2 #include "ssl/certificate_db.h"
22 #define HERE "(ssl_crtd) " << __FILE__ << ':' << __LINE__ << ": "
24 Ssl::Lock::Lock(std::string
const &aFilename
) :
27 hFile(INVALID_HANDLE_VALUE
)
34 bool Ssl::Lock::locked() const
37 return hFile
!= INVALID_HANDLE_VALUE
;
43 void Ssl::Lock::lock()
47 hFile
= CreateFile(TEXT(filename
.c_str()), GENERIC_READ
, 0, NULL
, OPEN_EXISTING
, FILE_ATTRIBUTE_NORMAL
, NULL
);
48 if (hFile
== INVALID_HANDLE_VALUE
)
50 fd
= open(filename
.c_str(), 0);
53 throw std::runtime_error("Failed to open file " + filename
);
56 if (!LockFile(hFile
, 0, 0, 1, 0))
58 if (flock(fd
, LOCK_EX
) != 0)
60 throw std::runtime_error("Failed to get a lock of " + filename
);
63 void Ssl::Lock::unlock()
66 if (hFile
!= INVALID_HANDLE_VALUE
) {
67 UnlockFile(hFile
, 0, 0, 1, 0);
69 hFile
= INVALID_HANDLE_VALUE
;
79 throw std::runtime_error("Lock is already unlocked for " + filename
);
88 Ssl::Locker::Locker(Lock
&aLock
, const char *aFileName
, int aLineNo
):
89 weLocked(false), lock(aLock
), fileName(aFileName
), lineNo(aLineNo
)
97 Ssl::Locker::~Locker()
103 Ssl::CertificateDb::Row::Row()
106 row
= (char **)OPENSSL_malloc(sizeof(char *) * (width
+ 1));
107 for (size_t i
= 0; i
< width
+ 1; ++i
)
111 Ssl::CertificateDb::Row::Row(char **aRow
, size_t aWidth
): width(aWidth
)
116 Ssl::CertificateDb::Row::~Row()
122 if ((max
= (void *)row
[width
]) != NULL
) {
123 // It is an openSSL allocated row. The TXT_DB_read function stores the
124 // index and row items one one memory segment. The row[width] points
125 // to the end of buffer. We have to check for items in the array which
126 // are not stored in this segment. These items should released.
127 for (size_t i
= 0; i
< width
+ 1; ++i
) {
128 if (((row
[i
] < (char *)row
) || (row
[i
] > max
)) && (row
[i
] != NULL
))
129 OPENSSL_free(row
[i
]);
132 for (size_t i
= 0; i
< width
+ 1; ++i
) {
134 OPENSSL_free(row
[i
]);
140 void Ssl::CertificateDb::Row::reset()
145 void Ssl::CertificateDb::Row::setValue(size_t cell
, char const * value
)
147 assert(cell
< width
);
152 row
[cell
] = static_cast<char *>(OPENSSL_malloc(sizeof(char) * (strlen(value
) + 1)));
153 memcpy(row
[cell
], value
, sizeof(char) * (strlen(value
) + 1));
158 char ** Ssl::CertificateDb::Row::getRow()
163 void Ssl::CertificateDb::sq_TXT_DB_delete(TXT_DB
*db
, const char **row
)
168 #if SQUID_SSLTXTDB_PSTRINGDATA
169 for (int i
= 0; i
< sk_OPENSSL_PSTRING_num(db
->data
); ++i
) {
170 const char ** current_row
= ((const char **)sk_OPENSSL_PSTRING_value(db
->data
, i
));
172 for (int i
= 0; i
< sk_num(db
->data
); ++i
) {
173 const char ** current_row
= ((const char **)sk_value(db
->data
, i
));
175 if (current_row
== row
) {
176 sq_TXT_DB_delete_row(db
, i
);
182 #define countof(arr) (sizeof(arr)/sizeof(*arr))
183 void Ssl::CertificateDb::sq_TXT_DB_delete_row(TXT_DB
*db
, int idx
)
186 #if SQUID_SSLTXTDB_PSTRINGDATA
187 rrow
= (char **)sk_OPENSSL_PSTRING_delete(db
->data
, idx
);
189 rrow
= (char **)sk_delete(db
->data
, idx
);
195 Row
row(rrow
, cnlNumber
); // row wrapper used to free the rrow
197 const Columns db_indexes
[]={cnlSerial
, cnlName
};
198 for (unsigned int i
= 0; i
< countof(db_indexes
); ++i
) {
200 #if SQUID_SSLTXTDB_PSTRINGDATA
201 if (LHASH_OF(OPENSSL_STRING
) *fieldIndex
= db
->index
[db_indexes
[i
]])
202 data
= lh_OPENSSL_STRING_delete(fieldIndex
, rrow
);
204 if (LHASH
*fieldIndex
= db
->index
[db_indexes
[i
]])
205 data
= lh_delete(fieldIndex
, rrow
);
208 assert(data
== rrow
);
212 unsigned long Ssl::CertificateDb::index_serial_hash(const char **a
)
214 const char *n
= a
[Ssl::CertificateDb::cnlSerial
];
217 return lh_strhash(n
);
220 int Ssl::CertificateDb::index_serial_cmp(const char **a
, const char **b
)
223 for (aa
= a
[Ssl::CertificateDb::cnlSerial
]; *aa
== '0'; ++aa
);
224 for (bb
= b
[Ssl::CertificateDb::cnlSerial
]; *bb
== '0'; ++bb
);
225 return strcmp(aa
, bb
);
228 unsigned long Ssl::CertificateDb::index_name_hash(const char **a
)
230 return(lh_strhash(a
[Ssl::CertificateDb::cnlName
]));
233 int Ssl::CertificateDb::index_name_cmp(const char **a
, const char **b
)
235 return(strcmp(a
[Ssl::CertificateDb::cnlName
], b
[CertificateDb::cnlName
]));
238 const std::string
Ssl::CertificateDb::db_file("index.txt");
239 const std::string
Ssl::CertificateDb::cert_dir("certs");
240 const std::string
Ssl::CertificateDb::size_file("size");
242 Ssl::CertificateDb::CertificateDb(std::string
const & aDb_path
, size_t aMax_db_size
, size_t aFs_block_size
)
244 db_full(aDb_path
+ "/" + db_file
),
245 cert_full(aDb_path
+ "/" + cert_dir
),
246 size_full(aDb_path
+ "/" + size_file
),
248 max_db_size(aMax_db_size
),
249 fs_block_size(aFs_block_size
),
251 enabled_disk_store(true)
253 if (db_path
.empty() && !max_db_size
)
254 enabled_disk_store
= false;
255 else if ((db_path
.empty() && max_db_size
) || (!db_path
.empty() && !max_db_size
))
256 throw std::runtime_error("ssl_crtd is missing the required parameter. There should be -s and -M parameters together.");
259 bool Ssl::CertificateDb::find(std::string
const & host_name
, Ssl::X509_Pointer
& cert
, Ssl::EVP_PKEY_Pointer
& pkey
)
261 const Locker
locker(dbLock
, Here
);
263 return pure_find(host_name
, cert
, pkey
);
266 bool Ssl::CertificateDb::purgeCert(std::string
const & key
)
268 const Locker
locker(dbLock
, Here
);
273 if (!deleteByHostname(key
))
280 bool Ssl::CertificateDb::addCertAndPrivateKey(Ssl::X509_Pointer
& cert
, Ssl::EVP_PKEY_Pointer
& pkey
, std::string
const & useName
)
282 const Locker
locker(dbLock
, Here
);
284 if (!db
|| !cert
|| !pkey
)
287 ASN1_INTEGER
* ai
= X509_get_serialNumber(cert
.get());
288 std::string serial_string
;
289 Ssl::BIGNUM_Pointer
serial(ASN1_INTEGER_to_BN(ai
, NULL
));
291 TidyPointer
<char, tidyFree
> hex_bn(BN_bn2hex(serial
.get()));
292 serial_string
= std::string(hex_bn
.get());
294 row
.setValue(cnlSerial
, serial_string
.c_str());
295 char ** rrow
= TXT_DB_get_by_index(db
.get(), cnlSerial
, row
.getRow());
296 // We are creating certificates with unique serial numbers. If the serial
297 // number is found in the database, the same certificate is already stored.
299 // TODO: check if the stored row is valid.
304 TidyPointer
<char, tidyFree
> subject(X509_NAME_oneline(X509_get_subject_name(cert
.get()), NULL
, 0));
305 Ssl::X509_Pointer findCert
;
306 Ssl::EVP_PKEY_Pointer findPkey
;
307 if (pure_find(useName
.empty() ? subject
.get() : useName
, findCert
, findPkey
)) {
308 // Replace with database certificate
309 cert
.reset(findCert
.release());
310 pkey
.reset(findPkey
.release());
313 // pure_find may fail because the entry is expired, or because the
314 // certs file is corrupted. Remove any entry with given hostname
315 deleteByHostname(useName
.empty() ? subject
.get() : useName
);
318 // check db size while trying to minimize calls to size()
319 while (size() > max_db_size
) {
320 if (deleteInvalidCertificate())
321 continue; // try to find another invalid certificate if needed
323 // there are no more invalid ones, but there must be valid certificates
325 if (!deleteOldestCertificate()) {
326 save(); // Some entries may have been removed. Update the index file.
327 return false; // errors prevented us from freeing enough space
329 } while (size() > max_db_size
);
333 row
.setValue(cnlType
, "V");
334 ASN1_UTCTIME
* tm
= X509_get_notAfter(cert
.get());
335 row
.setValue(cnlExp_date
, std::string(reinterpret_cast<char *>(tm
->data
), tm
->length
).c_str());
336 row
.setValue(cnlFile
, "unknown");
337 if (!useName
.empty())
338 row
.setValue(cnlName
, useName
.c_str());
340 TidyPointer
<char, tidyFree
> subject(X509_NAME_oneline(X509_get_subject_name(cert
.get()), NULL
, 0));
341 row
.setValue(cnlName
, subject
.get());
344 if (!TXT_DB_insert(db
.get(), row
.getRow())) {
345 // failed to add index (???) but we may have already modified
346 // the database so save before exit
353 std::string
filename(cert_full
+ "/" + serial_string
+ ".pem");
354 if (!writeCertAndPrivateKeyToFile(cert
, pkey
, filename
.c_str())) {
355 //remove row from txt_db and save
356 sq_TXT_DB_delete(db
.get(), (const char **)rrow
);
366 void Ssl::CertificateDb::create(std::string
const & db_path
)
369 throw std::runtime_error("Path to db is empty");
370 std::string
db_full(db_path
+ "/" + db_file
);
371 std::string
cert_full(db_path
+ "/" + cert_dir
);
372 std::string
size_full(db_path
+ "/" + size_file
);
374 if (mkdir(db_path
.c_str(), 0777))
375 throw std::runtime_error("Cannot create " + db_path
);
377 if (mkdir(cert_full
.c_str(), 0777))
378 throw std::runtime_error("Cannot create " + cert_full
);
380 std::ofstream
size(size_full
.c_str());
384 throw std::runtime_error("Cannot open " + size_full
+ " to open");
385 std::ofstream
db(db_full
.c_str());
387 throw std::runtime_error("Cannot open " + db_full
+ " to open");
390 void Ssl::CertificateDb::check(std::string
const & db_path
, size_t max_db_size
)
392 CertificateDb
db(db_path
, max_db_size
, 0);
396 bool Ssl::CertificateDb::pure_find(std::string
const & host_name
, Ssl::X509_Pointer
& cert
, Ssl::EVP_PKEY_Pointer
& pkey
)
402 row
.setValue(cnlName
, host_name
.c_str());
404 char **rrow
= TXT_DB_get_by_index(db
.get(), cnlName
, row
.getRow());
408 if (!sslDateIsInTheFuture(rrow
[cnlExp_date
]))
411 // read cert and pkey from file.
412 std::string
filename(cert_full
+ "/" + rrow
[cnlSerial
] + ".pem");
413 readCertAndPrivateKeyFromFiles(cert
, pkey
, filename
.c_str(), NULL
);
419 size_t Ssl::CertificateDb::size() const
424 void Ssl::CertificateDb::addSize(std::string
const & filename
)
426 writeSize(readSize() + getFileSize(filename
));
429 void Ssl::CertificateDb::subSize(std::string
const & filename
)
431 writeSize(readSize() - getFileSize(filename
));
434 size_t Ssl::CertificateDb::readSize() const
436 std::ifstream
ifstr(size_full
.c_str());
437 if (!ifstr
&& enabled_disk_store
)
438 throw std::runtime_error("cannot open for reading: " + size_full
);
440 if (!(ifstr
>> db_size
))
441 throw std::runtime_error("error while reading " + size_full
);
445 void Ssl::CertificateDb::writeSize(size_t db_size
)
447 std::ofstream
ofstr(size_full
.c_str());
448 if (!ofstr
&& enabled_disk_store
)
449 throw std::runtime_error("cannot write \"" + size_full
+ "\" file");
453 size_t Ssl::CertificateDb::getFileSize(std::string
const & filename
)
455 std::ifstream
file(filename
.c_str(), std::ios::binary
);
456 file
.seekg(0, std::ios_base::end
);
457 size_t file_size
= file
.tellg();
458 return ((file_size
+ fs_block_size
- 1) / fs_block_size
) * fs_block_size
;
461 void Ssl::CertificateDb::load()
463 // Load db from file.
464 Ssl::BIO_Pointer
in(BIO_new(BIO_s_file()));
465 if (!in
|| BIO_read_filename(in
.get(), db_full
.c_str()) <= 0)
466 throw std::runtime_error("Uninitialized SSL certificate database directory: " + db_path
+ ". To initialize, run \"ssl_crtd -c -s " + db_path
+ "\".");
468 bool corrupt
= false;
469 Ssl::TXT_DB_Pointer
temp_db(TXT_DB_read(in
.get(), cnlNumber
));
473 // Create indexes in db.
474 if (!corrupt
&& !TXT_DB_create_index(temp_db
.get(), cnlSerial
, NULL
, LHASH_HASH_FN(index_serial_hash
), LHASH_COMP_FN(index_serial_cmp
)))
477 if (!corrupt
&& !TXT_DB_create_index(temp_db
.get(), cnlName
, NULL
, LHASH_HASH_FN(index_name_hash
), LHASH_COMP_FN(index_name_cmp
)))
481 throw std::runtime_error("The SSL certificate database " + db_path
+ " is corrupted. Please rebuild");
483 db
.reset(temp_db
.release());
486 void Ssl::CertificateDb::save()
489 throw std::runtime_error("The certificates database is not loaded");;
491 // To save the db to file, create a new BIO with BIO file methods.
492 Ssl::BIO_Pointer
out(BIO_new(BIO_s_file()));
493 if (!out
|| !BIO_write_filename(out
.get(), const_cast<char *>(db_full
.c_str())))
494 throw std::runtime_error("Failed to initialize " + db_full
+ " file for writing");;
496 if (TXT_DB_write(out
.get(), db
.get()) < 0)
497 throw std::runtime_error("Failed to write " + db_full
+ " file");
500 // Normally defined in defines.h file
501 void Ssl::CertificateDb::deleteRow(const char **row
, int rowIndex
)
503 const std::string
filename(cert_full
+ "/" + row
[cnlSerial
] + ".pem");
504 sq_TXT_DB_delete_row(db
.get(), rowIndex
);
507 int ret
= remove(filename
.c_str());
508 if (ret
< 0 && errno
!= ENOENT
)
509 throw std::runtime_error("Failed to remove certficate file " + filename
+ " from db");
512 bool Ssl::CertificateDb::deleteInvalidCertificate()
517 bool removed_one
= false;
518 #if SQUID_SSLTXTDB_PSTRINGDATA
519 for (int i
= 0; i
< sk_OPENSSL_PSTRING_num(db
.get()->data
); ++i
) {
520 const char ** current_row
= ((const char **)sk_OPENSSL_PSTRING_value(db
.get()->data
, i
));
522 for (int i
= 0; i
< sk_num(db
.get()->data
); ++i
) {
523 const char ** current_row
= ((const char **)sk_value(db
.get()->data
, i
));
526 if (!sslDateIsInTheFuture(current_row
[cnlExp_date
])) {
527 deleteRow(current_row
, i
);
538 bool Ssl::CertificateDb::deleteOldestCertificate()
543 #if SQUID_SSLTXTDB_PSTRINGDATA
544 if (sk_OPENSSL_PSTRING_num(db
.get()->data
) == 0)
546 if (sk_num(db
.get()->data
) == 0)
550 #if SQUID_SSLTXTDB_PSTRINGDATA
551 const char **row
= (const char **)sk_OPENSSL_PSTRING_value(db
.get()->data
, 0);
553 const char **row
= (const char **)sk_value(db
.get()->data
, 0);
561 bool Ssl::CertificateDb::deleteByHostname(std::string
const & host
)
566 #if SQUID_SSLTXTDB_PSTRINGDATA
567 for (int i
= 0; i
< sk_OPENSSL_PSTRING_num(db
.get()->data
); ++i
) {
568 const char ** current_row
= ((const char **)sk_OPENSSL_PSTRING_value(db
.get()->data
, i
));
570 for (int i
= 0; i
< sk_num(db
.get()->data
); ++i
) {
571 const char ** current_row
= ((const char **)sk_value(db
.get()->data
, i
));
573 if (host
== current_row
[cnlName
]) {
574 deleteRow(current_row
, i
);
581 bool Ssl::CertificateDb::IsEnabledDiskStore() const
583 return enabled_disk_store
;