2 * Copyright (C) 1996-2016 The Squid Software Foundation and contributors
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.
10 #include "base/MakeFunctor.h"
11 #include "security/cert_generators/file/certificate_db.h"
27 #define HERE "(security_file_certgen) " << __FILE__ << ':' << __LINE__ << ": "
29 Ssl::Lock::Lock(std::string
const &aFilename
) :
32 hFile(INVALID_HANDLE_VALUE
)
39 bool Ssl::Lock::locked() const
42 return hFile
!= INVALID_HANDLE_VALUE
;
48 void Ssl::Lock::lock()
52 hFile
= CreateFile(TEXT(filename
.c_str()), GENERIC_READ
, 0, NULL
, OPEN_EXISTING
, FILE_ATTRIBUTE_NORMAL
, NULL
);
53 if (hFile
== INVALID_HANDLE_VALUE
)
55 fd
= open(filename
.c_str(), O_RDWR
);
58 throw std::runtime_error("Failed to open file " + filename
);
61 if (!LockFile(hFile
, 0, 0, 1, 0))
63 if (lockf(fd
, F_LOCK
, 0) != 0)
65 if (flock(fd
, LOCK_EX
) != 0)
67 throw std::runtime_error("Failed to get a lock of " + filename
);
70 void Ssl::Lock::unlock()
73 if (hFile
!= INVALID_HANDLE_VALUE
) {
74 UnlockFile(hFile
, 0, 0, 1, 0);
76 hFile
= INVALID_HANDLE_VALUE
;
81 lockf(fd
, F_ULOCK
, 0);
90 throw std::runtime_error("Lock is already unlocked for " + filename
);
99 Ssl::Locker::Locker(Lock
&aLock
, const char *aFileName
, int aLineNo
):
100 weLocked(false), lock(aLock
), fileName(aFileName
), lineNo(aLineNo
)
102 if (!lock
.locked()) {
108 Ssl::Locker::~Locker()
114 Ssl::CertificateDb::Row::Row()
117 row
= (char **)OPENSSL_malloc(sizeof(char *) * (width
+ 1));
118 for (size_t i
= 0; i
< width
+ 1; ++i
)
122 Ssl::CertificateDb::Row::Row(char **aRow
, size_t aWidth
): width(aWidth
)
127 Ssl::CertificateDb::Row::~Row()
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
]);
143 for (size_t i
= 0; i
< width
+ 1; ++i
) {
145 OPENSSL_free(row
[i
]);
151 void Ssl::CertificateDb::Row::reset()
156 void Ssl::CertificateDb::Row::setValue(size_t cell
, char const * value
)
158 assert(cell
< width
);
163 row
[cell
] = static_cast<char *>(OPENSSL_malloc(sizeof(char) * (strlen(value
) + 1)));
164 memcpy(row
[cell
], value
, sizeof(char) * (strlen(value
) + 1));
169 char ** Ssl::CertificateDb::Row::getRow()
174 void Ssl::CertificateDb::sq_TXT_DB_delete(TXT_DB
*db
, const char **row
)
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
));
184 const char ** current_row
= ((const char **)sk_OPENSSL_PSTRING_value(db
->data
, i
));
187 for (int i
= 0; i
< sk_num(db
->data
); ++i
) {
188 const char ** current_row
= ((const char **)sk_value(db
->data
, i
));
190 if (current_row
== row
) {
191 sq_TXT_DB_delete_row(db
, i
);
197 #define countof(arr) (sizeof(arr)/sizeof(*arr))
198 void Ssl::CertificateDb::sq_TXT_DB_delete_row(TXT_DB
*db
, int idx
) {
200 #if SQUID_SSLTXTDB_PSTRINGDATA
201 rrow
= (char **)sk_OPENSSL_PSTRING_delete(db
->data
, idx
);
203 rrow
= (char **)sk_delete(db
->data
, idx
);
209 Row
row(rrow
, cnlNumber
); // row wrapper used to free the rrow
211 const Columns db_indexes
[]= {cnlSerial
, cnlName
};
212 for (unsigned int i
= 0; i
< countof(db_indexes
); ++i
) {
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
);
218 if (LHASH
*fieldIndex
= db
->index
[db_indexes
[i
]])
219 data
= lh_delete(fieldIndex
, rrow
);
222 assert(data
== rrow
);
226 unsigned long Ssl::CertificateDb::index_serial_hash(const char **a
) {
227 const char *n
= a
[Ssl::CertificateDb::cnlSerial
];
230 return lh_strhash(n
);
233 int Ssl::CertificateDb::index_serial_cmp(const char **a
, const char **b
) {
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
);
240 unsigned long Ssl::CertificateDb::index_name_hash(const char **a
) {
241 return(lh_strhash(a
[Ssl::CertificateDb::cnlName
]));
244 int Ssl::CertificateDb::index_name_cmp(const char **a
, const char **b
) {
245 return(strcmp(a
[Ssl::CertificateDb::cnlName
], b
[CertificateDb::cnlName
]));
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");
252 Ssl::CertificateDb::CertificateDb(std::string
const & aDb_path
, size_t aMax_db_size
, size_t aFs_block_size
)
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)),
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.");
267 bool Ssl::CertificateDb::find(std::string
const & host_name
, Security::CertPointer
& cert
, Ssl::EVP_PKEY_Pointer
& pkey
) {
268 const Locker
locker(dbLock
, Here
);
270 return pure_find(host_name
, cert
, pkey
);
273 bool Ssl::CertificateDb::purgeCert(std::string
const & key
) {
274 const Locker
locker(dbLock
, Here
);
279 if (!deleteByHostname(key
))
286 bool Ssl::CertificateDb::addCertAndPrivateKey(Security::CertPointer
& cert
, Ssl::EVP_PKEY_Pointer
& pkey
, std::string
const & useName
) {
287 const Locker
locker(dbLock
, Here
);
289 if (!db
|| !cert
|| !pkey
)
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
));
296 std::unique_ptr
<char, xfree_functor
> hex_bn(BN_bn2hex(serial
.get()));
297 serial_string
= std::string(hex_bn
.get());
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.
304 // TODO: check if the stored row is valid.
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());
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
);
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();
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
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
342 dbSize
= size(); // get the current database size
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());
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());
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
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
);
378 void Ssl::CertificateDb::create(std::string
const & 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
);
385 if (mkdir(db_path
.c_str(), 0777))
386 throw std::runtime_error("Cannot create " + db_path
);
388 if (mkdir(cert_full
.c_str(), 0777))
389 throw std::runtime_error("Cannot create " + cert_full
);
391 std::ofstream
size(size_full
.c_str());
395 throw std::runtime_error("Cannot open " + size_full
+ " to open");
396 std::ofstream
db(db_full
.c_str());
398 throw std::runtime_error("Cannot open " + db_full
+ " to open");
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
);
405 // Call readSize to force rebuild size file in the case it is corrupted
409 size_t Ssl::CertificateDb::rebuildSize()
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
));
417 const char ** current_row
= ((const char **)sk_OPENSSL_PSTRING_value(db
.get()->data
, i
));
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
));
423 const std::string
filename(cert_full
+ "/" + current_row
[cnlSerial
] + ".pem");
424 const size_t fSize
= getFileSize(filename
);
431 bool Ssl::CertificateDb::pure_find(std::string
const & host_name
, Security::CertPointer
& cert
, Ssl::EVP_PKEY_Pointer
& pkey
) {
436 row
.setValue(cnlName
, host_name
.c_str());
438 char **rrow
= TXT_DB_get_by_index(db
.get(), cnlName
, row
.getRow());
442 if (!sslDateIsInTheFuture(rrow
[cnlExp_date
]))
445 // read cert and pkey from file.
446 std::string
filename(cert_full
+ "/" + rrow
[cnlSerial
] + ".pem");
447 readCertAndPrivateKeyFromFiles(cert
, pkey
, filename
.c_str(), NULL
);
453 size_t Ssl::CertificateDb::size() {
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
);
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;
472 size_t Ssl::CertificateDb::readSize() {
473 std::ifstream
ifstr(size_full
.c_str());
475 if (!ifstr
|| !(ifstr
>> db_size
))
476 return rebuildSize();
480 void Ssl::CertificateDb::writeSize(size_t db_size
) {
481 std::ofstream
ofstr(size_full
.c_str());
483 throw std::runtime_error("cannot write \"" + size_full
+ "\" file");
487 size_t Ssl::CertificateDb::getFileSize(std::string
const & filename
) {
488 std::ifstream
file(filename
.c_str(), std::ios::binary
);
491 file
.seekg(0, std::ios_base::end
);
492 const std::streampos file_size
= file
.tellg();
495 return ((static_cast<size_t>(file_size
) + fs_block_size
- 1) / fs_block_size
) * fs_block_size
;
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
+ "\".");
504 bool corrupt
= false;
505 Ssl::TXT_DB_Pointer
temp_db(TXT_DB_read(in
.get(), cnlNumber
));
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
)))
513 if (!corrupt
&& !TXT_DB_create_index(temp_db
.get(), cnlName
, NULL
, LHASH_HASH_FN(index_name_hash
), LHASH_COMP_FN(index_name_cmp
)))
517 throw std::runtime_error("The SSL certificate database " + db_path
+ " is corrupted. Please rebuild");
519 db
.reset(temp_db
.release());
522 void Ssl::CertificateDb::save() {
524 throw std::runtime_error("The certificates database is not loaded");;
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");;
531 if (TXT_DB_write(out
.get(), db
.get()) < 0)
532 throw std::runtime_error("Failed to write " + db_full
+ " file");
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
);
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");
546 bool Ssl::CertificateDb::deleteInvalidCertificate() {
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
));
556 const char ** current_row
= ((const char **)sk_OPENSSL_PSTRING_value(db
.get()->data
, i
));
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
));
563 if (!sslDateIsInTheFuture(current_row
[cnlExp_date
])) {
564 deleteRow(current_row
, i
);
575 bool Ssl::CertificateDb::deleteOldestCertificate()
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));
584 const char **row
= (const char **)sk_OPENSSL_PSTRING_value(db
.get()->data
, 0);
587 const char **row
= (const char **)sk_value(db
.get()->data
, 0);
595 bool Ssl::CertificateDb::deleteByHostname(std::string
const & host
) {
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
));
604 const char ** current_row
= ((const char **)sk_OPENSSL_PSTRING_value(db
.get()->data
, i
));
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
));
610 if (host
== current_row
[cnlName
]) {
611 deleteRow(current_row
, i
);
618 bool Ssl::CertificateDb::hasRows() const
623 #if SQUID_SSLTXTDB_PSTRINGDATA
624 if (sk_OPENSSL_PSTRING_num(db
.get()->data
) == 0)
626 if (sk_num(db
.get()->data
) == 0)
632 bool Ssl::CertificateDb::IsEnabledDiskStore() const {
633 return enabled_disk_store
;