suricata
app-layer-parser.h
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  * \author Anoop Saldanha <anoopsaldanha@gmail.com>
23  */
24 
25 #ifndef SURICATA_APP_LAYER_PARSER_H
26 #define SURICATA_APP_LAYER_PARSER_H
27 
28 #include "app-layer-events.h"
29 #include "util-file.h"
30 #include "rust.h"
31 #include "util-config.h"
32 
33 /* Flags for AppLayerParserState. */
34 // flag available BIT_U16(0)
35 #define APP_LAYER_PARSER_NO_INSPECTION BIT_U16(1)
36 #define APP_LAYER_PARSER_NO_REASSEMBLY BIT_U16(2)
37 #define APP_LAYER_PARSER_NO_INSPECTION_PAYLOAD BIT_U16(3)
38 #define APP_LAYER_PARSER_BYPASS_READY BIT_U16(4)
39 #define APP_LAYER_PARSER_EOF_TS BIT_U16(5)
40 #define APP_LAYER_PARSER_EOF_TC BIT_U16(6)
41 /* 2x vacancy */
42 #define APP_LAYER_PARSER_SFRAME_TS BIT_U16(9)
43 #define APP_LAYER_PARSER_SFRAME_TC BIT_U16(10)
44 
45 /* Flags for AppLayerParserProtoCtx. */
46 #define APP_LAYER_PARSER_OPT_ACCEPT_GAPS BIT_U32(0)
47 
48 #define APP_LAYER_PARSER_INT_STREAM_DEPTH_SET BIT_U32(0)
49 
50 /* applies to DetectFlags uint64_t field */
51 
52 /** reserved for future use */
53 #define APP_LAYER_TX_RESERVED1_FLAG BIT_U64(48)
54 #define APP_LAYER_TX_RESERVED2_FLAG BIT_U64(49)
55 #define APP_LAYER_TX_RESERVED3_FLAG BIT_U64(50)
56 #define APP_LAYER_TX_RESERVED4_FLAG BIT_U64(51)
57 #define APP_LAYER_TX_RESERVED5_FLAG BIT_U64(52)
58 #define APP_LAYER_TX_RESERVED6_FLAG BIT_U64(53)
59 #define APP_LAYER_TX_RESERVED7_FLAG BIT_U64(54)
60 #define APP_LAYER_TX_RESERVED8_FLAG BIT_U64(55)
61 #define APP_LAYER_TX_RESERVED9_FLAG BIT_U64(56)
62 #define APP_LAYER_TX_RESERVED10_FLAG BIT_U64(57)
63 #define APP_LAYER_TX_RESERVED11_FLAG BIT_U64(58)
64 #define APP_LAYER_TX_RESERVED12_FLAG BIT_U64(59)
65 #define APP_LAYER_TX_RESERVED13_FLAG BIT_U64(60)
66 #define APP_LAYER_TX_RESERVED14_FLAG BIT_U64(61)
67 
68 #define APP_LAYER_TX_RESERVED_FLAGS \
69  (APP_LAYER_TX_RESERVED1_FLAG | APP_LAYER_TX_RESERVED2_FLAG | APP_LAYER_TX_RESERVED3_FLAG | \
70  APP_LAYER_TX_RESERVED4_FLAG | APP_LAYER_TX_RESERVED5_FLAG | \
71  APP_LAYER_TX_RESERVED6_FLAG | APP_LAYER_TX_RESERVED7_FLAG | \
72  APP_LAYER_TX_RESERVED8_FLAG | APP_LAYER_TX_RESERVED9_FLAG | \
73  APP_LAYER_TX_RESERVED10_FLAG | APP_LAYER_TX_RESERVED11_FLAG | \
74  APP_LAYER_TX_RESERVED12_FLAG | APP_LAYER_TX_RESERVED13_FLAG | \
75  APP_LAYER_TX_RESERVED14_FLAG)
76 
77 /** should inspection be skipped in that direction */
78 #define APP_LAYER_TX_SKIP_INSPECT_FLAG BIT_U64(62)
79 /** is tx fully inspected? */
80 #define APP_LAYER_TX_INSPECTED_FLAG BIT_U64(63)
81 /** other 63 bits are for tracking which prefilter engine is already
82  * completely inspected */
83 #define APP_LAYER_TX_PREFILTER_MASK ~(APP_LAYER_TX_INSPECTED_FLAG | APP_LAYER_TX_RESERVED_FLAGS)
84 
85 /** parser has successfully processed in the input, and has consumed
86  * all of it. */
87 #define APP_LAYER_OK (AppLayerResult) { 0, 0, 0 }
88 
89 /** parser has hit an unrecoverable error. Returning this to the API
90  * leads to no further calls to the parser. */
91 #define APP_LAYER_ERROR (AppLayerResult) { -1, 0, 0 }
92 
93 /** parser needs more data. Through 'c' it will indicate how many
94  * of the input bytes it has consumed. Through 'n' it will indicate
95  * how many more bytes it needs before getting called again.
96  * \note consumed (c) should never be more than the input len
97  * needed (n) + consumed (c) should be more than the input len
98  */
99 #define APP_LAYER_INCOMPLETE(c,n) (AppLayerResult) { 1, (c), (n) }
100 
101 int AppLayerParserProtoIsRegistered(uint8_t ipproto, AppProto alproto);
102 
103 /***** transaction handling *****/
104 
105 int AppLayerParserSetup(void);
108 
110 
111 /**
112  * \brief Gets a new app layer protocol's parser thread context.
113  *
114  * \retval Non-NULL pointer on success.
115  * NULL pointer on failure.
116  */
118 
119 /**
120  * \brief Destroys the app layer parser thread context obtained
121  * using AppLayerParserThreadCtxAlloc().
122  *
123  * \param tctx Pointer to the thread context to be destroyed.
124  */
126 
127 /**
128  * \brief Given a protocol name, checks if the parser is enabled in
129  * the conf file.
130  *
131  * \param alproto_name Name of the app layer protocol.
132  *
133  * \retval 1 If enabled.
134  * \retval 0 If disabled.
135  */
136 int AppLayerParserConfParserEnabled(const char *ipproto,
137  const char *alproto_name);
138 
139 /** \brief Prototype for parsing functions */
140 typedef AppLayerResult (*AppLayerParserFPtr)(Flow *f, void *protocol_state,
141  AppLayerParserState *pstate, StreamSlice stream_slice, void *local_storage);
142 
143 typedef struct AppLayerGetTxIterState {
144  union {
145  void *ptr;
146  uint64_t u64;
147  } un;
149 
150 /** \brief tx iterator prototype */
151 typedef AppLayerGetTxIterTuple (*AppLayerGetTxIteratorFunc)
152  (const uint8_t ipproto, const AppProto alproto,
153  void *alstate, uint64_t min_tx_id, uint64_t max_tx_id,
154  AppLayerGetTxIterState *state);
155 
156 /***** Parser related registration *****/
157 
158 typedef int (*AppLayerParserGetFrameIdByNameFn)(const char *frame_name);
159 typedef const char *(*AppLayerParserGetFrameNameByIdFn)(const uint8_t id);
160 
161 /**
162  * \brief Register app layer parser for the protocol.
163  *
164  * \retval 0 On success.
165  * \retval -1 On failure.
166  */
167 int AppLayerParserRegisterParser(uint8_t ipproto, AppProto alproto,
168  uint8_t direction,
169  AppLayerParserFPtr Parser);
171  AppProto alproto,
172  uint8_t direction);
173 void AppLayerParserRegisterOptionFlags(uint8_t ipproto, AppProto alproto,
174  uint32_t flags);
175 void AppLayerParserRegisterStateFuncs(uint8_t ipproto, AppProto alproto,
176  void *(*StateAlloc)(void *, AppProto), void (*StateFree)(void *));
178  void *(*LocalStorageAlloc)(void), void (*LocalStorageFree)(void *));
179 // void AppLayerParserRegisterGetEventsFunc(uint8_t ipproto, AppProto proto,
180 // AppLayerDecoderEvents *(*StateGetEvents)(void *) __attribute__((nonnull)));
182  uint8_t ipproto, AppProto alproto, AppLayerGetFileState (*GetTxFiles)(void *, uint8_t));
183 void AppLayerParserRegisterLogger(uint8_t ipproto, AppProto alproto);
184 void AppLayerParserRegisterLoggerBits(uint8_t ipproto, AppProto alproto, LoggerId bits);
185 void AppLayerParserRegisterGetStateProgressFunc(uint8_t ipproto, AppProto alproto,
186  int (*StateGetStateProgress)(void *alstate, uint8_t direction));
187 void AppLayerParserRegisterTxFreeFunc(uint8_t ipproto, AppProto alproto,
188  void (*StateTransactionFree)(void *, uint64_t));
189 void AppLayerParserRegisterGetTxCnt(uint8_t ipproto, AppProto alproto,
190  uint64_t (*StateGetTxCnt)(void *alstate));
191 void AppLayerParserRegisterGetTx(uint8_t ipproto, AppProto alproto,
192  void *(StateGetTx)(void *alstate, uint64_t tx_id));
193 void AppLayerParserRegisterGetTxIterator(uint8_t ipproto, AppProto alproto,
196  AppProto alproto, const int ts, const int tc);
197 void AppLayerParserRegisterGetEventInfo(uint8_t ipproto, AppProto alproto,
198  int (*StateGetEventInfo)(const char *event_name, int *event_id,
199  AppLayerEventType *event_type));
200 void AppLayerParserRegisterGetEventInfoById(uint8_t ipproto, AppProto alproto,
201  int (*StateGetEventInfoById)(int event_id, const char **event_name,
202  AppLayerEventType *event_type));
203 void AppLayerParserRegisterGetFrameFuncs(uint8_t ipproto, AppProto alproto,
204  AppLayerParserGetFrameIdByNameFn GetFrameIdByName,
205  AppLayerParserGetFrameNameByIdFn GetFrameNameById);
206 void AppLayerParserRegisterSetStreamDepthFlag(uint8_t ipproto, AppProto alproto,
207  void (*SetStreamDepthFlag)(void *tx, uint8_t flags));
208 
209 void AppLayerParserRegisterTxDataFunc(uint8_t ipproto, AppProto alproto,
210  AppLayerTxData *(*GetTxData)(void *tx));
211 void AppLayerParserRegisterApplyTxConfigFunc(uint8_t ipproto, AppProto alproto,
212  bool (*ApplyTxConfig)(void *state, void *tx, int mode, AppLayerTxConfig));
214  uint8_t ipproto, AppProto alproto, AppLayerStateData *(*GetStateData)(void *state));
215 
216 /***** Get and transaction functions *****/
217 
219  const AppProto alproto);
220 
221 void *AppLayerParserGetProtocolParserLocalStorage(uint8_t ipproto, AppProto alproto);
222 void AppLayerParserDestroyProtocolParserLocalStorage(uint8_t ipproto, AppProto alproto,
223  void *local_data);
224 
225 
227 void AppLayerParserSetTransactionLogId(AppLayerParserState *pstate, uint64_t tx_id);
228 
229 uint64_t AppLayerParserGetTransactionInspectId(AppLayerParserState *pstate, uint8_t direction);
231  void *alstate, const uint8_t flags, bool tag_txs_as_inspected);
232 
234 AppLayerDecoderEvents *AppLayerParserGetEventsByTx(uint8_t ipproto, AppProto alproto, void *tx);
235 AppLayerGetFileState AppLayerParserGetTxFiles(const Flow *f, void *tx, const uint8_t direction);
236 int AppLayerParserGetStateProgress(uint8_t ipproto, AppProto alproto,
237  void *alstate, uint8_t direction);
238 uint64_t AppLayerParserGetTxCnt(const Flow *, void *alstate);
239 void *AppLayerParserGetTx(uint8_t ipproto, AppProto alproto, void *alstate, uint64_t tx_id);
240 int AppLayerParserGetStateProgressCompletionStatus(AppProto alproto, uint8_t direction);
241 int AppLayerParserGetEventInfo(uint8_t ipproto, AppProto alproto, const char *event_name,
242  int *event_id, AppLayerEventType *event_type);
243 int AppLayerParserGetEventInfoById(uint8_t ipproto, AppProto alproto, int event_id,
244  const char **event_name, AppLayerEventType *event_type);
245 
246 uint64_t AppLayerParserGetTransactionActive(const Flow *f, AppLayerParserState *pstate, uint8_t direction);
247 
248 uint8_t AppLayerParserGetFirstDataDir(uint8_t ipproto, AppProto alproto);
249 
250 bool AppLayerParserSupportsFiles(uint8_t ipproto, AppProto alproto);
251 
252 AppLayerTxData *AppLayerParserGetTxData(uint8_t ipproto, AppProto alproto, void *tx);
253 uint64_t AppLayerParserGetTxDetectFlags(AppLayerTxData *txd, const uint8_t dir);
254 AppLayerStateData *AppLayerParserGetStateData(uint8_t ipproto, AppProto alproto, void *state);
255 void AppLayerParserApplyTxConfig(uint8_t ipproto, AppProto alproto,
256  void *state, void *tx, enum ConfigAction mode, AppLayerTxConfig);
257 
258 static inline bool AppLayerParserIsFileTx(const AppLayerTxData *txd)
259 {
260  if (txd->file_tx != 0) {
261  return true;
262  }
263  return false;
264 }
265 
266 static inline bool AppLayerParserIsFileTxInDir(const AppLayerTxData *txd, const uint8_t direction)
267 {
268  if ((txd->file_tx & direction) != 0) {
269  return true;
270  }
271  return false;
272 }
273 
274 /** \brief check if tx (possibly) has files in this tx for the direction */
275 static inline bool AppLayerParserHasFilesInDir(const AppLayerTxData *txd, const uint8_t direction)
276 {
277  return (txd->files_opened && AppLayerParserIsFileTxInDir(txd, direction));
278 }
279 
280 /***** General *****/
281 
283  uint8_t flags, const uint8_t *input, uint32_t input_len);
286 int AppLayerParserProtocolHasLogger(uint8_t ipproto, AppProto alproto);
287 LoggerId AppLayerParserProtocolGetLoggerBits(uint8_t ipproto, AppProto alproto);
288 void AppLayerParserTriggerRawStreamReassembly(Flow *f, int direction);
289 void AppLayerParserSetStreamDepth(uint8_t ipproto, AppProto alproto, uint32_t stream_depth);
290 uint32_t AppLayerParserGetStreamDepth(const Flow *f);
291 void AppLayerParserSetStreamDepthFlag(uint8_t ipproto, AppProto alproto, void *state, uint64_t tx_id, uint8_t flags);
292 int AppLayerParserIsEnabled(AppProto alproto);
293 int AppLayerParserGetFrameIdByName(uint8_t ipproto, AppProto alproto, const char *name);
294 const char *AppLayerParserGetFrameNameById(uint8_t ipproto, AppProto alproto, const uint8_t id);
295 
296 /***** Cleanup *****/
297 
299  uint8_t protomap, AppProto alproto, void *alstate, AppLayerParserState *pstate);
300 void AppLayerParserStateCleanup(const Flow *f, void *alstate, AppLayerParserState *pstate);
301 
303 
304 void AppLayerParserStateSetFlag(AppLayerParserState *pstate, uint16_t flag);
305 uint16_t AppLayerParserStateIssetFlag(AppLayerParserState *pstate, uint16_t flag);
306 
309 
310 void AppLayerParserTransactionsCleanup(Flow *f, const uint8_t pkt_dir);
311 
312 /***** Unittests *****/
313 
314 #ifdef UNITTESTS
315 void AppLayerParserRegisterProtocolUnittests(uint8_t ipproto, AppProto alproto,
316  void (*RegisterUnittests)(void));
320 void UTHAppLayerParserStateGetIds(void *ptr, uint64_t *i1, uint64_t *i2, uint64_t *log, uint64_t *min);
321 #endif
322 
324 void FileApplyTxFlags(const AppLayerTxData *txd, const uint8_t direction, File *file);
325 
326 #endif /* SURICATA_APP_LAYER_PARSER_H */
AppLayerParserGetStateProgress
int AppLayerParserGetStateProgress(uint8_t ipproto, AppProto alproto, void *alstate, uint8_t direction)
get the progress value for a tx/protocol
Definition: app-layer-parser.c:1066
AppLayerParserThreadCtxFree
void AppLayerParserThreadCtxFree(AppLayerParserThreadCtx *tctx)
Destroys the app layer parser thread context obtained using AppLayerParserThreadCtxAlloc().
Definition: app-layer-parser.c:300
AppLayerParserGetTx
void * AppLayerParserGetTx(uint8_t ipproto, AppProto alproto, void *alstate, uint64_t tx_id)
Definition: app-layer-parser.c:1088
AppLayerParserPostStreamSetup
void AppLayerParserPostStreamSetup(void)
Definition: app-layer-parser.c:255
AppLayerParserGetDecoderEvents
AppLayerDecoderEvents * AppLayerParserGetDecoderEvents(AppLayerParserState *pstate)
Definition: app-layer-parser.c:831
AppLayerParserRegisterGetTx
void AppLayerParserRegisterGetTx(uint8_t ipproto, AppProto alproto, void *(StateGetTx)(void *alstate, uint64_t tx_id))
Definition: app-layer-parser.c:499
AppLayerParserRegisterLogger
void AppLayerParserRegisterLogger(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:457
ts
uint64_t ts
Definition: source-erf-file.c:55
AppLayerParserRegisterLoggerBits
void AppLayerParserRegisterLoggerBits(uint8_t ipproto, AppProto alproto, LoggerId bits)
Definition: app-layer-parser.c:448
AppLayerGetTxIterState::ptr
void * ptr
Definition: app-layer-parser.h:145
AppLayerParserStateAlloc
AppLayerParserState * AppLayerParserStateAlloc(void)
Definition: app-layer-parser.c:224
AppLayerParserSetEOF
void AppLayerParserSetEOF(AppLayerParserState *pstate)
Definition: app-layer-parser.c:1472
AppLayerParserRegisterGetTxCnt
void AppLayerParserRegisterGetTxCnt(uint8_t ipproto, AppProto alproto, uint64_t(*StateGetTxCnt)(void *alstate))
Definition: app-layer-parser.c:488
AppLayerParserGetEventInfoById
int AppLayerParserGetEventInfoById(uint8_t ipproto, AppProto alproto, int event_id, const char **event_name, AppLayerEventType *event_type)
Definition: app-layer-parser.c:1113
AppLayerParserRegisterGetFrameFuncs
void AppLayerParserRegisterGetFrameFuncs(uint8_t ipproto, AppProto alproto, AppLayerParserGetFrameIdByNameFn GetFrameIdByName, AppLayerParserGetFrameNameByIdFn GetFrameNameById)
Definition: app-layer-parser.c:545
AppLayerParserGetStreamDepth
uint32_t AppLayerParserGetStreamDepth(const Flow *f)
Definition: app-layer-parser.c:1554
AppProto
uint16_t AppProto
Definition: app-layer-protos.h:82
AppLayerParserRegisterSetStreamDepthFlag
void AppLayerParserRegisterSetStreamDepthFlag(uint8_t ipproto, AppProto alproto, void(*SetStreamDepthFlag)(void *tx, uint8_t flags))
Definition: app-layer-parser.c:597
Flow_
Flow data structure.
Definition: flow.h:360
LoggerId
LoggerId
Definition: suricata-common.h:460
AppLayerParserGetTxDetectFlags
uint64_t AppLayerParserGetTxDetectFlags(AppLayerTxData *txd, const uint8_t dir)
Definition: app-layer-parser.c:709
AppLayerParserRegisterGetEventInfoById
void AppLayerParserRegisterGetEventInfoById(uint8_t ipproto, AppProto alproto, int(*StateGetEventInfoById)(int event_id, const char **event_name, AppLayerEventType *event_type))
Definition: app-layer-parser.c:533
UTHAppLayerParserStateGetIds
void UTHAppLayerParserStateGetIds(void *ptr, uint64_t *i1, uint64_t *i2, uint64_t *log, uint64_t *min)
Definition: app-layer-parser.c:203
rust.h
proto
uint8_t proto
Definition: decode-template.h:0
AppLayerParserProtocolGetLoggerBits
LoggerId AppLayerParserProtocolGetLoggerBits(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1524
AppLayerParserGetFrameIdByName
int AppLayerParserGetFrameIdByName(uint8_t ipproto, AppProto alproto, const char *name)
Definition: app-layer-parser.c:1573
AppLayerGetTxIterState::u64
uint64_t u64
Definition: app-layer-parser.h:146
AppLayerParserSetup
int AppLayerParserSetup(void)
Definition: app-layer-parser.c:248
AppLayerParserRegisterProtocolUnittests
void AppLayerParserRegisterProtocolUnittests(uint8_t ipproto, AppProto alproto, void(*RegisterUnittests)(void))
Definition: app-layer-parser.c:1836
AppLayerDecoderEvents_
Data structure to store app layer decoder events.
Definition: app-layer-events.h:35
AppLayerParserSetStreamDepth
void AppLayerParserSetStreamDepth(uint8_t ipproto, AppProto alproto, uint32_t stream_depth)
Definition: app-layer-parser.c:1543
AppLayerParserStateIssetFlag
uint16_t AppLayerParserStateIssetFlag(AppLayerParserState *pstate, uint16_t flag)
Definition: app-layer-parser.c:1771
AppLayerParserGetProtocolParserLocalStorage
void * AppLayerParserGetProtocolParserLocalStorage(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:609
AppLayerParserRegisterGetTxFilesFunc
void AppLayerParserRegisterGetTxFilesFunc(uint8_t ipproto, AppProto alproto, AppLayerGetFileState(*GetTxFiles)(void *, uint8_t))
Definition: app-layer-parser.c:438
AppLayerParserFPtr
AppLayerResult(* AppLayerParserFPtr)(Flow *f, void *protocol_state, AppLayerParserState *pstate, StreamSlice stream_slice, void *local_storage)
Prototype for parsing functions.
Definition: app-layer-parser.h:140
FileApplyTxFlags
void FileApplyTxFlags(const AppLayerTxData *txd, const uint8_t direction, File *file)
Definition: util-file.c:295
AppLayerParserConfParserEnabled
int AppLayerParserConfParserEnabled(const char *ipproto, const char *alproto_name)
Given a protocol name, checks if the parser is enabled in the conf file.
Definition: app-layer-parser.c:320
AppLayerParserTriggerRawStreamReassembly
void AppLayerParserTriggerRawStreamReassembly(Flow *f, int direction)
Definition: app-layer-parser.c:1532
AppLayerParserGetEventInfo
int AppLayerParserGetEventInfo(uint8_t ipproto, AppProto alproto, const char *event_name, int *event_id, AppLayerEventType *event_type)
Definition: app-layer-parser.c:1103
AppLayerParserState_
Definition: app-layer-parser.c:129
AppLayerParserGetTransactionLogId
uint64_t AppLayerParserGetTransactionLogId(AppLayerParserState *pstate)
Definition: app-layer-parser.c:682
AppLayerParserRegisterLocalStorageFunc
void AppLayerParserRegisterLocalStorageFunc(uint8_t ipproto, AppProto proto, void *(*LocalStorageAlloc)(void), void(*LocalStorageFree)(void *))
Definition: app-layer-parser.c:424
AppLayerParserStateSetFlag
void AppLayerParserStateSetFlag(AppLayerParserState *pstate, uint16_t flag)
Definition: app-layer-parser.c:1763
AppLayerParserRegisterStateProgressCompletionStatus
void AppLayerParserRegisterStateProgressCompletionStatus(AppProto alproto, const int ts, const int tc)
Definition: app-layer-parser.c:518
AppLayerParserProtoIsRegistered
int AppLayerParserProtoIsRegistered(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:217
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:57
AppLayerParserRegisterOptionFlags
void AppLayerParserRegisterOptionFlags(uint8_t ipproto, AppProto alproto, uint32_t flags)
Definition: app-layer-parser.c:401
AppLayerParserRegisterStateDataFunc
void AppLayerParserRegisterStateDataFunc(uint8_t ipproto, AppProto alproto, AppLayerStateData *(*GetStateData)(void *state))
Definition: app-layer-parser.c:577
AppLayerParserGetTxData
AppLayerTxData * AppLayerParserGetTxData(uint8_t ipproto, AppProto alproto, void *tx)
Definition: app-layer-parser.c:1158
AppLayerParserRegisterTxDataFunc
void AppLayerParserRegisterTxDataFunc(uint8_t ipproto, AppProto alproto, AppLayerTxData *(*GetTxData)(void *tx))
Definition: app-layer-parser.c:567
AppLayerParserTransactionsCleanup
void AppLayerParserTransactionsCleanup(Flow *f, const uint8_t pkt_dir)
remove obsolete (inspected and logged) transactions
Definition: app-layer-parser.c:885
AppLayerParserDestroyProtocolParserLocalStorage
void AppLayerParserDestroyProtocolParserLocalStorage(uint8_t ipproto, AppProto alproto, void *local_data)
Definition: app-layer-parser.c:624
AppLayerGetTxIterState
Definition: app-layer-parser.h:143
AppLayerParserGetTransactionInspectId
uint64_t AppLayerParserGetTransactionInspectId(AppLayerParserState *pstate, uint8_t direction)
Definition: app-layer-parser.c:699
AppLayerParserHasDecoderEvents
bool AppLayerParserHasDecoderEvents(AppLayerParserState *pstate)
Definition: app-layer-parser.c:1488
AppLayerParserSetTransactionInspectId
void AppLayerParserSetTransactionInspectId(const Flow *f, AppLayerParserState *pstate, void *alstate, const uint8_t flags, bool tag_txs_as_inspected)
Definition: app-layer-parser.c:730
AppLayerParserRegisterGetTxIterator
void AppLayerParserRegisterGetTxIterator(uint8_t ipproto, AppProto alproto, AppLayerGetTxIteratorFunc Func)
Definition: app-layer-parser.c:510
AppLayerGetTxIterator
AppLayerGetTxIteratorFunc AppLayerGetTxIterator(const uint8_t ipproto, const AppProto alproto)
Definition: app-layer-parser.c:674
AppLayerParserGetTxFiles
AppLayerGetFileState AppLayerParserGetTxFiles(const Flow *f, void *tx, const uint8_t direction)
Definition: app-layer-parser.c:855
AppLayerParserRestoreParserTable
void AppLayerParserRestoreParserTable(void)
Definition: app-layer-parser.c:1853
AppLayerGetTxIterState
struct AppLayerGetTxIterState AppLayerGetTxIterState
AppLayerParserRegisterTxFreeFunc
void AppLayerParserRegisterTxFreeFunc(uint8_t ipproto, AppProto alproto, void(*StateTransactionFree)(void *, uint64_t))
Definition: app-layer-parser.c:477
AppLayerParserDeSetup
int AppLayerParserDeSetup(void)
Definition: app-layer-parser.c:269
ConfigAction
ConfigAction
Definition: util-config.h:27
AppLayerParserGetFrameNameById
const char * AppLayerParserGetFrameNameById(uint8_t ipproto, AppProto alproto, const uint8_t id)
Definition: app-layer-parser.c:1582
AppLayerFramesFreeContainer
void AppLayerFramesFreeContainer(Flow *f)
Definition: app-layer-parser.c:165
util-file.h
File_
Definition: util-file.h:79
AppLayerTxData
struct AppLayerTxData AppLayerTxData
Definition: detect.h:1364
AppLayerParserIsEnabled
int AppLayerParserIsEnabled(AppProto alproto)
simple way to globally test if a alproto is registered and fully enabled in the configuration.
Definition: app-layer-parser.c:1506
flags
uint8_t flags
Definition: decode-gre.h:0
AppLayerParserGetFrameNameByIdFn
const char *(* AppLayerParserGetFrameNameByIdFn)(const uint8_t id)
Definition: app-layer-parser.h:159
AppLayerParserGetStateData
AppLayerStateData * AppLayerParserGetStateData(uint8_t ipproto, AppProto alproto, void *state)
Definition: app-layer-parser.c:1165
AppLayerParserApplyTxConfig
void AppLayerParserApplyTxConfig(uint8_t ipproto, AppProto alproto, void *state, void *tx, enum ConfigAction mode, AppLayerTxConfig)
Definition: app-layer-parser.c:1176
AppLayerParserSetTransactionLogId
void AppLayerParserSetTransactionLogId(AppLayerParserState *pstate, uint64_t tx_id)
Definition: app-layer-parser.c:689
AppLayerParserRegisterStateFuncs
void AppLayerParserRegisterStateFuncs(uint8_t ipproto, AppProto alproto, void *(*StateAlloc)(void *, AppProto), void(*StateFree)(void *))
Definition: app-layer-parser.c:411
AppLayerParserRegisterUnittests
void AppLayerParserRegisterUnittests(void)
Definition: app-layer-parser.c:1948
AppLayerParserStateCleanup
void AppLayerParserStateCleanup(const Flow *f, void *alstate, AppLayerParserState *pstate)
Definition: app-layer-parser.c:1610
AppLayerParserBackupParserTable
void AppLayerParserBackupParserTable(void)
Definition: app-layer-parser.c:1845
AppLayerParserRegisterGetStateProgressFunc
void AppLayerParserRegisterGetStateProgressFunc(uint8_t ipproto, AppProto alproto, int(*StateGetStateProgress)(void *alstate, uint8_t direction))
Definition: app-layer-parser.c:466
tv
ThreadVars * tv
Definition: fuzz_decodepcapfile.c:32
app-layer-events.h
AppLayerParserRegisterProtocolParsers
void AppLayerParserRegisterProtocolParsers(void)
Definition: app-layer-parser.c:1695
AppLayerParserGetFirstDataDir
uint8_t AppLayerParserGetFirstDataDir(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1124
AppLayerParserRegisterGetEventInfo
void AppLayerParserRegisterGetEventInfo(uint8_t ipproto, AppProto alproto, int(*StateGetEventInfo)(const char *event_name, int *event_id, AppLayerEventType *event_type))
Definition: app-layer-parser.c:555
util-config.h
AppLayerParserGetTxCnt
uint64_t AppLayerParserGetTxCnt(const Flow *, void *alstate)
Definition: app-layer-parser.c:1081
AppLayerParserRegisterParser
int AppLayerParserRegisterParser(uint8_t ipproto, AppProto alproto, uint8_t direction, AppLayerParserFPtr Parser)
Register app layer parser for the protocol.
Definition: app-layer-parser.c:378
AppLayerParserProtocolHasLogger
int AppLayerParserProtocolHasLogger(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1516
AppLayerParserThreadCtxAlloc
AppLayerParserThreadCtx * AppLayerParserThreadCtxAlloc(void)
Gets a new app layer protocol's parser thread context.
Definition: app-layer-parser.c:279
AppLayerParserSetStreamDepthFlag
void AppLayerParserSetStreamDepthFlag(uint8_t ipproto, AppProto alproto, void *state, uint64_t tx_id, uint8_t flags)
Definition: app-layer-parser.c:1559
AppLayerGetTxIteratorFunc
AppLayerGetTxIterTuple(* AppLayerGetTxIteratorFunc)(const uint8_t ipproto, const AppProto alproto, void *alstate, uint64_t min_tx_id, uint64_t max_tx_id, AppLayerGetTxIterState *state)
tx iterator prototype
Definition: app-layer-parser.h:152
AppLayerParserThreadCtx_
Definition: app-layer-parser.c:58
AppLayerParserStateFree
void AppLayerParserStateFree(AppLayerParserState *pstate)
Definition: app-layer-parser.c:236
AppLayerParserGetEventsByTx
AppLayerDecoderEvents * AppLayerParserGetEventsByTx(uint8_t ipproto, AppProto alproto, void *tx)
Definition: app-layer-parser.c:839
AppLayerParserRegisterApplyTxConfigFunc
void AppLayerParserRegisterApplyTxConfigFunc(uint8_t ipproto, AppProto alproto, bool(*ApplyTxConfig)(void *state, void *tx, int mode, AppLayerTxConfig))
Definition: app-layer-parser.c:587
AppLayerGetTxIterState::un
union AppLayerGetTxIterState::@11 un
AppLayerParserParse
int AppLayerParserParse(ThreadVars *tv, AppLayerParserThreadCtx *tctx, Flow *f, AppProto alproto, uint8_t flags, const uint8_t *input, uint32_t input_len)
Definition: app-layer-parser.c:1266
AppLayerParserGetFrameIdByNameFn
int(* AppLayerParserGetFrameIdByNameFn)(const char *frame_name)
Definition: app-layer-parser.h:158
AppLayerParserSupportsFiles
bool AppLayerParserSupportsFiles(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1148
AppLayerParserRegisterParserAcceptableDataDirection
void AppLayerParserRegisterParserAcceptableDataDirection(uint8_t ipproto, AppProto alproto, uint8_t direction)
Definition: app-layer-parser.c:390
AppLayerParserGetStateProgressCompletionStatus
int AppLayerParserGetStateProgressCompletionStatus(AppProto alproto, uint8_t direction)
Definition: app-layer-parser.c:1095
AppLayerParserStateProtoCleanup
void AppLayerParserStateProtoCleanup(uint8_t protomap, AppProto alproto, void *alstate, AppLayerParserState *pstate)
Definition: app-layer-parser.c:1593
AppLayerParserGetTransactionActive
uint64_t AppLayerParserGetTransactionActive(const Flow *f, AppLayerParserState *pstate, uint8_t direction)
Definition: app-layer-parser.c:1131