getsslserviceResult Structure Definition

The getsslserviceResult structure defines the return type for getsslservice API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

sslserviceList

List of sslservices


sslservice Structure Definition

The sslservice structure defines the actual return type values for getsslservice API.

Syntax



Members

servicename

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

crlcheck

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

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 regeneration 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 re-generation of RSA public-key and pri-vate-key pair.

sessreuse

The state of session reuse 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.

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

redirectportrewrite

The state of port rewrite feature.

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.

tls13

The state of TLSv1.3 protocol support.

dtls1

The state of DTLSv1.0 protocol support.

dtls12

The state of DTLSv1.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.

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

The state of Server-Authentication support.

commonname

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

cipheraliasname/ciphername/ciphergroupname

The cipher group/alias/individual cipher configuration.

ciphername

The cipher group/alias/individual cipher configuration

description

The cipher suite description.

certkeyname

The certificate key pair binding.

policyname

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.

cleartextport

The clearTextPort settings.

service


priority

The priority of the policies bound to this SSL service

type

The phase of the SSL connection in which the policy rule is evaluated. Possible Value: SERVER_AUTH_VAL_REQ. The bindpoint means:: 1. SERVER_AUTH_VAL_REQ: Policy evaluation will be performed during the verification of the server certificate. Action allowed with this type is: OCSPCERTVALIDATION.

polinherit

Whether the bound policy is a inherited policy or not

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.

pushenctrigger

PUSH packet triggering encryption: Always, Ignore, Merge

ca

CA certificate.

snicert

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

gotopriorityexpression

Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.

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 that contains DTLS settings for the service.

dtlsflag

The flag is used to indicate whether DTLS is set or not

quicflag

This flag is used to indicate the use of the QUIC transport protocol by a virtual server or service.

ecccurvename

Named ECC curve bound to service/vserver.

sslprofile

Name of the SSL profile that contains SSL settings for the service.

strictsigdigestcheck

Parameter indicating to check whether peer's certificate during TLS1.2 handshake is signed with one of signature-hash combination supported by Citrix ADC

cipherdefaulton

Flag indicating whether the bound cipher was the DEFAULT cipher, bound at boot time, or any other cipher from the CLI

cacertbundlename

CA certbundle name bound to the service.

skipcacertbundle

The flag is used to indicate whether all CA_names in this particular CA certificate bundle needs to be sent to the SSL client while requesting for client certificate in a SSL handshake

sslclientlogs

This parameter is used to enable or disable the logging of additional information, such as the Session ID and SNI name, from SSL handshakes to the audit logs.

_nextgenapiresource


boundskipcaname


boundskipcaname2


See Also