packet-xmpp-utils.h

/* xmpp-utils.h
 *
 * Copyright 2011, Mariusz Okroj <okrojmariusz[]gmail.com>
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <[email protected]>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#ifndef XMPP_UTILS_H
#define XMPP_UTILS_H
 
#include "ws_symbol_export.h"
#include "tvbuff.h"
#include "dissectors/packet-xml.h"
#include <epan/wmem_scopes.h>
 
#define xmpp_elem_cdata(elem) \
elem->data?elem->data->value:""
 
typedef struct _xmpp_array_t
{
    void *data;
    int length;
} xmpp_array_t;
 
typedef struct _xmpp_attr_t{
    const char *value;
    const char *name;
    int offset;
    int length;
 
    bool was_read;
} xmpp_attr_t;
 
typedef struct _xmpp_data_t{
    char *value;
 
    int offset;
    int length;
} xmpp_data_t;
 
typedef struct _xmpp_element_t{
    char* name;
 
    /*abbreviation that apprears before tag name (<nos:x .../>)
     if abbrev doesn't appear then NULL*/
    char* default_ns_abbrev;
    /*pair of namespace abbrev and namespace*/
    GHashTable *namespaces;
 
    GHashTable *attrs;
    GList *elements;
    xmpp_data_t *data;
 
    int offset;
    int length;
 
    bool was_read;
} xmpp_element_t;
 
/*informations about attributes that are displayed in proto tree*/
typedef struct _xmpp_attr_info{
    const char *name;
    const int *phf;
    bool is_required;
    bool in_short_list;
 
    /*function validates this attribute
    it may impose other restrictions (e.g. validating atribut's name, ...)*/
    void (*val_func)(packet_info *pinfo, proto_item *item, const char *name, const char *value, const void *data);
    void *data;
} xmpp_attr_info;
 
typedef struct _xmpp_attr_info_ext{
    const char* ns;
    xmpp_attr_info info;
} xmpp_attr_info_ext;
 
typedef enum _xmpp_elem_info_type{
    NAME,
    ATTR,
    NAME_AND_ATTR,
    NAMES
} xmpp_elem_info_type;
 
typedef enum _xmpp_elem_info_occurrence
{
    ONE,MANY
} xmpp_elem_info_occurrence;
 
/*informations about elements that are displayed in proto tree*/
typedef struct _xmpp_elem_info{
    xmpp_elem_info_type type;
    const void *data;
    /*function that displays element in tree*/
    void (*elem_func)(proto_tree* tree, tvbuff_t* tvb, packet_info* pinfo, xmpp_element_t* element);
    xmpp_elem_info_occurrence occurrence;
} xmpp_elem_info;
 
typedef struct _xmpp_conv_info_t {
    wmem_tree_t *req_resp;
    wmem_tree_t *jingle_sessions;
    wmem_tree_t *ibb_sessions;
    wmem_tree_t *gtalk_sessions;
    uint32_t     ssl_start;
} xmpp_conv_info_t;
 
typedef struct _xmpp_reqresp_transaction_t {
    uint32_t req_frame;
    uint32_t resp_frame;
} xmpp_transaction_t;
 
extern void xmpp_iq_reqresp_track(packet_info *pinfo, xmpp_element_t *packet, xmpp_conv_info_t *xmpp_info);
 
extern void xmpp_jingle_session_track(packet_info *pinfo, xmpp_element_t *packet, xmpp_conv_info_t *xmpp_info);
 
extern void xmpp_ibb_session_track(packet_info *pinfo, xmpp_element_t *packet, xmpp_conv_info_t *xmpp_info);
 
extern void xmpp_gtalk_session_track(packet_info *pinfo, xmpp_element_t *packet, xmpp_conv_info_t *xmpp_info);
 
extern void xmpp_unknown(proto_tree *tree, tvbuff_t *tvb, packet_info *pinfo, xmpp_element_t *element);
 
