Botan  1.11.11
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Botan::X509_Object Class Referenceabstract

#include <x509_obj.h>

Inheritance diagram for Botan::X509_Object:
Botan::ASN1_Object Botan::PKCS10_Request Botan::X509_Certificate Botan::X509_CRL

Public Member Functions

std::vector< byteBER_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< bytesignature () const
 
AlgorithmIdentifier signature_algorithm () const
 
std::vector< bytetbs_data () const
 
virtual ~X509_Object ()
 

Static Public Member Functions

static std::vector< bytemake_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< bytesig
 
AlgorithmIdentifier sig_algo
 
std::vector< bytetbs_bits
 

Detailed Description

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

Definition at line 22 of file x509_obj.h.

Constructor & Destructor Documentation

virtual Botan::X509_Object::~X509_Object ( )
inlinevirtual

Definition at line 88 of file x509_obj.h.

88 {}
Botan::X509_Object::X509_Object ( DataSource src,
const std::string &  pem_labels 
)
protected

Definition at line 23 of file x509_obj.cpp.

24  {
25  init(stream, labels);
26  }
Botan::X509_Object::X509_Object ( const std::string &  file,
const std::string &  pem_labels 
)
protected

Definition at line 31 of file x509_obj.cpp.

32  {
33  DataSource_Stream stream(file, true);
34  init(stream, labels);
35  }
Botan::X509_Object::X509_Object ( const std::vector< byte > &  vec,
const std::string &  labels 
)
protected

Definition at line 40 of file x509_obj.cpp.

41  {
42  DataSource_Memory stream(&vec[0], vec.size());
43  init(stream, labels);
44  }
Botan::X509_Object::X509_Object ( )
inlineprotected

Definition at line 95 of file x509_obj.h.

95 {}

Member Function Documentation

std::vector< byte > Botan::X509_Object::BER_encode ( ) const
Returns
BER encoding of this

Definition at line 113 of file x509_obj.cpp.

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

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

114  {
115  DER_Encoder der;
116  encode_into(der);
117  return der.get_contents_unlocked();
118  }
void encode_into(class DER_Encoder &to) const override
Definition: x509_obj.cpp:84
bool Botan::X509_Object::check_signature ( const Public_Key key) const

Check the signature on this data

Parameters
keythe public key purportedly used to sign this data
Returns
true if the signature is valid, otherwise false

Definition at line 185 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().

186  {
187  try {
188  std::vector<std::string> sig_info =
190 
191  if(sig_info.size() != 2 || sig_info[0] != pub_key.algo_name())
192  return false;
193 
194  std::string padding = sig_info[1];
195  Signature_Format format =
196  (pub_key.message_parts() >= 2) ? DER_SEQUENCE : IEEE_1363;
197 
198  PK_Verifier verifier(pub_key, padding, format);
199 
200  return verifier.verify_message(tbs_data(), signature());
201  }
202  catch(std::exception& e)
203  {
204  return false;
205  }
206  }
Signature_Format
Definition: pubkey.h:24
std::vector< std::string > split_on(const std::string &str, char delim)
Definition: parsing.cpp:108
AlgorithmIdentifier sig_algo
Definition: x509_obj.h:96
std::vector< byte > signature() const
Definition: x509_obj.cpp:139
std::string lookup(const OID &oid)
Definition: oids.cpp:111
std::vector< byte > tbs_data() const
Definition: x509_obj.cpp:131
bool Botan::X509_Object::check_signature ( const Public_Key key) const

Check the signature on this data

Parameters
keythe 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 176 of file x509_obj.cpp.

References check_signature().

177  {
178  std::unique_ptr<const Public_Key> key(pub_key);
179  return check_signature(*key);
180  }
bool check_signature(const Public_Key &key) const
Definition: x509_obj.cpp:185
void Botan::X509_Object::decode_from ( class BER_Decoder from)
overridevirtual

Decode whatever this object is from from

Parameters
fromthe BER_Decoder that will be read from

Implements Botan::ASN1_Object.

Definition at line 98 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().

99  {
100  from.start_cons(SEQUENCE)
101  .start_cons(SEQUENCE)
102  .raw_bytes(tbs_bits)
103  .end_cons()
104  .decode(sig_algo)
105  .decode(sig, BIT_STRING)
106  .verify_end()
107  .end_cons();
108  }
std::vector< byte > sig
Definition: x509_obj.h:97
AlgorithmIdentifier sig_algo
Definition: x509_obj.h:96
std::vector< byte > tbs_bits
Definition: x509_obj.h:97
void Botan::X509_Object::do_decode ( )
protected

