stream.h

Go to the documentation of this file.

#ifndef __STREAM_H__
#define __STREAM_H__

#include "snort_packet_header.h"
#include "ubi_SplayTree.h"

/* Toggle's whether to use the HASH_TABLE for
 * session cache -- versus a SplayTree.
 */
#define USE_HASH_TABLE
//#define USE_SPLAY_TREE

/* Only track a certain number of alerts per session */
#define MAX_SESSION_ALERTS  8

/* Session flags for stream4 data */
#define SSNFLAG_SEEN_CLIENT         0x00000001
#define SSNFLAG_SEEN_SERVER         0x00000002
#define SSNFLAG_ESTABLISHED         0x00000004
#define SSNFLAG_NMAP                0x00000008
#define SSNFLAG_ECN_CLIENT_QUERY    0x00000010
#define SSNFLAG_ECN_SERVER_REPLY    0x00000020
#define SSNFLAG_HTTP_1_1            0x00000040 /* has this stream seen HTTP 1.1? */
#define SSNFLAG_SEEN_PMATCH         0x00000080 /* has this stream seen
                                                  pattern match? */
#define SSNFLAG_MIDSTREAM           0x00000100 /* picked up midstream */
#define SSNFLAG_CLIENT_FIN          0x00000200 /* server sent fin */
#define SSNFLAG_SERVER_FIN          0x00000400 /* client sent fin */

#define SSNFLAG_ALL                 0xFFFFFFFF /* all that and a bag of chips */

#define SSNPREPROC_HTTP             0x01
#define SSNPREPROC_TELNET           0x02
#define SSNPREPROC_FTP              0x03
#define SSNPREPROC_SMTP             0x04

typedef struct _Stream
{
    u_int32_t ip;          /* IP addr */
    u_int16_t port;        /* port number */
    u_int8_t  state;       /* stream state */
    u_int32_t isn;         /* initial sequence number */
    u_int32_t base_seq;    /* base seq num for this packet set */
    u_int32_t last_ack;    /* last segment ack'd */
    u_int16_t win_size;    /* window size */
    u_int32_t next_seq;    /* next sequence we expect to see -- used on reassemble */
    u_int32_t pkts_sent;   /* track the number of packets in this stream */
    u_int32_t bytes_sent;  /* track the number of bytes in this stream */
    u_int32_t bytes_tracked; /* track the total number of bytes on this side */
    u_int8_t  state_queue;    /* queued state transition */
    u_int8_t  expected_flags; /* tcp flag needed to accept transition */
    u_int32_t trans_seq;      /* sequence number of transition packet */
    u_int8_t  stq_chk_seq;    /* flag to see if we need to check the seq 
                                 num of the state transition packet */
    u_int32_t overlap_pkts;  /* track the number of packets with duplicate seq #s */
    u_int32_t bytes_inspected; /* track the number of bytes seen since last
                                * data from other side */

    ubi_trRoot data;

    u_int32_t last_trunc_time; /* last time this session was truncated. (stream4inline) */
} Stream;

#ifdef USE_HASH_TABLE
typedef struct _SessionHashKey
{
            u_int32_t lowIP;
            u_int32_t highIP;
            u_int16_t port; /* If IPs are the same, this will be the lower of
                             * the two ports.  Otherwise, it will be the port
                             * corresponding to lowIP. */
#if defined(_LP64)
            u_int16_t pad1;
#endif
            u_int16_t port2;
#if defined(_LP64)
            u_int16_t pad2;
#endif
} SessionHashKey;
#else /* USE_SPLAY_TREE */
#endif