extern void xmpp_cdata(proto_tree *tree, tvbuff_t *tvb, xmpp_element_t *element, int hf);
 
extern void xmpp_simple_cdata_elem(proto_tree *tree, tvbuff_t *tvb, packet_info *pinfo, xmpp_element_t *element);
 
extern xmpp_element_t* xmpp_xml_frame_to_element_t(packet_info *pinfo, xml_frame_t *xml_frame, xmpp_element_t *parent, tvbuff_t *tvb);
 
extern void xmpp_element_t_tree_free(xmpp_element_t *root);
 
extern xmpp_array_t* xmpp_ep_init_array_t(wmem_allocator_t *pool, const char** array, int len);
 
/*Allocs ephemeral memory for xmpp_attr_t struct*/
extern xmpp_attr_t* xmpp_ep_init_attr_t(wmem_allocator_t *pool, const char *value, int offset, int length);
 
extern xmpp_element_t* xmpp_steal_element_by_name(xmpp_element_t *packet, const char *name);
extern xmpp_element_t* xmpp_steal_element_by_names(xmpp_element_t *packet, const char **names, int names_len);
extern xmpp_element_t* xmpp_steal_element_by_attr(xmpp_element_t *packet, const char *attr_name, const char *attr_value);
extern xmpp_element_t* xmpp_steal_element_by_name_and_attr(xmpp_element_t *packet, const char *name, const char *attr_name, const char *attr_value);
 
/*Returns first child in element*/
extern xmpp_element_t* xmpp_get_first_element(xmpp_element_t *packet);
 
/*Converts element to string. Returns memory allocated from the given pool.*/
extern char* xmpp_element_to_string(wmem_allocator_t *pool, tvbuff_t *tvb, xmpp_element_t *element);
 
/* Returns attribute by name and set as read. If attrib is set as read, it may be found
 * one more time, but it is invisible for function xmpp_unknown_attrib*/
extern xmpp_attr_t* xmpp_get_attr(xmpp_element_t *element, const char* attr_name);
 
/*Function hides first element in tree.*/
extern void xmpp_proto_tree_hide_first_child(proto_tree *tree);
 
/*Function shows first element in tree.*/
extern void xmpp_proto_tree_show_first_child(proto_tree *tree);
 
/*Function returns item as text. Memory is allocated from the given pool.*/
extern char* proto_item_get_text(wmem_allocator_t *pool, proto_item *item);
 
/*Function returns struct that contains 3 strings. It is used to build xmpp_attr_info struct.*/
extern void *xmpp_name_attr_struct(wmem_allocator_t *pool, const char *name, const char *attr_name, const char *attr_value);
 
extern void xmpp_display_attrs(proto_tree *tree, xmpp_element_t *element, packet_info *pinfo, tvbuff_t *tvb, const xmpp_attr_info *attrs, unsigned n);
 
extern void xmpp_display_attrs_ext(proto_tree *tree, xmpp_element_t *element, packet_info *pinfo, tvbuff_t *tvb, const xmpp_attr_info_ext *attrs, unsigned n);
 
extern void xmpp_display_elems(proto_tree *tree, xmpp_element_t *parent, packet_info *pinfo, tvbuff_t *tvb, xmpp_elem_info *elems, unsigned n);
 
/* Validates attribute value. Takes string array(char**) in parameter data.
 * Is used in XMPP_ATTR_INFO struct.
 */
extern void xmpp_val_enum_list(packet_info *pinfo, proto_item *item, const char *name, const char *value, const void *data);
 
extern void xmpp_change_elem_to_attrib(wmem_allocator_t *pool, const char *elem_name, const char *attr_name, xmpp_element_t *parent, xmpp_attr_t* (*transform_func)(wmem_allocator_t *pool, xmpp_element_t *element));
 
extern xmpp_attr_t* xmpp_transform_func_cdata(wmem_allocator_t *pool, xmpp_element_t *elem);
 
#endif /* XMPP_UTILS_H */