epan/dissectors/packet-ber.h

   1 /* packet-ber.h
   2  * Helpers for ASN.1/BER dissection
   3  * Ronnie Sahlberg (C) 2004
   4  *
   5  * $Id$
   6  *
   7  * Ethereal - Network traffic analyzer
   8  * By Gerald Combs <gerald@ethereal.com>
   9  * Copyright 1998 Gerald Combs
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License
  13  * as published by the Free Software Foundation; either version 2
  14  * of the License, or (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  24  */
  25
  26 #ifndef __PACKET_BER_H__
  27 #define __PACKET_BER_H__
  28
  29 #include <epan/to_str.h>
  30
  31 #define BER_NOT_DECODED_YET(x) \
  32 proto_tree_add_text(tree, tvb, offset, 0, "something unknown here [%s]",x); \
  33 fprintf(stderr,"Not decoded yet in packet : %d  [%s]\n", pinfo->fd->num,x); \
  34 if (check_col(pinfo->cinfo, COL_INFO)){ \
  35         col_append_fstr(pinfo->cinfo, COL_INFO, "[UNKNOWN BER: %s]", x); \
  36 } \
  37 tvb_get_guint8(tvb, 9999);
  38
  39 typedef int (*ber_callback)(packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset);
  40
  41 #define BER_CLASS_UNI   0
  42 #define BER_CLASS_APP   1
  43 #define BER_CLASS_CON   2
  44 #define BER_CLASS_PRI   3
  45 #define BER_CLASS_ANY   99                      /* dont check class nor tag */
  46
  47 #define BER_UNI_TAG_EOC                                 0       /* 'end-of-content' */
  48 #define BER_UNI_TAG_BOOLEAN                             1
  49 #define BER_UNI_TAG_INTEGER                             2
  50 #define BER_UNI_TAG_BITSTRING               3
  51 #define BER_UNI_TAG_OCTETSTRING             4
  52 #define BER_UNI_TAG_NULL                                5
  53 #define BER_UNI_TAG_OID                                 6       /* OBJECT IDENTIFIER */
  54 #define BER_UNI_TAG_ObjectDescriptor    7
  55 #define BER_UNI_TAG_REAL                                9
  56 #define BER_UNI_TAG_ENUMERATED              10
  57 #define BER_UNI_TAG_EMBEDDED_PDV            11
  58 #define BER_UNI_TAG_UTF8String              12
  59 #define BER_UNI_TAG_RELATIVE_OID            13
  60 #define BER_UNI_TAG_SEQUENCE                16  /* SEQUENCE, SEQUENCE OF */
  61 #define BER_UNI_TAG_SET                                 17      /* SET, SET OF */
  62 #define BER_UNI_TAG_NumericString           18
  63 #define BER_UNI_TAG_PrintableString         19
  64 #define BER_UNI_TAG_TeletexString           20  /* TeletextString, T61String */
  65 #define BER_UNI_TAG_VideotexString          21
  66 #define BER_UNI_TAG_IA5String               22
  67 #define BER_UNI_TAG_UTCTime                             23
  68 #define BER_UNI_TAG_GeneralizedTime         24
  69 #define BER_UNI_TAG_GraphicString           25
  70 #define BER_UNI_TAG_VisibleString           26  /* VisibleString, ISO64String */
  71 #define BER_UNI_TAG_GeneralString           27
  72 #define BER_UNI_TAG_UniversalString         28
  73 #define BER_UNI_TAG_CHARACTERSTRING         29
  74 #define BER_UNI_TAG_BMPString               30
  75
  76 #define BER_MAX_OID_STR_LEN MAX_OID_STR_LEN
  77
  78 /* this function dissects the identifier octer of the BER TLV.
  79  * We only handle TAGs (and LENGTHs) that fit inside 32 bit integers.
  80  */
  81 extern int get_ber_identifier(tvbuff_t *tvb, int offset, gint8 *class, gboolean *pc, gint32 *tag);
  82 extern int dissect_ber_identifier(packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint8 *class, gboolean *pc, gint32 *tag);
  83 extern int dissect_unknown_ber(packet_info *pinfo, tvbuff_t *tvb, int offset, proto_tree *tree);
  84 /* this function dissects the identifier octer of the BER TLV.
  85  * We only handle (TAGs and) LENGTHs that fit inside 32 bit integers.
  86  */
  87 extern int get_ber_length(proto_tree *tree, tvbuff_t *tvb, int offset, guint32 *length, gboolean *ind);
  88 extern int dissect_ber_length(packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, guint32 *length, gboolean *ind);
  89
  90 extern int dissect_ber_octet_string(gboolean implicit_tag, packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id, tvbuff_t **out_tvb);
  91 extern int dissect_ber_octet_string_wcb(gboolean implicit_tag, packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id, ber_callback func);
  92
  93 extern int dissect_ber_integer(gboolean implicit_tag, packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id, guint32 *value);
  94
  95 extern int dissect_ber_null(gboolean implicit_tag, packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id);
  96
  97 extern int dissect_ber_boolean(gboolean implicit_tag, packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id);
  98
  99
 100 #define BER_FLAGS_OPTIONAL      0x00000001
 101 #define BER_FLAGS_IMPLTAG       0x00000002
 102 #define BER_FLAGS_NOOWNTAG      0x00000004
 103 #define BER_FLAGS_NOTCHKTAG     0x00000008
 104 typedef struct _ber_sequence_t {
 105         gint8   class;
 106         gint32  tag;
 107         guint32 flags;
 108         ber_callback    func;
 109 } ber_sequence_t;
 110
 111 /* this function dissects a BER sequence
 112  */
 113 extern int dissect_ber_sequence(gboolean implicit_tag, packet_info *pinfo, proto_tree *parent_tree, tvbuff_t *tvb, int offset, const ber_sequence_t *seq, gint hf_id, gint ett_id);
 114 extern int dissect_ber_set(gboolean implicit_tag, packet_info *pinfo, proto_tree *parent_tree, tvbuff_t *tvb, int offset, const ber_sequence_t *seq, gint hf_id, gint ett_id);
 115
 116
 117 typedef struct _ber_choice_t {
 118         guint32 value;
 119         gint8   class;
 120         gint32  tag;
 121         guint32 flags;
 122         ber_callback    func;
 123 } ber_choice_t;
 124
 125
 126 /* this function dissects a BER choice
 127  */
 128 extern int dissect_ber_choice(packet_info *pinfo, proto_tree *parent_tree, tvbuff_t *tvb, int offset, const ber_choice_t *ch, gint hf_id, gint ett_id, gint *branch_taken);
 129
 130
 131 /* this function dissects a BER strings
 132  */
 133 extern int dissect_ber_restricted_string(gboolean implicit_tag, gint32 type, packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id, tvbuff_t **out_tvb);
 134 extern int dissect_ber_GeneralString(packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id, char *name_string, guint name_len);
 135
 136
 137 /* this function dissects a BER Object Identifier
 138  */
 139 extern int dissect_ber_object_identifier(gboolean implicit_tag, packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id, tvbuff_t **value_tvb);
 140 extern int dissect_ber_object_identifier_str(gboolean implicit_tag, packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id, const char **value_string);
 141
 142 /* this function dissects a BER sequence of
 143  */
 144 extern int dissect_ber_sequence_of(gboolean implicit_tag, packet_info *pinfo, proto_tree *parent_tree, tvbuff_t *tvb, int offset, const ber_sequence_t *seq, gint hf_id, gint ett_id);
 145
 146 extern int dissect_ber_set_of(gboolean implicit_tag, packet_info *pinfo, proto_tree *parent_tree, tvbuff_t *tvb, int offset, const ber_sequence_t *seq, gint hf_id, gint ett_id);
 147
 148
 149 extern int dissect_ber_GeneralizedTime(gboolean implicit_tag, packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id);
 150
 151 typedef struct _asn_namedbit {
 152         guint32 bit;
 153         int *p_id;
 154         gint32 gb0;  /* the 1st bit of "bit group", -1 = the 1st bit of current byte */
 155         gint32 gb1;  /* last bit of "bit group", -1 = last bit of current byte */
 156         const gchar *tstr;  /* true string */
 157         const gchar *fstr;  /* false string */
 158 } asn_namedbit;
 159 /* this function dissects a BER BIT-STRING
 160  */
 161 extern int dissect_ber_bitstring(gboolean implicit_tag, packet_info *pinfo, proto_tree *parent_tree, tvbuff_t *tvb, int offset, const asn_namedbit *named_bits, gint hf_id, gint ett_id, tvbuff_t **out_tvb);
 162 extern int dissect_ber_bitstring32(gboolean implicit_tag, packet_info *pinfo, proto_tree *parent_tree, tvbuff_t *tvb, int offset, int **bit_fields, gint hf_id, gint ett_id, tvbuff_t **out_tvb);
 163
 164
 165 extern proto_item *ber_last_created_item;
 166 extern proto_item *get_ber_last_created_item(void);
 167
 168 int call_ber_oid_callback(const char *oid, tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree);
 169 void register_ber_oid_dissector_handle(const char *oid, dissector_handle_t dissector, int proto, const char *name);
 170 void register_ber_oid_dissector(const char *oid, dissector_t dissector, int proto, const char *name);
 171 void register_ber_oid_name(const char *oid, const char *name);
 172 void dissect_ber_oid_NULL_callback(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
 173 const char * get_ber_oid_name(const char *str);
 174
 175 #endif  /* __PACKET_BER_H__ */
 176