suricata
packet.c File Reference
#include "packet.h"
#include "packet-bindgen.h"
#include "pkt-var.h"
#include "flow.h"
#include "host.h"
#include "util-profiling.h"
#include "util-validate.h"
#include "action-globals.h"
#include "rust.h"
#include "app-layer-events.h"
Include dependency graph for packet.c:

Go to the source code of this file.

Macros

#define CLEAR_ADDR(a)
 
#define PACKET_RESET_ACTION(p)   (p)->action = 0
 
#define RESET_PKT_LEN(p)   ((p)->pktlen = 0)
 

Functions

void PacketDrop (Packet *p, const uint8_t action, enum PacketDropReason r)
 issue drop action More...
 
bool PacketCheckAction (const Packet *p, const uint8_t a)
 
uint8_t PacketGetAction (const Packet *p)
 
bool PacketInit (Packet *p)
 Initialize a packet structure for use. More...
 
void PacketReleaseRefs (Packet *p)
 
void PacketReinit (Packet *p)
 Recycle a packet structure for reuse. More...
 
void PacketRecycle (Packet *p)
 
void PacketDestructor (Packet *p)
 Cleanup a packet so that we can free it. No memset needed.. More...
 
void SCPacketSetReleasePacket (Packet *p, void(*ReleasePacket)(Packet *p))
 Set a packet release function. More...
 
void SCPacketSetLiveDevice (Packet *p, LiveDevice *device)
 Set a packets live device. More...
 
void SCPacketSetDatalink (Packet *p, int datalink)
 Set a packets data link type. More...
 
void SCPacketSetTime (Packet *p, SCTime_t ts)
 Set the timestamp for a packet. More...
 
void SCPacketSetSource (Packet *p, enum PktSrcEnum source)
 Set packet source. More...
 
uint8_t SCPacketGetIPProto (const Packet *p)
 Get IP proto regardless of IP version. More...
 
bool SCPacketIsToServer (const Packet *p)
 Test whether the packet is marked as flowing to the server. More...
 
bool SCPacketIsToClient (const Packet *p)
 Test whether the packet is marked as flowing to the client. More...
 
enum PacketL3Types SCPacketGetL3Type (const Packet *p)
 Get the type of the packet's L3 layer. More...
 
const uint8_t * SCPacketGetL3 (const Packet *p, uint32_t *len)
 Get the L3 packet data, starting at the L3 header. More...
 
Flow * SCPacketGetFlow (const Packet *p)
 Get the flow associated with the packet. More...
 
void SCPacketGetTimeAsParts (const Packet *p, uint64_t *secs, uint64_t *usecs)
 Get packet timestamp as individual values. More...
 

Macro Definition Documentation

◆ CLEAR_ADDR

#define CLEAR_ADDR (   a)
Value:
do { \
(a)->family = 0; \
(a)->addr_data32[0] = 0; \
(a)->addr_data32[1] = 0; \
(a)->addr_data32[2] = 0; \
(a)->addr_data32[3] = 0; \
} while (0)

◆ PACKET_RESET_ACTION

#define PACKET_RESET_ACTION (   p)    (p)->action = 0

◆ RESET_PKT_LEN

#define RESET_PKT_LEN (   p)    ((p)->pktlen = 0)

Function Documentation

◆ PacketCheckAction()

bool PacketCheckAction ( const Packet *  p,
const uint8_t  a 
)

Definition at line 51 of file packet.c.

References Packet_::action, likely, p, and Packet_::root.

Referenced by AlertJsonHeader(), CaptureStatsUpdate(), RejectSendIPv4ICMP(), RejectSendIPv4TCP(), RejectSendIPv6ICMP(), and RejectSendIPv6TCP().

Here is the caller graph for this function:

◆ PacketDestructor()

void PacketDestructor ( Packet *  p)

Cleanup a packet so that we can free it. No memset needed..

Definition at line 179 of file packet.c.

References PacketAlerts_::alerts, Packet_::alerts, Packet_::app_layer_events, PacketAlerts_::drop, p, PACKET_FREE_EXTDATA, PACKET_PROFILING_RESET, PacketAlertFree(), PacketAlertRecycle(), PacketReleaseRefs(), Packet_::persistent, Packet_::pktvar, PktVarFree(), SCAppLayerDecoderEventsFreeEvents(), SCSpinDestroy, and Packet_::tunnel_lock.

Referenced by PacketFree().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ PacketDrop()

void PacketDrop ( Packet *  p,
const uint8_t  action,
enum PacketDropReason  r 
)

issue drop action

Set drop (+reject) flags in both current and root packet.

Parameters
actionaction bit flags. Must be limited to ACTION_DROP_REJECT|ACTION_ALERT

Definition at line 35 of file packet.c.

References Packet_::action, ACTION_ALERT, ACTION_DROP_REJECT, DEBUG_VALIDATE_BUG_ON, Packet_::drop_reason, p, PKT_DROP_REASON_INNER_PACKET, PKT_DROP_REASON_NOT_SET, and Packet_::root.

◆ PacketGetAction()

uint8_t PacketGetAction ( const Packet *  p)

