1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 2012 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
9 * Copyright (C) 2010 - 2011, Hoi-Ho Chan, <hoiho.chan@gmail.com>
11 * This software is licensed as described in the file COPYING, which
12 * you should have received as part of this distribution. The terms
13 * are also available at https://curl.haxx.se/docs/copyright.html.
15 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
16 * copies of the Software, and permit persons to whom the Software is
17 * furnished to do so, under the terms of the COPYING file.
19 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
20 * KIND, either express or implied.
22 ***************************************************************************/
25 * Source file for all PolarSSL-specific code for the TLS/SSL layer. No code
26 * but vtls.c should ever call or use these functions.
30 #include "curl_setup.h"
34 #include <polarssl/net.h>
35 #include <polarssl/ssl.h>
36 #include <polarssl/certs.h>
37 #include <polarssl/x509.h>
38 #include <polarssl/version.h>
40 #if POLARSSL_VERSION_NUMBER < 0x01030000
41 #error too old PolarSSL
44 #include <polarssl/error.h>
45 #include <polarssl/entropy.h>
46 #include <polarssl/ctr_drbg.h>
50 #include "inet_pton.h"
53 #include "parsedate.h"
54 #include "connect.h" /* for the connect timeout */
57 #include "polarssl_threadlock.h"
58 #include "curl_printf.h"
59 #include "curl_memory.h"
60 /* The last #include file should be: */
63 /* apply threading? */
64 #if defined(USE_THREADS_POSIX) || defined(USE_THREADS_WIN32)
65 #define THREADING_SUPPORT
68 #if defined(THREADING_SUPPORT)
69 static entropy_context entropy;
71 static int entropy_init_initialized = 0;
73 /* start of entropy_init_mutex() */
74 static void entropy_init_mutex(entropy_context *ctx)
76 /* lock 0 = entropy_init_mutex() */
77 Curl_polarsslthreadlock_lock_function(0);
78 if(entropy_init_initialized == 0) {
80 entropy_init_initialized = 1;
82 Curl_polarsslthreadlock_unlock_function(0);
84 /* end of entropy_init_mutex() */
86 /* start of entropy_func_mutex() */
87 static int entropy_func_mutex(void *data, unsigned char *output, size_t len)
90 /* lock 1 = entropy_func_mutex() */
91 Curl_polarsslthreadlock_lock_function(1);
92 ret = entropy_func(data, output, len);
93 Curl_polarsslthreadlock_unlock_function(1);
97 /* end of entropy_func_mutex() */
99 #endif /* THREADING_SUPPORT */
101 /* Define this to enable lots of debugging for PolarSSL */
102 #undef POLARSSL_DEBUG
104 #ifdef POLARSSL_DEBUG
105 static void polarssl_debug(void *context, int level, const char *line)
107 struct SessionHandle *data = NULL;
112 data = (struct SessionHandle *)context;
114 infof(data, "%s", line);
120 /* ALPN for http2? */
121 #ifdef POLARSSL_SSL_ALPN
125 static Curl_recv polarssl_recv;
126 static Curl_send polarssl_send;
130 polarssl_connect_step1(struct connectdata *conn,
133 struct SessionHandle *data = conn->data;
134 struct ssl_connect_data* connssl = &conn->ssl[sockindex];
136 bool sni = TRUE; /* default is SNI enabled */
139 struct in6_addr addr;
143 void *old_session = NULL;
144 size_t old_session_size = 0;
148 /* PolarSSL only supports SSLv3 and TLSv1 */
149 if(data->set.ssl.version == CURL_SSLVERSION_SSLv2) {
150 failf(data, "PolarSSL does not support SSLv2");
151 return CURLE_SSL_CONNECT_ERROR;
153 else if(data->set.ssl.version == CURL_SSLVERSION_SSLv3)
154 sni = FALSE; /* SSLv3 has no SNI */
156 #ifdef THREADING_SUPPORT
157 entropy_init_mutex(&entropy);
159 if((ret = ctr_drbg_init(&connssl->ctr_drbg, entropy_func_mutex, &entropy,
160 connssl->ssn.id, connssl->ssn.length)) != 0) {
161 #ifdef POLARSSL_ERROR_C
162 error_strerror(ret, errorbuf, sizeof(errorbuf));
163 #endif /* POLARSSL_ERROR_C */
164 failf(data, "Failed - PolarSSL: ctr_drbg_init returned (-0x%04X) %s\n",
168 entropy_init(&connssl->entropy);
170 if((ret = ctr_drbg_init(&connssl->ctr_drbg, entropy_func, &connssl->entropy,
171 connssl->ssn.id, connssl->ssn.length)) != 0) {
172 #ifdef POLARSSL_ERROR_C
173 error_strerror(ret, errorbuf, sizeof(errorbuf));
174 #endif /* POLARSSL_ERROR_C */
175 failf(data, "Failed - PolarSSL: ctr_drbg_init returned (-0x%04X) %s\n",
178 #endif /* THREADING_SUPPORT */
180 /* Load the trusted CA */
181 memset(&connssl->cacert, 0, sizeof(x509_crt));
183 if(data->set.str[STRING_SSL_CAFILE]) {
184 ret = x509_crt_parse_file(&connssl->cacert,
185 data->set.str[STRING_SSL_CAFILE]);
188 #ifdef POLARSSL_ERROR_C
189 error_strerror(ret, errorbuf, sizeof(errorbuf));
190 #endif /* POLARSSL_ERROR_C */
191 failf(data, "Error reading ca cert file %s - PolarSSL: (-0x%04X) %s",
192 data->set.str[STRING_SSL_CAFILE], -ret, errorbuf);
194 if(data->set.ssl.verifypeer)
195 return CURLE_SSL_CACERT_BADFILE;
199 if(data->set.str[STRING_SSL_CAPATH]) {
200 ret = x509_crt_parse_path(&connssl->cacert,
201 data->set.str[STRING_SSL_CAPATH]);
204 #ifdef POLARSSL_ERROR_C
205 error_strerror(ret, errorbuf, sizeof(errorbuf));
206 #endif /* POLARSSL_ERROR_C */
207 failf(data, "Error reading ca cert path %s - PolarSSL: (-0x%04X) %s",
208 data->set.str[STRING_SSL_CAPATH], -ret, errorbuf);
210 if(data->set.ssl.verifypeer)
211 return CURLE_SSL_CACERT_BADFILE;
215 /* Load the client certificate */
216 memset(&connssl->clicert, 0, sizeof(x509_crt));
218 if(data->set.str[STRING_CERT]) {
219 ret = x509_crt_parse_file(&connssl->clicert,
220 data->set.str[STRING_CERT]);
223 #ifdef POLARSSL_ERROR_C
224 error_strerror(ret, errorbuf, sizeof(errorbuf));
225 #endif /* POLARSSL_ERROR_C */
226 failf(data, "Error reading client cert file %s - PolarSSL: (-0x%04X) %s",
227 data->set.str[STRING_CERT], -ret, errorbuf);
229 return CURLE_SSL_CERTPROBLEM;
233 /* Load the client private key */
234 if(data->set.str[STRING_KEY]) {
237 ret = pk_parse_keyfile(&pk, data->set.str[STRING_KEY],
238 data->set.str[STRING_KEY_PASSWD]);
239 if(ret == 0 && !pk_can_do(&pk, POLARSSL_PK_RSA))
240 ret = POLARSSL_ERR_PK_TYPE_MISMATCH;
242 rsa_copy(&connssl->rsa, pk_rsa(pk));
244 rsa_free(&connssl->rsa);
248 #ifdef POLARSSL_ERROR_C
249 error_strerror(ret, errorbuf, sizeof(errorbuf));
250 #endif /* POLARSSL_ERROR_C */
251 failf(data, "Error reading private key %s - PolarSSL: (-0x%04X) %s",
252 data->set.str[STRING_KEY], -ret, errorbuf);
254 return CURLE_SSL_CERTPROBLEM;
259 memset(&connssl->crl, 0, sizeof(x509_crl));
261 if(data->set.str[STRING_SSL_CRLFILE]) {
262 ret = x509_crl_parse_file(&connssl->crl,
263 data->set.str[STRING_SSL_CRLFILE]);
266 #ifdef POLARSSL_ERROR_C
267 error_strerror(ret, errorbuf, sizeof(errorbuf));
268 #endif /* POLARSSL_ERROR_C */
269 failf(data, "Error reading CRL file %s - PolarSSL: (-0x%04X) %s",
270 data->set.str[STRING_SSL_CRLFILE], -ret, errorbuf);
272 return CURLE_SSL_CRL_BADFILE;
276 infof(data, "PolarSSL: Connecting to %s:%d\n",
277 conn->host.name, conn->remote_port);
279 if(ssl_init(&connssl->ssl)) {
280 failf(data, "PolarSSL: ssl_init failed");
281 return CURLE_SSL_CONNECT_ERROR;
284 switch(data->set.ssl.version) {
286 case CURL_SSLVERSION_DEFAULT:
287 case CURL_SSLVERSION_TLSv1:
288 ssl_set_min_version(&connssl->ssl, SSL_MAJOR_VERSION_3,
289 SSL_MINOR_VERSION_1);
291 case CURL_SSLVERSION_SSLv3:
292 ssl_set_min_version(&connssl->ssl, SSL_MAJOR_VERSION_3,
293 SSL_MINOR_VERSION_0);
294 ssl_set_max_version(&connssl->ssl, SSL_MAJOR_VERSION_3,
295 SSL_MINOR_VERSION_0);
296 infof(data, "PolarSSL: Forced min. SSL Version to be SSLv3\n");
298 case CURL_SSLVERSION_TLSv1_0:
299 ssl_set_min_version(&connssl->ssl, SSL_MAJOR_VERSION_3,
300 SSL_MINOR_VERSION_1);
301 ssl_set_max_version(&connssl->ssl, SSL_MAJOR_VERSION_3,
302 SSL_MINOR_VERSION_1);
303 infof(data, "PolarSSL: Forced min. SSL Version to be TLS 1.0\n");
305 case CURL_SSLVERSION_TLSv1_1:
306 ssl_set_min_version(&connssl->ssl, SSL_MAJOR_VERSION_3,
307 SSL_MINOR_VERSION_2);
308 ssl_set_max_version(&connssl->ssl, SSL_MAJOR_VERSION_3,
309 SSL_MINOR_VERSION_2);
310 infof(data, "PolarSSL: Forced min. SSL Version to be TLS 1.1\n");
312 case CURL_SSLVERSION_TLSv1_2:
313 ssl_set_min_version(&connssl->ssl, SSL_MAJOR_VERSION_3,
314 SSL_MINOR_VERSION_3);
315 ssl_set_max_version(&connssl->ssl, SSL_MAJOR_VERSION_3,
316 SSL_MINOR_VERSION_3);
317 infof(data, "PolarSSL: Forced min. SSL Version to be TLS 1.2\n");
321 ssl_set_endpoint(&connssl->ssl, SSL_IS_CLIENT);
322 ssl_set_authmode(&connssl->ssl, SSL_VERIFY_OPTIONAL);
324 ssl_set_rng(&connssl->ssl, ctr_drbg_random,
326 ssl_set_bio(&connssl->ssl,
327 net_recv, &conn->sock[sockindex],
328 net_send, &conn->sock[sockindex]);
330 ssl_set_ciphersuites(&connssl->ssl, ssl_list_ciphersuites());
331 if(!Curl_ssl_getsessionid(conn, &old_session, &old_session_size)) {
332 memcpy(&connssl->ssn, old_session, old_session_size);
333 infof(data, "PolarSSL re-using session\n");
336 ssl_set_session(&connssl->ssl,
339 ssl_set_ca_chain(&connssl->ssl,
344 ssl_set_own_cert_rsa(&connssl->ssl,
345 &connssl->clicert, &connssl->rsa);
347 if(!Curl_inet_pton(AF_INET, conn->host.name, &addr) &&
349 !Curl_inet_pton(AF_INET6, conn->host.name, &addr) &&
351 sni && ssl_set_hostname(&connssl->ssl, conn->host.name)) {
352 infof(data, "WARNING: failed to configure "
353 "server name indication (SNI) TLS extension\n");
357 if(data->set.ssl_enable_alpn) {
358 static const char* protocols[3];
362 if(data->set.httpversion >= CURL_HTTP_VERSION_2) {
363 protocols[cur++] = NGHTTP2_PROTO_VERSION_ID;
364 infof(data, "ALPN, offering %s\n", NGHTTP2_PROTO_VERSION_ID);
368 protocols[cur++] = ALPN_HTTP_1_1;
369 infof(data, "ALPN, offering %s\n", ALPN_HTTP_1_1);
371 protocols[cur] = NULL;
373 ssl_set_alpn_protocols(&connssl->ssl, protocols);
377 #ifdef POLARSSL_DEBUG
378 ssl_set_dbg(&connssl->ssl, polarssl_debug, data);
381 connssl->connecting_state = ssl_connect_2;
387 polarssl_connect_step2(struct connectdata *conn,
391 struct SessionHandle *data = conn->data;
392 struct ssl_connect_data* connssl = &conn->ssl[sockindex];
398 conn->recv[sockindex] = polarssl_recv;
399 conn->send[sockindex] = polarssl_send;
401 ret = ssl_handshake(&connssl->ssl);
407 case POLARSSL_ERR_NET_WANT_READ:
408 connssl->connecting_state = ssl_connect_2_reading;
411 case POLARSSL_ERR_NET_WANT_WRITE:
412 connssl->connecting_state = ssl_connect_2_writing;
416 #ifdef POLARSSL_ERROR_C
417 error_strerror(ret, errorbuf, sizeof(errorbuf));
418 #endif /* POLARSSL_ERROR_C */
419 failf(data, "ssl_handshake returned - PolarSSL: (-0x%04X) %s",
421 return CURLE_SSL_CONNECT_ERROR;
424 infof(data, "PolarSSL: Handshake complete, cipher is %s\n",
425 ssl_get_ciphersuite(&conn->ssl[sockindex].ssl) );
427 ret = ssl_get_verify_result(&conn->ssl[sockindex].ssl);
429 if(ret && data->set.ssl.verifypeer) {
430 if(ret & BADCERT_EXPIRED)
431 failf(data, "Cert verify failed: BADCERT_EXPIRED");
433 if(ret & BADCERT_REVOKED) {
434 failf(data, "Cert verify failed: BADCERT_REVOKED");
435 return CURLE_SSL_CACERT;
438 if(ret & BADCERT_CN_MISMATCH)
439 failf(data, "Cert verify failed: BADCERT_CN_MISMATCH");
441 if(ret & BADCERT_NOT_TRUSTED)
442 failf(data, "Cert verify failed: BADCERT_NOT_TRUSTED");
444 return CURLE_PEER_FAILED_VERIFICATION;
447 if(ssl_get_peer_cert(&(connssl->ssl))) {
448 /* If the session was resumed, there will be no peer certs */
449 memset(buffer, 0, sizeof(buffer));
451 if(x509_crt_info(buffer, sizeof(buffer), (char *)"* ",
452 ssl_get_peer_cert(&(connssl->ssl))) != -1)
453 infof(data, "Dumping cert info:\n%s\n", buffer);
457 if(data->set.ssl_enable_alpn) {
458 const char *next_protocol = ssl_get_alpn_protocol(&connssl->ssl);
460 if(next_protocol != NULL) {
461 infof(data, "ALPN, server accepted to use %s\n", next_protocol);
464 if(!strncmp(next_protocol, NGHTTP2_PROTO_VERSION_ID,
465 NGHTTP2_PROTO_VERSION_ID_LEN)) {
466 conn->negnpn = CURL_HTTP_VERSION_2;
470 if(!strncmp(next_protocol, ALPN_HTTP_1_1, ALPN_HTTP_1_1_LENGTH)) {
471 conn->negnpn = CURL_HTTP_VERSION_1_1;
475 infof(data, "ALPN, server did not agree to a protocol\n");
479 connssl->connecting_state = ssl_connect_3;
480 infof(data, "SSL connected\n");
486 polarssl_connect_step3(struct connectdata *conn,
489 CURLcode result = CURLE_OK;
490 struct ssl_connect_data *connssl = &conn->ssl[sockindex];
491 struct SessionHandle *data = conn->data;
492 void *old_ssl_sessionid = NULL;
493 ssl_session *our_ssl_sessionid = &conn->ssl[sockindex].ssn;
496 DEBUGASSERT(ssl_connect_3 == connssl->connecting_state);
498 /* Save the current session data for possible re-use */
499 incache = !(Curl_ssl_getsessionid(conn, &old_ssl_sessionid, NULL));
501 if(old_ssl_sessionid != our_ssl_sessionid) {
502 infof(data, "old SSL session ID is stale, removing\n");
503 Curl_ssl_delsessionid(conn, old_ssl_sessionid);
509 void *new_session = malloc(sizeof(ssl_session));
512 memcpy(new_session, our_ssl_sessionid, sizeof(ssl_session));
514 result = Curl_ssl_addsessionid(conn, new_session, sizeof(ssl_session));
517 result = CURLE_OUT_OF_MEMORY;
520 failf(data, "failed to store ssl session");
525 connssl->connecting_state = ssl_connect_done;
530 static ssize_t polarssl_send(struct connectdata *conn,
538 ret = ssl_write(&conn->ssl[sockindex].ssl,
539 (unsigned char *)mem, len);
542 *curlcode = (ret == POLARSSL_ERR_NET_WANT_WRITE) ?
543 CURLE_AGAIN : CURLE_SEND_ERROR;
550 void Curl_polarssl_close(struct connectdata *conn, int sockindex)
552 rsa_free(&conn->ssl[sockindex].rsa);
553 x509_crt_free(&conn->ssl[sockindex].clicert);
554 x509_crt_free(&conn->ssl[sockindex].cacert);
555 x509_crl_free(&conn->ssl[sockindex].crl);
556 ssl_free(&conn->ssl[sockindex].ssl);
559 static ssize_t polarssl_recv(struct connectdata *conn,
568 memset(buf, 0, buffersize);
569 ret = ssl_read(&conn->ssl[num].ssl, (unsigned char *)buf, buffersize);
572 if(ret == POLARSSL_ERR_SSL_PEER_CLOSE_NOTIFY)
575 *curlcode = (ret == POLARSSL_ERR_NET_WANT_READ) ?
576 CURLE_AGAIN : CURLE_RECV_ERROR;
585 void Curl_polarssl_session_free(void *ptr)
590 /* 1.3.10 was the first rebranded version. All new releases (in 1.3 branch and
591 higher) will be mbed TLS branded.. */
593 size_t Curl_polarssl_version(char *buffer, size_t size)
595 unsigned int version = version_get_number();
596 return snprintf(buffer, size, "%s/%d.%d.%d",
597 version >= 0x01030A00?"mbedTLS":"PolarSSL",
598 version>>24, (version>>16)&0xff, (version>>8)&0xff);
602 polarssl_connect_common(struct connectdata *conn,
608 struct SessionHandle *data = conn->data;
609 struct ssl_connect_data *connssl = &conn->ssl[sockindex];
610 curl_socket_t sockfd = conn->sock[sockindex];
614 /* check if the connection has already been established */
615 if(ssl_connection_complete == connssl->state) {
620 if(ssl_connect_1 == connssl->connecting_state) {
621 /* Find out how much more time we're allowed */
622 timeout_ms = Curl_timeleft(data, NULL, TRUE);
625 /* no need to continue if time already is up */
626 failf(data, "SSL connection timeout");
627 return CURLE_OPERATION_TIMEDOUT;
630 result = polarssl_connect_step1(conn, sockindex);
635 while(ssl_connect_2 == connssl->connecting_state ||
636 ssl_connect_2_reading == connssl->connecting_state ||
637 ssl_connect_2_writing == connssl->connecting_state) {
639 /* check allowed time left */
640 timeout_ms = Curl_timeleft(data, NULL, TRUE);
643 /* no need to continue if time already is up */
644 failf(data, "SSL connection timeout");
645 return CURLE_OPERATION_TIMEDOUT;
648 /* if ssl is expecting something, check if it's available. */
649 if(connssl->connecting_state == ssl_connect_2_reading ||
650 connssl->connecting_state == ssl_connect_2_writing) {
652 curl_socket_t writefd = ssl_connect_2_writing==
653 connssl->connecting_state?sockfd:CURL_SOCKET_BAD;
654 curl_socket_t readfd = ssl_connect_2_reading==
655 connssl->connecting_state?sockfd:CURL_SOCKET_BAD;
657 what = Curl_socket_ready(readfd, writefd, nonblocking?0:timeout_ms);
660 failf(data, "select/poll on SSL socket, errno: %d", SOCKERRNO);
661 return CURLE_SSL_CONNECT_ERROR;
670 failf(data, "SSL connection timeout");
671 return CURLE_OPERATION_TIMEDOUT;
674 /* socket is readable or writable */
677 /* Run transaction, and return to the caller if it failed or if
678 * this connection is part of a multi handle and this loop would
679 * execute again. This permits the owner of a multi handle to
680 * abort a connection attempt before step2 has completed while
681 * ensuring that a client using select() or epoll() will always
682 * have a valid fdset to wait on.
684 result = polarssl_connect_step2(conn, sockindex);
685 if(result || (nonblocking &&
686 (ssl_connect_2 == connssl->connecting_state ||
687 ssl_connect_2_reading == connssl->connecting_state ||
688 ssl_connect_2_writing == connssl->connecting_state)))
691 } /* repeat step2 until all transactions are done. */
693 if(ssl_connect_3 == connssl->connecting_state) {
694 result = polarssl_connect_step3(conn, sockindex);
699 if(ssl_connect_done == connssl->connecting_state) {
700 connssl->state = ssl_connection_complete;
701 conn->recv[sockindex] = polarssl_recv;
702 conn->send[sockindex] = polarssl_send;
708 /* Reset our connect state machine */
709 connssl->connecting_state = ssl_connect_1;
715 Curl_polarssl_connect_nonblocking(struct connectdata *conn,
719 return polarssl_connect_common(conn, sockindex, TRUE, done);
724 Curl_polarssl_connect(struct connectdata *conn,
730 result = polarssl_connect_common(conn, sockindex, FALSE, &done);
740 * return 0 error initializing SSL
741 * return 1 SSL initialized successfully
743 int Curl_polarssl_init(void)
745 return Curl_polarsslthreadlock_thread_setup();
748 void Curl_polarssl_cleanup(void)
750 (void)Curl_polarsslthreadlock_thread_cleanup();
753 #endif /* USE_POLARSSL */