2 #include "ssl/gadgets.h"
3 #if HAVE_OPENSSL_X509V3_H
4 #include <openssl/x509v3.h>
7 EVP_PKEY
* Ssl::createSslPrivateKey()
9 Ssl::EVP_PKEY_Pointer
pkey(EVP_PKEY_new());
14 Ssl::RSA_Pointer
rsa(RSA_generate_key(1024, RSA_F4
, NULL
, NULL
));
19 if (!EVP_PKEY_assign_RSA(pkey
.get(), (rsa
.get())))
23 return pkey
.release();
27 \ingroup ServerProtocolSSLInternal
28 * Set serial random serial number or set random serial number.
30 static bool setSerialNumber(ASN1_INTEGER
*ai
, BIGNUM
const* serial
)
34 Ssl::BIGNUM_Pointer
bn(BN_new());
36 bn
.reset(BN_dup(serial
));
41 if (!BN_pseudo_rand(bn
.get(), 64, 0, 0))
45 if (ai
&& !BN_to_ASN1_INTEGER(bn
.get(), ai
))
50 bool Ssl::writeCertAndPrivateKeyToMemory(Ssl::X509_Pointer
const & cert
, Ssl::EVP_PKEY_Pointer
const & pkey
, std::string
& bufferToWrite
)
52 bufferToWrite
.clear();
55 BIO_Pointer
bio(BIO_new(BIO_s_mem()));
59 if (!PEM_write_bio_X509 (bio
.get(), cert
.get()))
62 if (!PEM_write_bio_PrivateKey(bio
.get(), pkey
.get(), NULL
, NULL
, 0, NULL
, NULL
))
66 long len
= BIO_get_mem_data(bio
.get(), &ptr
);
70 bufferToWrite
= std::string(ptr
, len
);
74 bool Ssl::appendCertToMemory(Ssl::X509_Pointer
const & cert
, std::string
& bufferToWrite
)
79 BIO_Pointer
bio(BIO_new(BIO_s_mem()));
83 if (!PEM_write_bio_X509 (bio
.get(), cert
.get()))
87 long len
= BIO_get_mem_data(bio
.get(), &ptr
);
91 if (!bufferToWrite
.empty())
92 bufferToWrite
.append(" "); // add a space...
94 bufferToWrite
.append(ptr
, len
);
98 bool Ssl::writeCertAndPrivateKeyToFile(Ssl::X509_Pointer
const & cert
, Ssl::EVP_PKEY_Pointer
const & pkey
, char const * filename
)
103 Ssl::BIO_Pointer
bio(BIO_new(BIO_s_file_internal()));
106 if (!BIO_write_filename(bio
.get(), const_cast<char *>(filename
)))
109 if (!PEM_write_bio_X509(bio
.get(), cert
.get()))
112 if (!PEM_write_bio_PrivateKey(bio
.get(), pkey
.get(), NULL
, NULL
, 0, NULL
, NULL
))
118 bool Ssl::readCertAndPrivateKeyFromMemory(Ssl::X509_Pointer
& cert
, Ssl::EVP_PKEY_Pointer
& pkey
, char const * bufferToRead
)
120 Ssl::BIO_Pointer
bio(BIO_new(BIO_s_mem()));
121 BIO_puts(bio
.get(), bufferToRead
);
123 X509
* certPtr
= NULL
;
124 cert
.reset(PEM_read_bio_X509(bio
.get(), &certPtr
, 0, 0));
128 EVP_PKEY
* pkeyPtr
= NULL
;
129 pkey
.reset(PEM_read_bio_PrivateKey(bio
.get(), &pkeyPtr
, 0, 0));
136 bool Ssl::readCertFromMemory(X509_Pointer
& cert
, char const * bufferToRead
)
138 Ssl::BIO_Pointer
bio(BIO_new(BIO_s_mem()));
139 BIO_puts(bio
.get(), bufferToRead
);
141 X509
* certPtr
= NULL
;
142 cert
.reset(PEM_read_bio_X509(bio
.get(), &certPtr
, 0, 0));
149 // According to RFC 5280 (Section A.1), the common name length in a certificate
150 // can be at most 64 characters
151 static const size_t MaxCnLen
= 64;
153 // Replace certs common name with the given
154 static bool replaceCommonName(Ssl::X509_Pointer
& cert
, std::string
const &rawCn
)
156 std::string cn
= rawCn
;
158 if (cn
.length() > MaxCnLen
) {
159 // In the case the length od CN is more than the maximum supported size
160 // try to use the first upper level domain.
163 pos
= cn
.find('.', pos
+ 1);
164 } while (pos
!= std::string::npos
&& (cn
.length() - pos
+ 2) > MaxCnLen
);
166 // If no short domain found or this domain is a toplevel domain
167 // we failed to find a good cn name.
168 if (pos
== std::string::npos
|| cn
.find('.', pos
+ 1) == std::string::npos
)
171 std::string
fixedCn(1, '*');
172 fixedCn
.append(cn
.c_str() + pos
);
176 // Assume [] surround an IPv6 address and strip them because browsers such
177 // as Firefox, Chromium, and Safari prefer bare IPv6 addresses in CNs.
178 if (cn
.length() > 2 && *cn
.begin() == '[' && *cn
.rbegin() == ']')
179 cn
= cn
.substr(1, cn
.size()-2);
181 X509_NAME
*name
= X509_get_subject_name(cert
.get());
184 // Remove the CN part:
185 int loc
= X509_NAME_get_index_by_NID(name
, NID_commonName
, -1);
187 X509_NAME_ENTRY
*tmp
= X509_NAME_get_entry(name
, loc
);
188 X509_NAME_delete_entry(name
, loc
);
189 X509_NAME_ENTRY_free(tmp
);
193 return X509_NAME_add_entry_by_NID(name
, NID_commonName
, MBSTRING_ASC
,
194 (unsigned char *)(cn
.c_str()), -1, -1, 0);
197 const char *Ssl::CertSignAlgorithmStr
[] = {
204 const char *Ssl::CertAdaptAlgorithmStr
[] = {
211 Ssl::CertificateProperties::CertificateProperties():
212 setValidAfter(false),
213 setValidBefore(false),
214 setCommonName(false),
215 signAlgorithm(Ssl::algSignEnd
)
218 std::string
& Ssl::CertificateProperties::dbKey() const
220 static std::string certKey
;
222 certKey
.reserve(4096);
223 if (mimicCert
.get()) {
225 certKey
.append(X509_NAME_oneline(X509_get_subject_name(mimicCert
.get()), buf
, sizeof(buf
)));
228 if (certKey
.empty()) {
229 certKey
.append("/CN=", 4);
230 certKey
.append(commonName
);
234 certKey
.append("+SetValidAfter=on", 17);
237 certKey
.append("+SetValidBefore=on", 18);
240 certKey
.append("+SetCommonName=", 15);
241 certKey
.append(commonName
);
244 if (signAlgorithm
!= Ssl::algSignEnd
) {
245 certKey
.append("+Sign=", 6);
246 certKey
.append(certSignAlgorithm(signAlgorithm
));
252 static bool buildCertificate(Ssl::X509_Pointer
& cert
, Ssl::CertificateProperties
const &properties
)
254 // not an Ssl::X509_NAME_Pointer because X509_REQ_get_subject_name()
255 // returns a pointer to the existing subject name. Nothing to clean here.
256 if (properties
.mimicCert
.get()) {
257 // Leave subject empty if we cannot extract it from true cert.
258 if (X509_NAME
*name
= X509_get_subject_name(properties
.mimicCert
.get())) {
259 // X509_set_subject_name will call X509_dup for name
260 X509_set_subject_name(cert
.get(), name
);
264 if (properties
.setCommonName
|| !properties
.mimicCert
.get()) {
265 // In this case the CN of the certificate given by the user
266 // Ignore errors: it is better to make a certificate with no CN
267 // than to quit ssl_crtd because we cannot make a certificate.
268 // Most errors are caused by user input such as huge domain names.
269 (void)replaceCommonName(cert
, properties
.commonName
);
272 // We should get caCert notBefore and notAfter fields and do not allow
273 // notBefore/notAfter values from certToMimic before/after notBefore/notAfter
274 // fields from caCert.
275 // Currently there is not any way in openssl tollkit to compare two ASN1_TIME
277 ASN1_TIME
*aTime
= NULL
;
278 if (!properties
.setValidBefore
&& properties
.mimicCert
.get())
279 aTime
= X509_get_notBefore(properties
.mimicCert
.get());
280 if (!aTime
&& properties
.signWithX509
.get())
281 aTime
= X509_get_notBefore(properties
.signWithX509
.get());
284 if (!X509_set_notBefore(cert
.get(), aTime
))
286 } else if (!X509_gmtime_adj(X509_get_notBefore(cert
.get()), (-2)*24*60*60))
290 if (!properties
.setValidAfter
&& properties
.mimicCert
.get())
291 aTime
= X509_get_notAfter(properties
.mimicCert
.get());
292 if (!aTime
&& properties
.signWithX509
.get())
293 aTime
= X509_get_notAfter(properties
.signWithX509
.get());
295 if (!X509_set_notAfter(cert
.get(), aTime
))
297 } else if (!X509_gmtime_adj(X509_get_notAfter(cert
.get()), 60*60*24*356*3))
300 // mimic the alias and possibly subjectAltName
301 if (properties
.mimicCert
.get()) {
302 unsigned char *alStr
;
304 alStr
= X509_alias_get0(properties
.mimicCert
.get(), &alLen
);
306 X509_alias_set1(cert
.get(), alStr
, alLen
);
309 // Mimic subjectAltName unless we used a configured CN: browsers reject
310 // certificates with CN unrelated to subjectAltNames.
311 if (!properties
.setCommonName
) {
312 int pos
=X509_get_ext_by_NID (properties
.mimicCert
.get(), OBJ_sn2nid("subjectAltName"), -1);
313 X509_EXTENSION
*ext
=X509_get_ext(properties
.mimicCert
.get(), pos
);
315 X509_add_ext(cert
.get(), ext
, -1);
316 /* According the RFC 5280 using extensions requires version 3
318 Set version value to 2 for version 3 certificates.
320 X509_set_version(cert
.get(), 2);
328 static bool generateFakeSslCertificate(Ssl::X509_Pointer
& certToStore
, Ssl::EVP_PKEY_Pointer
& pkeyToStore
, Ssl::CertificateProperties
const &properties
, Ssl::BIGNUM_Pointer
const &serial
)
330 Ssl::EVP_PKEY_Pointer pkey
;
331 // Use signing certificates private key as generated certificate private key
332 if (properties
.signWithPkey
.get())
333 pkey
.resetAndLock(properties
.signWithPkey
.get());
334 else // if not exist generate one
335 pkey
.reset(Ssl::createSslPrivateKey());
340 Ssl::X509_Pointer
cert(X509_new());
344 // Set pub key and serial given by the caller
345 if (!X509_set_pubkey(cert
.get(), pkey
.get()))
347 if (!setSerialNumber(X509_get_serialNumber(cert
.get()), serial
.get()))
350 // Fill the certificate with the required properties
351 if (!buildCertificate(cert
, properties
))
355 // Set issuer name, from CA or our subject name for self signed cert
356 if (properties
.signAlgorithm
!= Ssl::algSignSelf
&& properties
.signWithX509
.get())
357 ret
= X509_set_issuer_name(cert
.get(), X509_get_subject_name(properties
.signWithX509
.get()));
358 else // Self signed certificate, set issuer to self
359 ret
= X509_set_issuer_name(cert
.get(), X509_get_subject_name(cert
.get()));
363 /*Now sign the request */
364 if (properties
.signAlgorithm
!= Ssl::algSignSelf
&& properties
.signWithPkey
.get())
365 ret
= X509_sign(cert
.get(), properties
.signWithPkey
.get(), EVP_sha1());
366 else //else sign with self key (self signed request)
367 ret
= X509_sign(cert
.get(), pkey
.get(), EVP_sha1());
372 certToStore
.reset(cert
.release());
373 pkeyToStore
.reset(pkey
.release());
377 static BIGNUM
*createCertSerial(unsigned char *md
, unsigned int n
)
380 assert(n
== 20); //for sha1 n is 20 (for md5 n is 16)
382 BIGNUM
*serial
= NULL
;
383 serial
= BN_bin2bn(md
, n
, NULL
);
385 // if the serial is "0" set it to '1'
386 if (BN_is_zero(serial
))
389 // serial size does not exceed 20 bytes
390 assert(BN_num_bits(serial
) <= 160);
392 // According the RFC 5280, serial is an 20 bytes ASN.1 INTEGER (a signed big integer)
393 // and the maximum value for X.509 certificate serial number is 2^159-1 and
394 // the minimum 0. If the first bit of the serial is '1' ( eg 2^160-1),
395 // will result to a negative integer.
396 // To handle this, if the produced serial is greater than 2^159-1
397 // truncate the last bit
398 if (BN_is_bit_set(serial
, 159))
399 BN_clear_bit(serial
, 159);
404 /// Return the SHA1 digest of the DER encoded version of the certificate
405 /// stored in a BIGNUM
406 static BIGNUM
*x509Digest(Ssl::X509_Pointer
const & cert
)
409 unsigned char md
[EVP_MAX_MD_SIZE
];
411 if (!X509_digest(cert
.get(),EVP_sha1(),md
,&n
))
414 return createCertSerial(md
, n
);
417 static BIGNUM
*x509Pubkeydigest(Ssl::X509_Pointer
const & cert
)
420 unsigned char md
[EVP_MAX_MD_SIZE
];
422 if (!X509_pubkey_digest(cert
.get(),EVP_sha1(),md
,&n
))
425 return createCertSerial(md
, n
);
428 /// Generate a unique serial number based on a Ssl::CertificateProperties object
429 /// for a new generated certificate
430 static bool createSerial(Ssl::BIGNUM_Pointer
&serial
, Ssl::CertificateProperties
const &properties
)
432 Ssl::EVP_PKEY_Pointer fakePkey
;
433 Ssl::X509_Pointer fakeCert
;
435 serial
.reset(x509Pubkeydigest(properties
.signWithX509
));
437 serial
.reset(BN_new());
438 BN_zero(serial
.get());
441 if (!generateFakeSslCertificate(fakeCert
, fakePkey
, properties
, serial
))
444 // The x509Fingerprint return an SHA1 hash.
445 // both SHA1 hash and maximum serial number size are 20 bytes.
446 BIGNUM
*r
= x509Digest(fakeCert
);
454 bool Ssl::generateSslCertificate(Ssl::X509_Pointer
& certToStore
, Ssl::EVP_PKEY_Pointer
& pkeyToStore
, Ssl::CertificateProperties
const &properties
)
456 Ssl::BIGNUM_Pointer serial
;
458 if (!createSerial(serial
, properties
))
461 return generateFakeSslCertificate(certToStore
, pkeyToStore
, properties
, serial
);
465 \ingroup ServerProtocolSSLInternal
466 * Read certificate from file.
468 static X509
* readSslX509Certificate(char const * certFilename
)
472 Ssl::BIO_Pointer
bio(BIO_new(BIO_s_file_internal()));
475 if (!BIO_read_filename(bio
.get(), certFilename
))
477 X509
*certificate
= PEM_read_bio_X509(bio
.get(), NULL
, NULL
, NULL
);
481 EVP_PKEY
* Ssl::readSslPrivateKey(char const * keyFilename
, pem_password_cb
*passwd_callback
)
485 Ssl::BIO_Pointer
bio(BIO_new(BIO_s_file_internal()));
488 if (!BIO_read_filename(bio
.get(), keyFilename
))
490 EVP_PKEY
*pkey
= PEM_read_bio_PrivateKey(bio
.get(), NULL
, passwd_callback
, NULL
);
494 void Ssl::readCertAndPrivateKeyFromFiles(Ssl::X509_Pointer
& cert
, Ssl::EVP_PKEY_Pointer
& pkey
, char const * certFilename
, char const * keyFilename
)
496 if (keyFilename
== NULL
)
497 keyFilename
= certFilename
;
498 pkey
.reset(readSslPrivateKey(keyFilename
));
499 cert
.reset(readSslX509Certificate(certFilename
));
500 if (!pkey
|| !cert
|| !X509_check_private_key(cert
.get(), pkey
.get())) {
506 bool Ssl::sslDateIsInTheFuture(char const * date
)
511 tm
.data
= (unsigned char *)date
;
512 tm
.length
= strlen(date
);
514 return (X509_cmp_current_time(&tm
) > 0);
517 /// Print the time represented by a ASN1_TIME struct to a string using GeneralizedTime format
518 static bool asn1timeToGeneralizedTimeStr(ASN1_TIME
*aTime
, char *buf
, int bufLen
)
520 // ASN1_Time holds time to UTCTime or GeneralizedTime form.
521 // UTCTime has the form YYMMDDHHMMSS[Z | [+|-]offset]
522 // GeneralizedTime has the form YYYYMMDDHHMMSS[Z | [+|-] offset]
524 // length should have space for data plus 2 extra bytes for the two extra year fields
525 // plus the '\0' char.
526 if ((aTime
->length
+ 3) > bufLen
)
530 if (aTime
->type
== V_ASN1_UTCTIME
) {
531 if (aTime
->data
[0] > '5') { // RFC 2459, section 4.1.2.5.1
539 } else // if (aTime->type == V_ASN1_GENERALIZEDTIME)
542 memcpy(str
, aTime
->data
, aTime
->length
);
543 str
[aTime
->length
] = '\0';
547 static int asn1time_cmp(ASN1_TIME
*asnTime1
, ASN1_TIME
*asnTime2
)
549 char strTime1
[64], strTime2
[64];
550 if (!asn1timeToGeneralizedTimeStr(asnTime1
, strTime1
, sizeof(strTime1
)))
552 if (!asn1timeToGeneralizedTimeStr(asnTime2
, strTime2
, sizeof(strTime2
)))
555 return strcmp(strTime1
, strTime2
);
558 bool Ssl::certificateMatchesProperties(X509
*cert
, CertificateProperties
const &properties
)
562 // For non self-signed certificates we have to check if the signing certificate changed
563 if (properties
.signAlgorithm
!= Ssl::algSignSelf
) {
564 assert(properties
.signWithX509
.get());
565 if (X509_check_issued(properties
.signWithX509
.get(), cert
) != X509_V_OK
)
569 X509
*cert2
= properties
.mimicCert
.get();
570 // If there is not certificate to mimic stop here
574 if (!properties
.setCommonName
) {
575 X509_NAME
*cert1_name
= X509_get_subject_name(cert
);
576 X509_NAME
*cert2_name
= X509_get_subject_name(cert2
);
577 if (X509_NAME_cmp(cert1_name
, cert2_name
) != 0)
579 } else if (properties
.commonName
!= CommonHostName(cert
))
582 if (!properties
.setValidBefore
) {
583 ASN1_TIME
*aTime
= X509_get_notBefore(cert
);
584 ASN1_TIME
*bTime
= X509_get_notBefore(cert2
);
585 if (asn1time_cmp(aTime
, bTime
) != 0)
587 } else if (X509_cmp_current_time(X509_get_notBefore(cert
)) >= 0) {
588 // notBefore does not exist (=0) or it is in the future (>0)
592 if (!properties
.setValidAfter
) {
593 ASN1_TIME
*aTime
= X509_get_notAfter(cert
);
594 ASN1_TIME
*bTime
= X509_get_notAfter(cert2
);
595 if (asn1time_cmp(aTime
, bTime
) != 0)
597 } else if (X509_cmp_current_time(X509_get_notAfter(cert
)) <= 0) {
598 // notAfter does not exist (0) or it is in the past (<0)
604 alStr1
= (char *)X509_alias_get0(cert
, &alLen
);
605 char *alStr2
= (char *)X509_alias_get0(cert2
, &alLen
);
606 if ((!alStr1
&& alStr2
) || (alStr1
&& !alStr2
) ||
607 (alStr1
&& alStr2
&& strcmp(alStr1
, alStr2
)) != 0)
610 // Compare subjectAltName extension
611 STACK_OF(GENERAL_NAME
) * cert1_altnames
;
612 cert1_altnames
= (STACK_OF(GENERAL_NAME
)*)X509_get_ext_d2i(cert
, NID_subject_alt_name
, NULL
, NULL
);
613 STACK_OF(GENERAL_NAME
) * cert2_altnames
;
614 cert2_altnames
= (STACK_OF(GENERAL_NAME
)*)X509_get_ext_d2i(cert2
, NID_subject_alt_name
, NULL
, NULL
);
616 if (cert1_altnames
) {
617 int numalts
= sk_GENERAL_NAME_num(cert1_altnames
);
618 for (int i
= 0; match
&& i
< numalts
; ++i
) {
619 const GENERAL_NAME
*aName
= sk_GENERAL_NAME_value(cert1_altnames
, i
);
620 match
= sk_GENERAL_NAME_find(cert2_altnames
, aName
);
622 } else if (cert2_altnames
)
625 sk_GENERAL_NAME_pop_free(cert1_altnames
, GENERAL_NAME_free
);
626 sk_GENERAL_NAME_pop_free(cert2_altnames
, GENERAL_NAME_free
);
631 static const char *getSubjectEntry(X509
*x509
, int nid
)
633 static char name
[1024] = ""; // stores common name (CN)
638 // TODO: What if the entry is a UTF8String? See X509_NAME_get_index_by_NID(3ssl).
639 const int nameLen
= X509_NAME_get_text_by_NID(
640 X509_get_subject_name(x509
),
641 nid
, name
, sizeof(name
));
649 const char *Ssl::CommonHostName(X509
*x509
)
651 return getSubjectEntry(x509
, NID_commonName
);
654 const char *Ssl::getOrganization(X509
*x509
)
656 return getSubjectEntry(x509
, NID_organizationName
);