Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point Class Reference

#include <x509_ext.h>

Inheritance diagram for Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point:

Public Member Functions
std::vector< uint8_t >	BER_encode () const
const std::optional< AlternativeName > &	crl_issuer () const
void	decode_from (BER_Decoder &from) override
	Distribution_Point ()=default
	Distribution_Point (const AlternativeName &name)
	Distribution_Point (std::optional< DistributionPointName > dp_name, std::optional< ReasonFlags > reasons, std::optional< AlternativeName > crl_issuer)
const std::optional< DistributionPointName > &	distribution_point_name () const
void	encode_into (DER_Encoder &to) const override
const AlternativeName &	point () const
const std::optional< ReasonFlags > &	reasons () const

Detailed Description

Definition at line 604 of file x509_ext.h.

Constructor & Destructor Documentation

Distribution_Point() [1/3]

Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::Distribution_Point ( )

default

Distribution_Point() [2/3]

Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::Distribution_Point ( const AlternativeName & name )

inlineexplicit

Definition at line 611 of file x509_ext.h.

: m_dp_name(DistributionPointName(name)) {}

Distribution_Point() [3/3]

Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::Distribution_Point ( std::optional< DistributionPointName > dp_name, std::optional< ReasonFlags > reasons, std::optional< AlternativeName > crl_issuer )

inline

Definition at line 613 of file x509_ext.h.

                                                                        :
                  m_dp_name(std::move(dp_name)), m_reasons(reasons), m_crl_issuer(std::move(crl_issuer)) {}

References crl_issuer(), and reasons().

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

crl_issuer()

const std::optional< AlternativeName > & Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::crl_issuer ( ) const

inline

Return the optional CRL issuer name

Definition at line 631 of file x509_ext.h.

{ return m_crl_issuer; }

Referenced by decode_from(), and Distribution_Point().

decode_from()

void Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::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 1447 of file x509_ext.cpp.

                                                                            {
   /*
   * DistributionPoint ::= SEQUENCE {
   *      distributionPoint       [0]     DistributionPointName OPTIONAL,
   *      reasons                 [1]     ReasonFlags OPTIONAL,
   *      cRLIssuer               [2]     GeneralNames OPTIONAL }
   */
   BER_Decoder dp = ber.start_sequence();
 
   m_dp_name.reset();
   m_reasons.reset();
   m_crl_issuer.reset();
 
   // DER: these optional fields appear at most once and in increasing tag
   // order. Decoding them in tag order and then rejecting anything left over
   // (see end_cons below) catches out-of-order, duplicate, and unknown fields.
   dp.decode_optional_field(0,
                            ASN1_Class::ContextSpecific | ASN1_Class::Constructed,
                            [&](BER_Decoder& d) {
                               DistributionPointName name;
                               d.start_context_specific(0).decode(name).verify_end();
                               m_dp_name = std::move(name);
                            })
      .decode_optional_field(
         1, ASN1_Class::ContextSpecific, [&](BER_Decoder& d) { m_reasons = decode_reason_flags_implicit(d, 1); })
      .decode_optional_field(2, ASN1_Class::ContextSpecific | ASN1_Class::Constructed, [&](BER_Decoder& d) {
         AlternativeName crl_issuer;
         d.decode_implicit(crl_issuer,
                           ASN1_Type(2),
                           ASN1_Class::ContextSpecific | ASN1_Class::Constructed,
                           ASN1_Type::Sequence,
                           ASN1_Class::Constructed);
         m_crl_issuer = std::move(crl_issuer);
      });
 
   dp.end_cons();
 
   // RFC 5280 4.2.1.6: GeneralNames ::= SEQUENCE SIZE (1..MAX) OF GeneralName
   if(m_crl_issuer.has_value() && m_crl_issuer->is_empty()) {
      throw Decoding_Error("cRLIssuer GeneralNames must contain at least one GeneralName");
   }
 
   if(m_crl_issuer.has_value() && !crl_issuer_is_well_formed(*m_crl_issuer)) {
      /* RFC 5280 4.2.1.13: "If present, the cRLIssuer MUST only contain the
      * distinguished name (DN) from the issuer field of the CRL". */
      throw Decoding_Error("cRLIssuer must contain exactly one non-empty directoryName GeneralName");
   }
 
   if(!m_dp_name.has_value() && !m_crl_issuer.has_value()) {
      throw Decoding_Error("DistributionPoint must contain either distributionPoint or cRLIssuer");
   }
}

