Botan  2.18.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 289 of file certstor_sql.cpp.

References Botan::X509_Certificate::fingerprint().

290  {
291  auto stmt = m_database->new_statement("DELETE FROM " + m_prefix + "revoked WHERE fingerprint == ?1");
292 
293  stmt->bind(1,cert.fingerprint("SHA-256"));
294  stmt->spin();
295  }

◆ 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 135 of file certstor_sql.cpp.

References Botan::X509_DN::decode_from().

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

◆ 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 72 of file certstor.h.

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

73  {
74  return find_cert(cert.subject_dn(), cert.subject_key_id()) != nullptr;
75  }
virtual std::shared_ptr< const X509_Certificate > find_cert(const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const
Definition: certstor.cpp:20

◆ 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 77 of file certstor_sql.cpp.

References Botan::ASN1_Object::BER_encode().

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

◆ 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.

Reimplemented from Botan::Certificate_Store.

Definition at line 48 of file certstor_sql.cpp.

References Botan::ASN1_Object::BER_encode().

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

49  {
50  std::shared_ptr<SQL_Database::Statement> stmt;
51 
52  const std::vector<uint8_t> dn_encoding = subject_dn.BER_encode();
53 
54  if(key_id.empty())
55  {
56  stmt = m_database->new_statement("SELECT certificate FROM " + m_prefix + "certificates WHERE subject_dn == ?1 LIMIT 1");
57  stmt->bind(1, dn_encoding);
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) LIMIT 1");
63  stmt->bind(1, dn_encoding);
64  stmt->bind(2,key_id);
65  }
66 
67  while(stmt->step())
68  {
69  auto blob = stmt->get_blob(0);
70  return std::make_shared<X509_Certificate>(std::vector<uint8_t>(blob.first, blob.first + blob.second));
71  }
72 
73  return std::shared_ptr<const X509_Certificate>();
74  }

◆ 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 110 of file certstor_sql.cpp.

111  {
112  throw Not_Implemented("Certificate_Store_In_SQL::find_cert_by_pubkey_sha1");
113  }

◆ 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 116 of file certstor_sql.cpp.

117  {
118  throw Not_Implemented("Certificate_Store_In_SQL::find_cert_by_raw_subject_dn_sha256");
119  }

◆ 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 213 of file certstor_sql.cpp.

References Botan::Private_Key::fingerprint_private().

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

◆ 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 122 of file certstor_sql.cpp.

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

123  {
124  auto all_crls = generate_crls();
125 
126  for(auto crl: all_crls)
127  {
128  if(!crl.get_revoked().empty() && crl.issuer_dn() == subject.issuer_dn())
129  return std::shared_ptr<X509_CRL>(new X509_CRL(crl));
130  }
131 
132  return std::shared_ptr<X509_CRL>();
133  }
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 193 of file certstor_sql.cpp.

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

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

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

◆ 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 297 of file certstor_sql.cpp.

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

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

◆ 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 154 of file certstor_sql.cpp.

References Botan::ASN1_Object::BER_encode(), Botan::X509_Certificate::fingerprint(), 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().

155  {
156  const std::vector<uint8_t> dn_encoding = cert.subject_dn().BER_encode();
157  const std::vector<uint8_t> cert_encoding = cert.BER_encode();
158 
159  auto stmt = m_database->new_statement("INSERT OR REPLACE INTO " +
160  m_prefix + "certificates (\
161  fingerprint, \
162  subject_dn, \
163  key_id, \
164  priv_fingerprint, \
165  certificate \
166  ) VALUES ( ?1, ?2, ?3, ?4, ?5 )");
167 
168  stmt->bind(1,cert.fingerprint("SHA-256"));
169  stmt->bind(2,dn_encoding);
170  stmt->bind(3,cert.subject_key_id());
171  stmt->bind(4,std::vector<uint8_t>());
172  stmt->bind(5,cert_encoding);
173  stmt->spin();
174 
175  return true;
176  }

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

231  {
232  insert_cert(cert);
233 
234  if(find_key(cert))
235  return false;
236 
237  auto pkcs8 = PKCS8::BER_encode(key, m_rng, m_password);
238  auto fpr = key.fingerprint_private("SHA-256");
239 
240  auto stmt1 = m_database->new_statement(
241  "INSERT OR REPLACE INTO " + m_prefix + "keys ( fingerprint, key ) VALUES ( ?1, ?2 )");
242 
243  stmt1->bind(1,fpr);
244  stmt1->bind(2,pkcs8.data(),pkcs8.size());
245  stmt1->spin();
246 
247  auto stmt2 = m_database->new_statement(
248  "UPDATE " + m_prefix + "certificates SET priv_fingerprint = ?1 WHERE fingerprint == ?2");
249 
250  stmt2->bind(1,fpr);
251  stmt2->bind(2,cert.fingerprint("SHA-256"));
252  stmt2->spin();
253 
254  return true;
255  }
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:139

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

180  {
181  if(!find_cert(cert.subject_dn(),cert.subject_key_id()))
182  return false;
183 
184  auto stmt = m_database->new_statement("DELETE FROM " + m_prefix + "certificates WHERE fingerprint == ?1");
185 
186  stmt->bind(1,cert.fingerprint("SHA-256"));
187  stmt->spin();
188 
189  return true;
190  }
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 257 of file certstor_sql.cpp.

References Botan::Private_Key::fingerprint_private().

258  {
259  auto fpr = key.fingerprint_private("SHA-256");
260  auto stmt = m_database->new_statement("DELETE FROM " + m_prefix + "keys WHERE fingerprint == ?1");
261 
262  stmt->bind(1,fpr);
263  stmt->spin();
264  }

◆ 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 267 of file certstor_sql.cpp.

References Botan::ASN1_Object::BER_encode(), Botan::X509_Certificate::fingerprint(), Botan::Certificate_Store_In_SQL::insert_cert(), and Botan::ASN1_Time::time_is_set().

268  {
269  insert_cert(cert);
270 
271  auto stmt1 = m_database->new_statement(
272  "INSERT OR REPLACE INTO " + m_prefix + "revoked ( fingerprint, reason, time ) VALUES ( ?1, ?2, ?3 )");
273 
274  stmt1->bind(1,cert.fingerprint("SHA-256"));
275  stmt1->bind(2,code);
276 
277  if(time.time_is_set())
278  {
279  stmt1->bind(3, time.BER_encode());
280  }
281  else
282  {
283  stmt1->bind(3, static_cast<size_t>(-1));
284  }
285 
286  stmt1->spin();
287  }
bool insert_cert(const X509_Certificate &cert)

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