Botan::X509_Object Class Reference

#include <x509_obj.h>

Inheritance diagram for Botan::X509_Object:

Public Member Functions
MemoryVector< byte >	BER_encode () const
bool	check_signature (class Public_Key &key) const
bool	check_signature (class Public_Key *key) const
void	encode (Pipe &out, X509_Encoding encoding=PEM) const
std::string	hash_used_for_signature () const
std::string	PEM_encode () const
MemoryVector< byte >	signature () const
AlgorithmIdentifier	signature_algorithm () const
MemoryVector< byte >	tbs_data () const
virtual	~X509_Object ()

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 ()
	X509_Object ()
	X509_Object (const std::string &file, const std::string &pem_labels)
	X509_Object (DataSource &src, const std::string &pem_labels)

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

Detailed Description

This class represents abstract X.509 signed objects as in the X.500 SIGNED macro

Definition at line 23 of file x509_obj.h.

Constructor & Destructor Documentation

~X509_Object()

virtual Botan::X509_Object::~X509_Object ( )

inlinevirtual

Definition at line 94 of file x509_obj.h.

{}

X509_Object() [1/3]

Botan::X509_Object::X509_Object ( DataSource & src, const std::string & pem_labels )

protected

Definition at line 24 of file x509_obj.cpp.

   {
   init(stream, labels);
   }

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().

X509_Object() [2/3]

Botan::X509_Object::X509_Object ( const std::string & file, const std::string & pem_labels )

protected

Definition at line 32 of file x509_obj.cpp.

   {
   DataSource_Stream stream(file, true);
   init(stream, labels);
   }

X509_Object() [3/3]

Botan::X509_Object::X509_Object ( )

inlineprotected

Definition at line 100 of file x509_obj.h.

{}

Member Function Documentation

BER_encode()

MemoryVector< byte > Botan::X509_Object::BER_encode

(

)

const

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().

check_signature() [1/2]

bool Botan::X509_Object::check_signature

(

class Public_Key &

key

)

const

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

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().

do_decode()

void Botan::X509_Object::do_decode ( )

protected

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

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().

hash_used_for_signature()

std::string Botan::X509_Object::hash_used_for_signature

(

)

const

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().

make_signed()

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

static

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().

PEM_encode()

std::string Botan::X509_Object::PEM_encode

(

)

const

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().

signature()

MemoryVector< byte > Botan::X509_Object::signature

(

)

const

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

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().

tbs_data()

MemoryVector< byte > Botan::X509_Object::tbs_data

(

)

const

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

protected

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

protected

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

protected

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/x509cert/x509_obj.h
• src/cert/x509cert/x509_obj.cpp