Botan::ASN1_Time Class Reference

#include <asn1_time.h>

Inheritance diagram for Botan::ASN1_Time:

Public Member Functions
	ASN1_Time ()=default
	Create an invalid ASN1_Time.
	ASN1_Time (const std::chrono::system_clock::time_point &time)
	Create a ASN1_Time from a time point.
BOTAN_FUTURE_EXPLICIT	ASN1_Time (std::string_view t_spec)
	Create an ASN1_Time from string.
	ASN1_Time (std::string_view t_spec, ASN1_Type tag)
	Create an ASN1_Time from string and a specified tagging (Utc or Generalized).
std::vector< uint8_t >	BER_encode () const
int32_t	cmp (const ASN1_Time &other) const
	Compare this time against another.
void	decode_from (BER_Decoder &from) override
void	encode_into (DER_Encoder &to) const override
	DER encode a ASN1_Time.
std::string	readable_string () const
	Returns a human friendly string representation of no particular formatting.
ASN1_Type	tagging () const
	Return the tag (UtcTime or GeneralizedTime) this time was encoded with.
bool	time_is_set () const
	Return if the time has been set somehow.
uint64_t	time_since_epoch () const
	Return time since epoch.
std::chrono::system_clock::time_point	to_std_timepoint () const
	Returns a STL timepoint object.
std::string	to_string () const
	Return an internal string representation of the time.

Static Public Member Functions
static ASN1_Time	from_seconds_since_epoch (uint64_t seconds)
	Create an ASN1_Time from seconds since epoch.
static ASN1_Time	from_string (std::string_view t_spec)
static ASN1_Time	from_string (std::string_view t_spec, ASN1_Type tag)
static ASN1_Time	from_time_point (const std::chrono::system_clock::time_point &time)
	Create a ASN1_Time from a time point.

Detailed Description

Time (GeneralizedTime/UniversalTime)

Definition at line 18 of file asn1_time.h.

Constructor & Destructor Documentation

ASN1_Time() [1/4]

Botan::ASN1_Time::ASN1_Time ( )

default

Create an invalid ASN1_Time.

References ASN1_Time(), from_seconds_since_epoch(), from_string(), and from_time_point().

Referenced by ASN1_Time(), cmp(), from_seconds_since_epoch(), from_string(), from_string(), and from_time_point().

ASN1_Time() [2/4]

Botan::ASN1_Time::ASN1_Time ( const std::chrono::system_clock::time_point & time )

inlineexplicit

Create a ASN1_Time from a time point.

Definition at line 64 of file asn1_time.h.

                                                                      {
         *this = ASN1_Time::from_time_point(time);
      }

References from_time_point().

ASN1_Time() [3/4]

BOTAN_FUTURE_EXPLICIT Botan::ASN1_Time::ASN1_Time ( std::string_view t_spec )

inline

Create an ASN1_Time from string.

Definition at line 69 of file asn1_time.h.

{ *this = ASN1_Time::from_string(t_spec); }

References BOTAN_FUTURE_EXPLICIT, and from_string().

ASN1_Time() [4/4]

Botan::ASN1_Time::ASN1_Time ( std::string_view t_spec, ASN1_Type tag )

inline

Create an ASN1_Time from string and a specified tagging (Utc or Generalized).

Definition at line 72 of file asn1_time.h.

{ *this = ASN1_Time::from_string(t_spec, tag); }

References from_string().

Member Function Documentation

BER_encode()

std::vector< uint8_t > Botan::ASN1_Object::BER_encode ( ) const

inherited

Return the encoding of this object. This is a convenience method when just one object needs to be serialized. Use DER_Encoder for complicated encodings.

Definition at line 21 of file asn1_obj.cpp.

                                                 {
   std::vector<uint8_t> output;
   DER_Encoder der(output);
   this->encode_into(der);
   return output;
}

References encode_into().

Referenced by decode_from(), Botan::PKCS12::export_to(), Botan::Certificate_Store_In_SQL::find_all_certs(), Botan::Certificate_Store_In_SQL::find_cert(), Botan::X509_Certificate::fingerprint(), Botan::Certificate_Store_In_SQL::insert_cert(), Botan::X509_Object::PEM_encode(), and Botan::PSS_Params::PSS_Params().

cmp()

int32_t Botan::ASN1_Time::cmp

(

const ASN1_Time &

other

)

const