Definition at line 62 of file packet.c.

References Packet_::action, likely, p, and Packet_::root.

Referenced by EveAddVerdict().

Here is the caller graph for this function:

◆ PacketInit()

bool PacketInit ( Packet *  p)

Initialize a packet structure for use.

Definition at line 74 of file packet.c.

References PacketAlerts_::alerts, Packet_::alerts, Packet_::livedev_dst_id, Packet_::livedev_id, p, PacketAlertCreate(), Packet_::persistent, SCSpinInit, Packet_::tunnel_lock, and unlikely.

Referenced by PacketGetFromAlloc().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ PacketRecycle()

void PacketRecycle ( Packet *  p)

Definition at line 170 of file packet.c.

References p, PacketReinit(), and PacketReleaseRefs().

Here is the call graph for this function:

◆ PacketReinit()

◆ PacketReleaseRefs()

void PacketReleaseRefs ( Packet *  p)

Definition at line 86 of file packet.c.

Referenced by PacketDestructor(), and PacketRecycle().

Here is the caller graph for this function:

◆ SCPacketGetFlow()

Flow* SCPacketGetFlow ( const Packet *  p)

Get the flow associated with the packet.

Definition at line 300 of file packet.c.

References Packet_::flow, and p.

◆ SCPacketGetIPProto()

uint8_t SCPacketGetIPProto ( const Packet *  p)

Get IP proto regardless of IP version.

Exported wrapper around the PacketGetIPProto inline for plugins and Rust.

Definition at line 223 of file packet.c.

◆ SCPacketGetL3()

const uint8_t* SCPacketGetL3 ( const Packet *  p,
uint32_t *  len 
)

Get the L3 packet data, starting at the L3 header.

The returned data is borrowed from p and is valid only while its packet buffer remains valid and unchanged. For IPv4 and IPv6 the length comes from the IP header and includes the IPv6 base header. For ARP it is the fixed ARP header length. Trailing padding is excluded. The decoder has already validated the length against the captured packet length.

Parameters
pPacket to inspect, or NULL.
lenNon-NULL output pointer, set to zero when no data is returned.
Return values
NULLThe packet is NULL or has no decoded L3 layer.

Definition at line 271 of file packet.c.

References Packet_::l3, len, p, PACKET_L3_IPV4, and PacketL3::type.

◆ SCPacketGetL3Type()

enum PacketL3Types SCPacketGetL3Type ( const Packet *  p)

Get the type of the packet's L3 layer.

Return values
PACKET_L3_UNKNOWNThe packet is NULL or has no decoded L3 layer.

Definition at line 243 of file packet.c.

◆ SCPacketGetTimeAsParts()

void SCPacketGetTimeAsParts ( const Packet *  p,
uint64_t *  secs,
uint64_t *  usecs 
)

Get packet timestamp as individual values.

Definition at line 308 of file packet.c.

References p, SCTIME_SECS, SCTIME_USECS, and Packet_::ts.

◆ SCPacketIsToClient()

bool SCPacketIsToClient ( const Packet *  p)

Test whether the packet is marked as flowing to the client.

Requires a valid packet. Returns false when the direction flag is not set.

Definition at line 243 of file packet.c.

References p, and PKT_IS_TOCLIENT.

◆ SCPacketIsToServer()

bool SCPacketIsToServer ( const Packet *  p)

Test whether the packet is marked as flowing to the server.

Requires a valid packet. Returns false when the direction flag is not set.

Definition at line 233 of file packet.c.

References p, and PKT_IS_TOSERVER.

◆ SCPacketSetDatalink()

void SCPacketSetDatalink ( Packet *  p,
int  datalink 
)
inline

Set a packets data link type.

Definition at line 203 of file packet.c.

References Packet_::datalink, and p.

◆ SCPacketSetLiveDevice()

void SCPacketSetLiveDevice ( Packet *  p,
LiveDevice *  device 
)
inline

Set a packets live device.

Definition at line 198 of file packet.c.

References Packet_::livedev_id, LiveDeviceGetId(), and p.

Here is the call graph for this function:

◆ SCPacketSetReleasePacket()

void SCPacketSetReleasePacket ( Packet *  p,
void(*)(Packet *p)  ReleasePacket 
)
inline

Set a packet release function.

Set a custom release function for packet. This is required if extra non-standard packet was done that needs to be cleaned up when Suricata is done with a packet.

Its also where IPS actions may be done.

Definition at line 193 of file packet.c.

◆ SCPacketSetSource()

void SCPacketSetSource ( Packet *  p,
enum PktSrcEnum  source 
)
inline

Set packet source.

Definition at line 213 of file packet.c.

References p, and Packet_::pkt_src.

◆ SCPacketSetTime()

void SCPacketSetTime ( Packet *  p,
SCTime_t  ts 
)
inline

Set the timestamp for a packet.

Parameters
tsA timestamp in SCTime_t format. See SCTIME_FROM_TIMEVAL for conversion from struct timeval.

Definition at line 208 of file packet.c.

References p, ts, and Packet_::ts.

addr_data32
#define addr_data32
Definition: decode.h:140