1 #ifndef HEADER_CURL_URLDATA_H
2 #define HEADER_CURL_URLDATA_H
3 /***************************************************************************
5 * Project ___| | | | _ \| |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
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.
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.
20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21 * KIND, either express or implied.
23 ***************************************************************************/
25 /* This file is for lib internal stuff */
27 #include "curl_setup.h"
31 #define PORT_TELNET 23
33 #define PORT_HTTPS 443
34 #define PORT_DICT 2628
36 #define PORT_LDAPS 636
40 #define PORT_IMAPS 993
42 #define PORT_POP3S 995
46 #define PORT_SMTPS 465 /* sometimes called SSMTP */
48 #define PORT_RTMP 1935
49 #define PORT_RTMPT PORT_HTTP
50 #define PORT_RTMPS PORT_HTTPS
51 #define PORT_GOPHER 70
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:"
60 #define CURL_DEFAULT_USER "anonymous"
61 #define CURL_DEFAULT_PASSWORD "ftp@example.com"
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
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)
72 #define DEFAULT_CONNCACHE_SIZE 5
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")
77 /* Default FTP/IMAP etc response timeout in milliseconds.
78 Symbian OS panics when given a timeout much greater than 1/2 hour.
80 #define RESP_TIMEOUT (1800*1000)
82 /* Max string intput length is a precaution against abuse and to detect junk
83 input easier and better. */
84 #define CURL_MAX_INPUT_LENGTH 8000000
90 #ifdef HAVE_NETINET_IN_H
91 #include <netinet/in.h>
93 #ifdef HAVE_NETINET_IN6_H
94 #include <netinet/in6.h>
99 #include <curl/curl.h>
101 #include "http_chunks.h" /* for the structs and enum stuff */
106 /* return the count of bytes sent, or -1 on error */
107 typedef ssize_t (Curl_send)(struct connectdata *conn, /* connection data */
108 int sockindex, /* socketindex */
109 const void *buf, /* data to write */
110 size_t len, /* max amount to write */
111 CURLcode *err); /* error to return */
113 /* return the count of bytes read, or -1 on error */
114 typedef ssize_t (Curl_recv)(struct connectdata *conn, /* connection data */
115 int sockindex, /* socketindex */
116 char *buf, /* store data here */
117 size_t len, /* max amount to read */
118 CURLcode *err); /* error to return */
130 #include "wildcard.h"
131 #include "multihandle.h"
136 # elif defined HAVE_GSSMIT
137 # include <gssapi/gssapi.h>
138 # include <gssapi/gssapi_generic.h>
144 #ifdef HAVE_LIBSSH2_H
146 #include <libssh2_sftp.h>
147 #endif /* HAVE_LIBSSH2_H */
150 /* The "master buffer" is for HTTP pipelining */
151 #define MASTERBUF_SIZE 16384
153 /* Initial size of the buffer to store headers in, it'll be enlarged in case
155 #define HEADERSIZE 256
157 #define CURLEASY_MAGIC_NUMBER 0xc0dedbadU
158 #define GOOD_EASY_HANDLE(x) \
159 ((x) && ((x)->magic == CURLEASY_MAGIC_NUMBER))
162 /* Types needed for krb5-ftp connections */
170 enum protection_level {
171 PROT_NONE, /* first in list */
177 PROT_LAST /* last in list */
181 /* enum for the nonblocking SSL connection state machine */
185 ssl_connect_2_reading,
186 ssl_connect_2_writing,
193 ssl_connection_negotiating,
194 ssl_connection_complete
195 } ssl_connection_state;
197 /* SSL backend-specific data; declared differently by each SSL backend */
198 struct ssl_backend_data;
200 /* struct for data related to each SSL connection */
201 struct ssl_connect_data {
202 /* Use ssl encrypted communications TRUE/FALSE, not necessarily using it atm
203 but at least asked to or meaning to use it. See 'state' for the exact
204 current state of the connection. */
206 ssl_connection_state state;
207 ssl_connect_state connecting_state;
209 struct ssl_backend_data *backend;
213 struct ssl_primary_config {
214 long version; /* what version the client wants to use */
215 long version_max; /* max supported version the client wants to use*/
216 bool verifypeer; /* set TRUE if this is desired */
217 bool verifyhost; /* set TRUE if CN/SAN must match hostname */
218 bool verifystatus; /* set TRUE if certificate status must be checked */
219 bool sessionid; /* cache session IDs or not */
220 char *CApath; /* certificate dir (doesn't work on windows) */
221 char *CAfile; /* certificate to verify peer against */
223 char *random_file; /* path to file containing "random" data */
224 char *egdsocket; /* path to file containing the EGD daemon socket */
225 char *cipher_list; /* list of ciphers to use */
226 char *cipher_list13; /* list of TLS 1.3 cipher suites to use */
229 struct ssl_config_data {
230 struct ssl_primary_config primary;
231 bool enable_beast; /* especially allow this flaw for interoperability's
233 bool no_revoke; /* disable SSL certificate revocation checks */
234 long certverifyresult; /* result from the certificate verification */
235 char *CRLfile; /* CRL to check certificate revocation */
236 char *issuercert;/* optional issuer certificate filename */
237 curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */
238 void *fsslctxp; /* parameter for call back */
239 bool certinfo; /* gather lots of certificate info */
242 char *cert; /* client certificate file name */
243 char *cert_type; /* format for certificate (default: PEM)*/
244 char *key; /* private key file name */
245 char *key_type; /* format for private key (default: PEM) */
246 char *key_passwd; /* plain text private key password */
249 char *username; /* TLS username (for, e.g., SRP) */
250 char *password; /* TLS password (for, e.g., SRP) */
251 enum CURL_TLSAUTH authtype; /* TLS authentication type (default SRP) */
255 struct ssl_general_config {
256 size_t max_ssl_sessions; /* SSL session id cache size */
259 /* information stored about one single SSL session */
260 struct curl_ssl_session {
261 char *name; /* host name for which this ID was used */
262 char *conn_to_host; /* host name for the connection (may be NULL) */
263 const char *scheme; /* protocol scheme used */
264 void *sessionid; /* as returned from the SSL layer */
265 size_t idsize; /* if known, otherwise 0 */
266 long age; /* just a number, the higher the more recent */
267 int remote_port; /* remote port */
268 int conn_to_port; /* remote port for the connection (may be -1) */
269 struct ssl_primary_config ssl_config; /* setup for this session */
272 #ifdef USE_WINDOWS_SSPI
273 #include "curl_sspi.h"
276 /* Struct used for Digest challenge-response authentication */
278 #if defined(USE_WINDOWS_SSPI)
280 size_t input_token_len;
281 CtxtHandle *http_context;
282 /* copy of user/passwd used to make the identity for http_context.
283 either may be NULL. */
291 bool stale; /* set true for re-negotiation */
295 int nc; /* nounce count */
308 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
312 /* Struct used for GSSAPI (Kerberos V5) authentication */
313 #if defined(USE_KERBEROS5)
314 struct kerberos5data {
315 #if defined(USE_WINDOWS_SSPI)
316 CredHandle *credentials;
319 SEC_WINNT_AUTH_IDENTITY identity;
320 SEC_WINNT_AUTH_IDENTITY *p_identity;
324 gss_ctx_id_t context;
330 /* Struct used for NTLM challenge-response authentication */
331 #if defined(USE_NTLM)
334 #ifdef USE_WINDOWS_SSPI
335 CredHandle *credentials;
337 SEC_WINNT_AUTH_IDENTITY identity;
338 SEC_WINNT_AUTH_IDENTITY *p_identity;
342 size_t input_token_len;
346 unsigned char nonce[8];
347 void *target_info; /* TargetInfo received in the ntlm type-2 message */
348 unsigned int target_info_len;
354 struct negotiatedata {
355 /* When doing Negotiate (SPNEGO) auth, we first need to send a token
356 and then validate the received one. */
357 enum { GSS_AUTHNONE, GSS_AUTHRECV, GSS_AUTHSENT } state;
360 gss_ctx_id_t context;
362 gss_buffer_desc output_token;
364 #ifdef USE_WINDOWS_SSPI
366 CredHandle *credentials;
368 SEC_WINNT_AUTH_IDENTITY identity;
369 SEC_WINNT_AUTH_IDENTITY *p_identity;
373 size_t output_token_length;
381 * Boolean values that concerns this connection.
384 /* always modify bits.close with the connclose() and connkeep() macros! */
385 bool close; /* if set, we close the connection after this request */
386 bool reuse; /* if set, this is a re-used connection */
387 bool conn_to_host; /* if set, this connection has a "connect to host"
388 that overrides the host in the URL */
389 bool conn_to_port; /* if set, this connection has a "connect to port"
390 that overrides the port in the URL (remote port) */
391 bool proxy; /* if set, this transfer is done through a proxy - any type */
392 bool httpproxy; /* if set, this transfer is done through a http proxy */
393 bool socksproxy; /* if set, this transfer is done through a socks proxy */
394 bool user_passwd; /* do we use user+password for this connection? */
395 bool proxy_user_passwd; /* user+password for the proxy? */
396 bool ipv6_ip; /* we communicate with a remote site specified with pure IPv6
398 bool ipv6; /* we communicate with a site using an IPv6 address */
400 bool do_more; /* this is set TRUE if the ->curl_do_more() function is
401 supposed to be called, after ->curl_do() */
402 bool tcpconnect[2]; /* the TCP layer (or similar) is connected, this is set
403 the first time on the first connect function call */
404 bool protoconnstart;/* the protocol layer has STARTED its operation after
405 the TCP layer connect */
407 bool retry; /* this connection is about to get closed and then
408 re-attempted at another connection. */
409 bool tunnel_proxy; /* if CONNECT is used to "tunnel" through the proxy.
410 This is implicit when SSL-protocols are used through
411 proxies, but can also be enabled explicitly by
413 bool authneg; /* TRUE when the auth phase has started, which means
414 that we are creating a request with an auth header,
415 but it is not the final request in the auth
417 bool rewindaftersend;/* TRUE when the sending couldn't be stopped even
418 though it will be discarded. When the whole send
419 operation is done, we must call the data rewind
421 bool ftp_use_epsv; /* As set with CURLOPT_FTP_USE_EPSV, but if we find out
422 EPSV doesn't work we disable it for the forthcoming
425 bool ftp_use_eprt; /* As set with CURLOPT_FTP_USE_EPRT, but if we find out
426 EPRT doesn't work we disable it for the forthcoming
428 bool ftp_use_data_ssl; /* Enabled SSL for the data connection */
429 bool netrc; /* name+password provided by netrc */
430 bool userpwd_in_url; /* name+password found in url */
431 bool stream_was_rewound; /* Indicates that the stream was rewound after a
432 request read past the end of its response byte
434 bool proxy_connect_closed; /* set true if a proxy disconnected the
435 connection in a CONNECT request with auth, so
436 that libcurl should reconnect and continue. */
437 bool bound; /* set true if bind() has already been done on this socket/
439 bool type_set; /* type= was used in the URL */
440 bool multiplex; /* connection is multiplexed */
442 bool tcp_fastopen; /* use TCP Fast Open */
443 bool tls_enable_npn; /* TLS NPN extension? */
444 bool tls_enable_alpn; /* TLS ALPN extension? */
445 bool proxy_ssl_connected[2]; /* TRUE when SSL initialization for HTTPS proxy
447 bool socksproxy_connecting; /* connecting through a socks proxy */
451 char *rawalloc; /* allocated "raw" version of the name */
452 char *encalloc; /* allocated IDN-encoded version of the name */
453 char *name; /* name to use internally, might be encoded, might be raw */
454 const char *dispname; /* name to display, as 'name' might be encoded */
458 * Flags on the keepon member of the Curl_transfer_keeper
462 #define KEEP_RECV (1<<0) /* there is or may be data to read */
463 #define KEEP_SEND (1<<1) /* there is or may be data to write */
464 #define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there
465 might still be data to read */
466 #define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there
467 might still be data to write */
468 #define KEEP_RECV_PAUSE (1<<4) /* reading is paused */
469 #define KEEP_SEND_PAUSE (1<<5) /* writing is paused */
471 #define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE)
472 #define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE)
478 struct Curl_dns_entry *dns;
479 bool done; /* set TRUE when the lookup is complete */
480 int status; /* if done is TRUE, this is the status from the callback */
481 void *os_specific; /* 'struct thread_data' for Windows */
484 #define FIRSTSOCKET 0
485 #define SECONDARYSOCKET 1
487 /* These function pointer types are here only to allow easier typecasting
488 within the source when we need to cast between data pointers (such as NULL)
489 and function pointers. */
490 typedef CURLcode (*Curl_do_more_func)(struct connectdata *, int *);
491 typedef CURLcode (*Curl_done_func)(struct connectdata *, CURLcode, bool);
494 EXP100_SEND_DATA, /* enough waiting, just send the body now */
495 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */
496 EXP100_SENDING_REQUEST, /* still sending the request but will wait for
497 the 100 header once done with the request */
498 EXP100_FAILED /* used on 417 Expectation Failed */
502 UPGR101_INIT, /* default state */
503 UPGR101_REQUESTED, /* upgrade requested */
504 UPGR101_RECEIVED, /* response received */
505 UPGR101_WORKING /* talking upgraded protocol */
509 unsigned char *memory;
513 /* one of these for each DoH request */
517 unsigned char dohbuffer[512];
519 struct dohresponse serverdoh;
523 struct curl_slist *headers;
524 struct dnsprobe probe[2];
525 unsigned int pending; /* still outstanding requests */
531 * Request specific data in the easy handle (Curl_easy). Previously,
532 * these members were on the connectdata struct but since a conn struct may
533 * now be shared between different Curl_easys, we store connection-specific
534 * data here. This struct only keeps stuff that's interesting for *this*
535 * request, as it will be cleared between multiple ones
537 struct SingleRequest {
538 curl_off_t size; /* -1 if unknown at this point */
539 curl_off_t *bytecountp; /* return number of bytes read or NULL */
541 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch,
542 -1 means unlimited */
543 curl_off_t *writebytecountp; /* return number of bytes written or NULL */
545 curl_off_t bytecount; /* total number of bytes read */
546 curl_off_t writebytecount; /* number of bytes written */
548 long headerbytecount; /* only count received headers */
549 long deductheadercount; /* this amount of bytes doesn't count when we check
550 if anything has been transferred at the end of a
551 connection. We use this counter to make only a
552 100 reply (without a following second response
553 code) result in a CURLE_GOT_NOTHING error code */
555 struct curltime start; /* transfer started at this time */
556 struct curltime now; /* current time */
557 bool header; /* incoming data has HTTP header */
559 HEADER_NORMAL, /* no bad header at all */
560 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest
562 HEADER_ALLBAD /* all was believed to be header */
563 } badheader; /* the header was deemed bad and will be
565 int headerline; /* counts header lines to better track the
567 char *hbufp; /* points at *end* of header line */
569 char *str; /* within buf */
570 char *str_start; /* within buf */
571 char *end_ptr; /* within buf */
572 char *p; /* within headerbuff */
573 bool content_range; /* set TRUE if Content-Range: was found */
574 curl_off_t offset; /* possible resume offset read from the
575 Content-Range: header */
576 int httpcode; /* error code from the 'HTTP/1.? XXX' or
577 'RTSP/1.? XXX' line */
578 struct curltime start100; /* time stamp to wait for the 100 code from */
579 enum expect100 exp100; /* expect 100 continue state */
580 enum upgrade101 upgr101; /* 101 upgrade state */
582 struct contenc_writer_s *writer_stack; /* Content unencoding stack. */
583 /* See sec 3.5, RFC2616. */
592 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
593 and we're uploading the last chunk */
595 bool ignorebody; /* we read a response-body but we ignore it! */
596 bool ignorecl; /* This HTTP response has no body so we ignore the Content-
599 char *location; /* This points to an allocated version of the Location:
601 char *newurl; /* Set to the new URL to use when a redirect or a retry is
604 /* 'upload_present' is used to keep a byte counter of how much data there is
605 still left in the buffer, aimed for upload. */
606 ssize_t upload_present;
608 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
609 buffer, so the next read should read from where this pointer points to,
610 and the 'upload_present' contains the number of bytes available at this
612 char *upload_fromhere;
614 bool chunk; /* if set, this is a chunked transfer-encoding */
615 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
617 bool getheader; /* TRUE if header parsing is wanted */
619 bool forbidchunk; /* used only to explicitly forbid chunk-upload for
620 specific upload buffers. See readmoredata() in
621 http.c for details. */
623 void *protop; /* Allocated protocol-specific data. Each protocol
624 handler makes sure this points to data it needs. */
625 struct dohdata doh; /* DoH specific data for this request */
629 * Specific protocol handler.
632 struct Curl_handler {
633 const char *scheme; /* URL scheme name. */
635 /* Complement to setup_connection_internals(). */
636 CURLcode (*setup_connection)(struct connectdata *);
638 /* These two functions MUST be set to be protocol dependent */
639 CURLcode (*do_it)(struct connectdata *, bool *done);
642 /* If the curl_do() function is better made in two halves, this
643 * curl_do_more() function will be called afterwards, if set. For example
644 * for doing the FTP stuff after the PASV/PORT command.
646 Curl_do_more_func do_more;
648 /* This function *MAY* be set to a protocol-dependent function that is run
649 * after the connect() and everything is done, as a step in the connection.
650 * The 'done' pointer points to a bool that should be set to TRUE if the
651 * function completes before return. If it doesn't complete, the caller
652 * should call the curl_connecting() function until it is.
654 CURLcode (*connect_it)(struct connectdata *, bool *done);
657 CURLcode (*connecting)(struct connectdata *, bool *done);
658 CURLcode (*doing)(struct connectdata *, bool *done);
660 /* Called from the multi interface during the PROTOCONNECT phase, and it
661 should then return a proper fd set */
662 int (*proto_getsock)(struct connectdata *conn,
663 curl_socket_t *socks,
666 /* Called from the multi interface during the DOING phase, and it should
667 then return a proper fd set */
668 int (*doing_getsock)(struct connectdata *conn,
669 curl_socket_t *socks,
672 /* Called from the multi interface during the DO_MORE phase, and it should
673 then return a proper fd set */
674 int (*domore_getsock)(struct connectdata *conn,
675 curl_socket_t *socks,
678 /* Called from the multi interface during the DO_DONE, PERFORM and
679 WAITPERFORM phases, and it should then return a proper fd set. Not setting
680 this will make libcurl use the generic default one. */
681 int (*perform_getsock)(const struct connectdata *conn,
682 curl_socket_t *socks,
685 /* This function *MAY* be set to a protocol-dependent function that is run
686 * by the curl_disconnect(), as a step in the disconnection. If the handler
687 * is called because the connection has been considered dead, dead_connection
690 CURLcode (*disconnect)(struct connectdata *, bool dead_connection);
692 /* If used, this function gets called from transfer.c:readwrite_data() to
693 allow the protocol to do extra reads/writes */
694 CURLcode (*readwrite)(struct Curl_easy *data, struct connectdata *conn,
695 ssize_t *nread, bool *readmore);
697 /* This function can perform various checks on the connection. See
698 CONNCHECK_* for more information about the checks that can be performed,
699 and CONNRESULT_* for the results that can be returned. */
700 unsigned int (*connection_check)(struct connectdata *conn,
701 unsigned int checks_to_perform);
703 long defport; /* Default port. */
704 unsigned int protocol; /* See CURLPROTO_* - this needs to be the single
705 specific protocol bit */
706 unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */
709 #define PROTOPT_NONE 0 /* nothing extra */
710 #define PROTOPT_SSL (1<<0) /* uses SSL */
711 #define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */
712 #define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */
713 /* some protocols will have to call the underlying functions without regard to
714 what exact state the socket signals. IE even if the socket says "readable",
715 the send function might need to be called while uploading, or vice versa.
717 #define PROTOPT_DIRLOCK (1<<3)
718 #define PROTOPT_NONETWORK (1<<4) /* protocol doesn't use the network! */
719 #define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it
721 #define PROTOPT_NOURLQUERY (1<<6) /* protocol can't handle
722 url query strings (?foo=bar) ! */
723 #define PROTOPT_CREDSPERREQUEST (1<<7) /* requires login credentials per
724 request instead of per connection */
725 #define PROTOPT_ALPN_NPN (1<<8) /* set ALPN and/or NPN for this */
726 #define PROTOPT_STREAM (1<<9) /* a protocol with individual logical streams */
727 #define PROTOPT_URLOPTIONS (1<<10) /* allow options part in the userinfo field
729 #define PROTOPT_PROXY_AS_HTTP (1<<11) /* allow this non-HTTP scheme over a
730 HTTP proxy as HTTP proxies may know
731 this protocol and act as a gateway */
732 #define PROTOPT_WILDCARD (1<<12) /* protocol supports wildcard matching */
734 #define CONNCHECK_NONE 0 /* No checks */
735 #define CONNCHECK_ISDEAD (1<<0) /* Check if the connection is dead. */
736 #define CONNCHECK_KEEPALIVE (1<<1) /* Perform any keepalive function. */
738 #define CONNRESULT_NONE 0 /* No extra information. */
739 #define CONNRESULT_DEAD (1<<0) /* The connection is dead. */
741 #ifdef USE_RECV_BEFORE_SEND_WORKAROUND
742 struct postponed_data {
743 char *buffer; /* Temporal store for received data during
744 sending, must be freed */
745 size_t allocated_size; /* Size of temporal store */
746 size_t recv_size; /* Size of received data during sending */
747 size_t recv_processed; /* Size of processed part of postponed data */
749 curl_socket_t bindsock;/* Structure must be bound to specific socket,
750 used only for DEBUGASSERT */
751 #endif /* DEBUGBUILD */
753 #endif /* USE_RECV_BEFORE_SEND_WORKAROUND */
756 struct hostname host;
758 curl_proxytype proxytype; /* what kind of proxy that is in use */
759 char *user; /* proxy user name string, allocated */
760 char *passwd; /* proxy password string, allocated */
763 #define CONNECT_BUFFER_SIZE 16384
765 /* struct for HTTP CONNECT state data */
766 struct http_connect_state {
767 char connect_buffer[CONNECT_BUFFER_SIZE];
768 int perline; /* count bytes per line */
771 char *ptr; /* where to store more data */
772 curl_off_t cl; /* size of content to read and ignore */
773 bool chunked_encoding;
775 TUNNEL_INIT, /* init/default/no tunnel state */
776 TUNNEL_CONNECT, /* CONNECT has been sent off */
777 TUNNEL_COMPLETE /* CONNECT response received completely */
779 bool close_connection;
783 * The connectdata struct contains all fields and variables that should be
784 * unique for an entire connection.
787 /* 'data' is the CURRENT Curl_easy using this connection -- take great
788 caution that this might very well vary between different times this
789 connection is used! */
790 struct Curl_easy *data;
792 struct curl_llist_element bundle_node; /* conncache */
794 /* chunk is for HTTP chunked encoding, but is in the general connectdata
795 struct only because we can do just about any protocol through a HTTP proxy
796 and a HTTP proxy may in fact respond using chunked encoding */
797 struct Curl_chunker chunk;
799 curl_closesocket_callback fclosesocket; /* function closing the socket(s) */
800 void *closesocket_client;
802 /* This is used by the connection cache logic. If this returns TRUE, this
803 handle is being used by one or more easy handles and can only used by any
804 other easy handle without careful consideration (== only for
805 pipelining/multiplexing) and it cannot be used by another multi
807 #define CONN_INUSE(c) ((c)->send_pipe.size + (c)->recv_pipe.size)
809 /**** Fields set when inited and not modified again */
810 long connection_id; /* Contains a unique number to make it easier to
811 track the connections in the log output */
813 /* 'dns_entry' is the particular host we use. This points to an entry in the
814 DNS cache and it will not get pruned while locked. It gets unlocked in
815 Curl_done(). This entry will be NULL if the connection is re-used as then
816 there is no name resolve done. */
817 struct Curl_dns_entry *dns_entry;
819 /* 'ip_addr' is the particular IP we connected to. It points to a struct
820 within the DNS cache, so this pointer is only valid as long as the DNS
821 cache entry remains locked. It gets unlocked in Curl_done() */
822 Curl_addrinfo *ip_addr;
823 Curl_addrinfo *tempaddr[2]; /* for happy eyeballs */
825 /* 'ip_addr_str' is the ip_addr data as a human readable string.
826 It remains available as long as the connection does, which is longer than
827 the ip_addr itself. */
828 char ip_addr_str[MAX_IPADR_LEN];
830 unsigned int scope_id; /* Scope id for IPv6 */
832 int socktype; /* SOCK_STREAM or SOCK_DGRAM */
834 struct hostname host;
835 char *secondaryhostname; /* secondary socket host name (ftp) */
836 struct hostname conn_to_host; /* the host to connect to. valid only if
837 bits.conn_to_host is set */
839 struct proxy_info socks_proxy;
840 struct proxy_info http_proxy;
842 long port; /* which port to use locally */
843 int remote_port; /* the remote port, not the proxy port! */
844 int conn_to_port; /* the remote port to connect to. valid only if
845 bits.conn_to_port is set */
846 unsigned short secondary_port; /* secondary socket remote port to connect to
849 /* 'primary_ip' and 'primary_port' get filled with peer's numerical
850 ip address and port number whenever an outgoing connection is
851 *attempted* from the primary socket to a remote address. When more
852 than one address is tried for a connection these will hold data
853 for the last attempt. When the connection is actually established
854 these are updated with data which comes directly from the socket. */
856 char primary_ip[MAX_IPADR_LEN];
859 /* 'local_ip' and 'local_port' get filled with local's numerical
860 ip address and port number whenever an outgoing connection is
861 **established** from the primary socket to a remote address. */
863 char local_ip[MAX_IPADR_LEN];
866 char *user; /* user name string, allocated */
867 char *passwd; /* password string, allocated */
868 char *options; /* options string, allocated */
870 char *oauth_bearer; /* bearer token for OAuth 2.0, allocated */
872 int httpversion; /* the HTTP version*10 reported by the server */
873 int rtspversion; /* the RTSP version*10 reported by the server */
875 struct curltime now; /* "current" time */
876 struct curltime created; /* creation time */
877 curl_socket_t sock[2]; /* two sockets, the second is used for the data
878 transfer when doing FTP */
879 curl_socket_t tempsock[2]; /* temporary sockets for happy eyeballs */
880 bool sock_accepted[2]; /* TRUE if the socket on this index was created with
885 #ifdef USE_RECV_BEFORE_SEND_WORKAROUND
886 struct postponed_data postponed[2]; /* two buffers for two sockets */
887 #endif /* USE_RECV_BEFORE_SEND_WORKAROUND */
888 struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */
889 struct ssl_connect_data proxy_ssl[2]; /* this is for proxy ssl-stuff */
891 void *ssl_extra; /* separately allocated backend-specific data */
893 struct ssl_primary_config ssl_config;
894 struct ssl_primary_config proxy_ssl_config;
897 struct ConnectBits bits; /* various state-flags for this connection */
899 /* connecttime: when connect() is called on the current IP address. Used to
900 be able to track when to move on to try next IP - but only when the multi
901 interface is used. */
902 struct curltime connecttime;
903 /* The two fields below get set in Curl_connecthost */
904 int num_addr; /* number of addresses to try to connect to */
905 time_t timeoutms_per_addr; /* how long time in milliseconds to spend on
906 trying to connect to each IP address */
908 const struct Curl_handler *handler; /* Connection's protocol handler */
909 const struct Curl_handler *given; /* The protocol first given */
911 long ip_version; /* copied from the Curl_easy at creation time */
913 /* Protocols can use a custom keepalive mechanism to keep connections alive.
914 This allows those protocols to track the last time the keepalive mechanism
915 was used on this connection. */
916 struct curltime keepalive;
918 long upkeep_interval_ms; /* Time between calls for connection upkeep. */
920 /**** curl_get() phase fields */
922 curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */
923 curl_socket_t writesockfd; /* socket to write to, it may very
924 well be the same we read from.
925 CURL_SOCKET_BAD disables */
927 /** Dynamically allocated strings, MUST be freed before this **/
928 /** struct is killed. **/
929 struct dynamically_allocated_data {
932 char *accept_encoding;
938 char *rtsp_transport;
939 char *te; /* TE: request header */
943 int sec_complete; /* if Kerberos is enabled for this connection */
944 enum protection_level command_prot;
945 enum protection_level data_prot;
946 enum protection_level request_data_prot;
948 struct krb5buffer in_buffer;
950 const struct Curl_sec_client_mech *mech;
951 struct sockaddr_in local_addr;
954 #if defined(USE_KERBEROS5) /* Consider moving some of the above GSS-API */
955 struct kerberos5data krb5; /* variables into the structure definition, */
956 #endif /* however, some of them are ftp specific. */
958 /* the two following *_inuse fields are only flags, not counters in any way.
959 If TRUE it means the channel is in use, and if FALSE it means the channel
960 is up for grabs by one. */
962 bool readchannel_inuse; /* whether the read channel is in use by an easy
964 bool writechannel_inuse; /* whether the write channel is in use by an easy
966 struct curl_llist send_pipe; /* List of handles waiting to send on this
968 struct curl_llist recv_pipe; /* List of handles waiting to read their
969 responses on this pipeline */
970 char *master_buffer; /* The master buffer allocated on-demand;
971 used for pipelining. */
972 size_t read_pos; /* Current read position in the master buffer */
973 size_t buf_len; /* Length of the buffer?? */
976 curl_seek_callback seek_func; /* function that seeks the input */
977 void *seek_client; /* pointer to pass to the seek() above */
979 /*************** Request - specific items ************/
981 #if defined(USE_NTLM)
982 struct ntlmdata ntlm; /* NTLM differs from other authentication schemes
983 because it authenticates connections, not
985 struct ntlmdata proxyntlm; /* NTLM data for proxy */
987 #if defined(NTLM_WB_ENABLED)
988 /* used for communication with Samba's winbind daemon helper ntlm_auth */
989 curl_socket_t ntlm_auth_hlpr_socket;
990 pid_t ntlm_auth_hlpr_pid;
991 char *challenge_header;
992 char *response_header;
996 char syserr_buf [256]; /* buffer for Curl_strerror() */
997 /* data used for the asynch name resolve callback */
998 struct Curl_async async;
1000 /* These three are used for chunked-encoding trailer support */
1001 char *trailer; /* allocated buffer to store trailer in */
1002 int trlMax; /* allocated buffer size */
1003 int trlPos; /* index of where to store data */
1006 struct ftp_conn ftpc;
1007 struct http_conn httpc;
1008 struct ssh_conn sshc;
1009 struct tftp_state_data *tftpc;
1010 struct imap_conn imapc;
1011 struct pop3_conn pop3c;
1012 struct smtp_conn smtpc;
1013 struct rtsp_conn rtspc;
1014 struct smb_conn smbc;
1015 void *generic; /* RTMP and LDAP use this */
1018 int cselect_bits; /* bitmask of socket events */
1019 int waitfor; /* current READ/WRITE bits to wait for */
1021 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1022 int socks5_gssapi_enctype;
1025 /* When this connection is created, store the conditions for the local end
1026 bind. This is stored before the actual bind and before any connection is
1027 made and will serve the purpose of being used for comparison reasons so
1028 that subsequent bound-requested connections aren't accidentally re-using
1029 wrong connections. */
1031 unsigned short localport;
1033 struct http_connect_state *connect_state; /* for HTTP CONNECT */
1034 struct connectbundle *bundle; /* The bundle we are member of */
1035 int negnpn; /* APLN or NPN TLS negotiated protocol, CURL_HTTP_VERSION* */
1037 #ifdef USE_UNIX_SOCKETS
1038 char *unix_domain_socket;
1039 bool abstract_unix_socket;
1043 /* The end of connectdata. */
1046 * Struct to keep statistical and informational data.
1047 * All variables in this struct must be initialized/reset in Curl_initinfo().
1050 int httpcode; /* Recent HTTP, FTP, RTSP or SMTP response code */
1051 int httpproxycode; /* response code from proxy when received separate */
1052 int httpversion; /* the http version number X.Y = X*10+Y */
1053 time_t filetime; /* If requested, this is might get set. Set to -1 if the
1054 time was unretrievable. */
1055 bool timecond; /* set to TRUE if the time condition didn't match, which
1056 thus made the document NOT get fetched */
1057 long header_size; /* size of read header(s) in bytes */
1058 long request_size; /* the amount of bytes sent in the request(s) */
1059 unsigned long proxyauthavail; /* what proxy auth types were announced */
1060 unsigned long httpauthavail; /* what host auth types were announced */
1061 long numconnects; /* how many new connection did libcurl created */
1062 char *contenttype; /* the content type of the object */
1063 char *wouldredirect; /* URL this would've been redirected to if asked to */
1065 /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip'
1066 and, 'conn_local_port' are copied over from the connectdata struct in
1067 order to allow curl_easy_getinfo() to return this information even when
1068 the session handle is no longer associated with a connection, and also
1069 allow curl_easy_reset() to clear this information from the session handle
1070 without disturbing information which is still alive, and that might be
1071 reused, in the connection cache. */
1073 char conn_primary_ip[MAX_IPADR_LEN];
1074 long conn_primary_port;
1076 char conn_local_ip[MAX_IPADR_LEN];
1077 long conn_local_port;
1079 const char *conn_scheme;
1080 unsigned int conn_protocol;
1082 struct curl_certinfo certs; /* info about the certs, only populated in
1083 OpenSSL builds. Asked for with
1084 CURLOPT_CERTINFO / CURLINFO_CERTINFO */
1089 time_t lastshow; /* time() of the last displayed progress meter or NULL to
1090 force redraw at next call */
1091 curl_off_t size_dl; /* total expected size */
1092 curl_off_t size_ul; /* total expected size */
1093 curl_off_t downloaded; /* transferred so far */
1094 curl_off_t uploaded; /* transferred so far */
1096 curl_off_t current_speed; /* uses the currently fastest transfer */
1098 bool callback; /* set when progress callback is used */
1099 int width; /* screen width at download start */
1100 int flags; /* see progress.h */
1109 time_t t_appconnect;
1110 time_t t_pretransfer;
1111 time_t t_starttransfer;
1114 struct curltime start;
1115 struct curltime t_startsingle;
1116 struct curltime t_startop;
1117 struct curltime t_acceptdata;
1119 bool is_t_startransfer_set;
1121 /* upload speed limit */
1122 struct curltime ul_limit_start;
1123 curl_off_t ul_limit_size;
1124 /* download speed limit */
1125 struct curltime dl_limit_start;
1126 curl_off_t dl_limit_size;
1128 #define CURR_TIME (5 + 1) /* 6 entries for 5 seconds */
1130 curl_off_t speeder[ CURR_TIME ];
1131 struct curltime speeder_time[ CURR_TIME ];
1136 HTTPREQ_NONE, /* first in list */
1139 HTTPREQ_POST_FORM, /* we make a difference internally */
1140 HTTPREQ_POST_MIME, /* we make a difference internally */
1145 HTTPREQ_LAST /* last in list */
1149 RTSPREQ_NONE, /* first in list */
1157 RTSPREQ_GET_PARAMETER,
1158 RTSPREQ_SET_PARAMETER,
1161 RTSPREQ_LAST /* last in list */
1165 * Values that are generated, temporary or calculated internally for a
1166 * "session handle" must be defined within the 'struct UrlState'. This struct
1167 * will be used within the Curl_easy struct. When the 'Curl_easy'
1168 * struct is cloned, this data MUST NOT be copied.
1170 * Remember that any "state" information goes globally for the curl handle.
1171 * Session-data MUST be put in the connectdata struct and here. */
1172 #define MAX_CURL_USER_LENGTH 256
1173 #define MAX_CURL_PASSWORD_LENGTH 256
1176 unsigned long want; /* Bitmask set to the authentication methods wanted by
1177 app (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */
1178 unsigned long picked;
1179 unsigned long avail; /* Bitmask for what the server reports to support for
1181 bool done; /* TRUE when the auth phase is done and ready to do the *actual*
1183 bool multipass; /* TRUE if this is not yet authenticated but within the
1184 auth multipass negotiation */
1185 bool iestyle; /* TRUE if digest should be done IE-style or FALSE if it should
1189 struct Curl_http2_dep {
1190 struct Curl_http2_dep *next;
1191 struct Curl_easy *data;
1195 * This struct is for holding data that was attempted to get sent to the user's
1196 * callback but is held due to pausing. One instance per type (BOTH, HEADER,
1200 char *buf; /* allocated buffer to keep data in when a write callback
1201 returns to make the connection paused */
1202 size_t len; /* size of the 'tempwrite' allocated buffer */
1203 int type; /* type of the 'tempwrite' buffer as a bitmask that is used with
1204 Curl_client_write() */
1211 EXPIRE_CONNECTTIMEOUT,
1212 EXPIRE_DNS_PER_NAME,
1213 EXPIRE_HAPPY_EYEBALLS,
1214 EXPIRE_MULTI_PENDING,
1219 EXPIRE_LAST /* not an actual timer, used as a marker only */
1223 * One instance for each timeout an easy handle can set.
1226 struct curl_llist_element list;
1227 struct curltime time;
1231 /* individual pieces of the URL */
1245 /* Points to the connection cache */
1246 struct conncache *conn_cache;
1248 /* when curl_easy_perform() is called, the multi handle is "owned" by
1249 the easy handle so curl_easy_cleanup() on such an easy handle will
1250 also close the multi handle! */
1251 bool multi_owned_by_easy;
1253 /* buffers to store authentication data in, as parsed from input options */
1254 struct curltime keeps_speed; /* for the progress meter really */
1256 struct connectdata *lastconnect; /* The last connection, NULL if undefined */
1258 char *headerbuff; /* allocated buffer to store headers in */
1259 size_t headersize; /* size of the allocation */
1261 char *buffer; /* download buffer */
1262 char *ulbuf; /* allocated upload buffer or NULL */
1263 curl_off_t current_speed; /* the ProgressShow() function sets this,
1265 bool this_is_a_follow; /* this is a followed Location: request */
1266 bool refused_stream; /* this was refused, try again */
1267 char *first_host; /* host name of the first (not followed) request.
1268 if set, this should be the host name that we will
1269 sent authorization to, no else. Used to make Location:
1270 following not keep sending user+password... This is
1273 int first_remote_port; /* remote port of the first (not followed) request */
1274 struct curl_ssl_session *session; /* array of 'max_ssl_sessions' size */
1275 long sessionage; /* number of the most recent session */
1276 unsigned int tempcount; /* number of entries in use in tempwrite, 0 - 3 */
1277 struct tempbuf tempwrite[3]; /* BOTH, HEADER, BODY */
1278 char *scratch; /* huge buffer[set.buffer_size*2] for upload CRLF replacing */
1279 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
1280 This must be set to FALSE every time _easy_perform() is
1282 int os_errno; /* filled in with errno whenever an error occurs */
1284 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
1285 void (*prev_signal)(int sig);
1287 bool allow_port; /* Is set.use_port allowed to take effect or not. This
1288 is always set TRUE when curl_easy_perform() is called. */
1289 struct digestdata digest; /* state data for host Digest auth */
1290 struct digestdata proxydigest; /* state data for proxy Digest auth */
1293 struct negotiatedata negotiate; /* state data for host Negotiate auth */
1294 struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */
1297 struct auth authhost; /* auth details for host */
1298 struct auth authproxy; /* auth details for proxy */
1300 bool authproblem; /* TRUE if there's some problem authenticating */
1302 void *resolver; /* resolver state, if it is used in the URL state -
1303 ares_channel f.e. */
1305 #if defined(USE_OPENSSL)
1306 /* void instead of ENGINE to avoid bleeding OpenSSL into this header */
1308 #endif /* USE_OPENSSL */
1309 struct curltime expiretime; /* set this with Curl_expire() only */
1310 struct Curl_tree timenode; /* for the splay stuff */
1311 struct curl_llist timeoutlist; /* list of pending timeouts */
1312 struct time_node expires[EXPIRE_LAST]; /* nodes for each expire type */
1314 /* a place to store the most recently set FTP entrypath */
1315 char *most_recent_ftp_entrypath;
1317 /* set after initial USER failure, to prevent an authentication loop */
1318 bool ftp_trying_alternative;
1319 bool wildcardmatch; /* enable wildcard matching */
1320 int httpversion; /* the lowest HTTP version*10 reported by any server
1321 involved in this request */
1322 bool expect100header; /* TRUE if we added Expect: 100-continue */
1324 #if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) && \
1325 !defined(__SYMBIAN32__)
1326 /* do FTP line-end conversions on most platforms */
1327 #define CURL_DO_LINEEND_CONV
1328 /* for FTP downloads: track CRLF sequences that span blocks */
1329 bool prev_block_had_trailing_cr;
1330 /* for FTP downloads: how many CRLFs did we converted to LFs? */
1331 curl_off_t crlf_conversions;
1333 bool slash_removed; /* set TRUE if the 'path' points to a path where the
1334 initial URL slash separator has been taken off */
1336 bool rangestringalloc; /* the range string is malloc()'ed */
1338 char *range; /* range, if used. See README for detailed specification on
1340 curl_off_t resume_from; /* continue [ftp] transfer from here */
1342 /* This RTSP state information survives requests and connections */
1343 long rtsp_next_client_CSeq; /* the session's next client CSeq */
1344 long rtsp_next_server_CSeq; /* the session's next server CSeq */
1345 long rtsp_CSeq_recv; /* most recent CSeq received */
1347 curl_off_t infilesize; /* size of file to upload, -1 means unknown.
1348 Copied from set.filesize at start of operation */
1350 size_t drain; /* Increased when this stream has data to read, even if its
1351 socket is not necessarily is readable. Decreased when
1353 bool done; /* set to FALSE when Curl_init_do() is called and set to TRUE
1354 when multi_done() is called, to prevent multi_done() to get
1355 invoked twice when the multi interface is used. */
1357 curl_read_callback fread_func; /* read callback/function */
1358 void *in; /* CURLOPT_READDATA */
1360 struct Curl_easy *stream_depends_on;
1361 bool stream_depends_e; /* set or don't set the Exclusive bit */
1364 bool conncache_lock;
1366 CURLU *uh; /* URL handle for the current parsed URL */
1367 struct urlpieces up;
1372 * This 'DynamicStatic' struct defines dynamic states that actually change
1373 * values in the 'UserDefined' area, which MUST be taken into consideration
1374 * if the UserDefined struct is cloned or similar. You can probably just
1375 * copy these, but each one indicate a special action on other data.
1378 struct DynamicStatic {
1379 char *url; /* work URL, copied from UserDefined */
1380 bool url_alloc; /* URL string is malloc()'ed */
1381 char *referer; /* referer string */
1382 bool referer_alloc; /* referer string is malloc()ed */
1383 struct curl_slist *cookielist; /* list of cookie files set by
1384 curl_easy_setopt(COOKIEFILE) calls */
1385 struct curl_slist *resolve; /* set to point to the set.resolve list when
1386 this should be dealt with in pretransfer */
1390 * This 'UserDefined' struct must only contain data that is set once to go
1391 * for many (perhaps) independent connections. Values that are generated or
1392 * calculated internally for the "session handle" MUST be defined within the
1393 * 'struct UrlState' instead. The only exceptions MUST note the changes in
1394 * the 'DynamicStatic' struct.
1395 * Character pointer fields point to dynamic storage, unless otherwise stated.
1398 struct Curl_multi; /* declared and used only in multi.c */
1401 STRING_CERT_ORIG, /* client certificate file name */
1402 STRING_CERT_PROXY, /* client certificate file name */
1403 STRING_CERT_TYPE_ORIG, /* format for certificate (default: PEM)*/
1404 STRING_CERT_TYPE_PROXY, /* format for certificate (default: PEM)*/
1405 STRING_COOKIE, /* HTTP cookie string to send */
1406 STRING_COOKIEJAR, /* dump all cookies to this file */
1407 STRING_CUSTOMREQUEST, /* HTTP/FTP/RTSP request/method to use */
1408 STRING_DEFAULT_PROTOCOL, /* Protocol to use when the URL doesn't specify */
1409 STRING_DEVICE, /* local network interface/address to use */
1410 STRING_ENCODING, /* Accept-Encoding string */
1411 STRING_FTP_ACCOUNT, /* ftp account data */
1412 STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */
1413 STRING_FTPPORT, /* port to send with the FTP PORT command */
1414 STRING_KEY_ORIG, /* private key file name */
1415 STRING_KEY_PROXY, /* private key file name */
1416 STRING_KEY_PASSWD_ORIG, /* plain text private key password */
1417 STRING_KEY_PASSWD_PROXY, /* plain text private key password */
1418 STRING_KEY_TYPE_ORIG, /* format for private key (default: PEM) */
1419 STRING_KEY_TYPE_PROXY, /* format for private key (default: PEM) */
1420 STRING_KRB_LEVEL, /* krb security level */
1421 STRING_NETRC_FILE, /* if not NULL, use this instead of trying to find
1423 STRING_PROXY, /* proxy to use */
1424 STRING_PRE_PROXY, /* pre socks proxy to use */
1425 STRING_SET_RANGE, /* range, if used */
1426 STRING_SET_REFERER, /* custom string for the HTTP referer field */
1427 STRING_SET_URL, /* what original URL to work on */
1428 STRING_SSL_CAPATH_ORIG, /* CA directory name (doesn't work on windows) */
1429 STRING_SSL_CAPATH_PROXY, /* CA directory name (doesn't work on windows) */
1430 STRING_SSL_CAFILE_ORIG, /* certificate file to verify peer against */
1431 STRING_SSL_CAFILE_PROXY, /* certificate file to verify peer against */
1432 STRING_SSL_PINNEDPUBLICKEY_ORIG, /* public key file to verify peer against */
1433 STRING_SSL_PINNEDPUBLICKEY_PROXY, /* public key file to verify proxy */
1434 STRING_SSL_CIPHER_LIST_ORIG, /* list of ciphers to use */
1435 STRING_SSL_CIPHER_LIST_PROXY, /* list of ciphers to use */
1436 STRING_SSL_CIPHER13_LIST_ORIG, /* list of TLS 1.3 ciphers to use */
1437 STRING_SSL_CIPHER13_LIST_PROXY, /* list of TLS 1.3 ciphers to use */
1438 STRING_SSL_EGDSOCKET, /* path to file containing the EGD daemon socket */
1439 STRING_SSL_RANDOM_FILE, /* path to file containing "random" data */
1440 STRING_USERAGENT, /* User-Agent string */
1441 STRING_SSL_CRLFILE_ORIG, /* crl file to check certificate */
1442 STRING_SSL_CRLFILE_PROXY, /* crl file to check certificate */
1443 STRING_SSL_ISSUERCERT_ORIG, /* issuer cert file to check certificate */
1444 STRING_SSL_ISSUERCERT_PROXY, /* issuer cert file to check certificate */
1445 STRING_SSL_ENGINE, /* name of ssl engine */
1446 STRING_USERNAME, /* <username>, if used */
1447 STRING_PASSWORD, /* <password>, if used */
1448 STRING_OPTIONS, /* <options>, if used */
1449 STRING_PROXYUSERNAME, /* Proxy <username>, if used */
1450 STRING_PROXYPASSWORD, /* Proxy <password>, if used */
1451 STRING_NOPROXY, /* List of hosts which should not use the proxy, if
1453 STRING_RTSP_SESSION_ID, /* Session ID to use */
1454 STRING_RTSP_STREAM_URI, /* Stream URI for this request */
1455 STRING_RTSP_TRANSPORT, /* Transport for this session */
1456 #if defined(USE_LIBSSH2) || defined(USE_LIBSSH)
1457 STRING_SSH_PRIVATE_KEY, /* path to the private key file for auth */
1458 STRING_SSH_PUBLIC_KEY, /* path to the public key file for auth */
1459 STRING_SSH_HOST_PUBLIC_KEY_MD5, /* md5 of host public key in ascii hex */
1460 STRING_SSH_KNOWNHOSTS, /* file name of knownhosts file */
1462 STRING_PROXY_SERVICE_NAME, /* Proxy service name */
1463 STRING_SERVICE_NAME, /* Service name */
1468 STRING_TLSAUTH_USERNAME_ORIG, /* TLS auth <username> */
1469 STRING_TLSAUTH_USERNAME_PROXY, /* TLS auth <username> */
1470 STRING_TLSAUTH_PASSWORD_ORIG, /* TLS auth <password> */
1471 STRING_TLSAUTH_PASSWORD_PROXY, /* TLS auth <password> */
1473 STRING_BEARER, /* <bearer>, if used */
1474 #ifdef USE_UNIX_SOCKETS
1475 STRING_UNIX_SOCKET_PATH, /* path to Unix socket, if used */
1477 STRING_TARGET, /* CURLOPT_REQUEST_TARGET */
1478 STRING_DOH, /* CURLOPT_DOH_URL */
1479 /* -- end of zero-terminated strings -- */
1481 STRING_LASTZEROTERMINATED,
1483 /* -- below this are pointers to binary data that cannot be strdup'ed. --- */
1485 STRING_COPYPOSTFIELDS, /* if POST, set the fields' values here */
1487 STRING_LAST /* not used, just an end-of-list marker */
1490 /* callback that gets called when this easy handle is completed within a multi
1491 handle. Only used for internally created transfers, like for example
1493 typedef int (*multidone_func)(struct Curl_easy *easy, CURLcode result);
1495 struct UserDefined {
1496 FILE *err; /* the stderr user data goes here */
1497 void *debugdata; /* the data that will be passed to fdebug */
1498 char *errorbuffer; /* (Static) store failure messages in here */
1499 long proxyport; /* If non-zero, use this port number by default. If the
1500 proxy string features a ":[port]" that one will override
1502 void *out; /* CURLOPT_WRITEDATA */
1503 void *in_set; /* CURLOPT_READDATA */
1504 void *writeheader; /* write the header to this if non-NULL */
1505 void *rtp_out; /* write RTP to this if non-NULL */
1506 long use_port; /* which port to use (when not using default) */
1507 unsigned long httpauth; /* kind of HTTP authentication to use (bitmask) */
1508 unsigned long proxyauth; /* kind of proxy authentication to use (bitmask) */
1509 unsigned long socks5auth;/* kind of SOCKS5 authentication to use (bitmask) */
1510 long followlocation; /* as in HTTP Location: */
1511 long maxredirs; /* maximum no. of http(s) redirects to follow, set to -1
1514 int keep_post; /* keep POSTs as POSTs after a 30x request; each
1515 bit represents a request, from 301 to 303 */
1516 bool free_referer; /* set TRUE if 'referer' points to a string we
1518 void *postfields; /* if POST, set the fields' values here */
1519 curl_seek_callback seek_func; /* function that seeks the input */
1520 curl_off_t postfieldsize; /* if POST, this might have a size to use instead
1521 of strlen(), and then the data *may* be binary
1522 (contain zero bytes) */
1523 unsigned short localport; /* local port number to bind to */
1524 int localportrange; /* number of additional port numbers to test in case the
1525 'localport' one can't be bind()ed */
1526 curl_write_callback fwrite_func; /* function that stores the output */
1527 curl_write_callback fwrite_header; /* function that stores headers */
1528 curl_write_callback fwrite_rtp; /* function that stores interleaved RTP */
1529 curl_read_callback fread_func_set; /* function that reads the input */
1530 int is_fread_set; /* boolean, has read callback been set to non-NULL? */
1531 int is_fwrite_set; /* boolean, has write callback been set to non-NULL? */
1532 curl_progress_callback fprogress; /* OLD and deprecated progress callback */
1533 curl_xferinfo_callback fxferinfo; /* progress callback */
1534 curl_debug_callback fdebug; /* function that write informational data */
1535 curl_ioctl_callback ioctl_func; /* function for I/O control */
1536 curl_sockopt_callback fsockopt; /* function for setting socket options */
1537 void *sockopt_client; /* pointer to pass to the socket options callback */
1538 curl_opensocket_callback fopensocket; /* function for checking/translating
1539 the address and opening the
1541 void *opensocket_client;
1542 curl_closesocket_callback fclosesocket; /* function for closing the
1544 void *closesocket_client;
1546 void *seek_client; /* pointer to pass to the seek callback */
1547 /* the 3 curl_conv_callback functions below are used on non-ASCII hosts */
1548 /* function to convert from the network encoding: */
1549 curl_conv_callback convfromnetwork;
1550 /* function to convert to the network encoding: */
1551 curl_conv_callback convtonetwork;
1552 /* function to convert from UTF-8 encoding: */
1553 curl_conv_callback convfromutf8;
1555 void *progress_client; /* pointer to pass to the progress callback */
1556 void *ioctl_client; /* pointer to pass to the ioctl callback */
1557 long timeout; /* in milliseconds, 0 means no timeout */
1558 long connecttimeout; /* in milliseconds, 0 means no timeout */
1559 long accepttimeout; /* in milliseconds, 0 means no timeout */
1560 long happy_eyeballs_timeout; /* in milliseconds, 0 is a valid value */
1561 long server_response_timeout; /* in milliseconds, 0 means no timeout */
1562 long tftp_blksize; /* in bytes, 0 means use default */
1563 bool tftp_no_options; /* do not send TFTP options requests */
1564 curl_off_t filesize; /* size of file to upload, -1 means unknown */
1565 long low_speed_limit; /* bytes/second */
1566 long low_speed_time; /* number of seconds */
1567 curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */
1568 curl_off_t max_recv_speed; /* high speed limit in bytes/second for
1570 curl_off_t set_resume_from; /* continue [ftp] transfer from here */
1571 struct curl_slist *headers; /* linked list of extra headers */
1572 struct curl_slist *proxyheaders; /* linked list of extra CONNECT headers */
1573 struct curl_httppost *httppost; /* linked list of old POST data */
1574 curl_mimepart mimepost; /* MIME/POST data. */
1575 bool sep_headers; /* handle host and proxy headers separately */
1576 bool cookiesession; /* new cookie session? */
1577 bool crlf; /* convert crlf on ftp upload(?) */
1578 struct curl_slist *quote; /* after connection is established */
1579 struct curl_slist *postquote; /* after the transfer */
1580 struct curl_slist *prequote; /* before the transfer, after type */
1581 struct curl_slist *source_quote; /* 3rd party quote */
1582 struct curl_slist *source_prequote; /* in 3rd party transfer mode - before
1583 the transfer on source host */
1584 struct curl_slist *source_postquote; /* in 3rd party transfer mode - after
1585 the transfer on source host */
1586 struct curl_slist *telnet_options; /* linked list of telnet options */
1587 struct curl_slist *resolve; /* list of names to add/remove from
1589 struct curl_slist *connect_to; /* list of host:port mappings to override
1590 the hostname and port to connect to */
1591 curl_TimeCond timecondition; /* kind of time/date comparison */
1592 time_t timevalue; /* what time to compare with */
1593 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
1594 long httpversion; /* when non-zero, a specific HTTP version requested to
1595 be used in the library's request(s) */
1596 bool strip_path_slash; /* strip off initial slash from path */
1597 struct ssl_config_data ssl; /* user defined SSL stuff */
1598 struct ssl_config_data proxy_ssl; /* user defined SSL stuff for proxy */
1599 struct ssl_general_config general_ssl; /* general user defined SSL stuff */
1600 curl_proxytype proxytype; /* what kind of proxy that is in use */
1601 long dns_cache_timeout; /* DNS cache timeout */
1602 long buffer_size; /* size of receive buffer to use */
1603 size_t upload_buffer_size; /* size of upload buffer to use,
1604 keep it >= CURL_MAX_WRITE_SIZE */
1605 void *private_data; /* application-private data */
1607 struct curl_slist *http200aliases; /* linked list of aliases for http200 */
1609 long ipver; /* the CURL_IPRESOLVE_* defines in the public header file
1610 0 - whatever, 1 - v2, 2 - v6 */
1612 curl_off_t max_filesize; /* Maximum file size to download */
1614 curl_ftpfile ftp_filemethod; /* how to get to a file when FTP is used */
1616 int ftp_create_missing_dirs; /* 1 - create directories that don't exist
1617 2 - the same but also allow MKD to fail once
1620 curl_sshkeycallback ssh_keyfunc; /* key matching callback */
1621 void *ssh_keyfunc_userp; /* custom pointer to callback */
1622 bool ssh_compression; /* enable SSH compression */
1624 /* Here follows boolean settings that define how to behave during
1625 this session. They are STATIC, set by libcurl users or at least initially
1626 and they don't change during operations. */
1627 bool get_filetime; /* get the time and get of the remote file */
1628 bool tunnel_thru_httpproxy; /* use CONNECT through a HTTP proxy */
1629 bool prefer_ascii; /* ASCII rather than binary */
1630 bool ftp_append; /* append, not overwrite, on upload */
1631 bool ftp_list_only; /* switch FTP command for listing directories */
1632 bool ftp_use_port; /* use the FTP PORT command */
1633 bool hide_progress; /* don't use the progress meter */
1634 bool http_fail_on_error; /* fail on HTTP error codes >= 400 */
1635 bool http_keep_sending_on_error; /* for HTTP status codes >= 300 */
1636 bool http_follow_location; /* follow HTTP redirects */
1637 bool http_transfer_encoding; /* request compressed HTTP transfer-encoding */
1638 bool allow_auth_to_other_hosts;
1639 bool include_header; /* include received protocol headers in data output */
1640 bool http_set_referer; /* is a custom referer used */
1641 bool http_auto_referer; /* set "correct" referer when following location: */
1642 bool opt_no_body; /* as set with CURLOPT_NOBODY */
1643 bool upload; /* upload request */
1644 enum CURL_NETRC_OPTION
1645 use_netrc; /* defined in include/curl.h */
1646 bool verbose; /* output verbosity */
1647 bool krb; /* Kerberos connection requested */
1648 bool reuse_forbid; /* forbidden to be reused, close after use */
1649 bool reuse_fresh; /* do not re-use an existing connection */
1650 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
1651 bool ftp_use_eprt; /* if EPRT is to be attempted or not */
1652 bool ftp_use_pret; /* if PRET is to be used before PASV or not */
1654 curl_usessl use_ssl; /* if AUTH TLS is to be attempted etc, for FTP or
1655 IMAP or POP3 or others! */
1656 curl_ftpauth ftpsslauth; /* what AUTH XXX to be attempted */
1657 curl_ftpccc ftp_ccc; /* FTP CCC options */
1658 bool no_signal; /* do not use any signal/alarm handler */
1659 bool global_dns_cache; /* subject for future removal */
1660 bool tcp_nodelay; /* whether to enable TCP_NODELAY or not */
1661 bool ignorecl; /* ignore content length */
1662 bool ftp_skip_ip; /* skip the IP address the FTP server passes on to
1664 bool connect_only; /* make connection, let application use the socket */
1665 long ssh_auth_types; /* allowed SSH auth types */
1666 bool http_te_skip; /* pass the raw body data to the user, even when
1667 transfer-encoded (chunked, compressed) */
1668 bool http_ce_skip; /* pass the raw body data to the user, even when
1669 content-encoded (chunked, compressed) */
1670 long new_file_perms; /* Permissions to use when creating remote files */
1671 long new_directory_perms; /* Permissions to use when creating remote dirs */
1672 bool proxy_transfer_mode; /* set transfer mode (;type=<a|i>) when doing FTP
1673 via an HTTP proxy */
1674 char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */
1675 unsigned int scope_id; /* Scope id for IPv6 */
1676 long allowed_protocols;
1677 long redir_protocols;
1678 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1679 bool socks5_gssapi_nec; /* Flag to support NEC SOCKS5 server */
1681 struct curl_slist *mail_rcpt; /* linked list of mail recipients */
1682 bool sasl_ir; /* Enable/disable SASL initial response */
1683 /* Common RTSP header options */
1684 Curl_RtspReq rtspreq; /* RTSP request type */
1685 long rtspversion; /* like httpversion, for RTSP */
1686 bool wildcard_enabled; /* enable wildcard matching */
1687 curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer
1689 curl_chunk_end_callback chunk_end; /* called after part transferring
1691 curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds
1692 to pattern (e.g. if WILDCARDMATCH is on) */
1695 long gssapi_delegation; /* GSS-API credential delegation, see the
1696 documentation of CURLOPT_GSSAPI_DELEGATION */
1698 bool tcp_keepalive; /* use TCP keepalives */
1699 long tcp_keepidle; /* seconds in idle before sending keepalive probe */
1700 long tcp_keepintvl; /* seconds between TCP keepalive probes */
1701 bool tcp_fastopen; /* use TCP Fast Open */
1703 size_t maxconnects; /* Max idle connections in the connection cache */
1705 bool ssl_enable_npn; /* TLS NPN extension? */
1706 bool ssl_enable_alpn; /* TLS ALPN extension? */
1707 bool path_as_is; /* allow dotdots? */
1708 bool pipewait; /* wait for pipe/multiplex status before starting a
1710 long expect_100_timeout; /* in milliseconds */
1711 bool suppress_connect_headers; /* suppress proxy CONNECT response headers
1712 from user callbacks */
1714 bool dns_shuffle_addresses; /* whether to shuffle addresses before use */
1716 struct Curl_easy *stream_depends_on;
1717 bool stream_depends_e; /* set or don't set the Exclusive bit */
1720 bool haproxyprotocol; /* whether to send HAProxy PROXY protocol v1 header */
1722 struct Curl_http2_dep *stream_dependents;
1724 bool abstract_unix_socket;
1726 curl_resolver_start_callback resolver_start; /* optional callback called
1727 before resolver start */
1728 void *resolver_start_client; /* pointer to pass to resolver start callback */
1729 bool disallow_username_in_url; /* disallow username in url */
1730 long upkeep_interval_ms; /* Time between calls for connection upkeep. */
1731 bool doh; /* DNS-over-HTTPS enabled */
1732 bool doh_get; /* use GET for DoH requests, instead of POST */
1733 multidone_func fmultidone;
1734 struct Curl_easy *dohfor; /* this is a DoH request for that transfer */
1738 struct curl_hash *hostcache;
1740 HCACHE_NONE, /* not pointing to anything */
1741 HCACHE_GLOBAL, /* points to the (shrug) global one */
1742 HCACHE_MULTI, /* points to a shared one in the multi handle */
1743 HCACHE_SHARED /* points to a shared one in a shared object */
1748 * The 'connectdata' struct MUST have all the connection oriented stuff as we
1749 * may have several simultaneous connections and connection structs in memory.
1751 * The 'struct UserDefined' must only contain data that is set once to go for
1752 * many (perhaps) independent connections. Values that are generated or
1753 * calculated internally for the "session handle" must be defined within the
1754 * 'struct UrlState' instead.
1758 /* first, two fields for the linked list of these */
1759 struct Curl_easy *next;
1760 struct Curl_easy *prev;
1762 struct connectdata *easy_conn; /* the "unit's" connection */
1763 struct curl_llist_element connect_queue;
1764 struct curl_llist_element pipeline_queue;
1766 CURLMstate mstate; /* the handle's state */
1767 CURLcode result; /* previous result */
1769 struct Curl_message msg; /* A single posted message. */
1771 /* Array with the plain socket numbers this handle takes care of, in no
1772 particular order. Note that all sockets are added to the sockhash, where
1773 the state etc are also kept. This array is mostly used to detect when a
1774 socket is to be removed from the hash. See singlesocket(). */
1775 curl_socket_t sockets[MAX_SOCKSPEREASYHANDLE];
1779 struct Curl_multi *multi; /* if non-NULL, points to the multi handle
1780 struct to which this "belongs" when used by
1781 the multi interface */
1782 struct Curl_multi *multi_easy; /* if non-NULL, points to the multi handle
1783 struct to which this "belongs" when used
1784 by the easy interface */
1785 struct Curl_share *share; /* Share, handles global variable mutexing */
1787 struct PslCache *psl; /* The associated PSL cache. */
1789 struct SingleRequest req; /* Request-specific data */
1790 struct UserDefined set; /* values set by the libcurl user */
1791 struct DynamicStatic change; /* possibly modified userdefined data */
1792 struct CookieInfo *cookies; /* the cookies, read from files and servers.
1793 NOTE that the 'cookie' field in the
1794 UserDefined struct defines if the "engine"
1795 is to be used or not. */
1796 struct Progress progress; /* for all the progress meter data */
1797 struct UrlState state; /* struct for fields used for state info and
1798 other dynamic purposes */
1799 struct WildcardData wildcard; /* wildcard download state info */
1800 struct PureInfo info; /* stats, reports and info data */
1801 struct curl_tlssessioninfo tsi; /* Information about the TLS session, only
1802 valid after a client has asked for it */
1803 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
1804 iconv_t outbound_cd; /* for translating to the network encoding */
1805 iconv_t inbound_cd; /* for translating from the network encoding */
1806 iconv_t utf8_cd; /* for translating to UTF8 */
1807 #endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */
1808 unsigned int magic; /* set to a CURLEASY_MAGIC_NUMBER */
1811 #define LIBCURL_NAME "libcurl"
1813 #endif /* HEADER_CURL_URLDATA_H */
projects / platform / upstream / curl.git / blob