#include <x509_ca.h>

Public Member Functions
X509_Certificate	ca_certificate () const

X509_CRL	new_crl (RandomNumberGenerator &rng, std::chrono::system_clock::time_point issue_time, std::chrono::seconds next_update) const

X509_CRL	new_crl (RandomNumberGenerator &rng, uint32_t next_update=604800) const

X509_CA &	operator= (const X509_CA &)=delete

X509_CA &	operator= (X509_CA &&)=default

X509_Certificate	sign_request (const PKCS10_Request &req, RandomNumberGenerator &rng, const BigInt &serial_number, const X509_Time &not_before, const X509_Time &not_after) const

X509_Certificate	sign_request (const PKCS10_Request &req, RandomNumberGenerator &rng, const X509_Time &not_before, const X509_Time &not_after) const

X509_CRL	update_crl (const X509_CRL &last_crl, const std::vector< CRL_Entry > &new_entries, RandomNumberGenerator &rng, std::chrono::system_clock::time_point issue_time, std::chrono::seconds next_update) const

X509_CRL	update_crl (const X509_CRL &last_crl, const std::vector< CRL_Entry > &new_entries, RandomNumberGenerator &rng, uint32_t next_update=604800) const

	X509_CA (const X509_CA &)=delete

	X509_CA (const X509_Certificate &ca_certificate, const Private_Key &key, const std::map< std::string, std::string > &opts, const std::string &hash_fn, RandomNumberGenerator &rng)

	X509_CA (const X509_Certificate &ca_certificate, const Private_Key &key, const std::string &hash_fn, const std::string &padding_method, RandomNumberGenerator &rng)

	X509_CA (const X509_Certificate &ca_certificate, const Private_Key &key, const std::string &hash_fn, RandomNumberGenerator &rng)

	X509_CA (X509_CA &&)=default

	~X509_CA ()

Static Public Member Functions
static X509_Certificate	make_cert (PK_Signer *signer, RandomNumberGenerator &rng, const AlgorithmIdentifier &sig_algo, const std::vector< uint8_t > &pub_key, const X509_Time &not_before, const X509_Time &not_after, const X509_DN &issuer_dn, const X509_DN &subject_dn, const Extensions &extensions)

static X509_Certificate	make_cert (PK_Signer *signer, RandomNumberGenerator &rng, const BigInt &serial_number, const AlgorithmIdentifier &sig_algo, const std::vector< uint8_t > &pub_key, const X509_Time &not_before, const X509_Time &not_after, const X509_DN &issuer_dn, const X509_DN &subject_dn, const Extensions &extensions)

Detailed Description

This class represents X.509 Certificate Authorities (CAs).

Definition at line 27 of file x509_ca.h.

Constructor & Destructor Documentation

◆ X509_CA() [1/5]

Botan::X509_CA::X509_CA	(	const X509_Certificate &	ca_certificate,
		const Private_Key &	key,
		const std::string &	hash_fn,
		const std::string &	padding_method,
		RandomNumberGenerator &	rng
	)

Create a new CA object with custom padding option

Parameters

ca_certificate	the certificate of the CA
key	the private key of the CA
hash_fn	name of a hash function to use for signing
padding_method	name of the signature padding method to use
rng	the random generator to use

Definition at line 21 of file x509_ca.cpp.

                                             :
   m_ca_cert(cert)
   {
   if(!m_ca_cert.is_CA_cert())
      throw Invalid_Argument("X509_CA: This certificate is not for a CA");
 
   m_signer = X509_Object::choose_sig_format(m_ca_sig_algo, key, rng, hash_fn, padding_method);
   m_hash_fn = m_signer->hash_function();
   }

References Botan::X509_Object::choose_sig_format(), and Botan::X509_Certificate::is_CA_cert().

◆ X509_CA() [2/5]

Botan::X509_CA::X509_CA	(	const X509_Certificate &	ca_certificate,
		const Private_Key &	key,
		const std::string &	hash_fn,
		RandomNumberGenerator &	rng
	)

inline

Create a new CA object.

Parameters

ca_certificate	the certificate of the CA
key	the private key of the CA
hash_fn	name of a hash function to use for signing
rng	the random generator to use

Definition at line 183 of file x509_ca.h.

                                          :
         X509_CA(ca_certificate,
                 key,
                 hash_fn,
                 "",
                 rng) {}

◆ X509_CA() [3/5]

Botan::X509_CA::X509_CA	(	const X509_Certificate &	ca_certificate,
		const Private_Key &	key,
		const std::map< std::string, std::string > &	opts,
		const std::string &	hash_fn,
		RandomNumberGenerator &	rng
	)

inline

Create a new CA object.

Parameters

ca_certificate	the certificate of the CA
key	the private key of the CA
opts	additional options, e.g. padding, as key value pairs
hash_fn	name of a hash function to use for signing
rng	the random generator to use

Definition at line 202 of file x509_ca.h.

