wtap_opttypes.h

Go to the documentation of this file.

 
#ifndef WTAP_OPT_TYPES_H
#define WTAP_OPT_TYPES_H
 
#include "ws_symbol_export.h"
 
#include <wsutil/inet_addr.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/*
 * We use the pcapng option codes for option type values.
 */
 
/* Options for all blocks */
#define OPT_EOFOPT             0     
#define OPT_COMMENT            1     
#define OPT_CUSTOM_STR_COPY    2988  
#define OPT_CUSTOM_BIN_COPY    2989  
#define OPT_CUSTOM_STR_NO_COPY 19372 
#define OPT_CUSTOM_BIN_NO_COPY 19373 
 
/* Section Header block (SHB) */
#define OPT_SHB_HARDWARE       2     
#define OPT_SHB_OS             3     
#define OPT_SHB_USERAPPL       4     
 
/* Interface Description block (IDB) */
#define OPT_IDB_NAME           2     
#define OPT_IDB_DESCRIPTION    3     
#define OPT_IDB_IP4ADDR        4     
#define OPT_IDB_IP6ADDR        5     
#define OPT_IDB_MACADDR        6     
#define OPT_IDB_EUIADDR        7     
#define OPT_IDB_SPEED          8     
#define OPT_IDB_TSRESOL        9     
#define OPT_IDB_TZONE          10    
#define OPT_IDB_FILTER         11    
#define OPT_IDB_OS             12    
#define OPT_IDB_FCSLEN         13    
#define OPT_IDB_TSOFFSET       14    
#define OPT_IDB_HARDWARE       15    
#define OPT_IDB_TXSPEED        16    
#define OPT_IDB_RXSPEED        17    
#define OPT_IDB_IANA_TZNAME    18    
 
/*
 * These are the options for an EPB, but we use them for all WTAP_BLOCK_PACKET
 */
#define OPT_PKT_FLAGS        2
#define OPT_PKT_HASH         3
#define OPT_PKT_DROPCOUNT    4
#define OPT_PKT_PACKETID     5
#define OPT_PKT_QUEUE        6
#define OPT_PKT_VERDICT      7
#define OPT_PKT_PROCIDTHRDID 8    
 
/* Name Resolution Block (NRB) */
#define OPT_NS_DNSNAME       2
#define OPT_NS_DNSIP4ADDR    3
#define OPT_NS_DNSIP6ADDR    4
 
/* Interface Statistics Block (ISB) */
#define OPT_ISB_STARTTIME    2
#define OPT_ISB_ENDTIME      3
#define OPT_ISB_IFRECV       4
#define OPT_ISB_IFDROP       5
#define OPT_ISB_FILTERACCEPT 6
#define OPT_ISB_OSDROP       7
#define OPT_ISB_USRDELIV     8
 
/* Process Information Block (PIB) */
#define OPT_PIB_NAME         2   
#define OPT_PIB_PATH         3   
#define OPT_PIB_CMDLINE      4   
#define OPT_PIB_PPID         5   
#define OPT_PIB_UID          6   
#define OPT_PIB_USER         7   
#define OPT_PIB_UUID         8   
#define OPT_PIB_STARTTIME    9   
 
/* Darwin-specific options for EPB */
#define OPT_PKT_DARWIN_PIB_ID               32769   
#define OPT_PKT_DARWIN_SVC_CODE             32770   
#define OPT_PKT_DARWIN_EFFECTIVE_PIB_ID     32771   
#define OPT_PKT_DARWIN_MD_FLAGS             32772   
#define OPT_PKT_DARWIN_FLOW_ID              32773   
#define OPT_PKT_DARWIN_TRACE_TAG            32774   
#define OPT_PKT_DARWIN_DROP_REASON          32775   
#define OPT_PKT_DARWIN_DROP_LINE            32776   
#define OPT_PKT_DARWIN_DROP_FUNC            32777   
#define OPT_PKT_DARWIN_COMP_GENCNT          32778   
 

