wscbor.h

Go to the documentation of this file.

#pragma once
#include <ws_symbol_export.h>
#include <epan/tvbuff.h>
#include <epan/proto.h>
#include <epan/expert.h>
#include <wsutil/wmem/wmem_list.h>
 
#ifdef __cplusplus
extern "C" {
#endif

WS_DLL_PUBLIC
void wscbor_init(void);

WS_DLL_PUBLIC
const ei_register_info * wscbor_expert_items(int *size);

typedef enum cbor_type {
    CBOR_TYPE_UINT = 0, 
    CBOR_TYPE_NEGINT = 1, 
    CBOR_TYPE_BYTESTRING = 2, 
    CBOR_TYPE_STRING = 3, 
    CBOR_TYPE_ARRAY = 4, 
    CBOR_TYPE_MAP = 5, 
    CBOR_TYPE_TAG = 6, 
    CBOR_TYPE_FLOAT_CTRL = 7, 
} cbor_type;

typedef enum {
    CBOR_CTRL_NONE  =  0, 
    CBOR_CTRL_FALSE = 20, 
    CBOR_CTRL_TRUE  = 21, 
    CBOR_CTRL_NULL  = 22, 
    CBOR_CTRL_UNDEF = 23  
} _cbor_ctrl;

typedef struct {
    expert_field *ei;
    const char *msg;
} wscbor_error_t;

WS_DLL_PUBLIC
wscbor_error_t * wscbor_error_new(wmem_allocator_t *alloc, expert_field *ei, const char *format, ...) G_GNUC_PRINTF(3,4);

typedef struct {
    int start;
    int length;
    uint64_t value;
} wscbor_tag_t;
 
struct _wscbor_chunk_priv_t;
typedef struct _wscbor_chunk_priv_t wscbor_chunk_priv_t;
typedef struct {
    wscbor_chunk_priv_t *_priv;

    int start;
    int head_length;
    int data_length;
    wmem_list_t *errors;
    wmem_list_t *tags;

    cbor_type type_major;
    uint8_t type_minor;
    uint64_t head_value;
} wscbor_chunk_t;

WS_DLL_PUBLIC
wscbor_chunk_t * wscbor_chunk_read(wmem_allocator_t *alloc, tvbuff_t *tvb, int *offset);

WS_DLL_PUBLIC
void wscbor_chunk_free(wscbor_chunk_t *chunk);

WS_DLL_PUBLIC
uint64_t wscbor_chunk_mark_errors(packet_info *pinfo, proto_item *item, const wscbor_chunk_t *chunk);

WS_DLL_PUBLIC
unsigned wscbor_has_errors(const wscbor_chunk_t *chunk);

WS_DLL_PUBLIC
bool wscbor_is_indefinite_break(const wscbor_chunk_t *chunk);

WS_DLL_PUBLIC
bool wscbor_skip_next_item(wmem_allocator_t *alloc, tvbuff_t *tvb, int *offset);

WS_DLL_PUBLIC
bool wscbor_skip_if_errors(wmem_allocator_t *alloc, tvbuff_t *tvb, int *offset, const wscbor_chunk_t *chunk);
 

WS_DLL_PUBLIC
bool wscbor_require_major_type(wscbor_chunk_t *chunk, cbor_type major);

WS_DLL_PUBLIC
bool wscbor_require_array(wscbor_chunk_t *chunk);

WS_DLL_PUBLIC
bool wscbor_require_array_size(wscbor_chunk_t *chunk, uint64_t count_min, uint64_t count_max);

WS_DLL_PUBLIC
bool wscbor_require_map(wscbor_chunk_t *chunk);

WS_DLL_PUBLIC
bool * wscbor_require_boolean(wmem_allocator_t *alloc, wscbor_chunk_t *chunk);

WS_DLL_PUBLIC
uint64_t * wscbor_require_uint64(wmem_allocator_t *alloc, wscbor_chunk_t *chunk);

WS_DLL_PUBLIC
int64_t * wscbor_require_int64(wmem_allocator_t *alloc, wscbor_chunk_t *chunk);

WS_DLL_PUBLIC
char * wscbor_require_tstr(wmem_allocator_t *alloc, wscbor_chunk_t *chunk);

WS_DLL_PUBLIC
tvbuff_t * wscbor_require_bstr(wmem_allocator_t *alloc, wscbor_chunk_t *chunk);

WS_DLL_PUBLIC
proto_item * proto_tree_add_cbor_container(proto_tree *tree, int hfindex, packet_info *pinfo, tvbuff_t *tvb, const wscbor_chunk_t *chunk);

WS_DLL_PUBLIC
proto_item * proto_tree_add_cbor_ctrl(proto_tree *tree, int hfindex, packet_info *pinfo, tvbuff_t *tvb, const wscbor_chunk_t *chunk);

WS_DLL_PUBLIC
proto_item * proto_tree_add_cbor_boolean(proto_tree *tree, int hfindex, packet_info *pinfo, tvbuff_t *tvb, const wscbor_chunk_t *chunk, const bool *value);

WS_DLL_PUBLIC
proto_item * proto_tree_add_cbor_uint64(proto_tree *tree, int hfindex, packet_info *pinfo, tvbuff_t *tvb, const wscbor_chunk_t *chunk, const uint64_t *value);

WS_DLL_PUBLIC
proto_item * proto_tree_add_cbor_int64(proto_tree *tree, int hfindex, packet_info *pinfo, tvbuff_t *tvb, const wscbor_chunk_t *chunk, const int64_t *value);

WS_DLL_PUBLIC
proto_item * proto_tree_add_cbor_bitmask(proto_tree *tree, int hfindex, const int ett, int *const *fields, packet_info *pinfo, tvbuff_t *tvb, const wscbor_chunk_t *chunk, const uint64_t *value);

WS_DLL_PUBLIC
proto_item * proto_tree_add_cbor_tstr(proto_tree *tree, int hfindex, packet_info *pinfo, tvbuff_t *tvb, const wscbor_chunk_t *chunk);

WS_DLL_PUBLIC
proto_item * proto_tree_add_cbor_bstr(proto_tree *tree, int hfindex, packet_info *pinfo, tvbuff_t *tvb, const wscbor_chunk_t *chunk);

WS_DLL_PUBLIC
proto_item * proto_tree_add_cbor_strlen(proto_tree *tree, int hfindex, packet_info *pinfo, tvbuff_t *tvb, const wscbor_chunk_t *chunk);
 
#ifdef __cplusplus
}
#endif