Skip to content
Was this article helpful?

ssl profile

The following operations can be performed on "ssl profile":

add | bind | unbind | rm | set | unset | show

add ssl profile

Add a new SSL profile on the Netscaler

Synopsys

add ssl profile <name> [-sslProfileType ( BackEnd | FrontEnd )] [-dhCount <positive_integer>] [-dh ( ENABLED | DISABLED ) -dhFile <string>] [-eRSA ( ENABLED | DISABLED ) [-eRSACount <positive_integer>]] [-sessReuse ( ENABLED | DISABLED ) [-sessTimeout <positive_integer>]] [-cipherRedirect ( ENABLED | DISABLED ) [-cipherURL <URL>]] [-clientAuth ( ENABLED | DISABLED ) [-clientCert ( Mandatory | Optional )]] [-dhKeyExpSizeLimit ( ENABLED | DISABLED )] [-sslRedirect ( ENABLED | DISABLED )] [-redirectPortRewrite ( ENABLED | DISABLED )] [-ssl3 ( ENABLED | DISABLED )] [-tls1 ( ENABLED | DISABLED )] [-tls11 ( ENABLED | DISABLED )] [-tls12 ( ENABLED | DISABLED )] [-SNIEnable ( ENABLED | DISABLED )] [-ocspStapling ( ENABLED | DISABLED )] [-serverAuth ( ENABLED | DISABLED )] [-commonName <string>] [-pushEncTrigger <pushEncTrigger>] [-sendCloseNotify ( YES | NO )] [-clearTextPort <port|*>] [-insertionEncoding ( Unicode | UTF-8 )] [-denySSLReneg <denySSLReneg>] [-quantumSize <quantumSize>] [-strictCAChecks ( YES | NO )] [-encryptTriggerPktCount <positive_integer>] [-pushFlag <positive_integer>] [-dropReqWithNoHostHeader ( YES | NO )] [-pushEncTriggerTimeout <positive_integer>] [-sslTriggerTimeout <positive_integer>] [-clientAuthUseBoundCAChain ( ENABLED | DISABLED )] [-sessionTicket ( ENABLED | DISABLED )] [-sessionTicketLifeTime <positive_integer>] [-HSTS ( ENABLED | DISABLED )] [-maxage <positive_integer>] [-IncludeSubdomains ( YES | NO )]

Arguments

name

Name for the SSL profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the profile is created.

sslProfileType

Type of profile. Front end profiles apply to the entity that receives requests from a client. Backend profiles apply to the entity that sends client requests to a server.

Possible values: BackEnd, FrontEnd

Default value: FrontEnd

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).

This parameter is not applicable when configuring a backend profile.

Minimum value: 0

Maximum value: 65534

dh

State of Diffie-Hellman (DH) key exchange.

This parameter is not applicable when configuring a backend profile.

Possible values: ENABLED, DISABLED

Default value: DISABLED

dhFile

The file name and path for the DH parameter.

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.

This parameter is not applicable when configuring a backend profile.

Possible values: ENABLED, DISABLED

Default value: ENABLED

eRSACount

The refresh count for the re-generation of RSA public-key and private-key pair.

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

The Session timeout value in seconds.

Minimum value: 0

Maximum value: 4294967294

cipherRedirect

State of Cipher Redirect. If this parameter is set to 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.

This parameter is not applicable when configuring a backend profile.

Possible values: ENABLED, DISABLED

Default value: DISABLED

cipherURL

The redirect URL to be used with the Cipher Redirect feature.

clientAuth

State of client authentication. In service-based SSL offload, the service terminates the SSL handshake if the SSL client does not provide a valid certificate.

This parameter is not applicable when configuring a backend profile.

Possible values: ENABLED, DISABLED

Default value: DISABLED

clientCert

The rule for client certificate requirement in client authentication.

Possible values: Mandatory, Optional

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

sslRedirect

