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  * Wireshark - Network traffic analyzer
   8  * By Gerald Combs <gerald@wireshark.org>
   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 typedef int (*ber_type_fn)(gboolean, tvbuff_t*, int, packet_info*, proto_tree*, int);
  41
  42
  43 #define BER_CLASS_UNI   0
  44 #define BER_CLASS_APP   1
  45 #define BER_CLASS_CON   2
  46 #define BER_CLASS_PRI   3
  47 #define BER_CLASS_ANY   99                      /* dont check class nor tag */
  48
  49 #define BER_UNI_TAG_EOC                                 0       /* 'end-of-content' */
  50 #define BER_UNI_TAG_BOOLEAN                             1
  51 #define BER_UNI_TAG_INTEGER                             2
  52 #define BER_UNI_TAG_BITSTRING               3
  53 #define BER_UNI_TAG_OCTETSTRING             4
  54 #define BER_UNI_TAG_NULL                                5
  55 #define BER_UNI_TAG_OID                                 6       /* OBJECT IDENTIFIER */
  56 #define BER_UNI_TAG_ObjectDescriptor    7
  57 #define BER_UNI_TAG_REAL                                9
  58 #define BER_UNI_TAG_ENUMERATED              10
  59 #define BER_UNI_TAG_EMBEDDED_PDV            11
  60 #define BER_UNI_TAG_UTF8String              12
  61 #define BER_UNI_TAG_RELATIVE_OID            13
  62 #define BER_UNI_TAG_SEQUENCE                16  /* SEQUENCE, SEQUENCE OF */
  63 #define BER_UNI_TAG_SET                                 17      /* SET, SET OF */
  64 #define BER_UNI_TAG_NumericString           18
  65 #define BER_UNI_TAG_PrintableString         19
  66 #define BER_UNI_TAG_TeletexString           20  /* TeletextString, T61String */
  67 #define BER_UNI_TAG_VideotexString          21
  68 #define BER_UNI_TAG_IA5String               22
  69 #define BER_UNI_TAG_UTCTime                             23
  70 #define BER_UNI_TAG_GeneralizedTime         24
  71 #define BER_UNI_TAG_GraphicString           25
  72 #define BER_UNI_TAG_VisibleString           26  /* VisibleString, ISO64String */
  73 #define BER_UNI_TAG_GeneralString           27
  74 #define BER_UNI_TAG_UniversalString         28
  75 #define BER_UNI_TAG_CHARACTERSTRING         29
  76 #define BER_UNI_TAG_BMPString               30
  77
  78
  79 /* this function dissects the identifier octer of the BER TLV.
  80  * We only handle TAGs (and LENGTHs) that fit inside 32 bit integers.
  81  */
  82 extern int get_ber_identifier(tvbuff_t *tvb, int offset, gint8 *class, gboolean *pc, gint32 *tag);
  83 extern int dissect_ber_identifier(packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint8 *class, gboolean *pc, gint32 *tag);
  84 extern int dissect_unknown_ber(packet_info *pinfo, tvbuff_t *tvb, int offset, proto_tree *tree);
  85 /* this function dissects the identifier octer of the BER TLV.
  86  * We only handle (TAGs and) LENGTHs that fit inside 32 bit integers.
  87  */
  88 extern int get_ber_length(proto_tree *tree, tvbuff_t *tvb, int offset, guint32 *length, gboolean *ind);
  89 extern int dissect_ber_length(packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, guint32 *length, gboolean *ind);
  90
  91 extern int dissect_ber_tagged_type(gboolean implicit_tag, packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id, gint8 tag_cls, gint32 tag_tag, gboolean tag_impl, ber_type_fn type);
  92
  93 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);
  94 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);
  95
  96 extern int dissect_ber_integer64(gboolean implicit_tag, packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id, gint64 *value);
  97
  98 extern int dissect_ber_integer(gboolean implicit_tag, packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id, guint32 *value);
  99
 100 extern int dissect_ber_null(gboolean implicit_tag, packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id);
 101
 102 extern int dissect_ber_boolean(gboolean implicit_tag, packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id);
 103 extern int dissect_ber_boolean_value(gboolean implicit_tag, packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id, gboolean *value);
 104
 105
 106 #define BER_FLAGS_OPTIONAL      0x00000001
 107 #define BER_FLAGS_IMPLTAG       0x00000002
 108 #define BER_FLAGS_NOOWNTAG      0x00000004
 109 #define BER_FLAGS_NOTCHKTAG     0x00000008
 110 typedef struct _ber_sequence_t {
 111         gint8   class;
 112         gint32  tag;
 113         guint32 flags;
 114         ber_callback    func;
 115 } ber_sequence_t;
 116
 117 /* this function dissects a BER sequence
 118  */
 119 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);
 120 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);
 121
 122
 123 typedef struct _ber_choice_t {
 124         guint32 value;
 125         gint8   class;
 126         gint32  tag;
 127         guint32 flags;
 128         ber_callback    func;
 129 } ber_choice_t;
 130
 131
 132 /* this function dissects a BER choice
 133  */
 134 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);
 135
 136
 137 /* this function dissects a BER strings
 138  */
 139 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);
 140 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);
 141
 142
 143 /* this function dissects a BER Object Identifier
 144  */
 145 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);
 146 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);
 147
 148 /* this function dissects a BER sequence of
 149  */
 150 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);
 151
 152 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);
 153
 154
 155 extern int dissect_ber_GeneralizedTime(gboolean implicit_tag, packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gint hf_id);
 156
 157 typedef struct _asn_namedbit {
 158         guint32 bit;
 159         int *p_id;
 160         gint32 gb0;  /* the 1st bit of "bit group", -1 = the 1st bit of current byte */
 161         gint32 gb1;  /* last bit of "bit group", -1 = last bit of current byte */
 162         const gchar *tstr;  /* true string */
 163         const gchar *fstr;  /* false string */
 164 } asn_namedbit;
 165 /* this function dissects a BER BIT-STRING
 166  */
 167 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);
 168 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);
 169
 170
 171 extern proto_item *ber_last_created_item;
 172 extern proto_item *get_ber_last_created_item(void);
 173
 174 int call_ber_oid_callback(const char *oid, tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree);
 175 void register_ber_oid_dissector_handle(const char *oid, dissector_handle_t dissector, int proto, const char *name);
 176 void register_ber_oid_dissector(const char *oid, dissector_t dissector, int proto, const char *name);
 177 void dissect_ber_oid_NULL_callback(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
 178
 179 gboolean oid_has_dissector(const char *oid);
 180
 181 #endif  /* __PACKET_BER_H__ */
 182