Module tls

Module tls 

Source
Expand description

Fields related to a TLS connection. These fields focus on the TLS protocol itself and intentionally avoids in-depth analysis of the related x.509 certificate files.

Constantsยง

TLS_CIPHER
String indicating the cipher used during the current connection.
TLS_CLIENT_CERTIFICATE
PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of client.certificate_chain since this value also exists in that list.
TLS_CLIENT_CERTIFICATE_CHAIN
Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of client.certificate since that value should be the first certificate in the chain.
TLS_CLIENT_HASH_MD5
Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash.
TLS_CLIENT_HASH_SHA1
Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash.
TLS_CLIENT_HASH_SHA256
Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash.
TLS_CLIENT_ISSUER
Distinguished name of subject of the issuer of the x.509 certificate presented by the client.
TLS_CLIENT_JA3
A hash that identifies clients based on how they perform an SSL/TLS handshake.
TLS_CLIENT_NOT_AFTER
Date/Time indicating when client certificate is no longer considered valid.
TLS_CLIENT_NOT_BEFORE
Date/Time indicating when client certificate is first considered valid.
TLS_CLIENT_SERVER_NAME
Also called an SNI, this tells the server which hostname to which the client is attempting to connect to. When this value is available, it should get copied to destination.domain.
TLS_CLIENT_SUBJECT
Distinguished name of subject of the x.509 certificate presented by the client.
TLS_CLIENT_SUPPORTED_CIPHERS
Array of ciphers offered by the client during the client hello.
TLS_CLIENT_X509_ALTERNATIVE_NAMES
List of subject alternative names (SAN). Name types vary by certificate authority and certificate type but commonly contain IP addresses, DNS names (and wildcards), and email addresses.
TLS_CLIENT_X509_ISSUER_COMMON_NAME
List of common name (CN) of issuing certificate authority.
TLS_CLIENT_X509_ISSUER_COUNTRY
List of country (C) codes
TLS_CLIENT_X509_ISSUER_DISTINGUISHED_NAME
Distinguished name (DN) of issuing certificate authority.
TLS_CLIENT_X509_ISSUER_LOCALITY
List of locality names (L)
TLS_CLIENT_X509_ISSUER_ORGANIZATION
List of organizations (O) of issuing certificate authority.
TLS_CLIENT_X509_ISSUER_ORGANIZATIONAL_UNIT
List of organizational units (OU) of issuing certificate authority.
TLS_CLIENT_X509_ISSUER_STATE_OR_PROVINCE
List of state or province names (ST, S, or P)
TLS_CLIENT_X509_NOT_AFTER
Time at which the certificate is no longer considered valid.
TLS_CLIENT_X509_NOT_BEFORE
Time at which the certificate is first considered valid.
TLS_CLIENT_X509_PUBLIC_KEY_ALGORITHM
Algorithm used to generate the public key.
TLS_CLIENT_X509_PUBLIC_KEY_CURVE
The curve used by the elliptic curve public key algorithm. This is algorithm specific.
TLS_CLIENT_X509_PUBLIC_KEY_EXPONENT
Exponent used to derive the public key. This is algorithm specific.
TLS_CLIENT_X509_PUBLIC_KEY_SIZE
The size of the public key space in bits.
TLS_CLIENT_X509_SERIAL_NUMBER
Unique serial number issued by the certificate authority. For consistency, if this value is alphanumeric, it should be formatted without colons and uppercase characters.
TLS_CLIENT_X509_SIGNATURE_ALGORITHM
Identifier for certificate signature algorithm. We recommend using names found in Go Lang Crypto library. See https://github.com/golang/go/blob/go1.14/src/crypto/x509/x509.go#L337-L353.
TLS_CLIENT_X509_SUBJECT_COMMON_NAME
List of common names (CN) of subject.
TLS_CLIENT_X509_SUBJECT_COUNTRY
List of country (C) code
TLS_CLIENT_X509_SUBJECT_DISTINGUISHED_NAME
Distinguished name (DN) of the certificate subject entity.
TLS_CLIENT_X509_SUBJECT_LOCALITY
List of locality names (L)
TLS_CLIENT_X509_SUBJECT_ORGANIZATION
List of organizations (O) of subject.
TLS_CLIENT_X509_SUBJECT_ORGANIZATIONAL_UNIT
List of organizational units (OU) of subject.
TLS_CLIENT_X509_SUBJECT_STATE_OR_PROVINCE
List of state or province names (ST, S, or P)
TLS_CLIENT_X509_VERSION_NUMBER
Version of x509 format.
TLS_CURVE
String indicating the curve used for the given cipher, when applicable.
TLS_ESTABLISHED
Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel.
TLS_NEXT_PROTOCOL
String indicating the protocol being tunneled. Per the values in the IANA registry (https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids), this string should be lower case.
TLS_RESUMED
Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation.
TLS_SERVER_CERTIFICATE
PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of server.certificate_chain since this value also exists in that list.
TLS_SERVER_CERTIFICATE_CHAIN
Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of server.certificate since that value should be the first certificate in the chain.
TLS_SERVER_HASH_MD5
Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash.
TLS_SERVER_HASH_SHA1
Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash.
TLS_SERVER_HASH_SHA256
Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash.
TLS_SERVER_ISSUER
Subject of the issuer of the x.509 certificate presented by the server.
TLS_SERVER_JA3S
A hash that identifies servers based on how they perform an SSL/TLS handshake.
TLS_SERVER_NOT_AFTER
Timestamp indicating when server certificate is no longer considered valid.
TLS_SERVER_NOT_BEFORE
Timestamp indicating when server certificate is first considered valid.
TLS_SERVER_SUBJECT
Subject of the x.509 certificate presented by the server.
TLS_SERVER_X509_ALTERNATIVE_NAMES
List of subject alternative names (SAN). Name types vary by certificate authority and certificate type but commonly contain IP addresses, DNS names (and wildcards), and email addresses.
TLS_SERVER_X509_ISSUER_COMMON_NAME
List of common name (CN) of issuing certificate authority.
TLS_SERVER_X509_ISSUER_COUNTRY
List of country (C) codes
TLS_SERVER_X509_ISSUER_DISTINGUISHED_NAME
Distinguished name (DN) of issuing certificate authority.
TLS_SERVER_X509_ISSUER_LOCALITY
List of locality names (L)
TLS_SERVER_X509_ISSUER_ORGANIZATION
List of organizations (O) of issuing certificate authority.
TLS_SERVER_X509_ISSUER_ORGANIZATIONAL_UNIT
List of organizational units (OU) of issuing certificate authority.
TLS_SERVER_X509_ISSUER_STATE_OR_PROVINCE
List of state or province names (ST, S, or P)
TLS_SERVER_X509_NOT_AFTER
Time at which the certificate is no longer considered valid.
TLS_SERVER_X509_NOT_BEFORE
Time at which the certificate is first considered valid.
TLS_SERVER_X509_PUBLIC_KEY_ALGORITHM
Algorithm used to generate the public key.
TLS_SERVER_X509_PUBLIC_KEY_CURVE
The curve used by the elliptic curve public key algorithm. This is algorithm specific.
TLS_SERVER_X509_PUBLIC_KEY_EXPONENT
Exponent used to derive the public key. This is algorithm specific.
TLS_SERVER_X509_PUBLIC_KEY_SIZE
The size of the public key space in bits.
TLS_SERVER_X509_SERIAL_NUMBER
Unique serial number issued by the certificate authority. For consistency, if this value is alphanumeric, it should be formatted without colons and uppercase characters.
TLS_SERVER_X509_SIGNATURE_ALGORITHM
Identifier for certificate signature algorithm. We recommend using names found in Go Lang Crypto library. See https://github.com/golang/go/blob/go1.14/src/crypto/x509/x509.go#L337-L353.
TLS_SERVER_X509_SUBJECT_COMMON_NAME
List of common names (CN) of subject.
TLS_SERVER_X509_SUBJECT_COUNTRY
List of country (C) code
TLS_SERVER_X509_SUBJECT_DISTINGUISHED_NAME
Distinguished name (DN) of the certificate subject entity.
TLS_SERVER_X509_SUBJECT_LOCALITY
List of locality names (L)
TLS_SERVER_X509_SUBJECT_ORGANIZATION
List of organizations (O) of subject.
TLS_SERVER_X509_SUBJECT_ORGANIZATIONAL_UNIT
List of organizational units (OU) of subject.
TLS_SERVER_X509_SUBJECT_STATE_OR_PROVINCE
List of state or province names (ST, S, or P)
TLS_SERVER_X509_VERSION_NUMBER
Version of x509 format.
TLS_VERSION
Numeric part of the version parsed from the original string.
TLS_VERSION_PROTOCOL
Normalized lowercase protocol name parsed from original string.