1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
10 * This software is licensed as described in the file COPYING, which
11 * you should have received as part of this distribution. The terms
12 * are also available at https://curl.se/docs/copyright.html.
14 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 * copies of the Software, and permit persons to whom the Software is
16 * furnished to do so, under the terms of the COPYING file.
18 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 * KIND, either express or implied.
21 ***************************************************************************/
23 /* This file is for implementing all "generic" SSL functions that all libcurl
24 internals should use. It is then responsible for calling the proper
27 SSL-functions in libcurl should call functions in this source file, and not
28 to any specific SSL-layer.
30 Curl_ssl_ - prefix for generic ones
32 Note that this source code uses the functions of the configured SSL
33 backend via the global Curl_ssl instance.
35 "SSL/TLS Strong Encryption: An Introduction"
36 https://httpd.apache.org/docs/2.0/ssl/ssl_intro.html
39 #include "curl_setup.h"
41 #ifdef HAVE_SYS_TYPES_H
42 #include <sys/types.h>
44 #ifdef HAVE_SYS_STAT_H
53 #include "vtls.h" /* generic SSL protos etc */
64 #include "curl_base64.h"
65 #include "curl_printf.h"
68 /* The last #include files should be: */
69 #include "curl_memory.h"
72 /* convenience macro to check if this handle is using a shared SSL session */
73 #define SSLSESSION_SHARED(data) (data->share && \
74 (data->share->specifier & \
75 (1<<CURL_LOCK_DATA_SSL_SESSION)))
77 #define CLONE_STRING(var) \
80 dest->var = strdup(source->var); \
88 #define CLONE_BLOB(var) \
90 if(blobdup(&dest->var, source->var)) \
94 static CURLcode blobdup(struct curl_blob **dest,
95 struct curl_blob *src)
100 /* only if there's data to dupe! */
102 d = malloc(sizeof(struct curl_blob) + src->len);
104 return CURLE_OUT_OF_MEMORY;
106 /* Always duplicate because the connection may survive longer than the
107 handle that passed in the blob. */
108 d->flags = CURL_BLOB_COPY;
109 d->data = (void *)((char *)d + sizeof(struct curl_blob));
110 memcpy(d->data, src->data, src->len);
116 /* returns TRUE if the blobs are identical */
117 static bool blobcmp(struct curl_blob *first, struct curl_blob *second)
119 if(!first && !second) /* both are NULL */
121 if(!first || !second) /* one is NULL */
123 if(first->len != second->len) /* different sizes */
125 return !memcmp(first->data, second->data, first->len); /* same data */
130 Curl_ssl_config_matches(struct ssl_primary_config *data,
131 struct ssl_primary_config *needle)
133 if((data->version == needle->version) &&
134 (data->version_max == needle->version_max) &&
135 (data->ssl_options == needle->ssl_options) &&
136 (data->verifypeer == needle->verifypeer) &&
137 (data->verifyhost == needle->verifyhost) &&
138 (data->verifystatus == needle->verifystatus) &&
139 blobcmp(data->cert_blob, needle->cert_blob) &&
140 blobcmp(data->ca_info_blob, needle->ca_info_blob) &&
141 blobcmp(data->issuercert_blob, needle->issuercert_blob) &&
142 Curl_safecmp(data->CApath, needle->CApath) &&
143 Curl_safecmp(data->CAfile, needle->CAfile) &&
144 Curl_safecmp(data->issuercert, needle->issuercert) &&
145 Curl_safecmp(data->clientcert, needle->clientcert) &&
146 Curl_safecmp(data->random_file, needle->random_file) &&
147 Curl_safecmp(data->egdsocket, needle->egdsocket) &&
149 Curl_safecmp(data->username, needle->username) &&
150 Curl_safecmp(data->password, needle->password) &&
151 (data->authtype == needle->authtype) &&
153 Curl_safe_strcasecompare(data->cipher_list, needle->cipher_list) &&
154 Curl_safe_strcasecompare(data->cipher_list13, needle->cipher_list13) &&
155 Curl_safe_strcasecompare(data->curves, needle->curves) &&
156 Curl_safe_strcasecompare(data->CRLfile, needle->CRLfile) &&
157 Curl_safe_strcasecompare(data->pinned_key, needle->pinned_key))
164 Curl_clone_primary_ssl_config(struct ssl_primary_config *source,
165 struct ssl_primary_config *dest)
167 dest->version = source->version;
168 dest->version_max = source->version_max;
169 dest->verifypeer = source->verifypeer;
170 dest->verifyhost = source->verifyhost;
171 dest->verifystatus = source->verifystatus;
172 dest->sessionid = source->sessionid;
173 dest->ssl_options = source->ssl_options;
175 dest->authtype = source->authtype;
178 CLONE_BLOB(cert_blob);
179 CLONE_BLOB(ca_info_blob);
180 CLONE_BLOB(issuercert_blob);
181 CLONE_STRING(CApath);
182 CLONE_STRING(CAfile);
183 CLONE_STRING(issuercert);
184 CLONE_STRING(clientcert);
185 CLONE_STRING(random_file);
186 CLONE_STRING(egdsocket);
187 CLONE_STRING(cipher_list);
188 CLONE_STRING(cipher_list13);
189 CLONE_STRING(pinned_key);
190 CLONE_STRING(curves);
191 CLONE_STRING(CRLfile);
193 CLONE_STRING(username);
194 CLONE_STRING(password);
200 void Curl_free_primary_ssl_config(struct ssl_primary_config *sslc)
202 Curl_safefree(sslc->CApath);
203 Curl_safefree(sslc->CAfile);
204 Curl_safefree(sslc->issuercert);
205 Curl_safefree(sslc->clientcert);
206 Curl_safefree(sslc->random_file);
207 Curl_safefree(sslc->egdsocket);
208 Curl_safefree(sslc->cipher_list);
209 Curl_safefree(sslc->cipher_list13);
210 Curl_safefree(sslc->pinned_key);
211 Curl_safefree(sslc->cert_blob);
212 Curl_safefree(sslc->ca_info_blob);
213 Curl_safefree(sslc->issuercert_blob);
214 Curl_safefree(sslc->curves);
215 Curl_safefree(sslc->CRLfile);
217 Curl_safefree(sslc->username);
218 Curl_safefree(sslc->password);
223 static int multissl_setup(const struct Curl_ssl *backend);
226 int Curl_ssl_backend(void)
229 multissl_setup(NULL);
230 return Curl_ssl->info.id;
232 return (int)CURLSSLBACKEND_NONE;
238 /* "global" init done? */
239 static bool init_ssl = FALSE;
244 * @retval 0 error initializing SSL
245 * @retval 1 SSL initialized successfully
247 int Curl_ssl_init(void)
249 /* make sure this is only done once */
252 init_ssl = TRUE; /* never again */
254 return Curl_ssl->init();
257 #if defined(CURL_WITH_MULTI_SSL)
258 static const struct Curl_ssl Curl_ssl_multi;
262 void Curl_ssl_cleanup(void)
265 /* only cleanup if we did a previous init */
267 #if defined(CURL_WITH_MULTI_SSL)
268 Curl_ssl = &Curl_ssl_multi;
274 static bool ssl_prefs_check(struct Curl_easy *data)
276 /* check for CURLOPT_SSLVERSION invalid parameter value */
277 const long sslver = data->set.ssl.primary.version;
278 if((sslver < 0) || (sslver >= CURL_SSLVERSION_LAST)) {
279 failf(data, "Unrecognized parameter value passed via CURLOPT_SSLVERSION");
283 switch(data->set.ssl.primary.version_max) {
284 case CURL_SSLVERSION_MAX_NONE:
285 case CURL_SSLVERSION_MAX_DEFAULT:
289 if((data->set.ssl.primary.version_max >> 16) < sslver) {
290 failf(data, "CURL_SSLVERSION_MAX incompatible with CURL_SSLVERSION");
298 #ifndef CURL_DISABLE_PROXY
300 ssl_connect_init_proxy(struct connectdata *conn, int sockindex)
302 DEBUGASSERT(conn->bits.proxy_ssl_connected[sockindex]);
303 if(ssl_connection_complete == conn->ssl[sockindex].state &&
304 !conn->proxy_ssl[sockindex].use) {
305 struct ssl_backend_data *pbdata;
307 if(!(Curl_ssl->supports & SSLSUPP_HTTPS_PROXY))
308 return CURLE_NOT_BUILT_IN;
310 /* The pointers to the ssl backend data, which is opaque here, are swapped
311 rather than move the contents. */
312 pbdata = conn->proxy_ssl[sockindex].backend;
313 conn->proxy_ssl[sockindex] = conn->ssl[sockindex];
315 DEBUGASSERT(pbdata != NULL);
317 memset(&conn->ssl[sockindex], 0, sizeof(conn->ssl[sockindex]));
318 memset(pbdata, 0, Curl_ssl->sizeof_ssl_backend_data);
320 conn->ssl[sockindex].backend = pbdata;
327 Curl_ssl_connect(struct Curl_easy *data, struct connectdata *conn,
332 #ifndef CURL_DISABLE_PROXY
333 if(conn->bits.proxy_ssl_connected[sockindex]) {
334 result = ssl_connect_init_proxy(conn, sockindex);
340 if(!ssl_prefs_check(data))
341 return CURLE_SSL_CONNECT_ERROR;
343 /* mark this is being ssl-enabled from here on. */
344 conn->ssl[sockindex].use = TRUE;
345 conn->ssl[sockindex].state = ssl_connection_negotiating;
347 result = Curl_ssl->connect_blocking(data, conn, sockindex);
350 Curl_pgrsTime(data, TIMER_APPCONNECT); /* SSL is connected */
352 conn->ssl[sockindex].use = FALSE;
358 Curl_ssl_connect_nonblocking(struct Curl_easy *data, struct connectdata *conn,
359 bool isproxy, int sockindex, bool *done)
363 #ifndef CURL_DISABLE_PROXY
364 if(conn->bits.proxy_ssl_connected[sockindex]) {
365 result = ssl_connect_init_proxy(conn, sockindex);
370 if(!ssl_prefs_check(data))
371 return CURLE_SSL_CONNECT_ERROR;
373 /* mark this is being ssl requested from here on. */
374 conn->ssl[sockindex].use = TRUE;
375 result = Curl_ssl->connect_nonblocking(data, conn, sockindex, done);
377 conn->ssl[sockindex].use = FALSE;
378 else if(*done && !isproxy)
379 Curl_pgrsTime(data, TIMER_APPCONNECT); /* SSL is connected */
384 * Lock shared SSL session data
386 void Curl_ssl_sessionid_lock(struct Curl_easy *data)
388 if(SSLSESSION_SHARED(data))
389 Curl_share_lock(data, CURL_LOCK_DATA_SSL_SESSION, CURL_LOCK_ACCESS_SINGLE);
393 * Unlock shared SSL session data
395 void Curl_ssl_sessionid_unlock(struct Curl_easy *data)
397 if(SSLSESSION_SHARED(data))
398 Curl_share_unlock(data, CURL_LOCK_DATA_SSL_SESSION);
402 * Check if there's a session ID for the given connection in the cache, and if
403 * there's one suitable, it is provided. Returns TRUE when no entry matched.
405 bool Curl_ssl_getsessionid(struct Curl_easy *data,
406 struct connectdata *conn,
408 void **ssl_sessionid,
409 size_t *idsize, /* set 0 if unknown */
412 struct Curl_ssl_session *check;
415 bool no_match = TRUE;
417 #ifndef CURL_DISABLE_PROXY
418 struct ssl_primary_config * const ssl_config = isProxy ?
419 &conn->proxy_ssl_config :
421 const char * const name = isProxy ?
422 conn->http_proxy.host.name : conn->host.name;
423 int port = isProxy ? (int)conn->port : conn->remote_port;
425 /* no proxy support */
426 struct ssl_primary_config * const ssl_config = &conn->ssl_config;
427 const char * const name = conn->host.name;
428 int port = conn->remote_port;
431 *ssl_sessionid = NULL;
433 #ifdef CURL_DISABLE_PROXY
438 DEBUGASSERT(SSL_SET_OPTION(primary.sessionid));
440 if(!SSL_SET_OPTION(primary.sessionid) || !data->state.session)
441 /* session ID re-use is disabled or the session cache has not been
446 if(SSLSESSION_SHARED(data))
447 general_age = &data->share->sessionage;
449 general_age = &data->state.sessionage;
451 for(i = 0; i < data->set.general_ssl.max_ssl_sessions; i++) {
452 check = &data->state.session[i];
453 if(!check->sessionid)
454 /* not session ID means blank entry */
456 if(strcasecompare(name, check->name) &&
457 ((!conn->bits.conn_to_host && !check->conn_to_host) ||
458 (conn->bits.conn_to_host && check->conn_to_host &&
459 strcasecompare(conn->conn_to_host.name, check->conn_to_host))) &&
460 ((!conn->bits.conn_to_port && check->conn_to_port == -1) ||
461 (conn->bits.conn_to_port && check->conn_to_port != -1 &&
462 conn->conn_to_port == check->conn_to_port)) &&
463 (port == check->remote_port) &&
464 strcasecompare(conn->handler->scheme, check->scheme) &&
465 Curl_ssl_config_matches(ssl_config, &check->ssl_config)) {
466 /* yes, we have a session ID! */
467 (*general_age)++; /* increase general age */
468 check->age = *general_age; /* set this as used in this age */
469 *ssl_sessionid = check->sessionid;
471 *idsize = check->idsize;
477 DEBUGF(infof(data, "%s Session ID in cache for %s %s://%s:%d",
478 no_match? "Didn't find": "Found",
479 isProxy ? "proxy" : "host",
480 conn->handler->scheme, name, port));
485 * Kill a single session ID entry in the cache.
487 void Curl_ssl_kill_session(struct Curl_ssl_session *session)
489 if(session->sessionid) {
490 /* defensive check */
492 /* free the ID the SSL-layer specific way */
493 Curl_ssl->session_free(session->sessionid);
495 session->sessionid = NULL;
496 session->age = 0; /* fresh */
498 Curl_free_primary_ssl_config(&session->ssl_config);
500 Curl_safefree(session->name);
501 Curl_safefree(session->conn_to_host);
506 * Delete the given session ID from the cache.
508 void Curl_ssl_delsessionid(struct Curl_easy *data, void *ssl_sessionid)
512 for(i = 0; i < data->set.general_ssl.max_ssl_sessions; i++) {
513 struct Curl_ssl_session *check = &data->state.session[i];
515 if(check->sessionid == ssl_sessionid) {
516 Curl_ssl_kill_session(check);
523 * Store session id in the session cache. The ID passed on to this function
524 * must already have been extracted and allocated the proper way for the SSL
525 * layer. Curl_XXXX_session_free() will be called to free/kill the session ID
528 CURLcode Curl_ssl_addsessionid(struct Curl_easy *data,
529 struct connectdata *conn,
537 struct Curl_ssl_session *store;
540 char *clone_conn_to_host;
543 #ifndef CURL_DISABLE_PROXY
544 struct ssl_primary_config * const ssl_config = isProxy ?
545 &conn->proxy_ssl_config :
547 const char *hostname = isProxy ? conn->http_proxy.host.name :
550 struct ssl_primary_config * const ssl_config = &conn->ssl_config;
551 const char *hostname = conn->host.name;
558 if(!data->state.session)
561 store = &data->state.session[0];
562 oldest_age = data->state.session[0].age; /* zero if unused */
563 DEBUGASSERT(SSL_SET_OPTION(primary.sessionid));
565 clone_host = strdup(hostname);
567 return CURLE_OUT_OF_MEMORY; /* bail out */
569 if(conn->bits.conn_to_host) {
570 clone_conn_to_host = strdup(conn->conn_to_host.name);
571 if(!clone_conn_to_host) {
573 return CURLE_OUT_OF_MEMORY; /* bail out */
577 clone_conn_to_host = NULL;
579 if(conn->bits.conn_to_port)
580 conn_to_port = conn->conn_to_port;
584 /* Now we should add the session ID and the host name to the cache, (remove
585 the oldest if necessary) */
587 /* If using shared SSL session, lock! */
588 if(SSLSESSION_SHARED(data)) {
589 general_age = &data->share->sessionage;
592 general_age = &data->state.sessionage;
595 /* find an empty slot for us, or find the oldest */
596 for(i = 1; (i < data->set.general_ssl.max_ssl_sessions) &&
597 data->state.session[i].sessionid; i++) {
598 if(data->state.session[i].age < oldest_age) {
599 oldest_age = data->state.session[i].age;
600 store = &data->state.session[i];
603 if(i == data->set.general_ssl.max_ssl_sessions)
604 /* cache is full, we must "kill" the oldest entry! */
605 Curl_ssl_kill_session(store);
607 store = &data->state.session[i]; /* use this slot */
609 /* now init the session struct wisely */
610 store->sessionid = ssl_sessionid;
611 store->idsize = idsize;
612 store->age = *general_age; /* set current age */
613 /* free it if there's one already present */
615 free(store->conn_to_host);
616 store->name = clone_host; /* clone host name */
617 store->conn_to_host = clone_conn_to_host; /* clone connect to host name */
618 store->conn_to_port = conn_to_port; /* connect to port number */
620 store->remote_port = isProxy ? (int)conn->port : conn->remote_port;
621 store->scheme = conn->handler->scheme;
623 if(!Curl_clone_primary_ssl_config(ssl_config, &store->ssl_config)) {
624 Curl_free_primary_ssl_config(&store->ssl_config);
625 store->sessionid = NULL; /* let caller free sessionid */
627 free(clone_conn_to_host);
628 return CURLE_OUT_OF_MEMORY;
634 DEBUGF(infof(data, "Added Session ID to cache for %s://%s:%d [%s]",
635 store->scheme, store->name, store->remote_port,
636 isProxy ? "PROXY" : "server"));
640 void Curl_ssl_associate_conn(struct Curl_easy *data,
641 struct connectdata *conn)
643 if(Curl_ssl->associate_connection) {
644 Curl_ssl->associate_connection(data, conn, FIRSTSOCKET);
645 if((conn->sock[SECONDARYSOCKET] != CURL_SOCKET_BAD) &&
646 conn->bits.sock_accepted)
647 Curl_ssl->associate_connection(data, conn, SECONDARYSOCKET);
651 void Curl_ssl_detach_conn(struct Curl_easy *data,
652 struct connectdata *conn)
654 if(Curl_ssl->disassociate_connection) {
655 Curl_ssl->disassociate_connection(data, FIRSTSOCKET);
656 if((conn->sock[SECONDARYSOCKET] != CURL_SOCKET_BAD) &&
657 conn->bits.sock_accepted)
658 Curl_ssl->disassociate_connection(data, SECONDARYSOCKET);
662 void Curl_ssl_close_all(struct Curl_easy *data)
664 /* kill the session ID cache if not shared */
665 if(data->state.session && !SSLSESSION_SHARED(data)) {
667 for(i = 0; i < data->set.general_ssl.max_ssl_sessions; i++)
668 /* the single-killer function handles empty table slots */
669 Curl_ssl_kill_session(&data->state.session[i]);
671 /* free the cache data */
672 Curl_safefree(data->state.session);
675 Curl_ssl->close_all(data);
678 int Curl_ssl_getsock(struct connectdata *conn, curl_socket_t *socks)
680 struct ssl_connect_data *connssl = &conn->ssl[FIRSTSOCKET];
682 if(connssl->connecting_state == ssl_connect_2_writing) {
684 socks[0] = conn->sock[FIRSTSOCKET];
685 return GETSOCK_WRITESOCK(0);
687 if(connssl->connecting_state == ssl_connect_2_reading) {
689 socks[0] = conn->sock[FIRSTSOCKET];
690 return GETSOCK_READSOCK(0);
693 return GETSOCK_BLANK;
696 void Curl_ssl_close(struct Curl_easy *data, struct connectdata *conn,
699 DEBUGASSERT((sockindex <= 1) && (sockindex >= -1));
700 Curl_ssl->close_one(data, conn, sockindex);
701 conn->ssl[sockindex].state = ssl_connection_none;
704 CURLcode Curl_ssl_shutdown(struct Curl_easy *data, struct connectdata *conn,
707 if(Curl_ssl->shut_down(data, conn, sockindex))
708 return CURLE_SSL_SHUTDOWN_FAILED;
710 conn->ssl[sockindex].use = FALSE; /* get back to ordinary socket usage */
711 conn->ssl[sockindex].state = ssl_connection_none;
713 conn->recv[sockindex] = Curl_recv_plain;
714 conn->send[sockindex] = Curl_send_plain;
719 /* Selects an SSL crypto engine
721 CURLcode Curl_ssl_set_engine(struct Curl_easy *data, const char *engine)
723 return Curl_ssl->set_engine(data, engine);
726 /* Selects the default SSL crypto engine
728 CURLcode Curl_ssl_set_engine_default(struct Curl_easy *data)
730 return Curl_ssl->set_engine_default(data);
733 /* Return list of OpenSSL crypto engine names. */
734 struct curl_slist *Curl_ssl_engines_list(struct Curl_easy *data)
736 return Curl_ssl->engines_list(data);
740 * This sets up a session ID cache to the specified size. Make sure this code
741 * is agnostic to what underlying SSL technology we use.
743 CURLcode Curl_ssl_initsessions(struct Curl_easy *data, size_t amount)
745 struct Curl_ssl_session *session;
747 if(data->state.session)
748 /* this is just a precaution to prevent multiple inits */
751 session = calloc(amount, sizeof(struct Curl_ssl_session));
753 return CURLE_OUT_OF_MEMORY;
755 /* store the info in the SSL section */
756 data->set.general_ssl.max_ssl_sessions = amount;
757 data->state.session = session;
758 data->state.sessionage = 1; /* this is brand new */
762 static size_t multissl_version(char *buffer, size_t size);
764 void Curl_ssl_version(char *buffer, size_t size)
766 #ifdef CURL_WITH_MULTI_SSL
767 (void)multissl_version(buffer, size);
769 (void)Curl_ssl->version(buffer, size);
774 * This function tries to determine connection status.
777 * 1 means the connection is still in place
778 * 0 means the connection has been closed
779 * -1 means the connection status is unknown
781 int Curl_ssl_check_cxn(struct connectdata *conn)
783 return Curl_ssl->check_cxn(conn);
786 bool Curl_ssl_data_pending(const struct connectdata *conn,
789 return Curl_ssl->data_pending(conn, connindex);
792 void Curl_ssl_free_certinfo(struct Curl_easy *data)
794 struct curl_certinfo *ci = &data->info.certs;
796 if(ci->num_of_certs) {
797 /* free all individual lists used */
799 for(i = 0; i<ci->num_of_certs; i++) {
800 curl_slist_free_all(ci->certinfo[i]);
801 ci->certinfo[i] = NULL;
804 free(ci->certinfo); /* free the actual array too */
806 ci->num_of_certs = 0;
810 CURLcode Curl_ssl_init_certinfo(struct Curl_easy *data, int num)
812 struct curl_certinfo *ci = &data->info.certs;
813 struct curl_slist **table;
815 /* Free any previous certificate information structures */
816 Curl_ssl_free_certinfo(data);
818 /* Allocate the required certificate information structures */
819 table = calloc((size_t) num, sizeof(struct curl_slist *));
821 return CURLE_OUT_OF_MEMORY;
823 ci->num_of_certs = num;
824 ci->certinfo = table;
830 * 'value' is NOT a null-terminated string
832 CURLcode Curl_ssl_push_certinfo_len(struct Curl_easy *data,
838 struct curl_certinfo *ci = &data->info.certs;
840 struct curl_slist *nl;
841 CURLcode result = CURLE_OK;
842 size_t labellen = strlen(label);
843 size_t outlen = labellen + 1 + valuelen + 1; /* label:value\0 */
845 output = malloc(outlen);
847 return CURLE_OUT_OF_MEMORY;
849 /* sprintf the label and colon */
850 msnprintf(output, outlen, "%s:", label);
852 /* memcpy the value (it might not be null-terminated) */
853 memcpy(&output[labellen + 1], value, valuelen);
855 /* null-terminate the output */
856 output[labellen + 1 + valuelen] = 0;
858 nl = Curl_slist_append_nodup(ci->certinfo[certnum], output);
861 curl_slist_free_all(ci->certinfo[certnum]);
862 result = CURLE_OUT_OF_MEMORY;
865 ci->certinfo[certnum] = nl;
870 * This is a convenience function for push_certinfo_len that takes a zero
873 CURLcode Curl_ssl_push_certinfo(struct Curl_easy *data,
878 size_t valuelen = strlen(value);
880 return Curl_ssl_push_certinfo_len(data, certnum, label, value, valuelen);
883 CURLcode Curl_ssl_random(struct Curl_easy *data,
884 unsigned char *entropy,
887 return Curl_ssl->random(data, entropy, length);
891 * Curl_ssl_snihost() converts the input host name to a suitable SNI name put
892 * in data->state.buffer. Returns a pointer to the name (or NULL if a problem)
893 * and stores the new length in 'olen'.
895 * SNI fields must not have any trailing dot and while RFC 6066 section 3 says
896 * the SNI field is case insensitive, browsers always send the data lowercase
897 * and subsequently there are numerous servers out there that don't work
898 * unless the name is lowercased.
901 char *Curl_ssl_snihost(struct Curl_easy *data, const char *host, size_t *olen)
903 size_t len = strlen(host);
904 if(len && (host[len-1] == '.'))
906 if((long)len >= data->set.buffer_size)
909 Curl_strntolower(data->state.buffer, host, len);
910 data->state.buffer[len] = 0;
913 return data->state.buffer;
917 * Public key pem to der conversion
920 static CURLcode pubkey_pem_to_der(const char *pem,
921 unsigned char **der, size_t *der_len)
923 char *stripped_pem, *begin_pos, *end_pos;
924 size_t pem_count, stripped_pem_count = 0, pem_len;
927 /* if no pem, exit. */
929 return CURLE_BAD_CONTENT_ENCODING;
931 begin_pos = strstr(pem, "-----BEGIN PUBLIC KEY-----");
933 return CURLE_BAD_CONTENT_ENCODING;
935 pem_count = begin_pos - pem;
936 /* Invalid if not at beginning AND not directly following \n */
937 if(0 != pem_count && '\n' != pem[pem_count - 1])
938 return CURLE_BAD_CONTENT_ENCODING;
940 /* 26 is length of "-----BEGIN PUBLIC KEY-----" */
943 /* Invalid if not directly following \n */
944 end_pos = strstr(pem + pem_count, "\n-----END PUBLIC KEY-----");
946 return CURLE_BAD_CONTENT_ENCODING;
948 pem_len = end_pos - pem;
950 stripped_pem = malloc(pem_len - pem_count + 1);
952 return CURLE_OUT_OF_MEMORY;
955 * Here we loop through the pem array one character at a time between the
956 * correct indices, and place each character that is not '\n' or '\r'
957 * into the stripped_pem array, which should represent the raw base64 string
959 while(pem_count < pem_len) {
960 if('\n' != pem[pem_count] && '\r' != pem[pem_count])
961 stripped_pem[stripped_pem_count++] = pem[pem_count];
964 /* Place the null terminator in the correct place */
965 stripped_pem[stripped_pem_count] = '\0';
967 result = Curl_base64_decode(stripped_pem, der, der_len);
969 Curl_safefree(stripped_pem);
975 * Generic pinned public key check.
978 CURLcode Curl_pin_peer_pubkey(struct Curl_easy *data,
979 const char *pinnedpubkey,
980 const unsigned char *pubkey, size_t pubkeylen)
983 unsigned char *buf = NULL, *pem_ptr = NULL;
984 CURLcode result = CURLE_SSL_PINNEDPUBKEYNOTMATCH;
986 /* if a path wasn't specified, don't pin */
989 if(!pubkey || !pubkeylen)
992 /* only do this if pinnedpubkey starts with "sha256//", length 8 */
993 if(strncmp(pinnedpubkey, "sha256//", 8) == 0) {
995 size_t encodedlen, pinkeylen;
996 char *encoded, *pinkeycopy, *begin_pos, *end_pos;
997 unsigned char *sha256sumdigest;
999 if(!Curl_ssl->sha256sum) {
1000 /* without sha256 support, this cannot match */
1004 /* compute sha256sum of public key */
1005 sha256sumdigest = malloc(CURL_SHA256_DIGEST_LENGTH);
1006 if(!sha256sumdigest)
1007 return CURLE_OUT_OF_MEMORY;
1008 encode = Curl_ssl->sha256sum(pubkey, pubkeylen,
1009 sha256sumdigest, CURL_SHA256_DIGEST_LENGTH);
1011 if(encode != CURLE_OK)
1014 encode = Curl_base64_encode((char *)sha256sumdigest,
1015 CURL_SHA256_DIGEST_LENGTH, &encoded,
1017 Curl_safefree(sha256sumdigest);
1022 infof(data, " public key hash: sha256//%s", encoded);
1024 /* it starts with sha256//, copy so we can modify it */
1025 pinkeylen = strlen(pinnedpubkey) + 1;
1026 pinkeycopy = malloc(pinkeylen);
1028 Curl_safefree(encoded);
1029 return CURLE_OUT_OF_MEMORY;
1031 memcpy(pinkeycopy, pinnedpubkey, pinkeylen);
1032 /* point begin_pos to the copy, and start extracting keys */
1033 begin_pos = pinkeycopy;
1035 end_pos = strstr(begin_pos, ";sha256//");
1037 * if there is an end_pos, null terminate,
1038 * otherwise it'll go to the end of the original string
1043 /* compare base64 sha256 digests, 8 is the length of "sha256//" */
1044 if(encodedlen == strlen(begin_pos + 8) &&
1045 !memcmp(encoded, begin_pos + 8, encodedlen)) {
1051 * change back the null-terminator we changed earlier,
1052 * and look for next begin
1056 begin_pos = strstr(end_pos, "sha256//");
1058 } while(end_pos && begin_pos);
1059 Curl_safefree(encoded);
1060 Curl_safefree(pinkeycopy);
1064 fp = fopen(pinnedpubkey, "rb");
1070 size_t size, pem_len;
1073 /* Determine the file's size */
1074 if(fseek(fp, 0, SEEK_END))
1076 filesize = ftell(fp);
1077 if(fseek(fp, 0, SEEK_SET))
1079 if(filesize < 0 || filesize > MAX_PINNED_PUBKEY_SIZE)
1083 * if the size of our certificate is bigger than the file
1084 * size then it can't match
1086 size = curlx_sotouz((curl_off_t) filesize);
1087 if(pubkeylen > size)
1091 * Allocate buffer for the pinned key
1092 * With 1 additional byte for null terminator in case of PEM key
1094 buf = malloc(size + 1);
1098 /* Returns number of elements read, which should be 1 */
1099 if((int) fread(buf, size, 1, fp) != 1)
1102 /* If the sizes are the same, it can't be base64 encoded, must be der */
1103 if(pubkeylen == size) {
1104 if(!memcmp(pubkey, buf, pubkeylen))
1110 * Otherwise we will assume it's PEM and try to decode it
1111 * after placing null terminator
1114 pem_read = pubkey_pem_to_der((const char *)buf, &pem_ptr, &pem_len);
1115 /* if it wasn't read successfully, exit */
1120 * if the size of our certificate doesn't match the size of
1121 * the decoded file, they can't be the same, otherwise compare
1123 if(pubkeylen == pem_len && !memcmp(pubkey, pem_ptr, pubkeylen))
1128 Curl_safefree(pem_ptr);
1135 * Check whether the SSL backend supports the status_request extension.
1137 bool Curl_ssl_cert_status_request(void)
1139 return Curl_ssl->cert_status_request();
1143 * Check whether the SSL backend supports false start.
1145 bool Curl_ssl_false_start(void)
1147 return Curl_ssl->false_start();
1151 * Check whether the SSL backend supports setting TLS 1.3 cipher suites
1153 bool Curl_ssl_tls13_ciphersuites(void)
1155 return Curl_ssl->supports & SSLSUPP_TLS13_CIPHERSUITES;
1159 * Default implementations for unsupported functions.
1162 int Curl_none_init(void)
1167 void Curl_none_cleanup(void)
1170 int Curl_none_shutdown(struct Curl_easy *data UNUSED_PARAM,
1171 struct connectdata *conn UNUSED_PARAM,
1172 int sockindex UNUSED_PARAM)
1180 int Curl_none_check_cxn(struct connectdata *conn UNUSED_PARAM)
1186 CURLcode Curl_none_random(struct Curl_easy *data UNUSED_PARAM,
1187 unsigned char *entropy UNUSED_PARAM,
1188 size_t length UNUSED_PARAM)
1193 return CURLE_NOT_BUILT_IN;
1196 void Curl_none_close_all(struct Curl_easy *data UNUSED_PARAM)
1201 void Curl_none_session_free(void *ptr UNUSED_PARAM)
1206 bool Curl_none_data_pending(const struct connectdata *conn UNUSED_PARAM,
1207 int connindex UNUSED_PARAM)
1214 bool Curl_none_cert_status_request(void)
1219 CURLcode Curl_none_set_engine(struct Curl_easy *data UNUSED_PARAM,
1220 const char *engine UNUSED_PARAM)
1224 return CURLE_NOT_BUILT_IN;
1227 CURLcode Curl_none_set_engine_default(struct Curl_easy *data UNUSED_PARAM)
1230 return CURLE_NOT_BUILT_IN;
1233 struct curl_slist *Curl_none_engines_list(struct Curl_easy *data UNUSED_PARAM)
1236 return (struct curl_slist *)NULL;
1239 bool Curl_none_false_start(void)
1244 static int multissl_init(void)
1246 if(multissl_setup(NULL))
1248 return Curl_ssl->init();
1251 static CURLcode multissl_connect(struct Curl_easy *data,
1252 struct connectdata *conn, int sockindex)
1254 if(multissl_setup(NULL))
1255 return CURLE_FAILED_INIT;
1256 return Curl_ssl->connect_blocking(data, conn, sockindex);
1259 static CURLcode multissl_connect_nonblocking(struct Curl_easy *data,
1260 struct connectdata *conn,
1261 int sockindex, bool *done)
1263 if(multissl_setup(NULL))
1264 return CURLE_FAILED_INIT;
1265 return Curl_ssl->connect_nonblocking(data, conn, sockindex, done);
1268 static int multissl_getsock(struct connectdata *conn, curl_socket_t *socks)
1270 if(multissl_setup(NULL))
1272 return Curl_ssl->getsock(conn, socks);
1275 static void *multissl_get_internals(struct ssl_connect_data *connssl,
1278 if(multissl_setup(NULL))
1280 return Curl_ssl->get_internals(connssl, info);
1283 static void multissl_close(struct Curl_easy *data, struct connectdata *conn,
1286 if(multissl_setup(NULL))
1288 Curl_ssl->close_one(data, conn, sockindex);
1291 static const struct Curl_ssl Curl_ssl_multi = {
1292 { CURLSSLBACKEND_NONE, "multi" }, /* info */
1293 0, /* supports nothing */
1294 (size_t)-1, /* something insanely large to be on the safe side */
1296 multissl_init, /* init */
1297 Curl_none_cleanup, /* cleanup */
1298 multissl_version, /* version */
1299 Curl_none_check_cxn, /* check_cxn */
1300 Curl_none_shutdown, /* shutdown */
1301 Curl_none_data_pending, /* data_pending */
1302 Curl_none_random, /* random */
1303 Curl_none_cert_status_request, /* cert_status_request */
1304 multissl_connect, /* connect */
1305 multissl_connect_nonblocking, /* connect_nonblocking */
1306 multissl_getsock, /* getsock */
1307 multissl_get_internals, /* get_internals */
1308 multissl_close, /* close_one */
1309 Curl_none_close_all, /* close_all */
1310 Curl_none_session_free, /* session_free */
1311 Curl_none_set_engine, /* set_engine */
1312 Curl_none_set_engine_default, /* set_engine_default */
1313 Curl_none_engines_list, /* engines_list */
1314 Curl_none_false_start, /* false_start */
1315 NULL, /* sha256sum */
1316 NULL, /* associate_connection */
1317 NULL /* disassociate_connection */
1320 const struct Curl_ssl *Curl_ssl =
1321 #if defined(CURL_WITH_MULTI_SSL)
1323 #elif defined(USE_WOLFSSL)
1325 #elif defined(USE_SECTRANSP)
1326 &Curl_ssl_sectransp;
1327 #elif defined(USE_GNUTLS)
1329 #elif defined(USE_GSKIT)
1331 #elif defined(USE_MBEDTLS)
1333 #elif defined(USE_NSS)
1335 #elif defined(USE_RUSTLS)
1337 #elif defined(USE_OPENSSL)
1339 #elif defined(USE_SCHANNEL)
1341 #elif defined(USE_BEARSSL)
1344 #error "Missing struct Curl_ssl for selected SSL backend"
1347 static const struct Curl_ssl *available_backends[] = {
1348 #if defined(USE_WOLFSSL)
1351 #if defined(USE_SECTRANSP)
1352 &Curl_ssl_sectransp,
1354 #if defined(USE_GNUTLS)
1357 #if defined(USE_GSKIT)
1360 #if defined(USE_MBEDTLS)
1363 #if defined(USE_NSS)
1366 #if defined(USE_OPENSSL)
1369 #if defined(USE_SCHANNEL)
1372 #if defined(USE_BEARSSL)
1375 #if defined(USE_RUSTLS)
1381 static size_t multissl_version(char *buffer, size_t size)
1383 static const struct Curl_ssl *selected;
1384 static char backends[200];
1385 static size_t backends_len;
1386 const struct Curl_ssl *current;
1388 current = Curl_ssl == &Curl_ssl_multi ? available_backends[0] : Curl_ssl;
1390 if(current != selected) {
1392 char *end = backends + sizeof(backends);
1399 for(i = 0; available_backends[i]; ++i) {
1401 bool paren = (selected != available_backends[i]);
1403 if(available_backends[i]->version(vb, sizeof(vb))) {
1404 p += msnprintf(p, end - p, "%s%s%s%s", (p != backends ? " " : ""),
1405 (paren ? "(" : ""), vb, (paren ? ")" : ""));
1409 backends_len = p - backends;
1415 if(size <= backends_len) {
1416 strncpy(buffer, backends, size - 1);
1417 buffer[size - 1] = '\0';
1421 strcpy(buffer, backends);
1422 return backends_len;
1425 static int multissl_setup(const struct Curl_ssl *backend)
1430 if(Curl_ssl != &Curl_ssl_multi)
1438 if(!available_backends[0])
1441 env = env_tmp = curl_getenv("CURL_SSL_BACKEND");
1442 #ifdef CURL_DEFAULT_SSL_BACKEND
1444 env = CURL_DEFAULT_SSL_BACKEND;
1448 for(i = 0; available_backends[i]; i++) {
1449 if(strcasecompare(env, available_backends[i]->info.name)) {
1450 Curl_ssl = available_backends[i];
1457 /* Fall back to first available backend */
1458 Curl_ssl = available_backends[0];
1463 CURLsslset curl_global_sslset(curl_sslbackend id, const char *name,
1464 const curl_ssl_backend ***avail)
1469 *avail = (const curl_ssl_backend **)&available_backends;
1471 if(Curl_ssl != &Curl_ssl_multi)
1472 return id == Curl_ssl->info.id ||
1473 (name && strcasecompare(name, Curl_ssl->info.name)) ?
1475 #if defined(CURL_WITH_MULTI_SSL)
1476 CURLSSLSET_TOO_LATE;
1478 CURLSSLSET_UNKNOWN_BACKEND;
1481 for(i = 0; available_backends[i]; i++) {
1482 if(available_backends[i]->info.id == id ||
1483 (name && strcasecompare(available_backends[i]->info.name, name))) {
1484 multissl_setup(available_backends[i]);
1485 return CURLSSLSET_OK;
1489 return CURLSSLSET_UNKNOWN_BACKEND;
1493 CURLsslset curl_global_sslset(curl_sslbackend id, const char *name,
1494 const curl_ssl_backend ***avail)
1499 return CURLSSLSET_NO_BACKENDS;
1502 #endif /* !USE_SSL */