1 #ifndef HEADER_CURL_URLDATA_H 2 #define HEADER_CURL_URLDATA_H 3 /*************************************************************************** 4 * _ _ ____ _ 5 * Project ___| | | | _ \| | 6 * / __| | | | |_) | | 7 * | (__| |_| | _ <| |___ 8 * \___|\___/|_| \_\_____| 9 * 10 * Copyright (C) 1998 - 2021, 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 ***************************************************************************/ 24 25 /* This file is for lib internal stuff */ 26 27 #include "curl_setup.h" 28 29 #define PORT_FTP 21 30 #define PORT_FTPS 990 31 #define PORT_TELNET 23 32 #define PORT_HTTP 80 33 #define PORT_HTTPS 443 34 #define PORT_DICT 2628 35 #define PORT_LDAP 389 36 #define PORT_LDAPS 636 37 #define PORT_TFTP 69 38 #define PORT_SSH 22 39 #define PORT_IMAP 143 40 #define PORT_IMAPS 993 41 #define PORT_POP3 110 42 #define PORT_POP3S 995 43 #define PORT_SMB 445 44 #define PORT_SMBS 445 45 #define PORT_SMTP 25 46 #define PORT_SMTPS 465 /* sometimes called SSMTP */ 47 #define PORT_RTSP 554 48 #define PORT_RTMP 1935 49 #define PORT_RTMPT PORT_HTTP 50 #define PORT_RTMPS PORT_HTTPS 51 #define PORT_GOPHER 70 52 #define PORT_MQTT 1883 53 54 #define DICT_MATCH "/MATCH:" 55 #define DICT_MATCH2 "/M:" 56 #define DICT_MATCH3 "/FIND:" 57 #define DICT_DEFINE "/DEFINE:" 58 #define DICT_DEFINE2 "/D:" 59 #define DICT_DEFINE3 "/LOOKUP:" 60 61 #define CURL_DEFAULT_USER "anonymous" 62 #define CURL_DEFAULT_PASSWORD "ftp@example.com" 63 64 /* Convenience defines for checking protocols or their SSL based version. Each 65 protocol handler should only ever have a single CURLPROTO_ in its protocol 66 field. */ 67 #define PROTO_FAMILY_HTTP (CURLPROTO_HTTP|CURLPROTO_HTTPS) 68 #define PROTO_FAMILY_FTP (CURLPROTO_FTP|CURLPROTO_FTPS) 69 #define PROTO_FAMILY_POP3 (CURLPROTO_POP3|CURLPROTO_POP3S) 70 #define PROTO_FAMILY_SMB (CURLPROTO_SMB|CURLPROTO_SMBS) 71 #define PROTO_FAMILY_SMTP (CURLPROTO_SMTP|CURLPROTO_SMTPS) 72 #define PROTO_FAMILY_SSH (CURLPROTO_SCP|CURLPROTO_SFTP) 73 74 #define DEFAULT_CONNCACHE_SIZE 5 75 76 /* length of longest IPv6 address string including the trailing null */ 77 #define MAX_IPADR_LEN sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255") 78 79 /* Default FTP/IMAP etc response timeout in milliseconds */ 80 #define RESP_TIMEOUT (120*1000) 81 82 /* Max string input length is a precaution against abuse and to detect junk 83 input easier and better. */ 84 #define CURL_MAX_INPUT_LENGTH 8000000 85 86 #include "cookie.h" 87 #include "psl.h" 88 #include "formdata.h" 89 90 #ifdef HAVE_NETINET_IN_H 91 #include <netinet/in.h> 92 #endif 93 #ifdef HAVE_NETINET_IN6_H 94 #include <netinet/in6.h> 95 #endif 96 97 #include "timeval.h" 98 99 #include <curl/curl.h> 100 101 #include "http_chunks.h" /* for the structs and enum stuff */ 102 #include "hostip.h" 103 #include "hash.h" 104 #include "splay.h" 105 #include "dynbuf.h" 106 107 /* return the count of bytes sent, or -1 on error */ 108 typedef ssize_t (Curl_send)(struct Curl_easy *data, /* transfer */ 109 int sockindex, /* socketindex */ 110 const void *buf, /* data to write */ 111 size_t len, /* max amount to write */ 112 CURLcode *err); /* error to return */ 113 114 /* return the count of bytes read, or -1 on error */ 115 typedef ssize_t (Curl_recv)(struct Curl_easy *data, /* transfer */ 116 int sockindex, /* socketindex */ 117 char *buf, /* store data here */ 118 size_t len, /* max amount to read */ 119 CURLcode *err); /* error to return */ 120 121 #ifdef USE_HYPER 122 typedef CURLcode (*Curl_datastream)(struct Curl_easy *data, 123 struct connectdata *conn, 124 int *didwhat, 125 bool *done, 126 int select_res); 127 #endif 128 129 #include "mime.h" 130 #include "imap.h" 131 #include "pop3.h" 132 #include "smtp.h" 133 #include "ftp.h" 134 #include "file.h" 135 #include "vssh/ssh.h" 136 #include "http.h" 137 #include "rtsp.h" 138 #include "smb.h" 139 #include "mqtt.h" 140 #include "wildcard.h" 141 #include "multihandle.h" 142 #include "quic.h" 143 #include "c-hyper.h" 144 145 #ifdef HAVE_GSSAPI 146 # ifdef HAVE_GSSGNU 147 # include <gss.h> 148 # elif defined HAVE_GSSAPI_GSSAPI_H 149 # include <gssapi/gssapi.h> 150 # else 151 # include <gssapi.h> 152 # endif 153 # ifdef HAVE_GSSAPI_GSSAPI_GENERIC_H 154 # include <gssapi/gssapi_generic.h> 155 # endif 156 #endif 157 158 #ifdef HAVE_LIBSSH2_H 159 #include <libssh2.h> 160 #include <libssh2_sftp.h> 161 #endif /* HAVE_LIBSSH2_H */ 162 163 #define READBUFFER_SIZE CURL_MAX_WRITE_SIZE 164 #define READBUFFER_MAX CURL_MAX_READ_SIZE 165 #define READBUFFER_MIN 1024 166 167 /* The default upload buffer size, should not be smaller than 168 CURL_MAX_WRITE_SIZE, as it needs to hold a full buffer as could be sent in 169 a write callback. 170 171 The size was 16KB for many years but was bumped to 64KB because it makes 172 libcurl able to do significantly faster uploads in some circumstances. Even 173 larger buffers can help further, but this is deemed a fair memory/speed 174 compromise. */ 175 #define UPLOADBUFFER_DEFAULT 65536 176 #define UPLOADBUFFER_MAX (2*1024*1024) 177 #define UPLOADBUFFER_MIN CURL_MAX_WRITE_SIZE 178 179 #define CURLEASY_MAGIC_NUMBER 0xc0dedbadU 180 #define GOOD_EASY_HANDLE(x) \ 181 ((x) && ((x)->magic == CURLEASY_MAGIC_NUMBER)) 182 183 /* the type we use for storing a single boolean bit */ 184 #ifdef _MSC_VER 185 typedef bool bit; 186 #define BIT(x) bool x 187 #else 188 typedef unsigned int bit; 189 #define BIT(x) bit x:1 190 #endif 191 192 #ifdef HAVE_GSSAPI 193 /* Types needed for krb5-ftp connections */ 194 struct krb5buffer { 195 void *data; 196 size_t size; 197 size_t index; 198 BIT(eof_flag); 199 }; 200 201 enum protection_level { 202 PROT_NONE, /* first in list */ 203 PROT_CLEAR, 204 PROT_SAFE, 205 PROT_CONFIDENTIAL, 206 PROT_PRIVATE, 207 PROT_CMD, 208 PROT_LAST /* last in list */ 209 }; 210 #endif 211 212 /* enum for the nonblocking SSL connection state machine */ 213 typedef enum { 214 ssl_connect_1, 215 ssl_connect_2, 216 ssl_connect_2_reading, 217 ssl_connect_2_writing, 218 ssl_connect_3, 219 ssl_connect_done 220 } ssl_connect_state; 221 222 typedef enum { 223 ssl_connection_none, 224 ssl_connection_negotiating, 225 ssl_connection_complete 226 } ssl_connection_state; 227 228 /* SSL backend-specific data; declared differently by each SSL backend */ 229 struct ssl_backend_data; 230 231 /* struct for data related to each SSL connection */ 232 struct ssl_connect_data { 233 ssl_connection_state state; 234 ssl_connect_state connecting_state; 235 #if defined(USE_SSL) 236 struct ssl_backend_data *backend; 237 #endif 238 /* Use ssl encrypted communications TRUE/FALSE. The library is not 239 necessarily using ssl at the moment but at least asked to or means to use 240 it. See 'state' for the exact current state of the connection. */ 241 BIT(use); 242 }; 243 244 struct ssl_primary_config { 245 long version; /* what version the client wants to use */ 246 long version_max; /* max supported version the client wants to use*/ 247 char *CApath; /* certificate dir (doesn't work on windows) */ 248 char *CAfile; /* certificate to verify peer against */ 249 char *clientcert; 250 char *random_file; /* path to file containing "random" data */ 251 char *egdsocket; /* path to file containing the EGD daemon socket */ 252 char *cipher_list; /* list of ciphers to use */ 253 char *cipher_list13; /* list of TLS 1.3 cipher suites to use */ 254 char *pinned_key; 255 struct curl_blob *cert_blob; 256 char *curves; /* list of curves to use */ 257 BIT(verifypeer); /* set TRUE if this is desired */ 258 BIT(verifyhost); /* set TRUE if CN/SAN must match hostname */ 259 BIT(verifystatus); /* set TRUE if certificate status must be checked */ 260 BIT(sessionid); /* cache session IDs or not */ 261 }; 262 263 struct ssl_config_data { 264 struct ssl_primary_config primary; 265 long certverifyresult; /* result from the certificate verification */ 266 char *CRLfile; /* CRL to check certificate revocation */ 267 char *issuercert;/* optional issuer certificate filename */ 268 struct curl_blob *issuercert_blob; 269 curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */ 270 void *fsslctxp; /* parameter for call back */ 271 char *cert_type; /* format for certificate (default: PEM)*/ 272 char *key; /* private key file name */ 273 struct curl_blob *key_blob; 274 char *key_type; /* format for private key (default: PEM) */ 275 char *key_passwd; /* plain text private key password */ 276 #ifdef USE_TLS_SRP 277 char *username; /* TLS username (for, e.g., SRP) */ 278 char *password; /* TLS password (for, e.g., SRP) */ 279 enum CURL_TLSAUTH authtype; /* TLS authentication type (default SRP) */ 280 #endif 281 BIT(certinfo); /* gather lots of certificate info */ 282 BIT(falsestart); 283 BIT(enable_beast); /* allow this flaw for interoperability's sake*/ 284 BIT(no_revoke); /* disable SSL certificate revocation checks */ 285 BIT(no_partialchain); /* don't accept partial certificate chains */ 286 BIT(revoke_best_effort); /* ignore SSL revocation offline/missing revocation 287 list errors */ 288 BIT(native_ca_store); /* use the native ca store of operating system */ 289 }; 290 291 struct ssl_general_config { 292 size_t max_ssl_sessions; /* SSL session id cache size */ 293 }; 294 295 /* information stored about one single SSL session */ 296 struct Curl_ssl_session { 297 char *name; /* host name for which this ID was used */ 298 char *conn_to_host; /* host name for the connection (may be NULL) */ 299 const char *scheme; /* protocol scheme used */ 300 void *sessionid; /* as returned from the SSL layer */ 301 size_t idsize; /* if known, otherwise 0 */ 302 long age; /* just a number, the higher the more recent */ 303 int remote_port; /* remote port */ 304 int conn_to_port; /* remote port for the connection (may be -1) */ 305 struct ssl_primary_config ssl_config; /* setup for this session */ 306 }; 307 308 #ifdef USE_WINDOWS_SSPI 309 #include "curl_sspi.h" 310 #endif 311 312 /* Struct used for Digest challenge-response authentication */ 313 struct digestdata { 314 #if defined(USE_WINDOWS_SSPI) 315 BYTE *input_token; 316 size_t input_token_len; 317 CtxtHandle *http_context; 318 /* copy of user/passwd used to make the identity for http_context. 319 either may be NULL. */ 320 char *user; 321 char *passwd; 322 #else 323 char *nonce; 324 char *cnonce; 325 char *realm; 326 int algo; 327 char *opaque; 328 char *qop; 329 char *algorithm; 330 int nc; /* nounce count */ 331 BIT(stale); /* set true for re-negotiation */ 332 BIT(userhash); 333 #endif 334 }; 335 336 typedef enum { 337 NTLMSTATE_NONE, 338 NTLMSTATE_TYPE1, 339 NTLMSTATE_TYPE2, 340 NTLMSTATE_TYPE3, 341 NTLMSTATE_LAST 342 } curlntlm; 343 344 typedef enum { 345 GSS_AUTHNONE, 346 GSS_AUTHRECV, 347 GSS_AUTHSENT, 348 GSS_AUTHDONE, 349 GSS_AUTHSUCC 350 } curlnegotiate; 351 352 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV) 353 #include <iconv.h> 354 #endif 355 356 /* Struct used for GSSAPI (Kerberos V5) authentication */ 357 #if defined(USE_KERBEROS5) 358 struct kerberos5data { 359 #if defined(USE_WINDOWS_SSPI) 360 CredHandle *credentials; 361 CtxtHandle *context; 362 TCHAR *spn; 363 SEC_WINNT_AUTH_IDENTITY identity; 364 SEC_WINNT_AUTH_IDENTITY *p_identity; 365 size_t token_max; 366 BYTE *output_token; 367 #else 368 gss_ctx_id_t context; 369 gss_name_t spn; 370 #endif 371 }; 372 #endif 373 374 /* Struct used for NTLM challenge-response authentication */ 375 #if defined(USE_NTLM) 376 struct ntlmdata { 377 #ifdef USE_WINDOWS_SSPI 378 /* The sslContext is used for the Schannel bindings. The 379 * api is available on the Windows 7 SDK and later. 380 */ 381 #ifdef SECPKG_ATTR_ENDPOINT_BINDINGS 382 CtxtHandle *sslContext; 383 #endif 384 CredHandle *credentials; 385 CtxtHandle *context; 386 SEC_WINNT_AUTH_IDENTITY identity; 387 SEC_WINNT_AUTH_IDENTITY *p_identity; 388 size_t token_max; 389 BYTE *output_token; 390 BYTE *input_token; 391 size_t input_token_len; 392 TCHAR *spn; 393 #else 394 unsigned int flags; 395 unsigned char nonce[8]; 396 unsigned int target_info_len; 397 void *target_info; /* TargetInfo received in the ntlm type-2 message */ 398 399 #if defined(NTLM_WB_ENABLED) 400 /* used for communication with Samba's winbind daemon helper ntlm_auth */ 401 curl_socket_t ntlm_auth_hlpr_socket; 402 pid_t ntlm_auth_hlpr_pid; 403 char *challenge; /* The received base64 encoded ntlm type-2 message */ 404 char *response; /* The generated base64 ntlm type-1/type-3 message */ 405 #endif 406 #endif 407 }; 408 #endif 409 410 /* Struct used for Negotiate (SPNEGO) authentication */ 411 #ifdef USE_SPNEGO 412 struct negotiatedata { 413 #ifdef HAVE_GSSAPI 414 OM_uint32 status; 415 gss_ctx_id_t context; 416 gss_name_t spn; 417 gss_buffer_desc output_token; 418 #else 419 #ifdef USE_WINDOWS_SSPI 420 #ifdef SECPKG_ATTR_ENDPOINT_BINDINGS 421 CtxtHandle *sslContext; 422 #endif 423 DWORD status; 424 CredHandle *credentials; 425 CtxtHandle *context; 426 SEC_WINNT_AUTH_IDENTITY identity; 427 SEC_WINNT_AUTH_IDENTITY *p_identity; 428 TCHAR *spn; 429 size_t token_max; 430 BYTE *output_token; 431 size_t output_token_length; 432 #endif 433 #endif 434 BIT(noauthpersist); 435 BIT(havenoauthpersist); 436 BIT(havenegdata); 437 BIT(havemultiplerequests); 438 }; 439 #endif 440 441 442 /* 443 * Boolean values that concerns this connection. 444 */ 445 struct ConnectBits { 446 bool tcpconnect[2]; /* the TCP layer (or similar) is connected, this is set 447 the first time on the first connect function call */ 448 #ifndef CURL_DISABLE_PROXY 449 bool proxy_ssl_connected[2]; /* TRUE when SSL initialization for HTTPS proxy 450 is complete */ 451 BIT(httpproxy); /* if set, this transfer is done through a http proxy */ 452 BIT(socksproxy); /* if set, this transfer is done through a socks proxy */ 453 BIT(proxy_user_passwd); /* user+password for the proxy? */ 454 BIT(tunnel_proxy); /* if CONNECT is used to "tunnel" through the proxy. 455 This is implicit when SSL-protocols are used through 456 proxies, but can also be enabled explicitly by 457 apps */ 458 BIT(proxy_connect_closed); /* TRUE if a proxy disconnected the connection 459 in a CONNECT request with auth, so that 460 libcurl should reconnect and continue. */ 461 #endif 462 /* always modify bits.close with the connclose() and connkeep() macros! */ 463 BIT(close); /* if set, we close the connection after this request */ 464 BIT(reuse); /* if set, this is a re-used connection */ 465 BIT(altused); /* this is an alt-svc "redirect" */ 466 BIT(conn_to_host); /* if set, this connection has a "connect to host" 467 that overrides the host in the URL */ 468 BIT(conn_to_port); /* if set, this connection has a "connect to port" 469 that overrides the port in the URL (remote port) */ 470 BIT(proxy); /* if set, this transfer is done through a proxy - any type */ 471 BIT(user_passwd); /* do we use user+password for this connection? */ 472 BIT(ipv6_ip); /* we communicate with a remote site specified with pure IPv6 473 IP address */ 474 BIT(ipv6); /* we communicate with a site using an IPv6 address */ 475 BIT(do_more); /* this is set TRUE if the ->curl_do_more() function is 476 supposed to be called, after ->curl_do() */ 477 BIT(protoconnstart);/* the protocol layer has STARTED its operation after 478 the TCP layer connect */ 479 BIT(retry); /* this connection is about to get closed and then 480 re-attempted at another connection. */ 481 BIT(authneg); /* TRUE when the auth phase has started, which means 482 that we are creating a request with an auth header, 483 but it is not the final request in the auth 484 negotiation. */ 485 BIT(rewindaftersend);/* TRUE when the sending couldn't be stopped even 486 though it will be discarded. When the whole send 487 operation is done, we must call the data rewind 488 callback. */ 489 #ifndef CURL_DISABLE_FTP 490 BIT(ftp_use_epsv); /* As set with CURLOPT_FTP_USE_EPSV, but if we find out 491 EPSV doesn't work we disable it for the forthcoming 492 requests */ 493 BIT(ftp_use_eprt); /* As set with CURLOPT_FTP_USE_EPRT, but if we find out 494 EPRT doesn't work we disable it for the forthcoming 495 requests */ 496 BIT(ftp_use_data_ssl); /* Enabled SSL for the data connection */ 497 BIT(ftp_use_control_ssl); /* Enabled SSL for the control connection */ 498 #endif 499 BIT(netrc); /* name+password provided by netrc */ 500 BIT(bound); /* set true if bind() has already been done on this socket/ 501 connection */ 502 BIT(multiplex); /* connection is multiplexed */ 503 BIT(tcp_fastopen); /* use TCP Fast Open */ 504 BIT(tls_enable_npn); /* TLS NPN extension? */ 505 BIT(tls_enable_alpn); /* TLS ALPN extension? */ 506 BIT(connect_only); 507 BIT(doh); 508 #ifdef USE_UNIX_SOCKETS 509 BIT(abstract_unix_socket); 510 #endif 511 BIT(tls_upgraded); 512 BIT(sock_accepted); /* TRUE if the SECONDARYSOCKET was created with 513 accept() */ 514 BIT(parallel_connect); /* set TRUE when a parallel connect attempt has 515 started (happy eyeballs) */ 516 }; 517 518 struct hostname { 519 char *rawalloc; /* allocated "raw" version of the name */ 520 char *encalloc; /* allocated IDN-encoded version of the name */ 521 char *name; /* name to use internally, might be encoded, might be raw */ 522 const char *dispname; /* name to display, as 'name' might be encoded */ 523 }; 524 525 /* 526 * Flags on the keepon member of the Curl_transfer_keeper 527 */ 528 529 #define KEEP_NONE 0 530 #define KEEP_RECV (1<<0) /* there is or may be data to read */ 531 #define KEEP_SEND (1<<1) /* there is or may be data to write */ 532 #define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there 533 might still be data to read */ 534 #define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there 535 might still be data to write */ 536 #define KEEP_RECV_PAUSE (1<<4) /* reading is paused */ 537 #define KEEP_SEND_PAUSE (1<<5) /* writing is paused */ 538 539 #define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE) 540 #define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE) 541 542 #if defined(CURLRES_ASYNCH) || !defined(CURL_DISABLE_DOH) 543 #define USE_CURL_ASYNC 544 struct Curl_async { 545 char *hostname; 546 struct Curl_dns_entry *dns; 547 struct thread_data *tdata; 548 void *resolver; /* resolver state, if it is used in the URL state - 549 ares_channel f.e. */ 550 int port; 551 int status; /* if done is TRUE, this is the status from the callback */ 552 BIT(done); /* set TRUE when the lookup is complete */ 553 }; 554 555 #endif 556 557 #define FIRSTSOCKET 0 558 #define SECONDARYSOCKET 1 559 560 enum expect100 { 561 EXP100_SEND_DATA, /* enough waiting, just send the body now */ 562 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */ 563 EXP100_SENDING_REQUEST, /* still sending the request but will wait for 564 the 100 header once done with the request */ 565 EXP100_FAILED /* used on 417 Expectation Failed */ 566 }; 567 568 enum upgrade101 { 569 UPGR101_INIT, /* default state */ 570 UPGR101_REQUESTED, /* upgrade requested */ 571 UPGR101_RECEIVED, /* response received */ 572 UPGR101_WORKING /* talking upgraded protocol */ 573 }; 574 575 enum doh_slots { 576 /* Explicit values for first two symbols so as to match hard-coded 577 * constants in existing code 578 */ 579 DOH_PROBE_SLOT_IPADDR_V4 = 0, /* make 'V4' stand out for readability */ 580 DOH_PROBE_SLOT_IPADDR_V6 = 1, /* 'V6' likewise */ 581 582 /* Space here for (possibly build-specific) additional slot definitions */ 583 584 /* for example */ 585 /* #ifdef WANT_DOH_FOOBAR_TXT */ 586 /* DOH_PROBE_SLOT_FOOBAR_TXT, */ 587 /* #endif */ 588 589 /* AFTER all slot definitions, establish how many we have */ 590 DOH_PROBE_SLOTS 591 }; 592 593 /* one of these for each DoH request */ 594 struct dnsprobe { 595 CURL *easy; 596 int dnstype; 597 unsigned char dohbuffer[512]; 598 size_t dohlen; 599 struct dynbuf serverdoh; 600 }; 601 602 struct dohdata { 603 struct curl_slist *headers; 604 struct dnsprobe probe[DOH_PROBE_SLOTS]; 605 unsigned int pending; /* still outstanding requests */ 606 int port; 607 const char *host; 608 }; 609 610 /* 611 * Request specific data in the easy handle (Curl_easy). Previously, 612 * these members were on the connectdata struct but since a conn struct may 613 * now be shared between different Curl_easys, we store connection-specific 614 * data here. This struct only keeps stuff that's interesting for *this* 615 * request, as it will be cleared between multiple ones 616 */ 617 struct SingleRequest { 618 curl_off_t size; /* -1 if unknown at this point */ 619 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch, 620 -1 means unlimited */ 621 curl_off_t bytecount; /* total number of bytes read */ 622 curl_off_t writebytecount; /* number of bytes written */ 623 624 curl_off_t headerbytecount; /* only count received headers */ 625 curl_off_t deductheadercount; /* this amount of bytes doesn't count when we 626 check if anything has been transferred at 627 the end of a connection. We use this 628 counter to make only a 100 reply (without a 629 following second response code) result in a 630 CURLE_GOT_NOTHING error code */ 631 632 curl_off_t pendingheader; /* this many bytes left to send is actually 633 header and not body */ 634 struct curltime start; /* transfer started at this time */ 635 struct curltime now; /* current time */ 636 enum { 637 HEADER_NORMAL, /* no bad header at all */ 638 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest 639 is normal data */ 640 HEADER_ALLBAD /* all was believed to be header */ 641 } badheader; /* the header was deemed bad and will be 642 written as body */ 643 int headerline; /* counts header lines to better track the 644 first one */ 645 char *str; /* within buf */ 646 curl_off_t offset; /* possible resume offset read from the 647 Content-Range: header */ 648 int httpcode; /* error code from the 'HTTP/1.? XXX' or 649 'RTSP/1.? XXX' line */ 650 int keepon; 651 struct curltime start100; /* time stamp to wait for the 100 code from */ 652 enum expect100 exp100; /* expect 100 continue state */ 653 enum upgrade101 upgr101; /* 101 upgrade state */ 654 655 /* Content unencoding stack. See sec 3.5, RFC2616. */ 656 struct contenc_writer *writer_stack; 657 time_t timeofdoc; 658 long bodywrites; 659 char *location; /* This points to an allocated version of the Location: 660 header data */ 661 char *newurl; /* Set to the new URL to use when a redirect or a retry is 662 wanted */ 663 664 /* 'upload_present' is used to keep a byte counter of how much data there is 665 still left in the buffer, aimed for upload. */ 666 ssize_t upload_present; 667 668 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a 669 buffer, so the next read should read from where this pointer points to, 670 and the 'upload_present' contains the number of bytes available at this 671 position */ 672 char *upload_fromhere; 673 674 /* Allocated protocol-specific data. Each protocol handler makes sure this 675 points to data it needs. */ 676 union { 677 struct FILEPROTO *file; 678 struct FTP *ftp; 679 struct HTTP *http; 680 struct IMAP *imap; 681 struct ldapreqinfo *ldap; 682 struct MQTT *mqtt; 683 struct POP3 *pop3; 684 struct RTSP *rtsp; 685 struct smb_request *smb; 686 struct SMTP *smtp; 687 struct SSHPROTO *ssh; 688 struct TELNET *telnet; 689 } p; 690 #ifndef CURL_DISABLE_DOH 691 struct dohdata *doh; /* DoH specific data for this request */ 692 #endif 693 BIT(header); /* incoming data has HTTP header */ 694 BIT(content_range); /* set TRUE if Content-Range: was found */ 695 BIT(upload_done); /* set to TRUE when doing chunked transfer-encoding 696 upload and we're uploading the last chunk */ 697 BIT(ignorebody); /* we read a response-body but we ignore it! */ 698 BIT(http_bodyless); /* HTTP response status code is between 100 and 199, 699 204 or 304 */ 700 BIT(chunk); /* if set, this is a chunked transfer-encoding */ 701 BIT(upload_chunky); /* set TRUE if we are doing chunked transfer-encoding 702 on upload */ 703 BIT(getheader); /* TRUE if header parsing is wanted */ 704 BIT(forbidchunk); /* used only to explicitly forbid chunk-upload for 705 specific upload buffers. See readmoredata() in http.c 706 for details. */ 707 }; 708 709 /* 710 * Specific protocol handler. 711 */ 712 713 struct Curl_handler { 714 const char *scheme; /* URL scheme name. */ 715 716 /* Complement to setup_connection_internals(). This is done before the 717 transfer "owns" the connection. */ 718 CURLcode (*setup_connection)(struct Curl_easy *data, 719 struct connectdata *conn); 720 721 /* These two functions MUST be set to be protocol dependent */ 722 CURLcode (*do_it)(struct Curl_easy *data, bool *done); 723 CURLcode (*done)(struct Curl_easy *, CURLcode, bool); 724 725 /* If the curl_do() function is better made in two halves, this 726 * curl_do_more() function will be called afterwards, if set. For example 727 * for doing the FTP stuff after the PASV/PORT command. 728 */ 729 CURLcode (*do_more)(struct Curl_easy *, int *); 730 731 /* This function *MAY* be set to a protocol-dependent function that is run 732 * after the connect() and everything is done, as a step in the connection. 733 * The 'done' pointer points to a bool that should be set to TRUE if the 734 * function completes before return. If it doesn't complete, the caller 735 * should call the curl_connecting() function until it is. 736 */ 737 CURLcode (*connect_it)(struct Curl_easy *data, bool *done); 738 739 /* See above. */ 740 CURLcode (*connecting)(struct Curl_easy *data, bool *done); 741 CURLcode (*doing)(struct Curl_easy *data, bool *done); 742 743 /* Called from the multi interface during the PROTOCONNECT phase, and it 744 should then return a proper fd set */ 745 int (*proto_getsock)(struct Curl_easy *data, 746 struct connectdata *conn, curl_socket_t *socks); 747 748 /* Called from the multi interface during the DOING phase, and it should 749 then return a proper fd set */ 750 int (*doing_getsock)(struct Curl_easy *data, 751 struct connectdata *conn, curl_socket_t *socks); 752 753 /* Called from the multi interface during the DO_MORE phase, and it should 754 then return a proper fd set */ 755 int (*domore_getsock)(struct Curl_easy *data, 756 struct connectdata *conn, curl_socket_t *socks); 757 758 /* Called from the multi interface during the DO_DONE, PERFORM and 759 WAITPERFORM phases, and it should then return a proper fd set. Not setting 760 this will make libcurl use the generic default one. */ 761 int (*perform_getsock)(struct Curl_easy *data, 762 struct connectdata *conn, curl_socket_t *socks); 763 764 /* This function *MAY* be set to a protocol-dependent function that is run 765 * by the curl_disconnect(), as a step in the disconnection. If the handler 766 * is called because the connection has been considered dead, 767 * dead_connection is set to TRUE. The connection is already disassociated 768 * from the transfer here. 769 */ 770 CURLcode (*disconnect)(struct Curl_easy *, struct connectdata *, 771 bool dead_connection); 772 773 /* If used, this function gets called from transfer.c:readwrite_data() to 774 allow the protocol to do extra reads/writes */ 775 CURLcode (*readwrite)(struct Curl_easy *data, struct connectdata *conn, 776 ssize_t *nread, bool *readmore); 777 778 /* This function can perform various checks on the connection. See 779 CONNCHECK_* for more information about the checks that can be performed, 780 and CONNRESULT_* for the results that can be returned. */ 781 unsigned int (*connection_check)(struct Curl_easy *data, 782 struct connectdata *conn, 783 unsigned int checks_to_perform); 784 785 int defport; /* Default port. */ 786 unsigned int protocol; /* See CURLPROTO_* - this needs to be the single 787 specific protocol bit */ 788 unsigned int family; /* single bit for protocol family; basically the 789 non-TLS name of the protocol this is */ 790 unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */ 791 }; 792 793 #define PROTOPT_NONE 0 /* nothing extra */ 794 #define PROTOPT_SSL (1<<0) /* uses SSL */ 795 #define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */ 796 #define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */ 797 /* some protocols will have to call the underlying functions without regard to 798 what exact state the socket signals. IE even if the socket says "readable", 799 the send function might need to be called while uploading, or vice versa. 800 */ 801 #define PROTOPT_DIRLOCK (1<<3) 802 #define PROTOPT_NONETWORK (1<<4) /* protocol doesn't use the network! */ 803 #define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it 804 gets a default */ 805 #define PROTOPT_NOURLQUERY (1<<6) /* protocol can't handle 806 url query strings (?foo=bar) ! */ 807 #define PROTOPT_CREDSPERREQUEST (1<<7) /* requires login credentials per 808 request instead of per connection */ 809 #define PROTOPT_ALPN_NPN (1<<8) /* set ALPN and/or NPN for this */ 810 #define PROTOPT_STREAM (1<<9) /* a protocol with individual logical streams */ 811 #define PROTOPT_URLOPTIONS (1<<10) /* allow options part in the userinfo field 812 of the URL */ 813 #define PROTOPT_PROXY_AS_HTTP (1<<11) /* allow this non-HTTP scheme over a 814 HTTP proxy as HTTP proxies may know 815 this protocol and act as a gateway */ 816 #define PROTOPT_WILDCARD (1<<12) /* protocol supports wildcard matching */ 817 #define PROTOPT_USERPWDCTRL (1<<13) /* Allow "control bytes" (< 32 ascii) in 818 user name and password */ 819 820 #define CONNCHECK_NONE 0 /* No checks */ 821 #define CONNCHECK_ISDEAD (1<<0) /* Check if the connection is dead. */ 822 #define CONNCHECK_KEEPALIVE (1<<1) /* Perform any keepalive function. */ 823 824 #define CONNRESULT_NONE 0 /* No extra information. */ 825 #define CONNRESULT_DEAD (1<<0) /* The connection is dead. */ 826 827 #ifdef USE_RECV_BEFORE_SEND_WORKAROUND 828 struct postponed_data { 829 char *buffer; /* Temporal store for received data during 830 sending, must be freed */ 831 size_t allocated_size; /* Size of temporal store */ 832 size_t recv_size; /* Size of received data during sending */ 833 size_t recv_processed; /* Size of processed part of postponed data */ 834 #ifdef DEBUGBUILD 835 curl_socket_t bindsock;/* Structure must be bound to specific socket, 836 used only for DEBUGASSERT */ 837 #endif /* DEBUGBUILD */ 838 }; 839 #endif /* USE_RECV_BEFORE_SEND_WORKAROUND */ 840 841 struct proxy_info { 842 struct hostname host; 843 long port; 844 curl_proxytype proxytype; /* what kind of proxy that is in use */ 845 char *user; /* proxy user name string, allocated */ 846 char *passwd; /* proxy password string, allocated */ 847 }; 848 849 /* struct for HTTP CONNECT state data */ 850 struct http_connect_state { 851 struct dynbuf rcvbuf; 852 enum keeponval { 853 KEEPON_DONE, 854 KEEPON_CONNECT, 855 KEEPON_IGNORE 856 } keepon; 857 curl_off_t cl; /* size of content to read and ignore */ 858 enum { 859 TUNNEL_INIT, /* init/default/no tunnel state */ 860 TUNNEL_CONNECT, /* CONNECT has been sent off */ 861 TUNNEL_COMPLETE /* CONNECT response received completely */ 862 } tunnel_state; 863 BIT(chunked_encoding); 864 BIT(close_connection); 865 }; 866 867 struct ldapconninfo; 868 869 /* for the (SOCKS) connect state machine */ 870 enum connect_t { 871 CONNECT_INIT, 872 CONNECT_SOCKS_INIT, /* 1 */ 873 CONNECT_SOCKS_SEND, /* 2 waiting to send more first data */ 874 CONNECT_SOCKS_READ_INIT, /* 3 set up read */ 875 CONNECT_SOCKS_READ, /* 4 read server response */ 876 CONNECT_GSSAPI_INIT, /* 5 */ 877 CONNECT_AUTH_INIT, /* 6 setup outgoing auth buffer */ 878 CONNECT_AUTH_SEND, /* 7 send auth */ 879 CONNECT_AUTH_READ, /* 8 read auth response */ 880 CONNECT_REQ_INIT, /* 9 init SOCKS "request" */ 881 CONNECT_RESOLVING, /* 10 */ 882 CONNECT_RESOLVED, /* 11 */ 883 CONNECT_RESOLVE_REMOTE, /* 12 */ 884 CONNECT_REQ_SEND, /* 13 */ 885 CONNECT_REQ_SENDING, /* 14 */ 886 CONNECT_REQ_READ, /* 15 */ 887 CONNECT_REQ_READ_MORE, /* 16 */ 888 CONNECT_DONE /* 17 connected fine to the remote or the SOCKS proxy */ 889 }; 890 891 #define SOCKS_STATE(x) (((x) >= CONNECT_SOCKS_INIT) && \ 892 ((x) < CONNECT_DONE)) 893 894 struct connstate { 895 enum connect_t state; 896 ssize_t outstanding; /* send this many bytes more */ 897 unsigned char *outp; /* send from this pointer */ 898 }; 899 900 /* 901 * The connectdata struct contains all fields and variables that should be 902 * unique for an entire connection. 903 */ 904 struct connectdata { 905 /* 'data' is the CURRENT Curl_easy using this connection -- take great 906 caution that this might very well vary between different times this 907 connection is used! */ 908 struct Curl_easy *data; 909 struct connstate cnnct; 910 struct Curl_llist_element bundle_node; /* conncache */ 911 912 /* chunk is for HTTP chunked encoding, but is in the general connectdata 913 struct only because we can do just about any protocol through a HTTP proxy 914 and a HTTP proxy may in fact respond using chunked encoding */ 915 struct Curl_chunker chunk; 916 917 curl_closesocket_callback fclosesocket; /* function closing the socket(s) */ 918 void *closesocket_client; 919 920 /* This is used by the connection cache logic. If this returns TRUE, this 921 handle is still used by one or more easy handles and can only used by any 922 other easy handle without careful consideration (== only for 923 multiplexing) and it cannot be used by another multi handle! */ 924 #define CONN_INUSE(c) ((c)->easyq.size) 925 926 /**** Fields set when inited and not modified again */ 927 long connection_id; /* Contains a unique number to make it easier to 928 track the connections in the log output */ 929 930 /* 'dns_entry' is the particular host we use. This points to an entry in the 931 DNS cache and it will not get pruned while locked. It gets unlocked in 932 multi_done(). This entry will be NULL if the connection is re-used as then 933 there is no name resolve done. */ 934 struct Curl_dns_entry *dns_entry; 935 936 /* 'ip_addr' is the particular IP we connected to. It points to a struct 937 within the DNS cache, so this pointer is only valid as long as the DNS 938 cache entry remains locked. It gets unlocked in multi_done() */ 939 struct Curl_addrinfo *ip_addr; 940 struct Curl_addrinfo *tempaddr[2]; /* for happy eyeballs */ 941 942 unsigned int scope_id; /* Scope id for IPv6 */ 943 944 enum { 945 TRNSPRT_TCP = 3, 946 TRNSPRT_UDP = 4, 947 TRNSPRT_QUIC = 5 948 } transport; 949 950 #ifdef ENABLE_QUIC 951 struct quicsocket hequic[2]; /* two, for happy eyeballs! */ 952 struct quicsocket *quic; 953 #endif 954 955 struct hostname host; 956 char *hostname_resolve; /* host name to resolve to address, allocated */ 957 char *secondaryhostname; /* secondary socket host name (ftp) */ 958 struct hostname conn_to_host; /* the host to connect to. valid only if 959 bits.conn_to_host is set */ 960 #ifndef CURL_DISABLE_PROXY 961 struct proxy_info socks_proxy; 962 struct proxy_info http_proxy; 963 #endif 964 int port; /* which port to use locally - to connect to */ 965 int remote_port; /* the remote port, not the proxy port! */ 966 int conn_to_port; /* the remote port to connect to. valid only if 967 bits.conn_to_port is set */ 968 unsigned short secondary_port; /* secondary socket remote port to connect to 969 (ftp) */ 970 971 /* 'primary_ip' and 'primary_port' get filled with peer's numerical 972 ip address and port number whenever an outgoing connection is 973 *attempted* from the primary socket to a remote address. When more 974 than one address is tried for a connection these will hold data 975 for the last attempt. When the connection is actually established 976 these are updated with data which comes directly from the socket. */ 977 978 char primary_ip[MAX_IPADR_LEN]; 979 unsigned char ip_version; /* copied from the Curl_easy at creation time */ 980 981 char *user; /* user name string, allocated */ 982 char *passwd; /* password string, allocated */ 983 char *options; /* options string, allocated */ 984 985 char *sasl_authzid; /* authorisation identity string, allocated */ 986 987 int httpversion; /* the HTTP version*10 reported by the server */ 988 int rtspversion; /* the RTSP version*10 reported by the server */ 989 990 struct curltime now; /* "current" time */ 991 struct curltime created; /* creation time */ 992 struct curltime lastused; /* when returned to the connection cache */ 993 curl_socket_t sock[2]; /* two sockets, the second is used for the data 994 transfer when doing FTP */ 995 curl_socket_t tempsock[2]; /* temporary sockets for happy eyeballs */ 996 int tempfamily[2]; /* family used for the temp sockets */ 997 Curl_recv *recv[2]; 998 Curl_send *send[2]; 999 1000 #ifdef USE_RECV_BEFORE_SEND_WORKAROUND 1001 struct postponed_data postponed[2]; /* two buffers for two sockets */ 1002 #endif /* USE_RECV_BEFORE_SEND_WORKAROUND */ 1003 struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */ 1004 #ifndef CURL_DISABLE_PROXY 1005 struct ssl_connect_data proxy_ssl[2]; /* this is for proxy ssl-stuff */ 1006 #endif 1007 #ifdef USE_SSL 1008 void *ssl_extra; /* separately allocated backend-specific data */ 1009 #endif 1010 struct ssl_primary_config ssl_config; 1011 #ifndef CURL_DISABLE_PROXY 1012 struct ssl_primary_config proxy_ssl_config; 1013 #endif 1014 struct ConnectBits bits; /* various state-flags for this connection */ 1015 1016 /* The field below gets set in Curl_connecthost */ 1017 int num_addr; /* number of addresses to try to connect to */ 1018 /* connecttime: when connect() is called on the current IP address. Used to 1019 be able to track when to move on to try next IP - but only when the multi 1020 interface is used. */ 1021 struct curltime connecttime; 1022 1023 /* The field below gets set in Curl_connecthost */ 1024 /* how long time in milliseconds to spend on trying to connect to each IP 1025 address, per family */ 1026 timediff_t timeoutms_per_addr[2]; 1027 1028 const struct Curl_handler *handler; /* Connection's protocol handler */ 1029 const struct Curl_handler *given; /* The protocol first given */ 1030 1031 /* Protocols can use a custom keepalive mechanism to keep connections alive. 1032 This allows those protocols to track the last time the keepalive mechanism 1033 was used on this connection. */ 1034 struct curltime keepalive; 1035 1036 /**** curl_get() phase fields */ 1037 1038 curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */ 1039 curl_socket_t writesockfd; /* socket to write to, it may very 1040 well be the same we read from. 1041 CURL_SOCKET_BAD disables */ 1042 1043 #ifdef HAVE_GSSAPI 1044 BIT(sec_complete); /* if Kerberos is enabled for this connection */ 1045 enum protection_level command_prot; 1046 enum protection_level data_prot; 1047 enum protection_level request_data_prot; 1048 size_t buffer_size; 1049 struct krb5buffer in_buffer; 1050 void *app_data; 1051 const struct Curl_sec_client_mech *mech; 1052 struct sockaddr_in local_addr; 1053 #endif 1054 1055 #if defined(USE_KERBEROS5) /* Consider moving some of the above GSS-API */ 1056 struct kerberos5data krb5; /* variables into the structure definition, */ 1057 #endif /* however, some of them are ftp specific. */ 1058 1059 struct Curl_llist easyq; /* List of easy handles using this connection */ 1060 curl_seek_callback seek_func; /* function that seeks the input */ 1061 void *seek_client; /* pointer to pass to the seek() above */ 1062 1063 /*************** Request - specific items ************/ 1064 #if defined(USE_WINDOWS_SSPI) && defined(SECPKG_ATTR_ENDPOINT_BINDINGS) 1065 CtxtHandle *sslContext; 1066 #endif 1067 1068 #if defined(USE_NTLM) 1069 curlntlm http_ntlm_state; 1070 curlntlm proxy_ntlm_state; 1071 1072 struct ntlmdata ntlm; /* NTLM differs from other authentication schemes 1073 because it authenticates connections, not 1074 single requests! */ 1075 struct ntlmdata proxyntlm; /* NTLM data for proxy */ 1076 #endif 1077 1078 #ifdef USE_SPNEGO 1079 curlnegotiate http_negotiate_state; 1080 curlnegotiate proxy_negotiate_state; 1081 1082 struct negotiatedata negotiate; /* state data for host Negotiate auth */ 1083 struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */ 1084 #endif 1085 1086 /* for chunked-encoded trailer */ 1087 struct dynbuf trailer; 1088 1089 union { 1090 struct ftp_conn ftpc; 1091 struct http_conn httpc; 1092 struct ssh_conn sshc; 1093 struct tftp_state_data *tftpc; 1094 struct imap_conn imapc; 1095 struct pop3_conn pop3c; 1096 struct smtp_conn smtpc; 1097 struct rtsp_conn rtspc; 1098 struct smb_conn smbc; 1099 void *rtmp; 1100 struct ldapconninfo *ldapc; 1101 struct mqtt_conn mqtt; 1102 } proto; 1103 1104 struct http_connect_state *connect_state; /* for HTTP CONNECT */ 1105 struct connectbundle *bundle; /* The bundle we are member of */ 1106 #ifdef USE_UNIX_SOCKETS 1107 char *unix_domain_socket; 1108 #endif 1109 #ifdef USE_HYPER 1110 /* if set, an alternative data transfer function */ 1111 Curl_datastream datastream; 1112 #endif 1113 /* When this connection is created, store the conditions for the local end 1114 bind. This is stored before the actual bind and before any connection is 1115 made and will serve the purpose of being used for comparison reasons so 1116 that subsequent bound-requested connections aren't accidentally re-using 1117 wrong connections. */ 1118 char *localdev; 1119 int localportrange; 1120 int cselect_bits; /* bitmask of socket events */ 1121 int waitfor; /* current READ/WRITE bits to wait for */ 1122 int negnpn; /* APLN or NPN TLS negotiated protocol, CURL_HTTP_VERSION* */ 1123 1124 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI) 1125 int socks5_gssapi_enctype; 1126 #endif 1127 unsigned short localport; 1128 }; 1129 1130 /* The end of connectdata. */ 1131 1132 /* 1133 * Struct to keep statistical and informational data. 1134 * All variables in this struct must be initialized/reset in Curl_initinfo(). 1135 */ 1136 struct PureInfo { 1137 int httpcode; /* Recent HTTP, FTP, RTSP or SMTP response code */ 1138 int httpproxycode; /* response code from proxy when received separate */ 1139 int httpversion; /* the http version number X.Y = X*10+Y */ 1140 time_t filetime; /* If requested, this is might get set. Set to -1 if the 1141 time was unretrievable. */ 1142 curl_off_t header_size; /* size of read header(s) in bytes */ 1143 curl_off_t request_size; /* the amount of bytes sent in the request(s) */ 1144 unsigned long proxyauthavail; /* what proxy auth types were announced */ 1145 unsigned long httpauthavail; /* what host auth types were announced */ 1146 long numconnects; /* how many new connection did libcurl created */ 1147 char *contenttype; /* the content type of the object */ 1148 char *wouldredirect; /* URL this would've been redirected to if asked to */ 1149 curl_off_t retry_after; /* info from Retry-After: header */ 1150 1151 /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip' 1152 and, 'conn_local_port' are copied over from the connectdata struct in 1153 order to allow curl_easy_getinfo() to return this information even when 1154 the session handle is no longer associated with a connection, and also 1155 allow curl_easy_reset() to clear this information from the session handle 1156 without disturbing information which is still alive, and that might be 1157 reused, in the connection cache. */ 1158 1159 char conn_primary_ip[MAX_IPADR_LEN]; 1160 long conn_primary_port; 1161 char conn_local_ip[MAX_IPADR_LEN]; 1162 long conn_local_port; 1163 const char *conn_scheme; 1164 unsigned int conn_protocol; 1165 struct curl_certinfo certs; /* info about the certs, only populated in 1166 OpenSSL, GnuTLS, Schannel, NSS and GSKit 1167 builds. Asked for with CURLOPT_CERTINFO 1168 / CURLINFO_CERTINFO */ 1169 CURLproxycode pxcode; 1170 BIT(timecond); /* set to TRUE if the time condition didn't match, which 1171 thus made the document NOT get fetched */ 1172 }; 1173 1174 1175 struct Progress { 1176 time_t lastshow; /* time() of the last displayed progress meter or NULL to 1177 force redraw at next call */ 1178 curl_off_t size_dl; /* total expected size */ 1179 curl_off_t size_ul; /* total expected size */ 1180 curl_off_t downloaded; /* transferred so far */ 1181 curl_off_t uploaded; /* transferred so far */ 1182 1183 curl_off_t current_speed; /* uses the currently fastest transfer */ 1184 1185 int width; /* screen width at download start */ 1186 int flags; /* see progress.h */ 1187 1188 timediff_t timespent; 1189 1190 curl_off_t dlspeed; 1191 curl_off_t ulspeed; 1192 1193 timediff_t t_nslookup; 1194 timediff_t t_connect; 1195 timediff_t t_appconnect; 1196 timediff_t t_pretransfer; 1197 timediff_t t_starttransfer; 1198 timediff_t t_redirect; 1199 1200 struct curltime start; 1201 struct curltime t_startsingle; 1202 struct curltime t_startop; 1203 struct curltime t_acceptdata; 1204 1205 1206 /* upload speed limit */ 1207 struct curltime ul_limit_start; 1208 curl_off_t ul_limit_size; 1209 /* download speed limit */ 1210 struct curltime dl_limit_start; 1211 curl_off_t dl_limit_size; 1212 1213 #define CURR_TIME (5 + 1) /* 6 entries for 5 seconds */ 1214 1215 curl_off_t speeder[ CURR_TIME ]; 1216 struct curltime speeder_time[ CURR_TIME ]; 1217 int speeder_c; 1218 BIT(callback); /* set when progress callback is used */ 1219 BIT(is_t_startransfer_set); 1220 }; 1221 1222 typedef enum { 1223 RTSPREQ_NONE, /* first in list */ 1224 RTSPREQ_OPTIONS, 1225 RTSPREQ_DESCRIBE, 1226 RTSPREQ_ANNOUNCE, 1227 RTSPREQ_SETUP, 1228 RTSPREQ_PLAY, 1229 RTSPREQ_PAUSE, 1230 RTSPREQ_TEARDOWN, 1231 RTSPREQ_GET_PARAMETER, 1232 RTSPREQ_SET_PARAMETER, 1233 RTSPREQ_RECORD, 1234 RTSPREQ_RECEIVE, 1235 RTSPREQ_LAST /* last in list */ 1236 } Curl_RtspReq; 1237 1238 struct auth { 1239 unsigned long want; /* Bitmask set to the authentication methods wanted by 1240 app (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */ 1241 unsigned long picked; 1242 unsigned long avail; /* Bitmask for what the server reports to support for 1243 this resource */ 1244 BIT(done); /* TRUE when the auth phase is done and ready to do the 1245 actual request */ 1246 BIT(multipass); /* TRUE if this is not yet authenticated but within the 1247 auth multipass negotiation */ 1248 BIT(iestyle); /* TRUE if digest should be done IE-style or FALSE if it 1249 should be RFC compliant */ 1250 }; 1251 1252 struct Curl_http2_dep { 1253 struct Curl_http2_dep *next; 1254 struct Curl_easy *data; 1255 }; 1256 1257 /* 1258 * This struct is for holding data that was attempted to get sent to the user's 1259 * callback but is held due to pausing. One instance per type (BOTH, HEADER, 1260 * BODY). 1261 */ 1262 struct tempbuf { 1263 struct dynbuf b; 1264 int type; /* type of the 'tempwrite' buffer as a bitmask that is used with 1265 Curl_client_write() */ 1266 }; 1267 1268 /* Timers */ 1269 typedef enum { 1270 EXPIRE_100_TIMEOUT, 1271 EXPIRE_ASYNC_NAME, 1272 EXPIRE_CONNECTTIMEOUT, 1273 EXPIRE_DNS_PER_NAME, /* family1 */ 1274 EXPIRE_DNS_PER_NAME2, /* family2 */ 1275 EXPIRE_HAPPY_EYEBALLS_DNS, /* See asyn-ares.c */ 1276 EXPIRE_HAPPY_EYEBALLS, 1277 EXPIRE_MULTI_PENDING, 1278 EXPIRE_RUN_NOW, 1279 EXPIRE_SPEEDCHECK, 1280 EXPIRE_TIMEOUT, 1281 EXPIRE_TOOFAST, 1282 EXPIRE_QUIC, 1283 EXPIRE_LAST /* not an actual timer, used as a marker only */ 1284 } expire_id; 1285 1286 1287 typedef enum { 1288 TRAILERS_NONE, 1289 TRAILERS_INITIALIZED, 1290 TRAILERS_SENDING, 1291 TRAILERS_DONE 1292 } trailers_state; 1293 1294 1295 /* 1296 * One instance for each timeout an easy handle can set. 1297 */ 1298 struct time_node { 1299 struct Curl_llist_element list; 1300 struct curltime time; 1301 expire_id eid; 1302 }; 1303 1304 /* individual pieces of the URL */ 1305 struct urlpieces { 1306 char *scheme; 1307 char *hostname; 1308 char *port; 1309 char *user; 1310 char *password; 1311 char *options; 1312 char *path; 1313 char *query; 1314 }; 1315 1316 struct UrlState { 1317 /* Points to the connection cache */ 1318 struct conncache *conn_cache; 1319 int retrycount; /* number of retries on a new connection */ 1320 1321 /* buffers to store authentication data in, as parsed from input options */ 1322 struct curltime keeps_speed; /* for the progress meter really */ 1323 1324 long lastconnect_id; /* The last connection, -1 if undefined */ 1325 struct dynbuf headerb; /* buffer to store headers in */ 1326 1327 char *buffer; /* download buffer */ 1328 char *ulbuf; /* allocated upload buffer or NULL */ 1329 curl_off_t current_speed; /* the ProgressShow() function sets this, 1330 bytes / second */ 1331 char *first_host; /* host name of the first (not followed) request. 1332 if set, this should be the host name that we will 1333 sent authorization to, no else. Used to make Location: 1334 following not keep sending user+password... This is 1335 strdup() data. 1336 */ 1337 int first_remote_port; /* remote port of the first (not followed) request */ 1338 struct Curl_ssl_session *session; /* array of 'max_ssl_sessions' size */ 1339 long sessionage; /* number of the most recent session */ 1340 struct tempbuf tempwrite[3]; /* BOTH, HEADER, BODY */ 1341 unsigned int tempcount; /* number of entries in use in tempwrite, 0 - 3 */ 1342 int os_errno; /* filled in with errno whenever an error occurs */ 1343 char *scratch; /* huge buffer[set.buffer_size*2] for upload CRLF replacing */ 1344 #ifdef HAVE_SIGNAL 1345 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */ 1346 void (*prev_signal)(int sig); 1347 #endif 1348 struct digestdata digest; /* state data for host Digest auth */ 1349 struct digestdata proxydigest; /* state data for proxy Digest auth */ 1350 1351 struct auth authhost; /* auth details for host */ 1352 struct auth authproxy; /* auth details for proxy */ 1353 #ifdef USE_CURL_ASYNC 1354 struct Curl_async async; /* asynchronous name resolver data */ 1355 #endif 1356 1357 #if defined(USE_OPENSSL) 1358 /* void instead of ENGINE to avoid bleeding OpenSSL into this header */ 1359 void *engine; 1360 #endif /* USE_OPENSSL */ 1361 struct curltime expiretime; /* set this with Curl_expire() only */ 1362 struct Curl_tree timenode; /* for the splay stuff */ 1363 struct Curl_llist timeoutlist; /* list of pending timeouts */ 1364 struct time_node expires[EXPIRE_LAST]; /* nodes for each expire type */ 1365 1366 /* a place to store the most recently set FTP entrypath */ 1367 char *most_recent_ftp_entrypath; 1368 1369 int httpversion; /* the lowest HTTP version*10 reported by any server 1370 involved in this request */ 1371 1372 #if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) 1373 /* do FTP line-end conversions on most platforms */ 1374 #define CURL_DO_LINEEND_CONV 1375 /* for FTP downloads: track CRLF sequences that span blocks */ 1376 BIT(prev_block_had_trailing_cr); 1377 /* for FTP downloads: how many CRLFs did we converted to LFs? */ 1378 curl_off_t crlf_conversions; 1379 #endif 1380 char *range; /* range, if used. See README for detailed specification on 1381 this syntax. */ 1382 curl_off_t resume_from; /* continue [ftp] transfer from here */ 1383 1384 /* This RTSP state information survives requests and connections */ 1385 long rtsp_next_client_CSeq; /* the session's next client CSeq */ 1386 long rtsp_next_server_CSeq; /* the session's next server CSeq */ 1387 long rtsp_CSeq_recv; /* most recent CSeq received */ 1388 1389 curl_off_t infilesize; /* size of file to upload, -1 means unknown. 1390 Copied from set.filesize at start of operation */ 1391 1392 size_t drain; /* Increased when this stream has data to read, even if its 1393 socket is not necessarily is readable. Decreased when 1394 checked. */ 1395 1396 curl_read_callback fread_func; /* read callback/function */ 1397 void *in; /* CURLOPT_READDATA */ 1398 1399 struct Curl_easy *stream_depends_on; 1400 int stream_weight; 1401 CURLU *uh; /* URL handle for the current parsed URL */ 1402 struct urlpieces up; 1403 #if !defined(CURL_DISABLE_HTTP) || !defined(CURL_DISABLE_MQTT) 1404 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */ 1405 #endif 1406 #ifndef CURL_DISABLE_HTTP 1407 size_t trailers_bytes_sent; 1408 struct dynbuf trailers_buf; /* a buffer containing the compiled trailing 1409 headers */ 1410 #endif 1411 trailers_state trailers_state; /* whether we are sending trailers 1412 and what stage are we at */ 1413 #ifdef USE_HYPER 1414 CURLcode hresult; /* used to pass return codes back from hyper callbacks */ 1415 #endif 1416 1417 /* Dynamically allocated strings, MUST be freed before this struct is 1418 killed. */ 1419 struct dynamically_allocated_data { 1420 char *proxyuserpwd; 1421 char *uagent; 1422 char *accept_encoding; 1423 char *userpwd; 1424 char *rangeline; 1425 char *ref; 1426 char *host; 1427 char *cookiehost; 1428 char *rtsp_transport; 1429 char *te; /* TE: request header */ 1430 } aptr; 1431 1432 #ifdef CURLDEBUG 1433 BIT(conncache_lock); 1434 #endif 1435 /* when curl_easy_perform() is called, the multi handle is "owned" by 1436 the easy handle so curl_easy_cleanup() on such an easy handle will 1437 also close the multi handle! */ 1438 BIT(multi_owned_by_easy); 1439 1440 BIT(this_is_a_follow); /* this is a followed Location: request */ 1441 BIT(refused_stream); /* this was refused, try again */ 1442 BIT(errorbuf); /* Set to TRUE if the error buffer is already filled in. 1443 This must be set to FALSE every time _easy_perform() is 1444 called. */ 1445 BIT(allow_port); /* Is set.use_port allowed to take effect or not. This 1446 is always set TRUE when curl_easy_perform() is called. */ 1447 BIT(authproblem); /* TRUE if there's some problem authenticating */ 1448 /* set after initial USER failure, to prevent an authentication loop */ 1449 BIT(ftp_trying_alternative); 1450 BIT(wildcardmatch); /* enable wildcard matching */ 1451 BIT(expect100header); /* TRUE if we added Expect: 100-continue */ 1452 BIT(disableexpect); /* TRUE if Expect: is disabled due to a previous 1453 417 response */ 1454 BIT(use_range); 1455 BIT(rangestringalloc); /* the range string is malloc()'ed */ 1456 BIT(done); /* set to FALSE when Curl_init_do() is called and set to TRUE 1457 when multi_done() is called, to prevent multi_done() to get 1458 invoked twice when the multi interface is used. */ 1459 BIT(stream_depends_e); /* set or don't set the Exclusive bit */ 1460 BIT(previouslypending); /* this transfer WAS in the multi->pending queue */ 1461 BIT(cookie_engine); 1462 }; 1463 1464 1465 /* 1466 * This 'DynamicStatic' struct defines dynamic states that actually change 1467 * values in the 'UserDefined' area, which MUST be taken into consideration 1468 * if the UserDefined struct is cloned or similar. You can probably just 1469 * copy these, but each one indicate a special action on other data. 1470 */ 1471 1472 struct DynamicStatic { 1473 char *url; /* work URL, copied from UserDefined */ 1474 char *referer; /* referer string */ 1475 struct curl_slist *cookielist; /* list of cookie files set by 1476 curl_easy_setopt(COOKIEFILE) calls */ 1477 struct curl_slist *resolve; /* set to point to the set.resolve list when 1478 this should be dealt with in pretransfer */ 1479 BIT(url_alloc); /* URL string is malloc()'ed */ 1480 BIT(referer_alloc); /* referer string is malloc()ed */ 1481 BIT(wildcard_resolve); /* Set to true if any resolve change is a 1482 wildcard */ 1483 }; 1484 1485 /* 1486 * This 'UserDefined' struct must only contain data that is set once to go 1487 * for many (perhaps) independent connections. Values that are generated or 1488 * calculated internally for the "session handle" MUST be defined within the 1489 * 'struct UrlState' instead. The only exceptions MUST note the changes in 1490 * the 'DynamicStatic' struct. 1491 * Character pointer fields point to dynamic storage, unless otherwise stated. 1492 */ 1493 1494 struct Curl_multi; /* declared and used only in multi.c */ 1495 1496 /* 1497 * This enumeration MUST not use conditional directives (#ifdefs), new 1498 * null terminated strings MUST be added to the enumeration immediately 1499 * before STRING_LASTZEROTERMINATED, binary fields immediately before 1500 * STRING_LAST. When doing so, ensure that the packages/OS400/chkstring.c 1501 * test is updated and applicable changes for EBCDIC to ASCII conversion 1502 * are catered for in curl_easy_setopt_ccsid() 1503 */ 1504 enum dupstring { 1505 STRING_CERT_ORIG, /* client certificate file name */ 1506 STRING_CERT_PROXY, /* client certificate file name */ 1507 STRING_CERT_TYPE_ORIG, /* format for certificate (default: PEM)*/ 1508 STRING_CERT_TYPE_PROXY, /* format for certificate (default: PEM)*/ 1509 STRING_COOKIE, /* HTTP cookie string to send */ 1510 STRING_COOKIEJAR, /* dump all cookies to this file */ 1511 STRING_CUSTOMREQUEST, /* HTTP/FTP/RTSP request/method to use */ 1512 STRING_DEFAULT_PROTOCOL, /* Protocol to use when the URL doesn't specify */ 1513 STRING_DEVICE, /* local network interface/address to use */ 1514 STRING_ENCODING, /* Accept-Encoding string */ 1515 STRING_FTP_ACCOUNT, /* ftp account data */ 1516 STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */ 1517 STRING_FTPPORT, /* port to send with the FTP PORT command */ 1518 STRING_KEY_ORIG, /* private key file name */ 1519 STRING_KEY_PROXY, /* private key file name */ 1520 STRING_KEY_PASSWD_ORIG, /* plain text private key password */ 1521 STRING_KEY_PASSWD_PROXY, /* plain text private key password */ 1522 STRING_KEY_TYPE_ORIG, /* format for private key (default: PEM) */ 1523 STRING_KEY_TYPE_PROXY, /* format for private key (default: PEM) */ 1524 STRING_KRB_LEVEL, /* krb security level */ 1525 STRING_NETRC_FILE, /* if not NULL, use this instead of trying to find 1526 $HOME/.netrc */ 1527 STRING_PROXY, /* proxy to use */ 1528 STRING_PRE_PROXY, /* pre socks proxy to use */ 1529 STRING_SET_RANGE, /* range, if used */ 1530 STRING_SET_REFERER, /* custom string for the HTTP referer field */ 1531 STRING_SET_URL, /* what original URL to work on */ 1532 STRING_SSL_CAPATH_ORIG, /* CA directory name (doesn't work on windows) */ 1533 STRING_SSL_CAPATH_PROXY, /* CA directory name (doesn't work on windows) */ 1534 STRING_SSL_CAFILE_ORIG, /* certificate file to verify peer against */ 1535 STRING_SSL_CAFILE_PROXY, /* certificate file to verify peer against */ 1536 STRING_SSL_PINNEDPUBLICKEY_ORIG, /* public key file to verify peer against */ 1537 STRING_SSL_PINNEDPUBLICKEY_PROXY, /* public key file to verify proxy */ 1538 STRING_SSL_CIPHER_LIST_ORIG, /* list of ciphers to use */ 1539 STRING_SSL_CIPHER_LIST_PROXY, /* list of ciphers to use */ 1540 STRING_SSL_CIPHER13_LIST_ORIG, /* list of TLS 1.3 ciphers to use */ 1541 STRING_SSL_CIPHER13_LIST_PROXY, /* list of TLS 1.3 ciphers to use */ 1542 STRING_SSL_EGDSOCKET, /* path to file containing the EGD daemon socket */ 1543 STRING_SSL_RANDOM_FILE, /* path to file containing "random" data */ 1544 STRING_USERAGENT, /* User-Agent string */ 1545 STRING_SSL_CRLFILE_ORIG, /* crl file to check certificate */ 1546 STRING_SSL_CRLFILE_PROXY, /* crl file to check certificate */ 1547 STRING_SSL_ISSUERCERT_ORIG, /* issuer cert file to check certificate */ 1548 STRING_SSL_ISSUERCERT_PROXY, /* issuer cert file to check certificate */ 1549 STRING_SSL_ENGINE, /* name of ssl engine */ 1550 STRING_USERNAME, /* <username>, if used */ 1551 STRING_PASSWORD, /* <password>, if used */ 1552 STRING_OPTIONS, /* <options>, if used */ 1553 STRING_PROXYUSERNAME, /* Proxy <username>, if used */ 1554 STRING_PROXYPASSWORD, /* Proxy <password>, if used */ 1555 STRING_NOPROXY, /* List of hosts which should not use the proxy, if 1556 used */ 1557 STRING_RTSP_SESSION_ID, /* Session ID to use */ 1558 STRING_RTSP_STREAM_URI, /* Stream URI for this request */ 1559 STRING_RTSP_TRANSPORT, /* Transport for this session */ 1560 STRING_SSH_PRIVATE_KEY, /* path to the private key file for auth */ 1561 STRING_SSH_PUBLIC_KEY, /* path to the public key file for auth */ 1562 STRING_SSH_HOST_PUBLIC_KEY_MD5, /* md5 of host public key in ascii hex */ 1563 STRING_SSH_KNOWNHOSTS, /* file name of knownhosts file */ 1564 STRING_PROXY_SERVICE_NAME, /* Proxy service name */ 1565 STRING_SERVICE_NAME, /* Service name */ 1566 STRING_MAIL_FROM, 1567 STRING_MAIL_AUTH, 1568 STRING_TLSAUTH_USERNAME_ORIG, /* TLS auth <username> */ 1569 STRING_TLSAUTH_USERNAME_PROXY, /* TLS auth <username> */ 1570 STRING_TLSAUTH_PASSWORD_ORIG, /* TLS auth <password> */ 1571 STRING_TLSAUTH_PASSWORD_PROXY, /* TLS auth <password> */ 1572 STRING_BEARER, /* <bearer>, if used */ 1573 STRING_UNIX_SOCKET_PATH, /* path to Unix socket, if used */ 1574 STRING_TARGET, /* CURLOPT_REQUEST_TARGET */ 1575 STRING_DOH, /* CURLOPT_DOH_URL */ 1576 STRING_ALTSVC, /* CURLOPT_ALTSVC */ 1577 STRING_HSTS, /* CURLOPT_HSTS */ 1578 STRING_SASL_AUTHZID, /* CURLOPT_SASL_AUTHZID */ 1579 STRING_DNS_SERVERS, 1580 STRING_DNS_INTERFACE, 1581 STRING_DNS_LOCAL_IP4, 1582 STRING_DNS_LOCAL_IP6, 1583 STRING_SSL_EC_CURVES, 1584 1585 /* -- end of null-terminated strings -- */ 1586 1587 STRING_LASTZEROTERMINATED, 1588 1589 /* -- below this are pointers to binary data that cannot be strdup'ed. --- */ 1590 1591 STRING_COPYPOSTFIELDS, /* if POST, set the fields' values here */ 1592 1593 STRING_AWS_SIGV4, /* Parameters for V4 signature */ 1594 1595 STRING_LAST /* not used, just an end-of-list marker */ 1596 }; 1597 1598 enum dupblob { 1599 BLOB_CERT_ORIG, 1600 BLOB_CERT_PROXY, 1601 BLOB_KEY_ORIG, 1602 BLOB_KEY_PROXY, 1603 BLOB_SSL_ISSUERCERT_ORIG, 1604 BLOB_SSL_ISSUERCERT_PROXY, 1605 BLOB_LAST 1606 }; 1607 1608 /* callback that gets called when this easy handle is completed within a multi 1609 handle. Only used for internally created transfers, like for example 1610 DoH. */ 1611 typedef int (*multidone_func)(struct Curl_easy *easy, CURLcode result); 1612 1613 struct UserDefined { 1614 FILE *err; /* the stderr user data goes here */ 1615 void *debugdata; /* the data that will be passed to fdebug */ 1616 char *errorbuffer; /* (Static) store failure messages in here */ 1617 long proxyport; /* If non-zero, use this port number by default. If the 1618 proxy string features a ":[port]" that one will override 1619 this. */ 1620 void *out; /* CURLOPT_WRITEDATA */ 1621 void *in_set; /* CURLOPT_READDATA */ 1622 void *writeheader; /* write the header to this if non-NULL */ 1623 void *rtp_out; /* write RTP to this if non-NULL */ 1624 long use_port; /* which port to use (when not using default) */ 1625 unsigned long httpauth; /* kind of HTTP authentication to use (bitmask) */ 1626 unsigned long proxyauth; /* kind of proxy authentication to use (bitmask) */ 1627 unsigned long socks5auth;/* kind of SOCKS5 authentication to use (bitmask) */ 1628 long followlocation; /* as in HTTP Location: */ 1629 long maxredirs; /* maximum no. of http(s) redirects to follow, set to -1 1630 for infinity */ 1631 1632 int keep_post; /* keep POSTs as POSTs after a 30x request; each 1633 bit represents a request, from 301 to 303 */ 1634 void *postfields; /* if POST, set the fields' values here */ 1635 curl_seek_callback seek_func; /* function that seeks the input */ 1636 curl_off_t postfieldsize; /* if POST, this might have a size to use instead 1637 of strlen(), and then the data *may* be binary 1638 (contain zero bytes) */ 1639 unsigned short localport; /* local port number to bind to */ 1640 int localportrange; /* number of additional port numbers to test in case the 1641 'localport' one can't be bind()ed */ 1642 curl_write_callback fwrite_func; /* function that stores the output */ 1643 curl_write_callback fwrite_header; /* function that stores headers */ 1644 curl_write_callback fwrite_rtp; /* function that stores interleaved RTP */ 1645 curl_read_callback fread_func_set; /* function that reads the input */ 1646 curl_progress_callback fprogress; /* OLD and deprecated progress callback */ 1647 curl_xferinfo_callback fxferinfo; /* progress callback */ 1648 curl_debug_callback fdebug; /* function that write informational data */ 1649 curl_ioctl_callback ioctl_func; /* function for I/O control */ 1650 curl_sockopt_callback fsockopt; /* function for setting socket options */ 1651 void *sockopt_client; /* pointer to pass to the socket options callback */ 1652 curl_opensocket_callback fopensocket; /* function for checking/translating 1653 the address and opening the 1654 socket */ 1655 void *opensocket_client; 1656 curl_closesocket_callback fclosesocket; /* function for closing the 1657 socket */ 1658 void *closesocket_client; 1659 1660 void *seek_client; /* pointer to pass to the seek callback */ 1661 /* the 3 curl_conv_callback functions below are used on non-ASCII hosts */ 1662 /* function to convert from the network encoding: */ 1663 curl_conv_callback convfromnetwork; 1664 /* function to convert to the network encoding: */ 1665 curl_conv_callback convtonetwork; 1666 /* function to convert from UTF-8 encoding: */ 1667 curl_conv_callback convfromutf8; 1668 #ifdef USE_HSTS 1669 curl_hstsread_callback hsts_read; 1670 void *hsts_read_userp; 1671 curl_hstswrite_callback hsts_write; 1672 void *hsts_write_userp; 1673 #endif 1674 void *progress_client; /* pointer to pass to the progress callback */ 1675 void *ioctl_client; /* pointer to pass to the ioctl callback */ 1676 long timeout; /* in milliseconds, 0 means no timeout */ 1677 long connecttimeout; /* in milliseconds, 0 means no timeout */ 1678 long accepttimeout; /* in milliseconds, 0 means no timeout */ 1679 long happy_eyeballs_timeout; /* in milliseconds, 0 is a valid value */ 1680 long server_response_timeout; /* in milliseconds, 0 means no timeout */ 1681 long maxage_conn; /* in seconds, max idle time to allow a connection that 1682 is to be reused */ 1683 long tftp_blksize; /* in bytes, 0 means use default */ 1684 curl_off_t filesize; /* size of file to upload, -1 means unknown */ 1685 long low_speed_limit; /* bytes/second */ 1686 long low_speed_time; /* number of seconds */ 1687 curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */ 1688 curl_off_t max_recv_speed; /* high speed limit in bytes/second for 1689 download */ 1690 curl_off_t set_resume_from; /* continue [ftp] transfer from here */ 1691 struct curl_slist *headers; /* linked list of extra headers */ 1692 struct curl_slist *proxyheaders; /* linked list of extra CONNECT headers */ 1693 struct curl_httppost *httppost; /* linked list of old POST data */ 1694 curl_mimepart mimepost; /* MIME/POST data. */ 1695 struct curl_slist *quote; /* after connection is established */ 1696 struct curl_slist *postquote; /* after the transfer */ 1697 struct curl_slist *prequote; /* before the transfer, after type */ 1698 struct curl_slist *source_quote; /* 3rd party quote */ 1699 struct curl_slist *source_prequote; /* in 3rd party transfer mode - before 1700 the transfer on source host */ 1701 struct curl_slist *source_postquote; /* in 3rd party transfer mode - after 1702 the transfer on source host */ 1703 struct curl_slist *telnet_options; /* linked list of telnet options */ 1704 struct curl_slist *resolve; /* list of names to add/remove from 1705 DNS cache */ 1706 struct curl_slist *connect_to; /* list of host:port mappings to override 1707 the hostname and port to connect to */ 1708 curl_TimeCond timecondition; /* kind of time/date comparison */ 1709 curl_proxytype proxytype; /* what kind of proxy that is in use */ 1710 time_t timevalue; /* what time to compare with */ 1711 #if !defined(CURL_DISABLE_HTTP) || !defined(CURL_DISABLE_MQTT) 1712 Curl_HttpReq method; /* what kind of HTTP request (if any) is this */ 1713 #endif 1714 long httpversion; /* when non-zero, a specific HTTP version requested to 1715 be used in the library's request(s) */ 1716 struct ssl_config_data ssl; /* user defined SSL stuff */ 1717 #ifndef CURL_DISABLE_PROXY 1718 struct ssl_config_data proxy_ssl; /* user defined SSL stuff for proxy */ 1719 #endif 1720 struct ssl_general_config general_ssl; /* general user defined SSL stuff */ 1721 long dns_cache_timeout; /* DNS cache timeout */ 1722 long buffer_size; /* size of receive buffer to use */ 1723 size_t upload_buffer_size; /* size of upload buffer to use, 1724 keep it >= CURL_MAX_WRITE_SIZE */ 1725 void *private_data; /* application-private data */ 1726 struct curl_slist *http200aliases; /* linked list of aliases for http200 */ 1727 unsigned char ipver; /* the CURL_IPRESOLVE_* defines in the public header 1728 file 0 - whatever, 1 - v2, 2 - v6 */ 1729 curl_off_t max_filesize; /* Maximum file size to download */ 1730 #ifndef CURL_DISABLE_FTP 1731 curl_ftpfile ftp_filemethod; /* how to get to a file when FTP is used */ 1732 curl_ftpauth ftpsslauth; /* what AUTH XXX to be attempted */ 1733 curl_ftpccc ftp_ccc; /* FTP CCC options */ 1734 #endif 1735 int ftp_create_missing_dirs; /* 1 - create directories that don't exist 1736 2 - the same but also allow MKD to fail once 1737 */ 1738 curl_sshkeycallback ssh_keyfunc; /* key matching callback */ 1739 void *ssh_keyfunc_userp; /* custom pointer to callback */ 1740 enum CURL_NETRC_OPTION 1741 use_netrc; /* defined in include/curl.h */ 1742 curl_usessl use_ssl; /* if AUTH TLS is to be attempted etc, for FTP or 1743 IMAP or POP3 or others! */ 1744 long new_file_perms; /* Permissions to use when creating remote files */ 1745 long new_directory_perms; /* Permissions to use when creating remote dirs */ 1746 long ssh_auth_types; /* allowed SSH auth types */ 1747 char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */ 1748 struct curl_blob *blobs[BLOB_LAST]; 1749 unsigned int scope_id; /* Scope id for IPv6 */ 1750 long allowed_protocols; 1751 long redir_protocols; 1752 struct curl_slist *mail_rcpt; /* linked list of mail recipients */ 1753 /* Common RTSP header options */ 1754 Curl_RtspReq rtspreq; /* RTSP request type */ 1755 long rtspversion; /* like httpversion, for RTSP */ 1756 curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer 1757 starts */ 1758 curl_chunk_end_callback chunk_end; /* called after part transferring 1759 stopped */ 1760 curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds 1761 to pattern (e.g. if WILDCARDMATCH is on) */ 1762 void *fnmatch_data; 1763 1764 long gssapi_delegation; /* GSS-API credential delegation, see the 1765 documentation of CURLOPT_GSSAPI_DELEGATION */ 1766 1767 long tcp_keepidle; /* seconds in idle before sending keepalive probe */ 1768 long tcp_keepintvl; /* seconds between TCP keepalive probes */ 1769 1770 size_t maxconnects; /* Max idle connections in the connection cache */ 1771 1772 long expect_100_timeout; /* in milliseconds */ 1773 struct Curl_easy *stream_depends_on; 1774 int stream_weight; 1775 struct Curl_http2_dep *stream_dependents; 1776 1777 curl_resolver_start_callback resolver_start; /* optional callback called 1778 before resolver start */ 1779 void *resolver_start_client; /* pointer to pass to resolver start callback */ 1780 long upkeep_interval_ms; /* Time between calls for connection upkeep. */ 1781 multidone_func fmultidone; 1782 struct Curl_easy *dohfor; /* this is a DoH request for that transfer */ 1783 CURLU *uh; /* URL handle for the current parsed URL */ 1784 void *trailer_data; /* pointer to pass to trailer data callback */ 1785 curl_trailer_callback trailer_callback; /* trailing data callback */ 1786 BIT(is_fread_set); /* has read callback been set to non-NULL? */ 1787 BIT(is_fwrite_set); /* has write callback been set to non-NULL? */ 1788 BIT(free_referer); /* set TRUE if 'referer' points to a string we 1789 allocated */ 1790 BIT(tftp_no_options); /* do not send TFTP options requests */ 1791 BIT(sep_headers); /* handle host and proxy headers separately */ 1792 BIT(cookiesession); /* new cookie session? */ 1793 BIT(crlf); /* convert crlf on ftp upload(?) */ 1794 BIT(strip_path_slash); /* strip off initial slash from path */ 1795 BIT(ssh_compression); /* enable SSH compression */ 1796 1797 /* Here follows boolean settings that define how to behave during 1798 this session. They are STATIC, set by libcurl users or at least initially 1799 and they don't change during operations. */ 1800 BIT(get_filetime); /* get the time and get of the remote file */ 1801 BIT(tunnel_thru_httpproxy); /* use CONNECT through a HTTP proxy */ 1802 BIT(prefer_ascii); /* ASCII rather than binary */ 1803 BIT(ftp_append); /* append, not overwrite, on upload */ 1804 BIT(ftp_list_only); /* switch FTP command for listing directories */ 1805 #ifndef CURL_DISABLE_FTP 1806 BIT(ftp_use_port); /* use the FTP PORT command */ 1807 BIT(ftp_use_epsv); /* if EPSV is to be attempted or not */ 1808 BIT(ftp_use_eprt); /* if EPRT is to be attempted or not */ 1809 BIT(ftp_use_pret); /* if PRET is to be used before PASV or not */ 1810 BIT(ftp_skip_ip); /* skip the IP address the FTP server passes on to 1811 us */ 1812 #endif 1813 BIT(hide_progress); /* don't use the progress meter */ 1814 BIT(http_fail_on_error); /* fail on HTTP error codes >= 400 */ 1815 BIT(http_keep_sending_on_error); /* for HTTP status codes >= 300 */ 1816 BIT(http_follow_location); /* follow HTTP redirects */ 1817 BIT(http_transfer_encoding); /* request compressed HTTP transfer-encoding */ 1818 BIT(allow_auth_to_other_hosts); 1819 BIT(include_header); /* include received protocol headers in data output */ 1820 BIT(http_set_referer); /* is a custom referer used */ 1821 BIT(http_auto_referer); /* set "correct" referer when following 1822 location: */ 1823 BIT(opt_no_body); /* as set with CURLOPT_NOBODY */ 1824 BIT(upload); /* upload request */ 1825 BIT(verbose); /* output verbosity */ 1826 BIT(krb); /* Kerberos connection requested */ 1827 BIT(reuse_forbid); /* forbidden to be reused, close after use */ 1828 BIT(reuse_fresh); /* do not re-use an existing connection */ 1829 BIT(no_signal); /* do not use any signal/alarm handler */ 1830 BIT(tcp_nodelay); /* whether to enable TCP_NODELAY or not */ 1831 BIT(ignorecl); /* ignore content length */ 1832 BIT(connect_only); /* make connection, let application use the socket */ 1833 BIT(http_te_skip); /* pass the raw body data to the user, even when 1834 transfer-encoded (chunked, compressed) */ 1835 BIT(http_ce_skip); /* pass the raw body data to the user, even when 1836 content-encoded (chunked, compressed) */ 1837 BIT(proxy_transfer_mode); /* set transfer mode (;type=<a|i>) when doing 1838 FTP via an HTTP proxy */ 1839 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI) 1840 BIT(socks5_gssapi_nec); /* Flag to support NEC SOCKS5 server */ 1841 #endif 1842 BIT(sasl_ir); /* Enable/disable SASL initial response */ 1843 BIT(wildcard_enabled); /* enable wildcard matching */ 1844 BIT(tcp_keepalive); /* use TCP keepalives */ 1845 BIT(tcp_fastopen); /* use TCP Fast Open */ 1846 BIT(ssl_enable_npn); /* TLS NPN extension? */ 1847 BIT(ssl_enable_alpn);/* TLS ALPN extension? */ 1848 BIT(path_as_is); /* allow dotdots? */ 1849 BIT(pipewait); /* wait for multiplex status before starting a new 1850 connection */ 1851 BIT(suppress_connect_headers); /* suppress proxy CONNECT response headers 1852 from user callbacks */ 1853 BIT(dns_shuffle_addresses); /* whether to shuffle addresses before use */ 1854 BIT(stream_depends_e); /* set or don't set the Exclusive bit */ 1855 BIT(haproxyprotocol); /* whether to send HAProxy PROXY protocol v1 1856 header */ 1857 BIT(abstract_unix_socket); 1858 BIT(disallow_username_in_url); /* disallow username in url */ 1859 BIT(doh); /* DNS-over-HTTPS enabled */ 1860 BIT(doh_get); /* use GET for DoH requests, instead of POST */ 1861 BIT(http09_allowed); /* allow HTTP/0.9 responses */ 1862 BIT(mail_rcpt_allowfails); /* allow RCPT TO command to fail for some 1863 recipients */ 1864 }; 1865 1866 struct Names { 1867 struct Curl_hash *hostcache; 1868 enum { 1869 HCACHE_NONE, /* not pointing to anything */ 1870 HCACHE_MULTI, /* points to a shared one in the multi handle */ 1871 HCACHE_SHARED /* points to a shared one in a shared object */ 1872 } hostcachetype; 1873 }; 1874 1875 /* 1876 * The 'connectdata' struct MUST have all the connection oriented stuff as we 1877 * may have several simultaneous connections and connection structs in memory. 1878 * 1879 * The 'struct UserDefined' must only contain data that is set once to go for 1880 * many (perhaps) independent connections. Values that are generated or 1881 * calculated internally for the "session handle" must be defined within the 1882 * 'struct UrlState' instead. 1883 */ 1884 1885 struct Curl_easy { 1886 /* First a simple identifier to easier detect if a user mix up this easy 1887 handle with a multi handle. Set this to CURLEASY_MAGIC_NUMBER */ 1888 unsigned int magic; 1889 1890 /* first, two fields for the linked list of these */ 1891 struct Curl_easy *next; 1892 struct Curl_easy *prev; 1893 1894 struct connectdata *conn; 1895 struct Curl_llist_element connect_queue; 1896 struct Curl_llist_element conn_queue; /* list per connectdata */ 1897 1898 CURLMstate mstate; /* the handle's state */ 1899 CURLcode result; /* previous result */ 1900 1901 struct Curl_message msg; /* A single posted message. */ 1902 1903 /* Array with the plain socket numbers this handle takes care of, in no 1904 particular order. Note that all sockets are added to the sockhash, where 1905 the state etc are also kept. This array is mostly used to detect when a 1906 socket is to be removed from the hash. See singlesocket(). */ 1907 curl_socket_t sockets[MAX_SOCKSPEREASYHANDLE]; 1908 int actions[MAX_SOCKSPEREASYHANDLE]; /* action for each socket in 1909 sockets[] */ 1910 int numsocks; 1911 1912 struct Names dns; 1913 struct Curl_multi *multi; /* if non-NULL, points to the multi handle 1914 struct to which this "belongs" when used by 1915 the multi interface */ 1916 struct Curl_multi *multi_easy; /* if non-NULL, points to the multi handle 1917 struct to which this "belongs" when used 1918 by the easy interface */ 1919 struct Curl_share *share; /* Share, handles global variable mutexing */ 1920 #ifdef USE_LIBPSL 1921 struct PslCache *psl; /* The associated PSL cache. */ 1922 #endif 1923 struct SingleRequest req; /* Request-specific data */ 1924 struct UserDefined set; /* values set by the libcurl user */ 1925 struct DynamicStatic change; /* possibly modified userdefined data */ 1926 struct CookieInfo *cookies; /* the cookies, read from files and servers. 1927 NOTE that the 'cookie' field in the 1928 UserDefined struct defines if the "engine" 1929 is to be used or not. */ 1930 #ifdef USE_HSTS 1931 struct hsts *hsts; 1932 #endif 1933 #ifndef CURL_DISABLE_ALTSVC 1934 struct altsvcinfo *asi; /* the alt-svc cache */ 1935 #endif 1936 struct Progress progress; /* for all the progress meter data */ 1937 struct UrlState state; /* struct for fields used for state info and 1938 other dynamic purposes */ 1939 #ifndef CURL_DISABLE_FTP 1940 struct WildcardData wildcard; /* wildcard download state info */ 1941 #endif 1942 struct PureInfo info; /* stats, reports and info data */ 1943 struct curl_tlssessioninfo tsi; /* Information about the TLS session, only 1944 valid after a client has asked for it */ 1945 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV) 1946 iconv_t outbound_cd; /* for translating to the network encoding */ 1947 iconv_t inbound_cd; /* for translating from the network encoding */ 1948 iconv_t utf8_cd; /* for translating to UTF8 */ 1949 #endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */ 1950 #ifdef USE_HYPER 1951 struct hyptransfer hyp; 1952 #endif 1953 }; 1954 1955 #define LIBCURL_NAME "libcurl" 1956 1957 #endif /* HEADER_CURL_URLDATA_H */ 1958