Skip to content

Commit

Permalink
output/json: check 5-tuple values prior to logging
Browse files Browse the repository at this point in the history
This commit enhances the JSON output by introducing a feature for conditional port logging.
Now, port logging is dependent on the underlying protocol
(such as TCP, UDP, or SCTP), where port information is pertinent, while it
avoids unnecessary logging for protocols where a port is not utilized (e.g. ARP).

Furthermore, this update ensures that IP addresses and the protocol have
meaningful values set, rather than being logged as empty strings.

These changes will make each log entry more precise, eliminating cases where
5-tuple fields are empty or set to zero, indicating the absence of a field.

Backported to address ticket: https://redmine.openinfosecfoundation.org/issues/7460

Ticket: OISF#7460

(cherry picked from commit a1c6328)
  • Loading branch information
glongo authored and jasonish committed Dec 16, 2024
1 parent e5ebe36 commit 3219c57
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 5 deletions.
22 changes: 17 additions & 5 deletions src/output-json.c
Original file line number Diff line number Diff line change
Expand Up @@ -581,8 +581,10 @@ void JsonAddrInfoInit(const Packet *p, enum OutputJsonLogDirection dir, JsonAddr
case IPPROTO_SCTP:
addr->sp = sp;
addr->dp = dp;
addr->log_port = true;
break;
default:
addr->log_port = false;
break;
}

Expand Down Expand Up @@ -880,11 +882,21 @@ JsonBuilder *CreateEveHeader(const Packet *p, enum OutputJsonLogDirection dir,
JsonAddrInfoInit(p, dir, &addr_info);
addr = &addr_info;
}
jb_set_string(js, "src_ip", addr->src_ip);
jb_set_uint(js, "src_port", addr->sp);
jb_set_string(js, "dest_ip", addr->dst_ip);
jb_set_uint(js, "dest_port", addr->dp);
jb_set_string(js, "proto", addr->proto);
if (addr->src_ip[0] != '\0') {
jb_set_string(js, "src_ip", addr->src_ip);
}
if (addr->log_port) {
jb_set_uint(js, "src_port", addr->sp);
}
if (addr->dst_ip[0] != '\0') {
jb_set_string(js, "dest_ip", addr->dst_ip);
}
if (addr->log_port) {
jb_set_uint(js, "dest_port", addr->dp);
}
if (addr->proto[0] != '\0') {
jb_set_string(js, "proto", addr->proto);
}

/* icmp */
switch (p->proto) {
Expand Down
2 changes: 2 additions & 0 deletions src/output-json.h
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ typedef struct JsonAddrInfo_ {
Port sp;
Port dp;
char proto[JSON_PROTO_LEN];
// Ports are logged only when provided by the transport protocol.
bool log_port;
} JsonAddrInfo;

extern const JsonAddrInfo json_addr_info_zero;
Expand Down

0 comments on commit 3219c57

Please sign in to comment.