Go to the documentation of this file.
84 void *(*LocalStorageAlloc)(void);
93 void *(*StateGetTx)(
void *alstate, uint64_t tx_id);
98 AppLayerEventType *event_type);
100 int *event_id, AppLayerEventType *event_type);
102 AppLayerStateData *(*GetStateData)(
void *state);
152 static void AppLayerConfig(
void)
159 if (frames != NULL) {
176 if (f == NULL || f->
alparser == NULL)
222 return (alp_ctx.
ctxs[ipproto_map][alproto].
StateAlloc != NULL) ? 1 : 0;
243 AppLayerParserFramesFreeContainer(pstate->
frames);
252 memset(&alp_ctx, 0,
sizeof(alp_ctx));
322 const char *alproto_name)
334 r = snprintf(param,
sizeof(param),
"%s%s%s",
"app-layer.protocols.",
335 alproto_name,
".enabled");
338 }
else if (r > (
int)
sizeof(param)) {
339 FatalError(
"buffer not big enough to write param.");
345 r = snprintf(param,
sizeof(param),
"%s%s%s%s%s",
"app-layer.protocols.",
346 alproto_name,
".", ipproto,
".enabled");
349 }
else if (r > (
int)
sizeof(param)) {
350 FatalError(
"buffer not big enough to write param.");
364 }
else if (strcasecmp(node->
val,
"detection-only") == 0) {
367 SCLogError(
"Invalid value found for %s.", param);
386 Parser[(direction & STREAM_TOSERVER) ? 0 : 1] = Parser;
397 (direction & (STREAM_TOSERVER | STREAM_TOCLIENT));
413 void *(*StateAlloc)(
void *,
AppProto),
void (*StateFree)(
void *))
426 void *(*LocalStorageAlloc)(
void),
427 void (*LocalStorageFree)(
void *))
440 uint8_t ipproto,
AppProto alproto, AppLayerGetFileState (*GetTxFiles)(
void *, uint8_t))
468 int (*StateGetProgress)(
void *alstate, uint8_t direction))
473 StateGetProgress = StateGetProgress;
479 void (*StateTransactionFree)(
void *, uint64_t))
484 StateTransactionFree = StateTransactionFree;
490 uint64_t (*StateGetTxCnt)(
void *alstate))
495 StateGetTxCnt = StateGetTxCnt;
501 void *(StateGetTx)(
void *alstate, uint64_t tx_id))
506 StateGetTx = StateGetTx;
524 BUG_ON(!AppProtoIsValid(alproto));
535 int (*StateGetEventInfoById)(
int event_id,
const char **event_name,
536 AppLayerEventType *event_type))
541 StateGetEventInfoById = StateGetEventInfoById;
557 int (*StateGetEventInfo)(
const char *event_name,
int *event_id,
558 AppLayerEventType *event_type))
563 StateGetEventInfo = StateGetEventInfo;
579 uint8_t ipproto,
AppProto alproto, AppLayerStateData *(*GetStateData)(
void *state))
589 bool (*ApplyTxConfig)(
void *state,
void *tx,
int mode, AppLayerTxConfig))
599 void (*SetStreamDepthFlag)(
void *tx, uint8_t
flags))
616 LocalStorageAlloc != NULL)
631 LocalStorageFree != NULL)
634 LocalStorageFree(local_data);
648 static AppLayerGetTxIterTuple AppLayerDefaultGetTxIterator(
649 const uint8_t ipproto,
const AppProto alproto,
650 void *alstate, uint64_t min_tx_id, uint64_t max_tx_id,
653 uint64_t ustate = *(uint64_t *)state;
654 uint64_t tx_id =
MAX(min_tx_id, ustate);
655 for ( ; tx_id < max_tx_id; tx_id++) {
657 if (tx_ptr != NULL) {
660 AppLayerGetTxIterTuple tuple = {
663 .has_next = (tx_id + 1 < max_tx_id),
665 SCLogDebug(
"tuple: %p/%"PRIu64
"/%s", tuple.tx_ptr, tuple.tx_id,
666 tuple.has_next ?
"true" :
"false");
671 AppLayerGetTxIterTuple no_tuple = { NULL, 0,
false };
680 return Func ? Func : AppLayerDefaultGetTxIterator;
712 uint64_t detect_flags =
713 (dir & STREAM_TOSERVER) ? txd->detect_flags_ts : txd->detect_flags_tc;
717 static inline void SetTxDetectFlags(
AppLayerTxData *txd,
const uint8_t dir,
const uint64_t detect_flags)
719 if (dir & STREAM_TOSERVER) {
720 txd->detect_flags_ts = detect_flags;
722 txd->detect_flags_tc = detect_flags;
728 return txd->logged.flags;
732 void *alstate,
const uint8_t
flags,
733 bool tag_txs_as_inspected)
737 const int direction = (
flags & STREAM_TOSERVER) ? 0 : 1;
741 const uint8_t ipproto = f->
proto;
746 memset(&state, 0,
sizeof(state));
748 SCLogDebug(
"called: %s, tag_txs_as_inspected %s",direction==0?
"toserver":
"toclient",
749 tag_txs_as_inspected?
"true":
"false");
754 AppLayerGetTxIterTuple ires = IterFunc(ipproto, alproto, alstate, idx, total_txs, &state);
755 if (ires.tx_ptr == NULL)
758 void *tx = ires.tx_ptr;
762 if (state_progress < state_done_progress)
766 if (txd && tag_txs_as_inspected) {
770 SetTxDetectFlags(txd,
flags, detect_flags);
771 SCLogDebug(
"%p/%"PRIu64
" in-order tx is done for direction %s. Flag %016"PRIx64,
772 tx, idx,
flags & STREAM_TOSERVER ?
"toserver" :
"toclient", detect_flags);
784 if (tag_txs_as_inspected) {
787 AppLayerGetTxIterTuple ires = IterFunc(ipproto, alproto, alstate, idx, total_txs, &state);
788 if (ires.tx_ptr == NULL)
791 void *tx = ires.tx_ptr;
795 if (ires.tx_id > idx && pstate->
inspect_id[direction] == idx) {
801 if (state_progress < state_done_progress)
810 SetTxDetectFlags(txd,
flags, detect_flags);
811 SCLogDebug(
"%p/%"PRIu64
" out of order tx is done for direction %s. Flag %016"PRIx64,
812 tx, idx,
flags & STREAM_TOSERVER ?
"toserver" :
"toclient", detect_flags);
814 SCLogDebug(
"%p/%"PRIu64
" out of order tx. Update inspect_id? %"PRIu64,
837 "AppLayerDecoderEvents *");
849 if (txd != NULL && txd->events != NULL) {
864 AppLayerGetFileState files = { .fc = NULL, .cfg = NULL };
868 static void AppLayerParserFileTxHousekeeping(
869 const Flow *f,
void *tx,
const uint8_t pkt_dir,
const bool trunc)
877 #define IS_DISRUPTED(flags) ((flags) & (STREAM_DEPTH | STREAM_GAP))
896 const uint8_t ipproto = f->
proto;
898 void *
const alstate = f->
alstate;
901 if (alstate == NULL || alparser == NULL)
904 const uint64_t min = alparser->
min_id;
912 int pkt_dir_trunc = -1;
916 memset(&state, 0,
sizeof(state));
918 uint64_t new_min = min;
920 bool skipped =
false;
924 AppLayerGetTxIterTuple ires = IterFunc(ipproto, alproto, alstate, i, total_txs, &state);
925 if (ires.tx_ptr == NULL)
928 bool tx_skipped =
false;
929 void *tx = ires.tx_ptr;
934 if (txd != NULL && AppLayerParserHasFilesInDir(txd, pkt_dir)) {
935 if (pkt_dir_trunc == -1)
937 (pkt_dir == STREAM_TOSERVER) ? ts_disrupt_flags : tc_disrupt_flags);
938 AppLayerParserFileTxHousekeeping(f, tx, pkt_dir, (
bool)pkt_dir_trunc);
941 const int tx_progress_tc =
943 if (tx_progress_tc < tx_end_state_tc) {
944 SCLogDebug(
"%p/%"PRIu64
" skipping: tc parser not done", tx, i);
948 const int tx_progress_ts =
950 if (tx_progress_ts < tx_end_state_ts) {
951 SCLogDebug(
"%p/%"PRIu64
" skipping: ts parser not done", tx, i);
956 if (txd && has_tx_detect_flags) {
959 if (!(detect_flags_ts &
961 SCLogDebug(
"%p/%" PRIu64
" skipping: TS inspect not done: ts:%" PRIx64, tx, i,
968 if (!(detect_flags_tc &
970 SCLogDebug(
"%p/%" PRIu64
" skipping: TC inspect not done: ts:%" PRIx64, tx, i,
978 SCLogDebug(
"%p/%" PRIu64
" tx_skipped", tx, i);
983 if (txd && logger_expectation != 0) {
984 LoggerId tx_logged = GetTxLogged(txd);
985 if (tx_logged != logger_expectation) {
986 SCLogDebug(
"%p/%"PRIu64
" skipping: logging not done: want:%"PRIx32
", have:%"PRIx32,
987 tx, i, logger_expectation, tx_logged);
996 SCLogDebug(
"files_opened %u files_logged %u files_stored %u", txd->files_opened,
997 txd->files_logged, txd->files_stored);
999 if (txd->files_opened) {
1016 SCLogDebug(
"skipped? %s i %"PRIu64
", new_min %"PRIu64, skipped ?
"true" :
"false", i, new_min);
1019 SCLogDebug(
"final i %"PRIu64
", new_min %"PRIu64, i, new_min);
1022 if (!ires.has_next) {
1026 SCLogDebug(
"no next: cur tx i %"PRIu64
", total %"PRIu64, i, total_txs);
1028 new_min = total_txs;
1029 SCLogDebug(
"no next: cur tx i %"PRIu64
", total %"PRIu64
": "
1030 "new_min updated to %"PRIu64, i, total_txs, new_min);
1038 SCLogDebug(
"update f->alparser->min_id? %"PRIu64
" vs %"PRIu64, new_min, alparser->
min_id);
1039 if (new_min > alparser->
min_id) {
1040 const uint64_t next_id = new_min;
1041 alparser->
min_id = next_id;
1050 static inline int StateGetProgressCompletionStatus(
const AppProto alproto,
const uint8_t
flags)
1052 if (
flags & STREAM_TOSERVER) {
1054 }
else if (
flags & STREAM_TOCLIENT) {
1068 void *alstate, uint8_t
flags)
1073 r = StateGetProgressCompletionStatus(alproto,
flags);
1075 uint8_t direction =
flags & (STREAM_TOCLIENT | STREAM_TOSERVER);
1077 alstate, direction);
1100 int r = StateGetProgressCompletionStatus(alproto, direction);
1105 int *event_id, AppLayerEventType *event_type)
1115 const char **event_name, AppLayerEventType *event_type)
1119 *event_name = (
const char *)NULL;
1170 AppLayerStateData *d =
1178 void *state,
void *tx,
enum ConfigAction mode, AppLayerTxConfig config)
1192 if ((
flags & (STREAM_EOF|STREAM_TOSERVER)) == (STREAM_EOF|STREAM_TOSERVER)) {
1193 SCLogDebug(
"setting APP_LAYER_PARSER_EOF_TS");
1195 }
else if ((
flags & (STREAM_EOF|STREAM_TOCLIENT)) == (STREAM_EOF|STREAM_TOCLIENT)) {
1196 SCLogDebug(
"setting APP_LAYER_PARSER_EOF_TC");
1205 static void HandleStreamFrames(
Flow *f, StreamSlice stream_slice,
const uint8_t *input,
1206 const uint32_t input_len,
const uint8_t
flags)
1208 const uint8_t direction = (
flags & STREAM_TOSERVER) ? 0 : 1;
1214 input != NULL && f->
proto == IPPROTO_TCP) {
1216 if (frame == NULL) {
1217 int64_t frame_len = -1;
1218 if (
flags & STREAM_EOF)
1219 frame_len = input_len;
1222 f, &stream_slice, stream_slice.offset, frame_len, direction,
FRAME_STREAM_TYPE);
1224 SCLogDebug(
"opened: frame %p id %" PRIi64, frame, frame->
id);
1229 if (direction == 0) {
1235 }
else if (
flags & STREAM_EOF) {
1240 int64_t slice_o = (int64_t)stream_slice.offset - (int64_t)frame->
offset;
1241 int64_t frame_len = slice_o + (int64_t)input_len;
1242 SCLogDebug(
"%s: EOF frame->offset %" PRIu64
" -> %" PRIi64
": o %" PRIi64,
1244 frame->
len = frame_len;
1249 static void Setup(
Flow *f,
const uint8_t direction,
const uint8_t *input, uint32_t input_len,
1250 const uint8_t
flags, StreamSlice *as)
1252 memset(as, 0,
sizeof(*as));
1254 as->input_len = input_len;
1268 uint8_t
flags,
const uint8_t *input, uint32_t input_len)
1271 #ifdef DEBUG_VALIDATION
1276 StreamSlice stream_slice;
1277 void *alstate = NULL;
1278 uint64_t p_tx_cnt = 0;
1279 uint32_t consumed = input_len;
1280 const uint8_t direction = (
flags & STREAM_TOSERVER) ? 0 : 1;
1284 if (f->
proto == IPPROTO_TCP) {
1290 if (
flags & STREAM_GAP) {
1292 SCLogDebug(
"app-layer parser does not accept gaps");
1302 if (pstate == NULL) {
1304 if (pstate == NULL) {
1310 SetEOFFlags(pstate,
flags);
1315 if (alstate == NULL) {
1319 SCLogDebug(
"alloced new app layer state %p (name %s)",
1327 SCLogDebug(
"state data: updating file_flags %04x with flow file_flags %04x",
1334 SCLogDebug(
"using existing app layer state %p (name %s))",
1341 if (input_len > 0 || (
flags & STREAM_EOF)) {
1342 Setup(f,
flags & (STREAM_TOSERVER | STREAM_TOCLIENT), input, input_len,
flags,
1344 HandleStreamFrames(f, stream_slice, input, input_len,
flags);
1347 if (((stream_slice.flags & STREAM_TOSERVER) &&
1348 stream_slice.offset >= g_eps_applayer_error_offset_ts)) {
1349 SCLogNotice(
"putting parser %s into an error state from toserver offset %" PRIu64,
1354 if (((stream_slice.flags & STREAM_TOCLIENT) &&
1355 stream_slice.offset >= g_eps_applayer_error_offset_tc)) {
1356 SCLogNotice(
"putting parser %s into an error state from toclient offset %" PRIu64,
1363 AppLayerResult res = p->
Parser[direction](f, alstate, pstate, stream_slice,
1365 if (res.status < 0) {
1368 }
else if (res.status > 0) {
1377 if (res.consumed > input_len || res.needed + res.consumed < input_len) {
1385 (
flags & STREAM_TOSERVER) ?
"toserver" :
"toclient");
1386 if (direction == 0) {
1400 consumed = res.consumed;
1408 if (f->
proto == IPPROTO_TCP) {
1430 FlowSetNoPayloadInspectionFlag(f);
1436 FlowSetNoPayloadInspectionFlag(f);
1438 if (f->
proto == IPPROTO_TCP) {
1450 if (cur_tx_cnt > p_tx_cnt &&
tv) {
1456 if (consumed != input_len && f->
proto == IPPROTO_TCP && f->
protoctx != NULL) {
1466 if (f->
proto == IPPROTO_TCP) {
1480 SCLogDebug(
"setting APP_LAYER_PARSER_EOF_TC and APP_LAYER_PARSER_EOF_TS");
1521 int r = (alp_ctx.
ctxs[ipproto_map][alproto].
logger ==
false) ? 0 : 1;
1538 if (f != NULL && f->
protoctx != NULL)
1564 if (state != NULL) {
1601 if (
ctx->StateFree != NULL && alstate != NULL)
1602 ctx->StateFree(alstate);
1616 static void ValidateParserProtoDump(
AppProto alproto, uint8_t ipproto)
1620 printf(
"ERROR: incomplete app-layer registration\n");
1621 printf(
"AppLayer protocol %s ipproto %u\n",
AppProtoToString(alproto), ipproto);
1622 printf(
"- option flags %"PRIx32
"\n",
ctx->option_flags);
1623 printf(
"- first_data_dir %"PRIx8
"\n",
ctx->first_data_dir);
1624 printf(
"Mandatory:\n");
1625 printf(
"- Parser[0] %p Parser[1] %p\n",
ctx->Parser[0],
ctx->Parser[1]);
1626 printf(
"- StateAlloc %p StateFree %p\n",
ctx->StateAlloc,
ctx->StateFree);
1627 printf(
"- StateGetTx %p StateGetTxCnt %p StateTransactionFree %p\n",
1628 ctx->StateGetTx,
ctx->StateGetTxCnt,
ctx->StateTransactionFree);
1629 printf(
"- GetTxData %p\n",
ctx->GetTxData);
1630 printf(
"- GetStateData %p\n",
ctx->GetStateData);
1631 printf(
"- StateGetProgress %p\n",
ctx->StateGetProgress);
1632 printf(
"Optional:\n");
1633 printf(
"- LocalStorageAlloc %p LocalStorageFree %p\n",
ctx->LocalStorageAlloc,
ctx->LocalStorageFree);
1634 printf(
"- StateGetEventInfo %p StateGetEventInfoById %p\n",
ctx->StateGetEventInfo,
1635 ctx->StateGetEventInfoById);
1638 #define BOTH_SET(a, b) ((a) != NULL && (b) != NULL)
1639 #define BOTH_SET_OR_BOTH_UNSET(a, b) (((a) == NULL && (b) == NULL) || ((a) != NULL && (b) != NULL))
1640 #define THREE_SET(a, b, c) ((a) != NULL && (b) != NULL && (c) != NULL)
1642 static void ValidateParserProto(
AppProto alproto, uint8_t ipproto)
1647 if (
ctx->Parser[0] == NULL &&
ctx->Parser[1] == NULL)
1659 if (
ctx->StateGetProgress == NULL) {
1666 if (
ctx->GetTxData == NULL) {
1669 if (
ctx->GetStateData == NULL) {
1674 ValidateParserProtoDump(alproto, ipproto);
1678 #undef BOTH_SET_OR_BOTH_UNSET
1679 #undef THREE_SET_OR_THREE_UNSET
1682 static void ValidateParser(
AppProto alproto)
1684 ValidateParserProto(alproto, IPPROTO_TCP);
1685 ValidateParserProto(alproto, IPPROTO_UDP);
1688 static void ValidateParsers(
void)
1704 rs_dcerpc_register_parser();
1705 rs_dcerpc_udp_register_parser();
1710 SCRegisterDnsUdpParser();
1711 SCRegisterDnsTcpParser();
1712 rs_bittorrent_dht_udp_register_parser();
1714 SCEnipRegisterParsers();
1718 rs_register_ntp_parser();
1721 rs_register_krb5_parser();
1722 rs_dhcp_register_parser();
1723 rs_register_snmp_parser();
1724 rs_sip_register_parser();
1725 rs_quic_register_parser();
1726 rs_websocket_register_parser();
1727 rs_ldap_register_parser();
1728 rs_template_register_parser();
1730 SCMqttRegisterParser();
1731 rs_pgsql_register_parser();
1732 rs_rdp_register_parser();
1734 rs_telnet_register_parser();
1741 IPPROTO_TCP,
ALPROTO_POP3,
"+OK ", 4, 0, STREAM_TOCLIENT) < 0) {
1742 FatalError(
"pop3 proto registration failure");
1745 SCLogInfo(
"Protocol detection and parser disabled for pop3 protocol.");
1756 pstate->
flags |= flag;
1783 StreamSlice stream_slice,
void *local_data)
1791 static void *TestProtocolStateAlloc(
void *orig_state,
AppProto proto_orig)
1804 static void TestProtocolStateFree(
void *s)
1809 static uint64_t TestGetTxCnt(
void *state)
1815 static void TestStateTransactionFree(
void *state, uint64_t tx_id)
1820 static void *TestGetTx(
void *state, uint64_t tx_id)
1827 void (*RegisterUnittests)(
void))
1831 RegisterUnittests = RegisterUnittests;
1838 alp_ctx_backup_unittest = alp_ctx;
1839 memset(&alp_ctx, 0,
sizeof(alp_ctx));
1846 alp_ctx = alp_ctx_backup_unittest;
1847 memset(&alp_ctx_backup_unittest, 0,
sizeof(alp_ctx_backup_unittest));
1855 static int AppLayerParserTest01(
void)
1860 uint8_t testbuf[] = { 0x11 };
1861 uint32_t testlen =
sizeof(testbuf);
1865 memset(&ssn, 0,
sizeof(ssn));
1870 TestProtocolStateAlloc, TestProtocolStateFree);
1875 f =
UTHBuildFlow(AF_INET,
"1.2.3.4",
"4.3.2.1", 20, 40);
1879 f->
proto = IPPROTO_TCP;
1884 STREAM_TOSERVER | STREAM_EOF, testbuf,
1900 static int AppLayerParserTest02(
void)
1905 uint8_t testbuf[] = { 0x11 };
1906 uint32_t testlen =
sizeof(testbuf);
1911 TestProtocolParser);
1913 TestProtocolStateAlloc, TestProtocolStateFree);
1918 f =
UTHBuildFlow(AF_INET,
"1.2.3.4",
"4.3.2.1", 20, 40);
1921 f->
proto = IPPROTO_UDP;
1927 STREAM_TOSERVER | STREAM_EOF, testbuf,
1947 for (alproto = 0; alproto <
ALPROTO_MAX; alproto++) {
1948 ctx = &alp_ctx.
ctxs[ip][alproto];
1949 if (
ctx->RegisterUnittests == NULL)
1951 ctx->RegisterUnittests();
void AppLayerParserRegisterGetStateProgressFunc(uint8_t ipproto, AppProto alproto, int(*StateGetProgress)(void *alstate, uint8_t direction))
int AppLayerParserDeSetup(void)
AppLayerStateData *(* GetStateData)(void *state)
uint64_t(* StateGetTxCnt)(void *alstate)
enum ExceptionPolicy g_applayerparser_error_policy
AppLayerTxData *(* GetTxData)(void *tx)
#define FAIL_IF_NULL(expr)
Fail a test if expression evaluates to NULL.
AppLayerParserProtoCtx ctxs[FLOW_PROTO_MAX][ALPROTO_MAX]
void RegisterSMBParsers(void)
void RegisterIKEParsers(void)
int AppLayerParserIsEnabled(AppProto alproto)
simple way to globally test if a alproto is registered and fully enabled in the configuration.
void AppLayerParserRegisterLocalStorageFunc(uint8_t ipproto, AppProto alproto, void *(*LocalStorageAlloc)(void), void(*LocalStorageFree)(void *))
int AppLayerParserProtocolHasLogger(uint8_t ipproto, AppProto alproto)
void AppLayerParserRegisterOptionFlags(uint8_t ipproto, AppProto alproto, uint32_t flags)
void FramesFree(Frames *frames)
void AppLayerParserSetStreamDepthFlag(uint8_t ipproto, AppProto alproto, void *state, uint64_t tx_id, uint8_t flags)
void AppLayerParserSetTransactionLogId(AppLayerParserState *pstate, uint64_t tx_id)
bool g_filedata_logger_enabled
void AppLayerParserSetStreamDepth(uint8_t ipproto, AppProto alproto, uint32_t stream_depth)
void AppLayerParserApplyTxConfig(uint8_t ipproto, AppProto alproto, void *state, void *tx, enum ConfigAction mode, AppLayerTxConfig config)
void AppLayerParserTransactionsCleanup(Flow *f, const uint8_t pkt_dir)
remove obsolete (inspected and logged) transactions
void * AppLayerParserGetProtocolParserLocalStorage(uint8_t ipproto, AppProto alproto)
void UtRegisterTest(const char *name, int(*TestFn)(void))
Register unit test.
void(* LocalStorageFree)(void *)
App layer protocol parser context.
void RegisterSSHParsers(void)
Function to register the SSH protocol parsers and other functions.
void *(* StateGetTx)(void *alstate, uint64_t tx_id)
void AppLayerParserSetTransactionInspectId(const Flow *f, AppLayerParserState *pstate, void *alstate, const uint8_t flags, bool tag_txs_as_inspected)
#define APP_LAYER_PARSER_BYPASS_READY
AppLayerDecoderEvents * AppLayerParserGetEventsByTx(uint8_t ipproto, AppProto alproto, void *tx)
AppLayerGetTxIteratorFunc AppLayerGetTxIterator(const uint8_t ipproto, const AppProto alproto)
struct HtpBodyChunk_ * next
void RegisterModbusParsers(void)
Function to register the Modbus protocol parser.
void StreamTcpSetDisableRawReassemblyFlag(TcpSession *, char)
Set the No reassembly flag for the given direction in given TCP session.
FramesContainer * AppLayerFramesSetupContainer(Flow *f)
int AppLayerParserConfParserEnabled(const char *ipproto, const char *alproto_name)
check if a parser is enabled in the config Returns enabled always if: were running unittests
int AppLayerParserGetStateProgress(uint8_t ipproto, AppProto alproto, void *alstate, uint8_t flags)
get the progress value for a tx/protocol
void AppLayerParserTriggerRawStreamReassembly(Flow *f, int direction)
ConfNode * ConfGetNode(const char *name)
Get a ConfNode by name.
uint32_t reassembly_depth
void AppLayerIncGapErrorCounter(ThreadVars *tv, Flow *f)
#define APP_LAYER_PARSER_INT_STREAM_DEPTH_SET
void StreamTcpReassembleTriggerRawReassembly(TcpSession *ssn, int direction)
Trigger RAW stream reassembly.
uint64_t AppLayerParserGetTransactionLogId(AppLayerParserState *pstate)
const char * AppProtoToString(AppProto alproto)
Maps the ALPROTO_*, to its string equivalent.
bool AppLayerParserSupportsFiles(uint8_t ipproto, AppProto alproto)
void AppLayerParserRegisterStateProgressCompletionStatus(AppProto alproto, const int ts, const int tc)
void AppLayerParserRegisterParserAcceptableDataDirection(uint8_t ipproto, AppProto alproto, uint8_t direction)
int AppLayerParserGetStateProgressCompletionStatus(AppProto alproto, uint8_t direction)
uint8_t AppLayerParserGetFirstDataDir(uint8_t ipproto, AppProto alproto)
int AppLayerParserProtoIsRegistered(uint8_t ipproto, AppProto alproto)
void AppLayerParserRegisterTxFreeFunc(uint8_t ipproto, AppProto alproto, void(*StateTransactionFree)(void *, uint64_t))
#define FLOW_NOPAYLOAD_INSPECTION
#define APP_LAYER_TX_SKIP_INSPECT_FLAG
void AppLayerParserStateProtoCleanup(uint8_t protomap, AppProto alproto, void *alstate, AppLayerParserState *pstate)
AppLayerGetTxIteratorFunc StateGetTxIterator
void AppLayerParserThreadCtxFree(AppLayerParserThreadCtx *tctx)
Destroys the app layer parser thread context obtained using AppLayerParserThreadCtxAlloc().
void AppLayerDecoderEventsFreeEvents(AppLayerDecoderEvents **events)
void StreamTcpUpdateAppLayerProgress(TcpSession *ssn, char direction, const uint32_t progress)
update reassembly progress
#define APP_LAYER_TX_INSPECTED_FLAG
AppLayerStateData * AppLayerParserGetStateData(uint8_t ipproto, AppProto alproto, void *state)
struct TestState_ TestState
Frame * AppLayerFrameNewByAbsoluteOffset(Flow *f, const StreamSlice *stream_slice, const uint64_t frame_start, const int64_t len, int dir, uint8_t frame_type)
create new frame using the absolute offset from the start of the stream
TcpStreamCnf stream_config
#define APP_LAYER_PARSER_EOF_TS
void AppLayerIncAllocErrorCounter(ThreadVars *tv, Flow *f)
@ EXCEPTION_POLICY_NOT_SET
enum ExceptionPolicy ExceptionPolicyParse(const char *option, bool support_flow)
void AppLayerParserRegisterUnittests(void)
uint64_t AppLayerParserGetTransactionInspectId(AppLayerParserState *pstate, uint8_t direction)
Data structure to store app layer decoder events.
bool(* ApplyTxConfig)(void *state, void *tx, int mode, AppLayerTxConfig)
uint8_t FlowGetReverseProtoMapping(uint8_t rproto)
void RegisterDNP3Parsers(void)
Register the DNP3 application protocol parser.
int ConfValIsTrue(const char *val)
Check if a value is true.
void FTPParserCleanup(void)
Free memory allocated for global FTP parser state.
AppLayerGetFileState AppLayerParserGetTxFiles(const Flow *f, void *tx, const uint8_t direction)
int AppLayerParserGetEventInfoById(uint8_t ipproto, AppProto alproto, int event_id, const char **event_name, AppLayerEventType *event_type)
const struct SigGroupHead_ * sgh_toserver
void AppLayerParserRestoreParserTable(void)
AppLayerResult(* AppLayerParserFPtr)(Flow *f, void *protocol_state, AppLayerParserState *pstate, StreamSlice stream_slice, void *local_storage)
Prototype for parsing functions.
struct AppLayerParserCtx_ AppLayerParserCtx
AppLayerParserState * alparser
void AppLayerParserRegisterProtocolParsers(void)
void RegisterRFBParsers(void)
void StreamTcpInitConfig(bool)
To initialize the stream global configuration data.
Flow * UTHBuildFlow(int family, const char *src, const char *dst, Port sp, Port dp)
#define APP_LAYER_PARSER_SFRAME_TS
#define PASS
Pass the test.
AppLayerParserGetFrameIdByNameFn GetFrameIdByName
const char * AppLayerParserGetFrameNameById(uint8_t ipproto, AppProto alproto, const uint8_t id)
uint64_t AppLayerParserGetTransactionActive(const Flow *f, AppLayerParserState *pstate, uint8_t direction)
void AppLayerFramesFreeContainer(Flow *f)
uint64_t AppLayerParserGetTxDetectFlags(AppLayerTxData *txd, const uint8_t dir)
AppLayerParserThreadCtx * alp_tctx
void AppLayerParserRegisterLogger(uint8_t ipproto, AppProto alproto)
void AppLayerParserRegisterGetFrameFuncs(uint8_t ipproto, AppProto alproto, AppLayerParserGetFrameIdByNameFn GetIdByNameFunc, AppLayerParserGetFrameNameByIdFn GetNameByIdFunc)
void(* SetStreamDepthFlag)(void *tx, uint8_t flags)
Per thread variable structure.
void AppLayerParserRegisterLoggerBits(uint8_t ipproto, AppProto alproto, LoggerId bits)
int(* StateGetEventInfo)(const char *event_name, int *event_id, AppLayerEventType *event_type)
void AppLayerParserRegisterStateFuncs(uint8_t ipproto, AppProto alproto, void *(*StateAlloc)(void *, AppProto), void(*StateFree)(void *))
#define APP_LAYER_PARSER_NO_REASSEMBLY
#define IS_DISRUPTED(flags)
void AppLayerParserSetEOF(AppLayerParserState *pstate)
void(* RegisterUnittests)(void)
void AppLayerParserStateFree(AppLayerParserState *pstate)
void AppLayerParserStateCleanup(const Flow *f, void *alstate, AppLayerParserState *pstate)
void AppLayerParserBackupParserTable(void)
int(* StateGetEventInfoById)(int event_id, const char **event_name, AppLayerEventType *event_type)
const struct SigGroupHead_ * sgh_toclient
void RegisterNFSTCPParsers(void)
AppLayerParserGetFrameNameByIdFn GetFrameNameById
struct AppLayerParserProtoCtx_ AppLayerParserProtoCtx
App layer protocol parser context.
int AppLayerParserSetup(void)
void RegisterFTPParsers(void)
void AppLayerParserRegisterProtocolUnittests(uint8_t ipproto, AppProto alproto, void(*RegisterUnittests)(void))
void *(* StateAlloc)(void *, AppProto)
uint8_t FlowGetProtoMapping(uint8_t proto)
Function to map the protocol to the defined FLOW_PROTO_* enumeration.
void RegisterTFTPParsers(void)
#define FLOW_PROTO_APPLAYER_MAX
#define APP_LAYER_PARSER_EOF_TC
#define DEBUG_ASSERT_FLOW_LOCKED(f)
#define BOTH_SET_OR_BOTH_UNSET(a, b)
void * alproto_local_storage[FLOW_PROTO_MAX][ALPROTO_MAX]
void AppLayerParserRegisterGetEventInfo(uint8_t ipproto, AppProto alproto, int(*StateGetEventInfo)(const char *event_name, int *event_id, AppLayerEventType *event_type))
#define SCReturnPtr(x, type)
void(* StateFree)(void *)
void AppLayerParserRegisterGetTxFilesFunc(uint8_t ipproto, AppProto alproto, AppLayerGetFileState(*GetTxFiles)(void *, uint8_t))
void AppLayerProtoDetectRegisterProtocol(AppProto alproto, const char *alproto_name)
Registers a protocol for protocol detection phase.
void AppLayerParserRegisterSetStreamDepthFlag(uint8_t ipproto, AppProto alproto, void(*SetStreamDepthFlag)(void *tx, uint8_t flags))
#define APP_LAYER_PARSER_SFRAME_TC
void AppLayerIncParserErrorCounter(ThreadVars *tv, Flow *f)
int RunmodeIsUnittests(void)
#define SCLogInfo(...)
Macro used to log INFORMATIONAL messages.
#define APP_LAYER_PARSER_NO_INSPECTION
void * AppLayerParserGetTx(uint8_t ipproto, AppProto alproto, void *alstate, uint64_t tx_id)
int AppLayerParserRegisterParser(uint8_t ipproto, AppProto alproto, uint8_t direction, AppLayerParserFPtr Parser)
Register app layer parser for the protocol.
void UTHFreeFlow(Flow *flow)
AppLayerParserThreadCtx * AppLayerParserThreadCtxAlloc(void)
Gets a new app layer protocol's parser thread context.
void AppLayerParserRegisterGetTx(uint8_t ipproto, AppProto alproto, void *(StateGetTx)(void *alstate, uint64_t tx_id))
void AppLayerParserStateSetFlag(AppLayerParserState *pstate, uint16_t flag)
AppLayerParserFPtr Parser[2]
struct AppLayerTxData AppLayerTxData
void(* StateTransactionFree)(void *, uint64_t)
#define SCReturnStruct(x)
void RegisterSSLParsers(void)
Function to register the SSL protocol parser and other functions.
#define FAIL_IF(expr)
Fail a test if expression evaluates to true.
void StreamTcpSetSessionNoReassemblyFlag(TcpSession *, char)
disable reassembly
void StreamTcpFreeConfig(bool quiet)
int AppLayerParserParse(ThreadVars *tv, AppLayerParserThreadCtx *alp_tctx, Flow *f, AppProto alproto, uint8_t flags, const uint8_t *input, uint32_t input_len)
const char *(* AppLayerParserGetFrameNameByIdFn)(const uint8_t id)
void StreamTcpDisableAppLayer(Flow *f)
int AppLayerParserGetFrameIdByName(uint8_t ipproto, AppProto alproto, const char *name)
void AppLayerParserRegisterApplyTxConfigFunc(uint8_t ipproto, AppProto alproto, bool(*ApplyTxConfig)(void *state, void *tx, int mode, AppLayerTxConfig))
void AppLayerParserRegisterStateDataFunc(uint8_t ipproto, AppProto alproto, AppLayerStateData *(*GetStateData)(void *state))
void FilesPrune(FileContainer *fc, const StreamingBufferConfig *sbcfg, const bool trunc)
void AppLayerIncInternalErrorCounter(ThreadVars *tv, Flow *f)
AppLayerTxData * AppLayerParserGetTxData(uint8_t ipproto, AppProto alproto, void *tx)
void AppLayerParserRegisterTxDataFunc(uint8_t ipproto, AppProto alproto, AppLayerTxData *(*GetTxData)(void *tx))
uint32_t AppLayerParserGetStreamDepth(const Flow *f)
void RegisterIMAPParsers(void)
Frame * AppLayerFrameGetById(Flow *f, const int dir, const FrameId frame_id)
AppLayerGetFileState(* GetTxFiles)(void *, uint8_t)
#define FRAME_STREAM_TYPE
#define APP_LAYER_PARSER_OPT_ACCEPT_GAPS
void AppLayerParserRegisterGetTxIterator(uint8_t ipproto, AppProto alproto, AppLayerGetTxIteratorFunc Func)
FramesContainer * AppLayerFramesGetContainer(Flow *f)
#define SCLogError(...)
Macro used to log ERROR messages.
void AppLayerParserPostStreamSetup(void)
AppLayerDecoderEvents * AppLayerParserGetDecoderEvents(AppLayerParserState *pstate)
#define THREE_SET(a, b, c)
void AppLayerParserRegisterGetEventInfoById(uint8_t ipproto, AppProto alproto, int(*StateGetEventInfoById)(int event_id, const char **event_name, AppLayerEventType *event_type))
const char * AppLayerGetProtoName(AppProto alproto)
Given the internal protocol id, returns a string representation of the protocol.
void UTHAppLayerParserStateGetIds(void *ptr, uint64_t *i1, uint64_t *i2, uint64_t *log, uint64_t *min)
int ConfValIsFalse(const char *val)
Check if a value is false.
void RegisterHTPParsers(void)
Register the HTTP protocol and state handling functions to APP layer of the engine.
void AppLayerIncTxCounter(ThreadVars *tv, Flow *f, uint64_t step)
#define FRAME_FLAG_ENDS_AT_EOF
void RegisterSMTPParsers(void)
Register the SMTP Protocol parser.
AppLayerParserState * AppLayerParserStateAlloc(void)
#define SCReturnCT(x, type)
#define STREAMTCP_FLAG_APP_LAYER_DISABLED
AppLayerDecoderEvents * decoder_events
void AppLayerParserRegisterGetTxCnt(uint8_t ipproto, AppProto alproto, uint64_t(*StateGetTxCnt)(void *alstate))
int(* StateGetProgress)(void *alstate, uint8_t direction)
LoggerId AppLayerParserProtocolGetLoggerBits(uint8_t ipproto, AppProto alproto)
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
bool g_file_logger_enabled
void RegisterHTTP2Parsers(void)
#define STREAM_APP_PROGRESS(stream)
int AppLayerProtoDetectPMRegisterPatternCS(uint8_t ipproto, AppProto alproto, const char *pattern, uint16_t depth, uint16_t offset, uint8_t direction)
Registers a case-sensitive pattern for protocol detection.
#define APP_LAYER_PARSER_NO_INSPECTION_PAYLOAD
int FlowChangeProto(Flow *f)
Check if change proto flag is set for flow.
uint8_t FlowGetDisruptionFlags(const Flow *f, uint8_t flags)
get 'disruption' flags: GAP/DEPTH/PASS
uint16_t AppLayerParserStateIssetFlag(AppLayerParserState *pstate, uint16_t flag)
#define SCLogNotice(...)
Macro used to log NOTICE messages.
void RegisterNFSUDPParsers(void)
AppProto alproto
application level protocol
void AppLayerParserDestroyProtocolParserLocalStorage(uint8_t ipproto, AppProto alproto, void *local_data)
uint64_t AppLayerParserGetTxCnt(const Flow *f, void *alstate)
int AppLayerProtoDetectConfProtoDetectionEnabled(const char *ipproto, const char *alproto)
Given a protocol name, checks if proto detection is enabled in the conf file.
void SMTPParserCleanup(void)
Free memory allocated for global SMTP parser state.
bool AppLayerParserHasDecoderEvents(AppLayerParserState *pstate)
int(* AppLayerParserGetFrameIdByNameFn)(const char *frame_name)
void StreamTcpSetSessionBypassFlag(TcpSession *)
enable bypass
#define DEBUG_VALIDATE_BUG_ON(exp)
void *(* LocalStorageAlloc)(void)
int AppLayerParserGetEventInfo(uint8_t ipproto, AppProto alproto, const char *event_name, int *event_id, AppLayerEventType *event_type)