/src/botan/build/include/botan/ber_dec.h

Source (jump to first uncovered line)
/*
* BER Decoder
* (C) 1999-2010,2018 Jack Lloyd
*
* Botan is released under the Simplified BSD License (see license.txt)
*/

#ifndef BOTAN_BER_DECODER_H_
#define BOTAN_BER_DECODER_H_

#include <botan/asn1_obj.h>
#include <botan/data_src.h>

namespace Botan {

class BigInt;

/**
* BER Decoding Object
*/
class BOTAN_PUBLIC_API(2,0) BER_Decoder final
   {
   public:
      /**
      * Set up to BER decode the data in buf of length len
      */
      BER_Decoder(const uint8_t buf[], size_t len);

      /**
      * Set up to BER decode the data in vec
      */
      explicit BER_Decoder(const secure_vector<uint8_t>& vec);

      /**
      * Set up to BER decode the data in vec
      */
      explicit BER_Decoder(const std::vector<uint8_t>& vec);

      /**
      * Set up to BER decode the data in src
      */
      explicit BER_Decoder(DataSource& src);

      /**
      * Set up to BER decode the data in obj
      */
      BER_Decoder(const BER_Object& obj) :
         BER_Decoder(obj.bits(), obj.length()) {}

      /**
      * Set up to BER decode the data in obj
      */
      BER_Decoder(BER_Object&& obj) :
         BER_Decoder(std::move(obj), nullptr) {}

      BER_Decoder(const BER_Decoder& other);

      BER_Decoder& operator=(const BER_Decoder&) = delete;

      /**
      * Get the next object in the data stream.
      * If EOF, returns an object with type NO_OBJECT.
      */
      BER_Object get_next_object();

      BER_Decoder& get_next(BER_Object& ber)
         {
         ber = get_next_object();
         return (*this);
         }

      /**
      * Push an object back onto the stream. Throws if another
      * object was previously pushed and has not been subsequently
      * read out.
      */
      void push_back(const BER_Object& obj);

      /**
      * Push an object back onto the stream. Throws if another
      * object was previously pushed and has not been subsequently
      * read out.
      */
      void push_back(BER_Object&& obj);

      /**
      * Return true if there is at least one more item remaining
      */
      bool more_items() const;

      /**
      * Verify the stream is concluded, throws otherwise.
      * Returns (*this)
      */
      BER_Decoder& verify_end();

      /**
      * Verify the stream is concluded, throws otherwise.
      * Returns (*this)
      */
      BER_Decoder& verify_end(const std::string& err_msg);

      /**
      * Discard any data that remains unread
      * Returns (*this)
      */
      BER_Decoder& discard_remaining();

      BER_Decoder start_cons(ASN1_Type type_tag, ASN1_Class class_tag);

      BER_Decoder start_sequence()
         {
         return start_cons(ASN1_Type::Sequence, ASN1_Class::Universal);
         }

      BER_Decoder start_set()
         {
         return start_cons(ASN1_Type::Set, ASN1_Class::Universal);
         }

      BER_Decoder start_context_specific(uint32_t tag)
         {
         return start_cons(ASN1_Type(tag), ASN1_Class::ContextSpecific);
         }

      BER_Decoder start_explicit_context_specific(uint32_t tag)
         {
         return start_cons(ASN1_Type(tag), ASN1_Class::ExplicitContextSpecific);
         }

      /**
      * Finish decoding a constructed data, throws if any data remains.
      * Returns the parent of *this (ie the object on which start_cons was called).
      */
      BER_Decoder& end_cons();

      /**
      * Get next object and copy value to POD type
      * Asserts value length is equal to POD type sizeof.
      * Asserts Type tag and optional Class tag according to parameters.
      * Copy value to POD type (struct, union, C-style array, std::array, etc.).
      * @param out POD type reference where to copy object value
      * @param type_tag ASN1_Type enum to assert type on object read
      * @param class_tag ASN1_Type enum to assert class on object read (default: CONTEXT_SPECIFIC)
      * @return this reference
      */
      template <typename T>
         BER_Decoder& get_next_value(T &out,
                                     ASN1_Type type_tag,
                                     ASN1_Class class_tag = ASN1_Class::ContextSpecific)
         {
         static_assert(std::is_standard_layout<T>::value && std::is_trivial<T>::value, "Type must be POD");

         BER_Object obj = get_next_object();
         obj.assert_is_a(type_tag, class_tag);

         if (obj.length() != sizeof(T))
            throw BER_Decoding_Error(
                    "Size mismatch. Object value size is " +
                    std::to_string(obj.length()) +
                    "; Output type size is " +
                    std::to_string(sizeof(T)));

         copy_mem(reinterpret_cast<uint8_t*>(&out), obj.bits(), obj.length());

         return (*this);
         }

      /*
      * Save all the bytes remaining in the source
      */
      template<typename Alloc>
      BER_Decoder& raw_bytes(std::vector<uint8_t, Alloc>& out)
         {
         out.clear();
         uint8_t buf;
         while(m_source->read_byte(buf))
            out.push_back(buf);
         return (*this);
         }

      BER_Decoder& decode_null();

      /**
      * Decode a BER encoded BOOLEAN
      */
      BER_Decoder& decode(bool& out)
         {
         return decode(out, ASN1_Type::Boolean, ASN1_Class::Universal);
         }

      /*
      * Decode a small BER encoded INTEGER
      */
      BER_Decoder& decode(size_t& out)
         {
         return decode(out, ASN1_Type::Integer, ASN1_Class::Universal);
         }

      /*
      * Decode a BER encoded INTEGER
      */
      BER_Decoder& decode(BigInt& out)
         {
         return decode(out, ASN1_Type::Integer, ASN1_Class::Universal);
         }

      std::vector<uint8_t> get_next_octet_string()
         {
         std::vector<uint8_t> out_vec;
         decode(out_vec, ASN1_Type::OctetString);
         return out_vec;
         }

      /*
      * BER decode a BIT STRING or OCTET STRING
      */
      template<typename Alloc>
      BER_Decoder& decode(std::vector<uint8_t, Alloc>& out, ASN1_Type real_type)
         {
         return decode(out, real_type, real_type, ASN1_Class::Universal);
         }

      BER_Decoder& decode(bool& v,
                          ASN1_Type type_tag,
                          ASN1_Class class_tag = ASN1_Class::ContextSpecific);

      BER_Decoder& decode(size_t& v,
                          ASN1_Type type_tag,
                          ASN1_Class class_tag = ASN1_Class::ContextSpecific);

      BER_Decoder& decode(BigInt& v,
                          ASN1_Type type_tag,
                          ASN1_Class class_tag = ASN1_Class::ContextSpecific);

      BER_Decoder& decode(std::vector<uint8_t>& v,
                          ASN1_Type real_type,
                          ASN1_Type type_tag,
                          ASN1_Class class_tag = ASN1_Class::ContextSpecific);

      BER_Decoder& decode(secure_vector<uint8_t>& v,
                          ASN1_Type real_type,
                          ASN1_Type type_tag,
                          ASN1_Class class_tag = ASN1_Class::ContextSpecific);

      BER_Decoder& decode(ASN1_Object& obj,
                          ASN1_Type type_tag = ASN1_Type::NoObject,
                          ASN1_Class class_tag = ASN1_Class::NoObject);

      /**
      * Decode an integer value which is typed as an octet string
      */
      BER_Decoder& decode_octet_string_bigint(BigInt& b);

      uint64_t decode_constrained_integer(ASN1_Type type_tag,
                                          ASN1_Class class_tag,
                                          size_t T_bytes);

      template<typename T> BER_Decoder& decode_integer_type(T& out)
         {
         return decode_integer_type<T>(out, ASN1_Type::Integer, ASN1_Class::Universal);
         }

      template<typename T>
         BER_Decoder& decode_integer_type(T& out,
                                          ASN1_Type type_tag,
                                          ASN1_Class class_tag = ASN1_Class::ContextSpecific)
         {
         out = static_cast<T>(decode_constrained_integer(type_tag, class_tag, sizeof(out)));
         return (*this);
         }

