crl_ent.cpp

Go to the documentation of this file.

/*
* CRL Entry
* (C) 1999-2010 Jack Lloyd
*
* Botan is released under the Simplified BSD License (see license.txt)
*/
 
#include <botan/x509_crl.h>
 
#include <botan/asn1_obj.h>
#include <botan/asn1_time.h>
#include <botan/ber_dec.h>
#include <botan/bigint.h>
#include <botan/der_enc.h>
#include <botan/x509_ext.h>
#include <botan/x509cert.h>
 
namespace Botan {
 
class CRL_Entry_Data final {
   public:
      CRL_Entry_Data(const X509_Certificate& cert, CRL_Code why) :
            m_serial(cert.serial()),
            m_serial_bits(cert.serial_number()),
            m_time(X509_Time(std::chrono::system_clock::now())),
            m_reason(why) {
         if(why != CRL_Code::Unspecified) {
            m_extensions.add(std::make_unique<Cert_Extension::CRL_ReasonCode>(why));
         }
      }
 
      CRL_Entry_Data() = default;
 
      // NOLINTBEGIN(*non-private-member-variables-in-classes)
      X509_Serial_Number m_serial;
      std::vector<uint8_t> m_serial_bits;
      X509_Time m_time;
      CRL_Code m_reason = CRL_Code::Unspecified;
      Extensions m_extensions;
      // NOLINTEND(*non-private-member-variables-in-classes)
};
 
/*
* Create a CRL_Entry
*/
CRL_Entry::CRL_Entry(const X509_Certificate& cert, CRL_Code why) {
   m_data = std::make_shared<CRL_Entry_Data>(cert, why);
}
 
/*
* Compare two CRL_Entry structs for equality
*/
bool operator==(const CRL_Entry& a1, const CRL_Entry& a2) {
   if(a1.serial() != a2.serial()) {
      return false;
   }
   if(a1.expire_time() != a2.expire_time()) {
      return false;
   }
   if(a1.reason_code() != a2.reason_code()) {
      return false;
   }
   return true;
}
 
/*
* Compare two CRL_Entry structs for inequality
*/
bool operator!=(const CRL_Entry& a1, const CRL_Entry& a2) {
   return !(a1 == a2);
}
 
/*
* DER encode a CRL_Entry
*/
void CRL_Entry::encode_into(DER_Encoder& der) const {
   der.start_sequence().encode(serial()).encode(expire_time());
 
   if(extensions().count() > 0) {
      der.start_sequence().encode(extensions()).end_cons();
   }
 
   der.end_cons();
}
 
/*
* Decode a BER encoded CRL_Entry
*/
void CRL_Entry::decode_from(BER_Decoder& source) {
   auto data = std::make_unique<CRL_Entry_Data>();
 
   BER_Decoder entry = source.start_sequence();
 
   entry.decode(data->m_serial);
   entry.decode(data->m_time);
 
   data->m_serial_bits = data->m_serial.magnitude();
 
   if(entry.more_items()) {
      data->m_extensions.decode_from(entry, Extension_Context::CRL_Entry);
 
      // TODO(Botan4) start checking that CRLEntry extensions is not empty
      // Extensions  ::=  SEQUENCE SIZE (1..MAX) OF Extension
 
      if(const auto* ext = data->m_extensions.get_extension_object_as<Cert_Extension::CRL_ReasonCode>()) {
         const auto reason = ext->get_reason();
 
         /*
         * This reason code only makes sense in the context of delta CRL processing, which
         * we do not currently support. Seeing it in a regular CRL suggests that something
         * has gone very wrong (eg we are somehow processing a delta CRL, though that
         * shouldn't happen since the delta CRL indicator extension should be a critical
         * extension which we will reject.)
         */
         if(reason == CRL_Code::RemoveFromCrl) {
            throw Decoding_Error("CRL entry ReasonCode extension included invalid RemoveFromCrl");
         }
         data->m_reason = reason;
      } else {
         data->m_reason = CRL_Code::Unspecified;
      }
   }
 
   entry.end_cons();
 
   m_data = std::move(data);
}
 
const CRL_Entry_Data& CRL_Entry::data() const {
   if(!m_data) {
      throw Invalid_State("CRL_Entry_Data uninitialized");
   }
 
   return *m_data;
}
 
const std::vector<uint8_t>& CRL_Entry::serial_number() const {
   return data().m_serial_bits;
}
 
const X509_Serial_Number& CRL_Entry::serial() const {
   return data().m_serial;
}
 
const X509_Time& CRL_Entry::expire_time() const {
   return data().m_time;
}
 
CRL_Code CRL_Entry::reason_code() const {
   return data().m_reason;
}
 
const Extensions& CRL_Entry::extensions() const {
   return data().m_extensions;
}
 
}  // namespace Botan