typedef enum {
    WTAP_BLOCK_SECTION             = 0, 
    WTAP_BLOCK_IF_ID_AND_INFO,          
    WTAP_BLOCK_NAME_RESOLUTION,         
    WTAP_BLOCK_IF_STATISTICS,           
    WTAP_BLOCK_DECRYPTION_SECRETS,      
    WTAP_BLOCK_PACKET,                  
    WTAP_BLOCK_FT_SPECIFIC_REPORT,      
    WTAP_BLOCK_FT_SPECIFIC_EVENT,       
    WTAP_BLOCK_SYSDIG_EVENT,            
    WTAP_BLOCK_META_EVENT,              
    WTAP_BLOCK_SYSTEMD_JOURNAL_EXPORT,  
    WTAP_BLOCK_CUSTOM,                  
    WTAP_BLOCK_FT_SPECIFIC_INFORMATION, 
    WTAP_BLOCK_PROCESS_INFORMATION,     
    MAX_WTAP_BLOCK_TYPE_VALUE           
} wtap_block_type_t;
 
struct wtap_block;
typedef struct wtap_block* wtap_block_t;
 
typedef void (*wtap_block_create_func)(wtap_block_t block);
typedef void (*wtap_mand_free_func)(wtap_block_t block);
typedef void (*wtap_mand_copy_func)(wtap_block_t dest_block, wtap_block_t src_block);

typedef struct wtap_blocktype_t {
    wtap_block_type_t  block_type;  
    const char        *name;        
    const char        *description; 
    wtap_block_create_func create;  
    wtap_mand_free_func    free_mand; 
    wtap_mand_copy_func    copy_mand; 
    GHashTable            *options;   
} wtap_blocktype_t;

struct wtap_block {
    struct wtap_blocktype_t *info;           
    void                    *mandatory_data; 
    GArray                  *options;        
    int                      ref_count;      
#ifdef DEBUG_COUNT_REFS
    unsigned                 id;             
#endif
};

typedef struct wtapng_section_mandatory_s {
    uint64_t            section_length; 
} wtapng_section_mandatory_t;

typedef struct wtapng_iface_descriptions_s {
    GArray *interface_data;
} wtapng_iface_descriptions_t;

typedef struct wtapng_if_descr_mandatory_s {
    int                    wtap_encap;            
    uint64_t               time_units_per_second;
    int                    tsprecision;           
 
    uint32_t               snap_len;
 
    uint8_t                num_stat_entries;
    GArray                *interface_statistics;  
} wtapng_if_descr_mandatory_t;

typedef struct wtapng_nrb_mandatory_s {
    GList       *ipv4_addr_list;
    GList       *ipv6_addr_list;
}  wtapng_nrb_mandatory_t;

typedef struct wtapng_if_stats_mandatory_s {
    uint32_t interface_id;
    uint32_t ts_high;
    uint32_t ts_low;
} wtapng_if_stats_mandatory_t;

typedef struct wtapng_dsb_mandatory_s {
    uint32_t               secrets_type;            
    uint32_t               secrets_len;             
    uint8_t               *secrets_data;            
} wtapng_dsb_mandatory_t;

typedef struct wtapng_meta_event_mandatory_s {
    uint32_t               mev_block_type;      
    unsigned               mev_data_len;        
    uint8_t               *mev_data;            
} wtapng_meta_event_mandatory_t;

#if 0
/* Commented out for now, there's no mandatory data that isn't handled by
 * Wireshark in other ways.
 */
typedef struct wtapng_packet_mandatory_s {
    uint32_t interface_id;
    uint32_t ts_high;
    uint32_t ts_low;
    uint32_t captured_len;
    uint32_t orig_len;
} wtapng_packet_mandatory_t;
#endif

typedef struct wtapng_process_info_mandatory_s {
    uint32_t               process_id;      
    uint32_t               block_type;      
} wtapng_process_info_mandatory_t;

typedef struct wtapng_ft_specific_mandatory_s {
    unsigned  record_type;      /* the type of record this is - file type-specific value */
} wtapng_ft_specific_mandatory_t;

