Botan  1.11.4
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Botan::X509_CRL Class Reference

#include <x509_crl.h>

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

Classes

struct  X509_CRL_Error
 

Public Member Functions

std::vector< byte > authority_key_id () const
 
std::vector< byte > BER_encode () const
 
bool check_signature (const Public_Key &key) const
 
bool check_signature (const Public_Key *key) const
 
u32bit crl_number () const
 
void decode_from (class BER_Decoder &from) override
 
void encode_into (class DER_Encoder &to) const override
 
std::vector< CRL_Entry > get_revoked () const
 
std::string hash_used_for_signature () const
 
bool is_revoked (const X509_Certificate &cert) const
 
X509_DN issuer_dn () const
 
X509_Time next_update () const
 
std::string PEM_encode () const
 
std::vector< byte > signature () const
 
AlgorithmIdentifier signature_algorithm () const
 
std::vector< byte > tbs_data () const
 
X509_Time this_update () const
 
 X509_CRL (DataSource &source, bool throw_on_unknown_critical=false)
 
 X509_CRL (const std::string &filename, bool throw_on_unknown_critical=false)
 
 X509_CRL (const std::vector< byte > &vec, bool throw_on_unknown_critical=false)
 

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

Protected Attributes

std::vector< byte > sig
 
AlgorithmIdentifier sig_algo
 
std::vector< byte > tbs_bits
 

Detailed Description

This class represents X.509 Certificate Revocation Lists (CRLs).

Definition at line 22 of file x509_crl.h.

Constructor & Destructor Documentation

Botan::X509_CRL::X509_CRL ( DataSource &  source,
bool  throw_on_unknown_critical = false 
)

Construct a CRL from a data source.

Parameters
sourcethe data source providing the DER or PEM encoded CRL.
throw_on_unknown_criticalshould we throw an exception if an unknown CRL extension marked as critical is encountered.

Definition at line 21 of file x509_crl.cpp.

References Botan::X509_Object::do_decode().

22  :
23  X509_Object(in, "X509 CRL/CRL"), throw_on_unknown_critical(touc)
24  {
25  do_decode();
}
Botan::X509_CRL::X509_CRL ( const std::string &  filename,
bool  throw_on_unknown_critical = false 
)

Construct a CRL from a file containing the DER or PEM encoded CRL.

Parameters
filenamethe name of the CRL file
throw_on_unknown_criticalshould we throw an exception if an unknown CRL extension marked as critical is encountered.

Definition at line 30 of file x509_crl.cpp.

References Botan::X509_Object::do_decode().

31  :
32  X509_Object(in, "CRL/X509 CRL"), throw_on_unknown_critical(touc)
33  {
34  do_decode();
}
Botan::X509_CRL::X509_CRL ( const std::vector< byte > &  vec,
bool  throw_on_unknown_critical = false 
)

Construct a CRL from a binary vector

Parameters
vecthe binary (DER) representation of the CRL
throw_on_unknown_criticalshould we throw an exception if an unknown CRL extension marked as critical is encountered.

Definition at line 36 of file x509_crl.cpp.

References Botan::X509_Object::do_decode().

37  :
38  X509_Object(in, "CRL/X509 CRL"), throw_on_unknown_critical(touc)
39  {
40  do_decode();
}

Member Function Documentation

std::vector< byte > Botan::X509_CRL::authority_key_id ( ) const

Get the AuthorityKeyIdentifier of this CRL.

Returns
this CRLs AuthorityKeyIdentifier

Definition at line 162 of file x509_crl.cpp.

References Botan::Data_Store::get1_memvec().

Referenced by is_revoked().

163  {
164  return info.get1_memvec("X509v3.AuthorityKeyIdentifier");
165  }
std::vector< byte > Botan::X509_Object::BER_encode ( ) const
inherited
Returns
BER encoding of this

Definition at line 114 of file x509_obj.cpp.

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

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

115  {
116  DER_Encoder der;
117  encode_into(der);
118  return der.get_contents_unlocked();
119  }
bool Botan::X509_Object::check_signature ( const Public_Key &  key) const
inherited

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 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, Botan::X509_Object::sig_algo, Botan::X509_Object::signature(), Botan::split_on(), Botan::X509_Object::tbs_data(), and Botan::PK_Verifier::verify_message().

