#include <pkcs10.h>

Inheritance diagram for Botan::PKCS10_Request:

Public Member Functions
MemoryVector< byte >	BER_encode () const
std::string	challenge_password () const
bool	check_signature (class Public_Key &key) const
bool	check_signature (class Public_Key *key) const
Key_Constraints	constraints () const
void	encode (Pipe &out, X509_Encoding encoding=PEM) const
std::vector< OID >	ex_constraints () const
std::string	hash_used_for_signature () const
bool	is_CA () const
u32bit	path_limit () const
std::string	PEM_encode () const
	PKCS10_Request (const std::string &filename)
	PKCS10_Request (DataSource &source)
MemoryVector< byte >	raw_public_key () const
MemoryVector< byte >	signature () const
AlgorithmIdentifier	signature_algorithm () const
AlternativeName	subject_alt_name () const
X509_DN	subject_dn () const
Public_Key *	subject_public_key () const
MemoryVector< byte >	tbs_data () const

Static Public Member Functions
static MemoryVector< byte >	make_signed (class PK_Signer *signer, RandomNumberGenerator &rng, const AlgorithmIdentifier &alg_id, const MemoryRegion< byte > &tbs)

Protected Member Functions
void	do_decode ()

Protected Attributes
MemoryVector< byte >	sig
AlgorithmIdentifier	sig_algo
MemoryVector< byte >	tbs_bits

Detailed Description

PKCS #10 Certificate Request.

Definition at line 22 of file pkcs10.h.

Constructor & Destructor Documentation

◆ PKCS10_Request() [1/2]

Botan::PKCS10_Request::PKCS10_Request ( DataSource & source )

Create a PKCS#10 Request from a data source.

Parameters

source the data source providing the DER encoded request

Definition at line 22 of file pkcs10.cpp.

                                             :
   X509_Object(in, "CERTIFICATE REQUEST/NEW CERTIFICATE REQUEST")
   {
   do_decode();
   }

References Botan::X509_Object::do_decode(), and Botan::X509_Object::X509_Object().

Referenced by Botan::X509::create_cert_req().

◆ PKCS10_Request() [2/2]

Botan::PKCS10_Request::PKCS10_Request ( const std::string & filename )

Create a PKCS#10 Request from a file.

Parameters

filename the name of the file containing the DER or PEM encoded request file

Definition at line 31 of file pkcs10.cpp.

                                                  :
   X509_Object(in, "CERTIFICATE REQUEST/NEW CERTIFICATE REQUEST")
   {
   do_decode();
   }

References Botan::X509_Object::do_decode(), and Botan::X509_Object::X509_Object().

Member Function Documentation

◆ BER_encode()

MemoryVector< byte > Botan::X509_Object::BER_encode ( ) const

inherited

Returns: BER encoding of this

Definition at line 100 of file x509_obj.cpp.

   {
   return DER_Encoder()
      .start_cons(SEQUENCE)
         .start_cons(SEQUENCE)
            .raw_bytes(tbs_bits)
         .end_cons()
         .encode(sig_algo)
         .encode(sig, BIT_STRING)
      .end_cons()
   .get_contents();
   }

References Botan::BIT_STRING, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::DER_Encoder::raw_bytes(), Botan::SEQUENCE, sig, sig_algo, Botan::DER_Encoder::start_cons(), and tbs_bits.

Referenced by encode(), PEM_encode(), and Botan::CMS_Encoder::sign().

◆ challenge_password()

std::string Botan::PKCS10_Request::challenge_password ( ) const

Get the challenge password for this request

Returns: challenge password for this request

Definition at line 123 of file pkcs10.cpp.

   {
   return info.get1("PKCS9.ChallengePassword");
   }

◆ check_signature() [1/2]

bool Botan::X509_Object::check_signature ( class Public_Key & key ) const

inherited

Check the signature on this data

Parameters

key	the public key purportedly used to sign this data

Returns: true if the signature is valid, otherwise false

Definition at line 178 of file x509_obj.cpp.

   {
   try {
      std::vector<std::string> sig_info =
         split_on(OIDS::lookup(sig_algo.oid), '/');
 
      if(sig_info.size() != 2 || sig_info[0] != pub_key.algo_name())
         return false;
 
      std::string padding = sig_info[1];
      Signature_Format format =
         (pub_key.message_parts() >= 2) ? DER_SEQUENCE : IEEE_1363;
 
      PK_Verifier verifier(pub_key, padding, format);
 
      return verifier.verify_message(tbs_data(), signature());
      }
   catch(...)
      {
      return false;
      }
   }

References Botan::Public_Key::algo_name(), Botan::DER_SEQUENCE, Botan::IEEE_1363, Botan::OIDS::lookup(), Botan::Public_Key::message_parts(), Botan::AlgorithmIdentifier::oid, sig_algo, signature(), Botan::split_on(), tbs_data(), and Botan::PK_Verifier::verify_message().

Referenced by check_signature().

◆ check_signature() [2/2]

bool Botan::X509_Object::check_signature ( class Public_Key * key ) const

inherited

