#include "suricata-common.h"
#include "decode.h"
#include "app-layer.h"
#include "app-layer-detect-proto.h"
#include "app-layer-protos.h"
#include "app-layer-parser.h"
#include "app-layer-frames.h"
#include "app-layer-events.h"
#include "app-layer-ssl.h"
#include "conf.h"
#include "feature.h"
#include "util-debug.h"
#include "util-ja3.h"
#include "util-enum.h"
#include "util-validate.h"

Include dependency graph for app-layer-ssl.c:

Data Structures
struct	SslConfig_

struct	SSLDecoderResult

Macros
#define	SSL_CONFIG_DEFAULT_JA3 0

#define	SSLV3_CHANGE_CIPHER_SPEC 20

#define	SSLV3_ALERT_PROTOCOL 21

#define	SSLV3_HANDSHAKE_PROTOCOL 22

#define	SSLV3_APPLICATION_PROTOCOL 23

#define	SSLV3_HEARTBEAT_PROTOCOL 24

#define	SSLV3_HS_HELLO_REQUEST 0

#define	SSLV3_HS_CLIENT_HELLO 1

#define	SSLV3_HS_SERVER_HELLO 2

#define	SSLV3_HS_NEW_SESSION_TICKET 4

#define	SSLV3_HS_CERTIFICATE 11

#define	SSLV3_HS_SERVER_KEY_EXCHANGE 12

#define	SSLV3_HS_CERTIFICATE_REQUEST 13

#define	SSLV3_HS_SERVER_HELLO_DONE 14

#define	SSLV3_HS_CERTIFICATE_VERIFY 15

#define	SSLV3_HS_CLIENT_KEY_EXCHANGE 16

#define	SSLV3_HS_FINISHED 20

#define	SSLV3_HS_CERTIFICATE_URL 21

#define	SSLV3_HS_CERTIFICATE_STATUS 22

#define	SSLV2_MT_ERROR 0

#define	SSLV2_MT_CLIENT_HELLO 1

#define	SSLV2_MT_CLIENT_MASTER_KEY 2

#define	SSLV2_MT_CLIENT_FINISHED 3

#define	SSLV2_MT_SERVER_HELLO 4

#define	SSLV2_MT_SERVER_VERIFY 5

#define	SSLV2_MT_SERVER_FINISHED 6

#define	SSLV2_MT_REQUEST_CERTIFICATE 7

#define	SSLV2_MT_CLIENT_CERTIFICATE 8

#define	SSLV3_RECORD_HDR_LEN 5

#define	SSLV3_RECORD_MAX_LEN ((1 << 14) + 1024)

#define	SSLV3_CLIENT_HELLO_VERSION_LEN 2

#define	SSLV3_CLIENT_HELLO_RANDOM_LEN 32

#define	TLS_HB_REQUEST 1

#define	TLS_HB_RESPONSE 2

#define	SSL_RECORD_MINIMUM_LENGTH 6

#define	SHA1_STRING_LENGTH 60

#define	HAS_SPACE(n) ((uint64_t)(input - initial_input) + (uint64_t)(n) <= (uint64_t)(input_len))

#define	SSL_DECODER_ERROR(e)

#define	SSL_DECODER_OK(c)

#define	SSL_DECODER_INCOMPLETE(c, n)

#define	ValidateRecordState(...)

#define	SSLParserHSReset(connp)

#define	SSLParserReset(state)

#define	SSLSetEvent(ssl_state, event)

Typedefs
typedef struct SslConfig_	SslConfig

Enumerations
enum	{ ERR_INVALID_CERTIFICATE =1 , ERR_INVALID_LENGTH , ERR_INVALID_VERSION , ERR_INVALID_SERIAL , ERR_INVALID_ALGORITHMIDENTIFIER , ERR_INVALID_X509NAME , ERR_INVALID_DATE , ERR_INVALID_EXTENSIONS , ERR_INVALID_DER , ERR_EXTRACT_SUBJECT , ERR_EXTRACT_ISSUER , ERR_EXTRACT_VALIDITY }