206 :

207 X509_CA(ca_certificate, key, hash_fn, opts.at("padding"), rng) {}

◆ X509_CA() [4/5]

Botan::X509_CA::X509_CA ( const X509_CA & )

delete

◆ X509_CA() [5/5]

Botan::X509_CA::X509_CA ( X509_CA && )

default

◆ ~X509_CA()

Botan::X509_CA::~X509_CA ( )

default

Member Function Documentation

◆ ca_certificate()

X509_Certificate Botan::X509_CA::ca_certificate ( ) const

Get the certificate of this CA.

Returns: CA certificate

Definition at line 266 of file x509_ca.cpp.

   {
   return m_ca_cert;
   }

◆ make_cert() [1/2]

X509_Certificate Botan::X509_CA::make_cert	(	PK_Signer *	signer,
		RandomNumberGenerator &	rng,
		const AlgorithmIdentifier &	sig_algo,
		const std::vector< uint8_t > &	pub_key,
		const X509_Time &	not_before,
		const X509_Time &	not_after,
		const X509_DN &	issuer_dn,
		const X509_DN &	subject_dn,
		const Extensions &	extensions
	)

static

Interface for creating new certificates

Parameters

signer	a signing object
rng	a random number generator
sig_algo	the signature algorithm identifier
pub_key	the serialized public key
not_before	the start time of the certificate
not_after	the end time of the certificate
issuer_dn	the DN of the issuer
subject_dn	the DN of the subject
extensions	an optional list of certificate extensions

Returns: newly minted certificate

Definition at line 107 of file x509_ca.cpp.

   {
   const size_t SERIAL_BITS = 128;
   BigInt serial_no(rng, SERIAL_BITS);
 
   return make_cert(signer, rng, serial_no, sig_algo, pub_key,
                    not_before, not_after, issuer_dn, subject_dn, extensions);
   }

References make_cert().

Referenced by Botan::X509::create_self_signed_cert(), make_cert(), and sign_request().

◆ make_cert() [2/2]

X509_Certificate Botan::X509_CA::make_cert	(	PK_Signer *	signer,
		RandomNumberGenerator &	rng,
		const BigInt &	serial_number,
		const AlgorithmIdentifier &	sig_algo,
		const std::vector< uint8_t > &	pub_key,
		const X509_Time &	not_before,
		const X509_Time &	not_after,
		const X509_DN &	issuer_dn,
		const X509_DN &	subject_dn,
		const Extensions &	extensions
	)

static

Interface for creating new certificates

Parameters

signer	a signing object
rng	a random number generator
serial_number	the serial number the cert will be assigned
sig_algo	the signature algorithm identifier
pub_key	the serialized public key
not_before	the start time of the certificate
not_after	the end time of the certificate
issuer_dn	the DN of the issuer
subject_dn	the DN of the subject
extensions	an optional list of certificate extensions

Returns: newly minted certificate

Definition at line 127 of file x509_ca.cpp.

   {
   const size_t X509_CERT_VERSION = 3;
 
   // clang-format off
   return X509_Certificate(X509_Object::make_signed(
      signer, rng, sig_algo,
      DER_Encoder().start_sequence()
         .start_explicit(0)
            .encode(X509_CERT_VERSION-1)
         .end_explicit()
 
         .encode(serial_no)
 
         .encode(sig_algo)
         .encode(issuer_dn)
 
         .start_sequence()
            .encode(not_before)
            .encode(not_after)
         .end_cons()
 
         .encode(subject_dn)
         .raw_bytes(pub_key)
 
         .start_explicit(3)
            .start_sequence()
               .encode(extensions)
             .end_cons()
         .end_explicit()
      .end_cons()
      .get_contents()
      ));
   // clang-format on
   }

References Botan::X509_Object::make_signed().

◆ new_crl() [1/2]

X509_CRL Botan::X509_CA::new_crl	(	RandomNumberGenerator &	rng,
		std::chrono::system_clock::time_point	issue_time,
		std::chrono::seconds	next_update
	)		const

Create a new and empty CRL for this CA.

Parameters

rng	the random number generator to use
issue_time	the issue time (typically system_clock::now)
next_update	the time interval after issue_data within which a new CRL will be produced.

Returns: new CRL

Definition at line 197 of file x509_ca.cpp.

   {
   std::vector<CRL_Entry> empty;
   return make_crl(empty, 1, rng, issue_time, next_update);
   }

Referenced by new_crl().

◆ new_crl() [2/2]

X509_CRL Botan::X509_CA::new_crl	(	RandomNumberGenerator &	rng,
		uint32_t	next_update = `604800`
	)		const

Create a new and empty CRL for this CA.

Parameters

rng	the random number generator to use
next_update	the time to set in next update in seconds as the offset from the current time

Returns: new CRL

Definition at line 175 of file x509_ca.cpp.

   {
   return new_crl(rng,
                  std::chrono::system_clock::now(),
                  std::chrono::seconds(next_update));
   }

