2 * SSL/TLS interface functions for OpenSSL
3 * Copyright (c) 2004-2013, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
11 #ifndef CONFIG_SMARTCARD
12 #ifndef OPENSSL_NO_ENGINE
13 #define OPENSSL_NO_ENGINE
17 #include <openssl/ssl.h>
18 #include <openssl/err.h>
19 #include <openssl/pkcs12.h>
20 #include <openssl/x509v3.h>
21 #ifndef OPENSSL_NO_ENGINE
22 #include <openssl/engine.h>
23 #endif /* OPENSSL_NO_ENGINE */
26 #include <openssl/pem.h>
27 #include "keystore_get.h"
34 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
35 #define OPENSSL_d2i_TYPE const unsigned char **
37 #define OPENSSL_d2i_TYPE unsigned char **
40 #if defined(SSL_CTX_get_app_data) && defined(SSL_CTX_set_app_data)
41 #define OPENSSL_SUPPORTS_CTX_APP_DATA
44 #ifdef SSL_F_SSL_SET_SESSION_TICKET_EXT
45 #ifdef SSL_OP_NO_TICKET
47 * Session ticket override patch was merged into OpenSSL 0.9.9 tree on
48 * 2008-11-15. This version uses a bit different API compared to the old patch.
50 #define CONFIG_OPENSSL_TICKET_OVERRIDE
54 #ifdef SSL_set_tlsext_status_type
55 #ifndef OPENSSL_NO_TLSEXT
57 #include <openssl/ocsp.h>
58 #endif /* OPENSSL_NO_TLSEXT */
59 #endif /* SSL_set_tlsext_status_type */
61 static int tls_openssl_ref_count = 0;
64 void (*event_cb)(void *ctx, enum tls_event ev,
65 union tls_event_data *data);
68 char *ocsp_stapling_response;
71 static struct tls_context *tls_global = NULL;
74 struct tls_connection {
75 struct tls_context *context;
77 BIO *ssl_in, *ssl_out;
78 #ifndef OPENSSL_NO_ENGINE
79 ENGINE *engine; /* functional reference to the engine */
80 EVP_PKEY *private_key; /* the private key if using engine */
81 #endif /* OPENSSL_NO_ENGINE */
82 char *subject_match, *altsubject_match;
83 int read_alerts, write_alerts, failed;
85 tls_session_ticket_cb session_ticket_cb;
86 void *session_ticket_cb_ctx;
88 /* SessionTicket received from OpenSSL hello_extension_cb (server) */
90 size_t session_ticket_len;
92 unsigned int ca_cert_verify:1;
93 unsigned int cert_probe:1;
94 unsigned int server_cert_only:1;
105 static struct tls_context * tls_context_new(const struct tls_config *conf)
107 struct tls_context *context = os_zalloc(sizeof(*context));
111 context->event_cb = conf->event_cb;
112 context->cb_ctx = conf->cb_ctx;
113 context->cert_in_cb = conf->cert_in_cb;
119 #ifdef CONFIG_NO_STDOUT_DEBUG
121 static void _tls_show_errors(void)
125 while ((err = ERR_get_error())) {
126 /* Just ignore the errors, since stdout is disabled */
129 #define tls_show_errors(l, f, t) _tls_show_errors()
131 #else /* CONFIG_NO_STDOUT_DEBUG */
133 static void tls_show_errors(int level, const char *func, const char *txt)
137 wpa_printf(level, "OpenSSL: %s - %s %s",
138 func, txt, ERR_error_string(ERR_get_error(), NULL));
140 while ((err = ERR_get_error())) {
141 wpa_printf(MSG_INFO, "OpenSSL: pending error: %s",
142 ERR_error_string(err, NULL));
146 #endif /* CONFIG_NO_STDOUT_DEBUG */
149 #ifdef CONFIG_NATIVE_WINDOWS
151 /* Windows CryptoAPI and access to certificate stores */
152 #include <wincrypt.h>
154 #ifdef __MINGW32_VERSION
156 * MinGW does not yet include all the needed definitions for CryptoAPI, so
157 * define here whatever extra is needed.
159 #define CERT_SYSTEM_STORE_CURRENT_USER (1 << 16)
160 #define CERT_STORE_READONLY_FLAG 0x00008000
161 #define CERT_STORE_OPEN_EXISTING_FLAG 0x00004000
163 #endif /* __MINGW32_VERSION */
166 struct cryptoapi_rsa_data {
167 const CERT_CONTEXT *cert;
168 HCRYPTPROV crypt_prov;
170 BOOL free_crypt_prov;
174 static void cryptoapi_error(const char *msg)
176 wpa_printf(MSG_INFO, "CryptoAPI: %s; err=%u",
177 msg, (unsigned int) GetLastError());
181 static int cryptoapi_rsa_pub_enc(int flen, const unsigned char *from,
182 unsigned char *to, RSA *rsa, int padding)
184 wpa_printf(MSG_DEBUG, "%s - not implemented", __func__);
189 static int cryptoapi_rsa_pub_dec(int flen, const unsigned char *from,
190 unsigned char *to, RSA *rsa, int padding)
192 wpa_printf(MSG_DEBUG, "%s - not implemented", __func__);
197 static int cryptoapi_rsa_priv_enc(int flen, const unsigned char *from,
198 unsigned char *to, RSA *rsa, int padding)
200 struct cryptoapi_rsa_data *priv =
201 (struct cryptoapi_rsa_data *) rsa->meth->app_data;
203 DWORD hash_size, len, i;
204 unsigned char *buf = NULL;
208 RSAerr(RSA_F_RSA_EAY_PRIVATE_ENCRYPT,
209 ERR_R_PASSED_NULL_PARAMETER);
213 if (padding != RSA_PKCS1_PADDING) {
214 RSAerr(RSA_F_RSA_EAY_PRIVATE_ENCRYPT,
215 RSA_R_UNKNOWN_PADDING_TYPE);
219 if (flen != 16 /* MD5 */ + 20 /* SHA-1 */) {
220 wpa_printf(MSG_INFO, "%s - only MD5-SHA1 hash supported",
222 RSAerr(RSA_F_RSA_EAY_PRIVATE_ENCRYPT,
223 RSA_R_INVALID_MESSAGE_LENGTH);
227 if (!CryptCreateHash(priv->crypt_prov, CALG_SSL3_SHAMD5, 0, 0, &hash))
229 cryptoapi_error("CryptCreateHash failed");
233 len = sizeof(hash_size);
234 if (!CryptGetHashParam(hash, HP_HASHSIZE, (BYTE *) &hash_size, &len,
236 cryptoapi_error("CryptGetHashParam failed");
240 if ((int) hash_size != flen) {
241 wpa_printf(MSG_INFO, "CryptoAPI: Invalid hash size (%u != %d)",
242 (unsigned) hash_size, flen);
243 RSAerr(RSA_F_RSA_EAY_PRIVATE_ENCRYPT,
244 RSA_R_INVALID_MESSAGE_LENGTH);
247 if (!CryptSetHashParam(hash, HP_HASHVAL, (BYTE * ) from, 0)) {
248 cryptoapi_error("CryptSetHashParam failed");
253 buf = os_malloc(len);
255 RSAerr(RSA_F_RSA_EAY_PRIVATE_ENCRYPT, ERR_R_MALLOC_FAILURE);
259 if (!CryptSignHash(hash, priv->key_spec, NULL, 0, buf, &len)) {
260 cryptoapi_error("CryptSignHash failed");
264 for (i = 0; i < len; i++)
265 to[i] = buf[len - i - 1];
270 CryptDestroyHash(hash);
276 static int cryptoapi_rsa_priv_dec(int flen, const unsigned char *from,
277 unsigned char *to, RSA *rsa, int padding)
279 wpa_printf(MSG_DEBUG, "%s - not implemented", __func__);
284 static void cryptoapi_free_data(struct cryptoapi_rsa_data *priv)
288 if (priv->crypt_prov && priv->free_crypt_prov)
289 CryptReleaseContext(priv->crypt_prov, 0);
291 CertFreeCertificateContext(priv->cert);
296 static int cryptoapi_finish(RSA *rsa)
298 cryptoapi_free_data((struct cryptoapi_rsa_data *) rsa->meth->app_data);
299 os_free((void *) rsa->meth);
305 static const CERT_CONTEXT * cryptoapi_find_cert(const char *name, DWORD store)
308 const CERT_CONTEXT *ret = NULL;
310 cs = CertOpenStore((LPCSTR) CERT_STORE_PROV_SYSTEM, 0, 0,
311 store | CERT_STORE_OPEN_EXISTING_FLAG |
312 CERT_STORE_READONLY_FLAG, L"MY");
314 cryptoapi_error("Failed to open 'My system store'");
318 if (strncmp(name, "cert://", 7) == 0) {
319 unsigned short wbuf[255];
320 MultiByteToWideChar(CP_ACP, 0, name + 7, -1, wbuf, 255);
321 ret = CertFindCertificateInStore(cs, X509_ASN_ENCODING |
323 0, CERT_FIND_SUBJECT_STR,
325 } else if (strncmp(name, "hash://", 7) == 0) {
326 CRYPT_HASH_BLOB blob;
328 const char *hash = name + 7;
331 len = os_strlen(hash) / 2;
332 buf = os_malloc(len);
333 if (buf && hexstr2bin(hash, buf, len) == 0) {
336 ret = CertFindCertificateInStore(cs,
345 CertCloseStore(cs, 0);
351 static int tls_cryptoapi_cert(SSL *ssl, const char *name)
354 RSA *rsa = NULL, *pub_rsa;
355 struct cryptoapi_rsa_data *priv;
356 RSA_METHOD *rsa_meth;
359 (strncmp(name, "cert://", 7) != 0 &&
360 strncmp(name, "hash://", 7) != 0))
363 priv = os_zalloc(sizeof(*priv));
364 rsa_meth = os_zalloc(sizeof(*rsa_meth));
365 if (priv == NULL || rsa_meth == NULL) {
366 wpa_printf(MSG_WARNING, "CryptoAPI: Failed to allocate memory "
367 "for CryptoAPI RSA method");
373 priv->cert = cryptoapi_find_cert(name, CERT_SYSTEM_STORE_CURRENT_USER);
374 if (priv->cert == NULL) {
375 priv->cert = cryptoapi_find_cert(
376 name, CERT_SYSTEM_STORE_LOCAL_MACHINE);
378 if (priv->cert == NULL) {
379 wpa_printf(MSG_INFO, "CryptoAPI: Could not find certificate "
384 cert = d2i_X509(NULL, (OPENSSL_d2i_TYPE) &priv->cert->pbCertEncoded,
385 priv->cert->cbCertEncoded);
387 wpa_printf(MSG_INFO, "CryptoAPI: Could not process X509 DER "
392 if (!CryptAcquireCertificatePrivateKey(priv->cert,
393 CRYPT_ACQUIRE_COMPARE_KEY_FLAG,
394 NULL, &priv->crypt_prov,
396 &priv->free_crypt_prov)) {
397 cryptoapi_error("Failed to acquire a private key for the "
402 rsa_meth->name = "Microsoft CryptoAPI RSA Method";
403 rsa_meth->rsa_pub_enc = cryptoapi_rsa_pub_enc;
404 rsa_meth->rsa_pub_dec = cryptoapi_rsa_pub_dec;
405 rsa_meth->rsa_priv_enc = cryptoapi_rsa_priv_enc;
406 rsa_meth->rsa_priv_dec = cryptoapi_rsa_priv_dec;
407 rsa_meth->finish = cryptoapi_finish;
408 rsa_meth->flags = RSA_METHOD_FLAG_NO_CHECK;
409 rsa_meth->app_data = (char *) priv;
413 SSLerr(SSL_F_SSL_CTX_USE_CERTIFICATE_FILE,
414 ERR_R_MALLOC_FAILURE);
418 if (!SSL_use_certificate(ssl, cert)) {
423 pub_rsa = cert->cert_info->key->pkey->pkey.rsa;
427 rsa->n = BN_dup(pub_rsa->n);
428 rsa->e = BN_dup(pub_rsa->e);
429 if (!RSA_set_method(rsa, rsa_meth))
432 if (!SSL_use_RSAPrivateKey(ssl, rsa))
445 cryptoapi_free_data(priv);
451 static int tls_cryptoapi_ca_cert(SSL_CTX *ssl_ctx, SSL *ssl, const char *name)
454 PCCERT_CONTEXT ctx = NULL;
462 if (name == NULL || strncmp(name, "cert_store://", 13) != 0)
467 wstore = os_malloc((os_strlen(store) + 1) * sizeof(WCHAR));
470 wsprintf(wstore, L"%S", store);
471 cs = CertOpenSystemStore(0, wstore);
474 cs = CertOpenSystemStore(0, store);
477 wpa_printf(MSG_DEBUG, "%s: failed to open system cert store "
478 "'%s': error=%d", __func__, store,
479 (int) GetLastError());
483 while ((ctx = CertEnumCertificatesInStore(cs, ctx))) {
484 cert = d2i_X509(NULL, (OPENSSL_d2i_TYPE) &ctx->pbCertEncoded,
487 wpa_printf(MSG_INFO, "CryptoAPI: Could not process "
488 "X509 DER encoding for CA cert");
492 X509_NAME_oneline(X509_get_subject_name(cert), buf,
494 wpa_printf(MSG_DEBUG, "OpenSSL: Loaded CA certificate for "
495 "system certificate store: subject='%s'", buf);
497 if (!X509_STORE_add_cert(ssl_ctx->cert_store, cert)) {
498 tls_show_errors(MSG_WARNING, __func__,
499 "Failed to add ca_cert to OpenSSL "
500 "certificate store");
506 if (!CertCloseStore(cs, 0)) {
507 wpa_printf(MSG_DEBUG, "%s: failed to close system cert store "
508 "'%s': error=%d", __func__, name + 13,
509 (int) GetLastError());
516 #else /* CONFIG_NATIVE_WINDOWS */
518 static int tls_cryptoapi_cert(SSL *ssl, const char *name)
523 #endif /* CONFIG_NATIVE_WINDOWS */
526 static void ssl_info_cb(const SSL *ssl, int where, int ret)
531 wpa_printf(MSG_DEBUG, "SSL: (where=0x%x ret=0x%x)", where, ret);
532 w = where & ~SSL_ST_MASK;
533 if (w & SSL_ST_CONNECT)
535 else if (w & SSL_ST_ACCEPT)
540 if (where & SSL_CB_LOOP) {
541 wpa_printf(MSG_DEBUG, "SSL: %s:%s",
542 str, SSL_state_string_long(ssl));
543 } else if (where & SSL_CB_ALERT) {
544 struct tls_connection *conn = SSL_get_app_data((SSL *) ssl);
545 wpa_printf(MSG_INFO, "SSL: SSL3 alert: %s:%s:%s",
546 where & SSL_CB_READ ?
547 "read (remote end reported an error)" :
548 "write (local SSL3 detected an error)",
549 SSL_alert_type_string_long(ret),
550 SSL_alert_desc_string_long(ret));
551 if ((ret >> 8) == SSL3_AL_FATAL) {
552 if (where & SSL_CB_READ)
555 conn->write_alerts++;
557 if (conn->context->event_cb != NULL) {
558 union tls_event_data ev;
559 struct tls_context *context = conn->context;
560 os_memset(&ev, 0, sizeof(ev));
561 ev.alert.is_local = !(where & SSL_CB_READ);
562 ev.alert.type = SSL_alert_type_string_long(ret);
563 ev.alert.description = SSL_alert_desc_string_long(ret);
564 context->event_cb(context->cb_ctx, TLS_ALERT, &ev);
566 } else if (where & SSL_CB_EXIT && ret <= 0) {
567 wpa_printf(MSG_DEBUG, "SSL: %s:%s in %s",
568 str, ret == 0 ? "failed" : "error",
569 SSL_state_string_long(ssl));
574 #ifndef OPENSSL_NO_ENGINE
576 * tls_engine_load_dynamic_generic - load any openssl engine
577 * @pre: an array of commands and values that load an engine initialized
578 * in the engine specific function
579 * @post: an array of commands and values that initialize an already loaded
580 * engine (or %NULL if not required)
581 * @id: the engine id of the engine to load (only required if post is not %NULL
583 * This function is a generic function that loads any openssl engine.
585 * Returns: 0 on success, -1 on failure
587 static int tls_engine_load_dynamic_generic(const char *pre[],
588 const char *post[], const char *id)
591 const char *dynamic_id = "dynamic";
593 engine = ENGINE_by_id(id);
596 wpa_printf(MSG_DEBUG, "ENGINE: engine '%s' is already "
602 engine = ENGINE_by_id(dynamic_id);
603 if (engine == NULL) {
604 wpa_printf(MSG_INFO, "ENGINE: Can't find engine %s [%s]",
606 ERR_error_string(ERR_get_error(), NULL));
610 /* Perform the pre commands. This will load the engine. */
611 while (pre && pre[0]) {
612 wpa_printf(MSG_DEBUG, "ENGINE: '%s' '%s'", pre[0], pre[1]);
613 if (ENGINE_ctrl_cmd_string(engine, pre[0], pre[1], 0) == 0) {
614 wpa_printf(MSG_INFO, "ENGINE: ctrl cmd_string failed: "
615 "%s %s [%s]", pre[0], pre[1],
616 ERR_error_string(ERR_get_error(), NULL));
624 * Free the reference to the "dynamic" engine. The loaded engine can
625 * now be looked up using ENGINE_by_id().
629 engine = ENGINE_by_id(id);
630 if (engine == NULL) {
631 wpa_printf(MSG_INFO, "ENGINE: Can't find engine %s [%s]",
632 id, ERR_error_string(ERR_get_error(), NULL));
636 while (post && post[0]) {
637 wpa_printf(MSG_DEBUG, "ENGINE: '%s' '%s'", post[0], post[1]);
638 if (ENGINE_ctrl_cmd_string(engine, post[0], post[1], 0) == 0) {
639 wpa_printf(MSG_DEBUG, "ENGINE: ctrl cmd_string failed:"
640 " %s %s [%s]", post[0], post[1],
641 ERR_error_string(ERR_get_error(), NULL));
642 ENGINE_remove(engine);
655 * tls_engine_load_dynamic_pkcs11 - load the pkcs11 engine provided by opensc
656 * @pkcs11_so_path: pksc11_so_path from the configuration
657 * @pcks11_module_path: pkcs11_module_path from the configuration
659 static int tls_engine_load_dynamic_pkcs11(const char *pkcs11_so_path,
660 const char *pkcs11_module_path)
662 char *engine_id = "pkcs11";
663 const char *pre_cmd[] = {
664 "SO_PATH", NULL /* pkcs11_so_path */,
665 "ID", NULL /* engine_id */,
667 /* "NO_VCHECK", "1", */
671 const char *post_cmd[] = {
672 "MODULE_PATH", NULL /* pkcs11_module_path */,
676 if (!pkcs11_so_path || !pkcs11_module_path)
679 pre_cmd[1] = pkcs11_so_path;
680 pre_cmd[3] = engine_id;
681 post_cmd[1] = pkcs11_module_path;
683 wpa_printf(MSG_DEBUG, "ENGINE: Loading pkcs11 Engine from %s",
686 return tls_engine_load_dynamic_generic(pre_cmd, post_cmd, engine_id);
691 * tls_engine_load_dynamic_opensc - load the opensc engine provided by opensc
692 * @opensc_so_path: opensc_so_path from the configuration
694 static int tls_engine_load_dynamic_opensc(const char *opensc_so_path)
696 char *engine_id = "opensc";
697 const char *pre_cmd[] = {
698 "SO_PATH", NULL /* opensc_so_path */,
699 "ID", NULL /* engine_id */,
708 pre_cmd[1] = opensc_so_path;
709 pre_cmd[3] = engine_id;
711 wpa_printf(MSG_DEBUG, "ENGINE: Loading OpenSC Engine from %s",
714 return tls_engine_load_dynamic_generic(pre_cmd, NULL, engine_id);
716 #endif /* OPENSSL_NO_ENGINE */
719 void * tls_init(const struct tls_config *conf)
722 struct tls_context *context;
724 if (tls_openssl_ref_count == 0) {
725 tls_global = context = tls_context_new(conf);
730 if (conf && conf->fips_mode) {
731 if (!FIPS_mode_set(1)) {
732 wpa_printf(MSG_ERROR, "Failed to enable FIPS "
734 ERR_load_crypto_strings();
735 ERR_print_errors_fp(stderr);
740 wpa_printf(MSG_INFO, "Running in FIPS mode");
742 #else /* OPENSSL_FIPS */
743 if (conf && conf->fips_mode) {
744 wpa_printf(MSG_ERROR, "FIPS mode requested, but not "
750 #endif /* OPENSSL_FIPS */
751 #endif /* CONFIG_FIPS */
752 SSL_load_error_strings();
754 #if (OPENSSL_VERSION_NUMBER >= 0x0090800fL) && !defined(OPENSSL_NO_SHA256)
755 EVP_add_digest(EVP_sha256());
756 #endif /* OPENSSL_NO_SHA256 */
757 /* TODO: if /dev/urandom is available, PRNG is seeded
758 * automatically. If this is not the case, random data should
762 #ifndef OPENSSL_NO_RC2
764 * 40-bit RC2 is commonly used in PKCS#12 files, so enable it.
765 * This is enabled by PKCS12_PBE_add() in OpenSSL 0.9.8
766 * versions, but it looks like OpenSSL 1.0.0 does not do that
769 EVP_add_cipher(EVP_rc2_40_cbc());
770 #endif /* OPENSSL_NO_RC2 */
772 #endif /* PKCS12_FUNCS */
774 context = tls_global;
775 #ifdef OPENSSL_SUPPORTS_CTX_APP_DATA
776 /* Newer OpenSSL can store app-data per-SSL */
777 context = tls_context_new(conf);
780 #endif /* OPENSSL_SUPPORTS_CTX_APP_DATA */
782 tls_openssl_ref_count++;
784 ssl = SSL_CTX_new(TLSv1_method());
786 tls_openssl_ref_count--;
787 if (tls_openssl_ref_count == 0) {
790 } else if (context != tls_global) {
796 SSL_CTX_set_info_callback(ssl, ssl_info_cb);
797 #ifdef OPENSSL_SUPPORTS_CTX_APP_DATA
798 SSL_CTX_set_app_data(ssl, context);
799 #endif /* OPENSSL_SUPPORTS_CTX_APP_DATA */
801 #ifndef OPENSSL_NO_ENGINE
803 (conf->opensc_engine_path || conf->pkcs11_engine_path ||
804 conf->pkcs11_module_path)) {
805 wpa_printf(MSG_DEBUG, "ENGINE: Loading dynamic engine");
806 ERR_load_ENGINE_strings();
807 ENGINE_load_dynamic();
809 if (tls_engine_load_dynamic_opensc(conf->opensc_engine_path) ||
810 tls_engine_load_dynamic_pkcs11(conf->pkcs11_engine_path,
811 conf->pkcs11_module_path)) {
816 #endif /* OPENSSL_NO_ENGINE */
822 void tls_deinit(void *ssl_ctx)
824 SSL_CTX *ssl = ssl_ctx;
825 #ifdef OPENSSL_SUPPORTS_CTX_APP_DATA
826 struct tls_context *context = SSL_CTX_get_app_data(ssl);
827 if (context != tls_global)
829 #endif /* OPENSSL_SUPPORTS_CTX_APP_DATA */
832 tls_openssl_ref_count--;
833 if (tls_openssl_ref_count == 0) {
834 #ifndef OPENSSL_NO_ENGINE
836 #endif /* OPENSSL_NO_ENGINE */
837 CRYPTO_cleanup_all_ex_data();
841 os_free(tls_global->ocsp_stapling_response);
842 tls_global->ocsp_stapling_response = NULL;
849 static int tls_engine_init(struct tls_connection *conn, const char *engine_id,
850 const char *pin, const char *key_id,
851 const char *cert_id, const char *ca_cert_id)
853 #ifndef OPENSSL_NO_ENGINE
855 if (engine_id == NULL) {
856 wpa_printf(MSG_ERROR, "ENGINE: Engine ID not set");
860 wpa_printf(MSG_ERROR, "ENGINE: Smartcard PIN not set");
863 if (key_id == NULL) {
864 wpa_printf(MSG_ERROR, "ENGINE: Key Id not set");
869 conn->engine = ENGINE_by_id(engine_id);
871 wpa_printf(MSG_ERROR, "ENGINE: engine %s not available [%s]",
872 engine_id, ERR_error_string(ERR_get_error(), NULL));
875 if (ENGINE_init(conn->engine) != 1) {
876 wpa_printf(MSG_ERROR, "ENGINE: engine init failed "
877 "(engine: %s) [%s]", engine_id,
878 ERR_error_string(ERR_get_error(), NULL));
881 wpa_printf(MSG_DEBUG, "ENGINE: engine initialized");
883 if (ENGINE_ctrl_cmd_string(conn->engine, "PIN", pin, 0) == 0) {
884 wpa_printf(MSG_ERROR, "ENGINE: cannot set pin [%s]",
885 ERR_error_string(ERR_get_error(), NULL));
888 /* load private key first in-case PIN is required for cert */
889 conn->private_key = ENGINE_load_private_key(conn->engine,
891 if (!conn->private_key) {
892 wpa_printf(MSG_ERROR, "ENGINE: cannot load private key with id"
893 " '%s' [%s]", key_id,
894 ERR_error_string(ERR_get_error(), NULL));
895 ret = TLS_SET_PARAMS_ENGINE_PRV_INIT_FAILED;
899 /* handle a certificate and/or CA certificate */
900 if (cert_id || ca_cert_id) {
901 const char *cmd_name = "LOAD_CERT_CTRL";
903 /* test if the engine supports a LOAD_CERT_CTRL */
904 if (!ENGINE_ctrl(conn->engine, ENGINE_CTRL_GET_CMD_FROM_NAME,
905 0, (void *)cmd_name, NULL)) {
906 wpa_printf(MSG_ERROR, "ENGINE: engine does not support"
907 " loading certificates");
908 ret = TLS_SET_PARAMS_ENGINE_PRV_INIT_FAILED;
917 ENGINE_free(conn->engine);
921 if (conn->private_key) {
922 EVP_PKEY_free(conn->private_key);
923 conn->private_key = NULL;
927 #else /* OPENSSL_NO_ENGINE */
929 #endif /* OPENSSL_NO_ENGINE */
933 static void tls_engine_deinit(struct tls_connection *conn)
935 #ifndef OPENSSL_NO_ENGINE
936 wpa_printf(MSG_DEBUG, "ENGINE: engine deinit");
937 if (conn->private_key) {
938 EVP_PKEY_free(conn->private_key);
939 conn->private_key = NULL;
942 ENGINE_finish(conn->engine);
945 #endif /* OPENSSL_NO_ENGINE */
949 int tls_get_errors(void *ssl_ctx)
954 while ((err = ERR_get_error())) {
955 wpa_printf(MSG_INFO, "TLS - SSL error: %s",
956 ERR_error_string(err, NULL));
963 struct tls_connection * tls_connection_init(void *ssl_ctx)
965 SSL_CTX *ssl = ssl_ctx;
966 struct tls_connection *conn;
968 struct tls_context *context = tls_global;
969 #ifdef OPENSSL_SUPPORTS_CTX_APP_DATA
970 context = SSL_CTX_get_app_data(ssl);
971 #endif /* OPENSSL_SUPPORTS_CTX_APP_DATA */
973 conn = os_zalloc(sizeof(*conn));
976 conn->ssl = SSL_new(ssl);
977 if (conn->ssl == NULL) {
978 tls_show_errors(MSG_INFO, __func__,
979 "Failed to initialize new SSL connection");
984 conn->context = context;
985 SSL_set_app_data(conn->ssl, conn);
986 options = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 |
987 SSL_OP_SINGLE_DH_USE;
988 #ifdef SSL_OP_NO_COMPRESSION
989 options |= SSL_OP_NO_COMPRESSION;
990 #endif /* SSL_OP_NO_COMPRESSION */
991 SSL_set_options(conn->ssl, options);
993 conn->ssl_in = BIO_new(BIO_s_mem());
995 tls_show_errors(MSG_INFO, __func__,
996 "Failed to create a new BIO for ssl_in");
1002 conn->ssl_out = BIO_new(BIO_s_mem());
1003 if (!conn->ssl_out) {
1004 tls_show_errors(MSG_INFO, __func__,
1005 "Failed to create a new BIO for ssl_out");
1006 SSL_free(conn->ssl);
1007 BIO_free(conn->ssl_in);
1012 SSL_set_bio(conn->ssl, conn->ssl_in, conn->ssl_out);
1018 void tls_connection_deinit(void *ssl_ctx, struct tls_connection *conn)
1022 SSL_free(conn->ssl);
1023 tls_engine_deinit(conn);
1024 os_free(conn->subject_match);
1025 os_free(conn->altsubject_match);
1026 os_free(conn->session_ticket);
1031 int tls_connection_established(void *ssl_ctx, struct tls_connection *conn)
1033 return conn ? SSL_is_init_finished(conn->ssl) : 0;
1037 int tls_connection_shutdown(void *ssl_ctx, struct tls_connection *conn)
1042 /* Shutdown previous TLS connection without notifying the peer
1043 * because the connection was already terminated in practice
1044 * and "close notify" shutdown alert would confuse AS. */
1045 SSL_set_quiet_shutdown(conn->ssl, 1);
1046 SSL_shutdown(conn->ssl);
1051 static int tls_match_altsubject_component(X509 *cert, int type,
1052 const char *value, size_t len)
1058 ext = X509_get_ext_d2i(cert, NID_subject_alt_name, NULL, NULL);
1060 for (i = 0; ext && i < sk_GENERAL_NAME_num(ext); i++) {
1061 gen = sk_GENERAL_NAME_value(ext, i);
1062 if (gen->type != type)
1064 if (os_strlen((char *) gen->d.ia5->data) == len &&
1065 os_memcmp(value, gen->d.ia5->data, len) == 0)
1073 static int tls_match_altsubject(X509 *cert, const char *match)
1076 const char *pos, *end;
1081 if (os_strncmp(pos, "EMAIL:", 6) == 0) {
1084 } else if (os_strncmp(pos, "DNS:", 4) == 0) {
1087 } else if (os_strncmp(pos, "URI:", 4) == 0) {
1091 wpa_printf(MSG_INFO, "TLS: Invalid altSubjectName "
1095 end = os_strchr(pos, ';');
1097 if (os_strncmp(end + 1, "EMAIL:", 6) == 0 ||
1098 os_strncmp(end + 1, "DNS:", 4) == 0 ||
1099 os_strncmp(end + 1, "URI:", 4) == 0)
1101 end = os_strchr(end + 1, ';');
1106 len = os_strlen(pos);
1107 if (tls_match_altsubject_component(cert, type, pos, len) > 0)
1116 static enum tls_fail_reason openssl_tls_fail_reason(int err)
1119 case X509_V_ERR_CERT_REVOKED:
1120 return TLS_FAIL_REVOKED;
1121 case X509_V_ERR_CERT_NOT_YET_VALID:
1122 case X509_V_ERR_CRL_NOT_YET_VALID:
1123 return TLS_FAIL_NOT_YET_VALID;
1124 case X509_V_ERR_CERT_HAS_EXPIRED:
1125 case X509_V_ERR_CRL_HAS_EXPIRED:
1126 return TLS_FAIL_EXPIRED;
1127 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
1128 case X509_V_ERR_UNABLE_TO_GET_CRL:
1129 case X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER:
1130 case X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN:
1131 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY:
1132 case X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT:
1133 case X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE:
1134 case X509_V_ERR_CERT_CHAIN_TOO_LONG:
1135 case X509_V_ERR_PATH_LENGTH_EXCEEDED:
1136 case X509_V_ERR_INVALID_CA:
1137 return TLS_FAIL_UNTRUSTED;
1138 case X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE:
1139 case X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE:
1140 case X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY:
1141 case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
1142 case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
1143 case X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD:
1144 case X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD:
1145 case X509_V_ERR_CERT_UNTRUSTED:
1146 case X509_V_ERR_CERT_REJECTED:
1147 return TLS_FAIL_BAD_CERTIFICATE;
1149 return TLS_FAIL_UNSPECIFIED;
1154 static struct wpabuf * get_x509_cert(X509 *cert)
1159 int cert_len = i2d_X509(cert, NULL);
1163 buf = wpabuf_alloc(cert_len);
1167 tmp = wpabuf_put(buf, cert_len);
1168 i2d_X509(cert, &tmp);
1173 static void openssl_tls_fail_event(struct tls_connection *conn,
1174 X509 *err_cert, int err, int depth,
1175 const char *subject, const char *err_str,
1176 enum tls_fail_reason reason)
1178 union tls_event_data ev;
1179 struct wpabuf *cert = NULL;
1180 struct tls_context *context = conn->context;
1182 if (context->event_cb == NULL)
1185 cert = get_x509_cert(err_cert);
1186 os_memset(&ev, 0, sizeof(ev));
1187 ev.cert_fail.reason = reason != TLS_FAIL_UNSPECIFIED ?
1188 reason : openssl_tls_fail_reason(err);
1189 ev.cert_fail.depth = depth;
1190 ev.cert_fail.subject = subject;
1191 ev.cert_fail.reason_txt = err_str;
1192 ev.cert_fail.cert = cert;
1193 context->event_cb(context->cb_ctx, TLS_CERT_CHAIN_FAILURE, &ev);
1198 static void openssl_tls_cert_event(struct tls_connection *conn,
1199 X509 *err_cert, int depth,
1200 const char *subject)
1202 struct wpabuf *cert = NULL;
1203 union tls_event_data ev;
1204 struct tls_context *context = conn->context;
1205 #ifdef CONFIG_SHA256
1207 #endif /* CONFIG_SHA256 */
1209 if (context->event_cb == NULL)
1212 os_memset(&ev, 0, sizeof(ev));
1213 if (conn->cert_probe || context->cert_in_cb) {
1214 cert = get_x509_cert(err_cert);
1215 ev.peer_cert.cert = cert;
1217 #ifdef CONFIG_SHA256
1221 addr[0] = wpabuf_head(cert);
1222 len[0] = wpabuf_len(cert);
1223 if (sha256_vector(1, addr, len, hash) == 0) {
1224 ev.peer_cert.hash = hash;
1225 ev.peer_cert.hash_len = sizeof(hash);
1228 #endif /* CONFIG_SHA256 */
1229 ev.peer_cert.depth = depth;
1230 ev.peer_cert.subject = subject;
1231 context->event_cb(context->cb_ctx, TLS_PEER_CERTIFICATE, &ev);
1236 static int tls_verify_cb(int preverify_ok, X509_STORE_CTX *x509_ctx)
1242 struct tls_connection *conn;
1243 struct tls_context *context;
1244 char *match, *altmatch;
1245 const char *err_str;
1247 err_cert = X509_STORE_CTX_get_current_cert(x509_ctx);
1248 err = X509_STORE_CTX_get_error(x509_ctx);
1249 depth = X509_STORE_CTX_get_error_depth(x509_ctx);
1250 ssl = X509_STORE_CTX_get_ex_data(x509_ctx,
1251 SSL_get_ex_data_X509_STORE_CTX_idx());
1252 X509_NAME_oneline(X509_get_subject_name(err_cert), buf, sizeof(buf));
1254 conn = SSL_get_app_data(ssl);
1259 conn->peer_cert = err_cert;
1260 else if (depth == 1)
1261 conn->peer_issuer = err_cert;
1263 context = conn->context;
1264 match = conn->subject_match;
1265 altmatch = conn->altsubject_match;
1267 if (!preverify_ok && !conn->ca_cert_verify)
1269 if (!preverify_ok && depth > 0 && conn->server_cert_only)
1271 if (!preverify_ok && (conn->flags & TLS_CONN_DISABLE_TIME_CHECKS) &&
1272 (err == X509_V_ERR_CERT_HAS_EXPIRED ||
1273 err == X509_V_ERR_CERT_NOT_YET_VALID)) {
1274 wpa_printf(MSG_DEBUG, "OpenSSL: Ignore certificate validity "
1279 err_str = X509_verify_cert_error_string(err);
1281 #ifdef CONFIG_SHA256
1282 if (preverify_ok && depth == 0 && conn->server_cert_only) {
1283 struct wpabuf *cert;
1284 cert = get_x509_cert(err_cert);
1286 wpa_printf(MSG_DEBUG, "OpenSSL: Could not fetch "
1287 "server certificate data");
1293 addr[0] = wpabuf_head(cert);
1294 len[0] = wpabuf_len(cert);
1295 if (sha256_vector(1, addr, len, hash) < 0 ||
1296 os_memcmp(conn->srv_cert_hash, hash, 32) != 0) {
1297 err_str = "Server certificate mismatch";
1298 err = X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN;
1304 #endif /* CONFIG_SHA256 */
1306 if (!preverify_ok) {
1307 wpa_printf(MSG_WARNING, "TLS: Certificate verification failed,"
1308 " error %d (%s) depth %d for '%s'", err, err_str,
1310 openssl_tls_fail_event(conn, err_cert, err, depth, buf,
1311 err_str, TLS_FAIL_UNSPECIFIED);
1312 return preverify_ok;
1315 wpa_printf(MSG_DEBUG, "TLS: tls_verify_cb - preverify_ok=%d "
1316 "err=%d (%s) ca_cert_verify=%d depth=%d buf='%s'",
1317 preverify_ok, err, err_str,
1318 conn->ca_cert_verify, depth, buf);
1319 if (depth == 0 && match && os_strstr(buf, match) == NULL) {
1320 wpa_printf(MSG_WARNING, "TLS: Subject '%s' did not "
1321 "match with '%s'", buf, match);
1323 openssl_tls_fail_event(conn, err_cert, err, depth, buf,
1325 TLS_FAIL_SUBJECT_MISMATCH);
1326 } else if (depth == 0 && altmatch &&
1327 !tls_match_altsubject(err_cert, altmatch)) {
1328 wpa_printf(MSG_WARNING, "TLS: altSubjectName match "
1329 "'%s' not found", altmatch);
1331 openssl_tls_fail_event(conn, err_cert, err, depth, buf,
1332 "AltSubject mismatch",
1333 TLS_FAIL_ALTSUBJECT_MISMATCH);
1335 openssl_tls_cert_event(conn, err_cert, depth, buf);
1337 if (conn->cert_probe && preverify_ok && depth == 0) {
1338 wpa_printf(MSG_DEBUG, "OpenSSL: Reject server certificate "
1339 "on probe-only run");
1341 openssl_tls_fail_event(conn, err_cert, err, depth, buf,
1342 "Server certificate chain probe",
1343 TLS_FAIL_SERVER_CHAIN_PROBE);
1346 if (preverify_ok && context->event_cb != NULL)
1347 context->event_cb(context->cb_ctx,
1348 TLS_CERT_CHAIN_SUCCESS, NULL);
1350 return preverify_ok;
1354 #ifndef OPENSSL_NO_STDIO
1355 static int tls_load_ca_der(void *_ssl_ctx, const char *ca_cert)
1357 SSL_CTX *ssl_ctx = _ssl_ctx;
1358 X509_LOOKUP *lookup;
1361 lookup = X509_STORE_add_lookup(ssl_ctx->cert_store,
1362 X509_LOOKUP_file());
1363 if (lookup == NULL) {
1364 tls_show_errors(MSG_WARNING, __func__,
1365 "Failed add lookup for X509 store");
1369 if (!X509_LOOKUP_load_file(lookup, ca_cert, X509_FILETYPE_ASN1)) {
1370 unsigned long err = ERR_peek_error();
1371 tls_show_errors(MSG_WARNING, __func__,
1372 "Failed load CA in DER format");
1373 if (ERR_GET_LIB(err) == ERR_LIB_X509 &&
1374 ERR_GET_REASON(err) == X509_R_CERT_ALREADY_IN_HASH_TABLE) {
1375 wpa_printf(MSG_DEBUG, "OpenSSL: %s - ignoring "
1376 "cert already in hash table error",
1384 #endif /* OPENSSL_NO_STDIO */
1388 static BIO * BIO_from_keystore(const char *key)
1391 char value[KEYSTORE_MESSAGE_SIZE];
1392 int length = keystore_get(key, strlen(key), value);
1393 if (length != -1 && (bio = BIO_new(BIO_s_mem())) != NULL)
1394 BIO_write(bio, value, length);
1397 #endif /* ANDROID */
1400 static int tls_connection_ca_cert(void *_ssl_ctx, struct tls_connection *conn,
1401 const char *ca_cert, const u8 *ca_cert_blob,
1402 size_t ca_cert_blob_len, const char *ca_path)
1404 SSL_CTX *ssl_ctx = _ssl_ctx;
1407 * Remove previously configured trusted CA certificates before adding
1410 X509_STORE_free(ssl_ctx->cert_store);
1411 ssl_ctx->cert_store = X509_STORE_new();
1412 if (ssl_ctx->cert_store == NULL) {
1413 wpa_printf(MSG_DEBUG, "OpenSSL: %s - failed to allocate new "
1414 "certificate store", __func__);
1418 SSL_set_verify(conn->ssl, SSL_VERIFY_PEER, tls_verify_cb);
1419 conn->ca_cert_verify = 1;
1421 if (ca_cert && os_strncmp(ca_cert, "probe://", 8) == 0) {
1422 wpa_printf(MSG_DEBUG, "OpenSSL: Probe for server certificate "
1424 conn->cert_probe = 1;
1425 conn->ca_cert_verify = 0;
1429 if (ca_cert && os_strncmp(ca_cert, "hash://", 7) == 0) {
1430 #ifdef CONFIG_SHA256
1431 const char *pos = ca_cert + 7;
1432 if (os_strncmp(pos, "server/sha256/", 14) != 0) {
1433 wpa_printf(MSG_DEBUG, "OpenSSL: Unsupported ca_cert "
1434 "hash value '%s'", ca_cert);
1438 if (os_strlen(pos) != 32 * 2) {
1439 wpa_printf(MSG_DEBUG, "OpenSSL: Unexpected SHA256 "
1440 "hash length in ca_cert '%s'", ca_cert);
1443 if (hexstr2bin(pos, conn->srv_cert_hash, 32) < 0) {
1444 wpa_printf(MSG_DEBUG, "OpenSSL: Invalid SHA256 hash "
1445 "value in ca_cert '%s'", ca_cert);
1448 conn->server_cert_only = 1;
1449 wpa_printf(MSG_DEBUG, "OpenSSL: Checking only server "
1450 "certificate match");
1452 #else /* CONFIG_SHA256 */
1453 wpa_printf(MSG_INFO, "No SHA256 included in the build - "
1454 "cannot validate server certificate hash");
1456 #endif /* CONFIG_SHA256 */
1460 X509 *cert = d2i_X509(NULL, (OPENSSL_d2i_TYPE) &ca_cert_blob,
1463 tls_show_errors(MSG_WARNING, __func__,
1464 "Failed to parse ca_cert_blob");
1468 if (!X509_STORE_add_cert(ssl_ctx->cert_store, cert)) {
1469 unsigned long err = ERR_peek_error();
1470 tls_show_errors(MSG_WARNING, __func__,
1471 "Failed to add ca_cert_blob to "
1472 "certificate store");
1473 if (ERR_GET_LIB(err) == ERR_LIB_X509 &&
1474 ERR_GET_REASON(err) ==
1475 X509_R_CERT_ALREADY_IN_HASH_TABLE) {
1476 wpa_printf(MSG_DEBUG, "OpenSSL: %s - ignoring "
1477 "cert already in hash table error",
1485 wpa_printf(MSG_DEBUG, "OpenSSL: %s - added ca_cert_blob "
1486 "to certificate store", __func__);
1491 if (ca_cert && os_strncmp("keystore://", ca_cert, 11) == 0) {
1492 BIO *bio = BIO_from_keystore(&ca_cert[11]);
1493 STACK_OF(X509_INFO) *stack = NULL;
1497 stack = PEM_X509_INFO_read_bio(bio, NULL, NULL, NULL);
1503 for (i = 0; i < sk_X509_INFO_num(stack); ++i) {
1504 X509_INFO *info = sk_X509_INFO_value(stack, i);
1506 X509_STORE_add_cert(ssl_ctx->cert_store,
1510 X509_STORE_add_crl(ssl_ctx->cert_store,
1514 sk_X509_INFO_pop_free(stack, X509_INFO_free);
1515 SSL_set_verify(conn->ssl, SSL_VERIFY_PEER, tls_verify_cb);
1518 #endif /* ANDROID */
1520 #ifdef CONFIG_NATIVE_WINDOWS
1521 if (ca_cert && tls_cryptoapi_ca_cert(ssl_ctx, conn->ssl, ca_cert) ==
1523 wpa_printf(MSG_DEBUG, "OpenSSL: Added CA certificates from "
1524 "system certificate store");
1527 #endif /* CONFIG_NATIVE_WINDOWS */
1529 if (ca_cert || ca_path) {
1530 #ifndef OPENSSL_NO_STDIO
1531 if (SSL_CTX_load_verify_locations(ssl_ctx, ca_cert, ca_path) !=
1533 tls_show_errors(MSG_WARNING, __func__,
1534 "Failed to load root certificates");
1536 tls_load_ca_der(ssl_ctx, ca_cert) == 0) {
1537 wpa_printf(MSG_DEBUG, "OpenSSL: %s - loaded "
1538 "DER format CA certificate",
1543 wpa_printf(MSG_DEBUG, "TLS: Trusted root "
1544 "certificate(s) loaded");
1545 tls_get_errors(ssl_ctx);
1547 #else /* OPENSSL_NO_STDIO */
1548 wpa_printf(MSG_DEBUG, "OpenSSL: %s - OPENSSL_NO_STDIO",
1551 #endif /* OPENSSL_NO_STDIO */
1553 /* No ca_cert configured - do not try to verify server
1555 conn->ca_cert_verify = 0;
1562 static int tls_global_ca_cert(SSL_CTX *ssl_ctx, const char *ca_cert)
1565 if (SSL_CTX_load_verify_locations(ssl_ctx, ca_cert, NULL) != 1)
1567 tls_show_errors(MSG_WARNING, __func__,
1568 "Failed to load root certificates");
1572 wpa_printf(MSG_DEBUG, "TLS: Trusted root "
1573 "certificate(s) loaded");
1575 #ifndef OPENSSL_NO_STDIO
1576 /* Add the same CAs to the client certificate requests */
1577 SSL_CTX_set_client_CA_list(ssl_ctx,
1578 SSL_load_client_CA_file(ca_cert));
1579 #endif /* OPENSSL_NO_STDIO */
1586 int tls_global_set_verify(void *ssl_ctx, int check_crl)
1591 X509_STORE *cs = SSL_CTX_get_cert_store(ssl_ctx);
1593 tls_show_errors(MSG_INFO, __func__, "Failed to get "
1594 "certificate store when enabling "
1598 flags = X509_V_FLAG_CRL_CHECK;
1600 flags |= X509_V_FLAG_CRL_CHECK_ALL;
1601 X509_STORE_set_flags(cs, flags);
1607 static int tls_connection_set_subject_match(struct tls_connection *conn,
1608 const char *subject_match,
1609 const char *altsubject_match)
1611 os_free(conn->subject_match);
1612 conn->subject_match = NULL;
1613 if (subject_match) {
1614 conn->subject_match = os_strdup(subject_match);
1615 if (conn->subject_match == NULL)
1619 os_free(conn->altsubject_match);
1620 conn->altsubject_match = NULL;
1621 if (altsubject_match) {
1622 conn->altsubject_match = os_strdup(altsubject_match);
1623 if (conn->altsubject_match == NULL)
1631 int tls_connection_set_verify(void *ssl_ctx, struct tls_connection *conn,
1634 static int counter = 0;
1640 conn->ca_cert_verify = 1;
1641 SSL_set_verify(conn->ssl, SSL_VERIFY_PEER |
1642 SSL_VERIFY_FAIL_IF_NO_PEER_CERT |
1643 SSL_VERIFY_CLIENT_ONCE, tls_verify_cb);
1645 conn->ca_cert_verify = 0;
1646 SSL_set_verify(conn->ssl, SSL_VERIFY_NONE, NULL);
1649 SSL_set_accept_state(conn->ssl);
1652 * Set session id context in order to avoid fatal errors when client
1653 * tries to resume a session. However, set the context to a unique
1654 * value in order to effectively disable session resumption for now
1655 * since not all areas of the server code are ready for it (e.g.,
1656 * EAP-TTLS needs special handling for Phase 2 after abbreviated TLS
1660 SSL_set_session_id_context(conn->ssl,
1661 (const unsigned char *) &counter,
1668 static int tls_connection_client_cert(struct tls_connection *conn,
1669 const char *client_cert,
1670 const u8 *client_cert_blob,
1671 size_t client_cert_blob_len)
1673 if (client_cert == NULL && client_cert_blob == NULL)
1676 if (client_cert_blob &&
1677 SSL_use_certificate_ASN1(conn->ssl, (u8 *) client_cert_blob,
1678 client_cert_blob_len) == 1) {
1679 wpa_printf(MSG_DEBUG, "OpenSSL: SSL_use_certificate_ASN1 --> "
1682 } else if (client_cert_blob) {
1683 tls_show_errors(MSG_DEBUG, __func__,
1684 "SSL_use_certificate_ASN1 failed");
1687 if (client_cert == NULL)
1691 if (os_strncmp("keystore://", client_cert, 11) == 0) {
1692 BIO *bio = BIO_from_keystore(&client_cert[11]);
1696 x509 = PEM_read_bio_X509(bio, NULL, NULL, NULL);
1700 if (SSL_use_certificate(conn->ssl, x509) == 1)
1706 #endif /* ANDROID */
1708 #ifndef OPENSSL_NO_STDIO
1709 if (SSL_use_certificate_file(conn->ssl, client_cert,
1710 SSL_FILETYPE_ASN1) == 1) {
1711 wpa_printf(MSG_DEBUG, "OpenSSL: SSL_use_certificate_file (DER)"
1716 if (SSL_use_certificate_file(conn->ssl, client_cert,
1717 SSL_FILETYPE_PEM) == 1) {
1719 wpa_printf(MSG_DEBUG, "OpenSSL: SSL_use_certificate_file (PEM)"
1724 tls_show_errors(MSG_DEBUG, __func__,
1725 "SSL_use_certificate_file failed");
1726 #else /* OPENSSL_NO_STDIO */
1727 wpa_printf(MSG_DEBUG, "OpenSSL: %s - OPENSSL_NO_STDIO", __func__);
1728 #endif /* OPENSSL_NO_STDIO */
1734 static int tls_global_client_cert(SSL_CTX *ssl_ctx, const char *client_cert)
1736 #ifndef OPENSSL_NO_STDIO
1737 if (client_cert == NULL)
1740 if (SSL_CTX_use_certificate_file(ssl_ctx, client_cert,
1741 SSL_FILETYPE_ASN1) != 1 &&
1742 SSL_CTX_use_certificate_chain_file(ssl_ctx, client_cert) != 1 &&
1743 SSL_CTX_use_certificate_file(ssl_ctx, client_cert,
1744 SSL_FILETYPE_PEM) != 1) {
1745 tls_show_errors(MSG_INFO, __func__,
1746 "Failed to load client certificate");
1750 #else /* OPENSSL_NO_STDIO */
1751 if (client_cert == NULL)
1753 wpa_printf(MSG_DEBUG, "OpenSSL: %s - OPENSSL_NO_STDIO", __func__);
1755 #endif /* OPENSSL_NO_STDIO */
1759 static int tls_passwd_cb(char *buf, int size, int rwflag, void *password)
1761 if (password == NULL) {
1764 os_strlcpy(buf, (char *) password, size);
1765 return os_strlen(buf);
1770 static int tls_parse_pkcs12(SSL_CTX *ssl_ctx, SSL *ssl, PKCS12 *p12,
1775 STACK_OF(X509) *certs;
1782 if (!PKCS12_parse(p12, passwd, &pkey, &cert, &certs)) {
1783 tls_show_errors(MSG_DEBUG, __func__,
1784 "Failed to parse PKCS12 file");
1788 wpa_printf(MSG_DEBUG, "TLS: Successfully parsed PKCS12 data");
1791 X509_NAME_oneline(X509_get_subject_name(cert), buf,
1793 wpa_printf(MSG_DEBUG, "TLS: Got certificate from PKCS12: "
1794 "subject='%s'", buf);
1796 if (SSL_use_certificate(ssl, cert) != 1)
1799 if (SSL_CTX_use_certificate(ssl_ctx, cert) != 1)
1806 wpa_printf(MSG_DEBUG, "TLS: Got private key from PKCS12");
1808 if (SSL_use_PrivateKey(ssl, pkey) != 1)
1811 if (SSL_CTX_use_PrivateKey(ssl_ctx, pkey) != 1)
1814 EVP_PKEY_free(pkey);
1818 while ((cert = sk_X509_pop(certs)) != NULL) {
1819 X509_NAME_oneline(X509_get_subject_name(cert), buf,
1821 wpa_printf(MSG_DEBUG, "TLS: additional certificate"
1822 " from PKCS12: subject='%s'", buf);
1824 * There is no SSL equivalent for the chain cert - so
1825 * always add it to the context...
1827 if (SSL_CTX_add_extra_chain_cert(ssl_ctx, cert) != 1) {
1832 sk_X509_free(certs);
1838 tls_get_errors(ssl_ctx);
1842 #endif /* PKCS12_FUNCS */
1845 static int tls_read_pkcs12(SSL_CTX *ssl_ctx, SSL *ssl, const char *private_key,
1852 f = fopen(private_key, "rb");
1856 p12 = d2i_PKCS12_fp(f, NULL);
1860 tls_show_errors(MSG_INFO, __func__,
1861 "Failed to use PKCS#12 file");
1865 return tls_parse_pkcs12(ssl_ctx, ssl, p12, passwd);
1867 #else /* PKCS12_FUNCS */
1868 wpa_printf(MSG_INFO, "TLS: PKCS12 support disabled - cannot read "
1871 #endif /* PKCS12_FUNCS */
1875 static int tls_read_pkcs12_blob(SSL_CTX *ssl_ctx, SSL *ssl,
1876 const u8 *blob, size_t len, const char *passwd)
1881 p12 = d2i_PKCS12(NULL, (OPENSSL_d2i_TYPE) &blob, len);
1883 tls_show_errors(MSG_INFO, __func__,
1884 "Failed to use PKCS#12 blob");
1888 return tls_parse_pkcs12(ssl_ctx, ssl, p12, passwd);
1890 #else /* PKCS12_FUNCS */
1891 wpa_printf(MSG_INFO, "TLS: PKCS12 support disabled - cannot parse "
1894 #endif /* PKCS12_FUNCS */
1898 #ifndef OPENSSL_NO_ENGINE
1899 static int tls_engine_get_cert(struct tls_connection *conn,
1900 const char *cert_id,
1903 /* this runs after the private key is loaded so no PIN is required */
1905 const char *cert_id;
1908 params.cert_id = cert_id;
1911 if (!ENGINE_ctrl_cmd(conn->engine, "LOAD_CERT_CTRL",
1912 0, ¶ms, NULL, 1)) {
1913 wpa_printf(MSG_ERROR, "ENGINE: cannot load client cert with id"
1914 " '%s' [%s]", cert_id,
1915 ERR_error_string(ERR_get_error(), NULL));
1916 return TLS_SET_PARAMS_ENGINE_PRV_INIT_FAILED;
1919 wpa_printf(MSG_ERROR, "ENGINE: did not properly cert with id"
1921 return TLS_SET_PARAMS_ENGINE_PRV_INIT_FAILED;
1923 *cert = params.cert;
1926 #endif /* OPENSSL_NO_ENGINE */
1929 static int tls_connection_engine_client_cert(struct tls_connection *conn,
1930 const char *cert_id)
1932 #ifndef OPENSSL_NO_ENGINE
1935 if (tls_engine_get_cert(conn, cert_id, &cert))
1938 if (!SSL_use_certificate(conn->ssl, cert)) {
1939 tls_show_errors(MSG_ERROR, __func__,
1940 "SSL_use_certificate failed");
1945 wpa_printf(MSG_DEBUG, "ENGINE: SSL_use_certificate --> "
1949 #else /* OPENSSL_NO_ENGINE */
1951 #endif /* OPENSSL_NO_ENGINE */
1955 static int tls_connection_engine_ca_cert(void *_ssl_ctx,
1956 struct tls_connection *conn,
1957 const char *ca_cert_id)
1959 #ifndef OPENSSL_NO_ENGINE
1961 SSL_CTX *ssl_ctx = _ssl_ctx;
1963 if (tls_engine_get_cert(conn, ca_cert_id, &cert))
1966 /* start off the same as tls_connection_ca_cert */
1967 X509_STORE_free(ssl_ctx->cert_store);
1968 ssl_ctx->cert_store = X509_STORE_new();
1969 if (ssl_ctx->cert_store == NULL) {
1970 wpa_printf(MSG_DEBUG, "OpenSSL: %s - failed to allocate new "
1971 "certificate store", __func__);
1975 if (!X509_STORE_add_cert(ssl_ctx->cert_store, cert)) {
1976 unsigned long err = ERR_peek_error();
1977 tls_show_errors(MSG_WARNING, __func__,
1978 "Failed to add CA certificate from engine "
1979 "to certificate store");
1980 if (ERR_GET_LIB(err) == ERR_LIB_X509 &&
1981 ERR_GET_REASON(err) == X509_R_CERT_ALREADY_IN_HASH_TABLE) {
1982 wpa_printf(MSG_DEBUG, "OpenSSL: %s - ignoring cert"
1983 " already in hash table error",
1991 wpa_printf(MSG_DEBUG, "OpenSSL: %s - added CA certificate from engine "
1992 "to certificate store", __func__);
1993 SSL_set_verify(conn->ssl, SSL_VERIFY_PEER, tls_verify_cb);
1994 conn->ca_cert_verify = 1;
1998 #else /* OPENSSL_NO_ENGINE */
2000 #endif /* OPENSSL_NO_ENGINE */
2004 static int tls_connection_engine_private_key(struct tls_connection *conn)
2006 #ifndef OPENSSL_NO_ENGINE
2007 if (SSL_use_PrivateKey(conn->ssl, conn->private_key) != 1) {
2008 tls_show_errors(MSG_ERROR, __func__,
2009 "ENGINE: cannot use private key for TLS");
2012 if (!SSL_check_private_key(conn->ssl)) {
2013 tls_show_errors(MSG_INFO, __func__,
2014 "Private key failed verification");
2018 #else /* OPENSSL_NO_ENGINE */
2019 wpa_printf(MSG_ERROR, "SSL: Configuration uses engine, but "
2020 "engine support was not compiled in");
2022 #endif /* OPENSSL_NO_ENGINE */
2026 static int tls_connection_private_key(void *_ssl_ctx,
2027 struct tls_connection *conn,
2028 const char *private_key,
2029 const char *private_key_passwd,
2030 const u8 *private_key_blob,
2031 size_t private_key_blob_len)
2033 SSL_CTX *ssl_ctx = _ssl_ctx;
2037 if (private_key == NULL && private_key_blob == NULL)
2040 if (private_key_passwd) {
2041 passwd = os_strdup(private_key_passwd);
2047 SSL_CTX_set_default_passwd_cb(ssl_ctx, tls_passwd_cb);
2048 SSL_CTX_set_default_passwd_cb_userdata(ssl_ctx, passwd);
2051 while (private_key_blob) {
2052 if (SSL_use_PrivateKey_ASN1(EVP_PKEY_RSA, conn->ssl,
2053 (u8 *) private_key_blob,
2054 private_key_blob_len) == 1) {
2055 wpa_printf(MSG_DEBUG, "OpenSSL: SSL_use_PrivateKey_"
2056 "ASN1(EVP_PKEY_RSA) --> OK");
2061 if (SSL_use_PrivateKey_ASN1(EVP_PKEY_DSA, conn->ssl,
2062 (u8 *) private_key_blob,
2063 private_key_blob_len) == 1) {
2064 wpa_printf(MSG_DEBUG, "OpenSSL: SSL_use_PrivateKey_"
2065 "ASN1(EVP_PKEY_DSA) --> OK");
2070 if (SSL_use_RSAPrivateKey_ASN1(conn->ssl,
2071 (u8 *) private_key_blob,
2072 private_key_blob_len) == 1) {
2073 wpa_printf(MSG_DEBUG, "OpenSSL: "
2074 "SSL_use_RSAPrivateKey_ASN1 --> OK");
2079 if (tls_read_pkcs12_blob(ssl_ctx, conn->ssl, private_key_blob,
2080 private_key_blob_len, passwd) == 0) {
2081 wpa_printf(MSG_DEBUG, "OpenSSL: PKCS#12 as blob --> "
2091 if (!ok && private_key &&
2092 os_strncmp("keystore://", private_key, 11) == 0) {
2093 BIO *bio = BIO_from_keystore(&private_key[11]);
2094 EVP_PKEY *pkey = NULL;
2096 pkey = PEM_read_bio_PrivateKey(bio, NULL, NULL, NULL);
2100 if (SSL_use_PrivateKey(conn->ssl, pkey) == 1) {
2101 wpa_printf(MSG_DEBUG, "OpenSSL: Private key "
2105 EVP_PKEY_free(pkey);
2108 #endif /* ANDROID */
2110 while (!ok && private_key) {
2111 #ifndef OPENSSL_NO_STDIO
2112 if (SSL_use_PrivateKey_file(conn->ssl, private_key,
2113 SSL_FILETYPE_ASN1) == 1) {
2114 wpa_printf(MSG_DEBUG, "OpenSSL: "
2115 "SSL_use_PrivateKey_File (DER) --> OK");
2120 if (SSL_use_PrivateKey_file(conn->ssl, private_key,
2121 SSL_FILETYPE_PEM) == 1) {
2122 wpa_printf(MSG_DEBUG, "OpenSSL: "
2123 "SSL_use_PrivateKey_File (PEM) --> OK");
2127 #else /* OPENSSL_NO_STDIO */
2128 wpa_printf(MSG_DEBUG, "OpenSSL: %s - OPENSSL_NO_STDIO",
2130 #endif /* OPENSSL_NO_STDIO */
2132 if (tls_read_pkcs12(ssl_ctx, conn->ssl, private_key, passwd)
2134 wpa_printf(MSG_DEBUG, "OpenSSL: Reading PKCS#12 file "
2140 if (tls_cryptoapi_cert(conn->ssl, private_key) == 0) {
2141 wpa_printf(MSG_DEBUG, "OpenSSL: Using CryptoAPI to "
2142 "access certificate store --> OK");
2151 tls_show_errors(MSG_INFO, __func__,
2152 "Failed to load private key");
2157 SSL_CTX_set_default_passwd_cb(ssl_ctx, NULL);
2160 if (!SSL_check_private_key(conn->ssl)) {
2161 tls_show_errors(MSG_INFO, __func__, "Private key failed "
2166 wpa_printf(MSG_DEBUG, "SSL: Private key loaded successfully");
2171 static int tls_global_private_key(SSL_CTX *ssl_ctx, const char *private_key,
2172 const char *private_key_passwd)
2176 if (private_key == NULL)
2179 if (private_key_passwd) {
2180 passwd = os_strdup(private_key_passwd);
2186 SSL_CTX_set_default_passwd_cb(ssl_ctx, tls_passwd_cb);
2187 SSL_CTX_set_default_passwd_cb_userdata(ssl_ctx, passwd);
2189 #ifndef OPENSSL_NO_STDIO
2190 SSL_CTX_use_PrivateKey_file(ssl_ctx, private_key,
2191 SSL_FILETYPE_ASN1) != 1 &&
2192 SSL_CTX_use_PrivateKey_file(ssl_ctx, private_key,
2193 SSL_FILETYPE_PEM) != 1 &&
2194 #endif /* OPENSSL_NO_STDIO */
2195 tls_read_pkcs12(ssl_ctx, NULL, private_key, passwd)) {
2196 tls_show_errors(MSG_INFO, __func__,
2197 "Failed to load private key");
2204 SSL_CTX_set_default_passwd_cb(ssl_ctx, NULL);
2206 if (!SSL_CTX_check_private_key(ssl_ctx)) {
2207 tls_show_errors(MSG_INFO, __func__,
2208 "Private key failed verification");
2216 static int tls_connection_dh(struct tls_connection *conn, const char *dh_file)
2218 #ifdef OPENSSL_NO_DH
2219 if (dh_file == NULL)
2221 wpa_printf(MSG_ERROR, "TLS: openssl does not include DH support, but "
2222 "dh_file specified");
2224 #else /* OPENSSL_NO_DH */
2228 /* TODO: add support for dh_blob */
2229 if (dh_file == NULL)
2234 bio = BIO_new_file(dh_file, "r");
2236 wpa_printf(MSG_INFO, "TLS: Failed to open DH file '%s': %s",
2237 dh_file, ERR_error_string(ERR_get_error(), NULL));
2240 dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL);
2242 #ifndef OPENSSL_NO_DSA
2243 while (dh == NULL) {
2245 wpa_printf(MSG_DEBUG, "TLS: Failed to parse DH file '%s': %s -"
2246 " trying to parse as DSA params", dh_file,
2247 ERR_error_string(ERR_get_error(), NULL));
2248 bio = BIO_new_file(dh_file, "r");
2251 dsa = PEM_read_bio_DSAparams(bio, NULL, NULL, NULL);
2254 wpa_printf(MSG_DEBUG, "TLS: Failed to parse DSA file "
2255 "'%s': %s", dh_file,
2256 ERR_error_string(ERR_get_error(), NULL));
2260 wpa_printf(MSG_DEBUG, "TLS: DH file in DSA param format");
2261 dh = DSA_dup_DH(dsa);
2264 wpa_printf(MSG_INFO, "TLS: Failed to convert DSA "
2265 "params into DH params");
2270 #endif /* !OPENSSL_NO_DSA */
2272 wpa_printf(MSG_INFO, "TLS: Failed to read/parse DH/DSA file "
2277 if (SSL_set_tmp_dh(conn->ssl, dh) != 1) {
2278 wpa_printf(MSG_INFO, "TLS: Failed to set DH params from '%s': "
2280 ERR_error_string(ERR_get_error(), NULL));
2286 #endif /* OPENSSL_NO_DH */
2290 static int tls_global_dh(SSL_CTX *ssl_ctx, const char *dh_file)
2292 #ifdef OPENSSL_NO_DH
2293 if (dh_file == NULL)
2295 wpa_printf(MSG_ERROR, "TLS: openssl does not include DH support, but "
2296 "dh_file specified");
2298 #else /* OPENSSL_NO_DH */
2302 /* TODO: add support for dh_blob */
2303 if (dh_file == NULL)
2305 if (ssl_ctx == NULL)
2308 bio = BIO_new_file(dh_file, "r");
2310 wpa_printf(MSG_INFO, "TLS: Failed to open DH file '%s': %s",
2311 dh_file, ERR_error_string(ERR_get_error(), NULL));
2314 dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL);
2316 #ifndef OPENSSL_NO_DSA
2317 while (dh == NULL) {
2319 wpa_printf(MSG_DEBUG, "TLS: Failed to parse DH file '%s': %s -"
2320 " trying to parse as DSA params", dh_file,
2321 ERR_error_string(ERR_get_error(), NULL));
2322 bio = BIO_new_file(dh_file, "r");
2325 dsa = PEM_read_bio_DSAparams(bio, NULL, NULL, NULL);
2328 wpa_printf(MSG_DEBUG, "TLS: Failed to parse DSA file "
2329 "'%s': %s", dh_file,
2330 ERR_error_string(ERR_get_error(), NULL));
2334 wpa_printf(MSG_DEBUG, "TLS: DH file in DSA param format");
2335 dh = DSA_dup_DH(dsa);
2338 wpa_printf(MSG_INFO, "TLS: Failed to convert DSA "
2339 "params into DH params");
2344 #endif /* !OPENSSL_NO_DSA */
2346 wpa_printf(MSG_INFO, "TLS: Failed to read/parse DH/DSA file "
2351 if (SSL_CTX_set_tmp_dh(ssl_ctx, dh) != 1) {
2352 wpa_printf(MSG_INFO, "TLS: Failed to set DH params from '%s': "
2354 ERR_error_string(ERR_get_error(), NULL));
2360 #endif /* OPENSSL_NO_DH */
2364 int tls_connection_get_keys(void *ssl_ctx, struct tls_connection *conn,
2365 struct tls_keys *keys)
2368 wpa_printf(MSG_ERROR, "OpenSSL: TLS keys cannot be exported in FIPS "
2371 #else /* CONFIG_FIPS */
2374 if (conn == NULL || keys == NULL)
2377 if (ssl == NULL || ssl->s3 == NULL || ssl->session == NULL)
2380 os_memset(keys, 0, sizeof(*keys));
2381 keys->master_key = ssl->session->master_key;
2382 keys->master_key_len = ssl->session->master_key_length;
2383 keys->client_random = ssl->s3->client_random;
2384 keys->client_random_len = SSL3_RANDOM_SIZE;
2385 keys->server_random = ssl->s3->server_random;
2386 keys->server_random_len = SSL3_RANDOM_SIZE;
2389 #endif /* CONFIG_FIPS */
2393 int tls_connection_prf(void *tls_ctx, struct tls_connection *conn,
2394 const char *label, int server_random_first,
2395 u8 *out, size_t out_len)
2397 #if OPENSSL_VERSION_NUMBER >= 0x10001000L
2401 if (server_random_first)
2404 if (SSL_export_keying_material(ssl, out, out_len, label,
2405 os_strlen(label), NULL, 0, 0) == 1) {
2406 wpa_printf(MSG_DEBUG, "OpenSSL: Using internal PRF");
2414 static struct wpabuf *
2415 openssl_handshake(struct tls_connection *conn, const struct wpabuf *in_data,
2419 struct wpabuf *out_data;
2422 * Give TLS handshake data from the server (if available) to OpenSSL
2426 BIO_write(conn->ssl_in, wpabuf_head(in_data), wpabuf_len(in_data))
2428 tls_show_errors(MSG_INFO, __func__,
2429 "Handshake failed - BIO_write");
2433 /* Initiate TLS handshake or continue the existing handshake */
2435 res = SSL_accept(conn->ssl);
2437 res = SSL_connect(conn->ssl);
2439 int err = SSL_get_error(conn->ssl, res);
2440 if (err == SSL_ERROR_WANT_READ)
2441 wpa_printf(MSG_DEBUG, "SSL: SSL_connect - want "
2443 else if (err == SSL_ERROR_WANT_WRITE)
2444 wpa_printf(MSG_DEBUG, "SSL: SSL_connect - want to "
2447 tls_show_errors(MSG_INFO, __func__, "SSL_connect");
2452 /* Get the TLS handshake data to be sent to the server */
2453 res = BIO_ctrl_pending(conn->ssl_out);
2454 wpa_printf(MSG_DEBUG, "SSL: %d bytes pending from ssl_out", res);
2455 out_data = wpabuf_alloc(res);
2456 if (out_data == NULL) {
2457 wpa_printf(MSG_DEBUG, "SSL: Failed to allocate memory for "
2458 "handshake output (%d bytes)", res);
2459 if (BIO_reset(conn->ssl_out) < 0) {
2460 tls_show_errors(MSG_INFO, __func__,
2461 "BIO_reset failed");
2465 res = res == 0 ? 0 : BIO_read(conn->ssl_out, wpabuf_mhead(out_data),
2468 tls_show_errors(MSG_INFO, __func__,
2469 "Handshake failed - BIO_read");
2470 if (BIO_reset(conn->ssl_out) < 0) {
2471 tls_show_errors(MSG_INFO, __func__,
2472 "BIO_reset failed");
2474 wpabuf_free(out_data);
2477 wpabuf_put(out_data, res);
2483 static struct wpabuf *
2484 openssl_get_appl_data(struct tls_connection *conn, size_t max_len)
2486 struct wpabuf *appl_data;
2489 appl_data = wpabuf_alloc(max_len + 100);
2490 if (appl_data == NULL)
2493 res = SSL_read(conn->ssl, wpabuf_mhead(appl_data),
2494 wpabuf_size(appl_data));
2496 int err = SSL_get_error(conn->ssl, res);
2497 if (err == SSL_ERROR_WANT_READ ||
2498 err == SSL_ERROR_WANT_WRITE) {
2499 wpa_printf(MSG_DEBUG, "SSL: No Application Data "
2502 tls_show_errors(MSG_INFO, __func__,
2503 "Failed to read possible "
2504 "Application Data");
2506 wpabuf_free(appl_data);
2510 wpabuf_put(appl_data, res);
2511 wpa_hexdump_buf_key(MSG_MSGDUMP, "SSL: Application Data in Finished "
2512 "message", appl_data);
2518 static struct wpabuf *
2519 openssl_connection_handshake(struct tls_connection *conn,
2520 const struct wpabuf *in_data,
2521 struct wpabuf **appl_data, int server)
2523 struct wpabuf *out_data;
2528 out_data = openssl_handshake(conn, in_data, server);
2529 if (out_data == NULL)
2532 if (SSL_is_init_finished(conn->ssl) && appl_data && in_data)
2533 *appl_data = openssl_get_appl_data(conn, wpabuf_len(in_data));
2540 tls_connection_handshake(void *ssl_ctx, struct tls_connection *conn,
2541 const struct wpabuf *in_data,
2542 struct wpabuf **appl_data)
2544 return openssl_connection_handshake(conn, in_data, appl_data, 0);
2548 struct wpabuf * tls_connection_server_handshake(void *tls_ctx,
2549 struct tls_connection *conn,
2550 const struct wpabuf *in_data,
2551 struct wpabuf **appl_data)
2553 return openssl_connection_handshake(conn, in_data, appl_data, 1);
2557 struct wpabuf * tls_connection_encrypt(void *tls_ctx,
2558 struct tls_connection *conn,
2559 const struct wpabuf *in_data)
2567 /* Give plaintext data for OpenSSL to encrypt into the TLS tunnel. */
2568 if ((res = BIO_reset(conn->ssl_in)) < 0 ||
2569 (res = BIO_reset(conn->ssl_out)) < 0) {
2570 tls_show_errors(MSG_INFO, __func__, "BIO_reset failed");
2573 res = SSL_write(conn->ssl, wpabuf_head(in_data), wpabuf_len(in_data));
2575 tls_show_errors(MSG_INFO, __func__,
2576 "Encryption failed - SSL_write");
2580 /* Read encrypted data to be sent to the server */
2581 buf = wpabuf_alloc(wpabuf_len(in_data) + 300);
2584 res = BIO_read(conn->ssl_out, wpabuf_mhead(buf), wpabuf_size(buf));
2586 tls_show_errors(MSG_INFO, __func__,
2587 "Encryption failed - BIO_read");
2591 wpabuf_put(buf, res);
2597 struct wpabuf * tls_connection_decrypt(void *tls_ctx,
2598 struct tls_connection *conn,
2599 const struct wpabuf *in_data)
2604 /* Give encrypted data from TLS tunnel for OpenSSL to decrypt. */
2605 res = BIO_write(conn->ssl_in, wpabuf_head(in_data),
2606 wpabuf_len(in_data));
2608 tls_show_errors(MSG_INFO, __func__,
2609 "Decryption failed - BIO_write");
2612 if (BIO_reset(conn->ssl_out) < 0) {
2613 tls_show_errors(MSG_INFO, __func__, "BIO_reset failed");
2617 /* Read decrypted data for further processing */
2619 * Even though we try to disable TLS compression, it is possible that
2620 * this cannot be done with all TLS libraries. Add extra buffer space
2621 * to handle the possibility of the decrypted data being longer than
2624 buf = wpabuf_alloc((wpabuf_len(in_data) + 500) * 3);
2627 res = SSL_read(conn->ssl, wpabuf_mhead(buf), wpabuf_size(buf));
2629 tls_show_errors(MSG_INFO, __func__,
2630 "Decryption failed - SSL_read");
2634 wpabuf_put(buf, res);
2640 int tls_connection_resumed(void *ssl_ctx, struct tls_connection *conn)
2642 return conn ? conn->ssl->hit : 0;
2646 int tls_connection_set_cipher_list(void *tls_ctx, struct tls_connection *conn,
2649 char buf[100], *pos, *end;
2653 if (conn == NULL || conn->ssl == NULL || ciphers == NULL)
2658 end = pos + sizeof(buf);
2661 while (*c != TLS_CIPHER_NONE) {
2665 case TLS_CIPHER_RC4_SHA:
2668 case TLS_CIPHER_AES128_SHA:
2669 suite = "AES128-SHA";
2671 case TLS_CIPHER_RSA_DHE_AES128_SHA:
2672 suite = "DHE-RSA-AES128-SHA";
2674 case TLS_CIPHER_ANON_DH_AES128_SHA:
2675 suite = "ADH-AES128-SHA";
2678 wpa_printf(MSG_DEBUG, "TLS: Unsupported "
2679 "cipher selection: %d", *c);
2682 ret = os_snprintf(pos, end - pos, ":%s", suite);
2683 if (ret < 0 || ret >= end - pos)
2690 wpa_printf(MSG_DEBUG, "OpenSSL: cipher suites: %s", buf + 1);
2692 if (SSL_set_cipher_list(conn->ssl, buf + 1) != 1) {
2693 tls_show_errors(MSG_INFO, __func__,
2694 "Cipher suite configuration failed");
2702 int tls_get_cipher(void *ssl_ctx, struct tls_connection *conn,
2703 char *buf, size_t buflen)
2706 if (conn == NULL || conn->ssl == NULL)
2709 name = SSL_get_cipher(conn->ssl);
2713 os_strlcpy(buf, name, buflen);
2718 int tls_connection_enable_workaround(void *ssl_ctx,
2719 struct tls_connection *conn)
2721 SSL_set_options(conn->ssl, SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS);
2727 #if defined(EAP_FAST) || defined(EAP_FAST_DYNAMIC) || defined(EAP_SERVER_FAST)
2728 /* ClientHello TLS extensions require a patch to openssl, so this function is
2729 * commented out unless explicitly needed for EAP-FAST in order to be able to
2730 * build this file with unmodified openssl. */
2731 int tls_connection_client_hello_ext(void *ssl_ctx, struct tls_connection *conn,
2732 int ext_type, const u8 *data,
2735 if (conn == NULL || conn->ssl == NULL || ext_type != 35)
2738 #ifdef CONFIG_OPENSSL_TICKET_OVERRIDE
2739 if (SSL_set_session_ticket_ext(conn->ssl, (void *) data,
2742 #else /* CONFIG_OPENSSL_TICKET_OVERRIDE */
2743 if (SSL_set_hello_extension(conn->ssl, ext_type, (void *) data,
2746 #endif /* CONFIG_OPENSSL_TICKET_OVERRIDE */
2750 #endif /* EAP_FAST || EAP_FAST_DYNAMIC || EAP_SERVER_FAST */
2753 int tls_connection_get_failed(void *ssl_ctx, struct tls_connection *conn)
2757 return conn->failed;
2761 int tls_connection_get_read_alerts(void *ssl_ctx, struct tls_connection *conn)
2765 return conn->read_alerts;
2769 int tls_connection_get_write_alerts(void *ssl_ctx, struct tls_connection *conn)
2773 return conn->write_alerts;
2779 static void ocsp_debug_print_resp(OCSP_RESPONSE *rsp)
2781 #ifndef CONFIG_NO_STDOUT_DEBUG
2782 extern int wpa_debug_level;
2788 if (wpa_debug_level > MSG_DEBUG)
2791 out = BIO_new(BIO_s_mem());
2795 OCSP_RESPONSE_print(out, rsp, 0);
2796 rlen = BIO_ctrl_pending(out);
2797 txt = os_malloc(rlen + 1);
2803 res = BIO_read(out, txt, rlen);
2806 wpa_printf(MSG_DEBUG, "OpenSSL: OCSP Response\n%s", txt);
2810 #endif /* CONFIG_NO_STDOUT_DEBUG */
2814 static int ocsp_resp_cb(SSL *s, void *arg)
2816 struct tls_connection *conn = arg;
2817 const unsigned char *p;
2818 int len, status, reason;
2820 OCSP_BASICRESP *basic;
2822 ASN1_GENERALIZEDTIME *produced_at, *this_update, *next_update;
2824 len = SSL_get_tlsext_status_ocsp_resp(s, &p);
2826 wpa_printf(MSG_DEBUG, "OpenSSL: No OCSP response received");
2827 return (conn->flags & TLS_CONN_REQUIRE_OCSP) ? 0 : 1;
2830 wpa_hexdump(MSG_DEBUG, "OpenSSL: OCSP response", p, len);
2832 rsp = d2i_OCSP_RESPONSE(NULL, &p, len);
2834 wpa_printf(MSG_INFO, "OpenSSL: Failed to parse OCSP response");
2838 ocsp_debug_print_resp(rsp);
2840 status = OCSP_response_status(rsp);
2841 if (status != OCSP_RESPONSE_STATUS_SUCCESSFUL) {
2842 wpa_printf(MSG_INFO, "OpenSSL: OCSP responder error %d (%s)",
2843 status, OCSP_response_status_str(status));
2847 basic = OCSP_response_get1_basic(rsp);
2849 wpa_printf(MSG_INFO, "OpenSSL: Could not find BasicOCSPResponse");
2853 status = OCSP_basic_verify(basic, NULL, SSL_CTX_get_cert_store(s->ctx),
2856 tls_show_errors(MSG_INFO, __func__,
2857 "OpenSSL: OCSP response failed verification");
2858 OCSP_BASICRESP_free(basic);
2859 OCSP_RESPONSE_free(rsp);
2863 wpa_printf(MSG_DEBUG, "OpenSSL: OCSP response verification succeeded");
2865 if (!conn->peer_cert || !conn->peer_issuer) {
2866 wpa_printf(MSG_DEBUG, "OpenSSL: Peer certificate or issue certificate not available for OCSP status check");
2867 OCSP_BASICRESP_free(basic);
2868 OCSP_RESPONSE_free(rsp);
2872 id = OCSP_cert_to_id(NULL, conn->peer_cert, conn->peer_issuer);
2874 wpa_printf(MSG_DEBUG, "OpenSSL: Could not create OCSP certificate identifier");
2875 OCSP_BASICRESP_free(basic);
2876 OCSP_RESPONSE_free(rsp);
2880 if (!OCSP_resp_find_status(basic, id, &status, &reason, &produced_at,
2881 &this_update, &next_update)) {
2882 wpa_printf(MSG_INFO, "OpenSSL: Could not find current server certificate from OCSP response%s",
2883 (conn->flags & TLS_CONN_REQUIRE_OCSP) ? "" :
2884 " (OCSP not required)");
2885 OCSP_BASICRESP_free(basic);
2886 OCSP_RESPONSE_free(rsp);
2887 return (conn->flags & TLS_CONN_REQUIRE_OCSP) ? 0 : 1;
2890 if (!OCSP_check_validity(this_update, next_update, 5 * 60, -1)) {
2891 tls_show_errors(MSG_INFO, __func__,
2892 "OpenSSL: OCSP status times invalid");
2893 OCSP_BASICRESP_free(basic);
2894 OCSP_RESPONSE_free(rsp);
2898 OCSP_BASICRESP_free(basic);
2899 OCSP_RESPONSE_free(rsp);
2901 wpa_printf(MSG_DEBUG, "OpenSSL: OCSP status for server certificate: %s",
2902 OCSP_cert_status_str(status));
2904 if (status == V_OCSP_CERTSTATUS_GOOD)
2906 if (status == V_OCSP_CERTSTATUS_REVOKED)
2908 if (conn->flags & TLS_CONN_REQUIRE_OCSP) {
2909 wpa_printf(MSG_DEBUG, "OpenSSL: OCSP status unknown, but OCSP required");
2912 wpa_printf(MSG_DEBUG, "OpenSSL: OCSP status unknown, but OCSP was not required, so allow connection to continue");
2917 static int ocsp_status_cb(SSL *s, void *arg)
2923 if (tls_global->ocsp_stapling_response == NULL) {
2924 wpa_printf(MSG_DEBUG, "OpenSSL: OCSP status callback - no response configured");
2925 return SSL_TLSEXT_ERR_OK;
2928 resp = os_readfile(tls_global->ocsp_stapling_response, &len);
2930 wpa_printf(MSG_DEBUG, "OpenSSL: OCSP status callback - could not read response file");
2931 /* TODO: Build OCSPResponse with responseStatus = internalError
2933 return SSL_TLSEXT_ERR_OK;
2935 wpa_printf(MSG_DEBUG, "OpenSSL: OCSP status callback - send cached response");
2936 tmp = OPENSSL_malloc(len);
2939 return SSL_TLSEXT_ERR_ALERT_FATAL;
2942 os_memcpy(tmp, resp, len);
2944 SSL_set_tlsext_status_ocsp_resp(s, tmp, len);
2946 return SSL_TLSEXT_ERR_OK;
2949 #endif /* HAVE_OCSP */
2952 int tls_connection_set_params(void *tls_ctx, struct tls_connection *conn,
2953 const struct tls_connection_params *params)
2957 SSL_CTX *ssl_ctx = tls_ctx;
2962 while ((err = ERR_get_error())) {
2963 wpa_printf(MSG_INFO, "%s: Clearing pending SSL error: %s",
2964 __func__, ERR_error_string(err, NULL));
2967 if (params->engine) {
2968 wpa_printf(MSG_DEBUG, "SSL: Initializing TLS engine");
2969 ret = tls_engine_init(conn, params->engine_id, params->pin,
2970 params->key_id, params->cert_id,
2971 params->ca_cert_id);
2975 if (tls_connection_set_subject_match(conn,
2976 params->subject_match,
2977 params->altsubject_match))
2980 if (params->engine && params->ca_cert_id) {
2981 if (tls_connection_engine_ca_cert(tls_ctx, conn,
2982 params->ca_cert_id))
2983 return TLS_SET_PARAMS_ENGINE_PRV_VERIFY_FAILED;
2984 } else if (tls_connection_ca_cert(tls_ctx, conn, params->ca_cert,
2985 params->ca_cert_blob,
2986 params->ca_cert_blob_len,
2990 if (params->engine && params->cert_id) {
2991 if (tls_connection_engine_client_cert(conn, params->cert_id))
2992 return TLS_SET_PARAMS_ENGINE_PRV_VERIFY_FAILED;
2993 } else if (tls_connection_client_cert(conn, params->client_cert,
2994 params->client_cert_blob,
2995 params->client_cert_blob_len))
2998 if (params->engine && params->key_id) {
2999 wpa_printf(MSG_DEBUG, "TLS: Using private key from engine");
3000 if (tls_connection_engine_private_key(conn))
3001 return TLS_SET_PARAMS_ENGINE_PRV_VERIFY_FAILED;
3002 } else if (tls_connection_private_key(tls_ctx, conn,
3003 params->private_key,
3004 params->private_key_passwd,
3005 params->private_key_blob,
3006 params->private_key_blob_len)) {
3007 wpa_printf(MSG_INFO, "TLS: Failed to load private key '%s'",
3008 params->private_key);
3012 if (tls_connection_dh(conn, params->dh_file)) {
3013 wpa_printf(MSG_INFO, "TLS: Failed to load DH file '%s'",
3018 #ifdef SSL_OP_NO_TICKET
3019 if (params->flags & TLS_CONN_DISABLE_SESSION_TICKET)
3020 SSL_set_options(conn->ssl, SSL_OP_NO_TICKET);
3022 SSL_clear_options(conn->ssl, SSL_OP_NO_TICKET);
3023 #endif /* SSL_OP_NO_TICKET */
3026 if (params->flags & TLS_CONN_REQUEST_OCSP) {
3027 SSL_set_tlsext_status_type(conn->ssl, TLSEXT_STATUSTYPE_ocsp);
3028 SSL_CTX_set_tlsext_status_cb(ssl_ctx, ocsp_resp_cb);
3029 SSL_CTX_set_tlsext_status_arg(ssl_ctx, conn);
3031 #endif /* HAVE_OCSP */
3033 conn->flags = params->flags;
3035 tls_get_errors(tls_ctx);
3041 int tls_global_set_params(void *tls_ctx,
3042 const struct tls_connection_params *params)
3044 SSL_CTX *ssl_ctx = tls_ctx;
3047 while ((err = ERR_get_error())) {
3048 wpa_printf(MSG_INFO, "%s: Clearing pending SSL error: %s",
3049 __func__, ERR_error_string(err, NULL));
3052 if (tls_global_ca_cert(ssl_ctx, params->ca_cert))
3055 if (tls_global_client_cert(ssl_ctx, params->client_cert))
3058 if (tls_global_private_key(ssl_ctx, params->private_key,
3059 params->private_key_passwd))
3062 if (tls_global_dh(ssl_ctx, params->dh_file)) {
3063 wpa_printf(MSG_INFO, "TLS: Failed to load DH file '%s'",
3068 #ifdef SSL_OP_NO_TICKET
3069 if (params->flags & TLS_CONN_DISABLE_SESSION_TICKET)
3070 SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
3072 SSL_CTX_clear_options(ssl_ctx, SSL_OP_NO_TICKET);
3073 #endif /* SSL_OP_NO_TICKET */
3076 SSL_CTX_set_tlsext_status_cb(ssl_ctx, ocsp_status_cb);
3077 SSL_CTX_set_tlsext_status_arg(ssl_ctx, ssl_ctx);
3078 os_free(tls_global->ocsp_stapling_response);
3079 if (params->ocsp_stapling_response)
3080 tls_global->ocsp_stapling_response =
3081 os_strdup(params->ocsp_stapling_response);
3083 tls_global->ocsp_stapling_response = NULL;
3084 #endif /* HAVE_OCSP */
3090 int tls_connection_get_keyblock_size(void *tls_ctx,
3091 struct tls_connection *conn)
3093 const EVP_CIPHER *c;
3097 if (conn == NULL || conn->ssl == NULL ||
3098 conn->ssl->enc_read_ctx == NULL ||
3099 conn->ssl->enc_read_ctx->cipher == NULL ||
3100 conn->ssl->read_hash == NULL)
3103 c = conn->ssl->enc_read_ctx->cipher;
3104 #if OPENSSL_VERSION_NUMBER >= 0x00909000L
3105 h = EVP_MD_CTX_md(conn->ssl->read_hash);
3107 h = conn->ssl->read_hash;
3110 md_size = EVP_MD_size(h);
3111 #if OPENSSL_VERSION_NUMBER >= 0x10000000L
3112 else if (conn->ssl->s3)
3113 md_size = conn->ssl->s3->tmp.new_mac_secret_size;
3118 wpa_printf(MSG_DEBUG, "OpenSSL: keyblock size: key_len=%d MD_size=%d "
3119 "IV_len=%d", EVP_CIPHER_key_length(c), md_size,
3120 EVP_CIPHER_iv_length(c));
3121 return 2 * (EVP_CIPHER_key_length(c) +
3123 EVP_CIPHER_iv_length(c));
3127 unsigned int tls_capabilities(void *tls_ctx)
3133 #if defined(EAP_FAST) || defined(EAP_FAST_DYNAMIC) || defined(EAP_SERVER_FAST)
3134 /* Pre-shared secred requires a patch to openssl, so this function is
3135 * commented out unless explicitly needed for EAP-FAST in order to be able to
3136 * build this file with unmodified openssl. */
3138 static int tls_sess_sec_cb(SSL *s, void *secret, int *secret_len,
3139 STACK_OF(SSL_CIPHER) *peer_ciphers,
3140 SSL_CIPHER **cipher, void *arg)
3142 struct tls_connection *conn = arg;
3145 if (conn == NULL || conn->session_ticket_cb == NULL)
3148 ret = conn->session_ticket_cb(conn->session_ticket_cb_ctx,
3149 conn->session_ticket,
3150 conn->session_ticket_len,
3151 s->s3->client_random,
3152 s->s3->server_random, secret);
3153 os_free(conn->session_ticket);
3154 conn->session_ticket = NULL;
3159 *secret_len = SSL_MAX_MASTER_KEY_LENGTH;
3164 #ifdef CONFIG_OPENSSL_TICKET_OVERRIDE
3165 static int tls_session_ticket_ext_cb(SSL *s, const unsigned char *data,
3168 struct tls_connection *conn = arg;
3170 if (conn == NULL || conn->session_ticket_cb == NULL)
3173 wpa_printf(MSG_DEBUG, "OpenSSL: %s: length=%d", __func__, len);
3175 os_free(conn->session_ticket);
3176 conn->session_ticket = NULL;
3178 wpa_hexdump(MSG_DEBUG, "OpenSSL: ClientHello SessionTicket "
3179 "extension", data, len);
3181 conn->session_ticket = os_malloc(len);
3182 if (conn->session_ticket == NULL)
3185 os_memcpy(conn->session_ticket, data, len);
3186 conn->session_ticket_len = len;
3190 #else /* CONFIG_OPENSSL_TICKET_OVERRIDE */
3191 #ifdef SSL_OP_NO_TICKET
3192 static void tls_hello_ext_cb(SSL *s, int client_server, int type,
3193 unsigned char *data, int len, void *arg)
3195 struct tls_connection *conn = arg;
3197 if (conn == NULL || conn->session_ticket_cb == NULL)
3200 wpa_printf(MSG_DEBUG, "OpenSSL: %s: type=%d length=%d", __func__,
3203 if (type == TLSEXT_TYPE_session_ticket && !client_server) {
3204 os_free(conn->session_ticket);
3205 conn->session_ticket = NULL;
3207 wpa_hexdump(MSG_DEBUG, "OpenSSL: ClientHello SessionTicket "
3208 "extension", data, len);
3209 conn->session_ticket = os_malloc(len);
3210 if (conn->session_ticket == NULL)
3213 os_memcpy(conn->session_ticket, data, len);
3214 conn->session_ticket_len = len;
3217 #else /* SSL_OP_NO_TICKET */
3218 static int tls_hello_ext_cb(SSL *s, TLS_EXTENSION *ext, void *arg)
3220 struct tls_connection *conn = arg;
3222 if (conn == NULL || conn->session_ticket_cb == NULL)
3225 wpa_printf(MSG_DEBUG, "OpenSSL: %s: type=%d length=%d", __func__,
3226 ext->type, ext->length);
3228 os_free(conn->session_ticket);
3229 conn->session_ticket = NULL;
3231 if (ext->type == 35) {
3232 wpa_hexdump(MSG_DEBUG, "OpenSSL: ClientHello SessionTicket "
3233 "extension", ext->data, ext->length);
3234 conn->session_ticket = os_malloc(ext->length);
3235 if (conn->session_ticket == NULL)
3236 return SSL_AD_INTERNAL_ERROR;
3238 os_memcpy(conn->session_ticket, ext->data, ext->length);
3239 conn->session_ticket_len = ext->length;
3244 #endif /* SSL_OP_NO_TICKET */
3245 #endif /* CONFIG_OPENSSL_TICKET_OVERRIDE */
3246 #endif /* EAP_FAST || EAP_FAST_DYNAMIC || EAP_SERVER_FAST */
3249 int tls_connection_set_session_ticket_cb(void *tls_ctx,
3250 struct tls_connection *conn,
3251 tls_session_ticket_cb cb,
3254 #if defined(EAP_FAST) || defined(EAP_FAST_DYNAMIC) || defined(EAP_SERVER_FAST)
3255 conn->session_ticket_cb = cb;
3256 conn->session_ticket_cb_ctx = ctx;
3259 if (SSL_set_session_secret_cb(conn->ssl, tls_sess_sec_cb,
3262 #ifdef CONFIG_OPENSSL_TICKET_OVERRIDE
3263 SSL_set_session_ticket_ext_cb(conn->ssl,
3264 tls_session_ticket_ext_cb, conn);
3265 #else /* CONFIG_OPENSSL_TICKET_OVERRIDE */
3266 #ifdef SSL_OP_NO_TICKET
3267 SSL_set_tlsext_debug_callback(conn->ssl, tls_hello_ext_cb);
3268 SSL_set_tlsext_debug_arg(conn->ssl, conn);
3269 #else /* SSL_OP_NO_TICKET */
3270 if (SSL_set_hello_extension_cb(conn->ssl, tls_hello_ext_cb,
3273 #endif /* SSL_OP_NO_TICKET */
3274 #endif /* CONFIG_OPENSSL_TICKET_OVERRIDE */
3276 if (SSL_set_session_secret_cb(conn->ssl, NULL, NULL) != 1)
3278 #ifdef CONFIG_OPENSSL_TICKET_OVERRIDE
3279 SSL_set_session_ticket_ext_cb(conn->ssl, NULL, NULL);
3280 #else /* CONFIG_OPENSSL_TICKET_OVERRIDE */
3281 #ifdef SSL_OP_NO_TICKET
3282 SSL_set_tlsext_debug_callback(conn->ssl, NULL);
3283 SSL_set_tlsext_debug_arg(conn->ssl, conn);
3284 #else /* SSL_OP_NO_TICKET */
3285 if (SSL_set_hello_extension_cb(conn->ssl, NULL, NULL) != 1)
3287 #endif /* SSL_OP_NO_TICKET */
3288 #endif /* CONFIG_OPENSSL_TICKET_OVERRIDE */
3292 #else /* EAP_FAST || EAP_FAST_DYNAMIC || EAP_SERVER_FAST */
3294 #endif /* EAP_FAST || EAP_FAST_DYNAMIC || EAP_SERVER_FAST */