enum	SslConfigEncryptHandling { SSL_CNF_ENC_HANDLE_TRACK_ONLY = 0 , SSL_CNF_ENC_HANDLE_BYPASS = 1 , SSL_CNF_ENC_HANDLE_FULL = 2 }

Functions
void	RegisterSSLParsers (void)
	Function to register the SSL protocol parser and other functions.

void	SSLEnableJA3 (void)
	if not explicitly disabled in config, enable ja3 support

void	SSLEnableJA4 (void)
	if not explicitly disabled in config, enable ja4 support

bool	SSLJA3IsEnabled (void)
	return whether ja3 is effectively enabled

bool	SSLJA4IsEnabled (void)
	return whether ja4 is effectively enabled

Variables
SCEnumCharMap	tls_frame_table []

SCEnumCharMap	tls_decoder_event_table []

SslConfig	ssl_config

Detailed Description

Author: Anoop Saldanha anoop.nosp@m.sald.nosp@m.anha@.nosp@m.gmai.nosp@m.l.com; Pierre Chifflier pierr.nosp@m.e.ch.nosp@m.iffli.nosp@m.er@s.nosp@m.si.go.nosp@m.uv.f.nosp@m.r; Mats Klepsland mats..nosp@m.klep.nosp@m.sland.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Definition in file app-layer-ssl.c.

Macro Definition Documentation

◆ HAS_SPACE

#define HAS_SPACE ( n ) ((uint64_t)(input - initial_input) + (uint64_t)(n) <= (uint64_t)(input_len))

Definition at line 260 of file app-layer-ssl.c.

◆ SHA1_STRING_LENGTH

#define SHA1_STRING_LENGTH 60

Definition at line 258 of file app-layer-ssl.c.

◆ SSL_CONFIG_DEFAULT_JA3

#define SSL_CONFIG_DEFAULT_JA3 0

Definition at line 189 of file app-layer-ssl.c.

◆ SSL_DECODER_ERROR

#define SSL_DECODER_ERROR ( e )

Value:

    (struct SSLDecoderResult)                                                                      \
    {                                                                                              \
        (e), 0                                                                                     \
    }

Definition at line 266 of file app-layer-ssl.c.

◆ SSL_DECODER_INCOMPLETE

#define SSL_DECODER_INCOMPLETE	(	c,
		n
	)

Value:

    (struct SSLDecoderResult)                                                                      \
    {                                                                                              \
        (uint32_t)(c), (n)                                                                         \
    }

Definition at line 276 of file app-layer-ssl.c.

◆ SSL_DECODER_OK

#define SSL_DECODER_OK ( c )

Value:

    (struct SSLDecoderResult)                                                                      \
    {                                                                                              \
        (uint32_t)(c), 0                                                                           \
    }

Definition at line 271 of file app-layer-ssl.c.

◆ SSL_RECORD_MINIMUM_LENGTH

#define SSL_RECORD_MINIMUM_LENGTH 6

Definition at line 256 of file app-layer-ssl.c.

◆ SSLParserHSReset

#define SSLParserHSReset ( connp )

Value:

    do {                                                                                           \
        (connp)->handshake_type = 0;                                                               \
        (connp)->message_length = 0;                                                               \
    } while (0)

Definition at line 312 of file app-layer-ssl.c.

◆ SSLParserReset

#define SSLParserReset ( state )

Value:

    do {                                            \
        SCLogDebug("resetting state");              \
        (state)->curr_connp->bytes_processed = 0;   \
        SSLParserHSReset((state)->curr_connp);      \
    } while(0)

Definition at line 318 of file app-layer-ssl.c.

◆ SSLSetEvent

#define SSLSetEvent	(	ssl_state,
		event
	)

Value:

    do {                                                                                           \
        SCLogDebug("setting event %u", (event));                                                   \
        if ((ssl_state) == NULL) {                                                                 \
            SCLogDebug("could not set decoder event %u", event);                                   \
        } else {                                                                                   \
            AppLayerDecoderEventsSetEventRaw(&(ssl_state)->tx_data.events, (event));               \
            (ssl_state)->events++;                                                                 \
        }                                                                                          \
    } while (0)

Definition at line 325 of file app-layer-ssl.c.

◆ SSLV2_MT_CLIENT_CERTIFICATE

