]> git.ipfire.org Git - thirdparty/squid.git/blob - src/security/cert_generators/file/certificate_db.cc
security_file_certgen: convert xfree_char to UnaryFunctor xfree_functor
[thirdparty/squid.git] / src / security / cert_generators / file / certificate_db.cc
1 /*
2 * Copyright (C) 1996-2016 The Squid Software Foundation and contributors
3 *
4 * Squid software is distributed under GPLv2+ license and includes
5 * contributions from numerous individuals and organizations.
6 * Please see the COPYING and CONTRIBUTORS files for details.
7 */
8
9 #include "squid.h"
10 #include "base/MakeFunctor.h"
11 #include "security/cert_generators/file/certificate_db.h"
12
13 #include <cerrno>
14 #include <fstream>
15 #include <memory>
16 #include <stdexcept>
17 #if HAVE_SYS_STAT_H
18 #include <sys/stat.h>
19 #endif
20 #if HAVE_SYS_FILE_H
21 #include <sys/file.h>
22 #endif
23 #if HAVE_FCNTL_H
24 #include <fcntl.h>
25 #endif
26
27 #define HERE "(security_file_certgen) " << __FILE__ << ':' << __LINE__ << ": "
28
29 Ssl::Lock::Lock(std::string const &aFilename) :
30 filename(aFilename),
31 #if _SQUID_WINDOWS_
32 hFile(INVALID_HANDLE_VALUE)
33 #else
34 fd(-1)
35 #endif
36 {
37 }
38
39 bool Ssl::Lock::locked() const
40 {
41 #if _SQUID_WINDOWS_
42 return hFile != INVALID_HANDLE_VALUE;
43 #else
44 return fd != -1;
45 #endif
46 }
47
48 void Ssl::Lock::lock()
49 {
50
51 #if _SQUID_WINDOWS_
52 hFile = CreateFile(TEXT(filename.c_str()), GENERIC_READ, 0, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
53 if (hFile == INVALID_HANDLE_VALUE)
54 #else
55 fd = open(filename.c_str(), O_RDWR);
56 if (fd == -1)
57 #endif
58 throw std::runtime_error("Failed to open file " + filename);
59
60 #if _SQUID_WINDOWS_
61 if (!LockFile(hFile, 0, 0, 1, 0))
62 #elif _SQUID_SOLARIS_
63 if (lockf(fd, F_LOCK, 0) != 0)
64 #else
65 if (flock(fd, LOCK_EX) != 0)
66 #endif
67 throw std::runtime_error("Failed to get a lock of " + filename);
68 }
69
70 void Ssl::Lock::unlock()
71 {
72 #if _SQUID_WINDOWS_
73 if (hFile != INVALID_HANDLE_VALUE) {
74 UnlockFile(hFile, 0, 0, 1, 0);
75 CloseHandle(hFile);
76 hFile = INVALID_HANDLE_VALUE;
77 }
78 #else
79 if (fd != -1) {
80 #if _SQUID_SOLARIS_
81 lockf(fd, F_ULOCK, 0);
82 #else
83 flock(fd, LOCK_UN);
84 #endif
85 close(fd);
86 fd = -1;
87 }
88 #endif
89 else
90 throw std::runtime_error("Lock is already unlocked for " + filename);
91 }
92
93 Ssl::Lock::~Lock()
94 {
95 if (locked())
96 unlock();
97 }
98
99 Ssl::Locker::Locker(Lock &aLock, const char *aFileName, int aLineNo):
100 weLocked(false), lock(aLock), fileName(aFileName), lineNo(aLineNo)
101 {
102 if (!lock.locked()) {
103 lock.lock();
104 weLocked = true;
105 }
106 }
107
108 Ssl::Locker::~Locker()
109 {
110 if (weLocked)
111 lock.unlock();
112 }
113
114 Ssl::CertificateDb::Row::Row()
115 : width(cnlNumber)
116 {
117 row = (char **)OPENSSL_malloc(sizeof(char *) * (width + 1));
118 for (size_t i = 0; i < width + 1; ++i)
119 row[i] = NULL;
120 }
121
122 Ssl::CertificateDb::Row::Row(char **aRow, size_t aWidth): width(aWidth)
123 {
124 row = aRow;
125 }
126
127 Ssl::CertificateDb::Row::~Row()
128 {
129 if (!row)
130 return;
131
132 void *max;
133 if ((max = (void *)row[width]) != NULL) {
134 // It is an openSSL allocated row. The TXT_DB_read function stores the
135 // index and row items one one memory segment. The row[width] points
136 // to the end of buffer. We have to check for items in the array which
137 // are not stored in this segment. These items should released.
138 for (size_t i = 0; i < width + 1; ++i) {
139 if (((row[i] < (char *)row) || (row[i] > max)) && (row[i] != NULL))
140 OPENSSL_free(row[i]);
141 }
142 } else {
143 for (size_t i = 0; i < width + 1; ++i) {
144 if (row[i])
145 OPENSSL_free(row[i]);
146 }
147 }
148 OPENSSL_free(row);
149 }
150
151 void Ssl::CertificateDb::Row::reset()
152 {
153 row = NULL;
154 }
155
156 void Ssl::CertificateDb::Row::setValue(size_t cell, char const * value)
157 {
158 assert(cell < width);
159 if (row[cell]) {
160 free(row[cell]);
161 }
162 if (value) {
163 row[cell] = static_cast<char *>(OPENSSL_malloc(sizeof(char) * (strlen(value) + 1)));
164 memcpy(row[cell], value, sizeof(char) * (strlen(value) + 1));
165 } else
166 row[cell] = NULL;
167 }
168
169 char ** Ssl::CertificateDb::Row::getRow()
170 {
171 return row;
172 }
173
174 void Ssl::CertificateDb::sq_TXT_DB_delete(TXT_DB *db, const char **row)
175 {
176 if (!db)
177 return;
178
179 #if SQUID_SSLTXTDB_PSTRINGDATA
180 for (int i = 0; i < sk_OPENSSL_PSTRING_num(db->data); ++i) {
181 #if SQUID_STACKOF_PSTRINGDATA_HACK
182 const char ** current_row = ((const char **)sk_value(CHECKED_STACK_OF(OPENSSL_PSTRING, db->data), i));
183 #else
184 const char ** current_row = ((const char **)sk_OPENSSL_PSTRING_value(db->data, i));
185 #endif
186 #else
187 for (int i = 0; i < sk_num(db->data); ++i) {
188 const char ** current_row = ((const char **)sk_value(db->data, i));
189 #endif
190 if (current_row == row) {
191 sq_TXT_DB_delete_row(db, i);
192 return;
193 }
194 }
195 }
196
197 #define countof(arr) (sizeof(arr)/sizeof(*arr))
198 void Ssl::CertificateDb::sq_TXT_DB_delete_row(TXT_DB *db, int idx) {
199 char **rrow;
200 #if SQUID_SSLTXTDB_PSTRINGDATA
201 rrow = (char **)sk_OPENSSL_PSTRING_delete(db->data, idx);
202 #else
203 rrow = (char **)sk_delete(db->data, idx);
204 #endif
205
206 if (!rrow)
207 return;
208
209 Row row(rrow, cnlNumber); // row wrapper used to free the rrow
210
211 const Columns db_indexes[]= {cnlSerial, cnlName};
212 for (unsigned int i = 0; i < countof(db_indexes); ++i) {
213 void *data = NULL;
214 #if SQUID_SSLTXTDB_PSTRINGDATA
215 if (LHASH_OF(OPENSSL_STRING) *fieldIndex = db->index[db_indexes[i]])
216 data = lh_OPENSSL_STRING_delete(fieldIndex, rrow);
217 #else
218 if (LHASH *fieldIndex = db->index[db_indexes[i]])
219 data = lh_delete(fieldIndex, rrow);
220 #endif
221 if (data)
222 assert(data == rrow);
223 }
224 }
225
226 unsigned long Ssl::CertificateDb::index_serial_hash(const char **a) {
227 const char *n = a[Ssl::CertificateDb::cnlSerial];
228 while (*n == '0')
229 ++n;
230 return lh_strhash(n);
231 }
232
233 int Ssl::CertificateDb::index_serial_cmp(const char **a, const char **b) {
234 const char *aa, *bb;
235 for (aa = a[Ssl::CertificateDb::cnlSerial]; *aa == '0'; ++aa);
236 for (bb = b[Ssl::CertificateDb::cnlSerial]; *bb == '0'; ++bb);
237 return strcmp(aa, bb);
238 }
239
240 unsigned long Ssl::CertificateDb::index_name_hash(const char **a) {
241 return(lh_strhash(a[Ssl::CertificateDb::cnlName]));
242 }
243
244 int Ssl::CertificateDb::index_name_cmp(const char **a, const char **b) {
245 return(strcmp(a[Ssl::CertificateDb::cnlName], b[CertificateDb::cnlName]));
246 }
247
248 const std::string Ssl::CertificateDb::db_file("index.txt");
249 const std::string Ssl::CertificateDb::cert_dir("certs");
250 const std::string Ssl::CertificateDb::size_file("size");
251
252 Ssl::CertificateDb::CertificateDb(std::string const & aDb_path, size_t aMax_db_size, size_t aFs_block_size)
253 : db_path(aDb_path),
254 db_full(aDb_path + "/" + db_file),
255 cert_full(aDb_path + "/" + cert_dir),
256 size_full(aDb_path + "/" + size_file),
257 max_db_size(aMax_db_size),
258 fs_block_size((aFs_block_size ? aFs_block_size : 2048)),
259 dbLock(db_full),
260 enabled_disk_store(true) {
261 if (db_path.empty() && !max_db_size)
262 enabled_disk_store = false;
263 else if ((db_path.empty() && max_db_size) || (!db_path.empty() && !max_db_size))
264 throw std::runtime_error("security_file_certgen is missing the required parameter. There should be -s and -M parameters together.");
265 }
266
267 bool Ssl::CertificateDb::find(std::string const & host_name, Security::CertPointer & cert, Ssl::EVP_PKEY_Pointer & pkey) {
268 const Locker locker(dbLock, Here);
269 load();
270 return pure_find(host_name, cert, pkey);
271 }
272
273 bool Ssl::CertificateDb::purgeCert(std::string const & key) {
274 const Locker locker(dbLock, Here);
275 load();
276 if (!db)
277 return false;
278
279 if (!deleteByHostname(key))
280 return false;
281
282 save();
283 return true;
284 }
285
286 bool Ssl::CertificateDb::addCertAndPrivateKey(Security::CertPointer & cert, Ssl::EVP_PKEY_Pointer & pkey, std::string const & useName) {
287 const Locker locker(dbLock, Here);
288 load();
289 if (!db || !cert || !pkey)
290 return false;
291 Row row;
292 ASN1_INTEGER * ai = X509_get_serialNumber(cert.get());
293 std::string serial_string;
294 Ssl::BIGNUM_Pointer serial(ASN1_INTEGER_to_BN(ai, NULL));
295 {
296 std::unique_ptr<char, xfree_functor> hex_bn(BN_bn2hex(serial.get()));
297 serial_string = std::string(hex_bn.get());
298 }
299 row.setValue(cnlSerial, serial_string.c_str());
300 char ** rrow = TXT_DB_get_by_index(db.get(), cnlSerial, row.getRow());
301 // We are creating certificates with unique serial numbers. If the serial
302 // number is found in the database, the same certificate is already stored.
303 if (rrow != NULL) {
304 // TODO: check if the stored row is valid.
305 return true;
306 }
307
308 {
309 std::unique_ptr<char, xfree_functor> subject(X509_NAME_oneline(X509_get_subject_name(cert.get()), nullptr, 0));
310 Security::CertPointer findCert;
311 Ssl::EVP_PKEY_Pointer findPkey;
312 if (pure_find(useName.empty() ? subject.get() : useName, findCert, findPkey)) {
313 // Replace with database certificate
314 cert.reset(findCert.release());
315 pkey.reset(findPkey.release());
316 return true;
317 }
318 // pure_find may fail because the entry is expired, or because the
319 // certs file is corrupted. Remove any entry with given hostname
320 deleteByHostname(useName.empty() ? subject.get() : useName);
321 }
322
323 // check db size while trying to minimize calls to size()
324 size_t dbSize = size();
325 if ((dbSize == 0 && hasRows()) ||
326 (dbSize > 0 && !hasRows()) ||
327 (dbSize > 10 * max_db_size)) {
328 // Invalid database size, rebuild
329 dbSize = rebuildSize();
330 }
331 while (dbSize > max_db_size && deleteInvalidCertificate()) {
332 dbSize = size(); // get the current database size
333 // and try to find another invalid certificate if needed
334 }
335 // there are no more invalid ones, but there must be valid certificates
336 while (dbSize > max_db_size) {
337 if (!deleteOldestCertificate()) {
338 rebuildSize(); // No certificates in database.Update the size file.
339 save(); // Some entries may have been removed. Update the index file.
340 return false; // errors prevented us from freeing enough space
341 }
342 dbSize = size(); // get the current database size
343 }
344
345 row.setValue(cnlType, "V");
346 ASN1_UTCTIME * tm = X509_get_notAfter(cert.get());
347 row.setValue(cnlExp_date, std::string(reinterpret_cast<char *>(tm->data), tm->length).c_str());
348 row.setValue(cnlFile, "unknown");
349 if (!useName.empty())
350 row.setValue(cnlName, useName.c_str());
351 else {
352 std::unique_ptr<char, xfree_functor> subject(X509_NAME_oneline(X509_get_subject_name(cert.get()), nullptr, 0));
353 row.setValue(cnlName, subject.get());
354 }
355
356 if (!TXT_DB_insert(db.get(), row.getRow())) {
357 // failed to add index (???) but we may have already modified
358 // the database so save before exit
359 save();
360 return false;
361 }
362 rrow = row.getRow();
363 row.reset();
364
365 std::string filename(cert_full + "/" + serial_string + ".pem");
366 if (!writeCertAndPrivateKeyToFile(cert, pkey, filename.c_str())) {
367 //remove row from txt_db and save
368 sq_TXT_DB_delete(db.get(), (const char **)rrow);
369 save();
370 return false;
371 }
372 addSize(filename);
373
374 save();
375 return true;
376 }
377
378 void Ssl::CertificateDb::create(std::string const & db_path) {
379 if (db_path == "")
380 throw std::runtime_error("Path to db is empty");
381 std::string db_full(db_path + "/" + db_file);
382 std::string cert_full(db_path + "/" + cert_dir);
383 std::string size_full(db_path + "/" + size_file);
384
385 if (mkdir(db_path.c_str(), 0777))
386 throw std::runtime_error("Cannot create " + db_path);
387
388 if (mkdir(cert_full.c_str(), 0777))
389 throw std::runtime_error("Cannot create " + cert_full);
390
391 std::ofstream size(size_full.c_str());
392 if (size)
393 size << 0;
394 else
395 throw std::runtime_error("Cannot open " + size_full + " to open");
396 std::ofstream db(db_full.c_str());
397 if (!db)
398 throw std::runtime_error("Cannot open " + db_full + " to open");
399 }
400
401 void Ssl::CertificateDb::check(std::string const & db_path, size_t max_db_size, size_t fs_block_size) {
402 CertificateDb db(db_path, max_db_size, fs_block_size);
403 db.load();
404
405 // Call readSize to force rebuild size file in the case it is corrupted
406 (void)db.readSize();
407 }
408
409 size_t Ssl::CertificateDb::rebuildSize()
410 {
411 size_t dbSize = 0;
412 #if SQUID_SSLTXTDB_PSTRINGDATA
413 for (int i = 0; i < sk_OPENSSL_PSTRING_num(db.get()->data); ++i) {
414 #if SQUID_STACKOF_PSTRINGDATA_HACK
415 const char ** current_row = ((const char **)sk_value(CHECKED_STACK_OF(OPENSSL_PSTRING, db.get()->data), i));
416 #else
417 const char ** current_row = ((const char **)sk_OPENSSL_PSTRING_value(db.get()->data, i));
418 #endif
419 #else
420 for (int i = 0; i < sk_num(db.get()->data); ++i) {
421 const char ** current_row = ((const char **)sk_value(db.get()->data, i));
422 #endif
423 const std::string filename(cert_full + "/" + current_row[cnlSerial] + ".pem");
424 const size_t fSize = getFileSize(filename);
425 dbSize += fSize;
426 }
427 writeSize(dbSize);
428 return dbSize;
429 }
430
431 bool Ssl::CertificateDb::pure_find(std::string const & host_name, Security::CertPointer & cert, Ssl::EVP_PKEY_Pointer & pkey) {
432 if (!db)
433 return false;
434
435 Row row;
436 row.setValue(cnlName, host_name.c_str());
437
438 char **rrow = TXT_DB_get_by_index(db.get(), cnlName, row.getRow());
439 if (rrow == NULL)
440 return false;
441
442 if (!sslDateIsInTheFuture(rrow[cnlExp_date]))
443 return false;
444
445 // read cert and pkey from file.
446 std::string filename(cert_full + "/" + rrow[cnlSerial] + ".pem");
447 readCertAndPrivateKeyFromFiles(cert, pkey, filename.c_str(), NULL);
448 if (!cert || !pkey)
449 return false;
450 return true;
451 }
452
453 size_t Ssl::CertificateDb::size() {
454 return readSize();
455 }
456
457 void Ssl::CertificateDb::addSize(std::string const & filename) {
458 // readSize will rebuild 'size' file if missing or it is corrupted
459 size_t dbSize = readSize();
460 dbSize += getFileSize(filename);
461 writeSize(dbSize);
462 }
463
464 void Ssl::CertificateDb::subSize(std::string const & filename) {
465 // readSize will rebuild 'size' file if missing or it is corrupted
466 size_t dbSize = readSize();
467 const size_t fileSize = getFileSize(filename);
468 dbSize = dbSize > fileSize ? dbSize - fileSize : 0;
469 writeSize(dbSize);
470 }
471
472 size_t Ssl::CertificateDb::readSize() {
473 std::ifstream ifstr(size_full.c_str());
474 size_t db_size = 0;
475 if (!ifstr || !(ifstr >> db_size))
476 return rebuildSize();
477 return db_size;
478 }
479
480 void Ssl::CertificateDb::writeSize(size_t db_size) {
481 std::ofstream ofstr(size_full.c_str());
482 if (!ofstr)
483 throw std::runtime_error("cannot write \"" + size_full + "\" file");
484 ofstr << db_size;
485 }
486
487 size_t Ssl::CertificateDb::getFileSize(std::string const & filename) {
488 std::ifstream file(filename.c_str(), std::ios::binary);
489 if (!file)
490 return 0;
491 file.seekg(0, std::ios_base::end);
492 const std::streampos file_size = file.tellg();
493 if (file_size < 0)
494 return 0;
495 return ((static_cast<size_t>(file_size) + fs_block_size - 1) / fs_block_size) * fs_block_size;
496 }
497
498 void Ssl::CertificateDb::load() {
499 // Load db from file.
500 Ssl::BIO_Pointer in(BIO_new(BIO_s_file()));
501 if (!in || BIO_read_filename(in.get(), db_full.c_str()) <= 0)
502 throw std::runtime_error("Uninitialized SSL certificate database directory: " + db_path + ". To initialize, run \"security_file_certgen -c -s " + db_path + "\".");
503
504 bool corrupt = false;
505 Ssl::TXT_DB_Pointer temp_db(TXT_DB_read(in.get(), cnlNumber));
506 if (!temp_db)
507 corrupt = true;
508
509 // Create indexes in db.
510 if (!corrupt && !TXT_DB_create_index(temp_db.get(), cnlSerial, NULL, LHASH_HASH_FN(index_serial_hash), LHASH_COMP_FN(index_serial_cmp)))
511 corrupt = true;
512
513 if (!corrupt && !TXT_DB_create_index(temp_db.get(), cnlName, NULL, LHASH_HASH_FN(index_name_hash), LHASH_COMP_FN(index_name_cmp)))
514 corrupt = true;
515
516 if (corrupt)
517 throw std::runtime_error("The SSL certificate database " + db_path + " is corrupted. Please rebuild");
518
519 db.reset(temp_db.release());
520 }
521
522 void Ssl::CertificateDb::save() {
523 if (!db)
524 throw std::runtime_error("The certificates database is not loaded");;
525
526 // To save the db to file, create a new BIO with BIO file methods.
527 Ssl::BIO_Pointer out(BIO_new(BIO_s_file()));
528 if (!out || !BIO_write_filename(out.get(), const_cast<char *>(db_full.c_str())))
529 throw std::runtime_error("Failed to initialize " + db_full + " file for writing");;
530
531 if (TXT_DB_write(out.get(), db.get()) < 0)
532 throw std::runtime_error("Failed to write " + db_full + " file");
533 }
534
535 // Normally defined in defines.h file
536 void Ssl::CertificateDb::deleteRow(const char **row, int rowIndex) {
537 const std::string filename(cert_full + "/" + row[cnlSerial] + ".pem");
538 sq_TXT_DB_delete_row(db.get(), rowIndex);
539
540 subSize(filename);
541 int ret = remove(filename.c_str());
542 if (ret < 0 && errno != ENOENT)
543 throw std::runtime_error("Failed to remove certficate file " + filename + " from db");
544 }
545
546 bool Ssl::CertificateDb::deleteInvalidCertificate() {
547 if (!db)
548 return false;
549
550 bool removed_one = false;
551 #if SQUID_SSLTXTDB_PSTRINGDATA
552 for (int i = 0; i < sk_OPENSSL_PSTRING_num(db.get()->data); ++i) {
553 #if SQUID_STACKOF_PSTRINGDATA_HACK
554 const char ** current_row = ((const char **)sk_value(CHECKED_STACK_OF(OPENSSL_PSTRING, db.get()->data), i));
555 #else
556 const char ** current_row = ((const char **)sk_OPENSSL_PSTRING_value(db.get()->data, i));
557 #endif
558 #else
559 for (int i = 0; i < sk_num(db.get()->data); ++i) {
560 const char ** current_row = ((const char **)sk_value(db.get()->data, i));
561 #endif
562
563 if (!sslDateIsInTheFuture(current_row[cnlExp_date])) {
564 deleteRow(current_row, i);
565 removed_one = true;
566 break;
567 }
568 }
569
570 if (!removed_one)
571 return false;
572 return true;
573 }
574
575 bool Ssl::CertificateDb::deleteOldestCertificate()
576 {
577 if (!hasRows())
578 return false;
579
580 #if SQUID_SSLTXTDB_PSTRINGDATA
581 #if SQUID_STACKOF_PSTRINGDATA_HACK
582 const char **row = ((const char **)sk_value(CHECKED_STACK_OF(OPENSSL_PSTRING, db.get()->data), 0));
583 #else
584 const char **row = (const char **)sk_OPENSSL_PSTRING_value(db.get()->data, 0);
585 #endif
586 #else
587 const char **row = (const char **)sk_value(db.get()->data, 0);
588 #endif
589
590 deleteRow(row, 0);
591
592 return true;
593 }
594
595 bool Ssl::CertificateDb::deleteByHostname(std::string const & host) {
596 if (!db)
597 return false;
598
599 #if SQUID_SSLTXTDB_PSTRINGDATA
600 for (int i = 0; i < sk_OPENSSL_PSTRING_num(db.get()->data); ++i) {
601 #if SQUID_STACKOF_PSTRINGDATA_HACK
602 const char ** current_row = ((const char **)sk_value(CHECKED_STACK_OF(OPENSSL_PSTRING, db.get()->data), i));
603 #else
604 const char ** current_row = ((const char **)sk_OPENSSL_PSTRING_value(db.get()->data, i));
605 #endif
606 #else
607 for (int i = 0; i < sk_num(db.get()->data); ++i) {
608 const char ** current_row = ((const char **)sk_value(db.get()->data, i));
609 #endif
610 if (host == current_row[cnlName]) {
611 deleteRow(current_row, i);
612 return true;
613 }
614 }
615 return false;
616 }
617
618 bool Ssl::CertificateDb::hasRows() const
619 {
620 if (!db)
621 return false;
622
623 #if SQUID_SSLTXTDB_PSTRINGDATA
624 if (sk_OPENSSL_PSTRING_num(db.get()->data) == 0)
625 #else
626 if (sk_num(db.get()->data) == 0)
627 #endif
628 return false;
629 return true;
630 }
631
632 bool Ssl::CertificateDb::IsEnabledDiskStore() const {
633 return enabled_disk_store;
634 }
635