Referenced by Botan::X509_Object::check_signature(), and Botan::x509_path_validate().

187  {
188  try {
189  std::vector<std::string> sig_info =
190  split_on(OIDS::lookup(sig_algo.oid), '/');
191 
192  if(sig_info.size() != 2 || sig_info[0] != pub_key.algo_name())
193  return false;
194 
195  std::string padding = sig_info[1];
196  Signature_Format format =
197  (pub_key.message_parts() >= 2) ? DER_SEQUENCE : IEEE_1363;
198 
199  PK_Verifier verifier(pub_key, padding, format);
200 
201  return verifier.verify_message(tbs_data(), signature());
202  }
203  catch(std::exception& e)
204  {
205  return false;
206  }
207  }
bool Botan::X509_Object::check_signature ( const Public_Key *  key) const
inherited

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 177 of file x509_obj.cpp.

References Botan::X509_Object::check_signature().

178  {
179  std::unique_ptr<const Public_Key> key(pub_key);
180  return check_signature(*key);
181  }
u32bit Botan::X509_CRL::crl_number ( ) const

Get the serial number of this CRL.

Returns
CRLs serial number

Definition at line 170 of file x509_crl.cpp.

References Botan::Data_Store::get1_u32bit().

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

171  {
172  return info.get1_u32bit("X509v3.CRLNumber");
173  }
void Botan::X509_Object::decode_from ( class BER_Decoder &  from)
overridevirtualinherited

Decode whatever this object is from from

Parameters
fromthe 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, Botan::X509_Object::sig, Botan::X509_Object::sig_algo, Botan::BER_Decoder::start_cons(), Botan::X509_Object::tbs_bits, and Botan::BER_Decoder::verify_end().

100  {
101  from.start_cons(SEQUENCE)
102  .start_cons(SEQUENCE)
103  .raw_bytes(tbs_bits)
104  .end_cons()
105  .decode(sig_algo)
106  .decode(sig, BIT_STRING)
107  .verify_end()
108  .end_cons();
109  }
void Botan::X509_Object::do_decode ( )
protectedinherited

Definition at line 229 of file x509_obj.cpp.

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

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

Encode whatever this object is into to

Parameters
tothe 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, Botan::X509_Object::sig, Botan::X509_Object::sig_algo, Botan::DER_Encoder::start_cons(), and Botan::X509_Object::tbs_bits.

Referenced by Botan::X509_Object::BER_encode().

86  {
87  to.start_cons(SEQUENCE)
88  .start_cons(SEQUENCE)
89  .raw_bytes(tbs_bits)
90  .end_cons()
91  .encode(sig_algo)
92  .encode(sig, BIT_STRING)
93  .end_cons();
94  }
std::vector< CRL_Entry > Botan::X509_CRL::get_revoked ( ) const

Get the entries of this CRL in the form of a vector.

Returns
vector containing the entries of this CRL.

Definition at line 146 of file x509_crl.cpp.

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

147  {
148  return revoked;
149  }
std::string Botan::X509_Object::hash_used_for_signature ( ) const
inherited
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(), Botan::X509_Object::sig_algo, and Botan::split_on().

Referenced by Botan::x509_path_validate().

157  {
158  std::vector<std::string> sig_info =
159  split_on(OIDS::lookup(sig_algo.oid), '/');
160 
161  if(sig_info.size() != 2)
162  throw Internal_Error("Invalid name format found for " +
163  sig_algo.oid.as_string());
164 
165  std::vector<std::string> pad_and_hash =
166  parse_algorithm_name(sig_info[1]);
167 
168  if(pad_and_hash.size() != 2)
169  throw Internal_Error("Invalid name format " + sig_info[1]);
170 
171  return pad_and_hash[1];
172  }
bool Botan::X509_CRL::is_revoked ( const X509_Certificate &  cert) const

Check if this particular certificate is listed in the CRL

Definition at line 45 of file x509_crl.cpp.

References authority_key_id(), Botan::X509_Certificate::authority_key_id(), Botan::X509_Certificate::issuer_dn(), issuer_dn(), Botan::REMOVE_FROM_CRL, and Botan::X509_Certificate::serial_number().

