epan.h

Go to the documentation of this file.

#pragma once
#include <wsutil/feature_list.h>
#include <epan/tvbuff.h>
#include <epan/prefs.h>
#include <epan/frame_data.h>
#include <epan/register.h>
#include <wiretap/wtap_opttypes.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

extern bool wireshark_abort_on_dissector_bug;

extern bool wireshark_abort_on_too_many_items;

WS_DLL_PUBLIC void ws_dissector_bug(const char *format, ...)
    G_GNUC_PRINTF(1,2);

#define ws_dissector_oops(_fmt, ...) ws_dissector_bug("OOPS: " _fmt, __VA_ARGS__)

typedef struct epan_dissect epan_dissect_t;
 
struct epan_dfilter;
struct epan_column_info;

struct packet_provider_data;

struct packet_provider_funcs {
    const nstime_t *(*get_frame_ts)(struct packet_provider_data *prov, uint32_t frame_num);

    const nstime_t *(*get_start_ts)(struct packet_provider_data *prov);

    const nstime_t *(*get_end_ts)(struct packet_provider_data *prov);

    const char *(*get_interface_name)(struct packet_provider_data *prov, uint32_t interface_id, unsigned section_number);

    const char *(*get_interface_description)(struct packet_provider_data *prov, uint32_t interface_id, unsigned section_number);

    wtap_block_t (*get_modified_block)(struct packet_provider_data *prov, const frame_data *fd);

    int32_t (*get_process_id)(struct packet_provider_data *prov, uint32_t process_info_id, unsigned section_number);

    const char *(*get_process_name)(struct packet_provider_data *prov, uint32_t process_info_id, unsigned section_number);

    const uint8_t *(*get_process_uuid)(struct packet_provider_data *prov, uint32_t process_info_id, unsigned section_number, size_t *uuid_size);

    const char *(*get_process_path)(struct packet_provider_data *prov, uint32_t process_info_id, unsigned section_number);

    const uint8_t *(*get_process_cmdline)(struct packet_provider_data *prov, uint32_t process_info_id, unsigned section_number, size_t *cmdline_size);

    bool (*get_process_parent_id)(struct packet_provider_data *prov, uint32_t process_info_id, unsigned section_number, uint32_t *parent_process_id);

    bool (*get_process_user_id)(struct packet_provider_data *prov, uint32_t process_info_id, unsigned section_number, uint32_t *user_id);

    const char *(*get_process_user_name)(struct packet_provider_data *prov, uint32_t process_info_id, unsigned section_number);

    bool (*get_process_start_time)(struct packet_provider_data *prov, uint32_t process_info_id, unsigned section_number, nstime_t *start_time);

    bool (*find_process_info)(struct packet_provider_data *prov, uint32_t process_id, unsigned section_number, const nstime_t *ts, int64_t file_off, uint32_t *process_info_id);
};

/*
Ref 1
Epan
Enhanced Packet ANalyzer, aka the packet analyzing engine. Source code can be found in the epan directory.
 
Protocol-Tree - Keep data of the capture file protocol information.
 
Dissectors - The various protocol dissectors in epan/dissectors.
 
Plugins - Some of the protocol dissectors are implemented as plugins. Source code can be found at plugins.
 
Display-Filters - the display filter engine at epan/dfilter
 
*/

typedef struct {
    const char* env_var_prefix;     
    const char** col_fmt;           
    int num_cols;               
    register_entity_func register_func; 
    register_entity_func handoff_func;  
    struct _tap_reg const* tap_reg_listeners;   
} epan_app_data_t;

WS_DLL_PUBLIC
bool epan_init(register_cb cb, void *client_data, bool load_plugins, epan_app_data_t* app_data);

WS_DLL_PUBLIC
e_prefs *epan_load_settings(void);

WS_DLL_PUBLIC
void epan_cleanup(void);
 

typedef struct {
    void (*init)(void);

    void (*post_init)(void);

    void (*dissect_init)(epan_dissect_t *);

    void (*dissect_cleanup)(epan_dissect_t *);

    void (*cleanup)(void);

    void (*register_all_protocols)(register_cb cb, void *user_data);

    void (*register_all_handoffs)(register_cb cb, void *user_data);

    void (*register_all_tap_listeners)(void);
} epan_plugin;

WS_DLL_PUBLIC void epan_register_plugin(const epan_plugin *plugin);

WS_DLL_PUBLIC int epan_plugins_supported(void);

void epan_conversation_init(void);
 
 
typedef struct epan_session epan_t;
typedef struct epan_session epan_t;

WS_DLL_PUBLIC epan_t *epan_new(struct packet_provider_data *prov,
    const struct packet_provider_funcs *funcs);

WS_DLL_PUBLIC wtap_block_t epan_get_modified_block(const epan_t *session, const frame_data *fd);

WS_DLL_PUBLIC const char *epan_get_interface_name(const epan_t *session, uint32_t interface_id, unsigned section_number);

