#include <x509_obj.h>

Inheritance diagram for Botan::X509_Object:

Public Member Functions
std::vector< byte >	BER_encode () const

bool	check_signature (const Public_Key &key) const

bool	check_signature (const Public_Key *key) const

void	decode_from (class BER_Decoder &from) override

void	encode_into (class DER_Encoder &to) const override

std::string	hash_used_for_signature () const

std::string	PEM_encode () const

std::vector< byte >	signature () const

AlgorithmIdentifier	signature_algorithm () const

std::vector< byte >	tbs_data () const

virtual	~X509_Object ()

Static Public Member Functions
static std::vector< byte >	make_signed (class PK_Signer *signer, RandomNumberGenerator &rng, const AlgorithmIdentifier &alg_id, const secure_vector< byte > &tbs)

Protected Member Functions
void	do_decode ()

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

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

	X509_Object (const std::vector< byte > &vec, const std::string &labels)

	X509_Object ()

Protected Attributes
std::vector< byte >	sig

AlgorithmIdentifier	sig_algo

std::vector< 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

virtual Botan::X509_Object::~X509_Object ( )

inlinevirtual

Definition at line 89 of file x509_obj.h.

89 {}

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);
    }

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);
    }

Botan::X509_Object::X509_Object	(	const std::vector< byte > &	vec,
		const std::string &	labels
	)

protected

Definition at line 41 of file x509_obj.cpp.

    {
    DataSource_Memory stream(&vec[0], vec.size());
    init(stream, labels);
    }

Botan::X509_Object::X509_Object ( )

inlineprotected

Definition at line 96 of file x509_obj.h.

96 {}

Member Function Documentation

std::vector< byte > Botan::X509_Object::BER_encode ( ) const

Returns: BER encoding of this

Definition at line 114 of file x509_obj.cpp.

References encode_into(), and Botan::DER_Encoder::get_contents_unlocked().

Referenced by Botan::X509_Certificate::fingerprint(), and PEM_encode().

    {
    DER_Encoder der;
    encode_into(der);
    return der.get_contents_unlocked();
    }

bool Botan::X509_Object::check_signature ( const 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 186 of file x509_obj.cpp.

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(), and Botan::x509_path_validate().

    {
    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(std::exception& e)
       {
       return false;
       }
    }

bool Botan::X509_Object::check_signature ( const 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 177 of file x509_obj.cpp.

References check_signature().

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

void Botan::X509_Object::decode_from ( class BER_Decoder & from )

overridevirtual

Decode whatever this object is from from

Parameters

from	the BER_Decoder that will be read from

Implements Botan::ASN1_Object.

Definition at line 99 of file x509_obj.cpp.

References Botan::BIT_STRING, Botan::BER_Decoder::decode(), Botan::BER_Decoder::end_cons(), Botan::BER_Decoder::raw_bytes(), Botan::SEQUENCE, sig, sig_algo, Botan::BER_Decoder::start_cons(), tbs_bits, and Botan::BER_Decoder::verify_end().

    {
    from.start_cons(SEQUENCE)
          .start_cons(SEQUENCE)
             .raw_bytes(tbs_bits)
          .end_cons()
          .decode(sig_algo)
          .decode(sig, BIT_STRING)
          .verify_end()
       .end_cons();
    }

void Botan::X509_Object::do_decode ( )

protected

Definition at line 229 of file x509_obj.cpp.

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

    {
    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() + ")");
       }
    }

void Botan::X509_Object::encode_into ( class DER_Encoder & to ) const

overridevirtual

Encode whatever this object is into to

Parameters

to	the DER_Encoder that will be written to

Implements Botan::ASN1_Object.

Definition at line 85 of file x509_obj.cpp.

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

Referenced by BER_encode().

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

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

Returns: hash algorithm that was used to generate signature

Definition at line 156 of file x509_obj.cpp.

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

Referenced by Botan::x509_path_validate().

    {
    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];
    }

std::vector< byte > Botan::X509_Object::make_signed	(	class PK_Signer *	signer,
		RandomNumberGenerator &	rng,
		const AlgorithmIdentifier &	alg_id,
		const secure_vector< 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 212 of file x509_obj.cpp.

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

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

    {
    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_unlocked();
    }

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

Returns: PEM encoding of this

Definition at line 124 of file x509_obj.cpp.

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

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

std::vector< byte > Botan::X509_Object::signature ( ) const

Returns: signature on tbs_data()

Definition at line 140 of file x509_obj.cpp.

References sig.

Referenced by check_signature().

    {
    return sig;
    }

AlgorithmIdentifier Botan::X509_Object::signature_algorithm ( ) const

Returns: signature algorithm that was used to generate signature

Definition at line 148 of file x509_obj.cpp.

References sig_algo.

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

    {
    return sig_algo;
    }

std::vector< 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 132 of file x509_obj.cpp.

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

Referenced by check_signature().

    {
    return ASN1::put_in_sequence(tbs_bits);
    }

Member Data Documentation

std::vector<byte> Botan::X509_Object::sig

protected

Definition at line 98 of file x509_obj.h.

Referenced by decode_from(), encode_into(), Botan::X509_Certificate::operator<(), Botan::X509_Certificate::operator==(), and signature().

AlgorithmIdentifier Botan::X509_Object::sig_algo

protected

Definition at line 97 of file x509_obj.h.

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

std::vector<byte> Botan::X509_Object::tbs_bits

protected

Definition at line 98 of file x509_obj.h.

Referenced by decode_from(), encode_into(), Botan::X509_Certificate::operator<(), and tbs_data().

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

src/cert/x509/x509_obj.h
src/cert/x509/x509_obj.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation