Coverage Report

Created: 2020-06-30 13:58

/src/botan/build/include/botan/internal/tls_reader.h
Line
Count
Source (jump to first uncovered line)
1
/*
2
* TLS Data Reader
3
* (C) 2010-2011,2014 Jack Lloyd
4
*
5
* Botan is released under the Simplified BSD License (see license.txt)
6
*/
7
8
#ifndef BOTAN_TLS_READER_H_
9
#define BOTAN_TLS_READER_H_
10
11
#include <botan/exceptn.h>
12
#include <botan/secmem.h>
13
#include <botan/loadstor.h>
14
#include <string>
15
#include <vector>
16
17
namespace Botan {
18
19
namespace TLS {
20
21
/**
22
* Helper class for decoding TLS protocol messages
23
*/
24
class TLS_Data_Reader final
25
   {
26
   public:
27
      TLS_Data_Reader(const char* type, const std::vector<uint8_t>& buf_in) :
28
54.2k
         m_typename(type), m_buf(buf_in), m_offset(0) {}
29
30
      void assert_done() const
31
14.5k
         {
32
14.5k
         if(has_remaining())
33
127
            throw decode_error("Extra bytes at end of message");
34
14.5k
         }
35
36
719
      size_t read_so_far() const { return m_offset; }
37
38
332k
      size_t remaining_bytes() const { return m_buf.size() - m_offset; }
39
40
295k
      bool has_remaining() const { return (remaining_bytes() > 0); }
41
42
      std::vector<uint8_t> get_remaining()
43
0
         {
44
0
         return std::vector<uint8_t>(m_buf.begin() + m_offset, m_buf.end());
45
0
         }
46
47
      void discard_next(size_t bytes)
48
1.30k
         {
49
1.30k
         assert_at_least(bytes);
50
1.30k
         m_offset += bytes;
51
1.30k
         }
52
53
      uint32_t get_uint32_t()
54
5
         {
55
5
         assert_at_least(4);
56
5
         uint32_t result = make_uint32(m_buf[m_offset  ], m_buf[m_offset+1],
57
5
                                     m_buf[m_offset+2], m_buf[m_offset+3]);
58
5
         m_offset += 4;
59
5
         return result;
60
5
         }
61
62
      uint16_t get_uint16_t()
63
683k
         {
64
683k
         assert_at_least(2);
65
683k
         uint16_t result = make_uint16(m_buf[m_offset], m_buf[m_offset+1]);
66
683k
         m_offset += 2;
67
683k
         return result;
68
683k
         }
69
70
      uint8_t get_byte()
71
214k
         {
72
214k
         assert_at_least(1);
73
214k
         uint8_t result = m_buf[m_offset];
74
214k
         m_offset += 1;
75
214k
         return result;
76
214k
         }
77
78
      template<typename T, typename Container>
79
      Container get_elem(size_t num_elems)
80
364k
         {
81
364k
         assert_at_least(num_elems * sizeof(T));
82
364k
83
364k
         Container result(num_elems);
84
364k
85
3.15M
         for(size_t i = 0; i != num_elems; ++i)
86
2.79M
            result[i] = load_be<T>(&m_buf[m_offset], i);
87
364k
88
364k
         m_offset += num_elems * sizeof(T);
89
364k
90
364k
         return result;
91
364k
         }
std::__1::vector<unsigned char, std::__1::allocator<unsigned char> > Botan::TLS::TLS_Data_Reader::get_elem<unsigned char, std::__1::vector<unsigned char, std::__1::allocator<unsigned char> > >(unsigned long)
Line
Count
Source
80
331k
         {
81
331k
         assert_at_least(num_elems * sizeof(T));
82
331k
83
331k
         Container result(num_elems);
84
331k
85
3.03M
         for(size_t i = 0; i != num_elems; ++i)
86
2.70M
            result[i] = load_be<T>(&m_buf[m_offset], i);
87
331k
88
331k
         m_offset += num_elems * sizeof(T);
89
331k
90
331k
         return result;
91
331k
         }
std::__1::vector<unsigned short, std::__1::allocator<unsigned short> > Botan::TLS::TLS_Data_Reader::get_elem<unsigned short, std::__1::vector<unsigned short, std::__1::allocator<unsigned short> > >(unsigned long)
Line
Count
Source
80
33.3k
         {
81
33.3k
         assert_at_least(num_elems * sizeof(T));
82
33.3k
83
33.3k
         Container result(num_elems);
84
33.3k
85
119k
         for(size_t i = 0; i != num_elems; ++i)
86
85.7k
            result[i] = load_be<T>(&m_buf[m_offset], i);
87
33.3k
88
33.3k
         m_offset += num_elems * sizeof(T);
89
33.3k
90
33.3k
         return result;
91
33.3k
         }
92
93
      template<typename T>
94
      std::vector<T> get_range(size_t len_bytes,
95
                               size_t min_elems,
96
                               size_t max_elems)
97
66.8k
         {
98
66.8k
         const size_t num_elems =
99
66.8k
            get_num_elems(len_bytes, sizeof(T), min_elems, max_elems);
100
66.8k
101
66.8k
         return get_elem<T, std::vector<T>>(num_elems);
102
66.8k
         }
std::__1::vector<unsigned char, std::__1::allocator<unsigned char> > Botan::TLS::TLS_Data_Reader::get_range<unsigned char>(unsigned long, unsigned long, unsigned long)
Line
Count
Source
97
66.5k
         {
98
66.5k
         const size_t num_elems =
99
66.5k
            get_num_elems(len_bytes, sizeof(T), min_elems, max_elems);
100
66.5k
101
66.5k
         return get_elem<T, std::vector<T>>(num_elems);
102
66.5k
         }
std::__1::vector<unsigned short, std::__1::allocator<unsigned short> > Botan::TLS::TLS_Data_Reader::get_range<unsigned short>(unsigned long, unsigned long, unsigned long)
Line
Count
Source
97
233
         {
98
233
         const size_t num_elems =
99
233
            get_num_elems(len_bytes, sizeof(T), min_elems, max_elems);
100
233
101
233
         return get_elem<T, std::vector<T>>(num_elems);
102
233
         }
103
104
      template<typename T>
105
      std::vector<T> get_range_vector(size_t len_bytes,
106
                                      size_t min_elems,
107
                                      size_t max_elems)
108
111k
         {
109
111k
         const size_t num_elems =
110
111k
            get_num_elems(len_bytes, sizeof(T), min_elems, max_elems);
111
111k
112
111k
         return get_elem<T, std::vector<T>>(num_elems);
113
111k
         }
std::__1::vector<unsigned char, std::__1::allocator<unsigned char> > Botan::TLS::TLS_Data_Reader::get_range_vector<unsigned char>(unsigned long, unsigned long, unsigned long)
Line
Count
Source
108
78.6k
         {
109
78.6k
         const size_t num_elems =
110
78.6k
            get_num_elems(len_bytes, sizeof(T), min_elems, max_elems);
111
78.6k
112
78.6k
         return get_elem<T, std::vector<T>>(num_elems);
113
78.6k
         }
std::__1::vector<unsigned short, std::__1::allocator<unsigned short> > Botan::TLS::TLS_Data_Reader::get_range_vector<unsigned short>(unsigned long, unsigned long, unsigned long)
Line
Count
Source
108
33.2k
         {
109
33.2k
         const size_t num_elems =
110
33.2k
            get_num_elems(len_bytes, sizeof(T), min_elems, max_elems);
111
33.2k
112
33.2k
         return get_elem<T, std::vector<T>>(num_elems);
113
33.2k
         }
114
115
      std::string get_string(size_t len_bytes,
116
                             size_t min_bytes,
117
                             size_t max_bytes)
118
44.7k
         {
119
44.7k
         std::vector<uint8_t> v =
120
44.7k
            get_range_vector<uint8_t>(len_bytes, min_bytes, max_bytes);
121
44.7k
122
44.7k
         return std::string(cast_uint8_ptr_to_char(v.data()), v.size());
123
44.7k
         }
124
125
      template<typename T>
126
      std::vector<T> get_fixed(size_t size)
127
183k
         {
128
183k
         return get_elem<T, std::vector<T>>(size);
129
183k
         }
130
131
   private:
132
      size_t get_length_field(size_t len_bytes)
133
178k
         {
134
178k
         assert_at_least(len_bytes);
135
178k
136
178k
         if(len_bytes == 1)
137
125k
            return get_byte();
138
53.4k
         else if(len_bytes == 2)
139
53.1k
            return get_uint16_t();
140
258
141
258
         throw decode_error("Bad length size");
142
258
         }
143
144
      size_t get_num_elems(size_t len_bytes,
145
                           size_t T_size,
146
                           size_t min_elems,
147
                           size_t max_elems)
148
178k
         {
149
178k
         const size_t byte_length = get_length_field(len_bytes);
150
178k
151
178k
         if(byte_length % T_size != 0)
152
17
            throw decode_error("Size isn't multiple of T");
153
178k
154
178k
         const size_t num_elems = byte_length / T_size;
155
178k
156
178k
         if(num_elems < min_elems || num_elems > max_elems)
157
116
            throw decode_error("Length field outside parameters");
158
178k
159
178k
         return num_elems;
160
178k
         }
161
162
      void assert_at_least(size_t n) const
163
1.44M
         {
164
1.44M
         if(m_buf.size() - m_offset < n)
165
1.22k
            throw decode_error("Expected " + std::to_string(n) +
166
1.22k
                               " bytes remaining, only " +
167
1.22k
                               std::to_string(m_buf.size()-m_offset) +
168
1.22k
                               " left");
169
1.44M
         }
170
171
      Decoding_Error decode_error(const std::string& why) const
172
1.48k
         {
173
1.48k
         return Decoding_Error("Invalid " + std::string(m_typename) + ": " + why);
174
1.48k
         }
175
176
      const char* m_typename;
177
      const std::vector<uint8_t>& m_buf;
178
      size_t m_offset;
179
   };
180
181
/**
182
* Helper function for encoding length-tagged vectors
183
*/
184
template<typename T, typename Alloc>
185
void append_tls_length_value(std::vector<uint8_t, Alloc>& buf,
186
                             const T* vals,
187
                             size_t vals_size,
188
                             size_t tag_size)
189
162k
   {
190
162k
   const size_t T_size = sizeof(T);
191
162k
   const size_t val_bytes = T_size * vals_size;
192
162k
193
162k
   if(tag_size != 1 && tag_size != 2)
194
0
      throw Invalid_Argument("append_tls_length_value: invalid tag size");
195
162k
196
162k
   if((tag_size == 1 && val_bytes > 255) ||
197
162k
      (tag_size == 2 && val_bytes > 65535))
198
0
      throw Invalid_Argument("append_tls_length_value: value too large");
199
162k
200
403k
   for(size_t i = 0; i != tag_size; ++i)
201
240k
      buf.push_back(get_byte(sizeof(val_bytes)-tag_size+i, val_bytes));
202
162k
203
9.68M
   for(size_t i = 0; i != vals_size; ++i)
204
20.0M
      for(size_t j = 0; j != T_size; ++j)
205
10.5M
         buf.push_back(get_byte(j, vals[i]));
206
162k
   }
void Botan::TLS::append_tls_length_value<unsigned char, std::__1::allocator<unsigned char> >(std::__1::vector<unsigned char, std::__1::allocator<unsigned char> >&, unsigned char const*, unsigned long, unsigned long)
Line
Count
Source
189
124k
   {
190
124k
   const size_t T_size = sizeof(T);
191
124k
   const size_t val_bytes = T_size * vals_size;
192
124k
193
124k
   if(tag_size != 1 && tag_size != 2)
194
0
      throw Invalid_Argument("append_tls_length_value: invalid tag size");
195
124k
196
124k
   if((tag_size == 1 && val_bytes > 255) ||
197
124k
      (tag_size == 2 && val_bytes > 65535))
198
0
      throw Invalid_Argument("append_tls_length_value: value too large");
199
124k
200
287k
   for(size_t i = 0; i != tag_size; ++i)
201
163k
      buf.push_back(get_byte(sizeof(val_bytes)-tag_size+i, val_bytes));
202
124k
203
7.28M
   for(size_t i = 0; i != vals_size; ++i)
204
14.3M
      for(size_t j = 0; j != T_size; ++j)
205
7.15M
         buf.push_back(get_byte(j, vals[i]));
206
124k
   }
void Botan::TLS::append_tls_length_value<unsigned short, std::__1::allocator<unsigned char> >(std::__1::vector<unsigned char, std::__1::allocator<unsigned char> >&, unsigned short const*, unsigned long, unsigned long)
Line
Count
Source
189
12.3k
   {
190
12.3k
   const size_t T_size = sizeof(T);
191
12.3k
   const size_t val_bytes = T_size * vals_size;
192
12.3k
193
12.3k
   if(tag_size != 1 && tag_size != 2)
194
0
      throw Invalid_Argument("append_tls_length_value: invalid tag size");
195
12.3k
196
12.3k
   if((tag_size == 1 && val_bytes > 255) ||
197
12.3k
      (tag_size == 2 && val_bytes > 65535))
198
0
      throw Invalid_Argument("append_tls_length_value: value too large");
199
12.3k
200
37.1k
   for(size_t i = 0; i != tag_size; ++i)
201
24.7k
      buf.push_back(get_byte(sizeof(val_bytes)-tag_size+i, val_bytes));
202
12.3k
203
1.01M
   for(size_t i = 0; i != vals_size; ++i)
204
3.00M
      for(size_t j = 0; j != T_size; ++j)
205
2.00M
         buf.push_back(get_byte(j, vals[i]));
206
12.3k
   }
void Botan::TLS::append_tls_length_value<unsigned char, Botan::secure_allocator<unsigned char> >(std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> >&, unsigned char const*, unsigned long, unsigned long)
Line
Count
Source
189
26.3k
   {
190
26.3k
   const size_t T_size = sizeof(T);
191
26.3k
   const size_t val_bytes = T_size * vals_size;
192
26.3k
193
26.3k
   if(tag_size != 1 && tag_size != 2)
194
0
      throw Invalid_Argument("append_tls_length_value: invalid tag size");
195
26.3k
196
26.3k
   if((tag_size == 1 && val_bytes > 255) ||
197
26.3k
      (tag_size == 2 && val_bytes > 65535))
198
0
      throw Invalid_Argument("append_tls_length_value: value too large");
199
26.3k
200
78.9k
   for(size_t i = 0; i != tag_size; ++i)
201
52.6k
      buf.push_back(get_byte(sizeof(val_bytes)-tag_size+i, val_bytes));
202
26.3k
203
1.38M
   for(size_t i = 0; i != vals_size; ++i)
204
2.71M
      for(size_t j = 0; j != T_size; ++j)
205
1.35M
         buf.push_back(get_byte(j, vals[i]));
206
26.3k
   }
207
208
template<typename T, typename Alloc, typename Alloc2>
209
void append_tls_length_value(std::vector<uint8_t, Alloc>& buf,
210
                             const std::vector<T, Alloc2>& vals,
211
                             size_t tag_size)
212
135k
   {
213
135k
   append_tls_length_value(buf, vals.data(), vals.size(), tag_size);
214
135k
   }
void Botan::TLS::append_tls_length_value<unsigned char, std::__1::allocator<unsigned char>, std::__1::allocator<unsigned char> >(std::__1::vector<unsigned char, std::__1::allocator<unsigned char> >&, std::__1::vector<unsigned char, std::__1::allocator<unsigned char> > const&, unsigned long)
Line
Count
Source
212
96.3k
   {
213
96.3k
   append_tls_length_value(buf, vals.data(), vals.size(), tag_size);
214
96.3k
   }
Unexecuted instantiation: void Botan::TLS::append_tls_length_value<unsigned char, std::__1::allocator<unsigned char>, Botan::secure_allocator<unsigned char> >(std::__1::vector<unsigned char, std::__1::allocator<unsigned char> >&, std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> > const&, unsigned long)
void Botan::TLS::append_tls_length_value<unsigned short, std::__1::allocator<unsigned char>, std::__1::allocator<unsigned short> >(std::__1::vector<unsigned char, std::__1::allocator<unsigned char> >&, std::__1::vector<unsigned short, std::__1::allocator<unsigned short> > const&, unsigned long)
Line
Count
Source
212
12.3k
   {
213
12.3k
   append_tls_length_value(buf, vals.data(), vals.size(), tag_size);
214
12.3k
   }
void Botan::TLS::append_tls_length_value<unsigned char, Botan::secure_allocator<unsigned char>, std::__1::allocator<unsigned char> >(std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> >&, std::__1::vector<unsigned char, std::__1::allocator<unsigned char> > const&, unsigned long)
Line
Count
Source
212
1.06k
   {
213
1.06k
   append_tls_length_value(buf, vals.data(), vals.size(), tag_size);
214
1.06k
   }
void Botan::TLS::append_tls_length_value<unsigned char, Botan::secure_allocator<unsigned char>, Botan::secure_allocator<unsigned char> >(std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> >&, std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> > const&, unsigned long)
Line
Count
Source
212
25.2k
   {
213
25.2k
   append_tls_length_value(buf, vals.data(), vals.size(), tag_size);
214
25.2k
   }
215
216
template<typename Alloc>
217
void append_tls_length_value(std::vector<uint8_t, Alloc>& buf,
218
                             const std::string& str,
219
                             size_t tag_size)
220
21.9k
   {
221
21.9k
   append_tls_length_value(buf,
222
21.9k
                           cast_char_ptr_to_uint8(str.data()),
223
21.9k
                           str.size(),
224
21.9k
                           tag_size);
225
21.9k
   }
226
227
}
228
229
}
230
231
#endif