Coverage Report

Created: 2020-11-21 08:34

/src/botan/src/lib/asn1/asn1_time.cpp
Line
Count
Source (jump to first uncovered line)
1
/*
2
* X.509 Time Types
3
* (C) 1999-2007 Jack Lloyd
4
*
5
* Botan is released under the Simplified BSD License (see license.txt)
6
*/
7
8
#include <botan/asn1_obj.h>
9
#include <botan/der_enc.h>
10
#include <botan/ber_dec.h>
11
#include <botan/exceptn.h>
12
#include <botan/internal/parsing.h>
13
#include <botan/internal/calendar.h>
14
#include <sstream>
15
#include <iomanip>
16
17
namespace Botan {
18
19
ASN1_Time::ASN1_Time(const std::chrono::system_clock::time_point& time)
20
0
   {
21
0
   calendar_point cal(time);
22
23
0
   m_year   = cal.year();
24
0
   m_month  = cal.month();
25
0
   m_day    = cal.day();
26
0
   m_hour   = cal.hour();
27
0
   m_minute = cal.minutes();
28
0
   m_second = cal.seconds();
29
30
0
   m_tag = (m_year >= 2050) ? GENERALIZED_TIME : UTC_TIME;
31
0
   }
32
33
ASN1_Time::ASN1_Time(const std::string& t_spec, ASN1_Tag tag)
34
0
   {
35
0
   set_to(t_spec, tag);
36
0
   }
37
38
void ASN1_Time::encode_into(DER_Encoder& der) const
39
0
   {
40
0
   BOTAN_ARG_CHECK(m_tag == UTC_TIME || m_tag == GENERALIZED_TIME,
41
0
                   "ASN1_Time: Bad encoding tag");
42
43
0
   der.add_object(m_tag, UNIVERSAL, to_string());
44
0
   }
45
46
void ASN1_Time::decode_from(BER_Decoder& source)
47
55.0k
   {
48
55.0k
   BER_Object ber_time = source.get_next_object();
49
50
55.0k
   set_to(ASN1::to_string(ber_time), ber_time.type());
51
55.0k
   }
52
53
std::string ASN1_Time::to_string() const
54
0
   {
55
0
   if(time_is_set() == false)
56
0
      throw Invalid_State("ASN1_Time::to_string: No time set");
57
58
0
   uint32_t full_year = m_year;
59
60
0
   if(m_tag == UTC_TIME)
61
0
      {
62
0
      if(m_year < 1950 || m_year >= 2050)
63
0
         throw Encoding_Error("ASN1_Time: The time " + readable_string() +
64
0
                              " cannot be encoded as a UTCTime");
65
66
0
      full_year = (m_year >= 2000) ? (m_year - 2000) : (m_year - 1900);
67
0
      }
68
69
0
   const uint64_t YEAR_FACTOR = 10000000000ULL;
70
0
   const uint64_t MON_FACTOR  = 100000000;
71
0
   const uint64_t DAY_FACTOR  = 1000000;
72
0
   const uint64_t HOUR_FACTOR = 10000;
73
0
   const uint64_t MIN_FACTOR  = 100;
74
75
0
   const uint64_t int_repr =
76
0
      YEAR_FACTOR * full_year +
77
0
      MON_FACTOR * m_month +
78
0
      DAY_FACTOR * m_day +
79
0
      HOUR_FACTOR * m_hour +
80
0
      MIN_FACTOR * m_minute +
81
0
      m_second;
82
83
0
   std::string repr = std::to_string(int_repr) + "Z";
84
85
0
   uint32_t desired_size = (m_tag == UTC_TIME) ? 13 : 15;
86
87
0
   while(repr.size() < desired_size)
88
0
      repr = "0" + repr;
89
90
0
   return repr;
91
0
   }
92
93
std::string ASN1_Time::readable_string() const
94
5.18k
   {
95
5.18k
   if(time_is_set() == false)
96
0
      throw Invalid_State("ASN1_Time::readable_string: No time set");
97
98
   // desired format: "%04d/%02d/%02d %02d:%02d:%02d UTC"
99
5.18k
   std::stringstream output;
100
5.18k
   output << std::setfill('0')
101
5.18k
          << std::setw(4) << m_year << "/"
102
5.18k
          << std::setw(2) << m_month << "/"
103
5.18k
          << std::setw(2) << m_day
104
5.18k
          << " "
105
5.18k
          << std::setw(2) << m_hour << ":"
106
5.18k
          << std::setw(2) << m_minute << ":"
107
5.18k
          << std::setw(2) << m_second
108
5.18k
          << " UTC";
109
110
5.18k
   return output.str();
111
5.18k
   }
112
113
bool ASN1_Time::time_is_set() const
114
5.18k
   {
115
5.18k
   return (m_year != 0);
116
5.18k
   }
117
118
int32_t ASN1_Time::cmp(const ASN1_Time& other) const
119
0
   {
120
0
   if(time_is_set() == false)
121
0
      throw Invalid_State("ASN1_Time::cmp: No time set");
122
123
0
   const int32_t EARLIER = -1, LATER = 1, SAME_TIME = 0;
124
125
0
   if(m_year < other.m_year)     return EARLIER;
126
0
   if(m_year > other.m_year)     return LATER;
127
0
   if(m_month < other.m_month)   return EARLIER;
128
0
   if(m_month > other.m_month)   return LATER;
129
0
   if(m_day < other.m_day)       return EARLIER;
130
0
   if(m_day > other.m_day)       return LATER;
131
0
   if(m_hour < other.m_hour)     return EARLIER;
132
0
   if(m_hour > other.m_hour)     return LATER;
133
0
   if(m_minute < other.m_minute) return EARLIER;
134
0
   if(m_minute > other.m_minute) return LATER;
135
0
   if(m_second < other.m_second) return EARLIER;
136
0
   if(m_second > other.m_second) return LATER;
137
138
0
   return SAME_TIME;
139
0
   }
140
141
void ASN1_Time::set_to(const std::string& t_spec, ASN1_Tag spec_tag)
142
65.0k
   {
143
65.0k
   if(spec_tag == UTC_OR_GENERALIZED_TIME)
144
5.15k
      {
145
5.15k
      try
146
5.15k
         {
147
5.15k
         set_to(t_spec, GENERALIZED_TIME);
148
5.15k
         return;
149
5.15k
         }
150
4.84k
      catch(Invalid_Argument&) {} // Not a generalized time. Continue
151
152
4.84k
      try
153
4.84k
         {
154
4.84k
         set_to(t_spec, UTC_TIME);
155
4.84k
         return;
156
4.84k
         }
157
316
      catch(Invalid_Argument&) {} // Not a UTC time. Continue
158
159
316
      throw Invalid_Argument("Time string could not be parsed as GeneralizedTime or UTCTime.");
160
59.8k
      }
161
162
59.8k
   BOTAN_ASSERT(spec_tag == UTC_TIME || spec_tag == GENERALIZED_TIME, "Invalid tag.");
163
164
59.8k
   BOTAN_ARG_CHECK(t_spec.size() > 0, "Time string must not be empty.");
165
166
59.8k
   BOTAN_ARG_CHECK(t_spec.back() == 'Z', "Botan does not support times with timezones other than Z");
167
168
59.8k
   if(spec_tag == GENERALIZED_TIME)
169
9.50k
      {
170
9.50k
      BOTAN_ARG_CHECK(t_spec.size() == 15, "Invalid GeneralizedTime string");
171
9.50k
      }
172
50.3k
   else if(spec_tag == UTC_TIME)
173
48.7k
      {
174
48.7k
      BOTAN_ARG_CHECK(t_spec.size() == 13, "Invalid UTCTime string");
175
48.7k
      }
176
177
48.4k
   const size_t YEAR_SIZE = (spec_tag == UTC_TIME) ? 2 : 4;
178
179
59.8k
   std::vector<std::string> params;
180
59.8k
   std::string current;
181
182
175k
   for(size_t j = 0; j != YEAR_SIZE; ++j)
183
115k
      current += t_spec[j];
184
59.8k
   params.push_back(current);
185
59.8k
   current.clear();
186
187
591k
   for(size_t j = YEAR_SIZE; j != t_spec.size() - 1; ++j)
188
531k
      {
189
531k
      current += t_spec[j];
190
531k
      if(current.size() == 2)
191
265k
         {
192
265k
         params.push_back(current);
193
265k
         current.clear();
194
265k
         }
195
531k
      }
196
197
59.8k
   m_year   = to_u32bit(params[0]);
198
59.8k
   m_month  = to_u32bit(params[1]);
199
59.8k
   m_day    = to_u32bit(params[2]);
200
59.8k
   m_hour   = to_u32bit(params[3]);
201
59.8k
   m_minute = to_u32bit(params[4]);
202
52.6k
   m_second = (params.size() == 6) ? to_u32bit(params[5]) : 0;
203
59.8k
   m_tag    = spec_tag;
204
205
59.8k
   if(spec_tag == UTC_TIME)
206
47.9k
      {
207
47.9k
      if(m_year >= 50) m_year += 1900;
208
41.7k
      else             m_year += 2000;
209
47.9k
      }
210
211
59.8k
   if(!passes_sanity_check())
212
2.61k
      throw Invalid_Argument("Time " + t_spec + " does not seem to be valid");
213
59.8k
   }
214
215
/*
216
* Do a general sanity check on the time
217
*/
218
bool ASN1_Time::passes_sanity_check() const
219
52.5k
   {
220
   // AppVeyor's trust store includes a cert with expiration date in 3016 ...
221
52.5k
   if(m_year < 1950 || m_year > 3100)
222
459
      return false;
223
52.1k
   if(m_month == 0 || m_month > 12)
224
452
      return false;
225
226
51.6k
   const uint32_t days_in_month[12] = { 31, 28+1, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 };
227
228
51.6k
   if(m_day == 0 || m_day > days_in_month[m_month-1])
229
444
      return false;
230
231
51.2k
   if(m_month == 2 && m_day == 29)
232
2.56k
      {
233
2.56k
      if(m_year % 4 != 0)
234
202
         return false; // not a leap year
235
236
2.36k
      if(m_year % 100 == 0 && m_year % 400 != 0)
237
200
         return false;
238
50.8k
      }
239
240
50.8k
   if(m_hour >= 24 || m_minute >= 60 || m_second > 60)
241
658
      return false;
242
243
50.1k
   if (m_tag == UTC_TIME)
244
46.5k
      {
245
      /*
246
      UTCTime limits the value of components such that leap seconds
247
      are not covered. See "UNIVERSAL 23" in "Information technology
248
      Abstract Syntax Notation One (ASN.1): Specification of basic notation"
249
250
      http://www.itu.int/ITU-T/studygroups/com17/languages/
251
      */
252
46.5k
      if(m_second > 59)
253
202
         {
254
202
         return false;
255
202
         }
256
49.9k
      }
257
258
49.9k
   return true;
259
49.9k
   }
260
261
std::chrono::system_clock::time_point ASN1_Time::to_std_timepoint() const
262
0
   {
263
0
   return calendar_point(m_year, m_month, m_day, m_hour, m_minute, m_second).to_std_timepoint();
264
0
   }
265
266
uint64_t ASN1_Time::time_since_epoch() const
267
0
   {
268
0
   auto tp = this->to_std_timepoint();
269
0
   return std::chrono::duration_cast<std::chrono::seconds>(tp.time_since_epoch()).count();
270
0
   }
271
272
/*
273
* Compare two ASN1_Times for in various ways
274
*/
275
bool operator==(const ASN1_Time& t1, const ASN1_Time& t2)
276
0
   { return (t1.cmp(t2) == 0); }
277
bool operator!=(const ASN1_Time& t1, const ASN1_Time& t2)
278
0
   { return (t1.cmp(t2) != 0); }
279
280
bool operator<=(const ASN1_Time& t1, const ASN1_Time& t2)
281
0
   { return (t1.cmp(t2) <= 0); }
282
bool operator>=(const ASN1_Time& t1, const ASN1_Time& t2)
283
0
   { return (t1.cmp(t2) >= 0); }
284
285
bool operator<(const ASN1_Time& t1, const ASN1_Time& t2)
286
0
   { return (t1.cmp(t2) < 0); }
287
bool operator>(const ASN1_Time& t1, const ASN1_Time& t2)
288
0
   { return (t1.cmp(t2) > 0); }
289
290
}