Botan::X509 Namespace Reference

Functions
MemoryVector< byte >	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)
void	encode (const Public_Key &key, Pipe &pipe, X509_Encoding encoding=PEM)
Key_Constraints	find_constraints (const Public_Key &pub_key, Key_Constraints limits)
Public_Key *	load_key (const MemoryRegion< byte > &mem)
Public_Key *	load_key (const std::string &fsname)
Public_Key *	load_key (DataSource &source)
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 MemoryVector< byte > Botan::X509::BER_encode

(

const Public_Key &

key

)

BER encode a key

Parameters

key	the public key to encode

Returns

BER encoding of this key

Definition at line 21 of file x509_key.cpp.

   {
   return DER_Encoder()
         .start_cons(SEQUENCE)
            .encode(key.algorithm_identifier())
            .encode(key.x509_subject_public_key(), BIT_STRING)
         .end_cons()
      .get_contents();
   }

References Botan::Public_Key::algorithm_identifier(), BER_encode(), Botan::BIT_STRING, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::SEQUENCE, Botan::DER_Encoder::start_cons(), and Botan::Public_Key::x509_subject_public_key().

Referenced by BER_encode(), create_cert_req(), create_self_signed_cert(), encode(), and PEM_encode().

copy_key()

BOTAN_DLL Public_Key * Botan::X509::copy_key

(

const Public_Key &

key

)

Copy a key.

Parameters

key	the public key to copy

Returns

new public key object

Definition at line 104 of file x509_key.cpp.

   {
   DataSource_Memory source(PEM_encode(key));
   return X509::load_key(source);
   }

References copy_key(), load_key(), and PEM_encode().

Referenced by copy_key().

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

opts	the options defining the request to create
key	the key used to sign this request
rng	the rng to use
hash_fn	the hash function to use

Returns

newly created PKCS#10 request

Definition at line 91 of file x509self.cpp.

   {
   AlgorithmIdentifier sig_algo;
   X509_DN subject_dn;
   AlternativeName subject_alt;
 
   opts.sanity_check();
 
   MemoryVector<byte> pub_key = X509::BER_encode(key);
   std::auto_ptr<PK_Signer> signer(choose_sig_format(key, hash_fn, sig_algo));
   load_info(opts, subject_dn, subject_alt);
 
   const size_t PKCS10_VERSION = 0;
 
   Extensions extensions;
 
   extensions.add(
      new Cert_Extension::Basic_Constraints(opts.is_CA, opts.path_limit));
   extensions.add(
      new Cert_Extension::Key_Usage(
         opts.is_CA ? Key_Constraints(KEY_CERT_SIGN | CRL_SIGN) :
                      find_constraints(key, opts.constraints)
         )
      );
   extensions.add(
      new Cert_Extension::Extended_Key_Usage(opts.ex_constraints));
   extensions.add(
      new Cert_Extension::Subject_Alternative_Name(subject_alt));
 
   DER_Encoder tbs_req;
 
   tbs_req.start_cons(SEQUENCE)
      .encode(PKCS10_VERSION)
      .encode(subject_dn)
      .raw_bytes(pub_key)
      .start_explicit(0);
 
   if(opts.challenge != "")
      {
      ASN1_String challenge(opts.challenge, DIRECTORY_STRING);
 
      tbs_req.encode(
         Attribute("PKCS9.ChallengePassword",
                   DER_Encoder().encode(challenge).get_contents()
            )
         );
      }
 
   tbs_req.encode(
      Attribute("PKCS9.ExtensionRequest",
                DER_Encoder()
                   .start_cons(SEQUENCE)
                      .encode(extensions)
                   .end_cons()
               .get_contents()
         )
      )
      .end_explicit()
      .end_cons();
 
   DataSource_Memory source(
      X509_Object::make_signed(signer.get(),
                               rng,
                               sig_algo,
                               tbs_req.get_contents())
      );
 
   return PKCS10_Request(source);
   }

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

Referenced by create_cert_req().

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

opts	the options defining the certificate to create
key	the private key used for signing, i.e. the key associated with this self-signed certificate
hash_fn	the hash function to use
rng	the rng to use

Returns

newly created self-signed certificate

Definition at line 45 of file x509self.cpp.

   {
   AlgorithmIdentifier sig_algo;
   X509_DN subject_dn;
   AlternativeName subject_alt;
 
   opts.sanity_check();
 
   MemoryVector<byte> pub_key = X509::BER_encode(key);
   std::auto_ptr<PK_Signer> signer(choose_sig_format(key, hash_fn, sig_algo));
   load_info(opts, subject_dn, subject_alt);
 
   Key_Constraints constraints;
   if(opts.is_CA)
      constraints = Key_Constraints(KEY_CERT_SIGN | CRL_SIGN);
   else
      constraints = find_constraints(key, opts.constraints);
 
   Extensions extensions;
 
   extensions.add(
      new Cert_Extension::Basic_Constraints(opts.is_CA, opts.path_limit),
      true);
 
   extensions.add(new Cert_Extension::Key_Usage(constraints), true);
 
   extensions.add(new Cert_Extension::Subject_Key_ID(pub_key));
 
   extensions.add(
      new Cert_Extension::Subject_Alternative_Name(subject_alt));
 
   extensions.add(
      new Cert_Extension::Extended_Key_Usage(opts.ex_constraints));
 
   return X509_CA::make_cert(signer.get(), rng, sig_algo, pub_key,
                             opts.start, opts.end,
                             subject_dn, subject_dn,
                             extensions);
   }