Definition at line 228 of file x509_obj.cpp.

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

229  {
230  try {
231  force_decode();
232  }
233  catch(Decoding_Error& e)
234  {
235  throw Decoding_Error(PEM_label_pref + " decoding failed (" +
236  e.what() + ")");
237  }
238  catch(Invalid_Argument& e)
239  {
240  throw Decoding_Error(PEM_label_pref + " decoding failed (" +
241  e.what() + ")");
242  }
243  }
std::invalid_argument Invalid_Argument
Definition: exceptn.h:20
void Botan::X509_Object::encode_into ( class DER_Encoder to) const
overridevirtual

Encode whatever this object is into to

Parameters
tothe DER_Encoder that will be written to

Implements Botan::ASN1_Object.

Definition at line 84 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().

85  {
86  to.start_cons(SEQUENCE)
87  .start_cons(SEQUENCE)
88  .raw_bytes(tbs_bits)
89  .end_cons()
90  .encode(sig_algo)
91  .encode(sig, BIT_STRING)
92  .end_cons();
93  }
std::vector< byte > sig
Definition: x509_obj.h:97
AlgorithmIdentifier sig_algo
Definition: x509_obj.h:96
std::vector< byte > tbs_bits
Definition: x509_obj.h:97
std::string Botan::X509_Object::hash_used_for_signature ( ) const
Returns
hash algorithm that was used to generate signature

Definition at line 155 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().

156  {
157  std::vector<std::string> sig_info =
159 
160  if(sig_info.size() != 2)
161  throw Internal_Error("Invalid name format found for " +
163 
164  std::vector<std::string> pad_and_hash =
165  parse_algorithm_name(sig_info[1]);
166 
167  if(pad_and_hash.size() != 2)
168  throw Internal_Error("Invalid name format " + sig_info[1]);
169 
170  return pad_and_hash[1];
171  }
std::vector< std::string > parse_algorithm_name(const std::string &namex)
Definition: parsing.cpp:55
std::vector< std::string > split_on(const std::string &str, char delim)
Definition: parsing.cpp:108
AlgorithmIdentifier sig_algo
Definition: x509_obj.h:96
std::string lookup(const OID &oid)
Definition: oids.cpp:111
std::string as_string() const
Definition: asn1_oid.cpp:50
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
signerthe signer used to sign the object
rngthe random number generator to use
alg_idthe algorithm identifier of the signature scheme
tbsthe tbs bits to be signed
Returns
signed X509 object

Definition at line 211 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().

215  {
216  return DER_Encoder()
217  .start_cons(SEQUENCE)
218  .raw_bytes(tbs_bits)
219  .encode(algo)
220  .encode(signer->sign_message(tbs_bits, rng), BIT_STRING)
221  .end_cons()
222  .get_contents_unlocked();
223  }
std::vector< byte > tbs_bits
Definition: x509_obj.h:97
std::string Botan::X509_Object::PEM_encode ( ) const
Returns
PEM encoding of this

Definition at line 123 of file x509_obj.cpp.

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

124  {
125  return PEM_Code::encode(BER_encode(), PEM_label_pref);
126  }
std::vector< byte > BER_encode() const
Definition: x509_obj.cpp:113
std::string encode(const byte der[], size_t length, const std::string &label, size_t width)
Definition: pem.cpp:19
std::vector< byte > Botan::X509_Object::signature ( ) const
Returns
signature on tbs_data()

Definition at line 139 of file x509_obj.cpp.

References sig.

Referenced by check_signature().

140  {
141  return sig;
142  }
std::vector< byte > sig
Definition: x509_obj.h:97
AlgorithmIdentifier Botan::X509_Object::signature_algorithm ( ) const
Returns
signature algorithm that was used to generate signature

Definition at line 147 of file x509_obj.cpp.

References sig_algo.

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

148  {
149  return sig_algo;
150  }
AlgorithmIdentifier sig_algo
Definition: x509_obj.h:96
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 131 of file x509_obj.cpp.

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

Referenced by check_signature().

132  {
134  }
std::vector< byte > put_in_sequence(const std::vector< byte > &contents)
Definition: asn1_obj.cpp:34
std::vector< byte > tbs_bits
Definition: x509_obj.h:97

Member Data Documentation

std::vector<byte> Botan::X509_Object::sig
protected
AlgorithmIdentifier Botan::X509_Object::sig_algo
protected
std::vector<byte> Botan::X509_Object::tbs_bits
protected

Definition at line 97 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: