From da8b024b993ed00dc80c4fe3080c0b8157d4d508 Mon Sep 17 00:00:00 2001 From: Victor Julien Date: Sat, 15 Jan 2022 19:24:46 +0100 Subject: [PATCH] detect/quic: add quic.sni sticky buffer --- rust/src/quic/detect.rs | 15 ++++ src/Makefile.am | 2 + src/detect-engine-register.c | 2 + src/detect-engine-register.h | 1 + src/detect-quic-sni.c | 169 +++++++++++++++++++++++++++++++++++ src/detect-quic-sni.h | 28 ++++++ 6 files changed, 217 insertions(+) create mode 100644 src/detect-quic-sni.c create mode 100644 src/detect-quic-sni.h diff --git a/rust/src/quic/detect.rs b/rust/src/quic/detect.rs index 2cff8fc94b..d09a3e3094 100644 --- 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_sni( + tx: &QuicTransaction, buffer: *mut *const u8, buffer_len: *mut u32, +) -> u8 { + if let Some(sni) = &tx.sni { + *buffer = sni.as_ptr(); + *buffer_len = sni.len() as u32; + 1 + } else { + *buffer = ptr::null(); + *buffer_len = 0; + 0 + } +} + #[no_mangle] pub unsafe extern "C" fn rs_quic_tx_get_version( tx: &QuicTransaction, buffer: *mut *const u8, buffer_len: *mut u32, diff --git a/src/Makefile.am b/src/Makefile.am index cb4f497374..24f7b1edc4 100755 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -242,6 +242,7 @@ noinst_HEADERS = \ detect-mark.h \ detect-metadata.h \ detect-modbus.h \ + detect-quic-sni.h \ detect-quic-version.h \ detect-quic-cyu-hash.h \ detect-quic-cyu-string.h \ @@ -832,6 +833,7 @@ libsuricata_c_a_SOURCES = \ detect-mark.c \ detect-metadata.c \ detect-modbus.c \ + detect-quic-sni.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 d3a7c8a425..b82b3ceacc 100644 --- a/src/detect-engine-register.c +++ b/src/detect-engine-register.c @@ -217,6 +217,7 @@ #include "detect-mqtt-publish-message.h" #include "detect-mqtt-subscribe-topic.h" #include "detect-mqtt-unsubscribe-topic.h" +#include "detect-quic-sni.h" #include "detect-quic-version.h" #include "detect-quic-cyu-hash.h" #include "detect-quic-cyu-string.h" @@ -650,6 +651,7 @@ void SigTableSetup(void) DetectMQTTPublishMessageRegister(); DetectMQTTSubscribeTopicRegister(); DetectMQTTUnsubscribeTopicRegister(); + DetectQuicSniRegister(); DetectQuicVersionRegister(); DetectQuicCyuHashRegister(); DetectQuicCyuStringRegister(); diff --git a/src/detect-engine-register.h b/src/detect-engine-register.h index ac54611516..5d4043b31e 100644 --- a/src/detect-engine-register.h +++ b/src/detect-engine-register.h @@ -287,6 +287,7 @@ enum DetectKeywordId { DETECT_AL_MQTT_SUBSCRIBE_TOPIC, DETECT_AL_MQTT_UNSUBSCRIBE_TOPIC, DETECT_AL_QUIC_VERSION, + DETECT_AL_QUIC_SNI, DETECT_AL_QUIC_CYU_HASH, DETECT_AL_QUIC_CYU_STRING, DETECT_AL_TEMPLATE_BUFFER, diff --git a/src/detect-quic-sni.c b/src/detect-quic-sni.c new file mode 100644 index 0000000000..439f6b1fb6 --- /dev/null +++ b/src/detect-quic-sni.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.sni + */ + +#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-sni.h" +#include "util-byte.h" +#include "util-unittest.h" +#include "rust.h" + +#ifdef UNITTESTS +static void DetectQuicSniRegisterTests(void); +#endif + +#define BUFFER_NAME "quic_sni" +#define KEYWORD_NAME "quic.sni" +#define KEYWORD_ID DETECT_AL_QUIC_SNI + +static int quic_sni_id = 0; + +static int DetectQuicSniSetup(DetectEngineCtx *, Signature *, const char *); + +static InspectionBuffer *GetSniData(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_sni(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.sni: keyword + */ +void DetectQuicSniRegister(void) +{ + sigmatch_table[DETECT_AL_QUIC_SNI].name = KEYWORD_NAME; + sigmatch_table[DETECT_AL_QUIC_SNI].desc = "match Quic sni"; + sigmatch_table[DETECT_AL_QUIC_SNI].url = "/rules/quic-keywords.html#quic-sni"; + sigmatch_table[DETECT_AL_QUIC_SNI].Setup = DetectQuicSniSetup; + sigmatch_table[DETECT_AL_QUIC_SNI].flags |= SIGMATCH_NOOPT | SIGMATCH_INFO_STICKY_BUFFER; +#ifdef UNITTESTS + sigmatch_table[DETECT_AL_QUIC_SNI].RegisterTests = DetectQuicSniRegisterTests; +#endif + + DetectAppLayerMpmRegister2(BUFFER_NAME, SIG_FLAG_TOSERVER, 2, PrefilterGenericMpmRegister, + GetSniData, ALPROTO_QUIC, 1); + + DetectAppLayerInspectEngineRegister2(BUFFER_NAME, ALPROTO_QUIC, SIG_FLAG_TOSERVER, 1, + DetectEngineInspectBufferGeneric, GetSniData); + + quic_sni_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 DetectQuicSniSetup(DetectEngineCtx *de_ctx, Signature *s, const char *rawstr) +{ + if (DetectBufferSetActiveList(s, quic_sni_id) < 0) + return -1; + + if (DetectSignatureSetAppProto(s, ALPROTO_QUIC) < 0) + return -1; + + return 0; +} + +#ifdef UNITTESTS + +/** + * \test QuicSniTestParse01 is a test for a valid value + * + * \retval 1 on success + * \retval 0 on failure + */ +static int QuicSniTestParse01(void) +{ + DetectEngineCtx *de_ctx = DetectEngineCtxInit(); + FAIL_IF_NULL(de_ctx); + + Signature *sig = DetectEngineAppendSig( + de_ctx, "alert ip any any -> any any (quic.sni; content:\"googe.com\"; sid:1; rev:1;)"); + FAIL_IF_NULL(sig); + + sig = DetectEngineAppendSig( + de_ctx, "alert ip any any -> any any (quic.sni; content:\"|00|\"; sid:2; rev:1;)"); + FAIL_IF_NULL(sig); + + DetectEngineCtxFree(de_ctx); + + PASS; +} + +/** + * \test QuicSniTestParse03 is a test for an invalid value + * + * \retval 1 on success + * \retval 0 on failure + */ +static int QuicSniTestParse03(void) +{ + DetectEngineCtx *de_ctx = DetectEngineCtxInit(); + FAIL_IF_NULL(de_ctx); + + Signature *sig = + DetectEngineAppendSig(de_ctx, "alert ip any any -> any any (quic.sni:; sid:1; rev:1;)"); + FAIL_IF_NOT_NULL(sig); + + DetectEngineCtxFree(de_ctx); + + PASS; +} + +/** + * \brief this function registers unit tests for QuicSni + */ +void DetectQuicSniRegisterTests(void) +{ + UtRegisterTest("QuicSniTestParse01", QuicSniTestParse01); + UtRegisterTest("QuicSniTestParse03", QuicSniTestParse03); +} + +#endif /* UNITTESTS */ diff --git a/src/detect-quic-sni.h b/src/detect-quic-sni.h new file mode 100644 index 0000000000..13e590d2c7 --- /dev/null +++ b/src/detect-quic-sni.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_SNI_H__ +#define __DETECT_QUIC_SNI_H__ + +void DetectQuicSniRegister(void); + +#endif /* __DETECT_QUIC_SNI_H__ */