Botan 3.0.0-rc1
Crypto and TLS for C&
Public Member Functions | Static Public Member Functions | List of all members
Botan::X509_CA Class Referencefinal

#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_CAoperator= (const X509_CA &)=delete
 
X509_CAoperator= (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_certificatethe certificate of the CA
keythe private key of the CA
hash_fnname of a hash function to use for signing
padding_methodname of the signature padding method to use
rngthe random generator to use

Definition at line 21 of file x509_ca.cpp.

25 :
26 m_ca_cert(cert)
27 {
28 if(!m_ca_cert.is_CA_cert())
29 throw Invalid_Argument("X509_CA: This certificate is not for a CA");
30
31 m_signer = X509_Object::choose_sig_format(m_ca_sig_algo, key, rng, hash_fn, padding_method);
32 m_hash_fn = m_signer->hash_function();
33 }
bool is_CA_cert() const
Definition: x509cert.cpp:431
static std::unique_ptr< PK_Signer > choose_sig_format(AlgorithmIdentifier &sig_algo, const Private_Key &key, RandomNumberGenerator &rng, const std::string &hash_fn, const std::string &padding_algo)
Definition: x509_obj.cpp:243

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_certificatethe certificate of the CA
keythe private key of the CA
hash_fnname of a hash function to use for signing
rngthe random generator to use

Definition at line 183 of file x509_ca.h.

186 :
188 key,
189 hash_fn,
190 "",
191 rng) {}
X509_CA(const X509_Certificate &ca_certificate, const Private_Key &key, const std::string &hash_fn, const std::string &padding_method, RandomNumberGenerator &rng)
Definition: x509_ca.cpp:21
X509_Certificate ca_certificate() const
Definition: x509_ca.cpp:266

◆ 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_certificatethe certificate of the CA
keythe private key of the CA
optsadditional options, e.g. padding, as key value pairs
hash_fnname of a hash function to use for signing
rngthe 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.

267 {
268 return m_ca_cert;
269 }

◆ 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
signera signing object
rnga random number generator
sig_algothe signature algorithm identifier
pub_keythe serialized public key
not_beforethe start time of the certificate
not_afterthe end time of the certificate
issuer_dnthe DN of the issuer
subject_dnthe DN of the subject
extensionsan optional list of certificate extensions
Returns
newly minted certificate

Definition at line 107 of file x509_ca.cpp.

116 {
117 const size_t SERIAL_BITS = 128;
118 BigInt serial_no(rng, SERIAL_BITS);
119
120 return make_cert(signer, rng, serial_no, sig_algo, pub_key,
121 not_before, not_after, issuer_dn, subject_dn, extensions);
122 }
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)
Definition: x509_ca.cpp:107

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
signera signing object
rnga random number generator
serial_numberthe serial number the cert will be assigned
sig_algothe signature algorithm identifier
pub_keythe serialized public key
not_beforethe start time of the certificate
not_afterthe end time of the certificate
issuer_dnthe DN of the issuer
subject_dnthe DN of the subject
extensionsan optional list of certificate extensions
Returns
newly minted certificate

Definition at line 127 of file x509_ca.cpp.

137 {
138 const size_t X509_CERT_VERSION = 3;
139
140 // clang-format off
141 return X509_Certificate(X509_Object::make_signed(
142 signer, rng, sig_algo,
143 DER_Encoder().start_sequence()
144 .start_explicit(0)
145 .encode(X509_CERT_VERSION-1)
146 .end_explicit()
147
148 .encode(serial_no)
149
150 .encode(sig_algo)
151 .encode(issuer_dn)
152
153 .start_sequence()
154 .encode(not_before)
155 .encode(not_after)
156 .end_cons()
157
158 .encode(subject_dn)
159 .raw_bytes(pub_key)
160
161 .start_explicit(3)
162 .start_sequence()
163 .encode(extensions)
164 .end_cons()
165 .end_explicit()
166 .end_cons()
167 .get_contents()
168 ));
169 // clang-format on
170 }
static std::vector< uint8_t > make_signed(PK_Signer *signer, RandomNumberGenerator &rng, const AlgorithmIdentifier &alg_id, const secure_vector< uint8_t > &tbs)
Definition: x509_obj.cpp:145
std::string encode(const uint8_t der[], size_t length, const std::string &label, size_t width)
Definition: pem.cpp:42

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
rngthe random number generator to use
issue_timethe issue time (typically system_clock::now)
next_updatethe 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.

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

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
rngthe random number generator to use
next_updatethe 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.

177 {
178 return new_crl(rng,
179 std::chrono::system_clock::now(),
180 std::chrono::seconds(next_update));
181 }
X509_CRL new_crl(RandomNumberGenerator &rng, std::chrono::system_clock::time_point issue_time, std::chrono::seconds next_update) const
Definition: x509_ca.cpp:197

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
reqthe request to sign
rngthe rng to use
serial_numberthe serial number the cert will be assigned.
not_beforethe starting time for the certificate
not_afterthe expiration time for the certificate
Returns
resulting certificate

Definition at line 75 of file x509_ca.cpp.

80 {
81 auto extensions = choose_extensions(req, m_ca_cert, m_hash_fn);
82
83 return make_cert(m_signer.get(), rng, serial_number,
84 m_ca_sig_algo, req.raw_public_key(),
85 not_before, not_after,
86 m_ca_cert.subject_dn(), req.subject_dn(),
87 extensions);
88 }
const X509_DN & subject_dn() const
Definition: x509cert.cpp:416

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
reqthe request to sign
rngthe rng to use
not_beforethe starting time for the certificate
not_afterthe expiration time for the certificate
Returns
resulting certificate

Definition at line 93 of file x509_ca.cpp.

97 {
98 auto extensions = choose_extensions(req, m_ca_cert, m_hash_fn);
99
100 return make_cert(m_signer.get(), rng, m_ca_sig_algo,
101 req.raw_public_key(),
102 not_before, not_after,
103 m_ca_cert.subject_dn(), req.subject_dn(),
104 extensions);
105 }

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_crlthe last CRL of this CA to add the new entries to
new_entriescontains the new CRL entries to be added to the CRL
rngthe random number generator to use
issue_timethe issue time (typically system_clock::now)
next_updatethe time interval after issue_data within which a new CRL will be produced.

Definition at line 205 of file x509_ca.cpp.

210 {
211 std::vector<CRL_Entry> revoked = last_crl.get_revoked();
212
213 std::copy(new_revoked.begin(), new_revoked.end(),
214 std::back_inserter(revoked));
215
216 return make_crl(revoked, last_crl.crl_number() + 1, rng, issue_time, next_update);
217 }

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_crlthe last CRL of this CA to add the new entries to
new_entriescontains the new CRL entries to be added to the CRL
rngthe random number generator to use
next_updatethe time to set in next update in seconds as the offset from the current time

Definition at line 186 of file x509_ca.cpp.

190 {
191 return update_crl(crl, new_revoked, rng,
192 std::chrono::system_clock::now(),
193 std::chrono::seconds(next_update));
194 }
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
Definition: x509_ca.cpp:205

References update_crl().


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