typedef enum {
    WTAP_OPTTYPE_UINT8,          
    WTAP_OPTTYPE_UINT32,         
    WTAP_OPTTYPE_UINT64,         
    WTAP_OPTTYPE_STRING,         
    WTAP_OPTTYPE_BYTES,          
    WTAP_OPTTYPE_IPv4,           
    WTAP_OPTTYPE_IPv6,           
    WTAP_OPTTYPE_CUSTOM_STRING,  
    WTAP_OPTTYPE_CUSTOM_BINARY,  
    WTAP_OPTTYPE_IF_FILTER,      
    WTAP_OPTTYPE_PACKET_VERDICT, 
    WTAP_OPTTYPE_PACKET_HASH,    
    WTAP_OPTTYPE_INT8,           
    WTAP_OPTTYPE_INT32,          
    WTAP_OPTTYPE_INT64,          
} wtap_opttype_e;

typedef enum {
    WTAP_OPTTYPE_SUCCESS         =  0, 
    WTAP_OPTTYPE_NO_SUCH_OPTION  = -1, 
    WTAP_OPTTYPE_NOT_FOUND       = -2, 
    WTAP_OPTTYPE_TYPE_MISMATCH   = -3, 
    WTAP_OPTTYPE_NUMBER_MISMATCH = -4, 
    WTAP_OPTTYPE_ALREADY_EXISTS  = -5, 
    WTAP_OPTTYPE_BAD_BLOCK       = -6, 
    WTAP_OPTTYPE_PEN_MISMATCH    = -7, 
} wtap_opttype_return_val;
 
/* https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers */
#define PEN_VCTR 46254

typedef struct custom_string_opt_s {
    uint32_t pen;    
    char    *string; 
} custom_string_opt_t;
 

typedef struct binary_optdata {
    size_t custom_data_len; 
    void  *custom_data;     
} binary_optdata_t;

typedef struct custom_binary_opt_s {
    uint32_t         pen;  
    binary_optdata_t data; 
} custom_binary_opt_t;
 
/* Interface description data - if_filter option structure */

typedef struct wtap_bpf_insn_s {
    uint16_t code;  
    uint8_t  jt;    
    uint8_t  jf;    
    uint32_t k;     
} wtap_bpf_insn_t;
 

typedef enum {
    if_filter_pcap = 0, /* pcap filter string */
    if_filter_bpf  = 1  /* BPF program */
} if_filter_type_e;

typedef struct if_filter_opt_s {
    if_filter_type_e type; 

    union {
        char *filter_str; 

        struct wtap_bpf_insns {
            unsigned         bpf_prog_len; 
            wtap_bpf_insn_t *bpf_prog;     
        } bpf_prog; 
    } data;
} if_filter_opt_t;
 
/* Packet - packet_verdict option structure */

typedef enum {
    packet_verdict_hardware       = 0, 
    packet_verdict_linux_ebpf_tc  = 1, 
    packet_verdict_linux_ebpf_xdp = 2  
} packet_verdict_type_e;
 

typedef struct packet_verdict_opt_s {
    packet_verdict_type_e type; 
    union {
        GByteArray *verdict_bytes;        
        uint64_t    verdict_linux_ebpf_tc; 
        uint64_t    verdict_linux_ebpf_xdp; 
    }               data;       
} packet_verdict_opt_t;
 

typedef struct packet_hash_opt_s {
    uint8_t     type;        
    GByteArray *hash_bytes;  
} packet_hash_opt_t;
 

typedef union {
    uint8_t              uint8val;           
    uint32_t             uint32val;          
    uint64_t             uint64val;          
    int8_t               int8val;            
    int32_t              int32val;           
    int64_t              int64val;           
    ws_in4_addr          ipv4val;            
    ws_in6_addr          ipv6val;            
    char                *stringval;          
    GBytes              *byteval;            
    custom_string_opt_t  custom_stringval;   
    custom_binary_opt_t  custom_binaryval;   
    if_filter_opt_t      if_filterval;       
    packet_verdict_opt_t packet_verdictval;  
    packet_hash_opt_t    packet_hash;        
} wtap_optval_t;

typedef struct {
    unsigned      option_id; 
    wtap_optval_t value;     
} wtap_option_t;

typedef void (*wtap_block_create_func)(wtap_block_t block);

typedef void (*wtap_mand_free_func)(wtap_block_t block);

typedef void (*wtap_mand_copy_func)(wtap_block_t dest_block, wtap_block_t src_block);