WS_DLL_PUBLIC const char *epan_get_interface_description(const epan_t *session, uint32_t interface_id, unsigned section_number);

WS_DLL_PUBLIC int32_t epan_get_process_id(const epan_t *session, uint32_t process_info_id, unsigned section_number);

WS_DLL_PUBLIC const char *epan_get_process_name(const epan_t *session, uint32_t process_info_id, unsigned section_number);

WS_DLL_PUBLIC const uint8_t *epan_get_process_uuid(const epan_t *session, uint32_t process_info_id, unsigned section_number, size_t *uuid_size);

WS_DLL_PUBLIC const char *epan_get_process_path(const epan_t *session, uint32_t process_info_id, unsigned section_number);

WS_DLL_PUBLIC const uint8_t *epan_get_process_cmdline(const epan_t *session, uint32_t process_info_id, unsigned section_number, size_t *cmdline_size);

WS_DLL_PUBLIC bool epan_get_process_parent_id(const epan_t *session, uint32_t process_info_id, unsigned section_number, uint32_t *parent_process_id);

WS_DLL_PUBLIC bool epan_get_process_user_id(const epan_t *session, uint32_t process_info_id, unsigned section_number, uint32_t *user_id);

WS_DLL_PUBLIC const char *epan_get_process_user_name(const epan_t *session, uint32_t process_info_id, unsigned section_number);

WS_DLL_PUBLIC bool epan_get_process_start_time(const epan_t *session, uint32_t process_info_id, unsigned section_number, nstime_t *start_time);

WS_DLL_PUBLIC bool epan_find_process_info(const epan_t *session, uint32_t process_id, unsigned section_number, const nstime_t *ts, int64_t file_off, uint32_t *process_info_id);

const nstime_t *epan_get_frame_ts(const epan_t *session, uint32_t frame_num);

const nstime_t *epan_get_start_ts(const epan_t *session);

WS_DLL_PUBLIC void epan_free(epan_t *session);

WS_DLL_PUBLIC const char* epan_get_version(void);

WS_DLL_PUBLIC void epan_get_version_number(int *major, int *minor, int *micro);

WS_DLL_PUBLIC const char* epan_get_environment_prefix(void);

WS_DLL_PUBLIC
void epan_set_always_visible(bool force);

WS_DLL_PUBLIC
void
epan_dissect_init(epan_dissect_t *edt, epan_t *session, const bool create_proto_tree, const bool proto_tree_visible);

WS_DLL_PUBLIC
epan_dissect_t*
epan_dissect_new(epan_t *session, const bool create_proto_tree, const bool proto_tree_visible);

WS_DLL_PUBLIC
void
epan_dissect_reset(epan_dissect_t *edt);

WS_DLL_PUBLIC
void
epan_dissect_fake_protocols(epan_dissect_t *edt, const bool fake_protocols);

WS_DLL_PUBLIC
void
epan_dissect_run(epan_dissect_t *edt, int file_type_subtype,
        wtap_rec *rec, frame_data *fd, struct epan_column_info *cinfo);

WS_DLL_PUBLIC
void
epan_dissect_run_with_taps(epan_dissect_t *edt, int file_type_subtype,
        wtap_rec *rec, frame_data *fd, struct epan_column_info *cinfo);

WS_DLL_PUBLIC
void
epan_dissect_file_run(epan_dissect_t *edt, wtap_rec *rec,
        frame_data *fd, struct epan_column_info *cinfo);

WS_DLL_PUBLIC
void
epan_dissect_file_run_with_taps(epan_dissect_t *edt, wtap_rec *rec,
        frame_data *fd, struct epan_column_info *cinfo);

WS_DLL_PUBLIC
void
epan_dissect_prime_with_dfilter(epan_dissect_t *edt, const struct epan_dfilter *dfcode);

WS_DLL_PUBLIC
void
epan_dissect_prime_with_dfilter_print(epan_dissect_t *edt, const struct epan_dfilter *dfcode);

WS_DLL_PUBLIC
void
epan_dissect_prime_with_hfid(epan_dissect_t *edt, int hfid);

WS_DLL_PUBLIC
void
epan_dissect_prime_with_hfid_array(epan_dissect_t *edt, GArray *hfids);

WS_DLL_PUBLIC
void
epan_dissect_fill_in_columns(epan_dissect_t *edt, const bool fill_col_exprs, const bool fill_fd_columns);

WS_DLL_PUBLIC
bool
epan_dissect_packet_contains_field(epan_dissect_t* edt,
                                   const char *field_name);

WS_DLL_PUBLIC
void
epan_dissect_cleanup(epan_dissect_t* edt);

WS_DLL_PUBLIC
void
epan_dissect_free(epan_dissect_t* edt);

const char *
epan_custom_set(epan_dissect_t *edt, GSList *ids, int occurrence, bool display_details,
                char *result, char *expr, const int size);

WS_DLL_PUBLIC
void
epan_gather_compile_info(feature_list l);

WS_DLL_PUBLIC
void
epan_gather_runtime_info(feature_list l);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */