ssl vserver¶
The following operations can be performed on "ssl vserver":
set | unset | bind | unbind | show
set ssl vserver¶
Sets advanced SSL configuration for an SSL virtual server.
Synopsys¶
set ssl vserver <vServerName>@ [-clearTextPort <port>] [-dh ( ENABLED | DISABLED ) -dhFile <string>] [-dhCount <positive_integer>] [-dhKeyExpSizeLimit ( ENABLED | DISABLED )] [-eRSA ( ENABLED | DISABLED ) [-eRSACount <positive_integer>]] [-sessReuse ( ENABLED | DISABLED ) [-sessTimeout <positive_integer>]] [-cipherRedirect ( ENABLED | DISABLED ) [-cipherURL <URL>]] [-sslv2Redirect ( ENABLED | DISABLED ) [-sslv2URL <URL>]] [-clientAuth ( ENABLED | DISABLED ) [-clientCert ( Mandatory | Optional )]] [-sslRedirect ( ENABLED | DISABLED )] [-redirectPortRewrite ( ENABLED | DISABLED )] [-nonFipsCiphers ( ENABLED | DISABLED )] [-ssl2 ( ENABLED | DISABLED )] [-ssl3 ( ENABLED | DISABLED )] [-tls1 ( ENABLED | DISABLED )] [-tls11 ( ENABLED | DISABLED )] [-tls12 ( ENABLED | DISABLED )] [-SNIEnable ( ENABLED | DISABLED )] [-pushEncTrigger <pushEncTrigger>] [-sendCloseNotify ( YES | NO )] [-dtlsProfileName <string>] [-sslProfile <string>]
Arguments¶
vServerName
Name of the SSL virtual server for which to set advanced configuration.
clearTextPort
Port on which clear-text data is sent by the appliance to the server. Do not specify this parameter for SSL offloading with end-to-end encryption.
Default value: 0
dh
State of Diffie-Hellman (DH) key exchange.
Possible values: ENABLED, DISABLED
Default value: DISABLED
dhFile
Name of and, optionally, path to the DH parameter file, in PEM format, to be installed. /nsconfig/ssl/ is the default path.
dhCount
Number of interactions, between the client and the NetScaler appliance, after which the DH private-public pair is regenerated. A value of zero (0) specifies infinite use (no refresh).
Minimum value: 0
Maximum value: 65534
dhKeyExpSizeLimit
This option enables the use of NIST recommended (NIST Special Publication 800-56A) bit size for private-key size. For example, for DH params of size 2048bit, the private-key size recommended is 224bits. This is rounded-up to 256bits.
Possible values: ENABLED, DISABLED
Default value: DISABLED
eRSA
State of Ephemeral RSA (eRSA) key exchange. Ephemeral RSA allows clients that support only export ciphers to communicate with the secure server even if the server certificate does not support export clients. The ephemeral RSA key is automatically generated when you bind an export cipher to an SSL or TCP-based SSL virtual server or service. When you remove the export cipher, the eRSA key is not deleted. It is reused at a later date when another export cipher is bound to an SSL or TCP-based SSL virtual server or service. The eRSA key is deleted when the appliance restarts.
Possible values: ENABLED, DISABLED
Default value: ENABLED
eRSACount
Refresh count for regeneration of the RSA public-key and private-key pair. Zero (0) specifies infinite usage (no refresh).
Minimum value: 0
Maximum value: 65534
sessReuse
State of session reuse. Establishing the initial handshake requires CPU-intensive public key encryption operations. With the ENABLED setting, session key exchange is avoided for session resumption requests received from the client.
Possible values: ENABLED, DISABLED
Default value: ENABLED
sessTimeout
Time, in seconds, for which to keep the session active. Any session resumption request received after the timeout period will require a fresh SSL handshake and establishment of a new SSL session.
Default value: 120
Minimum value: 0
Maximum value: 4294967294
cipherRedirect
State of Cipher Redirect. If cipher redirect is enabled, you can configure an SSL virtual server or service to display meaningful error messages if the SSL handshake fails because of a cipher mismatch between the virtual server or service and the client.
Possible values: ENABLED, DISABLED
Default value: DISABLED
cipherURL
The redirect URL to be used with the Cipher Redirect feature.
sslv2Redirect
State of SSLv2 Redirect. If SSLv2 redirect is enabled, you can configure an SSL virtual server or service to display meaningful error messages if the SSL handshake fails because of a protocol version mismatch between the virtual server or service and the client.
Possible values: ENABLED, DISABLED
Default value: DISABLED
sslv2URL
URL of the page to which to redirect the client in case of a protocol version mismatch. Typically, this page has a clear explanation of the error or an alternative location that the transaction can continue from.
clientAuth
State of client authentication. If client authentication is enabled, the virtual server terminates the SSL handshake if the SSL client does not provide a valid certificate.
Possible values: ENABLED, DISABLED
Default value: DISABLED
clientCert
Type of client authentication. If this parameter is set to MANDATORY, the appliance terminates the SSL handshake if the SSL client does not provide a valid certificate. With the OPTIONAL setting, the appliance requests a certificate from the SSL clients but proceeds with the SSL transaction even if the client presents an invalid certificate.
Caution: Define proper access control policies before changing this setting to Optional.
Possible values: Mandatory, Optional
sslRedirect
State of HTTPS redirects for the SSL virtual server.
For an SSL session, if the client browser receives a redirect message, the browser tries to connect to the new location. However, the secure SSL session breaks if the object has moved from a secure site (https://) to an unsecure site (http://). Typically, a warning message appears on the screen, prompting the user to continue or disconnect.
If SSL Redirect is ENABLED, the redirect message is automatically converted from http:// to https:// and the SSL session does not break.
Possible values: ENABLED, DISABLED
Default value: DISABLED
redirectPortRewrite
State of the port rewrite while performing HTTPS redirect. If this parameter is ENABLED and the URL from the server does not contain the standard port, the port is rewritten to the standard.
Possible values: ENABLED, DISABLED
Default value: DISABLED
nonFipsCiphers
State of usage of non-FIPS approved ciphers. Valid only for an SSL service bound with a FIPS key and certificate.
Possible values: ENABLED, DISABLED
Default value: DISABLED
ssl2
State of SSLv2 protocol support for the SSL Virtual Server.
Possible values: ENABLED, DISABLED
Default value: DISABLED
ssl3
State of SSLv3 protocol support for the SSL Virtual Server.
Possible values: ENABLED, DISABLED
Default value: ENABLED
tls1
State of TLSv1.0 protocol support for the SSL Virtual Server.
Possible values: ENABLED, DISABLED
Default value: ENABLED
tls11
State of TLSv1.1 protocol support for the SSL Virtual Server. TLSv1.1 protocol is supported only on the MPX appliance. Support is not available on a FIPS appliance or on a NetScaler VPX virtual appliance. On an SDX appliance, TLSv1.1 protocol is supported only if an SSL chip is assigned to the instance.
Possible values: ENABLED, DISABLED
Default value: ENABLED
tls12
State of TLSv1.2 protocol support for the SSL Virtual Server. TLSv1.2 protocol is supported only on the MPX appliance. Support is not available on a FIPS appliance or on a NetScaler VPX virtual appliance. On an SDX appliance, TLSv1.2 protocol is supported only if an SSL chip is assigned to the instance.
Possible values: ENABLED, DISABLED
Default value: ENABLED
SNIEnable
State of the Server Name Indication (SNI) feature on the virtual server and service-based offload. SNI helps to enable SSL encryption on multiple domains on a single virtual server or service if the domains are controlled by the same organization and share the same second-level domain name. For example, *.sports.net can be used to secure domains such as login.sports.net and help.sports.net.
Possible values: ENABLED, DISABLED
Default value: DISABLED
pushEncTrigger
Trigger encryption on the basis of the PUSH flag value. Available settings function as follows:
-
ALWAYS - Any PUSH packet triggers encryption.
-
IGNORE - Ignore PUSH packet for triggering encryption.
-
MERGE - For a consecutive sequence of PUSH packets, the last PUSH packet triggers encryption.
-
TIMER - PUSH packet triggering encryption is delayed by the time defined in the set ssl parameter command or in the Change Advanced SSL Settings dialog box.
Possible values: Always, Merge, Ignore, Timer
sendCloseNotify
Enable sending SSL Close-Notify at the end of a transaction
Possible values: YES, NO
Default value: YES
dtlsProfileName
Name of the DTLS profile whose settings are to be applied to the virtual server.
sslProfile
Name of the SSL profile that contains SSL settings for the virtual server.
Example¶
1) set ssl vserver sslvip -dh ENABLED -dhFile /siteA/dh1024.pem -dhCount 500The above example set the DH parameters for the SSL virtual server 'sslvip'.3) set ssl vserver sslvip -ssl2 DISABLEDThe above example disables the support for SSLv2 protocol for the SSL virtual server 'sslvip'.
unset ssl vserver¶
Use this command to remove ssl vserver settings.Refer to the set ssl vserver command for meanings of the arguments.
Synopsys¶
unset ssl vserver <vServerName>@ [-clearTextPort] [-dh] [-dhFile] [-dhCount] [-dhKeyExpSizeLimit] [-eRSA] [-eRSACount] [-sessReuse] [-sessTimeout] [-cipherRedirect] [-cipherURL] [-sslv2Redirect] [-sslv2URL] [-clientAuth] [-clientCert] [-sslRedirect] [-redirectPortRewrite] [-nonFipsCiphers] [-ssl2] [-ssl3] [-tls1] [-tls11] [-tls12] [-SNIEnable] [-sendCloseNotify] [-dtlsProfileName] [-sslProfile]
bind ssl vserver¶
Binds an SSL certificate-key pair or an SSL policy to an SSL virtual server.
Synopsys¶
bind ssl vserver <vServerName>@ ((-policyName <string> [-priority <positive_integer>] [-gotoPriorityExpression <expression>] [-invoke (<labelType> <labelName>) ] ) | ((-certkeyName <string> [(-CA [-crlCheck ( Mandatory | Optional ) | -ocspCheck ( Mandatory | Optional )] [-skipCAName]) | -SNICert] ) | -cipherName <string> | -eccCurveName <eccCurveName>))
Arguments¶
vServerName
Name of the SSL virtual server.
policyName
Name of the SSL policy to bind to the SSL virtual server.
priority
Integer specifying the policy's priority. The lower the number, the higher the priority.
Minimum value: 0
Maximum value: 64000
gotoPriorityExpression
Expression or other value specifying the next policy to be evaluated if the current policy evaluates to TRUE. Specify one of the following values:
-
NEXT - Evaluate the policy with the next higher priority number.
-
END - End policy evaluation.
-
USE_INVOCATION_RESULT - Applicable if this policy invokes another policy label. If the final goto in the invoked policy label has a value of END, the evaluation stops. If the final goto is anything other than END, the current policy label performs a NEXT.
-
A default syntax or classic expression that evaluates to a number.
If you specify an expression, the number to which it evaluates determines the next policy to evaluate, as follows:
-
If the expression evaluates to a higher numbered priority, the policy with that priority is evaluated next.
-
If the expression evaluates to the priority of the current policy, the policy with the next higher numbered priority is evaluated next.
-
If the expression evaluates to a number that is larger than the largest numbered priority, policy evaluation ends.
An UNDEF event is triggered if:
-
The expression is invalid.
-
The expression evaluates to a priority number that is numerically lower than the current policy's priority.
-
The expression evaluates to a priority number that is between the current policy's priority number (say, 30) and the highest priority number (say, 100), but does not match any configured priority number (for example, the expression evaluates to the number 85). This example assumes that the priority number increments by 10 for every successive policy, and therefore a priority number of 85 does not exist in the policy label.
Default value: "END"
invoke
Invoke policies bound to a virtual server, service, or user-defined policy label. After the invoked policies are evaluated, the flow returns to the policy with the next priority.
labelType
Type of policy label to invoke.
Possible values: vserver, service, policylabel
labelName
Name of the policy label, virtual server, or service to invoke if the current policy rule evaluates to TRUE.
certkeyName
Name of the certificate-key pair.
CA
Name of the CA certificate that issues and signs the intermediate-CA certificate or the end-user client or server certificate.
crlCheck
Rule to use for the CRL corresponding to the CA certificate during client authentication. Available settings function as follows:
-
MANDATORY - Deny SSL clients if the CRL is missing or expired, or the Next Update date is in the past, or the CRL is incomplete.
-
OPTIONAL - Allow SSL clients if the CRL is missing or expired, or the Next Update date is in the past, or the CRL is incomplete, but deny if the client certificate is revoked in the CRL.
Possible values: Mandatory, Optional
Default value: CRLCHECK_OPTIONAL
skipCAName
The flag is used to indicate whether this particular CA certificates CA Name needs to be sent to the SSL client while requesting for client certificate in a SSL handshake
SNICert
Name of the certificate-key pair to bind for use in SNI processing.
ocspCheck
Rule to use for the OCSP responder associated with the CA certificate during client authentication. If MANDATORY is specified, deny all SSL clients if the OCSP check fails because of connectivity issues with the remote OCSP server, or any other reason that prevents the OCSP check. With the OPTIONAL setting, allow SSL clients even if the OCSP check fails except when the client certificate is revoked.
Possible values: Mandatory, Optional
cipherName
Name of the individual cipher, user-defined cipher group, or predefined (built-in) cipher alias.
eccCurveName
Named ECC curve bound to service/vserver.
Possible values: ALL, P_224, P_256, P_384, P_521
Example¶
- bind ssl vserver ssl_vip -certkeyName cert1In the above example the certificate cert1 is bound to the SSL vserver ssl_vip as server certificate.2. bind ssl vserver ssl_vip -certkeyName cert2 -CAIn the above example the certificate cert2 is bound to the SSL vserver ssl_vip as CA certificate.3. bind ssl vserver ssl_vip -certkeyName cert3 -CA -ocspCheck MandatoryIn the above example the certificate cert3 is bound to the SSL vserver ssl_vip as CA certificate, with OCSP check set to Mandatory.4. bind ssl vserver ssl_vip -policyName certInsert_pol -priority 10In the above example the SSL policy certInsert_pol is bound to the SSL vserver ssl_vip with priority 10.
unbind ssl vserver¶
Unbinds an SSL policy, cipher, and certificate-key pair from an SSL virtual server.
Synopsys¶
unbind ssl vserver <vServerName>@ ((-policyName <string> [-priority <positive_integer>]) | ((-certkeyName <string> [-CA | -SNICert] ) | -cipherName <string> | -eccCurveName <eccCurveName>))
Arguments¶
vServerName
Name of the SSL virtual server.
policyName
Name of the SSL policy to unbind from the SSL virtual server.
priority
Priority of the NOPOLICY (built-in policy) to be unbound. Not required if you are unbinding a user-defined policy.
Minimum value: 1
Maximum value: 2147483647
certkeyName
The name of the certificate key pair binding.
CA
CA certificate.
SNICert
Name of the SNI certificate-key pair.
cipherName
Name of the cipher.
eccCurveName
Named ECC curve bound to service/vserver.
Possible values: ALL, P_224, P_256, P_384, P_521
Example¶
unbind ssl vserver ssl_vip -policyName certInsert_pol
show ssl vserver¶
Displays SSL specific configuration information for all SSL virtual servers, or displays detailed information for the specified SSL virtual server.
Synopsys¶
show ssl vserver [<vServerName>] [-cipherDetails]
Arguments¶
vServerName
Name of the SSL virtual server for which to show detailed information.
cipherDetails
Display details of the individual ciphers bound to the SSL virtual server.
Outputs¶
clearTextPort
The clearTextPort settings.
dh
The state of Diffie-Hellman (DH) key exchange support.
dhFile
The file name and path for the DH parameter.
dhCount
The refresh count for the re-generation of DH public-key and private-key from the DH parameter.
dhKeyExpSizeLimit
This option enables the use of NIST recommended (NIST Special Publication 800-56A) bit size for private-key size. For example, for DH params of size 2048bit, the private-key size recommended is 224bits. This is rounded-up to 256bits.
eRSA
The state of Ephemeral RSA key exchange support.Ephemeral RSA is used for export ciphers
eRSACount
The refresh count for the re-generation of RSA public-key and private-key pair.
sessReuse
The state of session re-use support.
sessTimeout
The Session timeout value in seconds.
cipherRedirect
The state of Cipher Redirect feature.Cipher Redirect feature can be used to provide more readable information to SSL clients about mismatch in ciphers between the client and the SSL vserver.
crlCheck
The state of the CRL check parameter. (Mandatory/Optional)
cipherURL
The redirect URL to be used with the Cipher Redirect feature.
sslv2Redirect
The state of SSLv2 Redirect feature. SSLv2 Redirect feature can be used to provide more readable information to SSL client about non-support of SSLv2 protocol on the SSL vserver.
sslv2URL
The redirect URL to be used with SSLv2 Redirect feature.
clientAuth
The state of Client-Authentication support.
clientCert
The rule for client certificate requirement in client authentication.
sslRedirect
The state of HTTPS redirect feature support.
priority
The priority of the policies bound to this SSL service
polinherit
Whether the bound policy is a inherited policy or not
redirectPortRewrite
The state of port rewrite feature support.
nonFipsCiphers
The state of usage of non FIPS approved ciphers.
ssl2
The state of SSLv2 protocol support.
ssl3
The state of SSLv3 protocol support.
tls1
The state of TLSv1.0 protocol support.
tls11
The state of TLSv1.1 protocol support.
tls12
The state of TLSv1.2 protocol support.
SNIEnable
The state of SNI extension.Server Name Indication (SNI) helps to enable SSL encryption on multiple subdomains if the domains are controlled by the same organization and share the same second-level domain name. State of SNI feature on service
cipherAliasName/cipherName/cipherGroupName
The name of the cipher group/alias/individual cipheri bindings.
cipherName
The cipher group/alias/individual cipher configuration
description
The cipher suite description.
service
Service
certkeyName
The name of the certificate key pair binding.
policyName
The name of the SSL policy binding.
invoke
Invoke flag. This attribute is relevant only for ADVANCED policies
labelType
Type of policy label invocation.
labelName
Name of the label to invoke if the current policy rule evaluates to TRUE.
serviceName
Service name.
ocspCheck
The state of the OCSP check parameter. (Mandatory/Optional)
pushEncTrigger
PUSH packet triggering encryption: Always, Ignore, Merge
gotoPriorityExpression
Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
CA
CA certificate.
SNICert
The name of the CertKey. Use this option to bind Certkey(s) which will be used in SNI processing.
eccCurveName
Named ECC curve bound to vserver/service.
stateflag
skipCAName
The flag is used to indicate whether this particular CA certificate's CA_Name needs to be sent to the SSL client while requesting for client certificate in a SSL handshake
sendCloseNotify
Enable sending SSL Close-Notify at the end of a transaction
dtlsProfileName
Name of the DTLS profile whose settings are to be applied to the virtual server.
dtlsFlag
The flag is used to indicate whether DTLS is set or not
sslProfile
Name of the SSL profile that contains SSL settings for the virtual server.
devno
count
Example¶
An example of the output of the show vserver sslvip command is as follows:sh ssl vserver va1 Advanced SSL configuration for VServer va1: DH: DISABLED Ephemeral RSA: ENABLED Refresh Count: 0 Session Reuse: ENABLED Timeout: 120 seconds Cipher Redirect: DISABLED SSLv2 Redirect: DISABLED ClearText Port: 0 Client Auth: DISABLED SSL Redirect: DISABLED Non FIPS Ciphers: DISABLED SSLv2: DISABLED SSLv3: ENABLED TLSv1: ENABLED 1 bound certificate:1) CertKey Name: buy Server Certificate 1 bound CA certificate:1) CertKey Name: rtca CA Certificate 1) Cipher Name: DEFAULT Description: Predefined Cipher Alias