Botan::Cert_Extension::Subject_Key_ID Class Reference

#include <x509_ext.h>

Inheritance diagram for Botan::Cert_Extension::Subject_Key_ID:

Public Member Functions
std::unique_ptr< Certificate_Extension >	copy () const override
const std::vector< uint8_t > &	get_key_id () const
OID	oid_of () const override
	Subject_Key_ID ()=default
	Subject_Key_ID (const Public_Key &pub_key)
	Subject_Key_ID (const std::vector< uint8_t > &k)
	Subject_Key_ID (const std::vector< uint8_t > &public_key, std::string_view hash_fn)
virtual void	validate (const X509_Certificate &subject, const std::optional< X509_Certificate > &issuer, const std::vector< X509_Certificate > &cert_path, std::vector< std::set< Certificate_Status_Code > > &cert_status, size_t pos) const

Static Public Member Functions
static OID	static_oid ()

Detailed Description

Subject Key Identifier Extension

Definition at line 108 of file x509_ext.h.

Constructor & Destructor Documentation

Subject_Key_ID() [1/4]

Botan::Cert_Extension::Subject_Key_ID::Subject_Key_ID ( )

default

Subject_Key_ID() [2/4]

Botan::Cert_Extension::Subject_Key_ID::Subject_Key_ID ( const std::vector< uint8_t > & k )

inlineexplicit

Definition at line 112 of file x509_ext.h.

: m_key_id(k) {}

Subject_Key_ID() [3/4]

Botan::Cert_Extension::Subject_Key_ID::Subject_Key_ID ( const Public_Key & pub_key )

explicit

Derive the key identifier from the public key, using the first method given in RFC 5280 4.2.1.2:

(1) The keyIdentifier is composed of the 160-bit SHA-1 hash of the value of the BIT STRING subjectPublicKey (excluding the tag, length, and number of unused bits).

Definition at line 570 of file x509_ext.cpp.

                                                        {
   /*
   * RFC 5280 4.2.1.2:
   *    (1) The keyIdentifier is composed of the 160-bit SHA-1 hash of the
   *    value of the BIT STRING subjectPublicKey (excluding the tag, length,
   *    and number of unused bits).
   */
   auto hash = HashFunction::create_or_throw("SHA-1");
 
   m_key_id.resize(hash->output_length());
 
   hash->update(pub_key.public_key_bits());
   hash->final(m_key_id.data());
}

References Botan::HashFunction::create_or_throw(), and Botan::Public_Key::public_key_bits().

Subject_Key_ID() [4/4]

Botan::Cert_Extension::Subject_Key_ID::Subject_Key_ID	(	const std::vector< uint8_t > &	public_key,
		std::string_view	hash_fn )

Definition at line 588 of file x509_ext.cpp.

                                                                                          {
   auto hash = HashFunction::create_or_throw(hash_name);
 
   m_key_id.resize(hash->output_length());
 
   hash->update(pub_key);
   hash->final(m_key_id.data());
 
   // Truncate longer hashes, 192 bits here seems plenty
   const size_t max_skid_len = (192 / 8);
   if(m_key_id.size() > max_skid_len) {
      m_key_id.resize(max_skid_len);
   }
}

References Botan::HashFunction::create_or_throw().

Member Function Documentation

copy()

std::unique_ptr< Certificate_Extension > Botan::Cert_Extension::Subject_Key_ID::copy ( ) const

inlineoverridevirtual

Make a copy of this extension

Returns

copy of this

Implements Botan::Certificate_Extension.

Definition at line 127 of file x509_ext.h.

                                                                 {
         return std::make_unique<Subject_Key_ID>(m_key_id);
      }

References copy().

Referenced by copy().

get_key_id()

const std::vector< uint8_t > & Botan::Cert_Extension::Subject_Key_ID::get_key_id ( ) const

inline

Definition at line 131 of file x509_ext.h.

{ return m_key_id; }

oid_of()

OID Botan::Cert_Extension::Subject_Key_ID::oid_of ( ) const

inlineoverridevirtual

Return object identifier for this extension

Returns

OID representing this extension

Implements Botan::Certificate_Extension.

Definition at line 135 of file x509_ext.h.

{ return static_oid(); }

References static_oid().

static_oid()

OID Botan::Cert_Extension::Subject_Key_ID::static_oid ( )

inlinestatic

Definition at line 133 of file x509_ext.h.

{ return OID({2, 5, 29, 14}); }

Referenced by oid_of().

validate()

void Botan::Certificate_Extension::validate ( const X509_Certificate & subject, const std::optional< X509_Certificate > & issuer, const std::vector< X509_Certificate > & cert_path, std::vector< std::set< Certificate_Status_Code > > & cert_status, size_t pos ) const

virtualinherited

Callback visited during path validation.

An extension can implement this callback to inspect the path during path validation.

If an error occurs during validation of this extension, an appropriate status code shall be added to cert_status.

Parameters

subject	Subject certificate that contains this extension
issuer	Issuer certificate. nullopt for certificates with no available issuer (e.g. non self-signed trust anchors).
cert_path	Certificate path which is currently validated
cert_status	Certificate validation status codes for subject certificate
pos	Position of subject certificate in cert_path

Reimplemented in Botan::Cert_Extension::ASBlocks, Botan::Cert_Extension::Certificate_Policies, Botan::Cert_Extension::IPAddressBlocks, Botan::Cert_Extension::Name_Constraints, Botan::Cert_Extension::NoRevocationAvailable, Botan::Cert_Extension::OCSP_NoCheck, and Botan::Cert_Extension::Unknown_Extension.

Definition at line 181 of file x509_ext.cpp.

                                                     {}

Referenced by is_appropriate_context().

---

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

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