Botan 3.14.1
Crypto and TLS for C&
Botan::CRL_Entry Class Referencefinal

#include <x509_crl.h>

Inheritance diagram for Botan::CRL_Entry:
Botan::ASN1_Object

Public Member Functions

std::vector< uint8_t > BER_encode () const
 CRL_Entry ()=default
BOTAN_FUTURE_EXPLICIT CRL_Entry (const X509_Certificate &cert, CRL_Code reason=CRL_Code::Unspecified)
void decode_from (BER_Decoder &from) override
void encode_into (DER_Encoder &to) const override
const X509_Time & expire_time () const
const Extensions & extensions () const
CRL_Code reason_code () const
const X509_Serial_Number & serial () const
const std::vector< uint8_t > & serial_number () const

Friends

class X509_CRL

Detailed Description

This class represents CRL entries

Definition at line 32 of file x509_crl.h.

Constructor & Destructor Documentation

◆ CRL_Entry() [1/2]

Botan::CRL_Entry::CRL_Entry ( )
default

Create uninitialized CRL_Entry object

References BOTAN_FUTURE_EXPLICIT, CRL_Entry(), and Botan::Unspecified.

Referenced by CRL_Entry().

◆ CRL_Entry() [2/2]

Botan::CRL_Entry::CRL_Entry ( const X509_Certificate & cert,
CRL_Code reason = CRL_Code::Unspecified )

Construct an CRL entry.

Parameters
certthe certificate to revoke
reasonthe reason code to set in the entry

Definition at line 45 of file crl_ent.cpp.

45 {
46 m_data = std::make_shared<CRL_Entry_Data>(cert, why);
47}

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.

21 {
22 std::vector<uint8_t> output;
23 DER_Encoder der(output);
24 this->encode_into(der);
25 return output;
26}
virtual void encode_into(DER_Encoder &to) const =0

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().

◆ decode_from()

void Botan::CRL_Entry::decode_from ( BER_Decoder & from)
overridevirtual

Decode whatever this object is from from

Parameters
fromthe BER_Decoder that will be read from

Implements Botan::ASN1_Object.

Definition at line 88 of file crl_ent.cpp.

88 {
89 auto data = std::make_unique<CRL_Entry_Data>();
90
91 BER_Decoder entry = source.start_sequence();
92
93 entry.decode(data->m_serial);
94 entry.decode(data->m_time);
95
96 data->m_serial_bits = data->m_serial.magnitude();
97
98 if(entry.more_items()) {
99 data->m_extensions.decode_from(entry, Extension_Context::CRL_Entry);
100
101 // TODO(Botan4) start checking that CRLEntry extensions is not empty
102 // Extensions ::= SEQUENCE SIZE (1..MAX) OF Extension
103
104 if(const auto* ext = data->m_extensions.get_extension_object_as<Cert_Extension::CRL_ReasonCode>()) {
105 const auto reason = ext->get_reason();
106
107 /*
108 * This reason code only makes sense in the context of delta CRL processing, which
109 * we do not currently support. Seeing it in a regular CRL suggests that something
110 * has gone very wrong (eg we are somehow processing a delta CRL, though that
111 * shouldn't happen since the delta CRL indicator extension should be a critical
112 * extension which we will reject.)
113 */
114 if(reason == CRL_Code::RemoveFromCrl) {
115 throw Decoding_Error("CRL entry ReasonCode extension included invalid RemoveFromCrl");
116 }
117 data->m_reason = reason;
118 } else {
119 data->m_reason = CRL_Code::Unspecified;
120 }
121 }
122
123 entry.end_cons();
124
125 m_data = std::move(data);
126}

References Botan::CRL_Entry, Botan::BER_Decoder::decode(), Botan::BER_Decoder::end_cons(), Botan::BER_Decoder::more_items(), Botan::RemoveFromCrl, Botan::BER_Decoder::start_sequence(), and Botan::Unspecified.

◆ encode_into()

void Botan::CRL_Entry::encode_into ( DER_Encoder & to) const
overridevirtual

Encode whatever this object is into to

Parameters
tothe DER_Encoder that will be written to

Implements Botan::ASN1_Object.

Definition at line 75 of file crl_ent.cpp.

75 {
76 der.start_sequence().encode(serial()).encode(expire_time());
77
78 if(extensions().count() > 0) {
79 der.start_sequence().encode(extensions()).end_cons();
80 }
81
82 der.end_cons();
83}
const X509_Serial_Number & serial() const
Definition crl_ent.cpp:140
const X509_Time & expire_time() const
Definition crl_ent.cpp:144
const Extensions & extensions() const
Definition crl_ent.cpp:152

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), expire_time(), extensions(), serial(), and Botan::DER_Encoder::start_sequence().

◆ expire_time()

const X509_Time & Botan::CRL_Entry::expire_time ( ) const

Get the revocation date of the certificate associated with this entry

Returns
certificate's revocation date

Definition at line 144 of file crl_ent.cpp.

144 {
145 return data().m_time;
146}

Referenced by botan_x509_crl_entry_revocation_date(), encode_into(), and Botan::operator==().

◆ extensions()

const Extensions & Botan::CRL_Entry::extensions ( ) const

Get the extensions on this CRL entry

Definition at line 152 of file crl_ent.cpp.

152 {
153 return data().m_extensions;
154}

Referenced by encode_into().

◆ reason_code()

CRL_Code Botan::CRL_Entry::reason_code ( ) const

Get the entries reason code

Returns
reason code

Definition at line 148 of file crl_ent.cpp.

148 {
149 return data().m_reason;
150}

Referenced by botan_x509_crl_entry_reason(), and Botan::operator==().

◆ serial()

const X509_Serial_Number & Botan::CRL_Entry::serial ( ) const

Get the serial number of the certificate associated with this entry

Definition at line 140 of file crl_ent.cpp.

140 {
141 return data().m_serial;
142}

Referenced by botan_x509_crl_entry_serial_number(), encode_into(), and Botan::operator==().

◆ serial_number()

const std::vector< uint8_t > & Botan::CRL_Entry::serial_number ( ) const

Get the serial number of the certificate associated with this entry.

Note this is the absolute value; the (rare, non-conforming) negative serial numbers are indistinguishable from their positive counterpart. Prefer serial() which preserves the sign.

Returns
certificate's serial number

Definition at line 136 of file crl_ent.cpp.

136 {
137 return data().m_serial_bits;
138}

Referenced by botan_x509_crl_entry_view_serial_number().

◆ X509_CRL

friend class X509_CRL
friend

Definition at line 83 of file x509_crl.h.

References X509_CRL.

Referenced by X509_CRL.


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