Botan 3.8.1
Crypto and TLS for C&
x509_crl.h
Go to the documentation of this file.
1/*
2* X.509 CRL
3* (C) 1999-2007 Jack Lloyd
4*
5* Botan is released under the Simplified BSD License (see license.txt)
6*/
7
8#ifndef BOTAN_X509_CRL_H_
9#define BOTAN_X509_CRL_H_
10
11#include <botan/asn1_obj.h>
12#include <botan/pkix_enums.h>
13#include <botan/x509_obj.h>
14#include <memory>
15#include <vector>
16
17namespace Botan {
18
19class Extensions;
21class X509_DN;
22
23struct CRL_Entry_Data;
24struct CRL_Data;
25
26/**
27* This class represents CRL entries
28*/
29class BOTAN_PUBLIC_API(2, 0) CRL_Entry final : public ASN1_Object {
30 public:
31 void encode_into(DER_Encoder&) const override;
32 void decode_from(BER_Decoder&) override;
33
34 /**
35 * Get the serial number of the certificate associated with this entry.
36 * @return certificate's serial number
37 */
38 const std::vector<uint8_t>& serial_number() const;
39
40 /**
41 * Get the revocation date of the certificate associated with this entry
42 * @return certificate's revocation date
43 */
44 const X509_Time& expire_time() const;
45
46 /**
47 * Get the entries reason code
48 * @return reason code
49 */
50 CRL_Code reason_code() const;
51
52 /**
53 * Get the extensions on this CRL entry
54 */
55 const Extensions& extensions() const;
56
57 /**
58 * Create uninitialized CRL_Entry object
59 */
60 CRL_Entry() = default;
61
62 /**
63 * Construct an CRL entry.
64 * @param cert the certificate to revoke
65 * @param reason the reason code to set in the entry
66 */
68
69 private:
70 friend class X509_CRL;
71
72 const CRL_Entry_Data& data() const;
73
74 std::shared_ptr<CRL_Entry_Data> m_data;
75};
76
77/**
78* Test two CRL entries for equality in all fields.
79*/
80BOTAN_PUBLIC_API(2, 0) bool operator==(const CRL_Entry&, const CRL_Entry&);
81
82/**
83* Test two CRL entries for inequality in at least one field.
84*/
85BOTAN_PUBLIC_API(2, 0) bool operator!=(const CRL_Entry&, const CRL_Entry&);
86
87/**
88* This class represents X.509 Certificate Revocation Lists (CRLs).
89*/
90class BOTAN_PUBLIC_API(2, 0) X509_CRL final : public X509_Object {
91 public:
92 /**
93 * Check if this particular certificate is listed in the CRL
94 */
95 bool is_revoked(const X509_Certificate& cert) const;
96
97 /**
98 * Get the entries of this CRL in the form of a vector.
99 * @return vector containing the entries of this CRL.
100 */
101 const std::vector<CRL_Entry>& get_revoked() const;
102
103 /**
104 * Get the X509 version of this CRL object
105 * @return X509 version
106 */
107 uint32_t x509_version() const;
108
109 /**
110 * Get the issuer DN of this CRL.
111 * @return CRLs issuer DN
112 */
113 const X509_DN& issuer_dn() const;
114
115 /**
116 * @return extension data for this CRL
117 */
118 const Extensions& extensions() const;
119
120 /**
121 * Get the AuthorityKeyIdentifier of this CRL.
122 * @return this CRLs AuthorityKeyIdentifier
123 */
124 const std::vector<uint8_t>& authority_key_id() const;
125
126 /**
127 * Get the serial number of this CRL.
128 * @return CRLs serial number
129 */
130 uint32_t crl_number() const;
131
132 /**
133 * Get the CRL's thisUpdate value.
134 * @return CRLs thisUpdate
135 */
136 const X509_Time& this_update() const;
137
138 /**
139 * Get the CRL's nextUpdate value.
140 *
141 * Technically nextUpdate is optional in the X.509 spec and may be omitted,
142 * despite RFC 5280 requiring it. If the nextUpdate field is not set, this
143 * will return a time object with time_is_set() returning false.
144 *
145 * TODO(Botan4) return a `const std::optional<X509_Time>&` instead
146 *
147 * @return CRLs nextUpdate
148 */
149 const X509_Time& next_update() const;
150
151 /**
152 * Get the CRL's issuing distribution point
153 */
154 BOTAN_DEPRECATED("Use issuing_distribution_points") std::string crl_issuing_distribution_point() const;
155
156 /**
157 * Get the CRL's issuing distribution points
158 *
159 * See https://www.rfc-editor.org/rfc/rfc5280#section-5.2.5
160 */
161 std::vector<std::string> issuing_distribution_points() const;
162
163 /**
164 * Create an uninitialized CRL object. Any attempts to access
165 * this object will throw an exception.
166 */
167 X509_CRL() = default;
168
169 /**
170 * Construct a CRL from a data source.
171 * @param source the data source providing the DER or PEM encoded CRL.
172 */
173 X509_CRL(DataSource& source);
174
175#if defined(BOTAN_TARGET_OS_HAS_FILESYSTEM)
176 /**
177 * Construct a CRL from a file containing the DER or PEM encoded CRL.
178 * @param filename the name of the CRL file
179 */
180 X509_CRL(std::string_view filename);
181#endif
182
183 /**
184 * Construct a CRL from a binary vector
185 * @param vec the binary (DER) representation of the CRL
186 */
187 X509_CRL(const std::vector<uint8_t>& vec);
188
189 /**
190 * Construct a CRL
191 * @param issuer issuer of this CRL
192 * @param thisUpdate valid from
193 * @param nextUpdate valid until
194 * @param revoked entries to be included in the CRL
195 */
196 X509_CRL(const X509_DN& issuer,
197 const X509_Time& thisUpdate,
198 const X509_Time& nextUpdate,
199 const std::vector<CRL_Entry>& revoked);
200
201 private:
202 std::string PEM_label() const override;
203
204 std::vector<std::string> alternate_PEM_labels() const override;
205
206 void force_decode() override;
207
208 const CRL_Data& data() const;
209
210 std::shared_ptr<CRL_Data> m_data;
211};
212
213} // namespace Botan
214
215#endif
#define BOTAN_PUBLIC_API(maj, min)
Definition api.h:19
#define BOTAN_DEPRECATED(msg)
Definition api.h:59
ASN1_Object()=default
Definition x509_crl.h:29
friend class X509_CRL
Definition x509_crl.h:70
CRL_Code reason_code() const
Definition crl_ent.cpp:143
const X509_Time & expire_time() const
Definition crl_ent.cpp:139
CRL_Entry()=default
const std::vector< uint8_t > & serial_number() const
Definition crl_ent.cpp:135
void decode_from(BER_Decoder &) override
Definition crl_ent.cpp:104
void encode_into(DER_Encoder &) const override
Definition crl_ent.cpp:65
const Extensions & extensions() const
Definition crl_ent.cpp:147
const std::vector< CRL_Entry > & get_revoked() const
Definition x509_crl.cpp:203
const std::vector< uint8_t > & authority_key_id() const
Definition x509_crl.cpp:221
const X509_Time & this_update() const
Definition x509_crl.cpp:235
std::vector< std::string > issuing_distribution_points() const
Definition x509_crl.cpp:259
X509_CRL()=default
const Extensions & extensions() const
Definition x509_crl.cpp:196
uint32_t crl_number() const
Definition x509_crl.cpp:228
const X509_Time & next_update() const
Definition x509_crl.cpp:242
const X509_DN & issuer_dn() const
Definition x509_crl.cpp:214
bool is_revoked(const X509_Certificate &cert) const
Definition x509_crl.cpp:71
std::string crl_issuing_distribution_point() const
Definition x509_crl.cpp:249
uint32_t x509_version() const
Definition x509_crl.cpp:207
X509_Object(const X509_Object &)=default
ASN1_Time X509_Time
Definition asn1_obj.h:417