State of HTTPS redirects for the SSL service.

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.

This parameter is not applicable when configuring a backend profile.

Possible values: ENABLED, DISABLED

Default value: DISABLED

redirectPortRewrite

State of the port rewrite while performing HTTPS redirect. If this parameter is set to 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

ssl3

State of SSLv3 protocol support for the SSL profile.

Possible values: ENABLED, DISABLED

Default value: DISABLED

tls1

State of TLSv1.0 protocol support for the SSL profile.

Possible values: ENABLED, DISABLED

Default value: ENABLED

tls11

State of TLSv1.1 protocol support for the SSL profile.

Possible values: ENABLED, DISABLED

Default value: ENABLED

tls12

State of TLSv1.2 protocol support for the SSL profile.

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

ocspStapling

State of OCSP stapling support on the SSL virtual server. Supported only if the protocol used is higher than SSLv3. Possible values:

ENABLED: The appliance sends a request to the OCSP responder to check the status of the server certificate and caches the response for the specified time. If the response is valid at the time of SSL handshake with the client, the OCSP-based server certificate status is sent to the client during the handshake.

DISABLED: The appliance does not check the status of the server certificate.

Possible values: ENABLED, DISABLED

Default value: DISABLED

serverAuth

State of server authentication support for the SSL Backend profile.

Possible values: ENABLED, DISABLED

Default value: DISABLED

commonName

Name to be checked against the CommonName (CN) field in the server certificate bound to the SSL server.

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

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.

insertionEncoding

Encoding method used to insert the subject or issuer's name in HTTP requests to servers.

Possible values: Unicode, UTF-8

Default value: Unicode

denySSLReneg

Deny renegotiation in specified circumstances. Available settings function as follows:

  • NO - Allow SSL renegotiation.

  • FRONTEND_CLIENT - Deny secure and nonsecure SSL renegotiation initiated by the client.

  • FRONTEND_CLIENTSERVER - Deny secure and nonsecure SSL renegotiation initiated by the client or the NetScaler during policy-based client authentication.

  • ALL - Deny all secure and nonsecure SSL renegotiation.

  • NONSECURE - Deny nonsecure SSL renegotiation. Allows only clients that support RFC 5746.

Possible values: NO, FRONTEND_CLIENT, FRONTEND_CLIENTSERVER, ALL, NONSECURE

Default value: ALL

quantumSize

Amount of data to collect before the data is pushed to the crypto hardware for encryption. For large downloads, a larger quantum size better utilizes the crypto resources.

Possible values: 4096, 8192, 16384

Default value: 8192

strictCAChecks

Enable strict CA certificate checks on the appliance.

Possible values: YES, NO

Default value: NO

encryptTriggerPktCount

Maximum number of queued packets after which encryption is triggered. Use this setting for SSL transactions that send small packets from server to NetScaler.

Default value: 45

Minimum value: 10

Maximum value: 50

pushFlag

Insert PUSH flag into decrypted, encrypted, or all records. If the PUSH flag is set to a value other than 0, the buffered records are forwarded on the basis of the value of the PUSH flag. Available settings function as follows:

0 - Auto (PUSH flag is not set.)

1 - Insert PUSH flag into every decrypted record.

2 -Insert PUSH flag into every encrypted record.

3 - Insert PUSH flag into every decrypted and encrypted record.

Minimum value: 0

Maximum value: 3

dropReqWithNoHostHeader

Host header check for SNI enabled sessions. If this check is enabled and the HTTP request does not contain the host header for SNI enabled sessions, the request is dropped.

Possible values: YES, NO

Default value: NO

pushEncTriggerTimeout

PUSH encryption trigger timeout value. The timeout value is applied only if you set the Push Encryption Trigger parameter to Timer in the SSL virtual server settings.

Default value: 1

Minimum value: 1

Maximum value: 200

sslTriggerTimeout

Time, in milliseconds, after which encryption is triggered for transactions that are not tracked on the NetScaler appliance because their length is not known. There can be a delay of up to 10ms from the specified timeout value before the packet is pushed into the queue.

Default value: 100

Minimum value: 1

Maximum value: 200

clientAuthUseBoundCAChain

Certficates bound on the VIP are used for validating the client cert. Certficates came along with client cert are not used for validating the client cert

Possible values: ENABLED, DISABLED

Default value: DISABLED

sessionTicket

This option enables the use of session tickets, as per the RFC 5077

Possible values: ENABLED, DISABLED

Default value: DISABLED

sessionTicketLifeTime

This option sets the life time of session tickets issued by NS in secs

Default value: 300

Minimum value: 0

Maximum value: 172800

HSTS

State of TLSv1.0 protocol support for the SSL Virtual Server.

Possible values: ENABLED, DISABLED

Default value: DISABLED

maxage

Set max-age value for STS header

Default value: 0

Minimum value: 0

Maximum value: 4294967294

IncludeSubdomains

Set include sub domain value for STS header

Possible values: YES, NO

Default value: NO

Example

add sslProfile <profile name> -sslProfileType FrontEnd

bind ssl profile

Binds a cipher or ecccurve or certkey to an SSL profile.

Synopsys

bind ssl profile <name> ((-cipherName <string> [-cipherPriority <positive_integer>]) | -eccCurveName <eccCurveName>)

Arguments

name

Name of the SSL profile.

cipherName

Name of the cipher.

cipherPriority

Priority of the cipher binding

Minimum value: 1

Maximum value: 1000

eccCurveName

Named ECC curve bound to service/vserver.

Possible values: ALL, P_224, P_256, P_384, P_521

Example

  1. bind ssl profile ssl_prof -cipherName cipher_sha In the above example cipher group cipher_sha is bound to the SSL profile ssl_prof. Priority of cipher_sha will be next available maximum value.2. bind ssl profile ssl_prof -cipherName cipher_sha -cipherPriority 5In the above example cipher group cipher_sha is bound to the SSL profile ssl_prof at cipher priority 5.3. bind ssl profile ssl_prof -eccCurveName P_256In the above example P_256 eccCurve is bound to the SSL profile ssl_prof.4. bind ssl profile ssl_prof -ssliCACertkey ca_certkeyIn the above example the certkey named ca_certkey is bound to the SSL profile ssl_prof.

unbind ssl profile

Unbinds a cipher or eccCurve or certkey from an SSL profile.

Synopsys

unbind ssl profile <name> (-cipherName <string> | -eccCurveName <eccCurveName>)

Arguments

name

Name of the SSL profile

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 profile ssl_profile1 -cipherName cipher_sha

rm ssl profile

Remove a SSL profile on the Netscaler

Synopsys

rm ssl profile <name>

Arguments

name

Name of the SSL profile.

Example

rm sslProfile <profile name>

set ssl profile

Set/modify SSL profile values

Synopsys

set ssl profile <name> [-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>]] [-clientAuth ( ENABLED | DISABLED ) [-clientCert ( Mandatory | Optional )]] [-sslRedirect ( ENABLED | DISABLED )] [-redirectPortRewrite ( ENABLED | DISABLED )] [-ssl3 ( ENABLED | DISABLED )] [-tls1 ( ENABLED | DISABLED )] [-tls11 ( ENABLED | DISABLED )] [-tls12 ( ENABLED | DISABLED )] [-SNIEnable ( ENABLED | DISABLED )] [-ocspStapling ( ENABLED | DISABLED )] [-serverAuth ( ENABLED | DISABLED )] [-commonName <string>] [-pushEncTrigger <pushEncTrigger>] [-sendCloseNotify ( YES | NO )] [-clearTextPort <port|*>] [-insertionEncoding ( Unicode | UTF-8 )] [-denySSLReneg <denySSLReneg>] [-quantumSize <quantumSize>] [-strictCAChecks ( YES | NO )] [-encryptTriggerPktCount <positive_integer>] [-pushFlag <positive_integer>] [-dropReqWithNoHostHeader ( YES | NO )] [-pushEncTriggerTimeout <positive_integer>] [-sslTriggerTimeout <positive_integer>] [-clientAuthUseBoundCAChain ( ENABLED | DISABLED )] [-HSTS ( ENABLED | DISABLED )] [-maxage <positive_integer>] [-IncludeSubdomains ( YES | NO )] [-sessionTicket ( ENABLED | DISABLED )] [-sessionTicketLifeTime <positive_integer>] [-cipherName <string> -cipherPriority <positive_integer>] [-strictSigDigestCheck ( ENABLED | DISABLED )]

