ADC CLI Commands

ssl-action

May 28, 2024

Contributed by:

The following operations can be performed on “ssl-action”:

show ssl action

Displays information about all the SSL actions configured on the appliance, or displays detailed information about the specified SSL action.

Synopsis

show ssl action []

Arguments

name Name of the SSL action for which to show detailed information.

Output

stateflag clientAuth Perform client certificate authentication.

clientCertVerification Client certificate verification is mandatory or optional.

clientCert Insert the entire client certificate into the HTTP header of the request being sent to the web server. The certificate is inserted in ASCII (PEM) format.

certHeader clientCertSerialNumber Insert the entire client serial number into the HTTP header of the request being sent to the web server.

certSerialHeader clientCertSubject Insert the client certificate subject, also known as the distinguished name (DN), into the HTTP header of the request being sent to the web server.

certSubjectHeader clientCertHash Insert the certificate’s signature into the HTTP header of the request being sent to the web server. The signature is the value extracted directly from the X.509 certificate signature field. All X.509 certificates contain a signature field.

certHashHeader clientCertFingerprint Insert the certificate’s fingerprint into the HTTP header of the request being sent to the web server. The fingerprint is derived by computing the specified hash value (SHA256, for example) of the DER-encoding of the client certificate.

certFingerprintHeader certFingerprintDigest clientCertIssuer Insert the certificate issuer details into the HTTP header of the request being sent to the web server.

certIssuerHeader sessionID Insert the SSL session ID into the HTTP header of the request being sent to the web server. Every SSL connection that the client and the Citrix ADC share has a unique ID that identifies the specific connection.

sessionIDHeader cipher Insert the cipher suite that the client and the Citrix ADC negotiated for the SSL session into the HTTP header of the request being sent to the web server. The appliance inserts the cipher-suite name, SSL protocol, export or non-export string, and cipher strength bit, depending on the type of browser connecting to the SSL virtual server or service (for example, Cipher-Suite: RC4- MD5 SSLv3 Non-Export 128-bit).

cipherHeader OWASupport If the appliance is in front of an Outlook Web Access (OWA) server, insert a special header field, FRONT-END-HTTPS: ON, into the HTTP requests going to the OWA server. This header communicates to the server that the transaction is HTTPS and not HTTP.

forward This action takes an argument a vserver name, to this vserver one will be able to forward all the packets.

caCertGrpName This action will allow to pick CA(s) from the specific CA group, to verify the client certificate.

clientCertNotBefore Insert the date from which the certificate is valid into the HTTP header of the request being sent to the web server. Every certificate is configured with the date and time from which it is valid.

certNotBeforeHeader clientCertNotAfter Insert the date of expiry of the certificate into the HTTP header of the request being sent to the web server. Every certificate is configured with the date and time at which the certificate expires.

certNotAfterHeader hits The number of times the action has been taken.

undefHits The number of times the action resulted in UNDEF.

referenceCount The number of references to the action.

description Description of the action

flags ssllogProfile The name of the ssllogprofile.

builtin Flag to determine whether ssl action is built-in or not

feature The feature to be checked while applying this config

devno count

Example

show ssl action 1 Configured SSL action: 1) Name: certInsert_act Data Insertion Action: Cert Header: ENABLED Cert Tag: CERT

rm ssl action

Removes the specified SSL action.

Synopsis

rm ssl action

Arguments

name Name of the SSL action to remove.

Example

rm ssl action certInsert_act

add ssl action

Creates a new SSL action. An SSL action defines SSL settings that you can apply to the selected requests. You associate an action with one or more policies. Data in client connection requests or responses is compared to a rule (expression) specified in the policy, and the action is applied to connections that match the rule.

Synopsis

add ssl action \(\(-clientAuth \( DOCLIENTAUTH | NOCLIENTAUTH ) \[-clientCertVerification \( Mandatory | Optional )] \[-ssllogProfile ]) | -forward | -caCertGrpName ) \[-clientCert \( ENABLED | DISABLED ) -certHeader ] \[-clientCertSerialNumber \( ENABLED | DISABLED ) -certSerialHeader ] \[-clientCertSubject \( ENABLED | DISABLED ) -certSubjectHeader ] \[-clientCertHash \( ENABLED | DISABLED ) -certHashHeader ] \[-clientCertFingerprint \( ENABLED | DISABLED ) -certFingerprintHeader -certFingerprintDigest ] \[-clientCertIssuer \( ENABLED | DISABLED ) -certIssuerHeader ] \[-sessionID \( ENABLED | DISABLED ) -sessionIDHeader ] \[-cipher \( ENABLED | DISABLED ) -cipherHeader ] \[-clientCertNotBefore \( ENABLED | DISABLED ) -certNotBeforeHeader ] \[-clientCertNotAfter \( ENABLED | DISABLED ) -certNotAfterHeader ] \[-OWASupport \( ENABLED | DISABLED )]

Arguments

name Name for the SSL action. 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 action is created.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my action” or ‘my action’).

clientAuth Perform client certificate authentication.

Possible values: DOCLIENTAUTH, NOCLIENTAUTH

clientCertVerification Client certificate verification is mandatory or optional.

Possible values: Mandatory, Optional Default value: Mandatory

ssllogProfile The name of the ssllogprofile.

clientCert Insert the entire client certificate into the HTTP header of the request being sent to the web server. The certificate is inserted in ASCII (PEM) format.