Check the signature on this data

Parameters

key	the public key purportedly used to sign this data the pointer will be deleted after use

Returns: true if the signature is valid, otherwise false

Definition at line 169 of file x509_obj.cpp.

   {
   std::auto_ptr<Public_Key> key(pub_key);
   return check_signature(*key);
   }

References check_signature().

◆ constraints()

Key_Constraints Botan::PKCS10_Request::constraints ( ) const

Get the key constraints for the key associated with this PKCS#10 object.

Returns: key constraints

Definition at line 165 of file pkcs10.cpp.

   {
   return Key_Constraints(info.get1_u32bit("X509v3.KeyUsage", NO_CONSTRAINTS));
   }

References Botan::NO_CONSTRAINTS.

Referenced by Botan::X509_CA::sign_request().

◆ do_decode()

void Botan::X509_Object::do_decode ( )

protectedinherited

Definition at line 221 of file x509_obj.cpp.

   {
   try {
      force_decode();
      }
   catch(Decoding_Error& e)
      {
      throw Decoding_Error(PEM_label_pref + " decoding failed (" +
                           e.what() + ")");
      }
   catch(Invalid_Argument& e)
      {
      throw Decoding_Error(PEM_label_pref + " decoding failed (" +
                           e.what() + ")");
      }
   }

References Botan::Decoding_Error::Decoding_Error().

Referenced by Botan::PKCS10_Request::PKCS10_Request(), Botan::PKCS10_Request::PKCS10_Request(), Botan::X509_Certificate::X509_Certificate(), Botan::X509_Certificate::X509_Certificate(), Botan::X509_CRL::X509_CRL(), and Botan::X509_CRL::X509_CRL().

◆ encode()

void Botan::X509_Object::encode	(	Pipe &	out,
		X509_Encoding	encoding = PEM ) const

inherited

Encode this to a pipe

Deprecated: use BER_encode or PEM_encode instead

Parameters

out	the pipe to write to
encoding	the encoding to use

Definition at line 89 of file x509_obj.cpp.

   {
   if(encoding == PEM)
      out.write(this->PEM_encode());
   else
      out.write(this->BER_encode());
   }

References BER_encode(), Botan::PEM, PEM_encode(), and Botan::Pipe::write().

◆ ex_constraints()

std::vector< OID > Botan::PKCS10_Request::ex_constraints ( ) const

Get the extendend key constraints (if any).

Returns: extended key constraints

Definition at line 173 of file pkcs10.cpp.

   {
   std::vector<std::string> oids = info.get("X509v3.ExtendedKeyUsage");
 
   std::vector<OID> result;
   for(size_t i = 0; i != oids.size(); ++i)
      result.push_back(OID(oids[i]));
   return result;
   }

Referenced by Botan::X509_CA::sign_request().

◆ hash_used_for_signature()

std::string Botan::X509_Object::hash_used_for_signature ( ) const

inherited

Returns: hash algorithm that was used to generate signature

Definition at line 148 of file x509_obj.cpp.

   {
   std::vector<std::string> sig_info =
      split_on(OIDS::lookup(sig_algo.oid), '/');
 
   if(sig_info.size() != 2)
      throw Internal_Error("Invalid name format found for " +
                           sig_algo.oid.as_string());
 
   std::vector<std::string> pad_and_hash =
      parse_algorithm_name(sig_info[1]);
 
   if(pad_and_hash.size() != 2)
      throw Internal_Error("Invalid name format " + sig_info[1]);
 
   return pad_and_hash[1];
   }

References Botan::OID::as_string(), Botan::Internal_Error::Internal_Error(), Botan::OIDS::lookup(), Botan::AlgorithmIdentifier::oid, Botan::parse_algorithm_name(), sig_algo, and Botan::split_on().

◆ is_CA()

bool Botan::PKCS10_Request::is_CA ( ) const

Find out whether this is a CA request.

Returns: true if it is a CA request, false otherwise.

Definition at line 186 of file pkcs10.cpp.

   {
   return (info.get1_u32bit("X509v3.BasicConstraints.is_ca") > 0);
   }

Referenced by Botan::X509_CA::sign_request().

◆ make_signed()

MemoryVector< byte > Botan::X509_Object::make_signed	(	class PK_Signer *	signer,
		RandomNumberGenerator &	rng,
		const AlgorithmIdentifier &	alg_id,
		const MemoryRegion< byte > &	tbs )

staticinherited

Create a signed X509 object.

Parameters

signer	the signer used to sign the object
rng	the random number generator to use
alg_id	the algorithm identifier of the signature scheme
tbs	the tbs bits to be signed

Returns: signed X509 object

Definition at line 204 of file x509_obj.cpp.

   {
   return DER_Encoder()
      .start_cons(SEQUENCE)
         .raw_bytes(tbs_bits)
         .encode(algo)
         .encode(signer->sign_message(tbs_bits, rng), BIT_STRING)
      .end_cons()
   .get_contents();
   }