typedef struct {
    const char    *name;        
    const char    *description; 
    wtap_opttype_e data_type;   
    unsigned       flags;       
} wtap_opttype_t;
 
#define GET_OPTION_TYPE(options, option_id) \
    (const wtap_opttype_t *)g_hash_table_lookup((options), GUINT_TO_POINTER(option_id))

WS_DLL_PUBLIC void
wtap_opttypes_initialize(void);

WS_DLL_PUBLIC wtap_block_t
wtap_block_create(wtap_block_type_t block_type);

WS_DLL_PUBLIC wtap_block_t
wtap_block_ref(wtap_block_t block);

WS_DLL_PUBLIC void
wtap_block_unref(wtap_block_t block);

WS_DLL_PUBLIC void
wtap_block_array_free(GArray* block_array);

WS_DLL_PUBLIC void
wtap_block_array_unref(GArray* block_array);

WS_DLL_PUBLIC void
wtap_block_array_ref(GArray* block_array);

WS_DLL_PUBLIC void
wtap_opttype_block_register(wtap_blocktype_t* blocktype);

WS_DLL_PUBLIC wtap_block_type_t
wtap_block_get_type(wtap_block_t block);

WS_DLL_PUBLIC void*
wtap_block_get_mandatory_data(wtap_block_t block);

