packet-bpv7.h

/* packet-bpv7.h
 * Definitions for Bundle Protocol Version 7 dissection.
 * References:
 *     RFC 9171: https://www.rfc-editor.org/rfc/rfc9171.html
 *
 * Copyright 2019-2021, Brian Sipos <[email protected]>
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <[email protected]>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */
#ifndef PACKET_BPV7_H
#define PACKET_BPV7_H
 
#include <ws_symbol_export.h>
#include <epan/tvbuff.h>
#include <epan/proto.h>
#include <epan/expert.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* This dissector defines two layers of protocol:
 * - The BPv7 bundle format, its endpoint naming and its block types.
 * - The BPv7 Administrative Record which is a bundle payload as indicated by
 *   a primary block flag.
 *
 * BPv7 endpoint identifier (EID) dissectors for the scheme-specific
 * part (SSP) are registered with the dissector table "bpv7.eid".
 * This table uses a `uint` key for the scheme number and uses bp_eid_t* as
 * dissector user data to be populated by the SSP data.
 * Specifically the bp_eid_t::uri should be populated by the text form
 * of the EID (as an AT_STRINGZ value).
 *
 * BPv7 block-type-specific data (BTSD) dissectors are registered with the
 * dissector table "bpv7.block_type" and Administrative Record dissectors
 * with the table "bpv7.admin_record_type". Both use uint64_t* table keys.
 * Both use bp_dissector_data_t* as dissector user data.
 *
 * There is a BTSD heuristic dissector table "bpv7.btsd" which uses
 * bp_dissector_data_t* as dissector user data.
 *
 * Payload block (block type 1) dissection is additionally handled based on
 * bundle flags and destination EID as:
 * - If the bundle flags mark it as administrative, it is dissected as such.
 * - If the destination is a well-known SSP, the dissector table
 *   "bpv7.payload.dtn_wkssp" is used with the scheme-specific part.
 * - If the destination is "dtn" scheme, the dissector table
 *   "bpv7.payload.dtn_serv" is used with the service demux (text string).
 *   There is also Decode As behavior for dtn service demux.
 * - If the destination is "ipn" scheme, the dissector table
 *   "bpv7.payload.ipn_serv" is used with the service number (uint value).
 *   There is also Decode As behavior for ipn service number.
 * - Finally, fall through to BTSD heuristic dissection.
 * All payload dissection uses bp_dissector_data_t* as dissector user data.
 */
 
typedef enum {
    BP_CRC_NONE = 0,
    BP_CRC_16 = 1,
    BP_CRC_32 = 2,
} BundleCrcType;
 
typedef enum {
    BP_BUNDLE_REQ_DELETION_REPORT = 0x040000,
    BP_BUNDLE_REQ_DELIVERY_REPORT = 0x020000,
    BP_BUNDLE_REQ_FORWARDING_REPORT = 0x010000,
    BP_BUNDLE_REQ_RECEPTION_REPORT = 0x004000,
    BP_BUNDLE_REQ_STATUS_TIME = 0x000040,
    BP_BUNDLE_USER_APP_ACK = 0x000020,
    BP_BUNDLE_NO_FRAGMENT = 0x000004,
    BP_BUNDLE_PAYLOAD_ADMIN = 0x000002,
    BP_BUNDLE_IS_FRAGMENT = 0x000001,
} BundleProcessingFlag;
 
typedef enum {
    BP_BLOCK_REMOVE_IF_NO_PROCESS = 0x10,
    BP_BLOCK_DELETE_IF_NO_PROCESS = 0x04,
    BP_BLOCK_STATUS_IF_NO_PROCESS = 0x02,
    BP_BLOCK_REPLICATE_IN_FRAGMENT = 0x01,
} BlockProcessingFlag;
 
typedef enum {
    BP_BLOCKTYPE_INVALID = 0,
    BP_BLOCKTYPE_PAYLOAD = 1,
    BP_BLOCKTYPE_PREV_NODE = 6,
    BP_BLOCKTYPE_BUNDLE_AGE = 7,
    BP_BLOCKTYPE_HOP_COUNT = 10,
    BP_BLOCKTYPE_BIB = 11,
    BP_BLOCKTYPE_BCB = 12,
} BlockTypeCode;
 
typedef enum {
    BP_ADMINTYPE_BUNDLE_STATUS = 1,
} AdminRecordTypeCode;
 
typedef struct {
    uint64_t dtntime;
    nstime_t utctime;
} bp_dtn_time_t;
 
