Botan  2.4.0
Crypto and TLS for C++11
Public Member Functions | List of all members
Botan::Certificate_Store_In_SQLite Class Referencefinal

#include <certstor_sqlite.h>

Inheritance diagram for Botan::Certificate_Store_In_SQLite:
Botan::Certificate_Store_In_SQL Botan::Certificate_Store

Public Member Functions

void affirm_cert (const X509_Certificate &)
 Reverses the revokation for "cert". More...
 
std::vector< X509_DNall_subjects () const override
 
bool certificate_known (const X509_Certificate &cert) const
 
 Certificate_Store_In_SQLite (const std::string &db_path, const std::string &passwd, RandomNumberGenerator &rng, const std::string &table_prefix="")
 
std::vector< std::shared_ptr< const X509_Certificate > > find_all_certs (const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const override
 
std::shared_ptr< const X509_Certificatefind_cert (const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const override
 
std::shared_ptr< const X509_Certificatefind_cert_by_pubkey_sha1 (const std::vector< uint8_t > &key_hash) const override
 
std::shared_ptr< const X509_Certificatefind_cert_by_raw_subject_dn_sha256 (const std::vector< uint8_t > &subject_hash) const override
 
std::vector< std::shared_ptr< const X509_Certificate > > find_certs_for_key (const Private_Key &key) const
 Returns all certificates for private key "key". More...
 
std::shared_ptr< const X509_CRLfind_crl_for (const X509_Certificate &issuer) const override
 
std::shared_ptr< const Private_Keyfind_key (const X509_Certificate &) const
 Returns the private key for "cert" or an empty shared_ptr if none was found. More...
 
std::vector< X509_CRLgenerate_crls () const
 
bool insert_cert (const X509_Certificate &cert)
 
bool insert_key (const X509_Certificate &cert, const Private_Key &key)
 
bool remove_cert (const X509_Certificate &cert)
 
void remove_key (const Private_Key &key)
 Removes "key" from the store. More...
 
void revoke_cert (const X509_Certificate &, CRL_Code, const X509_Time &time=X509_Time())
 Marks "cert" as revoked starting from "time". More...
 

Detailed Description

Certificate and private key store backed by an sqlite (https://sqlite.org) database.

Definition at line 18 of file certstor_sqlite.h.

Constructor & Destructor Documentation

◆ Certificate_Store_In_SQLite()

Botan::Certificate_Store_In_SQLite::Certificate_Store_In_SQLite ( const std::string &  db_path,
const std::string &  passwd,
RandomNumberGenerator rng,
const std::string &  table_prefix = "" 
)

Create/open a certificate store.

Parameters
db_pathpath to the database file
passwdpassword to encrypt private keys in the database
rngused for encrypting keys
table_prefixoptional prefix for db table names

Definition at line 13 of file certstor_sqlite.cpp.

16  :
17  Certificate_Store_In_SQL(std::make_shared<Sqlite3_Database>(db_path), passwd, rng, table_prefix)
18  {}
Certificate_Store_In_SQL(const std::shared_ptr< SQL_Database > db, const std::string &passwd, RandomNumberGenerator &rng, const std::string &table_prefix="")

Member Function Documentation

◆ affirm_cert()

void Botan::Certificate_Store_In_SQL::affirm_cert ( const X509_Certificate cert)
inherited

Reverses the revokation for "cert".

Definition at line 296 of file certstor_sql.cpp.

References Botan::X509_Certificate::fingerprint().

297  {
298  auto stmt = m_database->new_statement("DELETE FROM " + m_prefix + "revoked WHERE fingerprint == ?1");
299 
300  stmt->bind(1,cert.fingerprint("SHA-256"));
301  stmt->spin();
302  }

◆ all_subjects()

std::vector< X509_DN > Botan::Certificate_Store_In_SQL::all_subjects ( ) const
overridevirtualinherited

Returns all subject DNs known to the store instance.

Implements Botan::Certificate_Store.

Definition at line 139 of file certstor_sql.cpp.

References Botan::X509_DN::decode_from().

140  {
141  std::vector<X509_DN> ret;
142  auto stmt = m_database->new_statement("SELECT subject_dn FROM " + m_prefix + "certificates");
143 
144  while(stmt->step())
145  {
146  auto blob = stmt->get_blob(0);
147  BER_Decoder dec(blob.first,blob.second);
148  X509_DN dn;
149 
150  dn.decode_from(dec);
151 
152  ret.push_back(dn);
153  }
154 
155  return ret;
156  }

◆ certificate_known()

bool Botan::Certificate_Store::certificate_known ( const X509_Certificate cert) const
inlineinherited
Returns
whether the certificate is known
Parameters
certcertififcate to be searched

Definition at line 70 of file certstor.h.

References Botan::X509_Certificate::subject_dn(), and Botan::X509_Certificate::subject_key_id().

71  {
72  return find_cert(cert.subject_dn(), cert.subject_key_id()) != nullptr;
73  }
virtual std::shared_ptr< const X509_Certificate > find_cert(const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const =0

◆ find_all_certs()

std::vector< std::shared_ptr< const X509_Certificate > > Botan::Certificate_Store_In_SQL::find_all_certs ( const X509_DN subject_dn,
const std::vector< uint8_t > &  key_id 
) const
overridevirtualinherited

Find all certificates with a given Subject DN. Subject DN and even the key identifier might not be unique.

Implements Botan::Certificate_Store.

Definition at line 80 of file certstor_sql.cpp.

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

81  {
82  std::vector<std::shared_ptr<const X509_Certificate>> certs;
83 
84  DER_Encoder enc;
85  std::shared_ptr<SQL_Database::Statement> stmt;
86 
87  subject_dn.encode_into(enc);
88 
89  if(key_id.empty())
90  {
91  stmt = m_database->new_statement("SELECT certificate FROM " + m_prefix + "certificates WHERE subject_dn == ?1");
92  stmt->bind(1,enc.get_contents_unlocked());
93  }
94  else
95  {
96  stmt = m_database->new_statement("SELECT certificate FROM " + m_prefix + "certificates WHERE\
97  subject_dn == ?1 AND (key_id == NULL OR key_id == ?2)");
98  stmt->bind(1,enc.get_contents_unlocked());
99  stmt->bind(2,key_id);
100  }
101 
102  std::shared_ptr<const X509_Certificate> cert;
103  while(stmt->step())
104  {
105  auto blob = stmt->get_blob(0);
106  certs.push_back(std::make_shared<X509_Certificate>(
107  std::vector<uint8_t>(blob.first,blob.first + blob.second)));
108  }
109 
110  return certs;
111  }

◆ find_cert()

std::shared_ptr< const X509_Certificate > Botan::Certificate_Store_In_SQL::find_cert ( const X509_DN subject_dn,
const std::vector< uint8_t > &  key_id 
) const
overridevirtualinherited

Returns the first certificate with matching subject DN and optional key ID.

Implements Botan::Certificate_Store.

Definition at line 47 of file certstor_sql.cpp.

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

Referenced by Botan::Certificate_Store_In_SQL::remove_cert().

48  {
49  DER_Encoder enc;
50  std::shared_ptr<SQL_Database::Statement> stmt;
51 
52  subject_dn.encode_into(enc);
53 
54  if(key_id.empty())
55  {
56  stmt = m_database->new_statement("SELECT certificate FROM " + m_prefix + "certificates WHERE subject_dn == ?1");
57  stmt->bind(1,enc.get_contents_unlocked());
58  }
59  else
60  {
61  stmt = m_database->new_statement("SELECT certificate FROM " + m_prefix + "certificates WHERE\
62  subject_dn == ?1 AND (key_id == NULL OR key_id == ?2)");
63  stmt->bind(1,enc.get_contents_unlocked());
64  stmt->bind(2,key_id);
65  }
66 
67  std::shared_ptr<const X509_Certificate> cert;
68  while(stmt->step())
69  {
70  auto blob = stmt->get_blob(0);
71  cert = std::make_shared<X509_Certificate>(
72  std::vector<uint8_t>(blob.first,blob.first + blob.second));
73 
74  }
75 
76  return cert;
77  }

◆ find_cert_by_pubkey_sha1()

std::shared_ptr< const X509_Certificate > Botan::Certificate_Store_In_SQL::find_cert_by_pubkey_sha1 ( const std::vector< uint8_t > &  key_hash) const
overridevirtualinherited

Find a certificate by searching for one with a matching SHA-1 hash of public key. Used for OCSP.

Parameters
key_hashSHA-1 hash of the subject's public key
Returns
a matching certificate or nullptr otherwise

Implements Botan::Certificate_Store.

Definition at line 114 of file certstor_sql.cpp.

115  {
116  throw Not_Implemented("TODO!");
117  }

◆ find_cert_by_raw_subject_dn_sha256()

std::shared_ptr< const X509_Certificate > Botan::Certificate_Store_In_SQL::find_cert_by_raw_subject_dn_sha256 ( const std::vector< uint8_t > &  subject_hash) const
overridevirtualinherited

Find a certificate by searching for one with a matching SHA-256 hash of raw subject name. Used for OCSP.

Parameters
subject_hashSHA-256 hash of the subject's raw name
Returns
a matching certificate or nullptr otherwise

Implements Botan::Certificate_Store.

Definition at line 120 of file certstor_sql.cpp.

121  {
122  throw Not_Implemented("TODO!");
123  }

◆ find_certs_for_key()

std::vector< std::shared_ptr< const X509_Certificate > > Botan::Certificate_Store_In_SQL::find_certs_for_key ( const Private_Key key) const
inherited

Returns all certificates for private key "key".

Definition at line 218 of file certstor_sql.cpp.

References Botan::Private_Key::fingerprint_private().

219  {
220  auto fpr = key.fingerprint_private("SHA-256");
221  auto stmt = m_database->new_statement("SELECT certificate FROM " + m_prefix + "certificates WHERE priv_fingerprint == ?1");
222 
223  stmt->bind(1,fpr);
224 
225  std::vector<std::shared_ptr<const X509_Certificate>> certs;
226  while(stmt->step())
227  {
228  auto blob = stmt->get_blob(0);
229  certs.push_back(std::make_shared<X509_Certificate>(
230  std::vector<uint8_t>(blob.first,blob.first + blob.second)));
231  }
232 
233  return certs;
234  }

◆ find_crl_for()

std::shared_ptr< const X509_CRL > Botan::Certificate_Store_In_SQL::find_crl_for ( const X509_Certificate issuer) const
overridevirtualinherited

Generates a CRL for all certificates issued by the given issuer.

Reimplemented from Botan::Certificate_Store.

Definition at line 126 of file certstor_sql.cpp.

References Botan::Certificate_Store_In_SQL::generate_crls(), and Botan::X509_Certificate::issuer_dn().

127  {
128  auto all_crls = generate_crls();
129 
130  for(auto crl: all_crls)
131  {
132  if(!crl.get_revoked().empty() && crl.issuer_dn() == subject.issuer_dn())
133  return std::shared_ptr<X509_CRL>(new X509_CRL(crl));
134  }
135 
136  return std::shared_ptr<X509_CRL>();
137  }
std::vector< X509_CRL > generate_crls() const

◆ find_key()

std::shared_ptr< const Private_Key > Botan::Certificate_Store_In_SQL::find_key ( const X509_Certificate cert) const
inherited

Returns the private key for "cert" or an empty shared_ptr if none was found.

Definition at line 198 of file certstor_sql.cpp.

References Botan::X509_Certificate::fingerprint(), and Botan::PKCS8::load_key().

Referenced by Botan::Certificate_Store_In_SQL::insert_key().

199  {
200  auto stmt = m_database->new_statement("SELECT key FROM " + m_prefix + "keys "
201  "JOIN " + m_prefix + "certificates ON " +
202  m_prefix + "keys.fingerprint == " + m_prefix + "certificates.priv_fingerprint "
203  "WHERE " + m_prefix + "certificates.fingerprint == ?1");
204  stmt->bind(1,cert.fingerprint("SHA-256"));
205 
206  std::shared_ptr<const Private_Key> key;
207  while(stmt->step())
208  {
209  auto blob = stmt->get_blob(0);
210  DataSource_Memory src(blob.first,blob.second);
211  key.reset(PKCS8::load_key(src, m_rng, m_password));
212  }
213 
214  return key;
215  }
std::unique_ptr< Private_Key > load_key(DataSource &source, std::function< std::string()> get_pass)
Definition: pkcs8.cpp:314

◆ generate_crls()

std::vector< X509_CRL > Botan::Certificate_Store_In_SQL::generate_crls ( ) const
inherited

Generates Certificate Revocation Lists for all certificates marked as revoked. A CRL is returned for each unique issuer DN.

Definition at line 304 of file certstor_sql.cpp.

Referenced by Botan::Certificate_Store_In_SQL::find_crl_for().

305  {
306  auto stmt = m_database->new_statement(
307  "SELECT certificate,reason,time FROM " + m_prefix + "revoked "
308  "JOIN " + m_prefix + "certificates ON " +
309  m_prefix + "certificates.fingerprint == " + m_prefix + "revoked.fingerprint");
310 
311  std::map<X509_DN,std::vector<CRL_Entry>> crls;
312  while(stmt->step())
313  {
314  auto blob = stmt->get_blob(0);
315  auto cert = X509_Certificate(
316  std::vector<uint8_t>(blob.first,blob.first + blob.second));
317  auto code = static_cast<CRL_Code>(stmt->get_size_t(1));
318  auto ent = CRL_Entry(cert,code);
319 
320  auto i = crls.find(cert.issuer_dn());
321  if(i == crls.end())
322  {
323  crls.insert(std::make_pair(cert.issuer_dn(),std::vector<CRL_Entry>({ent})));
324  }
325  else
326  {
327  i->second.push_back(ent);
328  }
329  }
330 
331  std::vector<X509_CRL> ret;
332  X509_Time t(std::chrono::system_clock::now());
333 
334  for(auto p: crls)
335  {
336  ret.push_back(X509_CRL(p.first,t,t,p.second));
337  }
338 
339  return ret;
340  }
CRL_Code
Definition: crl_ent.h:22

◆ insert_cert()

bool Botan::Certificate_Store_In_SQL::insert_cert ( const X509_Certificate cert)
inherited

Inserts "cert" into the store, returns false if the certificate is already known and true if insertion was successful.

Definition at line 158 of file certstor_sql.cpp.

References Botan::X509_DN::encode_into(), Botan::X509_Object::encode_into(), Botan::X509_Certificate::fingerprint(), Botan::DER_Encoder::get_contents_unlocked(), Botan::X509_Certificate::subject_dn(), and Botan::X509_Certificate::subject_key_id().

Referenced by Botan::Certificate_Store_In_SQL::insert_key(), and Botan::Certificate_Store_In_SQL::revoke_cert().

159  {
160  DER_Encoder enc;
161  auto stmt = m_database->new_statement("INSERT OR REPLACE INTO " +
162  m_prefix + "certificates (\
163  fingerprint, \
164  subject_dn, \
165  key_id, \
166  priv_fingerprint, \
167  certificate \
168  ) VALUES ( ?1, ?2, ?3, ?4, ?5 )");
169 
170  stmt->bind(1,cert.fingerprint("SHA-256"));
171  cert.subject_dn().encode_into(enc);
172  stmt->bind(2,enc.get_contents_unlocked());
173  stmt->bind(3,cert.subject_key_id());
174  stmt->bind(4,std::vector<uint8_t>());
175  enc = DER_Encoder();
176  cert.encode_into(enc);
177  stmt->bind(5,enc.get_contents_unlocked());
178  stmt->spin();
179 
180  return true;
181  }

◆ insert_key()

bool Botan::Certificate_Store_In_SQL::insert_key ( const X509_Certificate cert,
const Private_Key key 
)
inherited

Inserts "key" for "cert" into the store, returns false if the key is already known and true if insertion was successful.

Definition at line 236 of file certstor_sql.cpp.

References Botan::PKCS8::BER_encode(), Botan::Certificate_Store_In_SQL::find_key(), Botan::X509_Certificate::fingerprint(), Botan::Private_Key::fingerprint_private(), and Botan::Certificate_Store_In_SQL::insert_cert().

236  {
237  insert_cert(cert);
238 
239  if(find_key(cert))
240  return false;
241 
242  auto pkcs8 = PKCS8::BER_encode(key, m_rng, m_password);
243  auto fpr = key.fingerprint_private("SHA-256");
244 
245  auto stmt1 = m_database->new_statement(
246  "INSERT OR REPLACE INTO " + m_prefix + "keys ( fingerprint, key ) VALUES ( ?1, ?2 )");
247 
248  stmt1->bind(1,fpr);
249  stmt1->bind(2,pkcs8.data(),pkcs8.size());
250  stmt1->spin();
251 
252  auto stmt2 = m_database->new_statement(
253  "UPDATE " + m_prefix + "certificates SET priv_fingerprint = ?1 WHERE fingerprint == ?2");
254 
255  stmt2->bind(1,fpr);
256  stmt2->bind(2,cert.fingerprint("SHA-256"));
257  stmt2->spin();
258 
259  return true;
260  }
bool insert_cert(const X509_Certificate &cert)
std::shared_ptr< const Private_Key > find_key(const X509_Certificate &) const
Returns the private key for "cert" or an empty shared_ptr if none was found.
secure_vector< uint8_t > BER_encode(const Private_Key &key)
Definition: pkcs8.cpp:131

◆ remove_cert()

bool Botan::Certificate_Store_In_SQL::remove_cert ( const X509_Certificate cert)
inherited

Removes "cert" from the store. Returns false if the certificate could not be found and true if removal was successful.

Definition at line 184 of file certstor_sql.cpp.

References Botan::Certificate_Store_In_SQL::find_cert(), Botan::X509_Certificate::fingerprint(), Botan::X509_Certificate::subject_dn(), and Botan::X509_Certificate::subject_key_id().

185  {
186  if(!find_cert(cert.subject_dn(),cert.subject_key_id()))
187  return false;
188 
189  auto stmt = m_database->new_statement("DELETE FROM " + m_prefix + "certificates WHERE fingerprint == ?1");
190 
191  stmt->bind(1,cert.fingerprint("SHA-256"));
192  stmt->spin();
193 
194  return true;
195  }
std::shared_ptr< const X509_Certificate > find_cert(const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const override

◆ remove_key()

void Botan::Certificate_Store_In_SQL::remove_key ( const Private_Key key)
inherited

Removes "key" from the store.

Definition at line 262 of file certstor_sql.cpp.

References Botan::Private_Key::fingerprint_private().

263  {
264  auto fpr = key.fingerprint_private("SHA-256");
265  auto stmt = m_database->new_statement("DELETE FROM " + m_prefix + "keys WHERE fingerprint == ?1");
266 
267  stmt->bind(1,fpr);
268  stmt->spin();
269  }

◆ revoke_cert()

void Botan::Certificate_Store_In_SQL::revoke_cert ( const X509_Certificate cert,
CRL_Code  code,
const X509_Time time = X509_Time() 
)
inherited

Marks "cert" as revoked starting from "time".

Definition at line 272 of file certstor_sql.cpp.

References Botan::X509_Time::encode_into(), Botan::X509_Certificate::fingerprint(), Botan::DER_Encoder::get_contents_unlocked(), Botan::Certificate_Store_In_SQL::insert_cert(), and Botan::X509_Time::time_is_set().

273  {
274  insert_cert(cert);
275 
276  auto stmt1 = m_database->new_statement(
277  "INSERT OR REPLACE INTO " + m_prefix + "revoked ( fingerprint, reason, time ) VALUES ( ?1, ?2, ?3 )");
278 
279  stmt1->bind(1,cert.fingerprint("SHA-256"));
280  stmt1->bind(2,code);
281 
282  if(time.time_is_set())
283  {
284  DER_Encoder der;
285  time.encode_into(der);
286  stmt1->bind(3,der.get_contents_unlocked());
287  }
288  else
289  {
290  stmt1->bind(3,-1);
291  }
292 
293  stmt1->spin();
294  }
bool insert_cert(const X509_Certificate &cert)

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