Referenced by Botan::x509_path_validate().

46  {
47  /*
48  If the cert wasn't issued by the CRL issuer, it's possible the cert
49  is revoked, but not by this CRL. Maybe throw an exception instead?
50  */
51  if(cert.issuer_dn() != issuer_dn())
52  return false;
53 
54  std::vector<byte> crl_akid = authority_key_id();
55  std::vector<byte> cert_akid = cert.authority_key_id();
56 
57  if(!crl_akid.empty() && !cert_akid.empty())
58  if(crl_akid != cert_akid)
59  return false;
60 
61  std::vector<byte> cert_serial = cert.serial_number();
62 
63  bool is_revoked = false;
64 
65  for(size_t i = 0; i != revoked.size(); ++i)
66  {
67  if(cert_serial == revoked[i].serial_number())
68  {
69  if(revoked[i].reason_code() == REMOVE_FROM_CRL)
70  is_revoked = false;
71  else
72  is_revoked = true;
73  }
74  }
75 
76  return is_revoked;
77  }
X509_DN Botan::X509_CRL::issuer_dn ( ) const

Get the issuer DN of this CRL.

Returns
CRLs issuer DN

Definition at line 154 of file x509_crl.cpp.

References Botan::create_dn().

Referenced by Botan::Certificate_Store_In_Memory::add_crl(), and is_revoked().

155  {
156  return create_dn(info);
157  }
std::vector< byte > Botan::X509_Object::make_signed ( class PK_Signer *  signer,
RandomNumberGenerator &  rng,
const AlgorithmIdentifier &  alg_id,
const secure_vector< byte > &  tbs 
)
staticinherited

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

216  {
217  return DER_Encoder()
218  .start_cons(SEQUENCE)
219  .raw_bytes(tbs_bits)
220  .encode(algo)
221  .encode(signer->sign_message(tbs_bits, rng), BIT_STRING)
222  .end_cons()
223  .get_contents_unlocked();
224  }
X509_Time Botan::X509_CRL::next_update ( ) const

Get the CRL's nextUpdate value.

Returns
CRLs nextdUpdate

Definition at line 186 of file x509_crl.cpp.

References Botan::Data_Store::get1().

Referenced by Botan::x509_path_validate().

187  {
188  return info.get1("X509.CRL.end");
189  }
std::string Botan::X509_Object::PEM_encode ( ) const
inherited
Returns
PEM encoding of this

Definition at line 124 of file x509_obj.cpp.

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

125  {
126  return PEM_Code::encode(BER_encode(), PEM_label_pref);
127  }
std::vector< byte > Botan::X509_Object::signature ( ) const
inherited
Returns
signature on tbs_data()

Definition at line 140 of file x509_obj.cpp.

References Botan::X509_Object::sig.

Referenced by Botan::X509_Object::check_signature().

141  {
142  return sig;
143  }
AlgorithmIdentifier Botan::X509_Object::signature_algorithm ( ) const
inherited
Returns
signature algorithm that was used to generate signature

Definition at line 148 of file x509_obj.cpp.

References Botan::X509_Object::sig_algo.

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

149  {
150  return sig_algo;
151  }
std::vector< 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 132 of file x509_obj.cpp.

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

Referenced by Botan::X509_Object::check_signature().

133  {
134  return ASN1::put_in_sequence(tbs_bits);
135  }
X509_Time Botan::X509_CRL::this_update ( ) const

Get the CRL's thisUpdate value.

Returns
CRLs thisUpdate

Definition at line 178 of file x509_crl.cpp.

References Botan::Data_Store::get1().

Referenced by Botan::Certificate_Store_In_Memory::add_crl(), and Botan::x509_path_validate().

179  {
180  return info.get1("X509.CRL.start");
181  }

Member Data Documentation

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

Definition at line 98 of file x509_obj.h.

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

AlgorithmIdentifier Botan::X509_Object::sig_algo
protectedinherited

Definition at line 97 of file x509_obj.h.

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

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

Definition at line 98 of file x509_obj.h.

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

The documentation for this class was generated from the following files:
Generated on Wed May 1 2013 08:42:22 for Botan by   doxygen 1.8.3.1