1 #ifndef HEADER_CURL_VTLS_INT_H 2 #define HEADER_CURL_VTLS_INT_H 3 /*************************************************************************** 4 * _ _ ____ _ 5 * Project ___| | | | _ \| | 6 * / __| | | | |_) | | 7 * | (__| |_| | _ <| |___ 8 * \___|\___/|_| \_\_____| 9 * 10 * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 11 * 12 * This software is licensed as described in the file COPYING, which 13 * you should have received as part of this distribution. The terms 14 * are also available at https://curl.se/docs/copyright.html. 15 * 16 * You may opt to use, copy, modify, merge, publish, distribute and/or sell 17 * copies of the Software, and permit persons to whom the Software is 18 * furnished to do so, under the terms of the COPYING file. 19 * 20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY 21 * KIND, either express or implied. 22 * 23 * SPDX-License-Identifier: curl 24 * 25 ***************************************************************************/ 26 #include "curl_setup.h" 27 #include "cfilters.h" 28 #include "urldata.h" 29 30 #ifdef USE_SSL 31 32 /* see https://www.iana.org/assignments/tls-extensiontype-values/ */ 33 #define ALPN_HTTP_1_1_LENGTH 8 34 #define ALPN_HTTP_1_1 "http/1.1" 35 #define ALPN_H2_LENGTH 2 36 #define ALPN_H2 "h2" 37 #define ALPN_H3_LENGTH 2 38 #define ALPN_H3 "h3" 39 40 /* conservative sizes on the ALPN entries and count we are handling, 41 * we can increase these if we ever feel the need or have to accommodate 42 * ALPN strings from the "outside". */ 43 #define ALPN_NAME_MAX 10 44 #define ALPN_ENTRIES_MAX 3 45 #define ALPN_PROTO_BUF_MAX (ALPN_ENTRIES_MAX * (ALPN_NAME_MAX + 1)) 46 47 struct alpn_spec { 48 const char entries[ALPN_ENTRIES_MAX][ALPN_NAME_MAX]; 49 size_t count; /* number of entries */ 50 }; 51 52 struct alpn_proto_buf { 53 unsigned char data[ALPN_PROTO_BUF_MAX]; 54 int len; 55 }; 56 57 CURLcode Curl_alpn_to_proto_buf(struct alpn_proto_buf *buf, 58 const struct alpn_spec *spec); 59 CURLcode Curl_alpn_to_proto_str(struct alpn_proto_buf *buf, 60 const struct alpn_spec *spec); 61 62 CURLcode Curl_alpn_set_negotiated(struct Curl_cfilter *cf, 63 struct Curl_easy *data, 64 const unsigned char *proto, 65 size_t proto_len); 66 67 /* Information in each SSL cfilter context: cf->ctx */ 68 struct ssl_connect_data { 69 ssl_connection_state state; 70 ssl_connect_state connecting_state; 71 struct ssl_peer peer; 72 const struct alpn_spec *alpn; /* ALPN to use or NULL for none */ 73 void *backend; /* vtls backend specific props */ 74 struct cf_call_data call_data; /* data handle used in current call */ 75 struct curltime handshake_done; /* time when handshake finished */ 76 BIT(use_alpn); /* if ALPN shall be used in handshake */ 77 BIT(peer_closed); /* peer has closed connection */ 78 }; 79 80 81 #undef CF_CTX_CALL_DATA 82 #define CF_CTX_CALL_DATA(cf) \ 83 ((struct ssl_connect_data *)(cf)->ctx)->call_data 84 85 86 /* Definitions for SSL Implementations */ 87 88 struct Curl_ssl { 89 /* 90 * This *must* be the first entry to allow returning the list of available 91 * backends in curl_global_sslset(). 92 */ 93 curl_ssl_backend info; 94 unsigned int supports; /* bitfield, see above */ 95 size_t sizeof_ssl_backend_data; 96 97 int (*init)(void); 98 void (*cleanup)(void); 99 100 size_t (*version)(char *buffer, size_t size); 101 int (*check_cxn)(struct Curl_cfilter *cf, struct Curl_easy *data); 102 int (*shut_down)(struct Curl_cfilter *cf, 103 struct Curl_easy *data); 104 bool (*data_pending)(struct Curl_cfilter *cf, 105 const struct Curl_easy *data); 106 107 /* return 0 if a find random is filled in */ 108 CURLcode (*random)(struct Curl_easy *data, unsigned char *entropy, 109 size_t length); 110 bool (*cert_status_request)(void); 111 112 CURLcode (*connect_blocking)(struct Curl_cfilter *cf, 113 struct Curl_easy *data); 114 CURLcode (*connect_nonblocking)(struct Curl_cfilter *cf, 115 struct Curl_easy *data, 116 bool *done); 117 118 /* During handshake, adjust the pollset to include the socket 119 * for POLLOUT or POLLIN as needed. 120 * Mandatory. */ 121 void (*adjust_pollset)(struct Curl_cfilter *cf, struct Curl_easy *data, 122 struct easy_pollset *ps); 123 void *(*get_internals)(struct ssl_connect_data *connssl, CURLINFO info); 124 void (*close)(struct Curl_cfilter *cf, struct Curl_easy *data); 125 void (*close_all)(struct Curl_easy *data); 126 127 CURLcode (*set_engine)(struct Curl_easy *data, const char *engine); 128 CURLcode (*set_engine_default)(struct Curl_easy *data); 129 struct curl_slist *(*engines_list)(struct Curl_easy *data); 130 131 bool (*false_start)(void); 132 CURLcode (*sha256sum)(const unsigned char *input, size_t inputlen, 133 unsigned char *sha256sum, size_t sha256sumlen); 134 135 bool (*attach_data)(struct Curl_cfilter *cf, struct Curl_easy *data); 136 void (*detach_data)(struct Curl_cfilter *cf, struct Curl_easy *data); 137 138 void (*free_multi_ssl_backend_data)(struct multi_ssl_backend_data *mbackend); 139 140 ssize_t (*recv_plain)(struct Curl_cfilter *cf, struct Curl_easy *data, 141 char *buf, size_t len, CURLcode *code); 142 ssize_t (*send_plain)(struct Curl_cfilter *cf, struct Curl_easy *data, 143 const void *mem, size_t len, CURLcode *code); 144 145 }; 146 147 extern const struct Curl_ssl *Curl_ssl; 148 149 150 int Curl_none_init(void); 151 void Curl_none_cleanup(void); 152 int Curl_none_shutdown(struct Curl_cfilter *cf, struct Curl_easy *data); 153 int Curl_none_check_cxn(struct Curl_cfilter *cf, struct Curl_easy *data); 154 CURLcode Curl_none_random(struct Curl_easy *data, unsigned char *entropy, 155 size_t length); 156 void Curl_none_close_all(struct Curl_easy *data); 157 void Curl_none_session_free(void *ptr); 158 bool Curl_none_data_pending(struct Curl_cfilter *cf, 159 const struct Curl_easy *data); 160 bool Curl_none_cert_status_request(void); 161 CURLcode Curl_none_set_engine(struct Curl_easy *data, const char *engine); 162 CURLcode Curl_none_set_engine_default(struct Curl_easy *data); 163 struct curl_slist *Curl_none_engines_list(struct Curl_easy *data); 164 bool Curl_none_false_start(void); 165 void Curl_ssl_adjust_pollset(struct Curl_cfilter *cf, struct Curl_easy *data, 166 struct easy_pollset *ps); 167 168 /** 169 * Get the SSL filter below the given one or NULL if there is none. 170 */ 171 bool Curl_ssl_cf_is_proxy(struct Curl_cfilter *cf); 172 173 /* extract a session ID 174 * Sessionid mutex must be locked (see Curl_ssl_sessionid_lock). 175 * Caller must make sure that the ownership of returned sessionid object 176 * is properly taken (e.g. its refcount is incremented 177 * under sessionid mutex). 178 */ 179 bool Curl_ssl_getsessionid(struct Curl_cfilter *cf, 180 struct Curl_easy *data, 181 const struct ssl_peer *peer, 182 void **ssl_sessionid, 183 size_t *idsize); /* set 0 if unknown */ 184 /* add a new session ID 185 * Sessionid mutex must be locked (see Curl_ssl_sessionid_lock). 186 * Caller must ensure that it has properly shared ownership of this sessionid 187 * object with cache (e.g. incrementing refcount on success) 188 * Call takes ownership of `ssl_sessionid`, using `sessionid_free_cb` 189 * to destroy it in case of failure or later removal. 190 */ 191 CURLcode Curl_ssl_addsessionid(struct Curl_cfilter *cf, 192 struct Curl_easy *data, 193 const struct ssl_peer *peer, 194 void *ssl_sessionid, 195 size_t idsize, 196 Curl_ssl_sessionid_dtor *sessionid_free_cb); 197 198 #include "openssl.h" /* OpenSSL versions */ 199 #include "gtls.h" /* GnuTLS versions */ 200 #include "wolfssl.h" /* wolfSSL versions */ 201 #include "schannel.h" /* Schannel SSPI version */ 202 #include "sectransp.h" /* SecureTransport (Darwin) version */ 203 #include "mbedtls.h" /* mbedTLS versions */ 204 #include "bearssl.h" /* BearSSL versions */ 205 #include "rustls.h" /* rustls versions */ 206 207 #endif /* USE_SSL */ 208 209 #endif /* HEADER_CURL_VTLS_INT_H */ 210