Arguments

name

Name for the SSL profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the profile is created.

dh

State of Diffie-Hellman (DH) key exchange.

This parameter is not applicable when configuring a backend profile.

Possible values: ENABLED, DISABLED

Default value: DISABLED

dhFile

The file name and path for the DH parameter.

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).

This parameter is not applicable when configuring a backend profile.

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.

This parameter is not applicable when configuring a backend profile.

Possible values: ENABLED, DISABLED

Default value: ENABLED

eRSACount

The refresh count for the re-generation of RSA public-key and private-key pair.

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

The Session timeout value in seconds.

Default value: 120

Minimum value: 0

Maximum value: 4294967294

cipherRedirect

State of Cipher Redirect. If this parameter is set to 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.

This parameter is not applicable when configuring a backend profile.

Possible values: ENABLED, DISABLED

Default value: DISABLED

cipherURL

The redirect URL to be used with the Cipher Redirect feature.

clientAuth

State of client authentication. In service-based SSL offload, the service terminates the SSL handshake if the SSL client does not provide a valid certificate.

This parameter is not applicable when configuring a backend profile.

Possible values: ENABLED, DISABLED

Default value: DISABLED

clientCert

The rule for client certificate requirement in client authentication.

Possible values: Mandatory, Optional

sslRedirect

State of HTTPS redirects for the SSL service.

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.

This parameter is not applicable when configuring a backend profile.

Possible values: ENABLED, DISABLED

Default value: DISABLED

redirectPortRewrite

State of the port rewrite while performing HTTPS redirect. If this parameter is set to 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

ssl3

State of SSLv3 protocol support for the SSL profile.

Possible values: ENABLED, DISABLED

Default value: DISABLED

tls1

State of TLSv1.0 protocol support for the SSL profile.

Possible values: ENABLED, DISABLED

Default value: ENABLED

tls11

State of TLSv1.1 protocol support for the SSL profile.

Possible values: ENABLED, DISABLED

Default value: ENABLED

tls12

State of TLSv1.2 protocol support for the SSL profile.

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

ocspStapling

State of OCSP stapling support on the SSL virtual server. Supported only if the protocol used is higher than SSLv3. Possible values:

ENABLED: The appliance sends a request to the OCSP responder to check the status of the server certificate and caches the response for the specified time. If the response is valid at the time of SSL handshake with the client, the OCSP-based server certificate status is sent to the client during the handshake.

DISABLED: The appliance does not check the status of the server certificate.

Possible values: ENABLED, DISABLED

Default value: DISABLED

serverAuth

State of server authentication support for the SSL Backend profile.

Possible values: ENABLED, DISABLED

Default value: DISABLED

commonName

Name to be checked against the CommonName (CN) field in the server certificate bound to the SSL server.

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

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.

insertionEncoding

Encoding method used to insert the subject or issuer's name in HTTP requests to servers.

Possible values: Unicode, UTF-8

Default value: Unicode

denySSLReneg

