Botan::EAC_Time Class Reference

#include <eac_asn_obj.h>

Inheritance diagram for Botan::EAC_Time:

Public Member Functions
void	add_months (u32bit months)
void	add_years (u32bit years)
std::string	as_string () const
s32bit	cmp (const EAC_Time &other) const
void	decode_from (class BER_Decoder &)
	EAC_Time (const std::string &, ASN1_Tag=ASN1_Tag(0))
	EAC_Time (u32bit year, u32bit month, u32bit day, ASN1_Tag=ASN1_Tag(0))
	EAC_Time (u64bit, ASN1_Tag t=ASN1_Tag(0))
void	encode_into (class DER_Encoder &) const
u32bit	get_day () const
u32bit	get_month () const
u32bit	get_year () const
std::string	readable_string () const
void	set_to (const std::string &str)
bool	time_is_set () const
virtual	~EAC_Time ()

Detailed Description

This class represents CVC EAC Time objects. It only models year, month and day. Only limited sanity checks of the inputted date value are performed.

Definition at line 21 of file eac_asn_obj.h.

Constructor & Destructor Documentation

EAC_Time() [1/3]

Botan::EAC_Time::EAC_Time	(	u64bit	timer,
		ASN1_Tag	t = ASN1_Tag(0) )

Definition at line 54 of file asn1_eac_tm.cpp.

                                           : tag(t)
   {
   calendar_point cal = calendar_value(timer);
 
   year   = cal.year;
   month  = cal.month;
   day    = cal.day;
   }

References Botan::calendar_value(), Botan::calendar_point::day, Botan::calendar_point::month, and Botan::calendar_point::year.

Referenced by Botan::ASN1_Ced::ASN1_Ced(), Botan::ASN1_Ced::ASN1_Ced(), Botan::ASN1_Ced::ASN1_Ced(), Botan::ASN1_Cex::ASN1_Cex(), Botan::ASN1_Cex::ASN1_Cex(), Botan::ASN1_Cex::ASN1_Cex(), and cmp().

EAC_Time() [2/3]

Botan::EAC_Time::EAC_Time	(	const std::string &	t_spec,
		ASN1_Tag	t = ASN1_Tag(0) )

Definition at line 66 of file asn1_eac_tm.cpp.

                                                      : tag(t)
   {
   set_to(t_spec);
   }

References set_to().

EAC_Time() [3/3]

Botan::EAC_Time::EAC_Time	(	u32bit	year,
		u32bit	month,
		u32bit	day,
		ASN1_Tag	t = ASN1_Tag(0) )

Definition at line 73 of file asn1_eac_tm.cpp.

                                                           :
   year(y), month(m), day(d), tag(t)
   {
   }

~EAC_Time()

virtual Botan::EAC_Time::~EAC_Time ( )

inlinevirtual

Definition at line 96 of file eac_asn_obj.h.

{}

Member Function Documentation

add_months()

void Botan::EAC_Time::add_months

(

u32bit

months

)

Add the specified number of months to this.

Parameters

months

the number of months to add

Definition at line 190 of file asn1_eac_tm.cpp.

   {
   year += months/12;
   month += months % 12;
   if(month > 12)
      {
      year += 1;
      month -= 12;
      }
   }

Referenced by Botan::DE_EAC::create_cvca(), and Botan::DE_EAC::sign_request().

add_years()

void Botan::EAC_Time::add_years

(

u32bit

years

)

Add the specified number of years to this.

Parameters

years

the number of years to add

Definition at line 186 of file asn1_eac_tm.cpp.

   {
   year += years;
   }

as_string()

std::string Botan::EAC_Time::as_string

(

)

const

Get a this objects value as a string.

Returns

date string

Definition at line 130 of file asn1_eac_tm.cpp.

   {
   if (time_is_set() == false)
      throw Invalid_State("EAC_Time::as_string: No time set");
 
   std::string asn1rep;
   asn1rep = to_string(year, 2);
 
   asn1rep += to_string(month, 2) + to_string(day, 2);
 
   return asn1rep;
   }

References Botan::Invalid_State::Invalid_State(), time_is_set(), and Botan::to_string().

Referenced by Botan::DE_EAC::link_cvca().

cmp()

s32bit Botan::EAC_Time::cmp

(

const EAC_Time &

other

)

const

Compare this to another EAC_Time object.

Returns

-1 if this object's date is earlier than other, +1 in the opposite case, and 0 if both dates are equal.

Definition at line 205 of file asn1_eac_tm.cpp.

   {
   if (time_is_set() == false)
      throw Invalid_State("EAC_Time::cmp: No time set");
 
   const s32bit EARLIER = -1, LATER = 1, SAME_TIME = 0;
 
   if (year < other.year)     return EARLIER;
   if (year > other.year)     return LATER;
   if (month < other.month)   return EARLIER;
   if (month > other.month)   return LATER;
   if (day < other.day)       return EARLIER;
   if (day > other.day)       return LATER;
 
   return SAME_TIME;
   }

References EAC_Time(), Botan::Invalid_State::Invalid_State(), and time_is_set().

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

