Botan  1.11.32
Functions
Botan::X509 Namespace Reference

Functions

std::vector< byteBER_encode (const Public_Key &key)
 
Public_Keycopy_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_Keyload_key (DataSource &source)
 
Public_Keyload_key (const std::string &fsname)
 
Public_Keyload_key (const std::vector< byte > &mem)
 
std::string PEM_encode (const Public_Key &key)
 

Detailed Description

This namespace contains functions for handling X.509 public keys

Function Documentation

§ BER_encode()

BOTAN_DLL std::vector< byte > 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::algorithm_identifier(), Botan::BIT_STRING, Botan::DER_Encoder::encode(), Botan::PEM_Code::encode(), Botan::SEQUENCE, Botan::DER_Encoder::start_cons(), and Botan::Public_Key::x509_subject_public_key().

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

20  {
21  return DER_Encoder()
22  .start_cons(SEQUENCE)
23  .encode(key.algorithm_identifier())
24  .encode(key.x509_subject_public_key(), BIT_STRING)
25  .end_cons()
26  .get_contents_unlocked();
27  }
std::string encode(const byte der[], size_t length, const std::string &label, size_t width)
Definition: pem.cpp:43

§ copy_key()

BOTAN_DLL 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 102 of file x509_key.cpp.

References load_key(), and PEM_encode().

103  {
104  DataSource_Memory source(PEM_encode(key));
105  return X509::load_key(source);
106  }
std::string PEM_encode(const Public_Key &key)
Definition: x509_key.cpp:32
Public_Key * load_key(const std::vector< byte > &mem)
Definition: x509_key.cpp:93

§ create_cert_req()

BOTAN_DLL 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 95 of file x509self.cpp.

References Botan::Extensions::add(), BER_encode(), Botan::X509_Cert_Options::challenge, Botan::choose_sig_format(), Botan::X509_Cert_Options::constraints, Botan::CRL_SIGN, Botan::DIRECTORY_STRING, Botan::DER_Encoder::encode(), Botan::PEM_Code::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::end_explicit(), Botan::X509_Cert_Options::ex_constraints, Botan::DER_Encoder::get_contents(), Botan::X509_Cert_Options::is_CA, Botan::KEY_CERT_SIGN, Botan::X509_Object::make_signed(), Botan::NO_CONSTRAINTS, Botan::X509_Cert_Options::path_limit, Botan::DER_Encoder::raw_bytes(), Botan::SEQUENCE, Botan::DER_Encoder::start_cons(), Botan::DER_Encoder::start_explicit(), and Botan::verify_cert_constraints_valid_for_key_type().

99  {
100  AlgorithmIdentifier sig_algo;
101  X509_DN subject_dn;
102  AlternativeName subject_alt;
103 
104  std::vector<byte> pub_key = X509::BER_encode(key);
105  std::unique_ptr<PK_Signer> signer(choose_sig_format(key, hash_fn, sig_algo));
106  load_info(opts, subject_dn, subject_alt);
107 
108  const size_t PKCS10_VERSION = 0;
109 
110  Key_Constraints constraints;
111  if(opts.is_CA)
112  {
113  constraints = Key_Constraints(KEY_CERT_SIGN | CRL_SIGN);
114  }
115  else
116  {
117  verify_cert_constraints_valid_for_key_type(key, opts.constraints);
118  constraints = opts.constraints;
119  }
120 
121  Extensions extensions;
122 
123  extensions.add(
124  new Cert_Extension::Basic_Constraints(opts.is_CA, opts.path_limit));
125 
126  if(constraints != NO_CONSTRAINTS)
127  {
128  extensions.add(
129  new Cert_Extension::Key_Usage(constraints));
130  }
131  extensions.add(
132  new Cert_Extension::Extended_Key_Usage(opts.ex_constraints));
133  extensions.add(
134  new Cert_Extension::Subject_Alternative_Name(subject_alt));
135 
136  DER_Encoder tbs_req;
137 
138  tbs_req.start_cons(SEQUENCE)
139  .encode(PKCS10_VERSION)
140  .encode(subject_dn)
141  .raw_bytes(pub_key)
142  .start_explicit(0);
143 
144  if(!opts.challenge.empty())
145  {
146  ASN1_String challenge(opts.challenge, DIRECTORY_STRING);
147 
148  tbs_req.encode(
149  Attribute("PKCS9.ChallengePassword",
150  DER_Encoder().encode(challenge).get_contents_unlocked()
151  )
152  );
153  }
154 
155  tbs_req.encode(
156  Attribute("PKCS9.ExtensionRequest",
157  DER_Encoder()
158  .start_cons(SEQUENCE)
159  .encode(extensions)
160  .end_cons()
161  .get_contents_unlocked()
162  )
163  )
164  .end_explicit()
165  .end_cons();
166 
167  const std::vector<byte> req =
168  X509_Object::make_signed(signer.get(), rng, sig_algo,
169  tbs_req.get_contents());
170 
171  return PKCS10_Request(req);
172  }
Definition: ffi.h:507
void verify_cert_constraints_valid_for_key_type(const Public_Key &pub_key, Key_Constraints constraints)
std::string encode(const byte der[], size_t length, const std::string &label, size_t width)
Definition: pem.cpp:43
CK_ATTRIBUTE Attribute
Definition: p11.h:849
secure_vector< byte > BER_encode(const Private_Key &key)
Definition: pkcs8.cpp:130
PK_Signer * choose_sig_format(const Private_Key &key, const std::string &hash_fn, AlgorithmIdentifier &sig_algo)
Definition: x509_ca.cpp:227