Deny renegotiation in specified circumstances. Available settings function as follows:

  • NO - Allow SSL renegotiation.

  • FRONTEND_CLIENT - Deny secure and nonsecure SSL renegotiation initiated by the client.

  • FRONTEND_CLIENTSERVER - Deny secure and nonsecure SSL renegotiation initiated by the client or the NetScaler during policy-based client authentication.

  • ALL - Deny all secure and nonsecure SSL renegotiation.

  • NONSECURE - Deny nonsecure SSL renegotiation. Allows only clients that support RFC 5746.

Possible values: NO, FRONTEND_CLIENT, FRONTEND_CLIENTSERVER, ALL, NONSECURE

Default value: ALL

quantumSize

Amount of data to collect before the data is pushed to the crypto hardware for encryption. For large downloads, a larger quantum size better utilizes the crypto resources.

Possible values: 4096, 8192, 16384

Default value: 8192

strictCAChecks

Enable strict CA certificate checks on the appliance.

Possible values: YES, NO

Default value: NO

encryptTriggerPktCount

Maximum number of queued packets after which encryption is triggered. Use this setting for SSL transactions that send small packets from server to NetScaler.

Default value: 45

Minimum value: 10

Maximum value: 50

pushFlag

Insert PUSH flag into decrypted, encrypted, or all records. If the PUSH flag is set to a value other than 0, the buffered records are forwarded on the basis of the value of the PUSH flag. Available settings function as follows:

0 - Auto (PUSH flag is not set.)

1 - Insert PUSH flag into every decrypted record.

2 -Insert PUSH flag into every encrypted record.

3 - Insert PUSH flag into every decrypted and encrypted record.

Minimum value: 0

Maximum value: 3

dropReqWithNoHostHeader

Host header check for SNI enabled sessions. If this check is enabled and the HTTP request does not contain the host header for SNI enabled sessions, the request is dropped.

Possible values: YES, NO

Default value: NO

pushEncTriggerTimeout

PUSH encryption trigger timeout value. The timeout value is applied only if you set the Push Encryption Trigger parameter to Timer in the SSL virtual server settings.

Default value: 1

Minimum value: 1

Maximum value: 200

sslTriggerTimeout

Time, in milliseconds, after which encryption is triggered for transactions that are not tracked on the NetScaler appliance because their length is not known. There can be a delay of up to 10ms from the specified timeout value before the packet is pushed into the queue.

Default value: 100

Minimum value: 1

Maximum value: 200

clientAuthUseBoundCAChain

Certficates bound on the VIP are used for validating the client cert. Certficates came along with client cert are not used for validating the client cert

Possible values: ENABLED, DISABLED

Default value: DISABLED

HSTS

State of TLSv1.0 protocol support for the SSL Virtual Server.

Possible values: ENABLED, DISABLED

Default value: DISABLED

maxage

Set max-age value for STS header

Default value: 0

Minimum value: 0

Maximum value: 4294967294

IncludeSubdomains

Set include sub domain value for STS header

Possible values: YES, NO

Default value: NO

sessionTicket

This option enables the use of session tickets, as per the RFC 5077

Possible values: ENABLED, DISABLED

Default value: DISABLED

sessionTicketLifeTime

This option sets the life time of session tickets issued by NS in secs

Default value: 300

Minimum value: 0

Maximum value: 172800

cipherName

The cipher group/alias/individual cipher configuration

cipherPriority

cipher priority

Minimum value: 1

strictSigDigestCheck

Parameter indicating to check whether peer entity certificate during TLS1.2 handshake is signed with one of signature-hash combination supported by Netscaler.

Possible values: ENABLED, DISABLED

Default value: DISABLED

Example

set ssl profile <profile name> -tls1 ENABLED

unset ssl profile

Use this command to remove ssl profile settings.Refer to the set ssl profile command for meanings of the arguments.

Synopsys

