Toolpack:Tsbc TLS Profiles

From TBwiki
(Difference between revisions)
Jump to: navigation, search
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Configuring Certificates and TLS Profiles  ==
+
{{DISPLAYTITLE:Configuring TLS Profiles}}
{{DISPLAYTITLE:Configuring Certificates and TLS Profiles}}
+
  
'''''Applies to version(s): v3.1 and above'''''
+
{| class="wikitable"
 +
|-
 +
|rowspan="2"|This article applies to:
 +
|'''Product'''
 +
|'''Version'''
 +
|-
 +
|SBC
 +
|3.1
 +
|}
  
Multiple TLS profiles can be created in [[Toolpack]]. A TLS profile is a collection of certificates and other settings that define the behavior of TLS connections. Multiple TLS profiles can be used to expose different certificates and options to different TLS connections in [[Toolpack]], though one TLS profile is generally enough.
+
Multiple TLS profiles can be created in [[Toolpack]]. A TLS profile is a collection of certificates and other settings that define the behavior of TLS connections. Multiple TLS profiles can be used to expose different certificates and options to different TLS connections in [[Toolpack]], athough one TLS profile is generally enough.
  
== Upload trusted certificates ==
+
== Create TLS profile ==
  
=== Select '''Certificates''' from the navigation panel ===
+
1. Select '''TLS Profiles''' from the navigation panel
  
[[Image:ConfigureCertificates_0.png|150px]]
+
[[Image:ConfigureTlsProfile_0.png]]
  
=== Click ''' Create New Certificate ''' ===
+
2. Click ''' Create New TLS Profile'''
  
[[Image:ConfigureCertificates_1.png]]
+
[[Image:ConfigureTlsProfile_1.png]]
  
=== Configure certificate parameters ===
+
3. Configure TLS Profile parameters
  
* Give a name that is meaningful to you
+
* Provide a name that is meaningful to you.
* Select "Trusted" certificate to import a remote party's certificate to trust
+
* Check if client authentication is required. Enabling this checkbox means that incoming connections require the remote side to present a or many trusted certificate(s) (later selected after creation).
* Drag-and-drop (or copy-paste) the certificate's text content into the appropriate text box
+
* Select a local certificate (either one imported earlier, or the "Default" certificate which is automatically generated by Toolpack and is also used for HTTPS)
 
* Click "Create"
 
* Click "Create"
  
[[Image:ConfigureCertificates_2.png]]
+
[[Image:ConfigureTlsProfile_2.png|500px]]
  
== Upload local certificates (optional) ==
+
* Select one or multiple "trusted" certificates, only necessary if "Require peer authentication" is checked.
Toolpack already contains a unique default certificate that is unique. This certificate is used for HTTPs, and can also be used for TLS.
+
  
[[Image:ConfigureCertificates_3.png]]
+
[[Image:ConfigureTlsProfile_3.png|500px]]
  
In case you want to use a custom local certificate, proceed as follows:
 
* Repeat the same procedure as above (but using "Local" certificate type) to import the local certificate
 
* Use ssh (command-line or using tool like Filezilla) to upload the private key to the unit to following path. Use the '''same file''' name as the local certificate name previously used to import in the web portal (except file extension):
 
  /lib/tb/toolpack/pkg/ssl_certificate/
 
 
Example:
 
  scp my_local_cert.key root@MyFreeSbcHostName:/lib/tb/toolpack/pkg/ssl_certificate/
 
 
== Create TLS profile ==
 
 
=== Select '''Certificates''' from the navigation panel ===
 
 
[[Image:ConfigureTlsProfile_0.png]]
 
 
=== Click ''' Create New TLS Profile''' ===
 
 
[[Image:ConfigureTlsProfile_1.png]]
 
 
=== Configure TLS Profile parameters ===
 
 
* Give a name that is meaningful to you
 
* Decide if client authentication is required (meaning that incoming connections require remote side to present a trusted certificate)
 
* Select a local certificate (either one imported earlier, or the "Default" certificate which is automatically generated by Toolpack and is also used for HTTPS)
 
* Click "Create"
 
* Select one or multiple "trusted" certificates, which correspond to remote equipment's certificates (or root certificates from which remote certificates are signed)
 
  
[[Image:ConfigureTlsProfile_2.png]]
+
== List of Parameters ==
  
[[Image:ConfigureTlsProfile_3.png]]
+
*[[Parameter: Name|Name]]
 +
*[[Parameter: Require client authentication|Require client authentication]]
 +
*[[Parameter: Local certificate|Local certificate]]

Latest revision as of 09:02, 15 December 2020


This article applies to: Product Version
SBC 3.1

Multiple TLS profiles can be created in Toolpack. A TLS profile is a collection of certificates and other settings that define the behavior of TLS connections. Multiple TLS profiles can be used to expose different certificates and options to different TLS connections in Toolpack, athough one TLS profile is generally enough.

Create TLS profile

1. Select TLS Profiles from the navigation panel

ConfigureTlsProfile 0.png

2. Click Create New TLS Profile

ConfigureTlsProfile 1.png

3. Configure TLS Profile parameters

  • Provide a name that is meaningful to you.
  • Check if client authentication is required. Enabling this checkbox means that incoming connections require the remote side to present a or many trusted certificate(s) (later selected after creation).
  • Select a local certificate (either one imported earlier, or the "Default" certificate which is automatically generated by Toolpack and is also used for HTTPS)
  • Click "Create"

ConfigureTlsProfile 2.png

  • Select one or multiple "trusted" certificates, only necessary if "Require peer authentication" is checked.

ConfigureTlsProfile 3.png


List of Parameters

Personal tools