WS_DLL_PUBLIC unsigned
wtap_block_count_option(wtap_block_t block, unsigned option_id);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_uint8_option(wtap_block_t block, unsigned option_id, uint8_t value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_uint8_option_value(wtap_block_t block, unsigned option_id, uint8_t value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_uint8_option_value(wtap_block_t block, unsigned option_id, uint8_t* value) G_GNUC_WARN_UNUSED_RESULT;

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_uint32_option(wtap_block_t block, unsigned option_id, uint32_t value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_uint32_option_value(wtap_block_t block, unsigned option_id, uint32_t value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_uint32_option_value(wtap_block_t block, unsigned option_id, uint32_t* value) G_GNUC_WARN_UNUSED_RESULT;

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_uint64_option(wtap_block_t block, unsigned option_id, uint64_t value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_uint64_option_value(wtap_block_t block, unsigned option_id, uint64_t value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_uint64_option_value(wtap_block_t block, unsigned option_id, uint64_t* value) G_GNUC_WARN_UNUSED_RESULT;

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_nth_uint64_option_value(wtap_block_t block, unsigned option_id, unsigned idx, uint64_t *value) G_GNUC_WARN_UNUSED_RESULT;

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_int8_option(wtap_block_t block, unsigned option_id, int8_t value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_int8_option_value(wtap_block_t block, unsigned option_id, int8_t value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_int8_option_value(wtap_block_t block, unsigned option_id, int8_t* value) G_GNUC_WARN_UNUSED_RESULT;

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_int32_option(wtap_block_t block, unsigned option_id, int32_t value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_int32_option_value(wtap_block_t block, unsigned option_id, int32_t value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_int32_option_value(wtap_block_t block, unsigned option_id, int32_t* value) G_GNUC_WARN_UNUSED_RESULT;

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_int64_option(wtap_block_t block, unsigned option_id, int64_t value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_int64_option_value(wtap_block_t block, unsigned option_id, int64_t value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_int64_option_value(wtap_block_t block, unsigned option_id, int64_t* value) G_GNUC_WARN_UNUSED_RESULT;

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_ipv4_option(wtap_block_t block, unsigned option_id, uint32_t value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_ipv4_option_value(wtap_block_t block, unsigned option_id, uint32_t value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_ipv4_option_value(wtap_block_t block, unsigned option_id, uint32_t* value) G_GNUC_WARN_UNUSED_RESULT;

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_ipv6_option(wtap_block_t block, unsigned option_id, ws_in6_addr *value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_ipv6_option_value(wtap_block_t block, unsigned option_id, ws_in6_addr *value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_ipv6_option_value(wtap_block_t block, unsigned option_id, ws_in6_addr* value) G_GNUC_WARN_UNUSED_RESULT;

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_string_option(wtap_block_t block, unsigned option_id, const char *value, size_t value_length);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_string_option_owned(wtap_block_t block, unsigned option_id, char *value) G_GNUC_WARN_UNUSED_RESULT;

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_string_option_format(wtap_block_t block, unsigned option_id, const char *format, ...)
                                    G_GNUC_PRINTF(3,4);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_string_option_value(wtap_block_t block, unsigned option_id, const char* value, size_t value_length);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_nth_string_option_value(wtap_block_t block, unsigned option_id, unsigned idx, const char* value, size_t value_length);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_string_option_value_format(wtap_block_t block, unsigned option_id, const char *format, ...)
                                          G_GNUC_PRINTF(3,4);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_nth_string_option_value_format(wtap_block_t block, unsigned option_id, unsigned idx, const char *format, ...)
                                              G_GNUC_PRINTF(4,5);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_string_option_value(wtap_block_t block, unsigned option_id, char** value) G_GNUC_WARN_UNUSED_RESULT;

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_nth_string_option_value(wtap_block_t block, unsigned option_id, unsigned idx, char** value) G_GNUC_WARN_UNUSED_RESULT;

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_bytes_option(wtap_block_t block, unsigned option_id, const uint8_t *value, size_t value_length);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_bytes_option_borrow(wtap_block_t block, unsigned option_id, GBytes *value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_bytes_option_value(wtap_block_t block, unsigned option_id, const uint8_t* value, size_t value_length);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_nth_bytes_option_value(wtap_block_t block, unsigned option_id, unsigned idx, GBytes* value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_bytes_option_value(wtap_block_t block, unsigned option_id, GBytes** value) G_GNUC_WARN_UNUSED_RESULT;

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_nth_bytes_option_value(wtap_block_t block, unsigned option_id, unsigned idx, GBytes** value) G_GNUC_WARN_UNUSED_RESULT;

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_custom_string_option(wtap_block_t block, unsigned option_id, uint32_t pen, const char *value, size_t value_length);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_custom_binary_option(wtap_block_t block, unsigned option_id, uint32_t pen, binary_optdata_t *value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_custom_binary_option_from_data(wtap_block_t block, unsigned option_id, uint32_t pen, const void *data, size_t data_size);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_nth_custom_binary_option_value(wtap_block_t block, unsigned option_id, uint32_t pen, unsigned idx, binary_optdata_t *value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_if_filter_option(wtap_block_t block, unsigned option_id, if_filter_opt_t* value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_if_filter_option_value(wtap_block_t block, unsigned option_id, if_filter_opt_t* value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_if_filter_option_value(wtap_block_t block, unsigned option_id, if_filter_opt_t* value) G_GNUC_WARN_UNUSED_RESULT;

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_packet_verdict_option(wtap_block_t block, unsigned option_id, packet_verdict_opt_t* value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_nth_packet_verdict_option_value(wtap_block_t block, unsigned option_id, unsigned idx, packet_verdict_opt_t* value);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_nth_packet_verdict_option_value(wtap_block_t block, unsigned option_id, unsigned idx, packet_verdict_opt_t* value) G_GNUC_WARN_UNUSED_RESULT;

WS_DLL_PUBLIC void
wtap_packet_verdict_free(packet_verdict_opt_t* verdict);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_packet_hash_option(wtap_block_t block, unsigned option_id, packet_hash_opt_t* value);

WS_DLL_PUBLIC void
wtap_packet_hash_free(packet_hash_opt_t* hash);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_remove_option(wtap_block_t block, unsigned option_id);

WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_remove_nth_option_instance(wtap_block_t block, unsigned option_id, unsigned idx);

WS_DLL_PUBLIC void
wtap_block_copy(wtap_block_t dest_block, wtap_block_t src_block);

WS_DLL_PUBLIC wtap_block_t
wtap_block_make_copy(wtap_block_t block);

typedef bool (*wtap_block_foreach_func)(wtap_block_t block, unsigned option_id,
                                        wtap_opttype_e option_type, wtap_optval_t *option,
                                        void *user_data);

WS_DLL_PUBLIC bool
wtap_block_foreach_option(wtap_block_t block, wtap_block_foreach_func func, void* user_data);

WS_DLL_PUBLIC void
wtap_opttypes_cleanup(void);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* WTAP_OPT_TYPES_H */