      template<typename T>
         BER_Decoder& decode_optional(T& out,
                                      ASN1_Type type_tag,
                                      ASN1_Class class_tag,
                                      const T& default_value = T());

      template<typename T>
         BER_Decoder& decode_optional_implicit(
            T& out,
            ASN1_Type type_tag,
            ASN1_Class class_tag,
            ASN1_Type real_type,
            ASN1_Class real_class,
            const T& default_value = T());

      template<typename T>
         BER_Decoder& decode_list(std::vector<T>& out,
                                  ASN1_Type type_tag = ASN1_Type::Sequence,
                                  ASN1_Class class_tag = ASN1_Class::Universal);

      template<typename T>
         BER_Decoder& decode_and_check(const T& expected,
                                       const std::string& error_msg)
         {
         T actual;
         decode(actual);

         if(actual != expected)
            throw Decoding_Error(error_msg);

         return (*this);
         }

      /*
      * Decode an OPTIONAL string type
      */
      template<typename Alloc>
      BER_Decoder& decode_optional_string(std::vector<uint8_t, Alloc>& out,
                                          ASN1_Type real_type,
                                          uint32_t expected_tag,
                                          ASN1_Class class_tag = ASN1_Class::ContextSpecific)
         {
         BER_Object obj = get_next_object();

         ASN1_Type type_tag = static_cast<ASN1_Type>(expected_tag);

         if(obj.is_a(type_tag, class_tag))
            {
            if(class_tag == ASN1_Class::ExplicitContextSpecific)
               {
               BER_Decoder(std::move(obj)).decode(out, real_type).verify_end();
               }
            else
               {
               push_back(std::move(obj));
               decode(out, real_type, type_tag, class_tag);
               }
            }
         else
            {
            out.clear();
            push_back(std::move(obj));
            }

         return (*this);
         }

      template<typename Alloc>
      BER_Decoder& decode_optional_string(std::vector<uint8_t, Alloc>& out,
                                          ASN1_Type real_type,
                                          ASN1_Type expected_tag,
                                          ASN1_Class class_tag = ASN1_Class::ContextSpecific)
         {
         return decode_optional_string(out, real_type,
                                       static_cast<uint32_t>(expected_tag),
                                       class_tag);
         }

   private:
      BER_Decoder(BER_Object&& obj, BER_Decoder* parent);

      BER_Decoder* m_parent = nullptr;
      BER_Object m_pushed;
      // either m_data_src.get() or an unowned pointer
      DataSource* m_source;
      mutable std::unique_ptr<DataSource> m_data_src;
   };

/*
* Decode an OPTIONAL or DEFAULT element
*/
template<typename T>
BER_Decoder& BER_Decoder::decode_optional(T& out,
                                          ASN1_Type type_tag,
                                          ASN1_Class class_tag,
                                          const T& default_value)
   {
   BER_Object obj = get_next_object();

   if(obj.is_a(type_tag, class_tag))
      {
      if(class_tag == ASN1_Class::ExplicitContextSpecific)
         {
         BER_Decoder(std::move(obj)).decode(out).verify_end();
         }
      else
         {
         push_back(std::move(obj));
         decode(out, type_tag, class_tag);
         }
      }
   else
      {
      out = default_value;
      push_back(std::move(obj));
      }

   return (*this);
   }

/*
* Decode an OPTIONAL or DEFAULT element
*/
template<typename T>
BER_Decoder& BER_Decoder::decode_optional_implicit(
   T& out,
   ASN1_Type type_tag,
   ASN1_Class class_tag,
   ASN1_Type real_type,
   ASN1_Class real_class,
   const T& default_value)
   {
   BER_Object obj = get_next_object();

   if(obj.is_a(type_tag, class_tag))
      {
      obj.set_tagging(real_type, real_class);
      push_back(std::move(obj));
      decode(out, real_type, real_class);
      }
   else
      {
      // Not what we wanted, push it back on the stream
      out = default_value;
      push_back(std::move(obj));
      }

   return (*this);
   }
/*
* Decode a list of homogenously typed values
*/
template<typename T>
BER_Decoder& BER_Decoder::decode_list(std::vector<T>& vec,
                                      ASN1_Type type_tag,
                                      ASN1_Class class_tag)
   {
   BER_Decoder list = start_cons(type_tag, class_tag);

   while(list.more_items())
      {
      T value;
      list.decode(value);
      vec.push_back(std::move(value));
      }

   list.end_cons();

   return (*this);
   }

}

