Botan 3.14.1
Crypto and TLS for C&
certstor_sql.cpp
Go to the documentation of this file.
1/*
2* Certificate Store in SQL
3* (C) 2016 Kai Michaelis, Rohde & Schwarz Cybersecurity
4* (C) 2018 Jack Lloyd
5*
6* Botan is released under the Simplified BSD License (see license.txt)
7*/
8
9#include <botan/certstor_sql.h>
10
11#include <botan/asn1_obj.h>
12#include <botan/asn1_time.h>
13#include <botan/assert.h>
14#include <botan/ber_dec.h>
15#include <botan/data_src.h>
16#include <botan/pk_keys.h>
17#include <botan/pkcs8.h>
18#include <botan/pkix_types.h>
19#include <botan/internal/fmt.h>
20
21namespace Botan {
22
24 std::string_view passwd,
26 std::string_view table_prefix) :
27 m_rng(rng),
28 m_database(std::move(db)),
29 m_db_cert_table(fmt("{}certificates", table_prefix)),
30 m_db_keys_table(fmt("{}keys", table_prefix)),
31 m_db_crls_table(fmt("{}revoked", table_prefix)),
32 m_password(passwd) {
33 using DB = SQL_Database;
34 const auto blob = DB::Column_Type::Blob;
35 const auto integer = DB::Column_Type::Integer;
36
37 BOTAN_ARG_CHECK(m_database != nullptr, "Database must not be null");
38 BOTAN_ARG_CHECK(m_database->is_valid_table_name(m_db_cert_table), "Invalid table name");
39 BOTAN_ARG_CHECK(m_database->is_valid_table_name(m_db_keys_table), "Invalid table name");
40 BOTAN_ARG_CHECK(m_database->is_valid_table_name(m_db_crls_table), "Invalid table name");
41
42 m_database->create_table(DB::Table_Schema(m_db_cert_table,
43 {
44 DB::Column("fingerprint", blob).primary_key(),
45 DB::Column("subject_dn", blob),
46 DB::Column("key_id", blob),
47 DB::Column("priv_fingerprint", blob),
48 DB::Column("certificate", blob).not_null(),
49 })
50 .if_not_exists());
51
52 m_database->create_table(DB::Table_Schema(m_db_keys_table,
53 {
54 DB::Column("fingerprint", blob).primary_key(),
55 DB::Column("key", blob).not_null(),
56 })
57 .if_not_exists());
58
59 m_database->create_table(DB::Table_Schema(m_db_crls_table,
60 {
61 DB::Column("fingerprint", blob).primary_key(),
62 DB::Column("reason", integer).not_null(),
63 DB::Column("time", integer),
64 })
65 .if_not_exists());
66}
67
68// Certificate handling
69std::optional<X509_Certificate> Certificate_Store_In_SQL::find_cert(const X509_DN& subject_dn,
70 const std::vector<uint8_t>& key_id) const {
71 std::shared_ptr<SQL_Database::Statement> stmt;
72
73 const std::vector<uint8_t> dn_encoding = subject_dn.BER_encode();
74
75 if(key_id.empty()) {
76 stmt = m_database->select("certificate", m_db_cert_table, "subject_dn = ?1", 1);
77 stmt->bind(1, dn_encoding);
78 } else {
79 stmt =
80 m_database->select("certificate", m_db_cert_table, "subject_dn = ?1 AND (key_id IS NULL OR key_id = ?2)", 1);
81 stmt->bind(1, dn_encoding);
82 stmt->bind(2, key_id);
83 }
84
85 while(stmt->step()) {
86 return X509_Certificate(stmt->get_blob(0));
87 }
88
89 return std::optional<X509_Certificate>();
90}
91
92std::vector<X509_Certificate> Certificate_Store_In_SQL::find_all_certs(const X509_DN& subject_dn,
93 const std::vector<uint8_t>& key_id) const {
94 std::vector<X509_Certificate> certs;
95
96 std::shared_ptr<SQL_Database::Statement> stmt;
97
98 const std::vector<uint8_t> dn_encoding = subject_dn.BER_encode();
99
100 if(key_id.empty()) {
101 stmt = m_database->select("certificate", m_db_cert_table, "subject_dn = ?1");
102 stmt->bind(1, dn_encoding);
103 } else {
104 stmt = m_database->select("certificate", m_db_cert_table, "subject_dn = ?1 AND (key_id IS NULL OR key_id = ?2)");
105 stmt->bind(1, dn_encoding);
106 stmt->bind(2, key_id);
107 }
108
109 while(stmt->step()) {
110 certs.push_back(X509_Certificate(stmt->get_blob(0)));
111 }
112
113 return certs;
114}
115
117 const std::vector<uint8_t>& /*key_hash*/) const {
118 throw Not_Implemented("Certificate_Store_In_SQL::find_cert_by_pubkey_sha1");
119}
120
122 const std::vector<uint8_t>& /*subject_hash*/) const {
123 throw Not_Implemented("Certificate_Store_In_SQL::find_cert_by_raw_subject_dn_sha256");
124}
125
127 const X509_DN& /*issuer_dn*/, std::span<const uint8_t> /*serial_number*/) const {
128 throw Not_Implemented("Certificate_Store_In_SQL::find_cert_by_issuer_dn_and_serial_number");
129}
130
131std::optional<X509_CRL> Certificate_Store_In_SQL::find_crl_for(const X509_Certificate& subject) const {
132 const auto all_crls = generate_crls();
133
134 for(const auto& crl : all_crls) {
135 if(!crl.get_revoked().empty() && crl.issuer_dn() == subject.issuer_dn()) {
136 return crl;
137 }
138 }
139
140 return std::optional<X509_CRL>();
141}
142
143std::vector<X509_DN> Certificate_Store_In_SQL::all_subjects() const {
144 std::vector<X509_DN> ret;
145 const auto stmt = m_database->select("subject_dn", m_db_cert_table);
146
147 while(stmt->step()) {
148 BER_Decoder dec(stmt->get_blob(0), BER_Decoder::Limits::DER());
149 X509_DN dn;
150
151 dn.decode_from(dec);
152
153 ret.push_back(dn);
154 }
155
156 return ret;
157}
158
160 const std::vector<uint8_t> dn_encoding = cert.subject_dn().BER_encode();
161 const std::vector<uint8_t> cert_encoding = cert.BER_encode();
162
163 const auto stmt =
164 m_database->upsert(m_db_cert_table, {"fingerprint", "subject_dn", "key_id", "priv_fingerprint", "certificate"});
165
166 stmt->bind(1, cert.fingerprint("SHA-256"));
167 stmt->bind(2, dn_encoding);
168 stmt->bind(3, cert.subject_key_id());
169 stmt->bind(4, std::vector<uint8_t>());
170 stmt->bind(5, cert_encoding);
171 stmt->spin();
172
173 return true;
174}
175
177 const auto stmt = m_database->select("1", m_db_cert_table, "fingerprint = ?1");
178 stmt->bind(1, cert.fingerprint("SHA-256"));
179 return stmt->step();
180}
181
183 if(!find_cert(cert.subject_dn(), cert.subject_key_id())) {
184 return false;
185 }
186
187 const auto stmt = m_database->new_statement(fmt("DELETE FROM {} WHERE fingerprint = ?1", m_db_cert_table));
188
189 stmt->bind(1, cert.fingerprint("SHA-256"));
190 stmt->spin();
191
192 return true;
193}
194
195// Private key handling
196std::shared_ptr<const Private_Key> Certificate_Store_In_SQL::find_key(const X509_Certificate& cert) const {
197 const auto stmt =
198 m_database->new_statement(fmt("SELECT key FROM {} JOIN {} ON {}.fingerprint = {}.priv_fingerprint "
199 "WHERE {}.fingerprint = ?1",
200 m_db_keys_table,
201 m_db_cert_table,
202 m_db_keys_table,
203 m_db_cert_table,
204 m_db_cert_table));
205 stmt->bind(1, cert.fingerprint("SHA-256"));
206
207 std::shared_ptr<const Private_Key> key;
208 while(stmt->step()) {
209 DataSource_Memory src(stmt->get_blob(0));
210 key = PKCS8::load_key(src, m_password);
211 }
212
213 return key;
214}
215
216std::vector<X509_Certificate> Certificate_Store_In_SQL::find_certs_for_key(const Private_Key& key) const {
217 const auto fprint = key.fingerprint_private("SHA-256");
218 const auto stmt = m_database->select("certificate", m_db_cert_table, "priv_fingerprint = ?1");
219
220 stmt->bind(1, fprint);
221
222 std::vector<X509_Certificate> certs;
223 while(stmt->step()) {
224 certs.push_back(X509_Certificate(stmt->get_blob(0)));
225 }
226
227 return certs;
228}
229
231 insert_cert(cert);
232
233 if(find_key(cert)) {
234 return false;
235 }
236
237 auto pkcs8 = PKCS8::BER_encode(key, m_rng, m_password);
238 const auto fprint = key.fingerprint_private("SHA-256");
239
240 const auto stmt1 = m_database->upsert(m_db_keys_table, {"fingerprint", "key"});
241
242 stmt1->bind(1, fprint);
243 stmt1->bind(2, pkcs8.data(), pkcs8.size());
244 stmt1->spin();
245
246 const auto stmt2 =
247 m_database->new_statement(fmt("UPDATE {} SET priv_fingerprint = ?1 WHERE fingerprint = ?2", m_db_cert_table));
248
249 stmt2->bind(1, fprint);
250 stmt2->bind(2, cert.fingerprint("SHA-256"));
251 stmt2->spin();
252
253 return true;
254}
255
257 const auto fprint = key.fingerprint_private("SHA-256");
258 const auto stmt = m_database->new_statement(fmt("DELETE FROM {} WHERE fingerprint = ?1", m_db_keys_table));
259
260 stmt->bind(1, fprint);
261 stmt->spin();
262}
263
264// Revocation
266 // TODO(Botan4) require that time be valid
267 insert_cert(cert);
268
269 const auto stmt1 = m_database->upsert(m_db_crls_table, {"fingerprint", "reason", "time"});
270
271 stmt1->bind(1, cert.fingerprint("SHA-256"));
272 stmt1->bind(2, static_cast<uint32_t>(code));
273
274 if(time.time_is_set()) {
275 stmt1->bind(3, time.to_std_timepoint());
276 } else {
277 stmt1->bind_null(3);
278 }
279
280 stmt1->spin();
281}
282
283// Revocation
285 insert_cert(cert);
286
287 const auto stmt1 = m_database->upsert(m_db_crls_table, {"fingerprint", "reason", "time"});
288
289 stmt1->bind(1, cert.fingerprint("SHA-256"));
290 stmt1->bind(2, static_cast<uint32_t>(code));
291 stmt1->bind_null(3);
292
293 stmt1->spin();
294}
295
297 const auto stmt = m_database->new_statement(fmt("DELETE FROM {} WHERE fingerprint = ?1", m_db_crls_table));
298
299 stmt->bind(1, cert.fingerprint("SHA-256"));
300 stmt->spin();
301}
302
303std::vector<X509_CRL> Certificate_Store_In_SQL::generate_crls() const {
304 const auto stmt =
305 m_database->new_statement(fmt("SELECT certificate,reason,time FROM {} JOIN {} ON {}.fingerprint = "
306 "{}.fingerprint",
307 m_db_crls_table,
308 m_db_cert_table,
309 m_db_cert_table,
310 m_db_crls_table));
311
312 std::map<X509_DN, std::vector<CRL_Entry>> crls;
313 while(stmt->step()) {
314 const auto cert = X509_Certificate(stmt->get_blob(0));
315 const auto code = static_cast<CRL_Code>(stmt->get_size_t(1));
316 const auto ent = CRL_Entry(cert, code);
317
318 const auto i = crls.find(cert.issuer_dn());
319 if(i == crls.end()) {
320 crls.insert(std::make_pair(cert.issuer_dn(), std::vector<CRL_Entry>({ent})));
321 } else {
322 i->second.push_back(ent);
323 }
324 }
325
326 const X509_Time t(std::chrono::system_clock::now());
327
328 std::vector<X509_CRL> ret;
329 ret.reserve(crls.size());
330
331 for(const auto& p : crls) {
332 ret.push_back(X509_CRL(p.first, t, t, p.second));
333 }
334
335 return ret;
336}
337
338} // namespace Botan
#define BOTAN_ARG_CHECK(expr, msg)
Definition assert.h:33
std::vector< uint8_t > BER_encode() const
Definition asn1_obj.cpp:21
std::chrono::system_clock::time_point to_std_timepoint() const
Returns a STL timepoint object.
bool time_is_set() const
Return if the time has been set somehow.
static Limits DER()
Definition ber_dec.h:44
std::optional< X509_Certificate > find_cert_by_issuer_dn_and_serial_number(const X509_DN &issuer_dn, std::span< const uint8_t > serial_number) const override
std::vector< X509_DN > all_subjects() const override
bool insert_cert(const X509_Certificate &cert)
std::vector< X509_Certificate > find_all_certs(const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const override
std::optional< X509_Certificate > find_cert_by_raw_subject_dn_sha256(const std::vector< uint8_t > &subject_hash) const override
bool contains(const X509_Certificate &cert) const override
void revoke_cert(const X509_Certificate &cert, CRL_Code reason, const X509_Time &time)
Marks "cert" as revoked starting from "time".
std::optional< X509_CRL > find_crl_for(const X509_Certificate &issuer) const override
Certificate_Store_In_SQL(std::shared_ptr< SQL_Database > db, std::string_view passwd, RandomNumberGenerator &rng, std::string_view table_prefix="")
std::vector< X509_Certificate > find_certs_for_key(const Private_Key &key) const
Returns all certificates for private key "key".
void affirm_cert(const X509_Certificate &cert)
Reverses the revocation for "cert".
bool remove_cert(const X509_Certificate &cert)
std::shared_ptr< const Private_Key > find_key(const X509_Certificate &cert) const
Returns the private key for "cert" or an empty shared_ptr if none was found.
std::optional< X509_Certificate > find_cert(const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const override
void remove_key(const Private_Key &key)
Removes "key" from the store.
bool insert_key(const X509_Certificate &cert, const Private_Key &key)
std::optional< X509_Certificate > find_cert_by_pubkey_sha1(const std::vector< uint8_t > &key_hash) const override
std::vector< X509_CRL > generate_crls() const
std::string fingerprint_private(std::string_view alg) const
Definition pk_keys.cpp:103
std::string fingerprint(std::string_view hash_name="SHA-1") const
Definition x509cert.cpp:790
const X509_DN & subject_dn() const
Definition x509cert.cpp:458
const std::vector< uint8_t > & subject_key_id() const
Definition x509cert.cpp:434
const X509_DN & issuer_dn() const
Definition x509cert.cpp:454
void decode_from(BER_Decoder &from) override
Definition x509_dn.cpp:405
botan_x509_crl_t crl
Definition ffi_tls.h:127
std::vector< uint8_t > BER_encode(const Private_Key &key, RandomNumberGenerator &rng, std::string_view pass, std::chrono::milliseconds msec, std::string_view pbe_algo)
Definition pkcs8.cpp:168
std::unique_ptr< Private_Key > load_key(DataSource &source, const std::function< std::string()> &get_pass)
Definition pkcs8.cpp:320
ASN1_Time X509_Time
Definition asn1_obj.h:27
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53