#define SSLV2_MT_CLIENT_CERTIFICATE 8

Definition at line 243 of file app-layer-ssl.c.

◆ SSLV2_MT_CLIENT_FINISHED

#define SSLV2_MT_CLIENT_FINISHED 3

Definition at line 238 of file app-layer-ssl.c.

◆ SSLV2_MT_CLIENT_HELLO

#define SSLV2_MT_CLIENT_HELLO 1

Definition at line 236 of file app-layer-ssl.c.

◆ SSLV2_MT_CLIENT_MASTER_KEY

#define SSLV2_MT_CLIENT_MASTER_KEY 2

Definition at line 237 of file app-layer-ssl.c.

◆ SSLV2_MT_ERROR

#define SSLV2_MT_ERROR 0

Definition at line 235 of file app-layer-ssl.c.

◆ SSLV2_MT_REQUEST_CERTIFICATE

#define SSLV2_MT_REQUEST_CERTIFICATE 7

Definition at line 242 of file app-layer-ssl.c.

◆ SSLV2_MT_SERVER_FINISHED

#define SSLV2_MT_SERVER_FINISHED 6

Definition at line 241 of file app-layer-ssl.c.

◆ SSLV2_MT_SERVER_HELLO

#define SSLV2_MT_SERVER_HELLO 4

Definition at line 239 of file app-layer-ssl.c.

◆ SSLV2_MT_SERVER_VERIFY

#define SSLV2_MT_SERVER_VERIFY 5

Definition at line 240 of file app-layer-ssl.c.

◆ SSLV3_ALERT_PROTOCOL

#define SSLV3_ALERT_PROTOCOL 21

Definition at line 214 of file app-layer-ssl.c.

◆ SSLV3_APPLICATION_PROTOCOL

#define SSLV3_APPLICATION_PROTOCOL 23

Definition at line 216 of file app-layer-ssl.c.

◆ SSLV3_CHANGE_CIPHER_SPEC

#define SSLV3_CHANGE_CIPHER_SPEC 20

Definition at line 213 of file app-layer-ssl.c.

◆ SSLV3_CLIENT_HELLO_RANDOM_LEN

#define SSLV3_CLIENT_HELLO_RANDOM_LEN 32

Definition at line 250 of file app-layer-ssl.c.

◆ SSLV3_CLIENT_HELLO_VERSION_LEN

#define SSLV3_CLIENT_HELLO_VERSION_LEN 2

Definition at line 249 of file app-layer-ssl.c.

◆ SSLV3_HANDSHAKE_PROTOCOL

#define SSLV3_HANDSHAKE_PROTOCOL 22

Definition at line 215 of file app-layer-ssl.c.

◆ SSLV3_HEARTBEAT_PROTOCOL

#define SSLV3_HEARTBEAT_PROTOCOL 24

Definition at line 217 of file app-layer-ssl.c.

◆ SSLV3_HS_CERTIFICATE

#define SSLV3_HS_CERTIFICATE 11

Definition at line 224 of file app-layer-ssl.c.

◆ SSLV3_HS_CERTIFICATE_REQUEST

#define SSLV3_HS_CERTIFICATE_REQUEST 13

Definition at line 226 of file app-layer-ssl.c.

◆ SSLV3_HS_CERTIFICATE_STATUS

#define SSLV3_HS_CERTIFICATE_STATUS 22

Definition at line 232 of file app-layer-ssl.c.

◆ SSLV3_HS_CERTIFICATE_URL

#define SSLV3_HS_CERTIFICATE_URL 21

Definition at line 231 of file app-layer-ssl.c.

◆ SSLV3_HS_CERTIFICATE_VERIFY

#define SSLV3_HS_CERTIFICATE_VERIFY 15

Definition at line 228 of file app-layer-ssl.c.

◆ SSLV3_HS_CLIENT_HELLO

#define SSLV3_HS_CLIENT_HELLO 1

Definition at line 221 of file app-layer-ssl.c.

◆ SSLV3_HS_CLIENT_KEY_EXCHANGE

#define SSLV3_HS_CLIENT_KEY_EXCHANGE 16

Definition at line 229 of file app-layer-ssl.c.

