Coverage Report

Created: 2020-05-23 13:54

/src/botan/build/include/botan/asn1_obj.h
Line
Count
Source
1
/*
2
* ASN.1 Internals
3
* (C) 1999-2007,2018 Jack Lloyd
4
*
5
* Botan is released under the Simplified BSD License (see license.txt)
6
*/
7
8
#ifndef BOTAN_ASN1_H_
9
#define BOTAN_ASN1_H_
10
11
#include <botan/secmem.h>
12
#include <botan/exceptn.h>
13
14
namespace Botan {
15
16
class BER_Decoder;
17
class DER_Encoder;
18
19
/**
20
* ASN.1 Type and Class Tags
21
* This will become an enum class in a future major release
22
*/
23
enum ASN1_Tag : uint32_t {
24
   UNIVERSAL        = 0x00,
25
   APPLICATION      = 0x40,
26
   CONTEXT_SPECIFIC = 0x80,
27
28
   CONSTRUCTED      = 0x20,
29
30
   PRIVATE          = CONSTRUCTED | CONTEXT_SPECIFIC,
31
32
   EOC              = 0x00,
33
   BOOLEAN          = 0x01,
34
   INTEGER          = 0x02,
35
   BIT_STRING       = 0x03,
36
   OCTET_STRING     = 0x04,
37
   NULL_TAG         = 0x05,
38
   OBJECT_ID        = 0x06,
39
   ENUMERATED       = 0x0A,
40
   SEQUENCE         = 0x10,
41
   SET              = 0x11,
42
43
   UTF8_STRING      = 0x0C,
44
   NUMERIC_STRING   = 0x12,
45
   PRINTABLE_STRING = 0x13,
46
   T61_STRING       = 0x14,
47
   IA5_STRING       = 0x16,
48
   VISIBLE_STRING   = 0x1A,
49
   UNIVERSAL_STRING = 0x1C,
50
   BMP_STRING       = 0x1E,
51
52
   UTC_TIME                = 0x17,
53
   GENERALIZED_TIME        = 0x18,
54
   UTC_OR_GENERALIZED_TIME = 0x19,
55
56
   NO_OBJECT        = 0xFF00,
57
   DIRECTORY_STRING = 0xFF01
58
};
59
60
std::string BOTAN_UNSTABLE_API asn1_tag_to_string(ASN1_Tag type);
61
std::string BOTAN_UNSTABLE_API asn1_class_to_string(ASN1_Tag type);
62
63
/**
64
* Basic ASN.1 Object Interface
65
*/
66
class BOTAN_PUBLIC_API(2,0) ASN1_Object
67
   {
68
   public:
69
      /**
70
      * Encode whatever this object is into to
71
      * @param to the DER_Encoder that will be written to
72
      */
73
      virtual void encode_into(DER_Encoder& to) const = 0;
74
75
      /**
76
      * Decode whatever this object is from from
77
      * @param from the BER_Decoder that will be read from
78
      */
79
      virtual void decode_from(BER_Decoder& from) = 0;
80
81
      /**
82
      * Return the encoding of this object. This is a convenience
83
      * method when just one object needs to be serialized. Use
84
      * DER_Encoder for complicated encodings.
85
      */
86
      std::vector<uint8_t> BER_encode() const;
87
88
1.10M
      ASN1_Object() = default;
89
1.37M
      ASN1_Object(const ASN1_Object&) = default;
90
2.94k
      ASN1_Object & operator=(const ASN1_Object&) = default;
91
2.47M
      virtual ~ASN1_Object() = default;
92
   };
93
94
/**
95
* BER Encoded Object
96
*/
97
class BOTAN_PUBLIC_API(2,0) BER_Object final
98
   {
99
   public:
100
1.99M
      BER_Object() : type_tag(NO_OBJECT), class_tag(UNIVERSAL) {}
101
102
      BER_Object(const BER_Object& other) = default;
103
104
5.20k
      BER_Object& operator=(const BER_Object& other) = default;
105
106
532k
      BER_Object(BER_Object&& other) = default;
107
108
288k
      BER_Object& operator=(BER_Object&& other) = default;
109
110
2.99M
      bool is_set() const { return type_tag != NO_OBJECT; }
111
112
1.44M
      ASN1_Tag tagging() const { return ASN1_Tag(type() | get_class()); }
113
114
1.78M
      ASN1_Tag type() const { return type_tag; }
115
1.51M
      ASN1_Tag get_class() const { return class_tag; }
116
117
14.2M
      const uint8_t* bits() const { return value.data(); }
118
119
29.9M
      size_t length() const { return value.size(); }
120
121
      void assert_is_a(ASN1_Tag type_tag, ASN1_Tag class_tag,
122
                       const std::string& descr = "object") const;
123
124
      bool is_a(ASN1_Tag type_tag, ASN1_Tag class_tag) const;
125
126
      bool is_a(int type_tag, ASN1_Tag class_tag) const;
127
128
   BOTAN_DEPRECATED_PUBLIC_MEMBER_VARIABLES:
129
      /*
130
      * The following member variables are public for historical reasons, but
131
      * will be made private in a future major release. Use the accessor
132
      * functions above.
133
      */
134
      ASN1_Tag type_tag, class_tag;
135
      secure_vector<uint8_t> value;
136
137
   private:
138
139
      friend class BER_Decoder;
140
141
      void set_tagging(ASN1_Tag type_tag, ASN1_Tag class_tag);
142
143
      uint8_t* mutable_bits(size_t length)
144
1.22M
         {
145
1.22M
         value.resize(length);
146
1.22M
         return value.data();
147
1.22M
         }
148
   };
149
150
/*
151
* ASN.1 Utility Functions
152
*/
153
class DataSource;
154
155
namespace ASN1 {
156
157
std::vector<uint8_t> put_in_sequence(const std::vector<uint8_t>& val);
158
std::vector<uint8_t> put_in_sequence(const uint8_t bits[], size_t len);
159
std::string to_string(const BER_Object& obj);
160
161
/**
162
* Heuristics tests; is this object possibly BER?
163
* @param src a data source that will be peeked at but not modified
164
*/
165
bool maybe_BER(DataSource& src);
166
167
}
168
169
/**
170
* General BER Decoding Error Exception
171
*/
172
class BOTAN_PUBLIC_API(2,0) BER_Decoding_Error : public Decoding_Error
173
   {
174
   public:
175
      explicit BER_Decoding_Error(const std::string&);
176
   };
177
178
/**
179
* Exception For Incorrect BER Taggings
180
*/
181
class BOTAN_PUBLIC_API(2,0) BER_Bad_Tag final : public BER_Decoding_Error
182
   {
183
   public:
184
      BER_Bad_Tag(const std::string& msg, ASN1_Tag tag);
185
      BER_Bad_Tag(const std::string& msg, ASN1_Tag tag1, ASN1_Tag tag2);
186
   };
187
188
}
189
190
#endif