1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 2010 - 2011, Hoi-Ho Chan, <hoiho.chan@gmail.com>
9 * Copyright (C) 2012 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
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 http://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"
59 #define _MPRINTF_REPLACE /* use our functions only */
60 #include <curl/mprintf.h>
61 #include "curl_memory.h"
62 /* The last #include file should be: */
65 /* apply threading? */
66 #if defined(USE_THREADS_POSIX) || defined(USE_THREADS_WIN32)
67 #define THREADING_SUPPORT
70 #if defined(THREADING_SUPPORT)
71 static entropy_context entropy;
73 static int entropy_init_initialized = 0;
75 /* start of entropy_init_mutex() */
76 static void entropy_init_mutex(entropy_context *ctx)
78 /* lock 0 = entropy_init_mutex() */
79 polarsslthreadlock_lock_function(0);
80 if(entropy_init_initialized == 0) {
82 entropy_init_initialized = 1;
84 polarsslthreadlock_unlock_function(0);
86 /* end of entropy_init_mutex() */
88 /* start of entropy_func_mutex() */
89 static int entropy_func_mutex(void *data, unsigned char *output, size_t len)
92 /* lock 1 = entropy_func_mutex() */
93 polarsslthreadlock_lock_function(1);
94 ret = entropy_func(data, output, len);
95 polarsslthreadlock_unlock_function(1);
99 /* end of entropy_func_mutex() */
101 #endif /* THREADING_SUPPORT */
103 /* Define this to enable lots of debugging for PolarSSL */
104 #undef POLARSSL_DEBUG
106 #ifdef POLARSSL_DEBUG
107 static void polarssl_debug(void *context, int level, const char *line)
109 struct SessionHandle *data = NULL;
114 data = (struct SessionHandle *)context;
116 infof(data, "%s", line);
122 /* ALPN for http2? */
125 # ifdef POLARSSL_SSL_ALPN
130 static Curl_recv polarssl_recv;
131 static Curl_send polarssl_send;
135 polarssl_connect_step1(struct connectdata *conn,
138 struct SessionHandle *data = conn->data;
139 struct ssl_connect_data* connssl = &conn->ssl[sockindex];
141 bool sni = TRUE; /* default is SNI enabled */
144 struct in6_addr addr;
148 void *old_session = NULL;
149 size_t old_session_size = 0;
153 /* PolarSSL only supports SSLv3 and TLSv1 */
154 if(data->set.ssl.version == CURL_SSLVERSION_SSLv2) {
155 failf(data, "PolarSSL does not support SSLv2");
156 return CURLE_SSL_CONNECT_ERROR;
158 else if(data->set.ssl.version == CURL_SSLVERSION_SSLv3)
159 sni = FALSE; /* SSLv3 has no SNI */
161 #ifdef THREADING_SUPPORT
162 entropy_init_mutex(&entropy);
164 if((ret = ctr_drbg_init(&connssl->ctr_drbg, entropy_func_mutex, &entropy,
165 connssl->ssn.id, connssl->ssn.length)) != 0) {
166 #ifdef POLARSSL_ERROR_C
167 error_strerror(ret, errorbuf, sizeof(errorbuf));
168 #endif /* POLARSSL_ERROR_C */
169 failf(data, "Failed - PolarSSL: ctr_drbg_init returned (-0x%04X) %s\n",
173 entropy_init(&connssl->entropy);
175 if((ret = ctr_drbg_init(&connssl->ctr_drbg, entropy_func, &connssl->entropy,
176 connssl->ssn.id, connssl->ssn.length)) != 0) {
177 #ifdef POLARSSL_ERROR_C
178 error_strerror(ret, errorbuf, sizeof(errorbuf));
179 #endif /* POLARSSL_ERROR_C */
180 failf(data, "Failed - PolarSSL: ctr_drbg_init returned (-0x%04X) %s\n",
183 #endif /* THREADING_SUPPORT */
185 /* Load the trusted CA */
186 memset(&connssl->cacert, 0, sizeof(x509_crt));
188 if(data->set.str[STRING_SSL_CAFILE]) {
189 ret = x509_crt_parse_file(&connssl->cacert,
190 data->set.str[STRING_SSL_CAFILE]);
193 #ifdef POLARSSL_ERROR_C
194 error_strerror(ret, errorbuf, sizeof(errorbuf));
195 #endif /* POLARSSL_ERROR_C */
196 failf(data, "Error reading ca cert file %s - PolarSSL: (-0x%04X) %s",
197 data->set.str[STRING_SSL_CAFILE], -ret, errorbuf);
199 if(data->set.ssl.verifypeer)
200 return CURLE_SSL_CACERT_BADFILE;
204 if(data->set.str[STRING_SSL_CAPATH]) {
205 ret = x509_crt_parse_path(&connssl->cacert,
206 data->set.str[STRING_SSL_CAPATH]);
209 #ifdef POLARSSL_ERROR_C
210 error_strerror(ret, errorbuf, sizeof(errorbuf));
211 #endif /* POLARSSL_ERROR_C */
212 failf(data, "Error reading ca cert path %s - PolarSSL: (-0x%04X) %s",
213 data->set.str[STRING_SSL_CAPATH], -ret, errorbuf);
215 if(data->set.ssl.verifypeer)
216 return CURLE_SSL_CACERT_BADFILE;
220 /* Load the client certificate */
221 memset(&connssl->clicert, 0, sizeof(x509_crt));
223 if(data->set.str[STRING_CERT]) {
224 ret = x509_crt_parse_file(&connssl->clicert,
225 data->set.str[STRING_CERT]);
228 #ifdef POLARSSL_ERROR_C
229 error_strerror(ret, errorbuf, sizeof(errorbuf));
230 #endif /* POLARSSL_ERROR_C */
231 failf(data, "Error reading client cert file %s - PolarSSL: (-0x%04X) %s",
232 data->set.str[STRING_CERT], -ret, errorbuf);
234 return CURLE_SSL_CERTPROBLEM;
238 /* Load the client private key */
239 if(data->set.str[STRING_KEY]) {
242 ret = pk_parse_keyfile(&pk, data->set.str[STRING_KEY],
243 data->set.str[STRING_KEY_PASSWD]);
244 if(ret == 0 && !pk_can_do(&pk, POLARSSL_PK_RSA))
245 ret = POLARSSL_ERR_PK_TYPE_MISMATCH;
247 rsa_copy(&connssl->rsa, pk_rsa(pk));
249 rsa_free(&connssl->rsa);
253 #ifdef POLARSSL_ERROR_C
254 error_strerror(ret, errorbuf, sizeof(errorbuf));
255 #endif /* POLARSSL_ERROR_C */
256 failf(data, "Error reading private key %s - PolarSSL: (-0x%04X) %s",
257 data->set.str[STRING_KEY], -ret, errorbuf);
259 return CURLE_SSL_CERTPROBLEM;
264 memset(&connssl->crl, 0, sizeof(x509_crl));
266 if(data->set.str[STRING_SSL_CRLFILE]) {
267 ret = x509_crl_parse_file(&connssl->crl,
268 data->set.str[STRING_SSL_CRLFILE]);
271 #ifdef POLARSSL_ERROR_C
272 error_strerror(ret, errorbuf, sizeof(errorbuf));
273 #endif /* POLARSSL_ERROR_C */
274 failf(data, "Error reading CRL file %s - PolarSSL: (-0x%04X) %s",
275 data->set.str[STRING_SSL_CRLFILE], -ret, errorbuf);
277 return CURLE_SSL_CRL_BADFILE;
281 infof(data, "PolarSSL: Connecting to %s:%d\n",
282 conn->host.name, conn->remote_port);
284 if(ssl_init(&connssl->ssl)) {
285 failf(data, "PolarSSL: ssl_init failed");
286 return CURLE_SSL_CONNECT_ERROR;
289 switch(data->set.ssl.version) {
291 case CURL_SSLVERSION_DEFAULT:
292 ssl_set_min_version(&connssl->ssl, SSL_MAJOR_VERSION_3,
293 SSL_MINOR_VERSION_1);
295 case CURL_SSLVERSION_SSLv3:
296 ssl_set_min_version(&connssl->ssl, SSL_MAJOR_VERSION_3,
297 SSL_MINOR_VERSION_0);
298 infof(data, "PolarSSL: Forced min. SSL Version to be SSLv3\n");
300 case CURL_SSLVERSION_TLSv1_0:
301 ssl_set_min_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 infof(data, "PolarSSL: Forced min. SSL Version to be TLS 1.1\n");
310 case CURL_SSLVERSION_TLSv1_2:
311 ssl_set_min_version(&connssl->ssl, SSL_MAJOR_VERSION_3,
312 SSL_MINOR_VERSION_3);
313 infof(data, "PolarSSL: Forced min. SSL Version to be TLS 1.2\n");
317 ssl_set_endpoint(&connssl->ssl, SSL_IS_CLIENT);
318 ssl_set_authmode(&connssl->ssl, SSL_VERIFY_OPTIONAL);
320 ssl_set_rng(&connssl->ssl, ctr_drbg_random,
322 ssl_set_bio(&connssl->ssl,
323 net_recv, &conn->sock[sockindex],
324 net_send, &conn->sock[sockindex]);
326 ssl_set_ciphersuites(&connssl->ssl, ssl_list_ciphersuites());
327 if(!Curl_ssl_getsessionid(conn, &old_session, &old_session_size)) {
328 memcpy(&connssl->ssn, old_session, old_session_size);
329 infof(data, "PolarSSL re-using session\n");
332 ssl_set_session(&connssl->ssl,
335 ssl_set_ca_chain(&connssl->ssl,
340 ssl_set_own_cert_rsa(&connssl->ssl,
341 &connssl->clicert, &connssl->rsa);
343 if(!Curl_inet_pton(AF_INET, conn->host.name, &addr) &&
345 !Curl_inet_pton(AF_INET6, conn->host.name, &addr) &&
347 sni && ssl_set_hostname(&connssl->ssl, conn->host.name)) {
348 infof(data, "WARNING: failed to configure "
349 "server name indication (SNI) TLS extension\n");
353 if(data->set.httpversion == CURL_HTTP_VERSION_2_0) {
354 if(data->set.ssl_enable_alpn) {
355 static const char* protocols[] = {
356 NGHTTP2_PROTO_VERSION_ID, ALPN_HTTP_1_1, NULL
358 ssl_set_alpn_protocols(&connssl->ssl, protocols);
359 infof(data, "ALPN, offering %s, %s\n", protocols[0],
361 connssl->asked_for_h2 = TRUE;
366 #ifdef POLARSSL_DEBUG
367 ssl_set_dbg(&connssl->ssl, polarssl_debug, data);
370 connssl->connecting_state = ssl_connect_2;
376 polarssl_connect_step2(struct connectdata *conn,
380 struct SessionHandle *data = conn->data;
381 struct ssl_connect_data* connssl = &conn->ssl[sockindex];
385 const char* next_protocol;
391 conn->recv[sockindex] = polarssl_recv;
392 conn->send[sockindex] = polarssl_send;
395 if(!(ret = ssl_handshake(&connssl->ssl)))
397 else if(ret != POLARSSL_ERR_NET_WANT_READ &&
398 ret != POLARSSL_ERR_NET_WANT_WRITE) {
399 #ifdef POLARSSL_ERROR_C
400 error_strerror(ret, errorbuf, sizeof(errorbuf));
401 #endif /* POLARSSL_ERROR_C */
402 failf(data, "ssl_handshake returned - PolarSSL: (-0x%04X) %s",
405 return CURLE_SSL_CONNECT_ERROR;
408 if(ret == POLARSSL_ERR_NET_WANT_READ) {
409 connssl->connecting_state = ssl_connect_2_reading;
412 if(ret == POLARSSL_ERR_NET_WANT_WRITE) {
413 connssl->connecting_state = ssl_connect_2_writing;
416 failf(data, "SSL_connect failed with error %d.", ret);
417 return CURLE_SSL_CONNECT_ERROR;
422 infof(data, "PolarSSL: Handshake complete, cipher is %s\n",
423 ssl_get_ciphersuite(&conn->ssl[sockindex].ssl)
426 ret = ssl_get_verify_result(&conn->ssl[sockindex].ssl);
428 if(ret && data->set.ssl.verifypeer) {
429 if(ret & BADCERT_EXPIRED)
430 failf(data, "Cert verify failed: BADCERT_EXPIRED");
432 if(ret & BADCERT_REVOKED) {
433 failf(data, "Cert verify failed: BADCERT_REVOKED");
434 return CURLE_SSL_CACERT;
437 if(ret & BADCERT_CN_MISMATCH)
438 failf(data, "Cert verify failed: BADCERT_CN_MISMATCH");
440 if(ret & BADCERT_NOT_TRUSTED)
441 failf(data, "Cert verify failed: BADCERT_NOT_TRUSTED");
443 return CURLE_PEER_FAILED_VERIFICATION;
446 if(ssl_get_peer_cert(&(connssl->ssl))) {
447 /* If the session was resumed, there will be no peer certs */
448 memset(buffer, 0, sizeof(buffer));
450 if(x509_crt_info(buffer, sizeof(buffer), (char *)"* ",
451 ssl_get_peer_cert(&(connssl->ssl))) != -1)
452 infof(data, "Dumping cert info:\n%s\n", buffer);
456 if(data->set.ssl_enable_alpn) {
457 next_protocol = ssl_get_alpn_protocol(&connssl->ssl);
459 if(next_protocol != NULL) {
460 infof(data, "ALPN, server accepted to use %s\n", next_protocol);
462 if(strncmp(next_protocol, NGHTTP2_PROTO_VERSION_ID,
463 NGHTTP2_PROTO_VERSION_ID_LEN)) {
464 conn->negnpn = NPN_HTTP2;
466 else if(strncmp(next_protocol, ALPN_HTTP_1_1, ALPN_HTTP_1_1_LENGTH)) {
467 conn->negnpn = NPN_HTTP1_1;
470 else if(connssl->asked_for_h2) {
471 infof(data, "ALPN, server did not agree to a protocol\n");
476 connssl->connecting_state = ssl_connect_3;
477 infof(data, "SSL connected\n");
483 polarssl_connect_step3(struct connectdata *conn,
486 CURLcode result = CURLE_OK;
487 struct ssl_connect_data *connssl = &conn->ssl[sockindex];
488 struct SessionHandle *data = conn->data;
489 void *old_ssl_sessionid = NULL;
490 ssl_session *our_ssl_sessionid = &conn->ssl[sockindex].ssn ;
493 DEBUGASSERT(ssl_connect_3 == connssl->connecting_state);
495 /* Save the current session data for possible re-use */
496 incache = !(Curl_ssl_getsessionid(conn, &old_ssl_sessionid, NULL));
498 if(old_ssl_sessionid != our_ssl_sessionid) {
499 infof(data, "old SSL session ID is stale, removing\n");
500 Curl_ssl_delsessionid(conn, old_ssl_sessionid);
506 void *new_session = malloc(sizeof(ssl_session));
509 memcpy(new_session, our_ssl_sessionid, sizeof(ssl_session));
511 result = Curl_ssl_addsessionid(conn, new_session, sizeof(ssl_session));
514 result = CURLE_OUT_OF_MEMORY;
517 failf(data, "failed to store ssl session");
522 connssl->connecting_state = ssl_connect_done;
527 static ssize_t polarssl_send(struct connectdata *conn,
535 ret = ssl_write(&conn->ssl[sockindex].ssl,
536 (unsigned char *)mem, len);
539 *curlcode = (ret == POLARSSL_ERR_NET_WANT_WRITE) ?
540 CURLE_AGAIN : CURLE_SEND_ERROR;
547 void Curl_polarssl_close_all(struct SessionHandle *data)
552 void Curl_polarssl_close(struct connectdata *conn, int sockindex)
554 rsa_free(&conn->ssl[sockindex].rsa);
555 x509_crt_free(&conn->ssl[sockindex].clicert);
556 x509_crt_free(&conn->ssl[sockindex].cacert);
557 x509_crl_free(&conn->ssl[sockindex].crl);
558 ssl_free(&conn->ssl[sockindex].ssl);
561 static ssize_t polarssl_recv(struct connectdata *conn,
570 memset(buf, 0, buffersize);
571 ret = ssl_read(&conn->ssl[num].ssl, (unsigned char *)buf, buffersize);
574 if(ret == POLARSSL_ERR_SSL_PEER_CLOSE_NOTIFY)
577 *curlcode = (ret == POLARSSL_ERR_NET_WANT_READ) ?
578 CURLE_AGAIN : CURLE_RECV_ERROR;
587 void Curl_polarssl_session_free(void *ptr)
592 size_t Curl_polarssl_version(char *buffer, size_t size)
594 unsigned int version = version_get_number();
595 return snprintf(buffer, size, "PolarSSL/%d.%d.%d", version>>24,
596 (version>>16)&0xff, (version>>8)&0xff);
600 polarssl_connect_common(struct connectdata *conn,
606 struct SessionHandle *data = conn->data;
607 struct ssl_connect_data *connssl = &conn->ssl[sockindex];
608 curl_socket_t sockfd = conn->sock[sockindex];
612 /* check if the connection has already been established */
613 if(ssl_connection_complete == connssl->state) {
618 if(ssl_connect_1 == connssl->connecting_state) {
619 /* Find out how much more time we're allowed */
620 timeout_ms = Curl_timeleft(data, NULL, TRUE);
623 /* no need to continue if time already is up */
624 failf(data, "SSL connection timeout");
625 return CURLE_OPERATION_TIMEDOUT;
628 result = polarssl_connect_step1(conn, sockindex);
633 while(ssl_connect_2 == connssl->connecting_state ||
634 ssl_connect_2_reading == connssl->connecting_state ||
635 ssl_connect_2_writing == connssl->connecting_state) {
637 /* check allowed time left */
638 timeout_ms = Curl_timeleft(data, NULL, TRUE);
641 /* no need to continue if time already is up */
642 failf(data, "SSL connection timeout");
643 return CURLE_OPERATION_TIMEDOUT;
646 /* if ssl is expecting something, check if it's available. */
647 if(connssl->connecting_state == ssl_connect_2_reading ||
648 connssl->connecting_state == ssl_connect_2_writing) {
650 curl_socket_t writefd = ssl_connect_2_writing==
651 connssl->connecting_state?sockfd:CURL_SOCKET_BAD;
652 curl_socket_t readfd = ssl_connect_2_reading==
653 connssl->connecting_state?sockfd:CURL_SOCKET_BAD;
655 what = Curl_socket_ready(readfd, writefd, nonblocking?0:timeout_ms);
658 failf(data, "select/poll on SSL socket, errno: %d", SOCKERRNO);
659 return CURLE_SSL_CONNECT_ERROR;
668 failf(data, "SSL connection timeout");
669 return CURLE_OPERATION_TIMEDOUT;
672 /* socket is readable or writable */
675 /* Run transaction, and return to the caller if it failed or if
676 * this connection is part of a multi handle and this loop would
677 * execute again. This permits the owner of a multi handle to
678 * abort a connection attempt before step2 has completed while
679 * ensuring that a client using select() or epoll() will always
680 * have a valid fdset to wait on.
682 result = polarssl_connect_step2(conn, sockindex);
683 if(result || (nonblocking &&
684 (ssl_connect_2 == connssl->connecting_state ||
685 ssl_connect_2_reading == connssl->connecting_state ||
686 ssl_connect_2_writing == connssl->connecting_state)))
689 } /* repeat step2 until all transactions are done. */
691 if(ssl_connect_3 == connssl->connecting_state) {
692 result = polarssl_connect_step3(conn, sockindex);
697 if(ssl_connect_done == connssl->connecting_state) {
698 connssl->state = ssl_connection_complete;
699 conn->recv[sockindex] = polarssl_recv;
700 conn->send[sockindex] = polarssl_send;
706 /* Reset our connect state machine */
707 connssl->connecting_state = ssl_connect_1;
713 Curl_polarssl_connect_nonblocking(struct connectdata *conn,
717 return polarssl_connect_common(conn, sockindex, TRUE, done);
722 Curl_polarssl_connect(struct connectdata *conn,
728 result = polarssl_connect_common(conn, sockindex, FALSE, &done);
738 * return 0 error initializing SSL
739 * return 1 SSL initialized successfully
741 int polarssl_init(void)
743 return polarsslthreadlock_thread_setup();
746 void polarssl_cleanup(void)
748 (void)polarsslthreadlock_thread_cleanup();
751 #endif /* USE_POLARSSL */