Botan  2.13.0
Crypto and TLS for C++11
Functions
Botan::X509 Namespace Reference

Functions

std::vector< uint8_t > BER_encode (const Public_Key &key)
 
Public_Key * copy_key (const Public_Key &key)
 
PKCS10_Request create_cert_req (const X509_Cert_Options &opts, const Private_Key &key, const std::string &hash_fn, RandomNumberGenerator &rng)
 
X509_Certificate create_self_signed_cert (const X509_Cert_Options &opts, const Private_Key &key, const std::string &hash_fn, RandomNumberGenerator &rng)
 
Public_Key * load_key (DataSource &source)
 
Public_Key * load_key (const std::vector< uint8_t > &mem)
 
std::string PEM_encode (const Public_Key &key)
 

Detailed Description

This namespace contains functions for handling X.509 public keys

Function Documentation

std::vector< uint8_t > Botan::X509::BER_encode ( const Public_Key &  key)

BER encode a key

Parameters
keythe public key to encode
Returns
BER encoding of this key

Definition at line 19 of file x509_key.cpp.

References Botan::Public_Key::subject_public_key().

Referenced by botan_privkey_export_pubkey(), botan_pubkey_export(), and create_self_signed_cert().

20  {
21  // keeping it around for compat
22  return key.subject_public_key();
23  }
Public_Key * Botan::X509::copy_key ( const Public_Key &  key)

Copy a key.

Parameters
keythe public key to copy
Returns
new public key object

Definition at line 98 of file x509_key.cpp.

References load_key(), and PEM_encode().

99  {
100  DataSource_Memory source(PEM_encode(key));
101  return X509::load_key(source);
102  }
Botan::X509::PEM_encode
std::string PEM_encode(const Public_Key &key)
Definition: x509_key.cpp:28
Botan::X509::load_key
Public_Key * load_key(const std::vector< uint8_t > &mem)
Definition: x509_key.cpp:89
PKCS10_Request Botan::X509::create_cert_req ( const X509_Cert_Options &  opts,
const Private_Key &  key,
const std::string &  hash_fn,
RandomNumberGenerator &  rng 
)

Create a PKCS#10 certificate request.

Parameters
optsthe options defining the request to create
keythe key used to sign this request
rngthe rng to use
hash_fnthe hash function to use
Returns
newly created PKCS#10 request

Definition at line 109 of file x509self.cpp.

References Botan::Extensions::add_new(), Botan::X509_Cert_Options::challenge, Botan::X509_Cert_Options::constraints, Botan::PKCS10_Request::create(), Botan::CRL_SIGN, Botan::X509_Cert_Options::ex_constraints, Botan::X509_Cert_Options::extensions, Botan::X509_Cert_Options::is_CA, Botan::KEY_CERT_SIGN, Botan::NO_CONSTRAINTS, Botan::X509_Cert_Options::padding_scheme, Botan::X509_Cert_Options::path_limit, and Botan::verify_cert_constraints_valid_for_key_type().

113  {
114  X509_DN subject_dn;
115  AlternativeName subject_alt;
116  load_info(opts, subject_dn, subject_alt);
117 
118  Key_Constraints constraints;
119  if(opts.is_CA)
120  {
121  constraints = Key_Constraints(KEY_CERT_SIGN | CRL_SIGN);
122  }
123  else
124  {
125  verify_cert_constraints_valid_for_key_type(key, opts.constraints);
126  constraints = opts.constraints;
127  }
128 
129  Extensions extensions = opts.extensions;
130 
131  extensions.add_new(new Cert_Extension::Basic_Constraints(opts.is_CA, opts.path_limit));
132 
133  if(constraints != NO_CONSTRAINTS)
134  {
135  extensions.add_new(new Cert_Extension::Key_Usage(constraints));
136  }
137  extensions.add_new(new Cert_Extension::Extended_Key_Usage(opts.ex_constraints));
138  extensions.add_new(new Cert_Extension::Subject_Alternative_Name(subject_alt));
139 
140  return PKCS10_Request::create(key,
141  subject_dn,
142  extensions,
143  hash_fn,
144  rng,
145  opts.padding_scheme,
146  opts.challenge);
147  }
CRL_SIGN
Definition: ffi.h:1554
Botan::verify_cert_constraints_valid_for_key_type
void verify_cert_constraints_valid_for_key_type(const Public_Key &pub_key, Key_Constraints constraints)
Definition: key_constraint.cpp:70
X509_Certificate Botan::X509::create_self_signed_cert ( const X509_Cert_Options &  opts,
const Private_Key &  key,
const std::string &  hash_fn,
RandomNumberGenerator &  rng 
)

