2 * Copyright (C) 1996-2015 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 "ssl/certificate_db.h"
25 #define HERE "(ssl_crtd) " << __FILE__ << ':' << __LINE__ << ": "
27 Ssl::Lock::Lock(std::string
const &aFilename
) :
30 hFile(INVALID_HANDLE_VALUE
)
37 bool Ssl::Lock::locked() const
40 return hFile
!= INVALID_HANDLE_VALUE
;
46 void Ssl::Lock::lock()
50 hFile
= CreateFile(TEXT(filename
.c_str()), GENERIC_READ
, 0, NULL
, OPEN_EXISTING
, FILE_ATTRIBUTE_NORMAL
, NULL
);
51 if (hFile
== INVALID_HANDLE_VALUE
)
53 fd
= open(filename
.c_str(), O_RDWR
);
56 throw std::runtime_error("Failed to open file " + filename
);
59 if (!LockFile(hFile
, 0, 0, 1, 0))
61 if (lockf(fd
, F_LOCK
, 0) != 0)
63 if (flock(fd
, LOCK_EX
) != 0)
65 throw std::runtime_error("Failed to get a lock of " + filename
);
68 void Ssl::Lock::unlock()
71 if (hFile
!= INVALID_HANDLE_VALUE
) {
72 UnlockFile(hFile
, 0, 0, 1, 0);
74 hFile
= INVALID_HANDLE_VALUE
;
79 lockf(fd
, F_ULOCK
, 0);
88 throw std::runtime_error("Lock is already unlocked for " + filename
);
97 Ssl::Locker::Locker(Lock
&aLock
, const char *aFileName
, int aLineNo
):
98 weLocked(false), lock(aLock
), fileName(aFileName
), lineNo(aLineNo
)
100 if (!lock
.locked()) {
106 Ssl::Locker::~Locker()
112 Ssl::CertificateDb::Row::Row()
115 row
= (char **)OPENSSL_malloc(sizeof(char *) * (width
+ 1));
116 for (size_t i
= 0; i
< width
+ 1; ++i
)
120 Ssl::CertificateDb::Row::Row(char **aRow
, size_t aWidth
): width(aWidth
)
125 Ssl::CertificateDb::Row::~Row()
131 if ((max
= (void *)row
[width
]) != NULL
) {
132 // It is an openSSL allocated row. The TXT_DB_read function stores the
133 // index and row items one one memory segment. The row[width] points
134 // to the end of buffer. We have to check for items in the array which
135 // are not stored in this segment. These items should released.
136 for (size_t i
= 0; i
< width
+ 1; ++i
) {
137 if (((row
[i
] < (char *)row
) || (row
[i
] > max
)) && (row
[i
] != NULL
))
138 OPENSSL_free(row
[i
]);
141 for (size_t i
= 0; i
< width
+ 1; ++i
) {
143 OPENSSL_free(row
[i
]);
149 void Ssl::CertificateDb::Row::reset()
154 void Ssl::CertificateDb::Row::setValue(size_t cell
, char const * value
)
156 assert(cell
< width
);
161 row
[cell
] = static_cast<char *>(OPENSSL_malloc(sizeof(char) * (strlen(value
) + 1)));
162 memcpy(row
[cell
], value
, sizeof(char) * (strlen(value
) + 1));
167 char ** Ssl::CertificateDb::Row::getRow()
172 void Ssl::CertificateDb::sq_TXT_DB_delete(TXT_DB
*db
, const char **row
)
177 #if SQUID_SSLTXTDB_PSTRINGDATA
178 for (int i
= 0; i
< sk_OPENSSL_PSTRING_num(db
->data
); ++i
) {
179 #if SQUID_STACKOF_PSTRINGDATA_HACK
180 const char ** current_row
= ((const char **)sk_value(CHECKED_STACK_OF(OPENSSL_PSTRING
, db
->data
), i
));
182 const char ** current_row
= ((const char **)sk_OPENSSL_PSTRING_value(db
->data
, i
));
185 for (int i
= 0; i
< sk_num(db
->data
); ++i
) {
186 const char ** current_row
= ((const char **)sk_value(db
->data
, i
));
188 if (current_row
== row
) {
189 sq_TXT_DB_delete_row(db
, i
);
195 #define countof(arr) (sizeof(arr)/sizeof(*arr))
196 void Ssl::CertificateDb::sq_TXT_DB_delete_row(TXT_DB
*db
, int idx
) {
198 #if SQUID_SSLTXTDB_PSTRINGDATA
199 rrow
= (char **)sk_OPENSSL_PSTRING_delete(db
->data
, idx
);
201 rrow
= (char **)sk_delete(db
->data
, idx
);
207 Row
row(rrow
, cnlNumber
); // row wrapper used to free the rrow
209 const Columns db_indexes
[]= {cnlSerial
, cnlName
};
210 for (unsigned int i
= 0; i
< countof(db_indexes
); ++i
) {
212 #if SQUID_SSLTXTDB_PSTRINGDATA
213 if (LHASH_OF(OPENSSL_STRING
) *fieldIndex
= db
->index
[db_indexes
[i
]])
214 data
= lh_OPENSSL_STRING_delete(fieldIndex
, rrow
);
216 if (LHASH
*fieldIndex
= db
->index
[db_indexes
[i
]])
217 data
= lh_delete(fieldIndex
, rrow
);
220 assert(data
== rrow
);
224 unsigned long Ssl::CertificateDb::index_serial_hash(const char **a
) {
225 const char *n
= a
[Ssl::CertificateDb::cnlSerial
];
228 return lh_strhash(n
);
231 int Ssl::CertificateDb::index_serial_cmp(const char **a
, const char **b
) {
233 for (aa
= a
[Ssl::CertificateDb::cnlSerial
]; *aa
== '0'; ++aa
);
234 for (bb
= b
[Ssl::CertificateDb::cnlSerial
]; *bb
== '0'; ++bb
);
235 return strcmp(aa
, bb
);
238 unsigned long Ssl::CertificateDb::index_name_hash(const char **a
) {
239 return(lh_strhash(a
[Ssl::CertificateDb::cnlName
]));
242 int Ssl::CertificateDb::index_name_cmp(const char **a
, const char **b
) {
243 return(strcmp(a
[Ssl::CertificateDb::cnlName
], b
[CertificateDb::cnlName
]));
246 const std::string
Ssl::CertificateDb::db_file("index.txt");
247 const std::string
Ssl::CertificateDb::cert_dir("certs");
248 const std::string
Ssl::CertificateDb::size_file("size");
250 Ssl::CertificateDb::CertificateDb(std::string
const & aDb_path
, size_t aMax_db_size
, size_t aFs_block_size
)
252 db_full(aDb_path
+ "/" + db_file
),
253 cert_full(aDb_path
+ "/" + cert_dir
),
254 size_full(aDb_path
+ "/" + size_file
),
256 max_db_size(aMax_db_size
),
257 fs_block_size((aFs_block_size
? aFs_block_size
: 2048)),
259 enabled_disk_store(true) {
260 if (db_path
.empty() && !max_db_size
)
261 enabled_disk_store
= false;
262 else if ((db_path
.empty() && max_db_size
) || (!db_path
.empty() && !max_db_size
))
263 throw std::runtime_error("ssl_crtd is missing the required parameter. There should be -s and -M parameters together.");
266 bool Ssl::CertificateDb::find(std::string
const & host_name
, Ssl::X509_Pointer
& cert
, Ssl::EVP_PKEY_Pointer
& pkey
) {
267 const Locker
locker(dbLock
, Here
);
269 return pure_find(host_name
, cert
, pkey
);
272 bool Ssl::CertificateDb::purgeCert(std::string
const & key
) {
273 const Locker
locker(dbLock
, Here
);
278 if (!deleteByHostname(key
))
285 bool Ssl::CertificateDb::addCertAndPrivateKey(Ssl::X509_Pointer
& cert
, Ssl::EVP_PKEY_Pointer
& pkey
, std::string
const & useName
) {
286 const Locker
locker(dbLock
, Here
);
288 if (!db
|| !cert
|| !pkey
)
291 ASN1_INTEGER
* ai
= X509_get_serialNumber(cert
.get());
292 std::string serial_string
;
293 Ssl::BIGNUM_Pointer
serial(ASN1_INTEGER_to_BN(ai
, NULL
));
295 TidyPointer
<char, tidyFree
> hex_bn(BN_bn2hex(serial
.get()));
296 serial_string
= std::string(hex_bn
.get());
298 row
.setValue(cnlSerial
, serial_string
.c_str());
299 char ** rrow
= TXT_DB_get_by_index(db
.get(), cnlSerial
, row
.getRow());
300 // We are creating certificates with unique serial numbers. If the serial
301 // number is found in the database, the same certificate is already stored.
303 // TODO: check if the stored row is valid.
308 TidyPointer
<char, tidyFree
> subject(X509_NAME_oneline(X509_get_subject_name(cert
.get()), NULL
, 0));
309 Ssl::X509_Pointer findCert
;
310 Ssl::EVP_PKEY_Pointer findPkey
;
311 if (pure_find(useName
.empty() ? subject
.get() : useName
, findCert
, findPkey
)) {
312 // Replace with database certificate
313 cert
.reset(findCert
.release());
314 pkey
.reset(findPkey
.release());
317 // pure_find may fail because the entry is expired, or because the
318 // certs file is corrupted. Remove any entry with given hostname
319 deleteByHostname(useName
.empty() ? subject
.get() : useName
);
322 // check db size while trying to minimize calls to size()
323 while (size() > max_db_size
) {
324 if (deleteInvalidCertificate())
325 continue; // try to find another invalid certificate if needed
327 // there are no more invalid ones, but there must be valid certificates
329 if (!deleteOldestCertificate()) {
330 save(); // Some entries may have been removed. Update the index file.
331 return false; // errors prevented us from freeing enough space
333 } while (size() > max_db_size
);
337 row
.setValue(cnlType
, "V");
338 ASN1_UTCTIME
* tm
= X509_get_notAfter(cert
.get());
339 row
.setValue(cnlExp_date
, std::string(reinterpret_cast<char *>(tm
->data
), tm
->length
).c_str());
340 row
.setValue(cnlFile
, "unknown");
341 if (!useName
.empty())
342 row
.setValue(cnlName
, useName
.c_str());
344 TidyPointer
<char, tidyFree
> subject(X509_NAME_oneline(X509_get_subject_name(cert
.get()), NULL
, 0));
345 row
.setValue(cnlName
, subject
.get());
348 if (!TXT_DB_insert(db
.get(), row
.getRow())) {
349 // failed to add index (???) but we may have already modified
350 // the database so save before exit
357 std::string
filename(cert_full
+ "/" + serial_string
+ ".pem");
358 if (!writeCertAndPrivateKeyToFile(cert
, pkey
, filename
.c_str())) {
359 //remove row from txt_db and save
360 sq_TXT_DB_delete(db
.get(), (const char **)rrow
);
370 void Ssl::CertificateDb::create(std::string
const & db_path
) {
372 throw std::runtime_error("Path to db is empty");
373 std::string
db_full(db_path
+ "/" + db_file
);
374 std::string
cert_full(db_path
+ "/" + cert_dir
);
375 std::string
size_full(db_path
+ "/" + size_file
);
377 if (mkdir(db_path
.c_str(), 0777))
378 throw std::runtime_error("Cannot create " + db_path
);
380 if (mkdir(cert_full
.c_str(), 0777))
381 throw std::runtime_error("Cannot create " + cert_full
);
383 std::ofstream
size(size_full
.c_str());
387 throw std::runtime_error("Cannot open " + size_full
+ " to open");
388 std::ofstream
db(db_full
.c_str());
390 throw std::runtime_error("Cannot open " + db_full
+ " to open");
393 void Ssl::CertificateDb::check(std::string
const & db_path
, size_t max_db_size
, size_t fs_block_size
) {
394 CertificateDb
db(db_path
, max_db_size
, fs_block_size
);
397 // Call readSize to force rebuild size file in the case it is corrupted
401 size_t Ssl::CertificateDb::rebuildSize()
404 #if SQUID_SSLTXTDB_PSTRINGDATA
405 for (int i
= 0; i
< sk_OPENSSL_PSTRING_num(db
.get()->data
); ++i
) {
406 #if SQUID_STACKOF_PSTRINGDATA_HACK
407 const char ** current_row
= ((const char **)sk_value(CHECKED_STACK_OF(OPENSSL_PSTRING
, db
.get()->data
), i
));
409 const char ** current_row
= ((const char **)sk_OPENSSL_PSTRING_value(db
.get()->data
, i
));
412 for (int i
= 0; i
< sk_num(db
.get()->data
); ++i
) {
413 const char ** current_row
= ((const char **)sk_value(db
.get()->data
, i
));
415 const std::string
filename(cert_full
+ "/" + current_row
[cnlSerial
] + ".pem");
416 const size_t fSize
= getFileSize(filename
);
423 bool Ssl::CertificateDb::pure_find(std::string
const & host_name
, Ssl::X509_Pointer
& cert
, Ssl::EVP_PKEY_Pointer
& pkey
) {
428 row
.setValue(cnlName
, host_name
.c_str());
430 char **rrow
= TXT_DB_get_by_index(db
.get(), cnlName
, row
.getRow());
434 if (!sslDateIsInTheFuture(rrow
[cnlExp_date
]))
437 // read cert and pkey from file.
438 std::string
filename(cert_full
+ "/" + rrow
[cnlSerial
] + ".pem");
439 readCertAndPrivateKeyFromFiles(cert
, pkey
, filename
.c_str(), NULL
);
445 size_t Ssl::CertificateDb::size() {
449 void Ssl::CertificateDb::addSize(std::string
const & filename
) {
450 // readSize will rebuild 'size' file if missing or it is corrupted
451 size_t dbSize
= readSize();
452 dbSize
+= getFileSize(filename
);
456 void Ssl::CertificateDb::subSize(std::string
const & filename
) {
457 // readSize will rebuild 'size' file if missing or it is corrupted
458 size_t dbSize
= readSize();
459 dbSize
-= getFileSize(filename
);
463 size_t Ssl::CertificateDb::readSize() {
464 std::ifstream
ifstr(size_full
.c_str());
466 if (!ifstr
|| !(ifstr
>> db_size
))
467 return rebuildSize();
471 void Ssl::CertificateDb::writeSize(size_t db_size
) {
472 std::ofstream
ofstr(size_full
.c_str());
474 throw std::runtime_error("cannot write \"" + size_full
+ "\" file");
478 size_t Ssl::CertificateDb::getFileSize(std::string
const & filename
) {
479 std::ifstream
file(filename
.c_str(), std::ios::binary
);
482 file
.seekg(0, std::ios_base::end
);
483 size_t file_size
= file
.tellg();
484 return ((file_size
+ fs_block_size
- 1) / fs_block_size
) * fs_block_size
;
487 void Ssl::CertificateDb::load() {
488 // Load db from file.
489 Ssl::BIO_Pointer
in(BIO_new(BIO_s_file()));
490 if (!in
|| BIO_read_filename(in
.get(), db_full
.c_str()) <= 0)
491 throw std::runtime_error("Uninitialized SSL certificate database directory: " + db_path
+ ". To initialize, run \"ssl_crtd -c -s " + db_path
+ "\".");
493 bool corrupt
= false;
494 Ssl::TXT_DB_Pointer
temp_db(TXT_DB_read(in
.get(), cnlNumber
));
498 // Create indexes in db.
499 if (!corrupt
&& !TXT_DB_create_index(temp_db
.get(), cnlSerial
, NULL
, LHASH_HASH_FN(index_serial_hash
), LHASH_COMP_FN(index_serial_cmp
)))
502 if (!corrupt
&& !TXT_DB_create_index(temp_db
.get(), cnlName
, NULL
, LHASH_HASH_FN(index_name_hash
), LHASH_COMP_FN(index_name_cmp
)))
506 throw std::runtime_error("The SSL certificate database " + db_path
+ " is corrupted. Please rebuild");
508 db
.reset(temp_db
.release());
511 void Ssl::CertificateDb::save() {
513 throw std::runtime_error("The certificates database is not loaded");;
515 // To save the db to file, create a new BIO with BIO file methods.
516 Ssl::BIO_Pointer
out(BIO_new(BIO_s_file()));
517 if (!out
|| !BIO_write_filename(out
.get(), const_cast<char *>(db_full
.c_str())))
518 throw std::runtime_error("Failed to initialize " + db_full
+ " file for writing");;
520 if (TXT_DB_write(out
.get(), db
.get()) < 0)
521 throw std::runtime_error("Failed to write " + db_full
+ " file");
524 // Normally defined in defines.h file
525 void Ssl::CertificateDb::deleteRow(const char **row
, int rowIndex
) {
526 const std::string
filename(cert_full
+ "/" + row
[cnlSerial
] + ".pem");
527 sq_TXT_DB_delete_row(db
.get(), rowIndex
);
530 int ret
= remove(filename
.c_str());
531 if (ret
< 0 && errno
!= ENOENT
)
532 throw std::runtime_error("Failed to remove certficate file " + filename
+ " from db");
535 bool Ssl::CertificateDb::deleteInvalidCertificate() {
539 bool removed_one
= false;
540 #if SQUID_SSLTXTDB_PSTRINGDATA
541 for (int i
= 0; i
< sk_OPENSSL_PSTRING_num(db
.get()->data
); ++i
) {
542 #if SQUID_STACKOF_PSTRINGDATA_HACK
543 const char ** current_row
= ((const char **)sk_value(CHECKED_STACK_OF(OPENSSL_PSTRING
, db
.get()->data
), i
));
545 const char ** current_row
= ((const char **)sk_OPENSSL_PSTRING_value(db
.get()->data
, i
));
548 for (int i
= 0; i
< sk_num(db
.get()->data
); ++i
) {
549 const char ** current_row
= ((const char **)sk_value(db
.get()->data
, i
));
552 if (!sslDateIsInTheFuture(current_row
[cnlExp_date
])) {
553 deleteRow(current_row
, i
);
564 bool Ssl::CertificateDb::deleteOldestCertificate() {
568 #if SQUID_SSLTXTDB_PSTRINGDATA
569 if (sk_OPENSSL_PSTRING_num(db
.get()->data
) == 0)
571 if (sk_num(db
.get()->data
) == 0)
575 #if SQUID_SSLTXTDB_PSTRINGDATA
576 #if SQUID_STACKOF_PSTRINGDATA_HACK
577 const char **row
= ((const char **)sk_value(CHECKED_STACK_OF(OPENSSL_PSTRING
, db
.get()->data
), 0));
579 const char **row
= (const char **)sk_OPENSSL_PSTRING_value(db
.get()->data
, 0);
582 const char **row
= (const char **)sk_value(db
.get()->data
, 0);
590 bool Ssl::CertificateDb::deleteByHostname(std::string
const & host
) {
594 #if SQUID_SSLTXTDB_PSTRINGDATA
595 for (int i
= 0; i
< sk_OPENSSL_PSTRING_num(db
.get()->data
); ++i
) {
596 #if SQUID_STACKOF_PSTRINGDATA_HACK
597 const char ** current_row
= ((const char **)sk_value(CHECKED_STACK_OF(OPENSSL_PSTRING
, db
.get()->data
), i
));
599 const char ** current_row
= ((const char **)sk_OPENSSL_PSTRING_value(db
.get()->data
, i
));
602 for (int i
= 0; i
< sk_num(db
.get()->data
); ++i
) {
603 const char ** current_row
= ((const char **)sk_value(db
.get()->data
, i
));
605 if (host
== current_row
[cnlName
]) {
606 deleteRow(current_row
, i
);
613 bool Ssl::CertificateDb::IsEnabledDiskStore() const {
614 return enabled_disk_store
;