VirtualBox

source: vbox/trunk/src/libs/curl-7.64.0/lib/urldata.h@ 85671

Last change on this file since 85671 was 85671, checked in by vboxsync, 4 years ago

Export out internal curl copy to make it a lot simpler to build VBox (OSE) on Windows. bugref:9814

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette