Botan  2.7.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 291 of file certstor_sql.cpp.

References Botan::X509_Certificate::fingerprint().

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

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

References Botan::X509_DN::decode_from().

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

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

References Botan::ASN1_Object::BER_encode().

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

◆ 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::ASN1_Object::BER_encode().

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

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

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

113  {
114  throw Not_Implemented("Certificate_Store_In_SQL::find_cert_by_pubkey_sha1");
115  }

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

119  {
120  throw Not_Implemented("Certificate_Store_In_SQL::find_cert_by_raw_subject_dn_sha256");
121  }

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

References Botan::Private_Key::fingerprint_private().

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

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

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

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

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

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

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

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

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

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

157  {
158  const std::vector<uint8_t> dn_encoding = cert.subject_dn().BER_encode();
159  const std::vector<uint8_t> cert_encoding = cert.BER_encode();
160 
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  stmt->bind(2,dn_encoding);
172  stmt->bind(3,cert.subject_key_id());
173  stmt->bind(4,std::vector<uint8_t>());
174  stmt->bind(5,cert_encoding);
175  stmt->spin();
176 
177  return true;
178  }

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

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

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

References Botan::Private_Key::fingerprint_private().

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

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

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

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

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