decode_from()

void Botan::EAC_Time::decode_from ( class BER_Decoder & from )

virtual

Decode whatever this object is from from

Parameters

from	the BER_Decoder that will be read from

Implements Botan::ASN1_Object.

Definition at line 258 of file asn1_eac_tm.cpp.

   {
   BER_Object obj = source.get_next_object();
 
   if(obj.type_tag != this->tag)
      throw BER_Decoding_Error("Tag mismatch when decoding");
 
   if(obj.value.size() != 6)
      {
      throw Decoding_Error("EAC_Time decoding failed");
      }
 
   try
      {
      u32bit tmp_year = dec_two_digit(obj.value[0], obj.value[1]);
      u32bit tmp_mon = dec_two_digit(obj.value[2], obj.value[3]);
      u32bit tmp_day = dec_two_digit(obj.value[4], obj.value[5]);
      year = tmp_year + 2000;
      month = tmp_mon;
      day = tmp_day;
      }
   catch (Invalid_Argument)
      {
      throw Decoding_Error("EAC_Time decoding failed");
      }
 
   }

References Botan::BER_Decoding_Error::BER_Decoding_Error(), Botan::Decoding_Error::Decoding_Error(), Botan::BER_Decoder::get_next_object(), Botan::MemoryRegion< T >::size(), Botan::BER_Object::type_tag, and Botan::BER_Object::value.

encode_into()

void Botan::EAC_Time::encode_into ( class DER_Encoder & to ) const

virtual

Encode whatever this object is into to

Parameters

to	the DER_Encoder that will be written to

Implements Botan::ASN1_Object.

Definition at line 121 of file asn1_eac_tm.cpp.

   {
   der.add_object(tag, APPLICATION,
                  encoded_eac_time());
   }

References Botan::DER_Encoder::add_object(), and Botan::APPLICATION.

get_day()

u32bit Botan::EAC_Time::get_day

(

)

const

Get the day value of this objects.

Returns

day value

Definition at line 296 of file asn1_eac_tm.cpp.

   {
   return day;
   }

Referenced by Botan::ASN1_Ced::ASN1_Ced(), and Botan::ASN1_Cex::ASN1_Cex().

get_month()

u32bit Botan::EAC_Time::get_month

(

)

const

Get the month value of this objects.

Returns

month value

Definition at line 291 of file asn1_eac_tm.cpp.

   {
   return month;
   }

Referenced by Botan::ASN1_Ced::ASN1_Ced(), and Botan::ASN1_Cex::ASN1_Cex().

get_year()

u32bit Botan::EAC_Time::get_year

(

)

const

Get the year value of this objects.

Returns

year value

Definition at line 286 of file asn1_eac_tm.cpp.

   {
   return year;
   }

Referenced by Botan::ASN1_Ced::ASN1_Ced(), and Botan::ASN1_Cex::ASN1_Cex().

readable_string()

std::string Botan::EAC_Time::readable_string

(

)

const

Get a this objects value as a readable formatted string.

Returns

date string

Definition at line 154 of file asn1_eac_tm.cpp.

   {
   if (time_is_set() == false)
      throw Invalid_State("EAC_Time::readable_string: No time set");
 
   std::string readable;
   readable += to_string(year,     2) + "/";
   readable += to_string(month,    2) + "/";
   readable += to_string(day,      2) + " ";
 
   return readable;
   }

References Botan::Invalid_State::Invalid_State(), time_is_set(), and Botan::to_string().

set_to()

void Botan::EAC_Time::set_to

(

const std::string &

str

)

Set this' value by a string value.

Parameters

str	a string in the format "yyyy mm dd", e.g. "2007 08 01"

Definition at line 81 of file asn1_eac_tm.cpp.

   {
   if (time_str == "")
      {
      year = month = day = 0;
      return;
      }
 
   std::vector<std::string> params;
   std::string current;
 
   for (u32bit j = 0; j != time_str.size(); ++j)
      {
      if (Charset::is_digit(time_str[j]))
         current += time_str[j];
      else
         {
         if (current != "")
            params.push_back(current);
         current.clear();
         }
      }
   if (current != "")
      params.push_back(current);
 
   if (params.size() != 3)
      throw Invalid_Argument("Invalid time specification " + time_str);
 
   year   = to_u32bit(params[0]);
   month  = to_u32bit(params[1]);
   day    = to_u32bit(params[2]);
 
   if (!passes_sanity_check())
      throw Invalid_Argument("Invalid time specification " + time_str);
   }

References Botan::Charset::is_digit(), and Botan::to_u32bit().

Referenced by EAC_Time().

time_is_set()

bool Botan::EAC_Time::time_is_set

(

)

const

Find out whether this object's values have been set.

Returns

true if this object's internal values are set

Definition at line 146 of file asn1_eac_tm.cpp.

   {
   return (year != 0);
   }

Referenced by as_string(), cmp(), and readable_string().

---

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

• src/cert/cvc/eac_asn_obj.h
• src/cert/cvc/asn1_eac_tm.cpp