◆ SSLV3_HS_FINISHED

#define SSLV3_HS_FINISHED 20

Definition at line 230 of file app-layer-ssl.c.

◆ SSLV3_HS_HELLO_REQUEST

#define SSLV3_HS_HELLO_REQUEST 0

Definition at line 220 of file app-layer-ssl.c.

◆ SSLV3_HS_NEW_SESSION_TICKET

#define SSLV3_HS_NEW_SESSION_TICKET 4

Definition at line 223 of file app-layer-ssl.c.

◆ SSLV3_HS_SERVER_HELLO

#define SSLV3_HS_SERVER_HELLO 2

Definition at line 222 of file app-layer-ssl.c.

◆ SSLV3_HS_SERVER_HELLO_DONE

#define SSLV3_HS_SERVER_HELLO_DONE 14

Definition at line 227 of file app-layer-ssl.c.

◆ SSLV3_HS_SERVER_KEY_EXCHANGE

#define SSLV3_HS_SERVER_KEY_EXCHANGE 12

Definition at line 225 of file app-layer-ssl.c.

◆ SSLV3_RECORD_HDR_LEN

#define SSLV3_RECORD_HDR_LEN 5

Definition at line 245 of file app-layer-ssl.c.

◆ SSLV3_RECORD_MAX_LEN

#define SSLV3_RECORD_MAX_LEN ((1 << 14) + 1024)

max length according to RFC 5246 6.2.2 is 2^14 + 1024

Definition at line 247 of file app-layer-ssl.c.

◆ TLS_HB_REQUEST

#define TLS_HB_REQUEST 1

Definition at line 253 of file app-layer-ssl.c.

◆ TLS_HB_RESPONSE

#define TLS_HB_RESPONSE 2

Definition at line 254 of file app-layer-ssl.c.

◆ ValidateRecordState

#define ValidateRecordState ( ... )

Definition at line 309 of file app-layer-ssl.c.

Typedef Documentation

◆ SslConfig

typedef struct SslConfig_ SslConfig

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
ERR_INVALID_CERTIFICATE
ERR_INVALID_LENGTH
ERR_INVALID_VERSION
ERR_INVALID_SERIAL
ERR_INVALID_ALGORITHMIDENTIFIER
ERR_INVALID_X509NAME
ERR_INVALID_DATE
ERR_INVALID_EXTENSIONS
ERR_INVALID_DER
ERR_EXTRACT_SUBJECT
ERR_EXTRACT_ISSUER
ERR_EXTRACT_VALIDITY

Definition at line 169 of file app-layer-ssl.c.

◆ SslConfigEncryptHandling

enum SslConfigEncryptHandling

Enumerator
SSL_CNF_ENC_HANDLE_TRACK_ONLY	disable raw content, continue tracking
SSL_CNF_ENC_HANDLE_BYPASS	skip processing of flow, bypass if possible
SSL_CNF_ENC_HANDLE_FULL	handle fully like any other proto

Definition at line 194 of file app-layer-ssl.c.

Function Documentation

◆ RegisterSSLParsers()

void RegisterSSLParsers ( void )

Function to register the SSL protocol parser and other functions.

SSLv2 and SSLv23

Definition at line 3188 of file app-layer-ssl.c.

Referenced by AppLayerParserRegisterProtocolParsers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SSLEnableJA3()

void SSLEnableJA3 ( void )

if not explicitly disabled in config, enable ja3 support

Implemented using atomic to allow rule reloads to do this at runtime.

Definition at line 3319 of file app-layer-ssl.c.

References SslConfig_::disable_ja3, g_disable_hashing, SC_ATOMIC_GET, SC_ATOMIC_SET, and ssl_config.

◆ SSLEnableJA4()

void SSLEnableJA4 ( void )

if not explicitly disabled in config, enable ja4 support

Implemented using atomic to allow rule reloads to do this at runtime.

Definition at line 3336 of file app-layer-ssl.c.

References SslConfig_::disable_ja4, g_disable_hashing, SC_ATOMIC_GET, SC_ATOMIC_SET, and ssl_config.

◆ SSLJA3IsEnabled()

bool SSLJA3IsEnabled ( void )

