1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
/* Copyright (C) 2007-2014 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
*
* \author Victor Julien <victor@inliniac.net>
* \author Anoop Saldanha <anoopsaldanha@gmail.com>
*/
#ifndef __APP_LAYER_DETECT_PROTO__H__
#define __APP_LAYER_DETECT_PROTO__H__
#include "flow.h"
#include "app-layer-protos.h"
typedef struct AppLayerProtoDetectThreadCtx_ AppLayerProtoDetectThreadCtx;
typedef AppProto (*ProbingParserFPtr)(
Flow *f, uint8_t flags, const uint8_t *input, uint32_t input_len, uint8_t *rdir);
/***** Protocol Retrieval *****/
/**
* \brief Returns the app layer protocol given a buffer.
*
* \param tctx Pointer to the app layer protocol detection thread context.
* \param f Pointer to the flow.
* \param buf The buffer to be inspected.
* \param buflen The length of the above buffer.
* \param ipproto The ip protocol.
* \param flags The direction bitfield - STREAM_TOSERVER/STREAM_TOCLIENT.
* \param[out] reverse_flow true if flow is detected to be reversed
*
* \retval The app layer protocol.
*/
AppProto AppLayerProtoDetectGetProto(AppLayerProtoDetectThreadCtx *tctx, Flow *f,
const uint8_t *buf, uint32_t buflen, uint8_t ipproto, uint8_t flags, bool *reverse_flow);
/***** State Preparation *****/
/**
* \brief Prepares the internal state for protocol detection.
* This needs to be called once all the patterns and probing parser
* ports have been registered.
*/
int AppLayerProtoDetectPrepareState(void);
/***** PP registration *****/
void AppLayerProtoDetectPPRegister(uint8_t ipproto,
const char *portstr,
AppProto alproto,
uint16_t min_depth, uint16_t max_depth,
uint8_t direction,
ProbingParserFPtr ProbingParser1,
ProbingParserFPtr ProbingParser2);
/**
* \retval bool 0 if no config was found, 1 if config was found
*/
int AppLayerProtoDetectPPParseConfPorts(const char *ipproto_name,
uint8_t ipproto,
const char *alproto_name,
AppProto alproto,
uint16_t min_depth, uint16_t max_depth,
ProbingParserFPtr ProbingParserTs,
ProbingParserFPtr ProbingParserTc);
/***** PM registration *****/
/**
* \brief Registers a case-sensitive pattern for protocol detection.
*/
int AppLayerProtoDetectPMRegisterPatternCS(uint8_t ipproto, AppProto alproto,
const char *pattern, uint16_t depth, uint16_t offset,
uint8_t direction);
int AppLayerProtoDetectPMRegisterPatternCSwPP(uint8_t ipproto, AppProto alproto,
const char *pattern, uint16_t depth, uint16_t offset,
uint8_t direction,
ProbingParserFPtr PPFunc,
uint16_t pp_min_depth, uint16_t pp_max_depth);
/**
* \brief Registers a case-insensitive pattern for protocol detection.
*/
int AppLayerProtoDetectPMRegisterPatternCI(uint8_t ipproto, AppProto alproto,
const char *pattern,
uint16_t depth, uint16_t offset,
uint8_t direction);
/***** Setup/General Registration *****/
/**
* \brief The first function to be called. This initializes a global
* protocol detection context.
*
* \retval 0 On success;
* \retval -1 On failure.
*/
int AppLayerProtoDetectSetup(void);
/**
* \brief Reset proto detect for flow
*/
void AppLayerProtoDetectReset(Flow *);
bool AppLayerRequestProtocolChange(Flow *f, uint16_t dp, AppProto expect_proto);
bool AppLayerRequestProtocolTLSUpgrade(Flow *f);
/**
* \brief Cleans up the app layer protocol detection phase.
*/
int AppLayerProtoDetectDeSetup(void);
/**
* \brief Registers a protocol for protocol detection phase.
*
* This is the first function to be called after calling the
* setup function, AppLayerProtoDetectSetup(), before calling any other
* app layer functions, AppLayerParser or AppLayerProtoDetect, alike.
* With this function you are associating/registering a string
* that can be used by users to write rules, i.e.
* you register the http protocol for protocol detection using
* AppLayerProtoDetectRegisterProtocol(ctx, ALPROTO_HTTP1, "http"),
* following which you can write rules like -
* alert http any any -> any any (sid:1;)
* which basically matches on the HTTP protocol.
*
* \param alproto The protocol.
* \param alproto_str The string to associate with the above "alproto".
* Please send a static string that won't be destroyed
* post making this call, since this function won't
* create a copy of the received argument.
*
* \retval 0 On success;
* -1 On failure.
*/
void AppLayerProtoDetectRegisterProtocol(AppProto alproto, const char *alproto_name);
void AppLayerProtoDetectRegisterAlias(const char *proto_name, const char *proto_alias);
/**
* \brief Given a protocol name, checks if proto detection is enabled in
* the conf file.
*
* \param alproto Name of the app layer protocol.
*
* \retval 1 If enabled.
* \retval 0 If disabled.
*/
int AppLayerProtoDetectConfProtoDetectionEnabled(const char *ipproto,
const char *alproto);
/**
* \brief Given a protocol name, checks if proto detection is enabled in
* the conf file.
*
* \param alproto Name of the app layer protocol.
* \param default_enabled enable by default if not in the configuration file
*
* \retval 1 If enabled.
* \retval 0 If disabled.
*/
int AppLayerProtoDetectConfProtoDetectionEnabledDefault(
const char *ipproto, const char *alproto, bool default_enabled);
/**
* \brief Inits and returns an app layer protocol detection thread context.
* \param ctx Pointer to the app layer protocol detection context.
*
* \retval Pointer to the thread context, on success;
* NULL, on failure.
*/
AppLayerProtoDetectThreadCtx *AppLayerProtoDetectGetCtxThread(void);
/**
* \brief Destroys the app layer protocol detection thread context.
*
* \param tctx Pointer to the app layer protocol detection thread context.
*/
void AppLayerProtoDetectDestroyCtxThread(AppLayerProtoDetectThreadCtx *tctx);
/***** Utility *****/
void AppLayerProtoDetectSupportedIpprotos(AppProto alproto, uint8_t *ipprotos);
AppProto AppLayerProtoDetectGetProtoByName(const char *alproto_name);
const char *AppLayerProtoDetectGetProtoName(AppProto alproto);
void AppLayerProtoDetectSupportedAppProtocols(AppProto *alprotos);
void AppLayerRegisterExpectationProto(uint8_t proto, AppProto alproto);
/***** Unittests *****/
#ifdef UNITTESTS
/**
* \brief Backs up the internal context used by the app layer proto detection
* module.
*/
void AppLayerProtoDetectUnittestCtxBackup(void);
/**
* \brief Restores back the internal context used by the app layer proto
* detection module, that was previously backed up by calling
* AppLayerProtoDetectUnittestCtxBackup().
*/
void AppLayerProtoDetectUnittestCtxRestore(void);
/**
* \brief Register unittests for app layer proto detection module.
*/
void AppLayerProtoDetectUnittestsRegister(void);
#endif /* UNITTESTS */
#endif /* __APP_LAYER_DETECT_PROTO__H__ */
|
