suricata
detect-transform-sha1.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2020 Open Information Security Foundation
2  *
3  * You can copy, redistribute or modify this Program under the terms of
4  * the GNU General Public License version 2 as published by the Free
5  * Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * version 2 along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 
18 /**
19  * \file
20  *
21  * \author Victor Julien <victor@inliniac.net>
22  *
23  * Implements the sha1 transformation keyword
24  */
25 
26 #include "suricata-common.h"
27 
28 #include "detect.h"
29 #include "detect-engine.h"
30 #include "detect-engine-prefilter.h"
31 #include "detect-parse.h"
32 #include "detect-transform-sha1.h"
33 
34 #include "util-unittest.h"
35 #include "util-print.h"
36 
37 static int DetectTransformToSha1Setup (DetectEngineCtx *, Signature *, const char *);
38 #ifdef HAVE_NSS
39 static void DetectTransformToSha1RegisterTests(void);
40 static void TransformToSha1(InspectionBuffer *buffer, void *options);
41 #endif
42 
43 void DetectTransformSha1Register(void)
44 {
45  sigmatch_table[DETECT_TRANSFORM_SHA1].name = "to_sha1";
46  sigmatch_table[DETECT_TRANSFORM_SHA1].desc =
47  "convert to sha1 hash of the buffer";
48  sigmatch_table[DETECT_TRANSFORM_SHA1].url =
49  "/rules/transforms.html#to-sha1";
50  sigmatch_table[DETECT_TRANSFORM_SHA1].Setup =
51  DetectTransformToSha1Setup;
52 #ifdef HAVE_NSS
53  sigmatch_table[DETECT_TRANSFORM_SHA1].Transform =
54  TransformToSha1;
55  sigmatch_table[DETECT_TRANSFORM_SHA1].RegisterTests =
56  DetectTransformToSha1RegisterTests;
57 #endif
58  sigmatch_table[DETECT_TRANSFORM_SHA1].flags |= SIGMATCH_NOOPT;
59 }
60 
61 #ifndef HAVE_NSS
62 static int DetectTransformToSha1Setup (DetectEngineCtx *de_ctx, Signature *s, const char *nullstr)
63 {
64  SCLogError(SC_ERR_NO_SHA1_SUPPORT, "no SHA-1 calculation support built in, "
65  "needed for to_sha1 keyword");
66  return -1;
67 }
68 #else
69 /**
70  * \internal
71  * \brief Apply the nocase keyword to the last pattern match, either content or uricontent
72  * \param det_ctx detection engine ctx
73  * \param s signature
74  * \param nullstr should be null
75  * \retval 0 ok
76  * \retval -1 failure
77  */
78 static int DetectTransformToSha1Setup (DetectEngineCtx *de_ctx, Signature *s, const char *nullstr)
79 {
80  SCEnter();
81  int r = DetectSignatureAddTransform(s, DETECT_TRANSFORM_SHA1, NULL);
82  SCReturnInt(r);
83 }
84 
85 static void TransformToSha1(InspectionBuffer *buffer, void *options)
86 {
87  const uint8_t *input = buffer->inspect;
88  const uint32_t input_len = buffer->inspect_len;
89  uint8_t output[SHA1_LENGTH];
90 
91  //PrintRawDataFp(stdout, input, input_len);
92 
93  HASHContext *sha1_ctx = HASH_Create(HASH_AlgSHA1);
94  if (sha1_ctx) {
95  HASH_Begin(sha1_ctx);
96  HASH_Update(sha1_ctx, input, input_len);
97  unsigned int len = 0;
98  HASH_End(sha1_ctx, output, &len, sizeof(output));
99  HASH_Destroy(sha1_ctx);
100 
101  InspectionBufferCopy(buffer, output, sizeof(output));
102  }
103 }
104 
105 #ifdef UNITTESTS
106 static int DetectTransformToSha1Test01(void)
107 {
108  const uint8_t *input = (const uint8_t *)" A B C D ";
109  uint32_t input_len = strlen((char *)input);
110 
111  InspectionBuffer buffer;
112  InspectionBufferInit(&buffer, 8);
113  InspectionBufferSetup(&buffer, input, input_len);
114  PrintRawDataFp(stdout, buffer.inspect, buffer.inspect_len);
115  TransformToSha1(&buffer, NULL);
116  PrintRawDataFp(stdout, buffer.inspect, buffer.inspect_len);
117  InspectionBufferFree(&buffer);
118  PASS;
119 }
120 
121 #endif
122 
123 static void DetectTransformToSha1RegisterTests(void)
124 {
125 #ifdef UNITTESTS
126  UtRegisterTest("DetectTransformToSha1Test01",
127  DetectTransformToSha1Test01);
128 #endif
129 }
130 #endif
SigTableElmt_::url
const char * url
Definition: detect.h:1212
len
uint8_t len
Definition: app-layer-dnp3.h:2
detect-engine.h
SigTableElmt_::desc
const char * desc
Definition: detect.h:1211
SigTableElmt_::name
const char * name
Definition: detect.h:1209
UtRegisterTest
void UtRegisterTest(const char *name, int(*TestFn)(void))
Register unit test.
Definition: util-unittest.c:103
InspectionBuffer
Definition: detect.h:343
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1203
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:766
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1195
SHA1_LENGTH
#define SHA1_LENGTH
Definition: util-crypt.h:45
detect-engine-prefilter.h
util-unittest.h
InspectionBufferInit
void InspectionBufferInit(InspectionBuffer *buffer, uint32_t initial_size)
Definition: detect-engine.c:1106
DETECT_TRANSFORM_SHA1
@ DETECT_TRANSFORM_SHA1
Definition: detect-engine-register.h:263
PASS
#define PASS
Pass the test.
Definition: util-unittest.h:105
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
util-print.h
SCEnter
#define SCEnter(...)
Definition: util-debug.h:300
detect.h
PrintRawDataFp
void PrintRawDataFp(FILE *fp, const uint8_t *buf, uint32_t buflen)
Definition: util-print.c:141
SC_ERR_NO_SHA1_SUPPORT
@ SC_ERR_NO_SHA1_SUPPORT
Definition: util-error.h:320
InspectionBufferCopy
void InspectionBufferCopy(InspectionBuffer *buffer, uint8_t *buf, uint32_t buf_len)
Definition: detect-engine.c:1152
suricata-common.h
InspectionBufferSetup
void InspectionBufferSetup(InspectionBuffer *buffer, const uint8_t *data, const uint32_t data_len)
setup the buffer with our initial data
Definition: detect-engine.c:1116
sigmatch_table
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect-parse.c:73
SigTableElmt_::Transform
void(* Transform)(InspectionBuffer *, void *context)
Definition: detect.h:1191
SCLogError
#define SCLogError(err_code,...)
Macro used to log ERROR messages.
Definition: util-debug.h:257
DetectTransformSha1Register
void DetectTransformSha1Register(void)
Definition: detect-transform-sha1.c:43
InspectionBuffer::inspect_len
uint32_t inspect_len
Definition: detect.h:346
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect.h:344
detect-parse.h
Signature_
Signature container.
Definition: detect.h:527
DetectSignatureAddTransform
int DetectSignatureAddTransform(Signature *s, int transform, void *options)
Definition: detect-parse.c:1443
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1378
detect-transform-sha1.h
SCReturnInt
#define SCReturnInt(x)
Definition: util-debug.h:304
InspectionBufferFree
void InspectionBufferFree(InspectionBuffer *buffer)
Definition: detect-engine.c:1123
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1201