Compare this time against another.

Definition at line 237 of file asn1_time.cpp.

                                                   {
   if(!time_is_set() || !other.time_is_set()) {
      throw Invalid_State("ASN1_Time::cmp: Cannot compare empty times");
   }
 
   constexpr int32_t EARLIER = -1;
   constexpr int32_t LATER = 1;
   constexpr int32_t SAME_TIME = 0;
 
   if(m_year < other.m_year) {
      return EARLIER;
   }
   if(m_year > other.m_year) {
      return LATER;
   }
   if(m_month < other.m_month) {
      return EARLIER;
   }
   if(m_month > other.m_month) {
      return LATER;
   }
   if(m_day < other.m_day) {
      return EARLIER;
   }
   if(m_day > other.m_day) {
      return LATER;
   }
   if(m_hour < other.m_hour) {
      return EARLIER;
   }
   if(m_hour > other.m_hour) {
      return LATER;
   }
   if(m_minute < other.m_minute) {
      return EARLIER;
   }
   if(m_minute > other.m_minute) {
      return LATER;
   }
   if(m_second < other.m_second) {
      return EARLIER;
   }
   if(m_second > other.m_second) {
      return LATER;
   }
 
   return SAME_TIME;
}

References ASN1_Time(), and time_is_set().

Referenced by Botan::operator!=(), Botan::operator<(), Botan::operator<=(), Botan::operator==(), Botan::operator>(), and Botan::operator>=().

decode_from()

void Botan::ASN1_Time::decode_from ( BER_Decoder & from )

overridevirtual

Decode whatever this object is from from

Parameters

from	the BER_Decoder that will be read from

Implements Botan::ASN1_Object.

Definition at line 168 of file asn1_time.cpp.

                                               {
   const BER_Object ber_time = source.get_next_object();
 
   if(ber_time.get_class() != ASN1_Class::Universal ||
      (ber_time.type() != ASN1_Type::UtcTime && ber_time.type() != ASN1_Type::GeneralizedTime)) {
      throw Decoding_Error(fmt("ASN1_Time: Unexpected tag {}/{}",
                               static_cast<uint32_t>(ber_time.type()),
                               static_cast<uint32_t>(ber_time.get_class())));
   }
 
   try {
      // Assigning only after a successful parse means that a decoding error
      // cannot leave this object in a partially written state
      *this = ASN1_Time::from_string(ASN1::to_string(ber_time), ber_time.type());
   } catch(Invalid_Argument& e) {
      throw Decoding_Error(fmt("Invalid ASN1_Time encoding: {}", e.what()));
   }
}

References Botan::fmt(), from_string(), Botan::GeneralizedTime, Botan::BER_Object::get_class(), Botan::BER_Decoder::get_next_object(), Botan::ASN1::to_string(), Botan::BER_Object::type(), Botan::Universal, Botan::UtcTime, and Botan::Exception::what().

encode_into()

void Botan::ASN1_Time::encode_into ( DER_Encoder & to ) const

overridevirtual

DER encode a ASN1_Time.

Implements Botan::ASN1_Object.

Definition at line 162 of file asn1_time.cpp.

                                                  {
   BOTAN_ARG_CHECK(m_tag == ASN1_Type::UtcTime || m_tag == ASN1_Type::GeneralizedTime, "ASN1_Time: Bad encoding tag");
 
   der.add_object(m_tag, ASN1_Class::Universal, to_string());
}

References Botan::DER_Encoder::add_object(), BOTAN_ARG_CHECK, Botan::GeneralizedTime, to_string(), Botan::Universal, and Botan::UtcTime.

from_seconds_since_epoch()

ASN1_Time Botan::ASN1_Time::from_seconds_since_epoch ( uint64_t seconds )

static

Create an ASN1_Time from seconds since epoch.

Definition at line 37 of file asn1_time.cpp.

                                                                       {
   return ASN1_Time::from_time_point(std::chrono::system_clock::time_point(std::chrono::seconds(time_since_epoch)));
}

References ASN1_Time(), from_time_point(), and time_since_epoch().

Referenced by ASN1_Time().

from_string() [1/2]

ASN1_Time Botan::ASN1_Time::from_string ( std::string_view t_spec )

static

Create a ASN1_Time from a string

