quic: add quic.ua for matching user agent

diff --git a/rust/src/quic/detect.rs b/rust/src/quic/detect.rs
index d09a3e309408a62e3240e17fc0f45677d40c1ce7..d5bb75c956a7672ba0b361568c92f96281c7597d 100644 (file)
--- a/rust/src/quic/detect.rs
+++ b/rust/src/quic/detect.rs
@@ -18,6 +18,21 @@
 use crate::quic::quic::{QuicTransaction};
 use std::ptr;
 
+#[no_mangle]
+pub unsafe extern "C" fn rs_quic_tx_get_ua(
+    tx: &QuicTransaction, buffer: *mut *const u8, buffer_len: *mut u32,
+) -> u8 {
+    if let Some(ua) = &tx.ua {
+        *buffer = ua.as_ptr();
+        *buffer_len = ua.len() as u32;
+        1
+    } else {
+        *buffer = ptr::null();
+        *buffer_len = 0;
+        0
+    }
+}
+
 #[no_mangle]
 pub unsafe extern "C" fn rs_quic_tx_get_sni(
     tx: &QuicTransaction, buffer: *mut *const u8, buffer_len: *mut u32,

diff --git a/src/Makefile.am b/src/Makefile.am
index 24f7b1edc4f71194280940c0cd305bb38967b8d2..87d3e89dccf762a8d974140c34a0d67718c6d306 100755 (executable)
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -243,6 +243,7 @@ noinst_HEADERS = \
        detect-metadata.h \
        detect-modbus.h \
        detect-quic-sni.h \
+       detect-quic-ua.h \
        detect-quic-version.h \
        detect-quic-cyu-hash.h \
        detect-quic-cyu-string.h \
@@ -834,6 +835,7 @@ libsuricata_c_a_SOURCES = \
        detect-metadata.c \
        detect-modbus.c \
        detect-quic-sni.c \
+       detect-quic-ua.c \
        detect-quic-version.c \
        detect-quic-cyu-hash.c \
        detect-quic-cyu-string.c \

diff --git a/src/detect-engine-register.c b/src/detect-engine-register.c
index b82b3ceacc31e687611b99b7199465a0782aaebe..4a54e429455d27e1a7f793b6e8712f66aa5d9c1f 100644 (file)
--- a/src/detect-engine-register.c
+++ b/src/detect-engine-register.c
@@ -218,6 +218,7 @@
 #include "detect-mqtt-subscribe-topic.h"
 #include "detect-mqtt-unsubscribe-topic.h"
 #include "detect-quic-sni.h"
+#include "detect-quic-ua.h"
 #include "detect-quic-version.h"
 #include "detect-quic-cyu-hash.h"
 #include "detect-quic-cyu-string.h"
@@ -652,6 +653,7 @@ void SigTableSetup(void)
     DetectMQTTSubscribeTopicRegister();
     DetectMQTTUnsubscribeTopicRegister();
     DetectQuicSniRegister();
+    DetectQuicUaRegister();
     DetectQuicVersionRegister();
     DetectQuicCyuHashRegister();
     DetectQuicCyuStringRegister();

diff --git a/src/detect-engine-register.h b/src/detect-engine-register.h
index 5d4043b31eadadb2e1b89d899191138c154163b7..57e30bb4d7f85c0cbcacaae35f5a3aaa17a7c3e4 100644 (file)
--- a/src/detect-engine-register.h
+++ b/src/detect-engine-register.h
@@ -288,6 +288,7 @@ enum DetectKeywordId {
     DETECT_AL_MQTT_UNSUBSCRIBE_TOPIC,
     DETECT_AL_QUIC_VERSION,
     DETECT_AL_QUIC_SNI,
+    DETECT_AL_QUIC_UA,
     DETECT_AL_QUIC_CYU_HASH,
     DETECT_AL_QUIC_CYU_STRING,
     DETECT_AL_TEMPLATE_BUFFER,

diff --git a/src/detect-quic-ua.c b/src/detect-quic-ua.c
new file mode 100644 (file)
index 0000000..b90f4fc
--- /dev/null
+++ b/src/detect-quic-ua.c
@@ -0,0 +1,169 @@
+/* Copyright (C) 2022 Open Information Security Foundation
+ *
+ * You can copy, redistribute or modify this Program under the terms of
+ * the GNU General Public License version 2 as published by the Free
+ * Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * version 2 along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ */
+
+/**
+ *
+ * Implements the quic.ua
+ */
+
+#include "suricata-common.h"
+#include "conf.h"
+#include "detect.h"
+#include "detect-parse.h"
+#include "detect-engine.h"
+#include "detect-engine-prefilter.h"
+#include "detect-engine-mpm.h"
+#include "detect-engine-content-inspection.h"
+#include "detect-engine-uint.h"
+#include "detect-quic-ua.h"
+#include "util-byte.h"
+#include "util-unittest.h"
+#include "rust.h"
+
+#ifdef UNITTESTS
+static void DetectQuicUaRegisterTests(void);
+#endif
+
+#define BUFFER_NAME  "quic_ua"
+#define KEYWORD_NAME "quic.ua"
+#define KEYWORD_ID   DETECT_AL_QUIC_UA
+
+static int quic_ua_id = 0;
+
+static int DetectQuicUaSetup(DetectEngineCtx *, Signature *, const char *);
+
+static InspectionBuffer *GetUaData(DetectEngineThreadCtx *det_ctx,
+        const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,
+        const int list_id)
+{
+    InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
+    if (buffer->inspect == NULL) {
+        uint32_t b_len = 0;
+        const uint8_t *b = NULL;
+
+        if (rs_quic_tx_get_ua(txv, &b, &b_len) != 1)
+            return NULL;
+        if (b == NULL || b_len == 0)
+            return NULL;
+
+        InspectionBufferSetup(det_ctx, list_id, buffer, b, b_len);
+        InspectionBufferApplyTransforms(buffer, transforms);
+    }
+    return buffer;
+}
+
+/**
+ * \brief Registration function for quic.ua: keyword
+ */
+void DetectQuicUaRegister(void)
+{
+    sigmatch_table[DETECT_AL_QUIC_UA].name = KEYWORD_NAME;
+    sigmatch_table[DETECT_AL_QUIC_UA].desc = "match Quic ua";
+    sigmatch_table[DETECT_AL_QUIC_UA].url = "/rules/quic-keywords.html#quic-ua";
+    sigmatch_table[DETECT_AL_QUIC_UA].Setup = DetectQuicUaSetup;
+    sigmatch_table[DETECT_AL_QUIC_UA].flags |= SIGMATCH_NOOPT | SIGMATCH_INFO_STICKY_BUFFER;
+#ifdef UNITTESTS
+    sigmatch_table[DETECT_AL_QUIC_UA].RegisterTests = DetectQuicUaRegisterTests;
+#endif
+
+    DetectAppLayerMpmRegister2(BUFFER_NAME, SIG_FLAG_TOSERVER, 2, PrefilterGenericMpmRegister,
+            GetUaData, ALPROTO_QUIC, 1);
+
+    DetectAppLayerInspectEngineRegister2(BUFFER_NAME, ALPROTO_QUIC, SIG_FLAG_TOSERVER, 1,
+            DetectEngineInspectBufferGeneric, GetUaData);
+
+    quic_ua_id = DetectBufferTypeGetByName(BUFFER_NAME);
+}
+
+/**
+ * \internal
+ * \brief this function is used to add the parsed sigmatch  into the current signature
+ *
+ * \param de_ctx pointer to the Detection Engine Context
+ * \param s pointer to the Current Signature
+ * \param rawstr pointer to the user provided options
+ *
+ * \retval 0 on Success
+ * \retval -1 on Failure
+ */
+static int DetectQuicUaSetup(DetectEngineCtx *de_ctx, Signature *s, const char *rawstr)
+{
+    if (DetectBufferSetActiveList(s, quic_ua_id) < 0)
+        return -1;
+
+    if (DetectSignatureSetAppProto(s, ALPROTO_QUIC) < 0)
+        return -1;
+
+    return 0;
+}
+
+#ifdef UNITTESTS
+
+/**
+ * \test QuicUaTestParse01 is a test for a valid value
+ *
+ *  \retval 1 on success
+ *  \retval 0 on failure
+ */
+static int QuicUaTestParse01(void)
+{
+    DetectEngineCtx *de_ctx = DetectEngineCtxInit();
+    FAIL_IF_NULL(de_ctx);
+
+    Signature *sig = DetectEngineAppendSig(
+            de_ctx, "alert ip any any -> any any (quic.ua; content:\"googe.com\"; sid:1; rev:1;)");
+    FAIL_IF_NULL(sig);
+
+    sig = DetectEngineAppendSig(
+            de_ctx, "alert ip any any -> any any (quic.ua; content:\"|00|\"; sid:2; rev:1;)");
+    FAIL_IF_NULL(sig);
+
+    DetectEngineCtxFree(de_ctx);
+
+    PASS;
+}
+
+/**
+ * \test QuicUaTestParse03 is a test for an invalid value
+ *
+ *  \retval 1 on success
+ *  \retval 0 on failure
+ */
+static int QuicUaTestParse03(void)
+{
+    DetectEngineCtx *de_ctx = DetectEngineCtxInit();
+    FAIL_IF_NULL(de_ctx);
+
+    Signature *sig =
+            DetectEngineAppendSig(de_ctx, "alert ip any any -> any any (quic.ua:; sid:1; rev:1;)");
+    FAIL_IF_NOT_NULL(sig);
+
+    DetectEngineCtxFree(de_ctx);
+
+    PASS;
+}
+
+/**
+ * \brief this function registers unit tests for QuicUa
+ */
+void DetectQuicUaRegisterTests(void)
+{
+    UtRegisterTest("QuicUaTestParse01", QuicUaTestParse01);
+    UtRegisterTest("QuicUaTestParse03", QuicUaTestParse03);
+}
+
+#endif /* UNITTESTS */

diff --git a/src/detect-quic-ua.h b/src/detect-quic-ua.h
new file mode 100644 (file)
index 0000000..bf6e063
--- /dev/null
+++ b/src/detect-quic-ua.h
@@ -0,0 +1,28 @@
+/* Copyright (C) 2022 Open Information Security Foundation
+ *
+ * You can copy, redistribute or modify this Program under the terms of
+ * the GNU General Public License version 2 as published by the Free
+ * Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * version 2 along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ */
+
+/**
+ * \file
+ *
+ */
+
+#ifndef __DETECT_QUIC_UA_H__
+#define __DETECT_QUIC_UA_H__
+
+void DetectQuicUaRegister(void);
+
+#endif /* __DETECT_QUIC_UA_H__ */