Create a self-signed X.509 certificate.

Parameters
optsthe options defining the certificate to create
keythe private key used for signing, i.e. the key associated with this self-signed certificate
hash_fnthe hash function to use
rngthe rng to use
Returns
newly created self-signed certificate

Definition at line 50 of file x509self.cpp.

References Botan::Extensions::add_new(), BER_encode(), BOTAN_ASSERT_NOMSG, Botan::choose_sig_format(), Botan::X509_Cert_Options::constraints, Botan::CRL_SIGN, Botan::X509_Cert_Options::end, Botan::X509_Cert_Options::ex_constraints, Botan::X509_Cert_Options::extensions, Botan::AlgorithmIdentifier::get_oid(), Botan::OID::has_value(), Botan::X509_Cert_Options::is_CA, Botan::KEY_CERT_SIGN, Botan::X509_CA::make_cert(), Botan::NO_CONSTRAINTS, Botan::X509_Cert_Options::padding_scheme, Botan::X509_Cert_Options::path_limit, Botan::X509_Cert_Options::start, and Botan::verify_cert_constraints_valid_for_key_type().

54  {
55  AlgorithmIdentifier sig_algo;
56  X509_DN subject_dn;
57  AlternativeName subject_alt;
58 
59  // for now, only the padding option is used
60  std::map<std::string,std::string> sig_opts = { {"padding",opts.padding_scheme} };
61 
62  const std::vector<uint8_t> pub_key = X509::BER_encode(key);
63  std::unique_ptr<PK_Signer> signer(choose_sig_format(key, sig_opts, rng, hash_fn, sig_algo));
64  BOTAN_ASSERT_NOMSG(sig_algo.get_oid().has_value());
65  load_info(opts, subject_dn, subject_alt);
66 
67  Extensions extensions = opts.extensions;
68 
69  Key_Constraints constraints;
70  if(opts.is_CA)
71  {
72  constraints = Key_Constraints(KEY_CERT_SIGN | CRL_SIGN);
73  }
74  else
75  {
76  verify_cert_constraints_valid_for_key_type(key, opts.constraints);
77  constraints = opts.constraints;
78  }
79 
80  extensions.add_new(
81  new Cert_Extension::Basic_Constraints(opts.is_CA, opts.path_limit),
82  true);
83 
84  if(constraints != NO_CONSTRAINTS)
85  {
86  extensions.add_new(new Cert_Extension::Key_Usage(constraints), true);
87  }
88 
89  std::unique_ptr<Cert_Extension::Subject_Key_ID> skid(new Cert_Extension::Subject_Key_ID(pub_key, hash_fn));
90 
91  extensions.add_new(new Cert_Extension::Authority_Key_ID(skid->get_key_id()));
92  extensions.add_new(skid.release());
93 
94  extensions.add_new(
95  new Cert_Extension::Subject_Alternative_Name(subject_alt));
96 
97  extensions.add_new(
98  new Cert_Extension::Extended_Key_Usage(opts.ex_constraints));
99 
100  return X509_CA::make_cert(signer.get(), rng, sig_algo, pub_key,
101  opts.start, opts.end,
102  subject_dn, subject_dn,
103  extensions);
104  }
CRL_SIGN
Definition: ffi.h:1554
BOTAN_ASSERT_NOMSG
#define BOTAN_ASSERT_NOMSG(expr)
Definition: assert.h:68
Botan::PKCS8::BER_encode
secure_vector< uint8_t > BER_encode(const Private_Key &key)
Definition: pkcs8.cpp:139
Botan::verify_cert_constraints_valid_for_key_type
void verify_cert_constraints_valid_for_key_type(const Public_Key &pub_key, Key_Constraints constraints)
Definition: key_constraint.cpp:70
Botan::choose_sig_format
PK_Signer * choose_sig_format(const Private_Key &key, RandomNumberGenerator &rng, const std::string &hash_fn, AlgorithmIdentifier &sig_algo)
Definition: x509_ca.cpp:318
Public_Key * Botan::X509::load_key ( DataSource &  source)