References Botan::BIT_STRING, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::DER_Encoder::raw_bytes(), Botan::SEQUENCE, Botan::PK_Signer::sign_message(), Botan::DER_Encoder::start_cons(), and tbs_bits.

Referenced by Botan::X509::create_cert_req(), and Botan::X509_CA::make_cert().

◆ path_limit()

u32bit Botan::PKCS10_Request::path_limit ( ) const

Return the constraint on the path length defined in the BasicConstraints extension.

Returns: path limit

Definition at line 194 of file pkcs10.cpp.

   {
   return info.get1_u32bit("X509v3.BasicConstraints.path_constraint", 0);
   }

Referenced by Botan::X509_CA::sign_request().

◆ PEM_encode()

std::string Botan::X509_Object::PEM_encode ( ) const

inherited

Returns: PEM encoding of this

Definition at line 116 of file x509_obj.cpp.

   {
   return PEM_Code::encode(BER_encode(), PEM_label_pref);
   }

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

Referenced by encode().

◆ raw_public_key()

MemoryVector< byte > Botan::PKCS10_Request::raw_public_key ( ) const

Get the raw DER encoded public key.

Returns: raw DER encoded public key

Definition at line 139 of file pkcs10.cpp.

   {
   DataSource_Memory source(info.get1("X509.Certificate.public_key"));
   return PEM_Code::decode_check_label(source, "PUBLIC KEY");
   }

References Botan::PEM_Code::decode_check_label().

Referenced by Botan::X509_CA::sign_request().

◆ signature()

MemoryVector< byte > Botan::X509_Object::signature ( ) const

inherited

Returns: signature on tbs_data()

Definition at line 132 of file x509_obj.cpp.

   {
   return sig;
   }

References sig.

Referenced by check_signature().

◆ signature_algorithm()

AlgorithmIdentifier Botan::X509_Object::signature_algorithm ( ) const

inherited

Returns: signature algorithm that was used to generate signature

Definition at line 140 of file x509_obj.cpp.

   {
   return sig_algo;
   }

References sig_algo.

Referenced by Botan::X509_Certificate::to_string().

◆ subject_alt_name()

AlternativeName Botan::PKCS10_Request::subject_alt_name ( ) const

Get the subject alternative name.

Returns: subject alternative name.

Definition at line 157 of file pkcs10.cpp.

   {
   return create_alt_name(info);
   }

References Botan::create_alt_name().

Referenced by Botan::X509_CA::sign_request().

◆ subject_dn()

X509_DN Botan::PKCS10_Request::subject_dn ( ) const

Get the subject DN.

Returns: subject DN

Definition at line 131 of file pkcs10.cpp.

   {
   return create_dn(info);
   }

References Botan::create_dn().

Referenced by Botan::X509_CA::sign_request().

◆ subject_public_key()

Public_Key * Botan::PKCS10_Request::subject_public_key ( ) const

Get the subject public key.

Returns: subject public key

Definition at line 148 of file pkcs10.cpp.

   {
   DataSource_Memory source(info.get1("X509.Certificate.public_key"));
   return X509::load_key(source);
   }

References Botan::X509::load_key().

Referenced by Botan::X509_CA::sign_request().

◆ tbs_data()

MemoryVector< byte > Botan::X509_Object::tbs_data ( ) const

inherited

The underlying data that is to be or was signed

Returns: data that is or was signed

Definition at line 124 of file x509_obj.cpp.

   {
   return ASN1::put_in_sequence(tbs_bits);
   }

References Botan::ASN1::put_in_sequence(), and tbs_bits.

Referenced by check_signature().

Member Data Documentation

◆ sig

MemoryVector<byte> Botan::X509_Object::sig

protectedinherited

Definition at line 102 of file x509_obj.h.

Referenced by BER_encode(), Botan::X509_Certificate::operator==(), and signature().

◆ sig_algo

AlgorithmIdentifier Botan::X509_Object::sig_algo

protectedinherited

Definition at line 101 of file x509_obj.h.

Referenced by BER_encode(), check_signature(), hash_used_for_signature(), Botan::X509_Certificate::operator==(), and signature_algorithm().

◆ tbs_bits

MemoryVector<byte> Botan::X509_Object::tbs_bits

protectedinherited

Definition at line 102 of file x509_obj.h.

Referenced by BER_encode(), make_signed(), and tbs_data().

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

src/cert/pkcs10/pkcs10.h
src/cert/pkcs10/pkcs10.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PKCS10_Request() [1/2]

◆ PKCS10_Request() [2/2]

Member Function Documentation

◆ BER_encode()

◆ challenge_password()

◆ check_signature() [1/2]

◆ check_signature() [2/2]

◆ constraints()

◆ do_decode()

◆ encode()

◆ ex_constraints()

◆ hash_used_for_signature()

◆ is_CA()

◆ make_signed()

◆ path_limit()

◆ PEM_encode()

◆ raw_public_key()

◆ signature()

◆ signature_algorithm()

◆ subject_alt_name()

◆ subject_dn()

◆ subject_public_key()

◆ tbs_data()

Member Data Documentation

◆ sig

◆ sig_algo

◆ tbs_bits