Only the fixed 13 or 15 char RFC 5280 format (eg [YY]YYMMDDHHMMSSZ) is accepted, tag is set based on the use of 2 or 4 digit year, 2-digit years use the 1950 breakeven point (see RFC 5280 Section 4.1.2.5.1)

Definition at line 152 of file asn1_time.cpp.

                                                      {
   if(t_spec.size() == 13) {
      return ASN1_Time::from_string(t_spec, ASN1_Type::UtcTime);
   } else if(t_spec.size() == 15) {
      return ASN1_Time::from_string(t_spec, ASN1_Type::GeneralizedTime);
   } else {
      throw Invalid_Argument("Time string could not be parsed as GeneralizedTime or UTCTime.");
   }
}

References ASN1_Time(), from_string(), Botan::GeneralizedTime, and Botan::UtcTime.

Referenced by ASN1_Time(), ASN1_Time(), ASN1_Time(), decode_from(), and from_string().

from_string() [2/2]

ASN1_Time Botan::ASN1_Time::from_string ( std::string_view t_spec, ASN1_Type tag )

static

Create a ASN1_Time from a string

Only the fixed 13 or 15 char RFC 5280 format (eg [YY]YYMMDDHHMMSSZ) is accepted, based on the provided tag (which must be UtcTime or GeneralizedTime)

Definition at line 109 of file asn1_time.cpp.

                                                                     {
   BOTAN_ARG_CHECK(tag == ASN1_Type::UtcTime || tag == ASN1_Type::GeneralizedTime, "Invalid tag for ASN1_Time");
 
   if(tag == ASN1_Type::GeneralizedTime) {
      BOTAN_ARG_CHECK(t_spec.size() == 15, "Invalid GeneralizedTime input string");
   } else {
      BOTAN_ARG_CHECK(t_spec.size() == 13, "Invalid UTCTime input string");
   }
 
   BOTAN_ARG_CHECK(t_spec.back() == 'Z', "Botan does not support ASN1 times with timezones other than Z");
 
   const size_t field_len = 2;
   const size_t year_len = (tag == ASN1_Type::UtcTime) ? 2 : 4;
 
   const size_t year_start = 0;
   const size_t month_start = year_start + year_len;
   const size_t day_start = month_start + field_len;
   const size_t hour_start = day_start + field_len;
   const size_t min_start = hour_start + field_len;
   const size_t sec_start = min_start + field_len;
 
   uint32_t year = to_u32bit(t_spec.substr(year_start, year_len));
   const uint32_t month = to_u32bit(t_spec.substr(month_start, field_len));
   const uint32_t day = to_u32bit(t_spec.substr(day_start, field_len));
   const uint32_t hour = to_u32bit(t_spec.substr(hour_start, field_len));
   const uint32_t minute = to_u32bit(t_spec.substr(min_start, field_len));
   const uint32_t second = to_u32bit(t_spec.substr(sec_start, field_len));
 
   if(tag == ASN1_Type::UtcTime) {
      // Interpret the two digit year by the 1950/2050 split (RFC 5280 Section 4.1.2.5.1)
      year += (year >= 50) ? 1900 : 2000;
   }
 
   return ASN1_Time(static_cast<uint16_t>(year),
                    static_cast<uint8_t>(month),
                    static_cast<uint8_t>(day),
                    static_cast<uint8_t>(hour),
                    static_cast<uint8_t>(minute),
                    static_cast<uint8_t>(second),
                    tag);
}

References ASN1_Time(), BOTAN_ARG_CHECK, Botan::GeneralizedTime, Botan::to_u32bit(), and Botan::UtcTime.

from_time_point()

ASN1_Time Botan::ASN1_Time::from_time_point ( const std::chrono::system_clock::time_point & time )

static

Create a ASN1_Time from a time point.

Definition at line 94 of file asn1_time.cpp.

                                                                                {
   const calendar_point cal(time);
 
   const ASN1_Type tag = (cal.year() >= 2050) ? ASN1_Type::GeneralizedTime : ASN1_Type::UtcTime;
 
   return ASN1_Time(static_cast<uint16_t>(cal.year()),
                    static_cast<uint8_t>(cal.month()),
                    static_cast<uint8_t>(cal.day()),
                    static_cast<uint8_t>(cal.hour()),
                    static_cast<uint8_t>(cal.minutes()),
                    static_cast<uint8_t>(cal.seconds()),
                    tag);
}