Create a public key from a data source.

Parameters
sourcethe source providing the DER or PEM encoded key
Returns
new public key object

Definition at line 37 of file x509_key.cpp.

References Botan::BIT_STRING, Botan::BER_Decoder::decode(), Botan::PEM_Code::decode_check_label(), Botan::BER_Decoder::end_cons(), Botan::load_public_key(), Botan::PEM_Code::matches(), Botan::ASN1::maybe_BER(), Botan::SEQUENCE, and Botan::BER_Decoder::start_cons().

Referenced by botan_privkey_export_pubkey(), botan_pubkey_load(), copy_key(), load_key(), Botan::X509_Certificate::load_subject_public_key(), and Botan::PKCS10_Request::subject_public_key().

38  {
39  try {
40  AlgorithmIdentifier alg_id;
41  std::vector<uint8_t> key_bits;
42 
43  if(ASN1::maybe_BER(source) && !PEM_Code::matches(source))
44  {
45  BER_Decoder(source)
46  .start_cons(SEQUENCE)
47  .decode(alg_id)
48  .decode(key_bits, BIT_STRING)
49  .end_cons();
50  }
51  else
52  {
53  DataSource_Memory ber(
54  PEM_Code::decode_check_label(source, "PUBLIC KEY")
55  );
56 
57  BER_Decoder(ber)
58  .start_cons(SEQUENCE)
59  .decode(alg_id)
60  .decode(key_bits, BIT_STRING)
61  .end_cons();
62  }
63 
64  if(key_bits.empty())
65  throw Decoding_Error("X.509 public key decoding");
66 
67  return load_public_key(alg_id, key_bits).release();
68  }
69  catch(Decoding_Error& e)
70  {
71  throw Decoding_Error("X.509 public key decoding", e);
72  }
73  }
Botan::load_public_key
std::unique_ptr< Public_Key > load_public_key(const AlgorithmIdentifier &alg_id, const std::vector< uint8_t > &key_bits)
Definition: pk_algs.cpp:82
Botan::ASN1::maybe_BER
bool maybe_BER(DataSource &source)
Definition: asn1_obj.cpp:222
Botan::PEM_Code::decode_check_label
secure_vector< uint8_t > decode_check_label(DataSource &source, const std::string &label_want)
Definition: pem.cpp:54
Botan::PEM_Code::matches
bool matches(DataSource &source, const std::string &extra, size_t search_range)
Definition: pem.cpp:142
Public_Key * Botan::X509::load_key ( const std::vector< uint8_t > &  enc)

Create a public key from a memory region.

Parameters
encthe memory region containing the DER or PEM encoded key
Returns
new public key object

Definition at line 89 of file x509_key.cpp.

References load_key().

90  {
91  DataSource_Memory source(mem);
92  return X509::load_key(source);
93  }
Botan::X509::load_key
Public_Key * load_key(const std::vector< uint8_t > &mem)
Definition: x509_key.cpp:89
std::string Botan::X509::PEM_encode ( const Public_Key &  key)

PEM encode a public key into a string.

Parameters
keythe key to encode
Returns
PEM encoded key

Definition at line 28 of file x509_key.cpp.

References Botan::PEM_Code::encode(), and Botan::Public_Key::subject_public_key().

Referenced by botan_pubkey_export(), copy_key(), and Botan::X509_Certificate::to_string().

29  {
30  return PEM_Code::encode(key.subject_public_key(),
31  "PUBLIC KEY");
32  }
Botan::PEM_Code::encode
std::string encode(const uint8_t der[], size_t length, const std::string &label, size_t width)
Definition: pem.cpp:43
Generated on Mon Jan 13 2020 21:02:57 for Botan by   doxygen 1.8.9.1