return whether ja3 is effectively enabled

This means that it either has been enabled explicitly or has been enabled by having loaded a rule while not being explicitly disabled.

Return values

true	if enabled, false otherwise

Definition at line 3356 of file app-layer-ssl.c.

References SC_ATOMIC_GET, and ssl_config.

◆ SSLJA4IsEnabled()

bool SSLJA4IsEnabled ( void )

return whether ja4 is effectively enabled

This means that it either has been enabled explicitly or has been enabled by having loaded a rule while not being explicitly disabled.

Return values

true	if enabled, false otherwise

Definition at line 3369 of file app-layer-ssl.c.

References SC_ATOMIC_GET, and ssl_config.

Variable Documentation

◆ ssl_config

SslConfig ssl_config

Definition at line 210 of file app-layer-ssl.c.

Referenced by RegisterSSLParsers(), SSLEnableJA3(), SSLEnableJA4(), SSLJA3IsEnabled(), and SSLJA4IsEnabled().

◆ tls_decoder_event_table

SCEnumCharMap tls_decoder_event_table[]

Definition at line 131 of file app-layer-ssl.c.

◆ tls_frame_table

SCEnumCharMap tls_frame_table[]

Definition at line 99 of file app-layer-ssl.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ HAS_SPACE

◆ SHA1_STRING_LENGTH

◆ SSL_CONFIG_DEFAULT_JA3

◆ SSL_DECODER_ERROR

◆ SSL_DECODER_INCOMPLETE

◆ SSL_DECODER_OK

◆ SSL_RECORD_MINIMUM_LENGTH

◆ SSLParserHSReset

◆ SSLParserReset

◆ SSLSetEvent

◆ SSLV2_MT_CLIENT_CERTIFICATE

◆ SSLV2_MT_CLIENT_FINISHED

◆ SSLV2_MT_CLIENT_HELLO

◆ SSLV2_MT_CLIENT_MASTER_KEY

◆ SSLV2_MT_ERROR

◆ SSLV2_MT_REQUEST_CERTIFICATE

◆ SSLV2_MT_SERVER_FINISHED

◆ SSLV2_MT_SERVER_HELLO

◆ SSLV2_MT_SERVER_VERIFY

◆ SSLV3_ALERT_PROTOCOL

◆ SSLV3_APPLICATION_PROTOCOL

◆ SSLV3_CHANGE_CIPHER_SPEC

◆ SSLV3_CLIENT_HELLO_RANDOM_LEN

◆ SSLV3_CLIENT_HELLO_VERSION_LEN

◆ SSLV3_HANDSHAKE_PROTOCOL

◆ SSLV3_HEARTBEAT_PROTOCOL

◆ SSLV3_HS_CERTIFICATE

◆ SSLV3_HS_CERTIFICATE_REQUEST

◆ SSLV3_HS_CERTIFICATE_STATUS

◆ SSLV3_HS_CERTIFICATE_URL

◆ SSLV3_HS_CERTIFICATE_VERIFY

◆ SSLV3_HS_CLIENT_HELLO

◆ SSLV3_HS_CLIENT_KEY_EXCHANGE

◆ SSLV3_HS_FINISHED

◆ SSLV3_HS_HELLO_REQUEST

◆ SSLV3_HS_NEW_SESSION_TICKET

◆ SSLV3_HS_SERVER_HELLO

◆ SSLV3_HS_SERVER_HELLO_DONE

◆ SSLV3_HS_SERVER_KEY_EXCHANGE

◆ SSLV3_RECORD_HDR_LEN

◆ SSLV3_RECORD_MAX_LEN

◆ TLS_HB_REQUEST

◆ TLS_HB_RESPONSE

◆ ValidateRecordState

Typedef Documentation

◆ SslConfig

Enumeration Type Documentation

◆ anonymous enum

◆ SslConfigEncryptHandling

Function Documentation

◆ RegisterSSLParsers()

◆ SSLEnableJA3()

◆ SSLEnableJA4()

◆ SSLJA3IsEnabled()

◆ SSLJA4IsEnabled()

Variable Documentation

◆ ssl_config

◆ tls_decoder_event_table

◆ tls_frame_table