epan/dissectors/packet-bpsec.h

   1 /* packet-bpv7.h
   2  * Definitions for Bundle Protocol Version 7 Security (BPSec) dissection
   3  * References:
   4  *     RFC 9172: https://www.rfc-editor.org/rfc/rfc9172.html
   5  *
   6  * Copyright 2019-2021, Brian Sipos <brian.sipos@gmail.com>
   7  *
   8  * Wireshark - Network traffic analyzer
   9  * By Gerald Combs <gerald@wireshark.org>
  10  * Copyright 1998 Gerald Combs
  11  *
  12  * SPDX-License-Identifier: LGPL-2.1-or-later
  13  */
  14 #ifndef PACKET_BPSEC_H
  15 #define PACKET_BPSEC_H
  16
  17 #include <ws_symbol_export.h>
  18 #include <epan/tvbuff.h>
  19 #include "packet-bpv7.h"
  20
  21 #ifdef __cplusplus
  22 extern "C" {
  23 #endif
  24
  25 /*
  26  * BPSec per-context parameter types and result types are registered with the
  27  * dissector table "bpsec.param" and "bpsec.result" respectively.
  28  * Both use bpsec_id_t* table keys, to identify both the context and the type
  29  * code points.
  30  */
  31
  32 /** Abstract Security Block Security Context Flags.
  33  * RFC 9172 Section 3.6.
  34  */
  35 typedef enum {
  36     /// Security Context Parameters present
  37     BPSEC_ASB_HAS_PARAMS = 0x01,
  38 } BpsecAsbFlag;
  39
  40 /// Parameter/Result dissector lookup
  41 typedef struct {
  42     /// Security context ID
  43     int64_t context_id;
  44     /// Parameter/Result ID
  45     int64_t type_id;
  46 } bpsec_id_t;
  47
  48 typedef struct {
  49     /// Specific type being dissected
  50     bpsec_id_t id;
  51     /// Pointer to containing block/bundle context
  52     const bp_dissector_data_t *bp;
  53 } bpsec_dissector_data_t;
  54
  55 /** Construct a new ID.
  56  */
  57 WS_DLL_PUBLIC
  58 bpsec_id_t * bpsec_id_new(wmem_allocator_t *alloc, int64_t context_id, int64_t type_id);
  59
  60 /** Function to match the GDestroyNotify signature.
  61  */
  62 WS_DLL_PUBLIC
  63 void bpsec_id_free(wmem_allocator_t *alloc, void *ptr);
  64
  65 /** Function to match the GCompareFunc signature.
  66  */
  67 WS_DLL_PUBLIC
  68 gboolean bpsec_id_equal(const void *a, const void *b);
  69
  70 /** Function to match the GHashFunc signature.
  71  */
  72 WS_DLL_PUBLIC
  73 unsigned bpsec_id_hash(const void *key);
  74
  75 #ifdef __cplusplus
  76 }
  77 #endif
  78
  79 #endif /* PACKET_BPSEC_H */