Botan::ASN1_Time Class Reference

#include <asn1_obj.h>

Inheritance diagram for Botan::ASN1_Time:

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

Detailed Description

Time (GeneralizedTime/UniversalTime)

Definition at line 327 of file asn1_obj.h.

Constructor & Destructor Documentation

ASN1_Time() [1/3]

Botan::ASN1_Time::ASN1_Time ( )

default

Create an invalid ASN1_Time.

ASN1_Time() [2/3]

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

explicit

Create a ASN1_Time from a time point.

Definition at line 19 of file asn1_time.cpp.

   {
   calendar_point cal = calendar_value(time);
 
   m_year   = cal.get_year();
   m_month  = cal.get_month();
   m_day    = cal.get_day();
   m_hour   = cal.get_hour();
   m_minute = cal.get_minutes();
   m_second = cal.get_seconds();
 
   m_tag = (m_year >= 2050) ? GENERALIZED_TIME : UTC_TIME;
   }

References Botan::calendar_value(), Botan::GENERALIZED_TIME, Botan::calendar_point::get_day(), Botan::calendar_point::get_hour(), Botan::calendar_point::get_minutes(), Botan::calendar_point::get_month(), Botan::calendar_point::get_seconds(), Botan::calendar_point::get_year(), and Botan::UTC_TIME.

ASN1_Time() [3/3]

Botan::ASN1_Time::ASN1_Time	(	const std::string &	t_spec,
		ASN1_Tag	tag
	)

Create an ASN1_Time from string.

Definition at line 33 of file asn1_time.cpp.

   {
   set_to(t_spec, tag);
   }

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 16 of file asn1_obj.cpp.

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

References Botan::ASN1_Object::encode_into().

Referenced by Botan::PSSR::config_for_x509(), 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::Certificate_Store_In_SQL::revoke_cert().

cmp()

int32_t Botan::ASN1_Time::cmp

(

const ASN1_Time &

other

)

const

Compare this time against another.

Definition at line 118 of file asn1_time.cpp.

   {
   if(time_is_set() == false)
      throw Invalid_State("ASN1_Time::cmp: No time set");
 
   const int32_t EARLIER = -1, LATER = 1, 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 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 46 of file asn1_time.cpp.

   {
   BER_Object ber_time = source.get_next_object();
 
   set_to(ASN1::to_string(ber_time), ber_time.type());
   }

References Botan::BER_Decoder::get_next_object(), Botan::ASN1::to_string(), and Botan::BER_Object::type().

encode_into()

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

overridevirtual

DER encode a ASN1_Time.

Implements Botan::ASN1_Object.

Definition at line 38 of file asn1_time.cpp.

   {
   BOTAN_ARG_CHECK(m_tag == UTC_TIME || m_tag == GENERALIZED_TIME,
                   "ASN1_Time: Bad encoding tag");
 
   der.add_object(m_tag, UNIVERSAL, to_string());
   }

References Botan::DER_Encoder::add_object(), BOTAN_ARG_CHECK, Botan::GENERALIZED_TIME, to_string(), Botan::UNIVERSAL, and Botan::UTC_TIME.

readable_string()

std::string Botan::ASN1_Time::readable_string

(

)

const

Returns a human friendly string replesentation of no particular formatting.

Definition at line 93 of file asn1_time.cpp.

   {
   if(time_is_set() == false)
      throw Invalid_State("ASN1_Time::readable_string: No time set");
 
   // desired format: "%04d/%02d/%02d %02d:%02d:%02d UTC"
   std::stringstream output;
   output << std::setfill('0')
          << std::setw(4) << m_year << "/"
          << std::setw(2) << m_month << "/"
          << std::setw(2) << m_day
          << " "
          << std::setw(2) << m_hour << ":"
          << std::setw(2) << m_minute << ":"
          << std::setw(2) << m_second
          << " UTC";
 
   return output.str();
   }

References time_is_set().

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

time_is_set()

bool Botan::ASN1_Time::time_is_set

(

)

const

Return if the time has been set somehow.

Definition at line 113 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 266 of file asn1_time.cpp.

   {
   auto tp = this->to_std_timepoint();
   return std::chrono::duration_cast<std::chrono::seconds>(tp.time_since_epoch()).count();
   }

References to_std_timepoint().

to_std_timepoint()

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

(

)

const

Returns a STL timepoint object.

Definition at line 261 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 time_since_epoch().

to_string()

std::string Botan::ASN1_Time::to_string

(

)

const

Return an internal string representation of the time.

Definition at line 53 of file asn1_time.cpp.

   {
   if(time_is_set() == false)
      throw Invalid_State("ASN1_Time::to_string: No time set");
 
   uint32_t full_year = m_year;
 
   if(m_tag == UTC_TIME)
      {
      if(m_year < 1950 || m_year >= 2050)
         throw Encoding_Error("ASN1_Time: The time " + readable_string() +
                              " cannot be encoded as a UTCTime");
 
      full_year = (m_year >= 2000) ? (m_year - 2000) : (m_year - 1900);
      }
 
   const uint64_t YEAR_FACTOR = 10000000000ULL;
   const uint64_t MON_FACTOR  = 100000000;
   const uint64_t DAY_FACTOR  = 1000000;
   const uint64_t HOUR_FACTOR = 10000;
   const uint64_t MIN_FACTOR  = 100;
 
   const uint64_t int_repr =
      YEAR_FACTOR * full_year +
      MON_FACTOR * m_month +
      DAY_FACTOR * m_day +
      HOUR_FACTOR * m_hour +
      MIN_FACTOR * m_minute +
      m_second;
 
   std::string repr = std::to_string(int_repr) + "Z";
 
   uint32_t desired_size = (m_tag == UTC_TIME) ? 13 : 15;
 
   while(repr.size() < desired_size)
      repr = "0" + repr;
 
   return repr;
   }

References readable_string(), time_is_set(), Botan::ASN1::to_string(), and Botan::UTC_TIME.

Referenced by encode_into(), and Botan::X509_Certificate::subject_info().

---

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

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