#endif

Coverage Report

Created: 2022-08-24 06:26

Line	Count	Source (jump to first uncovered line)
1		/*
2		* BER Decoder
3		* (C) 1999-2010,2018 Jack Lloyd
4		*
5		* Botan is released under the Simplified BSD License (see license.txt)
6		*/
7
8		#ifndef BOTAN_BER_DECODER_H_
9		#define BOTAN_BER_DECODER_H_
10
11		#include <botan/asn1_obj.h>
12		#include <botan/data_src.h>
13
14		namespace Botan {
15
16		class BigInt;
17
18		/**
19		* BER Decoding Object
20		*/
21		class BOTAN_PUBLIC_API(2,0) BER_Decoder final
22		{
23		public:
24		/**
25		* Set up to BER decode the data in buf of length len
26		*/
27		BER_Decoder(const uint8_t buf[], size_t len);
28
29		/**
30		* Set up to BER decode the data in vec
31		*/
32		explicit BER_Decoder(const secure_vector<uint8_t>& vec);
33
34		/**
35		* Set up to BER decode the data in vec
36		*/
37		explicit BER_Decoder(const std::vector<uint8_t>& vec);
38
39		/**
40		* Set up to BER decode the data in src
41		*/
42		explicit BER_Decoder(DataSource& src);
43
44		/**
45		* Set up to BER decode the data in obj
46		*/
47		BER_Decoder(const BER_Object& obj) :
48	0	BER_Decoder(obj.bits(), obj.length()) {}
49
50		/**
51		* Set up to BER decode the data in obj
52		*/
53		BER_Decoder(BER_Object&& obj) :
54	0	BER_Decoder(std::move(obj), nullptr) {}
55
56		BER_Decoder(const BER_Decoder& other);
57
58		BER_Decoder& operator=(const BER_Decoder&) = delete;
59
60		/**
61		* Get the next object in the data stream.
62		* If EOF, returns an object with type NO_OBJECT.
63		*/
64		BER_Object get_next_object();
65
66		BER_Decoder& get_next(BER_Object& ber)
67	0	{
68	0	ber = get_next_object();
69	0	return (*this);
70	0	}
71
72		/**
73		* Push an object back onto the stream. Throws if another
74		* object was previously pushed and has not been subsequently
75		* read out.
76		*/
77		void push_back(const BER_Object& obj);
78
79		/**
80		* Push an object back onto the stream. Throws if another
81		* object was previously pushed and has not been subsequently
82		* read out.
83		*/
84		void push_back(BER_Object&& obj);
85
86		/**
87		* Return true if there is at least one more item remaining
88		*/
89		bool more_items() const;
90
91		/**
92		* Verify the stream is concluded, throws otherwise.
93		* Returns (*this)
94		*/
95		BER_Decoder& verify_end();
96
97		/**
98		* Verify the stream is concluded, throws otherwise.
99		* Returns (*this)
100		*/
101		BER_Decoder& verify_end(const std::string& err_msg);
102
103		/**
104		* Discard any data that remains unread
105		* Returns (*this)
106		*/
107		BER_Decoder& discard_remaining();
108
109		BER_Decoder start_cons(ASN1_Type type_tag, ASN1_Class class_tag);
110
111		BER_Decoder start_sequence()
112	0	{
113	0	return start_cons(ASN1_Type::Sequence, ASN1_Class::Universal);
114	0	}
115
116		BER_Decoder start_set()
117	0	{
118	0	return start_cons(ASN1_Type::Set, ASN1_Class::Universal);
119	0	}
120
121		BER_Decoder start_context_specific(uint32_t tag)
122	0	{
123	0	return start_cons(ASN1_Type(tag), ASN1_Class::ContextSpecific);
124	0	}
125
126		BER_Decoder start_explicit_context_specific(uint32_t tag)
127	0	{
128	0	return start_cons(ASN1_Type(tag), ASN1_Class::ExplicitContextSpecific);
129	0	}
130
131		/**
132		* Finish decoding a constructed data, throws if any data remains.
133		* Returns the parent of *this (ie the object on which start_cons was called).
134		*/
135		BER_Decoder& end_cons();
136
137		/**
138		* Get next object and copy value to POD type
139		* Asserts value length is equal to POD type sizeof.
140		* Asserts Type tag and optional Class tag according to parameters.
141		* Copy value to POD type (struct, union, C-style array, std::array, etc.).
142		* @param out POD type reference where to copy object value
143		* @param type_tag ASN1_Type enum to assert type on object read
144		* @param class_tag ASN1_Type enum to assert class on object read (default: CONTEXT_SPECIFIC)
145		* @return this reference
146		*/
147		template <typename T>
148		BER_Decoder& get_next_value(T &out,
149		ASN1_Type type_tag,
150		ASN1_Class class_tag = ASN1_Class::ContextSpecific)
151		{
152		static_assert(std::is_standard_layout<T>::value && std::is_trivial<T>::value, "Type must be POD");
153
154		BER_Object obj = get_next_object();
155		obj.assert_is_a(type_tag, class_tag);
156
157		if (obj.length() != sizeof(T))
158		throw BER_Decoding_Error(
159		"Size mismatch. Object value size is " +
160		std::to_string(obj.length()) +
161		"; Output type size is " +
162		std::to_string(sizeof(T)));
163
164		copy_mem(reinterpret_cast<uint8_t*>(&out), obj.bits(), obj.length());
165
166		return (*this);
167		}
168
169		/*
170		* Save all the bytes remaining in the source
171		*/
172		template<typename Alloc>
173		BER_Decoder& raw_bytes(std::vector<uint8_t, Alloc>& out)
174	0	{
175	0	out.clear();
176	0	uint8_t buf;
177	0	while(m_source->read_byte(buf))
178	0	out.push_back(buf);
179	0	return (*this);
180	0	}
181
182		BER_Decoder& decode_null();
183
184		/**
185		* Decode a BER encoded BOOLEAN
186		*/
187		BER_Decoder& decode(bool& out)
188	0	{
189	0	return decode(out, ASN1_Type::Boolean, ASN1_Class::Universal);
190	0	}
191
192		/*
193		* Decode a small BER encoded INTEGER
194		*/
195		BER_Decoder& decode(size_t& out)
196	0	{
197	0	return decode(out, ASN1_Type::Integer, ASN1_Class::Universal);
198	0	}
199
200		/*
201		* Decode a BER encoded INTEGER
202		*/
203		BER_Decoder& decode(BigInt& out)
204	0	{
205	0	return decode(out, ASN1_Type::Integer, ASN1_Class::Universal);
206	0	}
207
208		std::vector<uint8_t> get_next_octet_string()
209	0	{
210	0	std::vector<uint8_t> out_vec;
211	0	decode(out_vec, ASN1_Type::OctetString);
212	0	return out_vec;
213	0	}
214
215		/*
216		* BER decode a BIT STRING or OCTET STRING
217		*/
218		template<typename Alloc>
219		BER_Decoder& decode(std::vector<uint8_t, Alloc>& out, ASN1_Type real_type)
220	0	{
221	0	return decode(out, real_type, real_type, ASN1_Class::Universal);
222	0	} Unexecuted instantiation: Botan::BER_Decoder& Botan::BER_Decoder::decode<std::__1::allocator<unsigned char> >(std::__1::vector<unsigned char, std::__1::allocator<unsigned char> >&, Botan::ASN1_Type) Unexecuted instantiation: Botan::BER_Decoder& Botan::BER_Decoder::decode<Botan::secure_allocator<unsigned char> >(std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> >&, Botan::ASN1_Type)
223
224		BER_Decoder& decode(bool& v,
225		ASN1_Type type_tag,
226		ASN1_Class class_tag = ASN1_Class::ContextSpecific);
227
228		BER_Decoder& decode(size_t& v,
229		ASN1_Type type_tag,
230		ASN1_Class class_tag = ASN1_Class::ContextSpecific);
231
232		BER_Decoder& decode(BigInt& v,
233		ASN1_Type type_tag,
234		ASN1_Class class_tag = ASN1_Class::ContextSpecific);
235
236		BER_Decoder& decode(std::vector<uint8_t>& v,
237		ASN1_Type real_type,
238		ASN1_Type type_tag,
239		ASN1_Class class_tag = ASN1_Class::ContextSpecific);
240
241		BER_Decoder& decode(secure_vector<uint8_t>& v,
242		ASN1_Type real_type,
243		ASN1_Type type_tag,
244		ASN1_Class class_tag = ASN1_Class::ContextSpecific);
245
246		BER_Decoder& decode(ASN1_Object& obj,
247		ASN1_Type type_tag = ASN1_Type::NoObject,
248		ASN1_Class class_tag = ASN1_Class::NoObject);
249
250		/**
251		* Decode an integer value which is typed as an octet string
252		*/
253		BER_Decoder& decode_octet_string_bigint(BigInt& b);
254
255		uint64_t decode_constrained_integer(ASN1_Type type_tag,
256		ASN1_Class class_tag,
257		size_t T_bytes);
258
259		template<typename T> BER_Decoder& decode_integer_type(T& out)
260		{
261		return decode_integer_type<T>(out, ASN1_Type::Integer, ASN1_Class::Universal);
262		}
263
264		template<typename T>
265		BER_Decoder& decode_integer_type(T& out,
266		ASN1_Type type_tag,
267		ASN1_Class class_tag = ASN1_Class::ContextSpecific)
268		{
269		out = static_cast<T>(decode_constrained_integer(type_tag, class_tag, sizeof(out)));
270		return (*this);
271		}
272
273		template<typename T>
274		BER_Decoder& decode_optional(T& out,
275		ASN1_Type type_tag,
276		ASN1_Class class_tag,
277		const T& default_value = T());
278
279		template<typename T>
280		BER_Decoder& decode_optional_implicit(
281		T& out,
282		ASN1_Type type_tag,
283		ASN1_Class class_tag,
284		ASN1_Type real_type,
285		ASN1_Class real_class,
286		const T& default_value = T());
287
288		template<typename T>
289		BER_Decoder& decode_list(std::vector<T>& out,
290		ASN1_Type type_tag = ASN1_Type::Sequence,
291		ASN1_Class class_tag = ASN1_Class::Universal);
292
293		template<typename T>
294		BER_Decoder& decode_and_check(const T& expected,
295		const std::string& error_msg)
296	0	{
297	0	T actual;
298	0	decode(actual);
299
300	0	if(actual != expected)
301	0	throw Decoding_Error(error_msg);
302
303	0	return (*this);
304	0	} Unexecuted instantiation: Botan::BER_Decoder& Botan::BER_Decoder::decode_and_check<unsigned long>(unsigned long const&, std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&) Unexecuted instantiation: Botan::BER_Decoder& Botan::BER_Decoder::decode_and_check<Botan::OID>(Botan::OID const&, std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&)
305
306		/*
307		* Decode an OPTIONAL string type
308		*/
309		template<typename Alloc>
310		BER_Decoder& decode_optional_string(std::vector<uint8_t, Alloc>& out,
311		ASN1_Type real_type,
312		uint32_t expected_tag,
313		ASN1_Class class_tag = ASN1_Class::ContextSpecific)
314	0	{
315	0	BER_Object obj = get_next_object();
316
317	0	ASN1_Type type_tag = static_cast<ASN1_Type>(expected_tag);
318
319	0	if(obj.is_a(type_tag, class_tag))
320	0	{
321	0	if(class_tag == ASN1_Class::ExplicitContextSpecific)
322	0	{
323	0	BER_Decoder(std::move(obj)).decode(out, real_type).verify_end();
324	0	}
325	0	else
326	0	{
327	0	push_back(std::move(obj));
328	0	decode(out, real_type, type_tag, class_tag);
329	0	}
330	0	}
331	0	else
332	0	{
333	0	out.clear();
334	0	push_back(std::move(obj));
335	0	}
336
337	0	return (*this);
338	0	} Unexecuted instantiation: Botan::BER_Decoder& Botan::BER_Decoder::decode_optional_string<std::__1::allocator<unsigned char> >(std::__1::vector<unsigned char, std::__1::allocator<unsigned char> >&, Botan::ASN1_Type, unsigned int, Botan::ASN1_Class) Unexecuted instantiation: Botan::BER_Decoder& Botan::BER_Decoder::decode_optional_string<Botan::secure_allocator<unsigned char> >(std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> >&, Botan::ASN1_Type, unsigned int, Botan::ASN1_Class)
339
340		template<typename Alloc>
341		BER_Decoder& decode_optional_string(std::vector<uint8_t, Alloc>& out,
342		ASN1_Type real_type,
343		ASN1_Type expected_tag,
344		ASN1_Class class_tag = ASN1_Class::ContextSpecific)
345	0	{
346	0	return decode_optional_string(out, real_type,
347	0	static_cast<uint32_t>(expected_tag),
348	0	class_tag);
349	0	}
350
351		private:
352		BER_Decoder(BER_Object&& obj, BER_Decoder* parent);
353
354		BER_Decoder* m_parent = nullptr;
355		BER_Object m_pushed;
356		// either m_data_src.get() or an unowned pointer
357		DataSource* m_source;
358		mutable std::unique_ptr<DataSource> m_data_src;
359		};
360
361		/*
362		* Decode an OPTIONAL or DEFAULT element
363		*/
364		template<typename T>
365		BER_Decoder& BER_Decoder::decode_optional(T& out,
366		ASN1_Type type_tag,
367		ASN1_Class class_tag,
368		const T& default_value)
369	0	{
370	0	BER_Object obj = get_next_object();
371
372	0	if(obj.is_a(type_tag, class_tag))
373	0	{
374	0	if(class_tag == ASN1_Class::ExplicitContextSpecific)
375	0	{
376	0	BER_Decoder(std::move(obj)).decode(out).verify_end();
377	0	}
378	0	else
379	0	{
380	0	push_back(std::move(obj));
381	0	decode(out, type_tag, class_tag);
382	0	}
383	0	}
384	0	else
385	0	{
386	0	out = default_value;
387	0	push_back(std::move(obj));
388	0	}
389
390	0	return (*this);
391	0	}
392
393		/*
394		* Decode an OPTIONAL or DEFAULT element
395		*/
396		template<typename T>
397		BER_Decoder& BER_Decoder::decode_optional_implicit(
398		T& out,
399		ASN1_Type type_tag,
400		ASN1_Class class_tag,
401		ASN1_Type real_type,
402		ASN1_Class real_class,
403		const T& default_value)
404		{
405		BER_Object obj = get_next_object();
406
407		if(obj.is_a(type_tag, class_tag))
408		{
409		obj.set_tagging(real_type, real_class);
410		push_back(std::move(obj));
411		decode(out, real_type, real_class);
412		}
413		else
414		{
415		// Not what we wanted, push it back on the stream
416		out = default_value;
417		push_back(std::move(obj));
418		}
419
420		return (*this);
421		}
422		/*
423		* Decode a list of homogenously typed values
424		*/
425		template<typename T>
426		BER_Decoder& BER_Decoder::decode_list(std::vector<T>& vec,
427		ASN1_Type type_tag,
428		ASN1_Class class_tag)
429		{
430		BER_Decoder list = start_cons(type_tag, class_tag);
431
432		while(list.more_items())
433		{
434		T value;
435		list.decode(value);
436		vec.push_back(std::move(value));
437		}
438
439		list.end_cons();
440
441		return (*this);
442		}
443
444		}
445
446		#endif