typedef struct _Session
{
#ifdef USE_HASH_TABLE
#else /* USE_SPLAY_TREE */
    ubi_trNode Node;   /* Record keeper for the ubx stuff */
#endif
    Stream server;
    Stream client;
    
    time_t start_time;   /* unix second the session started */
    time_t last_session_time; /* last time this session got a packet */
    
    u_int32_t session_flags; /* special little flags we keep */
    u_int32_t http_alert_flags;

    u_int32_t  flush_point;
    u_int8_t  ttl; /* track the ttl of this current session ( only done on client side ) */
    
    u_int32_t alert_gid[MAX_SESSION_ALERTS]; /* flag alerts seen in a session  */
    u_int32_t alert_sid[MAX_SESSION_ALERTS]; /* flag alerts seen in a session  */
    u_int8_t  alert_count;                   /* count alerts seen in a session */

    u_int8_t preproc_proto;
    void *preproc_data;    /* preprocessor layer data structure */
    void (*preproc_free)(void *); /* function to free preproc_data */
#ifdef USE_HASH_TABLE
    SessionHashKey hashKey;
#else /* USE_SPLAY_TREE */
#endif

    /* tag this session to know it is already dumped */
    u_int8_t dumptag;

} Session;

/* used for the StreamPacketData chuck field */
#define SEG_UNASSEMBLED 0x00
#define SEG_FULL        0x01
#define SEG_PARTIAL     0x02

typedef struct _StreamPacketData
{
    ubi_trNode Node;
    u_int8_t *pktOrig;
    u_int8_t *pkt;
    u_int8_t *payload;
    SnortPktHeader pkth;
    u_int32_t seq_num;
    u_int16_t payload_size;
    u_int16_t pkt_size;
    u_int32_t cksum;
    u_int8_t  chuck;   /* mark the spd for chucking if it's 
                        * been reassembled 
                        */
} StreamPacketData;

typedef struct _Stream4Data
{
    char stream4_active;

    char stateful_inspection_flag;
    u_int32_t timeout;
    char state_alerts;
    char evasion_alerts;
    u_int32_t memcap;
    u_int32_t max_sessions;
    double cache_clean_percent;
    u_int16_t cache_clean_sessions;

    char log_flushed_streams;

    char ps_alerts;

    char track_stats_flag;
    char *stats_file;
    
    u_int32_t last_prune_time;

    char reassemble_client;
    char reassemble_server;
    char reassembly_alerts;
    char state_protection;
    char zero_flushed_packets;
    char flush_on_alert;
    u_int32_t overlap_limit;
    
    u_int8_t assemble_ports[65536];
    u_int8_t emergency_ports[65536];  /* alternate port set for self-preservation mode */

    u_int32_t sp_threshold;
    u_int32_t sp_period;

    u_int32_t suspend_threshold;
    u_int32_t suspend_period;
    
    
    u_int8_t  stop_traverse;
    u_int32_t stop_seq;
    
    u_int8_t  min_ttl;   /* min TTL we'll accept to insert a packet */
    u_int8_t  ttl_limit; /* the largest difference we'll accept in the
                            course of a TTL conversation */
    u_int16_t path_mtu;  /* max segment size we'll accept */
    u_int8_t  reassy_method;
    u_int32_t ps_memcap;
    int flush_data_diff_size;
    

    char asynchronous_link; /* used when you can only see part of the conversation
                               it can't be anywhere NEAR as robust */
    char enforce_state;
    char ms_inline_alerts;

    u_int32_t server_inspect_limit;

    // Random flush points
    u_int32_t flush_base;
    u_int32_t flush_range;
    int32_t  flush_behavior;
    u_int32_t flush_seed;

#ifdef GIDS
    /* stream4inline extra vars */
    char        stream4inline_mode;

    /* sliding window size */
    u_int32_t   stream4inline_window_size;

    char        truncate;               /* truncate (1) or prune (0) when SafeMalloc needs mem */ 
    char        truncate_cut_off_perc;  /* cut of this part off of the stream when truncating */ 

    char        drop_out_of_window;
    char        drop_data_on_unest;
    char        drop_no_tcp_on_est;
    char        drop_not_in_limits;
    char        drop_ttl_evasion;

    char        store_state_to_disk;
    char        state_file[255];
#endif /* GIDS */

} Stream4Data;

#endif  // __STREAM_H__

---