@@ -12,31 +12,31 @@
-
- -autoservername bool
-- Automatically send the -servername as the host argument - (default is false)
+- -autoservername bool
+- Automatically send the -servername as the host argument + (default is false)
-
- -alpn list
-- List of protocols to offer during Application-Layer +
- -alpn list
+- List of protocols to offer during Application-Layer Protocol Negotiation (ALPN). For example: h2, http/1.1, etc.
-- -cadir dir
-- Specify the directory containing the CA certificates. The - default directory is platform specific and can be set at - compile time. This can be overridden via the SSL_CERT_DIR - environment variable.
-- -cafile filename
-- Specify the certificate authority (CA) file to use.
-- -certfile filename
-- Specify the filename containing the certificate to use. The - default name is cert.pem. This can be overridden via - the SSL_CERT_FILE environment variable.
-- -cert filename
-- Specify the contents of a certificate to use, as a DER +
- -cadir dir
+- Set the CA certificates path. The default directory is platform + specific and can be set at compile time. This can be overridden + via the SSL_CERT_DIR environment variable.
+- -cafile filename
+- Set the certificate authority (CA) certificates file. The default + is the cert.pem file in the OpsnSSL directory. This can also be + overridden via the SSL_CERT_FILE environment variable.
+- -certfile filename
+- Specify the filename with the certificate to use.
+- -cert filename
+- Specify the contents of a certificate to use, as a DER encoded binary value (X.509 DER).
-- -cipher string
-- List of ciphers to use. String is a colon (":") separated list +
- -cipher string
+- List of ciphers to use. String is a colon (":") separated list of ciphers or cipher suites. Cipher suites can be combined using the + character. Prefixes can be used to permanently remove ("!"), delete ("-"), or move a cypher to the end of the list ("+"). Keywords @STRENGTH (sort by algorithm key length), @SECLEVEL=n (set security level to n), and DEFAULT (use default cipher list, at start only) can also be specified. See OpenSSL documentation for the full list of valid values. (TLS 1.2 and earlier only)
-- -ciphersuites string
-- List of cipher suites to use. String is a colon (":") +
- -ciphersuites string
+- List of cipher suites to use. String is a colon (":") separated list of cipher suite names. (TLS 1.3 only)
-- -command callback
-- Callback to invoke at several points during the handshake. +
- -command callback
+- Callback to invoke at several points during the handshake. This is used to pass errors and tracing information, and it can allow Tcl scripts to perform their own certificate validation in place of the default validation provided by OpenSSL. See CALLBACK OPTIONS for further discussion.
-- -dhparams filename
-- Specify the Diffie-Hellman parameters file.
-- -keyfile filename
-- Specify the private key file. (default is - value of -certfile)
-- -key filename
-- Specify the private key to use as a DER encoded value (PKCS#1 DER)
-- -model channel
-- Force this channel to share the same SSL_CTX - structure as the specified channel, and - therefore share callbacks etc.
-- -password callback
-- Callback to invoke when OpenSSL needs to obtain a password, +
- -dhparams filename
+- Specify the Diffie-Hellman parameters file.
+- -keyfile filename
+- Specify the private key file. (default is + value of -certfile)
+- -key filename
+- Specify the private key to use as a DER encoded value (PKCS#1 DER)
+- -model channel
+- Force this channel to share the same SSL_CTX + structure as the specified channel, and + therefore share callbacks etc.
+- -password callback
+- Callback to invoke when OpenSSL needs to obtain a password, typically to unlock the private key of a certificate. The - callback should return a string which represents the password - to be used. See CALLBACK OPTIONS + callback should return a string which represents the password + to be used. See CALLBACK OPTIONS for further discussion.
- -post_handshake bool
- Allow post-handshake ticket updates.
-- -request bool
-- Request a certificate from peer during SSL handshake. - (default is true)
-- -require bool
-- Require a valid certificate from peer during SSL handshake. +
- -request bool
+- Request a certificate from peer during SSL handshake. + (default is true)
+- -require bool
+- Require a valid certificate from peer during SSL handshake. If this is set to true, then -request must - also be set to true. (default is false)
-- -securitylevel integer
-- Set security level. Must be 0 to 5. The security level affects + also be set to true. (default is false)
+- -securitylevel integer
+- Set security level. Must be 0 to 5. The security level affects cipher suite encryption algorithms, supported ECC curves, supported signature algorithms, DH parameter sizes, certificate key sizes and signature algorithms. The default is 1. Level 3 and higher disable support for session tickets and only accept cipher suites that provide forward secrecy.
-- -server bool
-- Handshake as server if true, else handshake as - client. (default is false)
-- -servername host
-- Specify server hostname. Only available if the OpenSSL library +
- -server bool
+- Handshake as server if true, else handshake as + client. (default is false)
+- -servername host
+- Specify server hostname. Only available if the OpenSSL library the package is linked against supports the TLS hostname extension for 'Server Name Indication' (SNI). Use to name the logical host we are talking to and expecting a certificate for.
-- -session_id string
-- Session id to resume session.
-- -ssl2 bool
-- Enable use of SSL v2. (default is false)
-- -ssl3 bool
-- Enable use of SSL v3. (default is false)
-- -tls1 bool
-- Enable use of TLS v1. (default is true)
-- -tls1.1 bool
-- Enable use of TLS v1.1 (default is true)
-- -tls1.2 bool
-- Enable use of TLS v1.2 (default is true)
-- -tls1.3 bool
-- Enable use of TLS v1.3 (default is true)
+- -session_id string
+- Session id to resume session.
+- -ssl2 bool
+- Enable use of SSL v2. (default is false)
+- -ssl3 bool
+- Enable use of SSL v3. (default is false)
+- -tls1 bool
+- Enable use of TLS v1. (default is true)
+- -tls1.1 bool
+- Enable use of TLS v1.1 (default is true)
+- -tls1.2 bool
+- Enable use of TLS v1.2 (default is true)
+- -tls1.3 bool
+- Enable use of TLS v1.3 (default is true)
+- -validatecommand callback
+- Callback to invoke to verify or validate protocol config + parameters during the protocol negotiation phase. See + CALLBACK OPTIONS + for further discussion.
SSL Status-
- alpn protocol
-- The protocol selected after Application-Layer Protocol +
- alpn protocol
+- The protocol selected after Application-Layer Protocol Negotiation (ALPN).
-- cipher cipher
-- The current cipher in use between the client and - server channels.
-- peername name
-- The peername from the certificate.
-- protocol version
-- The protocol version used for the connection: +
- cipher cipher
+- The current cipher in use between the client and + server channels.
+- peername name
+- The peername from the certificate.
+- protocol version
+- The protocol version used for the connection: SSL2, SSL3, TLS1, TLS1.1, TLS1.2, TLS1.3, or unknown.
-- sbits n
-- The number of bits used for the session key.
-- signatureHashAlgorithm algorithm
-- The signature hash algorithm.
-- signature_type type
-- The signature type value.
-- verification result
-- Certificate verification result.
-- ca_names list
-- List of the Certificate Authorities used to create the certificate.
+- sbits n
+- The number of bits used for the session key.
+- signatureHashAlgorithm algorithm
+- The signature hash algorithm.
+- signature_type type
+- The signature type value.
+- verification result
+- Certificate verification result.
+- ca_names list
+- List of the Certificate Authorities used to create the certificate.
Certificate Status-
- all string
-- Dump of all certificate info.
- -- version value
-- The certificate version.
-- serialNumber n
-- The serial number of the certificate as hex string.
-- signature algorithm
-- Cipher algorithm used for certificate signature.
-- issuer dn
-- The distinguished name (DN) of the certificate issuer.
-- notBefore date
-- The begin date for the validity of the certificate.
-- notAfter date
-- The expiration date for the certificate.
-- subject dn
-- The distinguished name (DN) of the certificate subject. +
- all string
+- Dump of all certificate info.
+ +- version value
+- The certificate version.
+- serialNumber n
+- The serial number of the certificate as hex string.
+- signature algorithm
+- Cipher algorithm used for certificate signature.
+- issuer dn
+- The distinguished name (DN) of the certificate issuer.
+- notBefore date
+- The begin date for the validity of the certificate.
+- notAfter date
+- The expiration date for the certificate.
+- subject dn
+- The distinguished name (DN) of the certificate subject. Fields include: Common Name (CN), Organization (O), Locality or City (L), State or Province (S), and Country Name (C).
-- issuerUniqueID string
-- The issuer unique id.
-- subjectUniqueID string
-- The subject unique id.
- -- num_extensions n
-- Number of certificate extensions.
-- extensions list
-- List of certificate extension names.
-- authorityKeyIdentifier string
-- (AKI) Key identifier of the Issuing CA certificate that signed +
- issuerUniqueID string
+- The issuer unique id.
+- subjectUniqueID string
+- The subject unique id.
+ +- num_extensions n
+- Number of certificate extensions.
+- extensions list
+- List of certificate extension names.
+- authorityKeyIdentifier string
+- (AKI) Key identifier of the Issuing CA certificate that signed the SSL certificate. This value matches the SKI value of the Intermediate CA certificate.
-- subjectKeyIdentifier string
-- (SKI) Hash of the public key inside the certificate. Used to +
- subjectKeyIdentifier string
+- (SKI) Hash of the public key inside the certificate. Used to identify certificates that contain a particular public key.
-- subjectAltName list
-- List of all of the alternative domain names, sub domains, +
- subjectAltName list
+- List of all of the alternative domain names, sub domains, and IP addresses that are secured by the certificate.
-- ocsp list
-- List of all OCSP URLs.
+- ocsp list
+- List of all OCSP URLs.
- certificate cert
-- The PEM encoded certificate.
- -- signatureAlgorithm algorithm
-- Cipher algorithm used for certificate signature.
-- signatureValue string
-- Certificate signature as hex string.
-- signatureDigest version
-- Certificate signing digest.
-- publicKeyAlgorithm algorithm
-- Certificate signature public key algorithm.
-- publicKey string
-- Certificate signature public key as hex string.
-- bits n
-- Number of bits used for certificate signature key
-- self_signed boolean
-- Is certificate signature self signed.
- -- sha1_hash hash
-- The SHA1 hash of the certificate as hex string.
-- sha256_hash hash
-- The SHA256 hash of the certificate as hex string.
+- The PEM encoded certificate.
+ +- signatureAlgorithm algorithm
+- Cipher algorithm used for certificate signature.
+- signatureValue string
+- Certificate signature as hex string.
+- signatureDigest version
+- Certificate signing digest.
+- publicKeyAlgorithm algorithm
+- Certificate signature public key algorithm.
+- publicKey string
+- Certificate signature public key as hex string.
+- bits n
+- Number of bits used for certificate signature key
+- self_signed boolean
+- Is certificate signature self signed.
+ +- sha1_hash hash
+- The SHA1 hash of the certificate as hex string.
+- sha256_hash hash
+- The SHA256 hash of the certificate as hex string.
SSL Status-
- state state
-- State of the connection.
-- servername name
-- The name of the connected to server.
-- protocol version
-- The protocol version used for the connection: +
- state state
+- State of the connection.
+- servername name
+- The name of the connected to server.
+- protocol version
+- The protocol version used for the connection: SSL2, SSL3, TLS1, TLS1.1, TLS1.2, TLS1.3, or unknown.
-- renegotiation state
-- Whether protocol renegotiation is supported or not.
-- securitylevel level
-- The security level used for selection of ciphers, key size, etc.
-- session_reused boolean
-- Whether the session has been reused or not.
-- is_server boolean
-- Whether the connection configured as a server or client (false).
-- compression mode
-- Compression method.
-- expansion mode
-- Expansion method.
+- renegotiation state
+- Whether protocol renegotiation is supported or not.
+- securitylevel level
+- The security level used for selection of ciphers, key size, etc.
+- session_reused boolean
+- Whether the session has been reused or not.
+- is_server boolean
+- Whether the connection configured as a server or client (false).
+- compression mode
+- Compression method.
+- expansion mode
+- Expansion method.
Cipher Info-
- cipher cipher
-- The current cipher in use for the connection.
-- standard_name name
-- The standard RFC name of cipher.
-- bits n
-- The number of processed bits used for cipher.
-- secret_bits n
-- The number of secret bits used for cipher.
-- min_version version
-- The minimum protocol version for cipher.
-- id id
-- The OpenSSL cipher id.
-- description string
-- A text description of the cipher.
+- cipher cipher
+- The current cipher in use for the connection.
+- standard_name name
+- The standard RFC name of cipher.
+- bits n
+- The number of processed bits used for cipher.
+- secret_bits n
+- The number of secret bits used for cipher.
+- min_version version
+- The minimum protocol version for cipher.
+- id id
+- The OpenSSL cipher id.
+- description string
+- A text description of the cipher.
Session Info-
- alpn protocol
-- The protocol selected after Application-Layer Protocol +
- alpn protocol
+- The protocol selected after Application-Layer Protocol Negotiation (ALPN).
-- resumable boolean
-- Can the session be resumed or not.
-- start_time seconds
-- Time since session started in seconds since epoch.
-- timeout seconds
-- Max duration of session in seconds before time-out.
-- lifetime seconds
-- Session ticket lifetime hint in seconds.
-- session_id string
-- Unique session id for use in resuming the session.
-- session_ticket string
-- Unique session ticket for use in resuming the session.
-- ticket_app_data string
-- Unique session ticket application data.
-- master_key binary_string
-- Unique session master key.
-- session_cache_mode mode
-- Server cache mode (client, server, or both).
+- resumable boolean
+- Can the session be resumed or not.
+- start_time seconds
+- Time since session started in seconds since epoch.
+- timeout seconds
+- Max duration of session in seconds before time-out.
+- lifetime seconds
+- Session ticket lifetime hint in seconds.
+- session_id string
+- Unique session id for use in resuming the session.
+- session_ticket string
+- Unique session ticket for use in resuming the session.
+- ticket_app_data string
+- Unique session ticket application data.
+- master_key binary_string
+- Unique session master key.
+- session_cache_mode mode
+- Server cache mode (client, server, or both).
SSL_CTX_set_info_callback()
.
+ handshake, alert, connect, accept
.start, done, read, write, loop, exit
.SSL_state_string_long()
or by
+ SSL_alert_desc_string_long()
, depending on context.warning, fatal, and unknown
.SSL_CTX_sess_set_new_cb()
.
+ Where session_id is the current session identifier,
+ ticket is the session ticket info, and lifetime
+ is the the ticket lifetime in seconds.
+ SSL_CTX_set_info_callback()
.
- handshake, alert, connect, accept
.start, done, read, write, loop, exit
.SSL_state_string_long()
or by
- SSL_alert_desc_string_long()
,
- depending on context.
- warning, fatal, and unknown
.SSL_CTX_sess_set_new_cb()
.
- Where session_id is the current session identifier,
- ticket is the session ticket info, and lifetime
- is the the ticket lifetime in seconds.
+ message processing. Used to select an appropriate certificate to
+ present, and make other configuration adjustments relevant to that
+ server name and its configuration. Called before SNI and ALPN callbacks.
0
as the subject certificate and higher values
- denoting progressively more indirect issuer certificates.
- 0
as the peer certificate and higher values going
+ up to the Certificate Authority (CA).0
means the certificate is deemed invalid.
- A value of 1
means the certificate is deemed valid.
- X509_STORE_CTX_get_error()
.
+ A value of 1
means the certificate is deemed valid.X509_STORE_CTX_get_error()
.Reference implementations of these callbacks are provided in the