Go to the documentation of this file.
83 void *(*LocalStorageAlloc)(void);
92 void *(*StateGetTx)(
void *alstate, uint64_t tx_id);
97 uint8_t event_id,
const char **event_name, AppLayerEventType *event_type);
99 const char *event_name, uint8_t *event_id, AppLayerEventType *event_type);
101 AppLayerStateData *(*GetStateData)(
void *state);
151 static void AppLayerConfig(
void)
163 if (frames != NULL) {
180 if (f == NULL || f->
alparser == NULL)
226 return (alp_ctx.
ctxs[alproto][ipproto_map].
StateAlloc != NULL) ? 1 : 0;
247 AppLayerParserFramesFreeContainer(pstate->
frames);
339 const char *alproto_name)
351 r = snprintf(param,
sizeof(param),
"%s%s%s",
"app-layer.protocols.",
352 alproto_name,
".enabled");
355 }
else if (r > (
int)
sizeof(param)) {
356 FatalError(
"buffer not big enough to write param.");
362 r = snprintf(param,
sizeof(param),
"%s%s%s%s%s",
"app-layer.protocols.",
363 alproto_name,
".", ipproto,
".enabled");
366 }
else if (r > (
int)
sizeof(param)) {
367 FatalError(
"buffer not big enough to write param.");
381 }
else if (strcasecmp(node->
val,
"detection-only") == 0) {
384 SCLogError(
"Invalid value found for %s.", param);
403 .
Parser[(direction & STREAM_TOSERVER) ? 0 : 1] = Parser;
414 (direction & (STREAM_TOSERVER | STREAM_TOCLIENT));
430 void *(*StateAlloc)(
void *,
AppProto),
void (*StateFree)(
void *))
441 void *(*LocalStorageAlloc)(
void),
442 void (*LocalStorageFree)(
void *))
453 uint8_t ipproto,
AppProto alproto, AppLayerGetFileState (*GetTxFiles)(
void *, uint8_t))
481 int (*StateGetProgress)(
void *alstate, uint8_t direction))
491 void (*StateTransactionFree)(
void *, uint64_t))
501 uint64_t (*StateGetTxCnt)(
void *alstate))
511 void *(StateGetTx)(
void *alstate, uint64_t tx_id))
533 BUG_ON(!AppProtoIsValid(alproto));
544 int (*StateGetEventInfoById)(
545 uint8_t event_id,
const char **event_name, AppLayerEventType *event_type))
550 StateGetEventInfoById;
566 int (*StateGetEventInfo)(
567 const char *event_name, uint8_t *event_id, AppLayerEventType *event_type))
587 uint8_t ipproto,
AppProto alproto, AppLayerStateData *(*GetStateData)(
void *state))
597 bool (*ApplyTxConfig)(
void *state,
void *tx,
int mode, AppLayerTxConfig))
607 void (*SetStreamDepthFlag)(
void *tx, uint8_t
flags))
650 static AppLayerGetTxIterTuple AppLayerDefaultGetTxIterator(
651 const uint8_t ipproto,
const AppProto alproto,
652 void *alstate, uint64_t min_tx_id, uint64_t max_tx_id,
655 uint64_t ustate = *(uint64_t *)state;
656 uint64_t tx_id =
MAX(min_tx_id, ustate);
657 for ( ; tx_id < max_tx_id; tx_id++) {
659 if (tx_ptr != NULL) {
662 AppLayerGetTxIterTuple tuple = {
665 .has_next = (tx_id + 1 < max_tx_id),
667 SCLogDebug(
"tuple: %p/%"PRIu64
"/%s", tuple.tx_ptr, tuple.tx_id,
668 tuple.has_next ?
"true" :
"false");
673 AppLayerGetTxIterTuple no_tuple = { NULL, 0,
false };
682 return Func ? Func : AppLayerDefaultGetTxIterator;
715 uint8_t p = (dir & STREAM_TOSERVER) ? txd->detect_progress_ts : txd->detect_progress_tc;
721 return txd->logged.flags;
725 void *alstate,
const uint8_t
flags,
726 bool tag_txs_as_inspected)
730 const int direction = (
flags & STREAM_TOSERVER) ? 0 : 1;
734 const uint8_t ipproto = f->
proto;
740 SCLogDebug(
"called: %s, tag_txs_as_inspected %s",direction==0?
"toserver":
"toclient",
741 tag_txs_as_inspected?
"true":
"false");
746 AppLayerGetTxIterTuple ires = IterFunc(ipproto, alproto, alstate, idx, total_txs, &state);
747 if (ires.tx_ptr == NULL)
750 void *tx = ires.tx_ptr;
754 if (state_progress < state_done_progress)
758 if (txd && tag_txs_as_inspected) {
761 if (txd->flags & inspected_flag) {
762 txd->flags |= inspected_flag;
763 SCLogDebug(
"%p/%" PRIu64
" in-order tx is done for direction %s. Flags %02x", tx,
764 idx,
flags & STREAM_TOSERVER ?
"toserver" :
"toclient", txd->flags);
776 if (tag_txs_as_inspected) {
779 AppLayerGetTxIterTuple ires = IterFunc(ipproto, alproto, alstate, idx, total_txs, &state);
780 if (ires.tx_ptr == NULL)
783 void *tx = ires.tx_ptr;
787 if (ires.tx_id > idx && pstate->
inspect_id[direction] == idx) {
793 if (state_progress < state_done_progress)
799 const uint8_t inspected_flag = (
flags & STREAM_TOSERVER)
802 if (txd->flags & inspected_flag) {
803 txd->flags |= inspected_flag;
804 SCLogDebug(
"%p/%" PRIu64
" out of order tx is done for direction %s. Flag %02x",
805 tx, idx,
flags & STREAM_TOSERVER ?
"toserver" :
"toclient", txd->flags);
807 SCLogDebug(
"%p/%"PRIu64
" out of order tx. Update inspect_id? %"PRIu64,
830 "AppLayerDecoderEvents *");
842 if (txd != NULL && txd->events != NULL) {
857 AppLayerGetFileState files = { .fc = NULL, .cfg = NULL };
861 static void AppLayerParserFileTxHousekeeping(
862 const Flow *f,
void *tx,
const uint8_t pkt_dir,
const bool trunc)
870 #define IS_DISRUPTED(flags) ((flags) & (STREAM_DEPTH | STREAM_GAP))
889 const uint8_t ipproto = f->
proto;
891 void *
const alstate = f->
alstate;
894 if (alstate == NULL || alparser == NULL)
897 const uint64_t min = alparser->
min_id;
905 int pkt_dir_trunc = -1;
909 memset(&state, 0,
sizeof(state));
911 uint64_t new_min = min;
913 bool skipped =
false;
917 AppLayerGetTxIterTuple ires = IterFunc(ipproto, alproto, alstate, i, total_txs, &state);
918 if (ires.tx_ptr == NULL)
921 bool tx_skipped =
false;
922 void *tx = ires.tx_ptr;
927 if (txd != NULL && AppLayerParserHasFilesInDir(txd, pkt_dir)) {
928 if (pkt_dir_trunc == -1)
930 (pkt_dir == STREAM_TOSERVER) ? ts_disrupt_flags : tc_disrupt_flags);
931 AppLayerParserFileTxHousekeeping(f, tx, pkt_dir, (
bool)pkt_dir_trunc);
935 if (pkt_dir & STREAM_TOSERVER) {
936 txd->updated_ts =
false;
938 txd->updated_tc =
false;
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) {
961 SCLogDebug(
"%p/%" PRIu64
" skipping: TS inspect not done: ts:%02x", tx, i,
970 SCLogDebug(
"%p/%" PRIu64
" skipping: TC inspect not done: ts:%02x", 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 uint8_t *event_id, AppLayerEventType *event_type)
1112 event_name, event_id, event_type);
1117 const char **event_name, AppLayerEventType *event_type)
1121 *event_name = (
const char *)NULL;
1125 event_id, event_name, event_type);
1174 AppLayerStateData *d =
1182 void *state,
void *tx,
enum ConfigAction mode, AppLayerTxConfig config)
1196 if ((
flags & (STREAM_EOF|STREAM_TOSERVER)) == (STREAM_EOF|STREAM_TOSERVER)) {
1197 SCLogDebug(
"setting APP_LAYER_PARSER_EOF_TS");
1199 }
else if ((
flags & (STREAM_EOF|STREAM_TOCLIENT)) == (STREAM_EOF|STREAM_TOCLIENT)) {
1200 SCLogDebug(
"setting APP_LAYER_PARSER_EOF_TC");
1209 static void HandleStreamFrames(
Flow *f, StreamSlice stream_slice,
const uint8_t *input,
1210 const uint32_t input_len,
const uint8_t
flags)
1212 const uint8_t direction = (
flags & STREAM_TOSERVER) ? 0 : 1;
1218 input != NULL && f->
proto == IPPROTO_TCP) {
1220 if (frame == NULL) {
1221 int64_t frame_len = -1;
1222 if (
flags & STREAM_EOF)
1223 frame_len = input_len;
1226 f, &stream_slice, stream_slice.offset, frame_len, direction,
FRAME_STREAM_TYPE);
1228 SCLogDebug(
"opened: frame %p id %" PRIi64, frame, frame->
id);
1233 if (direction == 0) {
1239 }
else if (
flags & STREAM_EOF) {
1244 int64_t slice_o = (int64_t)stream_slice.offset - (int64_t)frame->
offset;
1245 int64_t frame_len = slice_o + (int64_t)input_len;
1246 SCLogDebug(
"%s: EOF frame->offset %" PRIu64
" -> %" PRIi64
": o %" PRIi64,
1248 frame->
len = frame_len;
1253 static void Setup(
Flow *f,
const uint8_t direction,
const uint8_t *input, uint32_t input_len,
1254 const uint8_t
flags, StreamSlice *as)
1256 memset(as, 0,
sizeof(*as));
1258 as->input_len = input_len;
1272 uint8_t
flags,
const uint8_t *input, uint32_t input_len)
1275 #ifdef DEBUG_VALIDATION
1280 StreamSlice stream_slice;
1281 void *alstate = NULL;
1282 uint64_t p_tx_cnt = 0;
1283 uint32_t consumed = input_len;
1284 const uint8_t direction = (
flags & STREAM_TOSERVER) ? 0 : 1;
1288 if (f->
proto == IPPROTO_TCP) {
1294 if (
flags & STREAM_GAP) {
1296 SCLogDebug(
"app-layer parser does not accept gaps");
1306 if (pstate == NULL) {
1308 if (pstate == NULL) {
1314 SetEOFFlags(pstate,
flags);
1319 if (alstate == NULL) {
1323 SCLogDebug(
"alloced new app layer state %p (name %s)",
1331 SCLogDebug(
"state data: updating file_flags %04x with flow file_flags %04x",
1338 SCLogDebug(
"using existing app layer state %p (name %s))",
1345 if (input_len > 0 || (
flags & STREAM_EOF)) {
1346 Setup(f,
flags & (STREAM_TOSERVER | STREAM_TOCLIENT), input, input_len,
flags,
1348 HandleStreamFrames(f, stream_slice, input, input_len,
flags);
1351 if (((stream_slice.flags & STREAM_TOSERVER) &&
1352 stream_slice.offset >= g_eps_applayer_error_offset_ts)) {
1353 SCLogNotice(
"putting parser %s into an error state from toserver offset %" PRIu64,
1358 if (((stream_slice.flags & STREAM_TOCLIENT) &&
1359 stream_slice.offset >= g_eps_applayer_error_offset_tc)) {
1360 SCLogNotice(
"putting parser %s into an error state from toclient offset %" PRIu64,
1367 AppLayerResult res = p->
Parser[direction](f, alstate, pstate, stream_slice,
1369 if (res.status < 0) {
1372 }
else if (res.status > 0) {
1381 if (res.consumed > input_len || res.needed + res.consumed < input_len) {
1389 (
flags & STREAM_TOSERVER) ?
"toserver" :
"toclient");
1390 if (direction == 0) {
1404 consumed = res.consumed;
1412 if (f->
proto == IPPROTO_TCP) {
1434 FlowSetNoPayloadInspectionFlag(f);
1440 FlowSetNoPayloadInspectionFlag(f);
1442 if (f->
proto == IPPROTO_TCP) {
1454 if (cur_tx_cnt > p_tx_cnt &&
tv) {
1460 if (consumed != input_len && f->
proto == IPPROTO_TCP && f->
protoctx != NULL) {
1470 if (f->
proto == IPPROTO_TCP) {
1484 SCLogDebug(
"setting APP_LAYER_PARSER_EOF_TC and APP_LAYER_PARSER_EOF_TS");
1525 int r = (!alp_ctx.
ctxs[alproto][ipproto_map].
logger) ? 0 : 1;
1542 if (f != NULL && f->
protoctx != NULL)
1568 if (state != NULL) {
1605 if (
ctx->StateFree != NULL && alstate != NULL)
1606 ctx->StateFree(alstate);
1620 static void ValidateParserProtoDump(
AppProto alproto, uint8_t ipproto)
1624 printf(
"ERROR: incomplete app-layer registration\n");
1625 printf(
"AppLayer protocol %s ipproto %u\n",
AppProtoToString(alproto), ipproto);
1626 printf(
"- option flags %"PRIx32
"\n",
ctx->option_flags);
1627 printf(
"- first_data_dir %"PRIx8
"\n",
ctx->first_data_dir);
1628 printf(
"Mandatory:\n");
1629 printf(
"- Parser[0] %p Parser[1] %p\n",
ctx->Parser[0],
ctx->Parser[1]);
1630 printf(
"- StateAlloc %p StateFree %p\n",
ctx->StateAlloc,
ctx->StateFree);
1631 printf(
"- StateGetTx %p StateGetTxCnt %p StateTransactionFree %p\n",
1632 ctx->StateGetTx,
ctx->StateGetTxCnt,
ctx->StateTransactionFree);
1633 printf(
"- GetTxData %p\n",
ctx->GetTxData);
1634 printf(
"- GetStateData %p\n",
ctx->GetStateData);
1635 printf(
"- StateGetProgress %p\n",
ctx->StateGetProgress);
1636 printf(
"Optional:\n");
1637 printf(
"- LocalStorageAlloc %p LocalStorageFree %p\n",
ctx->LocalStorageAlloc,
ctx->LocalStorageFree);
1638 printf(
"- StateGetEventInfo %p StateGetEventInfoById %p\n",
ctx->StateGetEventInfo,
1639 ctx->StateGetEventInfoById);
1642 #define BOTH_SET(a, b) ((a) != NULL && (b) != NULL)
1643 #define BOTH_SET_OR_BOTH_UNSET(a, b) (((a) == NULL && (b) == NULL) || ((a) != NULL && (b) != NULL))
1644 #define THREE_SET(a, b, c) ((a) != NULL && (b) != NULL && (c) != NULL)
1646 static void ValidateParserProto(
AppProto alproto, uint8_t ipproto)
1651 if (
ctx->Parser[0] == NULL &&
ctx->Parser[1] == NULL)
1663 if (
ctx->StateGetProgress == NULL) {
1670 if (
ctx->GetTxData == NULL) {
1673 if (
ctx->GetStateData == NULL) {
1678 ValidateParserProtoDump(alproto, ipproto);
1682 #undef BOTH_SET_OR_BOTH_UNSET
1683 #undef THREE_SET_OR_THREE_UNSET
1686 static void ValidateParser(
AppProto alproto)
1688 ValidateParserProto(alproto, IPPROTO_TCP);
1689 ValidateParserProto(alproto, IPPROTO_UDP);
1692 static void ValidateParsers(
void)
1700 #define ARRAY_CAP_STEP 16
1701 static void (**PreRegisteredCallbacks)(void) = NULL;
1702 static size_t preregistered_callbacks_nb = 0;
1703 static size_t preregistered_callbacks_cap = 0;
1707 if (preregistered_callbacks_nb == preregistered_callbacks_cap) {
1708 void *tmp =
SCRealloc(PreRegisteredCallbacks,
1709 sizeof(
void *) * (preregistered_callbacks_cap +
ARRAY_CAP_STEP));
1714 PreRegisteredCallbacks = tmp;
1716 PreRegisteredCallbacks[preregistered_callbacks_nb] = Register;
1717 preregistered_callbacks_nb++;
1729 SCRegisterDcerpcParser();
1730 SCRegisterDcerpcUdpParser();
1735 SCRegisterDnsUdpParser();
1736 SCRegisterDnsTcpParser();
1737 SCRegisterBittorrentDhtUdpParser();
1739 SCEnipRegisterParsers();
1743 rs_register_ntp_parser();
1746 rs_register_krb5_parser();
1747 SCRegisterDhcpParser();
1748 rs_register_snmp_parser();
1749 rs_sip_register_parser();
1750 rs_quic_register_parser();
1751 rs_websocket_register_parser();
1752 SCRegisterLdapTcpParser();
1753 SCRegisterLdapUdpParser();
1754 rs_template_register_parser();
1755 SCRfbRegisterParser();
1756 SCMqttRegisterParser();
1757 SCRegisterPgsqlParser();
1758 rs_rdp_register_parser();
1760 rs_telnet_register_parser();
1767 IPPROTO_TCP,
ALPROTO_POP3,
"+OK ", 4, 0, STREAM_TOCLIENT) < 0) {
1768 FatalError(
"pop3 proto registration failure");
1771 SCLogInfo(
"Protocol detection and parser disabled for pop3 protocol.");
1773 for (
size_t i = 0; i < preregistered_callbacks_nb; i++) {
1774 PreRegisteredCallbacks[i]();
1785 pstate->
flags |= flag;
1802 void (*RegisterUnittests)(
void))
1819 ctx = &alp_ctx.
ctxs[alproto][ip];
1820 if (
ctx->RegisterUnittests == NULL)
1822 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)
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)
#define APP_LAYER_TX_SKIP_INSPECT_TC
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(* 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)
#define FLOW_SGH_TOCLIENT
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.
uint8_t AppLayerParserGetTxDetectProgress(AppLayerTxData *txd, const uint8_t dir)
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
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
AppLayerStateData * AppLayerParserGetStateData(uint8_t ipproto, AppProto alproto, void *state)
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
Frame * AppLayerFrameGetLastOpenByType(Flow *f, const int dir, const uint8_t frame_type)
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.
int(* StateGetEventInfoById)(uint8_t event_id, const char **event_name, AppLayerEventType *event_type)
void FTPParserCleanup(void)
Free memory allocated for global FTP parser state.
AppLayerGetFileState AppLayerParserGetTxFiles(const Flow *f, void *tx, const uint8_t direction)
const struct SigGroupHead_ * sgh_toserver
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)
#define APP_LAYER_PARSER_SFRAME_TS
int AppLayerParserGetEventInfoById(uint8_t ipproto, AppProto alproto, uint8_t event_id, const char **event_name, AppLayerEventType *event_type)
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)
void *(* alproto_local_storage)[FLOW_PROTO_MAX]
int(* StateGetEventInfo)(const char *event_name, uint8_t *event_id, AppLayerEventType *event_type)
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)
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)
const struct SigGroupHead_ * sgh_toclient
void RegisterNFSTCPParsers(void)
void AppLayerParserRegisterGetEventInfo(uint8_t ipproto, AppProto alproto, int(*StateGetEventInfo)(const char *event_name, uint8_t *event_id, AppLayerEventType *event_type))
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)
#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.
#define SCRealloc(ptr, sz)
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))
enum ExceptionPolicy AppLayerErrorGetExceptionPolicy(void)
void AppLayerParserStateSetFlag(AppLayerParserState *pstate, uint16_t flag)
AppLayerParserFPtr Parser[2]
struct AppLayerTxData AppLayerTxData
void(* StateTransactionFree)(void *, uint64_t)
int AppLayerParserPreRegister(void(*Register)(void))
void RegisterSSLParsers(void)
Function to register the SSL protocol parser and other functions.
void StreamTcpSetSessionNoReassemblyFlag(TcpSession *, char)
disable reassembly
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)
AppLayerParserProtoCtx(* ctxs)[FLOW_PROTO_MAX]
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)
AppLayerGetFileState(* GetTxFiles)(void *, uint8_t)
#define FRAME_STREAM_TYPE
#define APP_LAYER_PARSER_OPT_ACCEPT_GAPS
#define APP_LAYER_TX_INSPECTED_TS
void AppLayerParserRegisterGetTxIterator(uint8_t ipproto, AppProto alproto, AppLayerGetTxIteratorFunc Func)
FramesContainer * AppLayerFramesGetContainer(Flow *f)
#define SCLogError(...)
Macro used to log ERROR messages.
#define FLOW_SGH_TOSERVER
void AppLayerParserPostStreamSetup(void)
AppLayerDecoderEvents * AppLayerParserGetDecoderEvents(AppLayerParserState *pstate)
#define THREE_SET(a, b, c)
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)
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)
void AppLayerParserRegisterGetEventInfoById(uint8_t ipproto, AppProto alproto, int(*StateGetEventInfoById)(uint8_t event_id, const char **event_name, AppLayerEventType *event_type))
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)
#define APP_LAYER_TX_INSPECTED_TC
void *(* LocalStorageAlloc)(void)
int AppLayerParserGetEventInfo(uint8_t ipproto, AppProto alproto, const char *event_name, uint8_t *event_id, AppLayerEventType *event_type)
#define APP_LAYER_TX_SKIP_INSPECT_TS