typedef struct {
    bp_dtn_time_t abstime;
    uint64_t seqno;
} bp_creation_ts_t;
 
WS_DLL_PUBLIC
int bp_creation_ts_compare(const void *a, const void *b, void *user_data);
 
typedef enum {
    EID_SCHEME_DTN = 1,
    EID_SCHEME_IPN = 2,
} EidScheme;
 
typedef struct {
    wmem_allocator_t *alloc;
    uint64_t scheme;
    address uri;
 
    const char *dtn_wkssp;
    const char *dtn_serv;
    uint64_t *ipn_serv;
} bp_eid_t;
 
WS_DLL_PUBLIC
bp_eid_t * bp_eid_new(wmem_allocator_t *alloc);
 
WS_DLL_PUBLIC
void bp_eid_free(bp_eid_t *obj);
 
WS_DLL_PUBLIC
bool bp_eid_equal(const void *a, const void *b);
 
typedef struct {
    wmem_map_t *data_i;
    wmem_map_t *data_c;
} security_mark_t;
 
typedef struct {
    proto_item *item_block;
 
    uint64_t flags;
    bp_eid_t *dst_eid;
    bp_eid_t *src_nodeid;
    bp_eid_t *rep_nodeid;
    bp_creation_ts_t ts;
    uint64_t *frag_offset;
    uint64_t *total_len;
    uint64_t crc_type;
    tvbuff_t *crc_field;
 
    security_mark_t sec;
} bp_block_primary_t;
 
WS_DLL_PUBLIC
bp_block_primary_t * bp_block_primary_new(wmem_allocator_t *alloc);
 
WS_DLL_PUBLIC
void bp_block_primary_free(wmem_allocator_t *alloc, bp_block_primary_t *obj);
 
typedef struct {
    uint64_t blk_ix;
    proto_item *item_block;
 
    uint64_t *type_code;
    uint64_t *block_number;
    uint64_t flags;
    uint64_t crc_type;
    tvbuff_t *crc_field;
 
    tvbuff_t *data;
    proto_tree *tree_data;
 
    security_mark_t sec;
} bp_block_canonical_t;
 
WS_DLL_PUBLIC
bp_block_canonical_t * bp_block_canonical_new(wmem_allocator_t *alloc, uint64_t blk_ix);
 
WS_DLL_PUBLIC
void bp_block_canonical_delete(wmem_allocator_t *alloc, bp_block_canonical_t *obj);
 
typedef struct {
    address src;
    bp_creation_ts_t ts;
    const uint64_t *frag_offset;
    const uint64_t *total_len;
} bp_bundle_ident_t;
 
WS_DLL_PUBLIC
bp_bundle_ident_t * bp_bundle_ident_new(wmem_allocator_t *alloc, const bp_eid_t *src, const bp_creation_ts_t *ts, const uint64_t *off, const uint64_t *len);
 
WS_DLL_PUBLIC
void bp_bundle_ident_free(wmem_allocator_t *alloc, bp_bundle_ident_t *obj);
 
WS_DLL_PUBLIC
gboolean bp_bundle_ident_equal(const void *a, const void *b);
 
WS_DLL_PUBLIC
unsigned bp_bundle_ident_hash(const void *key);
 
typedef struct {
    uint32_t frame_num;
    uint8_t layer_num;
    nstime_t frame_time;
    bp_bundle_ident_t *ident;
    bp_block_primary_t *primary;
    wmem_list_t *blocks;
    wmem_map_t *block_nums;
    wmem_map_t *block_types;
 
    unsigned *pyld_start;
    unsigned *pyld_len;
} bp_bundle_t;
 
WS_DLL_PUBLIC
bp_bundle_t * bp_bundle_new(wmem_allocator_t *alloc);
 
WS_DLL_PUBLIC
void bp_bundle_free(wmem_allocator_t *alloc, bp_bundle_t *obj);
 
WS_DLL_PUBLIC
proto_item * proto_tree_add_cbor_eid(proto_tree *tree, int hfindex, int hfindex_uri, packet_info *pinfo, tvbuff_t *tvb, int *offset, bp_eid_t *eid);
 
typedef struct {
    wmem_map_t *bundles;
    wmem_map_t *admin_status;
} bp_history_t;
 
typedef struct {
    bp_bundle_t *bundle;
    bp_block_canonical_t *block;
} bp_dissector_data_t;
 
#ifdef __cplusplus
}
#endif
 
#endif /* PACKET_BPV7_H */