References Botan::Extensions::add(), BER_encode(), Botan::choose_sig_format(), Botan::X509_Cert_Options::constraints, create_self_signed_cert(), Botan::CRL_SIGN, Botan::X509_Cert_Options::end, Botan::X509_Cert_Options::ex_constraints, find_constraints(), Botan::X509_Cert_Options::is_CA, Botan::KEY_CERT_SIGN, Botan::X509_CA::make_cert(), Botan::X509_Cert_Options::path_limit, Botan::X509_Cert_Options::sanity_check(), and Botan::X509_Cert_Options::start.

Referenced by create_self_signed_cert().

encode()

void Botan::X509::encode ( const Public_Key & key, Pipe & pipe, X509_Encoding encoding = PEM )

inline

Encode a key into a pipe.

Deprecated

Use PEM_encode or BER_encode instead

Parameters

key	the public key to encode
pipe	the pipe to feed the encoded key into
encoding	the encoding type to use

Definition at line 87 of file x509_key.h.

   {
   if(encoding == PEM)
      pipe.write(X509::PEM_encode(key));
   else
      pipe.write(X509::BER_encode(key));
   }

References BER_encode(), encode(), Botan::PEM, and PEM_encode().

Referenced by create_cert_req(), and encode().

find_constraints()

BOTAN_DLL Key_Constraints Botan::X509::find_constraints	(	const Public_Key &	pub_key,
		Key_Constraints	limits )

Create the key constraints for a specific public key.

Parameters

pub_key	the public key from which the basic set of constraints to be placed in the return value is derived
limits	additional limits that will be incorporated into the return value

Returns

combination of key type specific constraints and additional limits

Definition at line 113 of file x509_key.cpp.

   {
   const std::string name = pub_key.algo_name();
 
   size_t constraints = 0;
 
   if(name == "DH" || name == "ECDH")
      constraints |= KEY_AGREEMENT;
 
   if(name == "RSA" || name == "ElGamal")
      constraints |= KEY_ENCIPHERMENT | DATA_ENCIPHERMENT;
 
   if(name == "RSA" || name == "RW" || name == "NR" ||
      name == "DSA" || name == "ECDSA")
      constraints |= DIGITAL_SIGNATURE | NON_REPUDIATION;
 
   if(limits)
      constraints &= limits;
 
   return Key_Constraints(constraints);
   }

References Botan::Public_Key::algo_name(), Botan::DATA_ENCIPHERMENT, Botan::DIGITAL_SIGNATURE, find_constraints(), Botan::KEY_AGREEMENT, Botan::KEY_ENCIPHERMENT, and Botan::NON_REPUDIATION.

Referenced by create_cert_req(), create_self_signed_cert(), find_constraints(), and Botan::X509_CA::sign_request().

load_key() [1/3]

BOTAN_DLL Public_Key * Botan::X509::load_key

(

const MemoryRegion< byte > &

enc

)

Create a public key from a memory region.

Parameters

enc	the memory region containing the DER or PEM encoded key

Returns

new public key object

Definition at line 95 of file x509_key.cpp.

   {
   DataSource_Memory source(mem);
   return X509::load_key(source);
   }

References load_key().

load_key() [2/3]

BOTAN_DLL Public_Key * Botan::X509::load_key

(

const std::string &

filename

)

Create a public key from a file

Parameters

filename

pathname to the file to load

Returns

new public key object

Definition at line 86 of file x509_key.cpp.

   {
   DataSource_Stream source(fsname, true);
   return X509::load_key(source);
   }

References load_key().

load_key() [3/3]

BOTAN_DLL Public_Key * Botan::X509::load_key

(

DataSource &

source

)

Create a public key from a data source.

Parameters

source

the source providing the DER or PEM encoded key

Returns

new public key object

Definition at line 43 of file x509_key.cpp.

   {
   try {
      AlgorithmIdentifier alg_id;
      MemoryVector<byte> key_bits;
 
      if(ASN1::maybe_BER(source) && !PEM_Code::matches(source))
         {
         BER_Decoder(source)
            .start_cons(SEQUENCE)
            .decode(alg_id)
            .decode(key_bits, BIT_STRING)
            .verify_end()
         .end_cons();
         }
      else
         {
         DataSource_Memory ber(
            PEM_Code::decode_check_label(source, "PUBLIC KEY")
            );
 
         BER_Decoder(ber)
            .start_cons(SEQUENCE)
            .decode(alg_id)
            .decode(key_bits, BIT_STRING)
            .verify_end()
         .end_cons();
         }
 
      if(key_bits.empty())
         throw Decoding_Error("X.509 public key decoding failed");
 
      return make_public_key(alg_id, key_bits);
      }
   catch(Decoding_Error)
      {
      throw Decoding_Error("X.509 public key decoding failed");
      }
   }

References Botan::BER_Decoder::BER_Decoder(), Botan::BIT_STRING, Botan::PEM_Code::decode_check_label(), Botan::Decoding_Error::Decoding_Error(), Botan::MemoryRegion< T >::empty(), load_key(), Botan::make_public_key(), Botan::PEM_Code::matches(), Botan::ASN1::maybe_BER(), and Botan::SEQUENCE.

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

PEM_encode()

BOTAN_DLL std::string Botan::X509::PEM_encode

(

const Public_Key &

key

)

PEM encode a public key into a string.

Parameters

key	the key to encode

Returns

PEM encoded key

Definition at line 34 of file x509_key.cpp.

   {
   return PEM_Code::encode(X509::BER_encode(key),
                           "PUBLIC KEY");
   }

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

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