]> git.ipfire.org Git - people/ms/suricata.git/blobdiff - src/app-layer-ssl.h
app-layer: include DetectEngineState in AppLayerTxData
[people/ms/suricata.git] / src / app-layer-ssl.h
index 1a8a0a2ec2284d3277ac44171d6ac573db8981be..a5d9c2d0ff229b528a4630cef0f2613e964f503f 100644 (file)
@@ -29,6 +29,7 @@
 #include "app-layer-protos.h"
 #include "app-layer-parser.h"
 #include "decode-events.h"
+#include "util-ja3.h"
 #include "queue.h"
 
 enum {
@@ -49,61 +50,94 @@ enum {
     TLS_DECODER_EVENT_TOO_MANY_RECORDS_IN_PACKET,
     /* Certificates decoding messages */
     TLS_DECODER_EVENT_INVALID_CERTIFICATE,
-    TLS_DECODER_EVENT_CERTIFICATE_MISSING_ELEMENT,
-    TLS_DECODER_EVENT_CERTIFICATE_UNKNOWN_ELEMENT,
     TLS_DECODER_EVENT_CERTIFICATE_INVALID_LENGTH,
-    TLS_DECODER_EVENT_CERTIFICATE_INVALID_STRING,
+    TLS_DECODER_EVENT_CERTIFICATE_INVALID_VERSION,
+    TLS_DECODER_EVENT_CERTIFICATE_INVALID_SERIAL,
+    TLS_DECODER_EVENT_CERTIFICATE_INVALID_ALGORITHMIDENTIFIER,
+    TLS_DECODER_EVENT_CERTIFICATE_INVALID_X509NAME,
+    TLS_DECODER_EVENT_CERTIFICATE_INVALID_DATE,
+    TLS_DECODER_EVENT_CERTIFICATE_INVALID_EXTENSIONS,
+    TLS_DECODER_EVENT_CERTIFICATE_INVALID_DER,
+    TLS_DECODER_EVENT_CERTIFICATE_INVALID_SUBJECT,
+    TLS_DECODER_EVENT_CERTIFICATE_INVALID_ISSUER,
+    TLS_DECODER_EVENT_CERTIFICATE_INVALID_VALIDITY,
     TLS_DECODER_EVENT_ERROR_MSG_ENCOUNTERED,
     TLS_DECODER_EVENT_INVALID_SSL_RECORD,
 };
 
 enum {
     TLS_STATE_IN_PROGRESS = 0,
-    TLS_HANDSHAKE_DONE = 1,
-    TLS_STATE_FINISHED = 2
+    TLS_STATE_CERT_READY = 1,
+    TLS_HANDSHAKE_DONE = 2,
+    TLS_STATE_FINISHED = 3
 };
 
 /* Flag to indicate that server will now on send encrypted msgs */
-#define SSL_AL_FLAG_SERVER_CHANGE_CIPHER_SPEC   0x0001
+#define SSL_AL_FLAG_SERVER_CHANGE_CIPHER_SPEC   BIT_U32(0)
 /* Flag to indicate that client will now on send encrypted msgs */
-#define SSL_AL_FLAG_CLIENT_CHANGE_CIPHER_SPEC   0x0002
-#define SSL_AL_FLAG_CHANGE_CIPHER_SPEC          0x0004
+#define SSL_AL_FLAG_CLIENT_CHANGE_CIPHER_SPEC   BIT_U32(1)
+#define SSL_AL_FLAG_CHANGE_CIPHER_SPEC          BIT_U32(2)
 
 /* SSL related flags */
-#define SSL_AL_FLAG_SSL_CLIENT_HS               0x0008
-#define SSL_AL_FLAG_SSL_SERVER_HS               0x0010
-#define SSL_AL_FLAG_SSL_CLIENT_MASTER_KEY       0x0020
-#define SSL_AL_FLAG_SSL_CLIENT_SSN_ENCRYPTED    0x0040
-#define SSL_AL_FLAG_SSL_SERVER_SSN_ENCRYPTED    0x0080
-#define SSL_AL_FLAG_SSL_NO_SESSION_ID           0x0100
+#define SSL_AL_FLAG_SSL_CLIENT_HS               BIT_U32(3)
+#define SSL_AL_FLAG_SSL_SERVER_HS               BIT_U32(4)
+#define SSL_AL_FLAG_SSL_CLIENT_MASTER_KEY       BIT_U32(5)
+#define SSL_AL_FLAG_SSL_CLIENT_SSN_ENCRYPTED    BIT_U32(6)
+#define SSL_AL_FLAG_SSL_SERVER_SSN_ENCRYPTED    BIT_U32(7)
+#define SSL_AL_FLAG_SSL_NO_SESSION_ID           BIT_U32(8)
 
 /* flags specific to detect-ssl-state keyword */
-#define SSL_AL_FLAG_STATE_CLIENT_HELLO          0x0200
-#define SSL_AL_FLAG_STATE_SERVER_HELLO          0x0400
-#define SSL_AL_FLAG_STATE_CLIENT_KEYX           0x0800
-#define SSL_AL_FLAG_STATE_SERVER_KEYX           0x1000
-#define SSL_AL_FLAG_STATE_UNKNOWN               0x2000
+#define SSL_AL_FLAG_STATE_CLIENT_HELLO          BIT_U32(9)
+#define SSL_AL_FLAG_STATE_SERVER_HELLO          BIT_U32(10)
+#define SSL_AL_FLAG_STATE_CLIENT_KEYX           BIT_U32(11)
+#define SSL_AL_FLAG_STATE_SERVER_KEYX           BIT_U32(12)
+#define SSL_AL_FLAG_STATE_UNKNOWN               BIT_U32(13)
 
 /* flag to indicate that session is finished */
-#define SSL_AL_FLAG_STATE_FINISHED              0x4000
+#define SSL_AL_FLAG_STATE_FINISHED              BIT_U32(14)
 
 /* flags specific to HeartBeat state */
-#define SSL_AL_FLAG_HB_INFLIGHT                 0x8000
-#define SSL_AL_FLAG_HB_CLIENT_INIT              0x10000
-#define SSL_AL_FLAG_HB_SERVER_INIT              0x20000
+#define SSL_AL_FLAG_HB_INFLIGHT                 BIT_U32(15)
+#define SSL_AL_FLAG_HB_CLIENT_INIT              BIT_U32(16)
+#define SSL_AL_FLAG_HB_SERVER_INIT              BIT_U32(17)
 
 /* flag to indicate that handshake is done */
-#define SSL_AL_FLAG_HANDSHAKE_DONE              0x80000
+#define SSL_AL_FLAG_HANDSHAKE_DONE              BIT_U32(18)
+
+/* A session ID in the Client Hello message, indicating the client
+   wants to resume a session */
+#define SSL_AL_FLAG_SSL_CLIENT_SESSION_ID       BIT_U32(19)
+/* Session resumed without a full handshake */
+#define SSL_AL_FLAG_SESSION_RESUMED             BIT_U32(20)
+
+/* Encountered a supported_versions extension in client hello */
+#define SSL_AL_FLAG_CH_VERSION_EXTENSION        BIT_U32(21)
+
+/* Log the session even without ever seeing a certificate. This is used
+   to log TLSv1.3 sessions. */
+#define SSL_AL_FLAG_LOG_WITHOUT_CERT            BIT_U32(22)
+
+/* Encountered a early data extension in client hello. This extension is
+   used by 0-RTT. */
+#define SSL_AL_FLAG_EARLY_DATA                  BIT_U32(23)
 
 /* config flags */
 #define SSL_TLS_LOG_PEM                         (1 << 0)
 
 /* extensions */
 #define SSL_EXTENSION_SNI                       0x0000
+#define SSL_EXTENSION_ELLIPTIC_CURVES           0x000a
+#define SSL_EXTENSION_EC_POINT_FORMATS          0x000b
+#define SSL_EXTENSION_SESSION_TICKET            0x0023
+#define SSL_EXTENSION_EARLY_DATA                0x002a
+#define SSL_EXTENSION_SUPPORTED_VERSIONS        0x002b
 
 /* SNI types */
 #define SSL_SNI_TYPE_HOST_NAME                  0
 
+/* Max string length of the TLS version string */
+#define SSL_VERSION_MAX_STRLEN 20
+
 /* SSL versions.  We'll use a unified format for all, with the top byte
  * holding the major version and the lower byte the minor version */
 enum {
@@ -113,6 +147,26 @@ enum {
     TLS_VERSION_10 = 0x0301,
     TLS_VERSION_11 = 0x0302,
     TLS_VERSION_12 = 0x0303,
+    TLS_VERSION_13 = 0x0304,
+    TLS_VERSION_13_DRAFT28 = 0x7f1c,
+    TLS_VERSION_13_DRAFT27 = 0x7f1b,
+    TLS_VERSION_13_DRAFT26 = 0x7f1a,
+    TLS_VERSION_13_DRAFT25 = 0x7f19,
+    TLS_VERSION_13_DRAFT24 = 0x7f18,
+    TLS_VERSION_13_DRAFT23 = 0x7f17,
+    TLS_VERSION_13_DRAFT22 = 0x7f16,
+    TLS_VERSION_13_DRAFT21 = 0x7f15,
+    TLS_VERSION_13_DRAFT20 = 0x7f14,
+    TLS_VERSION_13_DRAFT19 = 0x7f13,
+    TLS_VERSION_13_DRAFT18 = 0x7f12,
+    TLS_VERSION_13_DRAFT17 = 0x7f11,
+    TLS_VERSION_13_DRAFT16 = 0x7f10,
+    TLS_VERSION_13_PRE_DRAFT16 = 0x7f01,
+    TLS_VERSION_13_DRAFT20_FB = 0xfb14,
+    TLS_VERSION_13_DRAFT21_FB = 0xfb15,
+    TLS_VERSION_13_DRAFT22_FB = 0xfb16,
+    TLS_VERSION_13_DRAFT23_FB = 0xfb17,
+    TLS_VERSION_13_DRAFT26_FB = 0xfb1a,
 };
 
 typedef struct SSLCertsChain_ {
@@ -139,15 +193,15 @@ typedef struct SSLStateConnp_ {
     uint32_t handshake_length;
 
     /* the no of bytes processed in the currently parsed record */
-    uint16_t bytes_processed;
+    uint32_t bytes_processed;
     /* the no of bytes processed in the currently parsed handshake */
     uint16_t hs_bytes_processed;
 
-    /* sslv2 client hello session id length */
     uint16_t session_id_length;
 
     char *cert0_subject;
     char *cert0_issuerdn;
+    char *cert0_serial;
     time_t cert0_not_before;
     time_t cert0_not_after;
     char *cert0_fingerprint;
@@ -155,13 +209,15 @@ typedef struct SSLStateConnp_ {
     /* ssl server name indication extension */
     char *sni;
 
-    uint8_t *cert_input;
-    uint32_t cert_input_len;
+    char *session_id;
 
     TAILQ_HEAD(, SSLCertsChain_) certs;
 
     uint32_t cert_log_flag;
 
+    JA3Buffer *ja3_str;
+    char *ja3_hash;
+
     /* buffer for the tls record.
      * We use a malloced buffer, if the record is fragmented */
     uint8_t *trec;
@@ -177,12 +233,11 @@ typedef struct SSLStateConnp_ {
 typedef struct SSLState_ {
     Flow *f;
 
+    AppLayerTxData tx_data;
+
     /* holds some state flags we need */
     uint32_t flags;
 
-    /* specifies which loggers are done logging */
-    uint32_t logged;
-
     /* there might be a better place to store this*/
     uint16_t hb_record_len;
 
@@ -195,12 +250,14 @@ typedef struct SSLState_ {
     SSLStateConnp client_connp;
     SSLStateConnp server_connp;
 
-    DetectEngineState *de_state;
     AppLayerDecoderEvents *decoder_events;
 } SSLState;
 
 void RegisterSSLParsers(void);
 void SSLParserRegisterTests(void);
 void SSLSetEvent(SSLState *ssl_state, uint8_t event);
+void SSLVersionToString(uint16_t, char *);
+void SSLEnableJA3(void);
+bool SSLJA3IsEnabled(void);
 
 #endif /* __APP_LAYER_SSL_H__ */