suricata
app-layer-parser.h
Go to the documentation of this file.
1 /* Copyright (C) 2007-2025 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 /* for use with the detect_progress_ts|detect_progress_tc fields */
51 
52 /** should inspection be skipped in that direction */
53 #define APP_LAYER_TX_SKIP_INSPECT_TS BIT_U8(0)
54 #define APP_LAYER_TX_SKIP_INSPECT_TC BIT_U8(1)
55 /** is tx fully inspected? */
56 #define APP_LAYER_TX_INSPECTED_TS BIT_U8(2)
57 #define APP_LAYER_TX_INSPECTED_TC BIT_U8(3)
58 /** accept is applied to entire tx */
59 #define APP_LAYER_TX_ACCEPT BIT_U8(4)
60 
61 /** parser has successfully processed in the input, and has consumed
62  * all of it. */
63 #define APP_LAYER_OK (AppLayerResult) { 0, 0, 0 }
64 
65 /** parser has hit an unrecoverable error. Returning this to the API
66  * leads to no further calls to the parser. */
67 #define APP_LAYER_ERROR (AppLayerResult) { -1, 0, 0 }
68 
69 /** parser needs more data. Through 'c' it will indicate how many
70  * of the input bytes it has consumed. Through 'n' it will indicate
71  * how many more bytes it needs before getting called again.
72  * \note consumed (c) should never be more than the input len
73  * needed (n) + consumed (c) should be more than the input len
74  */
75 #define APP_LAYER_INCOMPLETE(c,n) (AppLayerResult) { 1, (c), (n) }
76 
77 int AppLayerParserProtoIsRegistered(uint8_t ipproto, AppProto alproto);
78 
79 /***** transaction handling *****/
80 
81 int AppLayerParserSetup(void);
84 
86 
87 /**
88  * \brief Gets a new app layer protocol's parser thread context.
89  *
90  * \retval Non-NULL pointer on success.
91  * NULL pointer on failure.
92  */
94 
95 /**
96  * \brief Destroys the app layer parser thread context obtained
97  * using AppLayerParserThreadCtxAlloc().
98  *
99  * \param tctx Pointer to the thread context to be destroyed.
100  */
102 
103 /**
104  * \brief Given a protocol name, checks if the parser is enabled in
105  * the conf file.
106  *
107  * \param alproto_name Name of the app layer protocol.
108  *
109  * \retval 1 If enabled.
110  * \retval 0 If disabled.
111  */
112 int AppLayerParserConfParserEnabled(const char *ipproto,
113  const char *alproto_name);
114 
116 
117 /** \brief Prototype for parsing functions */
118 typedef AppLayerResult (*AppLayerParserFPtr)(Flow *f, void *protocol_state,
119  AppLayerParserState *pstate, StreamSlice stream_slice, void *local_storage);
120 
121 typedef struct AppLayerGetTxIterState {
122  union {
123  void *ptr;
124  uint64_t u64;
125  } un;
127 
128 /** \brief tx iterator prototype */
129 typedef AppLayerGetTxIterTuple (*AppLayerGetTxIteratorFunc)
130  (const uint8_t ipproto, const AppProto alproto,
131  void *alstate, uint64_t min_tx_id, uint64_t max_tx_id,
132  AppLayerGetTxIterState *state);
133 
134 /***** Parser related registration *****/
135 
136 /**
137  * \param name progress name to get the id for
138  * \param direction STREAM_TOSERVER/STREAM_TOCLIENT
139  */
140 typedef int (*AppLayerParserGetStateIdByNameFn)(const char *name, const uint8_t direction);
141 /**
142  * \param id progress value id to get the name for
143  * \param direction STREAM_TOSERVER/STREAM_TOCLIENT
144  */
145 typedef const char *(*AppLayerParserGetStateNameByIdFn)(const int id, const uint8_t direction);
146 
147 typedef int (*AppLayerParserGetFrameIdByNameFn)(const char *frame_name);
148 typedef const char *(*AppLayerParserGetFrameNameByIdFn)(const uint8_t id);
149 
150 int AppLayerParserPreRegister(void (*Register)(void));
151 /**
152  * \brief Register app layer parser for the protocol.
153  *
154  * \retval 0 On success.
155  * \retval -1 On failure.
156  */
157 int AppLayerParserRegisterParser(uint8_t ipproto, AppProto alproto,
158  uint8_t direction,
159  AppLayerParserFPtr Parser);
161  AppProto alproto,
162  uint8_t direction);
163 void AppLayerParserRegisterOptionFlags(uint8_t ipproto, AppProto alproto,
164  uint32_t flags);
165 void AppLayerParserRegisterStateFuncs(uint8_t ipproto, AppProto alproto,
166  void *(*StateAlloc)(void *, AppProto), void (*StateFree)(void *));
168  void *(*LocalStorageAlloc)(void), void (*LocalStorageFree)(void *));
169 // void AppLayerParserRegisterGetEventsFunc(uint8_t ipproto, AppProto proto,
170 // AppLayerDecoderEvents *(*StateGetEvents)(void *) __attribute__((nonnull)));
172  uint8_t ipproto, AppProto alproto, AppLayerGetFileState (*GetTxFiles)(void *, uint8_t));
173 void AppLayerParserRegisterLogger(uint8_t ipproto, AppProto alproto);
174 void AppLayerParserRegisterLoggerBits(uint8_t ipproto, AppProto alproto, LoggerId bits);
175 void AppLayerParserRegisterGetStateProgressFunc(uint8_t ipproto, AppProto alproto,
176  int (*StateGetStateProgress)(void *alstate, uint8_t direction));
177 void AppLayerParserRegisterTxFreeFunc(uint8_t ipproto, AppProto alproto,
178  void (*StateTransactionFree)(void *, uint64_t));
179 void AppLayerParserRegisterGetTxCnt(uint8_t ipproto, AppProto alproto,
180  uint64_t (*StateGetTxCnt)(void *alstate));
181 void AppLayerParserRegisterGetTx(uint8_t ipproto, AppProto alproto,
182  void *(StateGetTx)(void *alstate, uint64_t tx_id));
183 void AppLayerParserRegisterGetTxIterator(uint8_t ipproto, AppProto alproto,
186  AppProto alproto, const int ts, const int tc);
187 void AppLayerParserRegisterGetEventInfo(uint8_t ipproto, AppProto alproto,
188  int (*StateGetEventInfo)(
189  const char *event_name, uint8_t *event_id, AppLayerEventType *event_type));
190 void AppLayerParserRegisterGetEventInfoById(uint8_t ipproto, AppProto alproto,
191  int (*StateGetEventInfoById)(
192  uint8_t event_id, const char **event_name, AppLayerEventType *event_type));
193 void AppLayerParserRegisterGetFrameFuncs(uint8_t ipproto, AppProto alproto,
194  AppLayerParserGetFrameIdByNameFn GetFrameIdByName,
195  AppLayerParserGetFrameNameByIdFn GetFrameNameById);
196 void AppLayerParserRegisterSetStreamDepthFlag(uint8_t ipproto, AppProto alproto,
197  void (*SetStreamDepthFlag)(void *tx, uint8_t flags));
198 void AppLayerParserRegisterGetStateFuncs(uint8_t ipproto, AppProto alproto,
199  AppLayerParserGetStateIdByNameFn GetStateIdByName,
200  AppLayerParserGetStateNameByIdFn GetStateNameById);
201 
202 void AppLayerParserRegisterTxDataFunc(uint8_t ipproto, AppProto alproto,
203  AppLayerTxData *(*GetTxData)(void *tx));
204 void AppLayerParserRegisterApplyTxConfigFunc(uint8_t ipproto, AppProto alproto,
205  bool (*ApplyTxConfig)(void *state, void *tx, int mode, AppLayerTxConfig));
207  uint8_t ipproto, AppProto alproto, AppLayerStateData *(*GetStateData)(void *state));
208 
209 /***** Get and transaction functions *****/
210 
212  const AppProto alproto);
213 
214 void *AppLayerParserGetProtocolParserLocalStorage(uint8_t ipproto, AppProto alproto);
215 void AppLayerParserDestroyProtocolParserLocalStorage(uint8_t ipproto, AppProto alproto,
216  void *local_data);
217 
218 
220 void AppLayerParserSetTransactionLogId(AppLayerParserState *pstate, uint64_t tx_id);
221 
222 uint64_t AppLayerParserGetTransactionInspectId(AppLayerParserState *pstate, uint8_t direction);
224  void *alstate, const uint8_t flags, bool tag_txs_as_inspected);
225 
227 AppLayerDecoderEvents *AppLayerParserGetEventsByTx(uint8_t ipproto, AppProto alproto, void *tx);
228 AppLayerGetFileState AppLayerParserGetTxFiles(const Flow *f, void *tx, const uint8_t direction);
229 int AppLayerParserGetStateProgress(uint8_t ipproto, AppProto alproto,
230  void *alstate, uint8_t direction);
231 uint64_t AppLayerParserGetTxCnt(const Flow *, void *alstate);
232 void *AppLayerParserGetTx(uint8_t ipproto, AppProto alproto, void *alstate, uint64_t tx_id);
233 int AppLayerParserGetStateProgressCompletionStatus(AppProto alproto, uint8_t direction);
234 int AppLayerParserGetEventInfo(uint8_t ipproto, AppProto alproto, const char *event_name,
235  uint8_t *event_id, AppLayerEventType *event_type);
236 int AppLayerParserGetEventInfoById(uint8_t ipproto, AppProto alproto, uint8_t event_id,
237  const char **event_name, AppLayerEventType *event_type);
238 
239 uint64_t AppLayerParserGetTransactionActive(const Flow *f, AppLayerParserState *pstate, uint8_t direction);
240 
241 uint8_t AppLayerParserGetFirstDataDir(uint8_t ipproto, AppProto alproto);
242 
243 bool AppLayerParserSupportsFiles(uint8_t ipproto, AppProto alproto);
244 
245 AppLayerTxData *AppLayerParserGetTxData(uint8_t ipproto, AppProto alproto, void *tx);
246 uint8_t AppLayerParserGetTxDetectProgress(AppLayerTxData *txd, const uint8_t dir);
247 AppLayerStateData *AppLayerParserGetStateData(uint8_t ipproto, AppProto alproto, void *state);
248 void AppLayerParserApplyTxConfig(uint8_t ipproto, AppProto alproto,
249  void *state, void *tx, enum ConfigAction mode, AppLayerTxConfig);
250 
251 static inline bool AppLayerParserIsFileTx(const AppLayerTxData *txd)
252 {
253  if (txd->file_tx != 0) {
254  return true;
255  }
256  return false;
257 }
258 
259 static inline bool AppLayerParserIsFileTxInDir(const AppLayerTxData *txd, const uint8_t direction)
260 {
261  if ((txd->file_tx & direction) != 0) {
262  return true;
263  }
264  return false;
265 }
266 
267 /** \brief check if tx (possibly) has files in this tx for the direction */
268 static inline bool AppLayerParserHasFilesInDir(const AppLayerTxData *txd, const uint8_t direction)
269 {
270  return (txd->files_opened && AppLayerParserIsFileTxInDir(txd, direction));
271 }
272 
273 /***** General *****/
274 
276  uint8_t flags, const uint8_t *input, uint32_t input_len);
279 int AppLayerParserProtocolHasLogger(uint8_t ipproto, AppProto alproto);
280 LoggerId AppLayerParserProtocolGetLoggerBits(uint8_t ipproto, AppProto alproto);
281 void AppLayerParserTriggerRawStreamReassembly(Flow *f, int direction);
282 void AppLayerParserSetStreamDepth(uint8_t ipproto, AppProto alproto, uint32_t stream_depth);
283 uint32_t AppLayerParserGetStreamDepth(const Flow *f);
284 void AppLayerParserSetStreamDepthFlag(uint8_t ipproto, AppProto alproto, void *state, uint64_t tx_id, uint8_t flags);
285 int AppLayerParserIsEnabled(AppProto alproto);
286 int AppLayerParserGetFrameIdByName(uint8_t ipproto, AppProto alproto, const char *name);
287 const char *AppLayerParserGetFrameNameById(uint8_t ipproto, AppProto alproto, const uint8_t id);
288 /**
289  * \param name progress name to get the id for
290  * \param direction STREAM_TOSERVER/STREAM_TOCLIENT
291  */
293  uint8_t ipproto, AppProto alproto, const char *name, uint8_t direction);
294 /**
295  * \param id progress value id to get the name for
296  * \param direction STREAM_TOSERVER/STREAM_TOCLIENT
297  */
299  uint8_t ipproto, AppProto alproto, const int id, uint8_t direction);
300 
301 /***** Cleanup *****/
302 
304  uint8_t protomap, AppProto alproto, void *alstate, AppLayerParserState *pstate);
305 void AppLayerParserStateCleanup(const Flow *f, void *alstate, AppLayerParserState *pstate);
306 
308 
309 void AppLayerParserStateSetFlag(AppLayerParserState *pstate, uint16_t flag);
310 uint16_t AppLayerParserStateIssetFlag(AppLayerParserState *pstate, uint16_t flag);
311 
314 
315 void AppLayerParserTransactionsCleanup(Flow *f, const uint8_t pkt_dir);
316 
317 /***** Unittests *****/
318 
319 #ifdef UNITTESTS
320 void AppLayerParserRegisterProtocolUnittests(uint8_t ipproto, AppProto alproto,
321  void (*RegisterUnittests)(void));
323 void UTHAppLayerParserStateGetIds(void *ptr, uint64_t *i1, uint64_t *i2, uint64_t *log, uint64_t *min);
324 #endif
325 
327 void FileApplyTxFlags(const AppLayerTxData *txd, const uint8_t direction, File *file);
328 
329 #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:1096
AppLayerParserThreadCtxFree
void AppLayerParserThreadCtxFree(AppLayerParserThreadCtx *tctx)
Destroys the app layer parser thread context obtained using AppLayerParserThreadCtxAlloc().
Definition: app-layer-parser.c:322
AppLayerParserGetTx
void * AppLayerParserGetTx(uint8_t ipproto, AppProto alproto, void *alstate, uint64_t tx_id)
Definition: app-layer-parser.c:1118
AppLayerParserPostStreamSetup
void AppLayerParserPostStreamSetup(void)
Definition: app-layer-parser.c:270
AppLayerParserGetDecoderEvents
AppLayerDecoderEvents * AppLayerParserGetDecoderEvents(AppLayerParserState *pstate)
Definition: app-layer-parser.c:854
AppLayerParserRegisterGetTx
void AppLayerParserRegisterGetTx(uint8_t ipproto, AppProto alproto, void *(StateGetTx)(void *alstate, uint64_t tx_id))
Definition: app-layer-parser.c:529
AppLayerParserRegisterLogger
void AppLayerParserRegisterLogger(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:490
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:481
AppLayerGetTxIterState::ptr
void * ptr
Definition: app-layer-parser.h:123
AppLayerParserStateAlloc
AppLayerParserState * AppLayerParserStateAlloc(void)
Definition: app-layer-parser.c:233
AppLayerParserSetEOF
void AppLayerParserSetEOF(AppLayerParserState *pstate)
Definition: app-layer-parser.c:1506
AppLayerParserRegisterGetTxCnt
void AppLayerParserRegisterGetTxCnt(uint8_t ipproto, AppProto alproto, uint64_t(*StateGetTxCnt)(void *alstate))
Definition: app-layer-parser.c:519
AppLayerParserRegisterGetFrameFuncs
void AppLayerParserRegisterGetFrameFuncs(uint8_t ipproto, AppProto alproto, AppLayerParserGetFrameIdByNameFn GetFrameIdByName, AppLayerParserGetFrameNameByIdFn GetFrameNameById)
Definition: app-layer-parser.c:584
AppLayerParserGetStreamDepth
uint32_t AppLayerParserGetStreamDepth(const Flow *f)
Definition: app-layer-parser.c:1588
AppProto
uint16_t AppProto
Definition: app-layer-protos.h:85
AppLayerParserRegisterSetStreamDepthFlag
void AppLayerParserRegisterSetStreamDepthFlag(uint8_t ipproto, AppProto alproto, void(*SetStreamDepthFlag)(void *tx, uint8_t flags))
Definition: app-layer-parser.c:635
Flow_
Flow data structure.
Definition: flow.h:356
LoggerId
LoggerId
Definition: suricata-common.h:469
UTHAppLayerParserStateGetIds
void UTHAppLayerParserStateGetIds(void *ptr, uint64_t *i1, uint64_t *i2, uint64_t *log, uint64_t *min)
Definition: app-layer-parser.c:212
AppLayerErrorGetExceptionPolicy
enum ExceptionPolicy AppLayerErrorGetExceptionPolicy(void)
Definition: app-layer-parser.c:160
rust.h
proto
uint8_t proto
Definition: decode-template.h:0
AppLayerParserProtocolGetLoggerBits
LoggerId AppLayerParserProtocolGetLoggerBits(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1558
AppLayerParserGetFrameIdByName
int AppLayerParserGetFrameIdByName(uint8_t ipproto, AppProto alproto, const char *name)
Definition: app-layer-parser.c:1636
AppLayerParserRegisterGetEventInfoById
void AppLayerParserRegisterGetEventInfoById(uint8_t ipproto, AppProto alproto, int(*StateGetEventInfoById)(uint8_t event_id, const char **event_name, AppLayerEventType *event_type))
Definition: app-layer-parser.c:562
AppLayerGetTxIterState::u64
uint64_t u64
Definition: app-layer-parser.h:124
AppLayerParserSetup
int AppLayerParserSetup(void)
Definition: app-layer-parser.c:257
AppLayerParserRegisterProtocolUnittests
void AppLayerParserRegisterProtocolUnittests(uint8_t ipproto, AppProto alproto, void(*RegisterUnittests)(void))
Definition: app-layer-parser.c:1849
AppLayerDecoderEvents_
Data structure to store app layer decoder events.
Definition: app-layer-events.h:36
AppLayerParserSetStreamDepth
void AppLayerParserSetStreamDepth(uint8_t ipproto, AppProto alproto, uint32_t stream_depth)
Definition: app-layer-parser.c:1577
AppLayerParserStateIssetFlag
uint16_t AppLayerParserStateIssetFlag(AppLayerParserState *pstate, uint16_t flag)
Definition: app-layer-parser.c:1838
AppLayerParserGetProtocolParserLocalStorage
void * AppLayerParserGetProtocolParserLocalStorage(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:647
AppLayerParserRegisterGetTxFilesFunc
void AppLayerParserRegisterGetTxFilesFunc(uint8_t ipproto, AppProto alproto, AppLayerGetFileState(*GetTxFiles)(void *, uint8_t))
Definition: app-layer-parser.c:471
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:118
AppLayerParserGetTxDetectProgress
uint8_t AppLayerParserGetTxDetectProgress(AppLayerTxData *txd, const uint8_t dir)
Definition: app-layer-parser.c:742
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:343
AppLayerParserTriggerRawStreamReassembly
void AppLayerParserTriggerRawStreamReassembly(Flow *f, int direction)
Definition: app-layer-parser.c:1566
AppLayerParserState_
Definition: app-layer-parser.c:133
AppLayerParserGetTransactionLogId
uint64_t AppLayerParserGetTransactionLogId(AppLayerParserState *pstate)
Definition: app-layer-parser.c:714
AppLayerParserRegisterLocalStorageFunc
void AppLayerParserRegisterLocalStorageFunc(uint8_t ipproto, AppProto proto, void *(*LocalStorageAlloc)(void), void(*LocalStorageFree)(void *))
Definition: app-layer-parser.c:459
AppLayerParserStateSetFlag
void AppLayerParserStateSetFlag(AppLayerParserState *pstate, uint16_t flag)
Definition: app-layer-parser.c:1830
AppLayerParserRegisterStateProgressCompletionStatus
void AppLayerParserRegisterStateProgressCompletionStatus(AppProto alproto, const int ts, const int tc)
Definition: app-layer-parser.c:547
AppLayerParserProtoIsRegistered
int AppLayerParserProtoIsRegistered(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:226
AppLayerParserRegisterGetStateFuncs
void AppLayerParserRegisterGetStateFuncs(uint8_t ipproto, AppProto alproto, AppLayerParserGetStateIdByNameFn GetStateIdByName, AppLayerParserGetStateNameByIdFn GetStateNameById)
Definition: app-layer-parser.c:574
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:58
AppLayerParserRegisterOptionFlags
void AppLayerParserRegisterOptionFlags(uint8_t ipproto, AppProto alproto, uint32_t flags)
Definition: app-layer-parser.c:424
AppLayerParserRegisterStateDataFunc
void AppLayerParserRegisterStateDataFunc(uint8_t ipproto, AppProto alproto, AppLayerStateData *(*GetStateData)(void *state))
Definition: app-layer-parser.c:615
AppLayerParserGetTxData
AppLayerTxData * AppLayerParserGetTxData(uint8_t ipproto, AppProto alproto, void *tx)
Definition: app-layer-parser.c:1192
AppLayerParserRegisterTxDataFunc
void AppLayerParserRegisterTxDataFunc(uint8_t ipproto, AppProto alproto, AppLayerTxData *(*GetTxData)(void *tx))
Definition: app-layer-parser.c:605
AppLayerParserTransactionsCleanup
void AppLayerParserTransactionsCleanup(Flow *f, const uint8_t pkt_dir)
remove obsolete (inspected and logged) transactions
Definition: app-layer-parser.c:908
AppLayerParserDestroyProtocolParserLocalStorage
void AppLayerParserDestroyProtocolParserLocalStorage(uint8_t ipproto, AppProto alproto, void *local_data)
Definition: app-layer-parser.c:659
AppLayerGetTxIterState
Definition: app-layer-parser.h:121
AppLayerParserGetTransactionInspectId
uint64_t AppLayerParserGetTransactionInspectId(AppLayerParserState *pstate, uint8_t direction)
Definition: app-layer-parser.c:731
AppLayerParserHasDecoderEvents
bool AppLayerParserHasDecoderEvents(AppLayerParserState *pstate)
Definition: app-layer-parser.c:1522
AppLayerParserSetTransactionInspectId
void AppLayerParserSetTransactionInspectId(const Flow *f, AppLayerParserState *pstate, void *alstate, const uint8_t flags, bool tag_txs_as_inspected)
Definition: app-layer-parser.c:753
AppLayerParserRegisterGetTxIterator
void AppLayerParserRegisterGetTxIterator(uint8_t ipproto, AppProto alproto, AppLayerGetTxIteratorFunc Func)
Definition: app-layer-parser.c:539
AppLayerGetTxIterator
AppLayerGetTxIteratorFunc AppLayerGetTxIterator(const uint8_t ipproto, const AppProto alproto)
Definition: app-layer-parser.c:706
AppLayerParserGetStateNameById
const char * AppLayerParserGetStateNameById(uint8_t ipproto, AppProto alproto, const int id, uint8_t direction)
Definition: app-layer-parser.c:1626
AppLayerParserGetTxFiles
AppLayerGetFileState AppLayerParserGetTxFiles(const Flow *f, void *tx, const uint8_t direction)
Definition: app-layer-parser.c:878
name
const char * name
Definition: tm-threads.c:2135
AppLayerParserGetEventInfo
int AppLayerParserGetEventInfo(uint8_t ipproto, AppProto alproto, const char *event_name, uint8_t *event_id, AppLayerEventType *event_type)
Definition: app-layer-parser.c:1133
AppLayerGetTxIterState
struct AppLayerGetTxIterState AppLayerGetTxIterState
AppLayerParserRegisterTxFreeFunc
void AppLayerParserRegisterTxFreeFunc(uint8_t ipproto, AppProto alproto, void(*StateTransactionFree)(void *, uint64_t))
Definition: app-layer-parser.c:509
AppLayerParserDeSetup
int AppLayerParserDeSetup(void)
Definition: app-layer-parser.c:283
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:1645
AppLayerFramesFreeContainer
void AppLayerFramesFreeContainer(Flow *f)
Definition: app-layer-parser.c:174
util-file.h
File_
Definition: util-file.h:79
AppLayerTxData
struct AppLayerTxData AppLayerTxData
Definition: detect.h:1466
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:1540
flags
uint8_t flags
Definition: decode-gre.h:0
AppLayerParserGetFrameNameByIdFn
const char *(* AppLayerParserGetFrameNameByIdFn)(const uint8_t id)
Definition: app-layer-parser.h:148
AppLayerParserGetStateData
AppLayerStateData * AppLayerParserGetStateData(uint8_t ipproto, AppProto alproto, void *state)
Definition: app-layer-parser.c:1199
AppLayerParserApplyTxConfig
void AppLayerParserApplyTxConfig(uint8_t ipproto, AppProto alproto, void *state, void *tx, enum ConfigAction mode, AppLayerTxConfig)
Definition: app-layer-parser.c:1210
AppLayerParserSetTransactionLogId
void AppLayerParserSetTransactionLogId(AppLayerParserState *pstate, uint64_t tx_id)
Definition: app-layer-parser.c:721
AppLayerParserRegisterStateFuncs
void AppLayerParserRegisterStateFuncs(uint8_t ipproto, AppProto alproto, void *(*StateAlloc)(void *, AppProto), void(*StateFree)(void *))
Definition: app-layer-parser.c:434
AppLayerParserRegisterUnittests
void AppLayerParserRegisterUnittests(void)
Definition: app-layer-parser.c:1857
AppLayerParserGetStateNameByIdFn
const char *(* AppLayerParserGetStateNameByIdFn)(const int id, const uint8_t direction)
Definition: app-layer-parser.h:145
AppLayerParserStateCleanup
void AppLayerParserStateCleanup(const Flow *f, void *alstate, AppLayerParserState *pstate)
Definition: app-layer-parser.c:1673
AppLayerParserRegisterGetStateProgressFunc
void AppLayerParserRegisterGetStateProgressFunc(uint8_t ipproto, AppProto alproto, int(*StateGetStateProgress)(void *alstate, uint8_t direction))
Definition: app-layer-parser.c:499
tv
ThreadVars * tv
Definition: fuzz_decodepcapfile.c:32
app-layer-events.h
AppLayerParserRegisterProtocolParsers
void AppLayerParserRegisterProtocolParsers(void)
Definition: app-layer-parser.c:1778
AppLayerParserGetFirstDataDir
uint8_t AppLayerParserGetFirstDataDir(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1158
util-config.h
AppLayerParserGetStateIdByNameFn
int(* AppLayerParserGetStateIdByNameFn)(const char *name, const uint8_t direction)
Definition: app-layer-parser.h:140
AppLayerParserGetTxCnt
uint64_t AppLayerParserGetTxCnt(const Flow *, void *alstate)
Definition: app-layer-parser.c:1111
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:401
AppLayerParserGetStateIdByName
int AppLayerParserGetStateIdByName(uint8_t ipproto, AppProto alproto, const char *name, uint8_t direction)
Definition: app-layer-parser.c:1611
AppLayerParserProtocolHasLogger
int AppLayerParserProtocolHasLogger(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1550
AppLayerParserThreadCtxAlloc
AppLayerParserThreadCtx * AppLayerParserThreadCtxAlloc(void)
Gets a new app layer protocol's parser thread context.
Definition: app-layer-parser.c:295
AppLayerParserSetStreamDepthFlag
void AppLayerParserSetStreamDepthFlag(uint8_t ipproto, AppProto alproto, void *state, uint64_t tx_id, uint8_t flags)
Definition: app-layer-parser.c:1593
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:130
AppLayerParserPreRegister
int AppLayerParserPreRegister(void(*Register)(void))
Definition: app-layer-parser.c:1762
id
uint32_t id
Definition: detect-flowbits.c:933
AppLayerParserThreadCtx_
Definition: app-layer-parser.c:58
AppLayerParserStateFree
void AppLayerParserStateFree(AppLayerParserState *pstate)
Definition: app-layer-parser.c:245
AppLayerParserGetEventsByTx
AppLayerDecoderEvents * AppLayerParserGetEventsByTx(uint8_t ipproto, AppProto alproto, void *tx)
Definition: app-layer-parser.c:862
AppLayerParserRegisterGetEventInfo
void AppLayerParserRegisterGetEventInfo(uint8_t ipproto, AppProto alproto, int(*StateGetEventInfo)(const char *event_name, uint8_t *event_id, AppLayerEventType *event_type))
Definition: app-layer-parser.c:594
ExceptionPolicy
ExceptionPolicy
Definition: util-exception-policy-types.h:25
AppLayerParserRegisterApplyTxConfigFunc
void AppLayerParserRegisterApplyTxConfigFunc(uint8_t ipproto, AppProto alproto, bool(*ApplyTxConfig)(void *state, void *tx, int mode, AppLayerTxConfig))
Definition: app-layer-parser.c:625
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:1300
AppLayerParserGetFrameIdByNameFn
int(* AppLayerParserGetFrameIdByNameFn)(const char *frame_name)
Definition: app-layer-parser.h:147
AppLayerParserSupportsFiles
bool AppLayerParserSupportsFiles(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1182
AppLayerParserRegisterParserAcceptableDataDirection
void AppLayerParserRegisterParserAcceptableDataDirection(uint8_t ipproto, AppProto alproto, uint8_t direction)
Definition: app-layer-parser.c:413
AppLayerParserGetStateProgressCompletionStatus
int AppLayerParserGetStateProgressCompletionStatus(AppProto alproto, uint8_t direction)
Definition: app-layer-parser.c:1125
AppLayerGetTxIterState::un
union AppLayerGetTxIterState::@7 un
AppLayerParserGetEventInfoById
int AppLayerParserGetEventInfoById(uint8_t ipproto, AppProto alproto, uint8_t event_id, const char **event_name, AppLayerEventType *event_type)
Definition: app-layer-parser.c:1145
AppLayerParserStateProtoCleanup
void AppLayerParserStateProtoCleanup(uint8_t protomap, AppProto alproto, void *alstate, AppLayerParserState *pstate)
Definition: app-layer-parser.c:1656
AppLayerParserGetTransactionActive
uint64_t AppLayerParserGetTransactionActive(const Flow *f, AppLayerParserState *pstate, uint8_t direction)
Definition: app-layer-parser.c:1165