References ASN1_Time(), Botan::calendar_point::day(), Botan::GeneralizedTime, Botan::calendar_point::hour(), Botan::calendar_point::minutes(), Botan::calendar_point::month(), Botan::calendar_point::seconds(), Botan::UtcTime, and Botan::calendar_point::year().

Referenced by ASN1_Time(), ASN1_Time(), and from_seconds_since_epoch().

readable_string()

std::string Botan::ASN1_Time::readable_string

(

)

const

Returns a human friendly string representation of no particular formatting.

Definition at line 218 of file asn1_time.cpp.

                                           {
   if(!time_is_set()) {
      throw Invalid_State("ASN1_Time::readable_string: No time set");
   }
 
   // desired format: "YYYY/MM/DD HH:MM:SS UTC"
 
   std::ostringstream out;
 
   out << zero_pad(m_year, 4) << "/" << zero_pad(m_month, 2) << "/" << zero_pad(m_day, 2) << " ";
   out << zero_pad(m_hour, 2) << ":" << zero_pad(m_minute, 2) << ":" << zero_pad(m_second, 2) << " UTC";
 
   return out.str();
}

References time_is_set().

Referenced by to_string(), and Botan::X509_Certificate::to_string().

tagging()

ASN1_Type Botan::ASN1_Time::tagging ( ) const

inline

Return the tag (UtcTime or GeneralizedTime) this time was encoded with.

Definition at line 36 of file asn1_time.h.

{ return m_tag; }

time_is_set()

bool Botan::ASN1_Time::time_is_set

(

)

const

Return if the time has been set somehow.

Definition at line 233 of file asn1_time.cpp.

                                  {
   return (m_year != 0);
}

Referenced by cmp(), readable_string(), Botan::Certificate_Store_In_SQL::revoke_cert(), and to_string().

time_since_epoch()

uint64_t Botan::ASN1_Time::time_since_epoch

(

)

const

Return time since epoch.

Definition at line 290 of file asn1_time.cpp.

                                           {
   const int64_t tse = calendar_point(m_year, m_month, m_day, m_hour, m_minute, m_second).seconds_since_epoch();
 
   if(tse >= 0) {
      return static_cast<uint64_t>(tse);
   } else {
      throw Encoding_Error("ASN1_Time::time_since_epoch value is prior to epoch");
   }
}

References Botan::calendar_point::seconds_since_epoch().

Referenced by botan_x509_crl_entry_revocation_date(), and from_seconds_since_epoch().

to_std_timepoint()

std::chrono::system_clock::time_point Botan::ASN1_Time::to_std_timepoint

(

)

const

Returns a STL timepoint object.

Definition at line 286 of file asn1_time.cpp.

                                                                  {
   return calendar_point(m_year, m_month, m_day, m_hour, m_minute, m_second).to_std_timepoint();
}

References Botan::calendar_point::to_std_timepoint().

Referenced by Botan::Certificate_Store_In_SQL::revoke_cert().

to_string()

std::string Botan::ASN1_Time::to_string

(

)

const

Return an internal string representation of the time.

Definition at line 187 of file asn1_time.cpp.

                                     {
   if(!time_is_set()) {
      throw Invalid_State("ASN1_Time::to_string: No time set");
   }
 
   BOTAN_ASSERT_NOMSG(m_year <= 9999);
 
   std::ostringstream out;
 
   // UTCTime uses a 2 digit year, GeneralizedTime a 4 digit year
   if(m_tag == ASN1_Type::UtcTime) {
      if(m_year < 1950 || m_year >= 2050) {
         throw Encoding_Error(fmt("ASN_Time: The time {} cannot be encoded as UTCTime", readable_string()));
      }
 
      out << (zero_pad((m_year >= 2000) ? (m_year - 2000) : (m_year - 1900), 2));
   } else {
      out << zero_pad(m_year, 4);
   }
 
   // clang-format off
   out << zero_pad(m_month, 2)
       << zero_pad(m_day, 2)
       << zero_pad(m_hour, 2)
       << zero_pad(m_minute, 2)
       << zero_pad(m_second, 2) << "Z";
   // clang-format on
 
   return out.str();
}

References BOTAN_ASSERT_NOMSG, Botan::fmt(), readable_string(), time_is_set(), and Botan::UtcTime.

Referenced by encode_into().

---

The documentation for this class was generated from the following files:

• src/lib/asn1/asn1_time.h
• src/lib/asn1/asn1_time.cpp