References new_crl().

◆ operator=() [1/2]

X509_CA & Botan::X509_CA::operator= ( const X509_CA & )

delete

◆ operator=() [2/2]

X509_CA & Botan::X509_CA::operator= ( X509_CA && )

default

◆ sign_request() [1/2]

X509_Certificate Botan::X509_CA::sign_request	(	const PKCS10_Request &	req,
		RandomNumberGenerator &	rng,
		const BigInt &	serial_number,
		const X509_Time &	not_before,
		const X509_Time &	not_after
	)		const

Sign a PKCS#10 Request.

Parameters

req	the request to sign
rng	the rng to use
serial_number	the serial number the cert will be assigned.
not_before	the starting time for the certificate
not_after	the expiration time for the certificate

Returns: resulting certificate

Definition at line 75 of file x509_ca.cpp.

   {
   auto extensions = choose_extensions(req, m_ca_cert, m_hash_fn);
 
   return make_cert(m_signer.get(), rng, serial_number,
                    m_ca_sig_algo, req.raw_public_key(),
                    not_before, not_after,
                    m_ca_cert.subject_dn(), req.subject_dn(),
                    extensions);
   }

References make_cert(), Botan::PKCS10_Request::raw_public_key(), Botan::PKCS10_Request::subject_dn(), and Botan::X509_Certificate::subject_dn().

◆ sign_request() [2/2]

X509_Certificate Botan::X509_CA::sign_request	(	const PKCS10_Request &	req,
		RandomNumberGenerator &	rng,
		const X509_Time &	not_before,
		const X509_Time &	not_after
	)		const

Sign a PKCS#10 Request.

Parameters

req	the request to sign
rng	the rng to use
not_before	the starting time for the certificate
not_after	the expiration time for the certificate

Returns: resulting certificate

Definition at line 93 of file x509_ca.cpp.

   {
   auto extensions = choose_extensions(req, m_ca_cert, m_hash_fn);
 
   return make_cert(m_signer.get(), rng, m_ca_sig_algo,
                    req.raw_public_key(),
                    not_before, not_after,
                    m_ca_cert.subject_dn(), req.subject_dn(),
                    extensions);
   }

References make_cert(), Botan::PKCS10_Request::raw_public_key(), Botan::PKCS10_Request::subject_dn(), and Botan::X509_Certificate::subject_dn().

◆ update_crl() [1/2]

X509_CRL Botan::X509_CA::update_crl	(	const X509_CRL &	last_crl,
		const std::vector< CRL_Entry > &	new_entries,
		RandomNumberGenerator &	rng,
		std::chrono::system_clock::time_point	issue_time,
		std::chrono::seconds	next_update
	)		const

Create a new CRL by with additional entries.

Parameters

last_crl	the last CRL of this CA to add the new entries to
new_entries	contains the new CRL entries to be added to the CRL
rng	the random number generator to use
issue_time	the issue time (typically system_clock::now)
next_update	the time interval after issue_data within which a new CRL will be produced.

Definition at line 205 of file x509_ca.cpp.

   {
   std::vector<CRL_Entry> revoked = last_crl.get_revoked();
 
   std::copy(new_revoked.begin(), new_revoked.end(),
             std::back_inserter(revoked));
 
   return make_crl(revoked, last_crl.crl_number() + 1, rng, issue_time, next_update);
   }

References Botan::X509_CRL::crl_number(), and Botan::X509_CRL::get_revoked().

Referenced by update_crl().

◆ update_crl() [2/2]

X509_CRL Botan::X509_CA::update_crl	(	const X509_CRL &	last_crl,
		const std::vector< CRL_Entry > &	new_entries,
		RandomNumberGenerator &	rng,
		uint32_t	next_update = `604800`
	)		const

Create a new CRL by with additional entries.

Parameters

last_crl	the last CRL of this CA to add the new entries to
new_entries	contains the new CRL entries to be added to the CRL
rng	the random number generator to use
next_update	the time to set in next update in seconds as the offset from the current time

Definition at line 186 of file x509_ca.cpp.

   {
   return update_crl(crl, new_revoked, rng,
                     std::chrono::system_clock::now(),
                     std::chrono::seconds(next_update));
   }

References update_crl().

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

src/lib/x509/x509_ca.h
src/lib/x509/x509_ca.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ X509_CA() [1/5]

◆ X509_CA() [2/5]

◆ X509_CA() [3/5]

◆ X509_CA() [4/5]

◆ X509_CA() [5/5]

◆ ~X509_CA()

Member Function Documentation

◆ ca_certificate()

◆ make_cert() [1/2]

◆ make_cert() [2/2]

◆ new_crl() [1/2]

◆ new_crl() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ sign_request() [1/2]

◆ sign_request() [2/2]

◆ update_crl() [1/2]

◆ update_crl() [2/2]