unset ssl profile <name> [-dh] [-dhFile] [-dhCount] [-dhKeyExpSizeLimit] [-eRSA] [-eRSACount] [-sessReuse] [-sessTimeout] [-cipherRedirect] [-cipherURL] [-clientAuth] [-clientCert] [-sslRedirect] [-redirectPortRewrite] [-ssl3] [-tls1] [-tls11] [-tls12] [-SNIEnable] [-ocspStapling] [-serverAuth] [-commonName] [-pushEncTrigger] [-sendCloseNotify] [-clearTextPort] [-insertionEncoding] [-denySSLReneg] [-quantumSize] [-strictCAChecks] [-encryptTriggerPktCount] [-pushFlag] [-dropReqWithNoHostHeader] [-pushEncTriggerTimeout] [-sslTriggerTimeout] [-clientAuthUseBoundCAChain] [-HSTS] [-maxage] [-IncludeSubdomains] [-sessionTicket] [-sessionTicketLifeTime] [-cipherName] [-cipherPriority] [-strictSigDigestCheck]

show ssl profile

Display all the configured SSL profiles in the system. If a name is specified, then only that profile is shown.

Synopsys

show ssl profile [<name>]

Arguments

name

Name of the SSL profile for which to show detailed information.

Outputs

dh

State of Diffie-Hellman (DH) key exchange.

This parameter is not applicable when configuring a backend profile.

dhFile

The file name and path for the DH parameter.

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).

This parameter is not applicable when configuring a backend profile.

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

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.

This parameter is not applicable when configuring a backend profile.

eRSACount

The refresh count for the re-generation of RSA public-key and private-key pair.

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.

sessTimeout

The Session timeout value in seconds.

cipherRedirect

State of Cipher Redirect. If this parameter is set to 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.

This parameter is not applicable when configuring a backend profile.

cipherURL

The redirect URL to be used with the Cipher Redirect feature.

clientAuth

State of client authentication. In service-based SSL offload, the service terminates the SSL handshake if the SSL client does not provide a valid certificate.

This parameter is not applicable when configuring a backend profile.

clientCert

The rule for client certificate requirement in client authentication.

sslRedirect

State of HTTPS redirects for the SSL service.

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.

This parameter is not applicable when configuring a backend profile.

redirectPortRewrite

State of the port rewrite while performing HTTPS redirect. If this parameter is set to ENABLED, and the URL from the server does not contain the standard port, the port is rewritten to the standard.

nonFipsCiphers

State of usage of ciphers that are not FIPS approved. Valid only for an SSL service bound with a FIPS key and certificate.

ssl3

State of SSLv3 protocol support for the SSL profile.

tls1

State of TLSv1.0 protocol support for the SSL profile.

tls11

State of TLSv1.1 protocol support for the SSL profile.

tls12

State of TLSv1.2 protocol support for the SSL profile.

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.

ocspStapling

State of OCSP stapling support on the SSL virtual server. Supported only if the protocol used is higher than SSLv3. Possible values:

ENABLED: The appliance sends a request to the OCSP responder to check the status of the server certificate and caches the response for the specified time. If the response is valid at the time of SSL handshake with the client, the OCSP-based server certificate status is sent to the client during the handshake.

DISABLED: The appliance does not check the status of the server certificate.

serverAuth

State of server authentication support for the SSL Backend profile.

commonName

Name to be checked against the CommonName (CN) field in the server certificate bound to the SSL server.

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.

sendCloseNotify

Enable sending SSL Close-Notify at the end of a transaction.

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.

insertionEncoding

Encoding method used to insert the subject or issuer's name in HTTP requests to servers.

denySSLReneg

Deny renegotiation in specified circumstances. Available settings function as follows:

  • NO - Allow SSL renegotiation.

  • FRONTEND_CLIENT - Deny secure and nonsecure SSL renegotiation initiated by the client.

  • FRONTEND_CLIENTSERVER - Deny secure and nonsecure SSL renegotiation initiated by the client or the NetScaler during policy-based client authentication.

  • ALL - Deny all secure and nonsecure SSL renegotiation.

  • NONSECURE - Deny nonsecure SSL renegotiation. Allows only clients that support RFC 5746.