References Botan::Constructed, Botan::ContextSpecific, crl_issuer(), Botan::BER_Decoder::decode(), Botan::BER_Decoder::decode_implicit(), Botan::BER_Decoder::decode_optional_field(), Botan::BER_Decoder::end_cons(), Botan::Sequence, Botan::BER_Decoder::start_context_specific(), Botan::BER_Decoder::start_sequence(), and Botan::BER_Decoder::verify_end().

distribution_point_name()

const std::optional< DistributionPointName > & Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::distribution_point_name ( ) const

inline

Return the optional distribution point name

Definition at line 621 of file x509_ext.h.

{ return m_dp_name; }

encode_into()

void Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::encode_into ( DER_Encoder & to ) const

overridevirtual

Encode whatever this object is into to

Parameters

to	the DER_Encoder that will be written to

Implements Botan::ASN1_Object.

Definition at line 1409 of file x509_ext.cpp.

                                                                                  {
   /*
   * DistributionPoint ::= SEQUENCE {
   *      distributionPoint       [0]     DistributionPointName OPTIONAL,
   *      reasons                 [1]     ReasonFlags OPTIONAL,
   *      cRLIssuer               [2]     GeneralNames OPTIONAL }
   *
   * RFC 5280 4.2.1.13: "either distributionPoint or cRLIssuer MUST be present".
   */
   const bool has_dp_name = m_dp_name.has_value();
   const bool has_crl_issuer = m_crl_issuer.has_value();
   if(!has_dp_name && !has_crl_issuer) {
      throw Encoding_Error("DistributionPoint must contain either distributionPoint or cRLIssuer");
   }
   if(has_crl_issuer && !crl_issuer_is_well_formed(*m_crl_issuer)) {
      /* RFC 5280 4.2.1.13: "If present, the cRLIssuer MUST only contain the
      * distinguished name (DN) from the issuer field of the CRL". */
      throw Encoding_Error("cRLIssuer must contain exactly one non-empty directoryName GeneralName");
   }
 
   der.start_sequence();
 
   if(has_dp_name) {
      // distributionPoint [0] EXPLICIT DistributionPointName
      der.start_explicit_context_specific(0).encode(*m_dp_name).end_cons();
   }
 
   if(m_reasons) {
      emit_reason_flags_implicit(der, 1, *m_reasons);
   }
 
   if(has_crl_issuer) {
      emit_general_names_implicit(der, *m_crl_issuer, 2);
   }
 
   der.end_cons();
}

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::start_explicit_context_specific(), and Botan::DER_Encoder::start_sequence().

point()

const AlternativeName & Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::point

(

)

const

Deprecated compatibility shim. Raises Invalid_State if the distributionPoint field is absent or the name is a relative name.

Prefer distribution_point_name(), which surfaces both the OPTIONAL field and the CHOICE arm explicitly.

Definition at line 1331 of file x509_ext.cpp.

                                                                              {
   BOTAN_STATE_CHECK(m_dp_name.has_value() && m_dp_name->full_name().has_value());
   return *m_dp_name->full_name();
}

References BOTAN_STATE_CHECK.

reasons()

const std::optional< ReasonFlags > & Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::reasons ( ) const

inline

Return the optional reason flags

Definition at line 626 of file x509_ext.h.

{ return m_reasons; }

Referenced by Distribution_Point().

---

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

• src/lib/x509/x509_ext.h
• src/lib/x509/x509_ext.cpp