§ create_self_signed_cert()

BOTAN_DLL 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 43 of file x509self.cpp.

References Botan::Extensions::add(), BER_encode(), 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::is_CA, Botan::KEY_CERT_SIGN, Botan::X509_CA::make_cert(), Botan::NO_CONSTRAINTS, Botan::X509_Cert_Options::path_limit, Botan::X509_Cert_Options::start, and Botan::verify_cert_constraints_valid_for_key_type().

47  {
48  AlgorithmIdentifier sig_algo;
49  X509_DN subject_dn;
50  AlternativeName subject_alt;
51 
52  std::vector<byte> pub_key = X509::BER_encode(key);
53  std::unique_ptr<PK_Signer> signer(choose_sig_format(key, hash_fn, sig_algo));
54  load_info(opts, subject_dn, subject_alt);
55 
56  Key_Constraints constraints;
57  if(opts.is_CA)
58  {
59  constraints = Key_Constraints(KEY_CERT_SIGN | CRL_SIGN);
60  }
61  else
62  {
63  verify_cert_constraints_valid_for_key_type(key, opts.constraints);
64  constraints = opts.constraints;
65  }
66 
67  Extensions extensions;
68 
69  extensions.add(
70  new Cert_Extension::Basic_Constraints(opts.is_CA, opts.path_limit),
71  true);
72 
73  if(constraints != NO_CONSTRAINTS)
74  {
75  extensions.add(new Cert_Extension::Key_Usage(constraints), true);
76  }
77 
78  extensions.add(new Cert_Extension::Subject_Key_ID(pub_key));
79 
80  extensions.add(
81  new Cert_Extension::Subject_Alternative_Name(subject_alt));
82 
83  extensions.add(
84  new Cert_Extension::Extended_Key_Usage(opts.ex_constraints));
85 
86  return X509_CA::make_cert(signer.get(), rng, sig_algo, pub_key,
87  opts.start, opts.end,
88  subject_dn, subject_dn,
89  extensions);
90  }
Definition: ffi.h:507
void verify_cert_constraints_valid_for_key_type(const Public_Key &pub_key, Key_Constraints constraints)
secure_vector< byte > BER_encode(const Private_Key &key)
Definition: pkcs8.cpp:130
PK_Signer * choose_sig_format(const Private_Key &key, const std::string &hash_fn, AlgorithmIdentifier &sig_algo)
Definition: x509_ca.cpp:227

§ load_key() [1/3]

BOTAN_DLL 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 41 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::make_public_key(), Botan::PEM_Code::matches(), Botan::ASN1::maybe_BER(), Botan::SEQUENCE, Botan::BER_Decoder::start_cons(), Botan::BER_Decoder::verify_end(), and Botan::Exception::what().

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

42  {
43  try {
44  AlgorithmIdentifier alg_id;
45  secure_vector<byte> key_bits;
46 
47  if(ASN1::maybe_BER(source) && !PEM_Code::matches(source))
48  {
49  BER_Decoder(source)
50  .start_cons(SEQUENCE)
51  .decode(alg_id)
52  .decode(key_bits, BIT_STRING)
53  .verify_end()
54  .end_cons();
55  }
56  else
57  {
58  DataSource_Memory ber(
59  PEM_Code::decode_check_label(source, "PUBLIC KEY")
60  );
61 
62  BER_Decoder(ber)
63  .start_cons(SEQUENCE)
64  .decode(alg_id)
65  .decode(key_bits, BIT_STRING)
66  .verify_end()
67  .end_cons();
68  }
69 
70  if(key_bits.empty())
71  throw Decoding_Error("X.509 public key decoding failed");
72 
73  return make_public_key(alg_id, key_bits);
74  }
75  catch(Decoding_Error& e)
76  {
77  throw Decoding_Error("X.509 public key decoding failed: " + std::string(e.what()));
78  }
79  }
bool maybe_BER(DataSource &source)
Definition: asn1_obj.cpp:55
Public_Key * make_public_key(const AlgorithmIdentifier &alg_id, const secure_vector< byte > &key_bits)
Definition: pk_algs.cpp:57
bool matches(DataSource &source, const std::string &extra, size_t search_range)
Definition: pem.cpp:140
secure_vector< byte > decode_check_label(DataSource &source, const std::string &label_want)
Definition: pem.cpp:54

§ load_key() [2/3]

BOTAN_DLL Public_Key * Botan::X509::load_key ( const std::string &  filename)

Create a public key from a file

Parameters
filenamepathname to the file to load
Returns
new public key object

Definition at line 84 of file x509_key.cpp.

References load_key().

85  {
86  DataSource_Stream source(fsname, true);
87  return X509::load_key(source);
88  }
Public_Key * load_key(const std::vector< byte > &mem)
Definition: x509_key.cpp:93

§ load_key() [3/3]

BOTAN_DLL Public_Key * Botan::X509::load_key ( const std::vector< byte > &  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 93 of file x509_key.cpp.

References load_key().

94  {
95  DataSource_Memory source(mem);
96  return X509::load_key(source);
97  }
Public_Key * load_key(const std::vector< byte > &mem)
Definition: x509_key.cpp:93

§ PEM_encode()

BOTAN_DLL 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 32 of file x509_key.cpp.

References BER_encode(), and Botan::PEM_Code::encode().

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

33  {
35  "PUBLIC KEY");
36  }
std::vector< byte > BER_encode(const Public_Key &key)
Definition: x509_key.cpp:19
std::string encode(const byte der[], size_t length, const std::string &label, size_t width)
Definition: pem.cpp:43