quantumSize

Amount of data to collect before the data is pushed to the crypto hardware for encryption. For large downloads, a larger quantum size better utilizes the crypto resources.

strictCAChecks

Enable strict CA certificate checks on the appliance.

encryptTriggerPktCount

Maximum number of queued packets after which encryption is triggered. Use this setting for SSL transactions that send small packets from server to NetScaler.

pushFlag

Insert PUSH flag into decrypted, encrypted, or all records. If the PUSH flag is set to a value other than 0, the buffered records are forwarded on the basis of the value of the PUSH flag. Available settings function as follows:

0 - Auto (PUSH flag is not set.)

1 - Insert PUSH flag into every decrypted record.

2 -Insert PUSH flag into every encrypted record.

3 - Insert PUSH flag into every decrypted and encrypted record.

dropReqWithNoHostHeader

Host header check for SNI enabled sessions. If this check is enabled and the HTTP request does not contain the host header for SNI enabled sessions, the request is dropped.

pushEncTriggerTimeout

PUSH encryption trigger timeout value. The timeout value is applied only if you set the Push Encryption Trigger parameter to Timer in the SSL virtual server settings.

sslTriggerTimeout

Time, in milliseconds, after which encryption is triggered for transactions that are not tracked on the NetScaler appliance because their length is not known. There can be a delay of up to 10ms from the specified timeout value before the packet is pushed into the queue.

eccCurveName

Named ECC curve bound to vserver/service.

description

The cipher suite description.

cipherAliasName/cipherName/cipherGroupName

The name of the cipher group/alias/individual cipheri bindings.

cipherPriority

cipher priority

cipherName

The cipher group/alias/individual cipher configuration

crlCheck

The state of the CRL check parameter. (Mandatory/Optional)

ocspCheck

The state of the OCSP check parameter. (Mandatory/Optional)

SNICert

The name of the CertKey. Use this option to bind Certkey(s) which will be used in SNI processing.

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

stateflag

invoke

Invoke flag. This attribute is relevant only for ADVANCED policies

labelType

Type of policy label invocation.

sslProfileType

Type of profile. Front end profiles apply to the entity that receives requests from a client. Backend profiles apply to the entity that sends client requests to a server.

gslbServiceFlag

Indicates that the ssl profile has been bound to gslb service.

clientAuthUseBoundCAChain

Certficates bound on the VIP are used for validating the client cert. Certficates came along with client cert are not used for validating the client cert

serviceName

Service name.

service

Service

builtin

Flag to determine whether ssl profile is built-in or not

sslpfobjecttype

Internal flag to indicate what type of object binds this profile: monitor or service

sslInterception

Enable or disable transparent interception of SSL sessions.

ssliCACertkey

The certkey (CA certificate + private key) to be used for SSL interception.

ssliVerifyServerCertForReuse

Verify the origin server's certificate before reusing the front-end SSL session.

ssliReneg

Enable or disable triggering the client renegotiation when renegotiation request is received from the origin server.

ssliOCSPCheck

Enable or disable OCSP check for origin server certificate.

ssliMaxSessPerServer

Maximum ssl session to be cached per dynamic origin server. A unique ssl session is created for each SNI received from the client on ClientHello and the matching session is used for server session reuse.

sessionTicket

This option enables the use of session tickets, as per the RFC 5077

sessionTicketLifeTime

This option sets the life time of session tickets issued by NS in secs

HSTS

State of TLSv1.0 protocol support for the SSL Virtual Server.

maxage

Set max-age value for STS header

IncludeSubdomains

Set include sub domain value for STS header

strictSigDigestCheck

Parameter indicating to check whether peer entity certificate during TLS1.2 handshake is signed with one of signature-hash combination supported by Netscaler.

devno

count

Example

show ssl profile [profile name]

Was this article helpful?