1 #ifndef HEADER_CURL_URLDATA_H
2 #define HEADER_CURL_URLDATA_H
3 /***************************************************************************
5 * Project ___| | | | _ \| |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 1998 - 2017, 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)
86 #include <openssl/ssl.h>
87 #ifdef HAVE_OPENSSL_ENGINE_H
88 #include <openssl/engine.h>
90 #endif /* USE_OPENSSL */
93 #include <gnutls/gnutls.h>
98 #include <mbedtls/ssl.h>
99 #include <mbedtls/version.h>
100 #include <mbedtls/entropy.h>
101 #include <mbedtls/ctr_drbg.h>
103 #elif defined USE_POLARSSL
105 #include <polarssl/ssl.h>
106 #include <polarssl/version.h>
107 #if POLARSSL_VERSION_NUMBER<0x01010000
108 #include <polarssl/havege.h>
110 #include <polarssl/entropy.h>
111 #include <polarssl/ctr_drbg.h>
112 #endif /* POLARSSL_VERSION_NUMBER<0x01010000 */
114 #endif /* USE_POLARSSL */
117 #undef OCSP_REQUEST /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */
118 #undef OCSP_RESPONSE /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */
119 #include <cyassl/openssl/ssl.h>
132 #include <axTLS/config.h>
133 #include <axTLS/ssl.h>
137 #endif /* USE_AXTLS */
139 #if defined(USE_SCHANNEL) || defined(USE_WINDOWS_SSPI)
140 #include "curl_sspi.h"
144 #include <schannel.h>
148 #include <Security/Security.h>
149 /* For some reason, when building for iOS, the omnibus header above does
150 * not include SecureTransport.h as of iOS SDK 5.1. */
151 #include <Security/SecureTransport.h>
154 #ifdef HAVE_NETINET_IN_H
155 #include <netinet/in.h>
161 #include <zlib.h> /* for content-encoding */
163 /* zlib pollutes the namespace with this definition */
168 #include <curl/curl.h>
170 #include "http_chunks.h" /* for the structs and enum stuff */
184 #include "wildcard.h"
185 #include "multihandle.h"
190 # elif defined HAVE_GSSMIT
191 # include <gssapi/gssapi.h>
192 # include <gssapi/gssapi_generic.h>
198 #ifdef HAVE_LIBSSH2_H
200 #include <libssh2_sftp.h>
201 #endif /* HAVE_LIBSSH2_H */
203 /* Download buffer size, keep it fairly big for speed reasons */
205 #define BUFSIZE CURL_MAX_WRITE_SIZE
207 #define MAX_BUFSIZE CURL_MAX_READ_SIZE
208 #define CURL_BUFSIZE(x) ((x)?(x):(BUFSIZE))
210 /* Initial size of the buffer to store headers in, it'll be enlarged in case
212 #define HEADERSIZE 256
214 #define CURLEASY_MAGIC_NUMBER 0xc0dedbadU
215 #define GOOD_EASY_HANDLE(x) \
216 ((x) && ((x)->magic == CURLEASY_MAGIC_NUMBER))
218 /* Some convenience macros to get the larger/smaller value out of two given.
219 We prefix with CURL to prevent name collisions. */
220 #define CURLMAX(x,y) ((x)>(y)?(x):(y))
221 #define CURLMIN(x,y) ((x)<(y)?(x):(y))
224 /* Types needed for krb5-ftp connections */
232 enum protection_level {
233 PROT_NONE, /* first in list */
239 PROT_LAST /* last in list */
244 /* Structs to store Schannel handles */
245 struct curl_schannel_cred {
246 CredHandle cred_handle;
247 TimeStamp time_stamp;
251 struct curl_schannel_ctxt {
252 CtxtHandle ctxt_handle;
253 TimeStamp time_stamp;
257 /* enum for the nonblocking SSL connection state machine */
261 ssl_connect_2_reading,
262 ssl_connect_2_writing,
269 ssl_connection_negotiating,
270 ssl_connection_complete
271 } ssl_connection_state;
273 /* struct for data related to each SSL connection */
274 struct ssl_connect_data {
275 /* Use ssl encrypted communications TRUE/FALSE, not necessarily using it atm
276 but at least asked to or meaning to use it. See 'state' for the exact
277 current state of the connection. */
279 ssl_connection_state state;
280 ssl_connect_state connecting_state;
281 #if defined(USE_OPENSSL)
282 /* these ones requires specific SSL-types */
286 #elif defined(USE_GNUTLS)
287 gnutls_session_t session;
288 gnutls_certificate_credentials_t cred;
290 gnutls_srp_client_credentials_t srp_client_cred;
292 #elif defined(USE_MBEDTLS)
293 mbedtls_ctr_drbg_context ctr_drbg;
294 mbedtls_entropy_context entropy;
295 mbedtls_ssl_context ssl;
297 mbedtls_x509_crt cacert;
298 mbedtls_x509_crt clicert;
299 mbedtls_x509_crl crl;
300 mbedtls_pk_context pk;
301 mbedtls_ssl_config config;
302 const char *protocols[3];
303 #elif defined(USE_POLARSSL)
304 ctr_drbg_context ctr_drbg;
305 entropy_context entropy;
312 #elif defined(USE_CYASSL)
315 #elif defined(USE_NSS)
317 char *client_nickname;
318 struct Curl_easy *data;
319 struct curl_llist *obj_list;
320 PK11GenericObject *obj_clicert;
321 #elif defined(USE_GSKIT)
326 #elif defined(USE_AXTLS)
329 #elif defined(USE_SCHANNEL)
330 struct curl_schannel_cred *cred;
331 struct curl_schannel_ctxt *ctxt;
332 SecPkgContext_StreamSizes stream_sizes;
333 size_t encdata_length, decdata_length;
334 size_t encdata_offset, decdata_offset;
335 unsigned char *encdata_buffer, *decdata_buffer;
336 unsigned long req_flags, ret_flags;
337 CURLcode recv_unrecoverable_err; /* schannel_recv had an unrecoverable err */
338 bool recv_sspi_close_notify; /* true if connection closed by close_notify */
339 bool recv_connection_closed; /* true if connection closed, regardless how */
340 bool use_alpn; /* true if ALPN is used for this connection */
341 #elif defined(USE_DARWINSSL)
342 SSLContextRef ssl_ctx;
343 curl_socket_t ssl_sockfd;
344 bool ssl_direction; /* true if writing, false if reading */
345 size_t ssl_write_buffered_length;
346 #elif defined(USE_SSL)
347 #error "SSL backend specific information missing from ssl_connect_data"
351 struct ssl_primary_config {
352 long version; /* what version the client wants to use */
353 bool verifypeer; /* set TRUE if this is desired */
354 bool verifyhost; /* set TRUE if CN/SAN must match hostname */
355 bool verifystatus; /* set TRUE if certificate status must be checked */
356 char *CApath; /* certificate dir (doesn't work on windows) */
357 char *CAfile; /* certificate to verify peer against */
359 char *random_file; /* path to file containing "random" data */
360 char *egdsocket; /* path to file containing the EGD daemon socket */
361 char *cipher_list; /* list of ciphers to use */
364 struct ssl_config_data {
365 struct ssl_primary_config primary;
366 bool enable_beast; /* especially allow this flaw for interoperability's
368 bool no_revoke; /* disable SSL certificate revocation checks */
369 long certverifyresult; /* result from the certificate verification */
370 char *CRLfile; /* CRL to check certificate revocation */
371 char *issuercert;/* optional issuer certificate filename */
372 curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */
373 void *fsslctxp; /* parameter for call back */
374 bool certinfo; /* gather lots of certificate info */
377 char *cert; /* client certificate file name */
378 char *cert_type; /* format for certificate (default: PEM)*/
379 char *key; /* private key file name */
380 char *key_type; /* format for private key (default: PEM) */
381 char *key_passwd; /* plain text private key password */
384 char *username; /* TLS username (for, e.g., SRP) */
385 char *password; /* TLS password (for, e.g., SRP) */
386 enum CURL_TLSAUTH authtype; /* TLS authentication type (default SRP) */
390 struct ssl_general_config {
391 bool sessionid; /* cache session IDs or not */
392 size_t max_ssl_sessions; /* SSL session id cache size */
395 /* information stored about one single SSL session */
396 struct curl_ssl_session {
397 char *name; /* host name for which this ID was used */
398 char *conn_to_host; /* host name for the connection (may be NULL) */
399 const char *scheme; /* protocol scheme used */
400 void *sessionid; /* as returned from the SSL layer */
401 size_t idsize; /* if known, otherwise 0 */
402 long age; /* just a number, the higher the more recent */
403 int remote_port; /* remote port */
404 int conn_to_port; /* remote port for the connection (may be -1) */
405 struct ssl_primary_config ssl_config; /* setup for this session */
408 /* Struct used for Digest challenge-response authentication */
410 #if defined(USE_WINDOWS_SSPI)
412 size_t input_token_len;
413 CtxtHandle *http_context;
419 bool stale; /* set true for re-negotiation */
423 int nc; /* nounce count */
435 #ifdef USE_WINDOWS_SSPI
436 #include "curl_sspi.h"
439 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
443 /* Struct used for GSSAPI (Kerberos V5) authentication */
444 #if defined(USE_KERBEROS5)
445 struct kerberos5data {
446 #if defined(USE_WINDOWS_SSPI)
447 CredHandle *credentials;
450 SEC_WINNT_AUTH_IDENTITY identity;
451 SEC_WINNT_AUTH_IDENTITY *p_identity;
455 gss_ctx_id_t context;
461 /* Struct used for NTLM challenge-response authentication */
462 #if defined(USE_NTLM)
465 #ifdef USE_WINDOWS_SSPI
466 CredHandle *credentials;
468 SEC_WINNT_AUTH_IDENTITY identity;
469 SEC_WINNT_AUTH_IDENTITY *p_identity;
473 size_t input_token_len;
476 unsigned char nonce[8];
477 void *target_info; /* TargetInfo received in the ntlm type-2 message */
478 unsigned int target_info_len;
484 struct negotiatedata {
485 /* When doing Negotiate (SPNEGO) auth, we first need to send a token
486 and then validate the received one. */
487 enum { GSS_AUTHNONE, GSS_AUTHRECV, GSS_AUTHSENT } state;
490 gss_ctx_id_t context;
492 gss_buffer_desc output_token;
494 #ifdef USE_WINDOWS_SSPI
496 CredHandle *credentials;
498 SEC_WINNT_AUTH_IDENTITY identity;
499 SEC_WINNT_AUTH_IDENTITY *p_identity;
503 size_t output_token_length;
511 * Boolean values that concerns this connection.
514 /* always modify bits.close with the connclose() and connkeep() macros! */
515 bool close; /* if set, we close the connection after this request */
516 bool reuse; /* if set, this is a re-used connection */
517 bool conn_to_host; /* if set, this connection has a "connect to host"
518 that overrides the host in the URL */
519 bool conn_to_port; /* if set, this connection has a "connect to port"
520 that overrides the port in the URL (remote port) */
521 bool proxy; /* if set, this transfer is done through a proxy - any type */
522 bool httpproxy; /* if set, this transfer is done through a http proxy */
523 bool socksproxy; /* if set, this transfer is done through a socks proxy */
524 bool user_passwd; /* do we use user+password for this connection? */
525 bool proxy_user_passwd; /* user+password for the proxy? */
526 bool ipv6_ip; /* we communicate with a remote site specified with pure IPv6
528 bool ipv6; /* we communicate with a site using an IPv6 address */
530 bool do_more; /* this is set TRUE if the ->curl_do_more() function is
531 supposed to be called, after ->curl_do() */
532 bool tcpconnect[2]; /* the TCP layer (or similar) is connected, this is set
533 the first time on the first connect function call */
534 bool protoconnstart;/* the protocol layer has STARTED its operation after
535 the TCP layer connect */
537 bool retry; /* this connection is about to get closed and then
538 re-attempted at another connection. */
539 bool tunnel_proxy; /* if CONNECT is used to "tunnel" through the proxy.
540 This is implicit when SSL-protocols are used through
541 proxies, but can also be enabled explicitly by
543 bool authneg; /* TRUE when the auth phase has started, which means
544 that we are creating a request with an auth header,
545 but it is not the final request in the auth
547 bool rewindaftersend;/* TRUE when the sending couldn't be stopped even
548 though it will be discarded. When the whole send
549 operation is done, we must call the data rewind
551 bool ftp_use_epsv; /* As set with CURLOPT_FTP_USE_EPSV, but if we find out
552 EPSV doesn't work we disable it for the forthcoming
555 bool ftp_use_eprt; /* As set with CURLOPT_FTP_USE_EPRT, but if we find out
556 EPRT doesn't work we disable it for the forthcoming
558 bool ftp_use_data_ssl; /* Enabled SSL for the data connection */
559 bool netrc; /* name+password provided by netrc */
560 bool userpwd_in_url; /* name+password found in url */
561 bool stream_was_rewound; /* Indicates that the stream was rewound after a
562 request read past the end of its response byte
564 bool proxy_connect_closed; /* set true if a proxy disconnected the
565 connection in a CONNECT request with auth, so
566 that libcurl should reconnect and continue. */
567 bool bound; /* set true if bind() has already been done on this socket/
569 bool type_set; /* type= was used in the URL */
570 bool multiplex; /* connection is multiplexed */
572 bool tcp_fastopen; /* use TCP Fast Open */
573 bool tls_enable_npn; /* TLS NPN extension? */
574 bool tls_enable_alpn; /* TLS ALPN extension? */
575 bool proxy_ssl_connected[2]; /* TRUE when SSL initialization for HTTPS proxy
577 bool socksproxy_connecting; /* connecting through a socks proxy */
581 char *rawalloc; /* allocated "raw" version of the name */
582 char *encalloc; /* allocated IDN-encoded version of the name */
583 char *name; /* name to use internally, might be encoded, might be raw */
584 const char *dispname; /* name to display, as 'name' might be encoded */
588 * Flags on the keepon member of the Curl_transfer_keeper
592 #define KEEP_RECV (1<<0) /* there is or may be data to read */
593 #define KEEP_SEND (1<<1) /* there is or may be data to write */
594 #define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there
595 might still be data to read */
596 #define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there
597 might still be data to write */
598 #define KEEP_RECV_PAUSE (1<<4) /* reading is paused */
599 #define KEEP_SEND_PAUSE (1<<5) /* writing is paused */
601 #define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE)
602 #define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE)
607 ZLIB_UNINIT, /* uninitialized */
608 ZLIB_INIT, /* initialized */
609 ZLIB_GZIP_HEADER, /* reading gzip header */
610 ZLIB_GZIP_INFLATING, /* inflating gzip stream */
611 ZLIB_INIT_GZIP /* initialized in transparent gzip mode */
615 #ifdef CURLRES_ASYNCH
619 struct Curl_dns_entry *dns;
620 bool done; /* set TRUE when the lookup is complete */
621 int status; /* if done is TRUE, this is the status from the callback */
622 void *os_specific; /* 'struct thread_data' for Windows */
626 #define FIRSTSOCKET 0
627 #define SECONDARYSOCKET 1
629 /* These function pointer types are here only to allow easier typecasting
630 within the source when we need to cast between data pointers (such as NULL)
631 and function pointers. */
632 typedef CURLcode (*Curl_do_more_func)(struct connectdata *, int *);
633 typedef CURLcode (*Curl_done_func)(struct connectdata *, CURLcode, bool);
636 EXP100_SEND_DATA, /* enough waiting, just send the body now */
637 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */
638 EXP100_SENDING_REQUEST, /* still sending the request but will wait for
639 the 100 header once done with the request */
640 EXP100_FAILED /* used on 417 Expectation Failed */
644 UPGR101_INIT, /* default state */
645 UPGR101_REQUESTED, /* upgrade requested */
646 UPGR101_RECEIVED, /* response received */
647 UPGR101_WORKING /* talking upgraded protocol */
651 * Request specific data in the easy handle (Curl_easy). Previously,
652 * these members were on the connectdata struct but since a conn struct may
653 * now be shared between different Curl_easys, we store connection-specific
654 * data here. This struct only keeps stuff that's interesting for *this*
655 * request, as it will be cleared between multiple ones
657 struct SingleRequest {
658 curl_off_t size; /* -1 if unknown at this point */
659 curl_off_t *bytecountp; /* return number of bytes read or NULL */
661 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch,
662 -1 means unlimited */
663 curl_off_t *writebytecountp; /* return number of bytes written or NULL */
665 curl_off_t bytecount; /* total number of bytes read */
666 curl_off_t writebytecount; /* number of bytes written */
668 long headerbytecount; /* only count received headers */
669 long deductheadercount; /* this amount of bytes doesn't count when we check
670 if anything has been transferred at the end of a
671 connection. We use this counter to make only a
672 100 reply (without a following second response
673 code) result in a CURLE_GOT_NOTHING error code */
675 struct timeval start; /* transfer started at this time */
676 struct timeval now; /* current time */
677 bool header; /* incoming data has HTTP header */
679 HEADER_NORMAL, /* no bad header at all */
680 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest
682 HEADER_ALLBAD /* all was believed to be header */
683 } badheader; /* the header was deemed bad and will be
685 int headerline; /* counts header lines to better track the
687 char *hbufp; /* points at *end* of header line */
689 char *str; /* within buf */
690 char *str_start; /* within buf */
691 char *end_ptr; /* within buf */
692 char *p; /* within headerbuff */
693 bool content_range; /* set TRUE if Content-Range: was found */
694 curl_off_t offset; /* possible resume offset read from the
695 Content-Range: header */
696 int httpcode; /* error code from the 'HTTP/1.? XXX' or
697 'RTSP/1.? XXX' line */
698 struct timeval start100; /* time stamp to wait for the 100 code from */
699 enum expect100 exp100; /* expect 100 continue state */
700 enum upgrade101 upgr101; /* 101 upgrade state */
702 int auto_decoding; /* What content encoding. sec 3.5, RFC2616. */
704 #define IDENTITY 0 /* No encoding */
705 #define DEFLATE 1 /* zlib deflate [RFC 1950 & 1951] */
706 #define GZIP 2 /* gzip algorithm [RFC 1952] */
709 zlibInitState zlib_init; /* possible zlib init state;
710 undefined if Content-Encoding header. */
711 z_stream z; /* State structure for zlib. */
723 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
724 and we're uploading the last chunk */
726 bool ignorebody; /* we read a response-body but we ignore it! */
727 bool ignorecl; /* This HTTP response has no body so we ignore the Content-
730 char *location; /* This points to an allocated version of the Location:
732 char *newurl; /* Set to the new URL to use when a redirect or a retry is
735 /* 'upload_present' is used to keep a byte counter of how much data there is
736 still left in the buffer, aimed for upload. */
737 ssize_t upload_present;
739 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
740 buffer, so the next read should read from where this pointer points to,
741 and the 'upload_present' contains the number of bytes available at this
743 char *upload_fromhere;
745 bool chunk; /* if set, this is a chunked transfer-encoding */
746 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
748 bool getheader; /* TRUE if header parsing is wanted */
750 bool forbidchunk; /* used only to explicitly forbid chunk-upload for
751 specific upload buffers. See readmoredata() in
752 http.c for details. */
754 void *protop; /* Allocated protocol-specific data. Each protocol
755 handler makes sure this points to data it needs. */
759 * Specific protocol handler.
762 struct Curl_handler {
763 const char *scheme; /* URL scheme name. */
765 /* Complement to setup_connection_internals(). */
766 CURLcode (*setup_connection)(struct connectdata *);
768 /* These two functions MUST be set to be protocol dependent */
769 CURLcode (*do_it)(struct connectdata *, bool *done);
772 /* If the curl_do() function is better made in two halves, this
773 * curl_do_more() function will be called afterwards, if set. For example
774 * for doing the FTP stuff after the PASV/PORT command.
776 Curl_do_more_func do_more;
778 /* This function *MAY* be set to a protocol-dependent function that is run
779 * after the connect() and everything is done, as a step in the connection.
780 * The 'done' pointer points to a bool that should be set to TRUE if the
781 * function completes before return. If it doesn't complete, the caller
782 * should call the curl_connecting() function until it is.
784 CURLcode (*connect_it)(struct connectdata *, bool *done);
786 /* See above. Currently only used for FTP. */
787 CURLcode (*connecting)(struct connectdata *, bool *done);
788 CURLcode (*doing)(struct connectdata *, bool *done);
790 /* Called from the multi interface during the PROTOCONNECT phase, and it
791 should then return a proper fd set */
792 int (*proto_getsock)(struct connectdata *conn,
793 curl_socket_t *socks,
796 /* Called from the multi interface during the DOING phase, and it should
797 then return a proper fd set */
798 int (*doing_getsock)(struct connectdata *conn,
799 curl_socket_t *socks,
802 /* Called from the multi interface during the DO_MORE phase, and it should
803 then return a proper fd set */
804 int (*domore_getsock)(struct connectdata *conn,
805 curl_socket_t *socks,
808 /* Called from the multi interface during the DO_DONE, PERFORM and
809 WAITPERFORM phases, and it should then return a proper fd set. Not setting
810 this will make libcurl use the generic default one. */
811 int (*perform_getsock)(const struct connectdata *conn,
812 curl_socket_t *socks,
815 /* This function *MAY* be set to a protocol-dependent function that is run
816 * by the curl_disconnect(), as a step in the disconnection. If the handler
817 * is called because the connection has been considered dead, dead_connection
820 CURLcode (*disconnect)(struct connectdata *, bool dead_connection);
822 /* If used, this function gets called from transfer.c:readwrite_data() to
823 allow the protocol to do extra reads/writes */
824 CURLcode (*readwrite)(struct Curl_easy *data, struct connectdata *conn,
825 ssize_t *nread, bool *readmore);
827 long defport; /* Default port. */
828 unsigned int protocol; /* See CURLPROTO_* - this needs to be the single
829 specific protocol bit */
830 unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */
833 #define PROTOPT_NONE 0 /* nothing extra */
834 #define PROTOPT_SSL (1<<0) /* uses SSL */
835 #define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */
836 #define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */
837 /* some protocols will have to call the underlying functions without regard to
838 what exact state the socket signals. IE even if the socket says "readable",
839 the send function might need to be called while uploading, or vice versa.
841 #define PROTOPT_DIRLOCK (1<<3)
842 #define PROTOPT_NONETWORK (1<<4) /* protocol doesn't use the network! */
843 #define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it
845 #define PROTOPT_NOURLQUERY (1<<6) /* protocol can't handle
846 url query strings (?foo=bar) ! */
847 #define PROTOPT_CREDSPERREQUEST (1<<7) /* requires login credentials per
848 request instead of per connection */
849 #define PROTOPT_ALPN_NPN (1<<8) /* set ALPN and/or NPN for this */
850 #define PROTOPT_STREAM (1<<9) /* a protocol with individual logical streams */
851 #define PROTOPT_URLOPTIONS (1<<10) /* allow options part in the userinfo field
854 /* return the count of bytes sent, or -1 on error */
855 typedef ssize_t (Curl_send)(struct connectdata *conn, /* connection data */
856 int sockindex, /* socketindex */
857 const void *buf, /* data to write */
858 size_t len, /* max amount to write */
859 CURLcode *err); /* error to return */
861 /* return the count of bytes read, or -1 on error */
862 typedef ssize_t (Curl_recv)(struct connectdata *conn, /* connection data */
863 int sockindex, /* socketindex */
864 char *buf, /* store data here */
865 size_t len, /* max amount to read */
866 CURLcode *err); /* error to return */
868 #ifdef USE_RECV_BEFORE_SEND_WORKAROUND
869 struct postponed_data {
870 char *buffer; /* Temporal store for received data during
871 sending, must be freed */
872 size_t allocated_size; /* Size of temporal store */
873 size_t recv_size; /* Size of received data during sending */
874 size_t recv_processed; /* Size of processed part of postponed data */
876 curl_socket_t bindsock;/* Structure must be bound to specific socket,
877 used only for DEBUGASSERT */
878 #endif /* DEBUGBUILD */
880 #endif /* USE_RECV_BEFORE_SEND_WORKAROUND */
883 struct hostname host;
885 curl_proxytype proxytype; /* what kind of proxy that is in use */
886 char *user; /* proxy user name string, allocated */
887 char *passwd; /* proxy password string, allocated */
891 * The connectdata struct contains all fields and variables that should be
892 * unique for an entire connection.
895 /* 'data' is the CURRENT Curl_easy using this connection -- take great
896 caution that this might very well vary between different times this
897 connection is used! */
898 struct Curl_easy *data;
900 /* chunk is for HTTP chunked encoding, but is in the general connectdata
901 struct only because we can do just about any protocol through a HTTP proxy
902 and a HTTP proxy may in fact respond using chunked encoding */
903 struct Curl_chunker chunk;
905 curl_closesocket_callback fclosesocket; /* function closing the socket(s) */
906 void *closesocket_client;
908 bool inuse; /* This is a marker for the connection cache logic. If this is
909 TRUE this handle is being used by an easy handle and cannot
910 be used by any other easy handle without careful
911 consideration (== only for pipelining). */
913 /**** Fields set when inited and not modified again */
914 long connection_id; /* Contains a unique number to make it easier to
915 track the connections in the log output */
917 /* 'dns_entry' is the particular host we use. This points to an entry in the
918 DNS cache and it will not get pruned while locked. It gets unlocked in
919 Curl_done(). This entry will be NULL if the connection is re-used as then
920 there is no name resolve done. */
921 struct Curl_dns_entry *dns_entry;
923 /* 'ip_addr' is the particular IP we connected to. It points to a struct
924 within the DNS cache, so this pointer is only valid as long as the DNS
925 cache entry remains locked. It gets unlocked in Curl_done() */
926 Curl_addrinfo *ip_addr;
927 Curl_addrinfo *tempaddr[2]; /* for happy eyeballs */
929 /* 'ip_addr_str' is the ip_addr data as a human readable string.
930 It remains available as long as the connection does, which is longer than
931 the ip_addr itself. */
932 char ip_addr_str[MAX_IPADR_LEN];
934 unsigned int scope_id; /* Scope id for IPv6 */
936 int socktype; /* SOCK_STREAM or SOCK_DGRAM */
938 struct hostname host;
939 char *secondaryhostname; /* secondary socket host name (ftp) */
940 struct hostname conn_to_host; /* the host to connect to. valid only if
941 bits.conn_to_host is set */
943 struct proxy_info socks_proxy;
944 struct proxy_info http_proxy;
946 long port; /* which port to use locally */
947 int remote_port; /* the remote port, not the proxy port! */
948 int conn_to_port; /* the remote port to connect to. valid only if
949 bits.conn_to_port is set */
950 unsigned short secondary_port; /* secondary socket remote port to connect to
953 /* 'primary_ip' and 'primary_port' get filled with peer's numerical
954 ip address and port number whenever an outgoing connection is
955 *attempted* from the primary socket to a remote address. When more
956 than one address is tried for a connection these will hold data
957 for the last attempt. When the connection is actually established
958 these are updated with data which comes directly from the socket. */
960 char primary_ip[MAX_IPADR_LEN];
963 /* 'local_ip' and 'local_port' get filled with local's numerical
964 ip address and port number whenever an outgoing connection is
965 **established** from the primary socket to a remote address. */
967 char local_ip[MAX_IPADR_LEN];
970 char *user; /* user name string, allocated */
971 char *passwd; /* password string, allocated */
972 char *options; /* options string, allocated */
974 char *oauth_bearer; /* bearer token for OAuth 2.0, allocated */
976 int httpversion; /* the HTTP version*10 reported by the server */
977 int rtspversion; /* the RTSP version*10 reported by the server */
979 struct timeval now; /* "current" time */
980 struct timeval created; /* creation time */
981 curl_socket_t sock[2]; /* two sockets, the second is used for the data
982 transfer when doing FTP */
983 curl_socket_t tempsock[2]; /* temporary sockets for happy eyeballs */
984 bool sock_accepted[2]; /* TRUE if the socket on this index was created with
989 #ifdef USE_RECV_BEFORE_SEND_WORKAROUND
990 struct postponed_data postponed[2]; /* two buffers for two sockets */
991 #endif /* USE_RECV_BEFORE_SEND_WORKAROUND */
992 struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */
993 struct ssl_connect_data proxy_ssl[2]; /* this is for proxy ssl-stuff */
994 struct ssl_primary_config ssl_config;
995 struct ssl_primary_config proxy_ssl_config;
998 struct ConnectBits bits; /* various state-flags for this connection */
1000 /* connecttime: when connect() is called on the current IP address. Used to
1001 be able to track when to move on to try next IP - but only when the multi
1002 interface is used. */
1003 struct timeval connecttime;
1004 /* The two fields below get set in Curl_connecthost */
1005 int num_addr; /* number of addresses to try to connect to */
1006 time_t timeoutms_per_addr; /* how long time in milliseconds to spend on
1007 trying to connect to each IP address */
1009 const struct Curl_handler *handler; /* Connection's protocol handler */
1010 const struct Curl_handler *given; /* The protocol first given */
1012 long ip_version; /* copied from the Curl_easy at creation time */
1014 /**** curl_get() phase fields */
1016 curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */
1017 curl_socket_t writesockfd; /* socket to write to, it may very
1018 well be the same we read from.
1019 CURL_SOCKET_BAD disables */
1021 /** Dynamicly allocated strings, MUST be freed before this **/
1022 /** struct is killed. **/
1023 struct dynamically_allocated_data {
1026 char *accept_encoding;
1032 char *rtsp_transport;
1033 char *te; /* TE: request header */
1037 int sec_complete; /* if Kerberos is enabled for this connection */
1038 enum protection_level command_prot;
1039 enum protection_level data_prot;
1040 enum protection_level request_data_prot;
1042 struct krb5buffer in_buffer;
1044 const struct Curl_sec_client_mech *mech;
1045 struct sockaddr_in local_addr;
1048 #if defined(USE_KERBEROS5) /* Consider moving some of the above GSS-API */
1049 struct kerberos5data krb5; /* variables into the structure definition, */
1050 #endif /* however, some of them are ftp specific. */
1052 /* the two following *_inuse fields are only flags, not counters in any way.
1053 If TRUE it means the channel is in use, and if FALSE it means the channel
1054 is up for grabs by one. */
1056 bool readchannel_inuse; /* whether the read channel is in use by an easy
1058 bool writechannel_inuse; /* whether the write channel is in use by an easy
1060 struct curl_llist *send_pipe; /* List of handles waiting to
1061 send on this pipeline */
1062 struct curl_llist *recv_pipe; /* List of handles waiting to read
1063 their responses on this pipeline */
1064 char *master_buffer; /* The master buffer allocated on-demand;
1065 used for pipelining. */
1066 size_t read_pos; /* Current read position in the master buffer */
1067 size_t buf_len; /* Length of the buffer?? */
1070 curl_seek_callback seek_func; /* function that seeks the input */
1071 void *seek_client; /* pointer to pass to the seek() above */
1073 /*************** Request - specific items ************/
1075 #if defined(USE_NTLM)
1076 struct ntlmdata ntlm; /* NTLM differs from other authentication schemes
1077 because it authenticates connections, not
1079 struct ntlmdata proxyntlm; /* NTLM data for proxy */
1081 #if defined(NTLM_WB_ENABLED)
1082 /* used for communication with Samba's winbind daemon helper ntlm_auth */
1083 curl_socket_t ntlm_auth_hlpr_socket;
1084 pid_t ntlm_auth_hlpr_pid;
1085 char *challenge_header;
1086 char *response_header;
1090 char syserr_buf [256]; /* buffer for Curl_strerror() */
1092 #ifdef CURLRES_ASYNCH
1093 /* data used for the asynch name resolve callback */
1094 struct Curl_async async;
1097 /* These three are used for chunked-encoding trailer support */
1098 char *trailer; /* allocated buffer to store trailer in */
1099 int trlMax; /* allocated buffer size */
1100 int trlPos; /* index of where to store data */
1103 struct ftp_conn ftpc;
1104 struct http_conn httpc;
1105 struct ssh_conn sshc;
1106 struct tftp_state_data *tftpc;
1107 struct imap_conn imapc;
1108 struct pop3_conn pop3c;
1109 struct smtp_conn smtpc;
1110 struct rtsp_conn rtspc;
1111 struct smb_conn smbc;
1112 void *generic; /* RTMP and LDAP use this */
1115 int cselect_bits; /* bitmask of socket events */
1116 int waitfor; /* current READ/WRITE bits to wait for */
1118 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1119 int socks5_gssapi_enctype;
1122 /* When this connection is created, store the conditions for the local end
1123 bind. This is stored before the actual bind and before any connection is
1124 made and will serve the purpose of being used for comparison reasons so
1125 that subsequent bound-requested connections aren't accidentally re-using
1126 wrong connections. */
1128 unsigned short localport;
1131 /* tunnel as in tunnel through a HTTP proxy with CONNECT */
1133 TUNNEL_INIT, /* init/default/no tunnel state */
1134 TUNNEL_CONNECT, /* CONNECT has been sent off */
1135 TUNNEL_COMPLETE /* CONNECT response received completely */
1136 } tunnel_state[2]; /* two separate ones to allow FTP */
1137 struct connectbundle *bundle; /* The bundle we are member of */
1139 int negnpn; /* APLN or NPN TLS negotiated protocol, CURL_HTTP_VERSION* */
1141 #ifdef USE_UNIX_SOCKETS
1142 char *unix_domain_socket;
1143 bool abstract_unix_socket;
1147 /* The end of connectdata. */
1150 * Struct to keep statistical and informational data.
1151 * All variables in this struct must be initialized/reset in Curl_initinfo().
1154 int httpcode; /* Recent HTTP, FTP, RTSP or SMTP response code */
1155 int httpproxycode; /* response code from proxy when received separate */
1156 int httpversion; /* the http version number X.Y = X*10+Y */
1157 long filetime; /* If requested, this is might get set. Set to -1 if the time
1158 was unretrievable. We cannot have this of type time_t,
1159 since time_t is unsigned on several platforms such as
1161 bool timecond; /* set to TRUE if the time condition didn't match, which
1162 thus made the document NOT get fetched */
1163 long header_size; /* size of read header(s) in bytes */
1164 long request_size; /* the amount of bytes sent in the request(s) */
1165 unsigned long proxyauthavail; /* what proxy auth types were announced */
1166 unsigned long httpauthavail; /* what host auth types were announced */
1167 long numconnects; /* how many new connection did libcurl created */
1168 char *contenttype; /* the content type of the object */
1169 char *wouldredirect; /* URL this would've been redirected to if asked to */
1171 /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip'
1172 and, 'conn_local_port' are copied over from the connectdata struct in
1173 order to allow curl_easy_getinfo() to return this information even when
1174 the session handle is no longer associated with a connection, and also
1175 allow curl_easy_reset() to clear this information from the session handle
1176 without disturbing information which is still alive, and that might be
1177 reused, in the connection cache. */
1179 char conn_primary_ip[MAX_IPADR_LEN];
1180 long conn_primary_port;
1182 char conn_local_ip[MAX_IPADR_LEN];
1183 long conn_local_port;
1185 const char *conn_scheme;
1186 unsigned int conn_protocol;
1188 struct curl_certinfo certs; /* info about the certs, only populated in
1189 OpenSSL builds. Asked for with
1190 CURLOPT_CERTINFO / CURLINFO_CERTINFO */
1195 time_t lastshow; /* time() of the last displayed progress meter or NULL to
1196 force redraw at next call */
1197 curl_off_t size_dl; /* total expected size */
1198 curl_off_t size_ul; /* total expected size */
1199 curl_off_t downloaded; /* transferred so far */
1200 curl_off_t uploaded; /* transferred so far */
1202 curl_off_t current_speed; /* uses the currently fastest transfer */
1204 bool callback; /* set when progress callback is used */
1205 int width; /* screen width at download start */
1206 int flags; /* see progress.h */
1215 double t_appconnect;
1216 double t_pretransfer;
1217 double t_starttransfer;
1220 struct timeval start;
1221 struct timeval t_startsingle;
1222 struct timeval t_startop;
1223 struct timeval t_acceptdata;
1225 /* upload speed limit */
1226 struct timeval ul_limit_start;
1227 curl_off_t ul_limit_size;
1228 /* download speed limit */
1229 struct timeval dl_limit_start;
1230 curl_off_t dl_limit_size;
1232 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
1234 curl_off_t speeder[ CURR_TIME ];
1235 struct timeval speeder_time[ CURR_TIME ];
1240 HTTPREQ_NONE, /* first in list */
1243 HTTPREQ_POST_FORM, /* we make a difference internally */
1247 HTTPREQ_LAST /* last in list */
1251 RTSPREQ_NONE, /* first in list */
1259 RTSPREQ_GET_PARAMETER,
1260 RTSPREQ_SET_PARAMETER,
1263 RTSPREQ_LAST /* last in list */
1267 * Values that are generated, temporary or calculated internally for a
1268 * "session handle" must be defined within the 'struct UrlState'. This struct
1269 * will be used within the Curl_easy struct. When the 'Curl_easy'
1270 * struct is cloned, this data MUST NOT be copied.
1272 * Remember that any "state" information goes globally for the curl handle.
1273 * Session-data MUST be put in the connectdata struct and here. */
1274 #define MAX_CURL_USER_LENGTH 256
1275 #define MAX_CURL_PASSWORD_LENGTH 256
1278 unsigned long want; /* Bitmask set to the authentication methods wanted by
1279 app (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */
1280 unsigned long picked;
1281 unsigned long avail; /* Bitmask for what the server reports to support for
1283 bool done; /* TRUE when the auth phase is done and ready to do the *actual*
1285 bool multi; /* TRUE if this is not yet authenticated but within the auth
1286 multipass negotiation */
1287 bool iestyle; /* TRUE if digest should be done IE-style or FALSE if it should
1291 struct Curl_http2_dep {
1292 struct Curl_http2_dep *next;
1293 struct Curl_easy *data;
1298 /* Points to the connection cache */
1299 struct conncache *conn_cache;
1301 /* when curl_easy_perform() is called, the multi handle is "owned" by
1302 the easy handle so curl_easy_cleanup() on such an easy handle will
1303 also close the multi handle! */
1304 bool multi_owned_by_easy;
1306 /* buffers to store authentication data in, as parsed from input options */
1307 struct timeval keeps_speed; /* for the progress meter really */
1309 struct connectdata *lastconnect; /* The last connection, NULL if undefined */
1311 char *headerbuff; /* allocated buffer to store headers in */
1312 size_t headersize; /* size of the allocation */
1314 char *buffer; /* download buffer */
1315 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
1316 curl_off_t current_speed; /* the ProgressShow() funcion sets this,
1318 bool this_is_a_follow; /* this is a followed Location: request */
1320 char *first_host; /* host name of the first (not followed) request.
1321 if set, this should be the host name that we will
1322 sent authorization to, no else. Used to make Location:
1323 following not keep sending user+password... This is
1326 int first_remote_port; /* remote port of the first (not followed) request */
1327 struct curl_ssl_session *session; /* array of 'max_ssl_sessions' size */
1328 long sessionage; /* number of the most recent session */
1329 char *tempwrite; /* allocated buffer to keep data in when a write
1330 callback returns to make the connection paused */
1331 size_t tempwritesize; /* size of the 'tempwrite' allocated buffer */
1332 int tempwritetype; /* type of the 'tempwrite' buffer as a bitmask that is
1333 used with Curl_client_write() */
1334 char *scratch; /* huge buffer[BUFSIZE*2] when doing upload CRLF replacing */
1335 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
1336 This must be set to FALSE every time _easy_perform() is
1338 int os_errno; /* filled in with errno whenever an error occurs */
1340 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
1341 void (*prev_signal)(int sig);
1343 bool allow_port; /* Is set.use_port allowed to take effect or not. This
1344 is always set TRUE when curl_easy_perform() is called. */
1345 struct digestdata digest; /* state data for host Digest auth */
1346 struct digestdata proxydigest; /* state data for proxy Digest auth */
1349 struct negotiatedata negotiate; /* state data for host Negotiate auth */
1350 struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */
1353 struct auth authhost; /* auth details for host */
1354 struct auth authproxy; /* auth details for proxy */
1356 bool authproblem; /* TRUE if there's some problem authenticating */
1358 void *resolver; /* resolver state, if it is used in the URL state -
1359 ares_channel f.e. */
1361 #if defined(USE_OPENSSL) && defined(HAVE_OPENSSL_ENGINE_H)
1363 #endif /* USE_OPENSSL */
1364 struct timeval expiretime; /* set this with Curl_expire() only */
1365 struct Curl_tree timenode; /* for the splay stuff */
1366 struct curl_llist *timeoutlist; /* list of pending timeouts */
1368 /* a place to store the most recently set FTP entrypath */
1369 char *most_recent_ftp_entrypath;
1371 /* set after initial USER failure, to prevent an authentication loop */
1372 bool ftp_trying_alternative;
1374 int httpversion; /* the lowest HTTP version*10 reported by any server
1375 involved in this request */
1376 bool expect100header; /* TRUE if we added Expect: 100-continue */
1378 bool pipe_broke; /* TRUE if the connection we were pipelined on broke
1379 and we need to restart from the beginning */
1381 #if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) && \
1382 !defined(__SYMBIAN32__)
1383 /* do FTP line-end conversions on most platforms */
1384 #define CURL_DO_LINEEND_CONV
1385 /* for FTP downloads: track CRLF sequences that span blocks */
1386 bool prev_block_had_trailing_cr;
1387 /* for FTP downloads: how many CRLFs did we converted to LFs? */
1388 curl_off_t crlf_conversions;
1390 char *pathbuffer;/* allocated buffer to store the URL's path part in */
1391 char *path; /* path to use, points to somewhere within the pathbuffer
1393 bool slash_removed; /* set TRUE if the 'path' points to a path where the
1394 initial URL slash separator has been taken off */
1396 bool rangestringalloc; /* the range string is malloc()'ed */
1398 char *range; /* range, if used. See README for detailed specification on
1400 curl_off_t resume_from; /* continue [ftp] transfer from here */
1402 /* This RTSP state information survives requests and connections */
1403 long rtsp_next_client_CSeq; /* the session's next client CSeq */
1404 long rtsp_next_server_CSeq; /* the session's next server CSeq */
1405 long rtsp_CSeq_recv; /* most recent CSeq received */
1407 curl_off_t infilesize; /* size of file to upload, -1 means unknown.
1408 Copied from set.filesize at start of operation */
1410 size_t drain; /* Increased when this stream has data to read, even if its
1411 socket is not necessarily is readable. Decreased when
1413 bool done; /* set to FALSE when Curl_init_do() is called and set to TRUE
1414 when multi_done() is called, to prevent multi_done() to get
1415 invoked twice when the multi interface is used. */
1417 curl_read_callback fread_func; /* read callback/function */
1418 void *in; /* CURLOPT_READDATA */
1420 struct Curl_easy *stream_depends_on;
1421 bool stream_depends_e; /* set or don't set the Exclusive bit */
1427 * This 'DynamicStatic' struct defines dynamic states that actually change
1428 * values in the 'UserDefined' area, which MUST be taken into consideration
1429 * if the UserDefined struct is cloned or similar. You can probably just
1430 * copy these, but each one indicate a special action on other data.
1433 struct DynamicStatic {
1434 char *url; /* work URL, copied from UserDefined */
1435 bool url_alloc; /* URL string is malloc()'ed */
1436 char *referer; /* referer string */
1437 bool referer_alloc; /* referer sting is malloc()ed */
1438 struct curl_slist *cookielist; /* list of cookie files set by
1439 curl_easy_setopt(COOKIEFILE) calls */
1440 struct curl_slist *resolve; /* set to point to the set.resolve list when
1441 this should be dealt with in pretransfer */
1445 * This 'UserDefined' struct must only contain data that is set once to go
1446 * for many (perhaps) independent connections. Values that are generated or
1447 * calculated internally for the "session handle" MUST be defined within the
1448 * 'struct UrlState' instead. The only exceptions MUST note the changes in
1449 * the 'DynamicStatic' struct.
1450 * Character pointer fields point to dynamic storage, unless otherwise stated.
1453 struct Curl_multi; /* declared and used only in multi.c */
1456 STRING_CERT_ORIG, /* client certificate file name */
1457 STRING_CERT_PROXY, /* client certificate file name */
1458 STRING_CERT_TYPE_ORIG, /* format for certificate (default: PEM)*/
1459 STRING_CERT_TYPE_PROXY, /* format for certificate (default: PEM)*/
1460 STRING_COOKIE, /* HTTP cookie string to send */
1461 STRING_COOKIEJAR, /* dump all cookies to this file */
1462 STRING_CUSTOMREQUEST, /* HTTP/FTP/RTSP request/method to use */
1463 STRING_DEFAULT_PROTOCOL, /* Protocol to use when the URL doesn't specify */
1464 STRING_DEVICE, /* local network interface/address to use */
1465 STRING_ENCODING, /* Accept-Encoding string */
1466 STRING_FTP_ACCOUNT, /* ftp account data */
1467 STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */
1468 STRING_FTPPORT, /* port to send with the FTP PORT command */
1469 STRING_KEY_ORIG, /* private key file name */
1470 STRING_KEY_PROXY, /* private key file name */
1471 STRING_KEY_PASSWD_ORIG, /* plain text private key password */
1472 STRING_KEY_PASSWD_PROXY, /* plain text private key password */
1473 STRING_KEY_TYPE_ORIG, /* format for private key (default: PEM) */
1474 STRING_KEY_TYPE_PROXY, /* format for private key (default: PEM) */
1475 STRING_KRB_LEVEL, /* krb security level */
1476 STRING_NETRC_FILE, /* if not NULL, use this instead of trying to find
1478 STRING_PROXY, /* proxy to use */
1479 STRING_PRE_PROXY, /* pre socks proxy to use */
1480 STRING_SET_RANGE, /* range, if used */
1481 STRING_SET_REFERER, /* custom string for the HTTP referer field */
1482 STRING_SET_URL, /* what original URL to work on */
1483 STRING_SSL_CAPATH_ORIG, /* CA directory name (doesn't work on windows) */
1484 STRING_SSL_CAPATH_PROXY, /* CA directory name (doesn't work on windows) */
1485 STRING_SSL_CAFILE_ORIG, /* certificate file to verify peer against */
1486 STRING_SSL_CAFILE_PROXY, /* certificate file to verify peer against */
1487 STRING_SSL_PINNEDPUBLICKEY_ORIG, /* public key file to verify peer against */
1488 STRING_SSL_PINNEDPUBLICKEY_PROXY, /* public key file to verify proxy */
1489 STRING_SSL_CIPHER_LIST_ORIG, /* list of ciphers to use */
1490 STRING_SSL_CIPHER_LIST_PROXY, /* list of ciphers to use */
1491 STRING_SSL_EGDSOCKET, /* path to file containing the EGD daemon socket */
1492 STRING_SSL_RANDOM_FILE, /* path to file containing "random" data */
1493 STRING_USERAGENT, /* User-Agent string */
1494 STRING_SSL_CRLFILE_ORIG, /* crl file to check certificate */
1495 STRING_SSL_CRLFILE_PROXY, /* crl file to check certificate */
1496 STRING_SSL_ISSUERCERT_ORIG, /* issuer cert file to check certificate */
1497 STRING_SSL_ISSUERCERT_PROXY, /* issuer cert file to check certificate */
1498 STRING_USERNAME, /* <username>, if used */
1499 STRING_PASSWORD, /* <password>, if used */
1500 STRING_OPTIONS, /* <options>, if used */
1501 STRING_PROXYUSERNAME, /* Proxy <username>, if used */
1502 STRING_PROXYPASSWORD, /* Proxy <password>, if used */
1503 STRING_NOPROXY, /* List of hosts which should not use the proxy, if
1505 STRING_RTSP_SESSION_ID, /* Session ID to use */
1506 STRING_RTSP_STREAM_URI, /* Stream URI for this request */
1507 STRING_RTSP_TRANSPORT, /* Transport for this session */
1509 STRING_SSH_PRIVATE_KEY, /* path to the private key file for auth */
1510 STRING_SSH_PUBLIC_KEY, /* path to the public key file for auth */
1511 STRING_SSH_HOST_PUBLIC_KEY_MD5, /* md5 of host public key in ascii hex */
1512 STRING_SSH_KNOWNHOSTS, /* file name of knownhosts file */
1514 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1515 STRING_PROXY_SERVICE_NAME, /* Proxy service name */
1517 #if !defined(CURL_DISABLE_CRYPTO_AUTH) || defined(USE_KERBEROS5) || \
1519 STRING_SERVICE_NAME, /* Service name */
1525 STRING_TLSAUTH_USERNAME_ORIG, /* TLS auth <username> */
1526 STRING_TLSAUTH_USERNAME_PROXY, /* TLS auth <username> */
1527 STRING_TLSAUTH_PASSWORD_ORIG, /* TLS auth <password> */
1528 STRING_TLSAUTH_PASSWORD_PROXY, /* TLS auth <password> */
1530 STRING_BEARER, /* <bearer>, if used */
1531 #ifdef USE_UNIX_SOCKETS
1532 STRING_UNIX_SOCKET_PATH, /* path to Unix socket, if used */
1535 /* -- end of zero-terminated strings -- */
1537 STRING_LASTZEROTERMINATED,
1539 /* -- below this are pointers to binary data that cannot be strdup'ed.
1540 Each such pointer must be added manually to Curl_dupset() --- */
1542 STRING_COPYPOSTFIELDS, /* if POST, set the fields' values here */
1544 STRING_LAST /* not used, just an end-of-list marker */
1547 struct UserDefined {
1548 FILE *err; /* the stderr user data goes here */
1549 void *debugdata; /* the data that will be passed to fdebug */
1550 char *errorbuffer; /* (Static) store failure messages in here */
1551 long proxyport; /* If non-zero, use this port number by default. If the
1552 proxy string features a ":[port]" that one will override
1554 void *out; /* CURLOPT_WRITEDATA */
1555 void *in_set; /* CURLOPT_READDATA */
1556 void *writeheader; /* write the header to this if non-NULL */
1557 void *rtp_out; /* write RTP to this if non-NULL */
1558 long use_port; /* which port to use (when not using default) */
1559 unsigned long httpauth; /* kind of HTTP authentication to use (bitmask) */
1560 unsigned long proxyauth; /* kind of proxy authentication to use (bitmask) */
1561 long followlocation; /* as in HTTP Location: */
1562 long maxredirs; /* maximum no. of http(s) redirects to follow, set to -1
1565 int keep_post; /* keep POSTs as POSTs after a 30x request; each
1566 bit represents a request, from 301 to 303 */
1567 bool free_referer; /* set TRUE if 'referer' points to a string we
1569 void *postfields; /* if POST, set the fields' values here */
1570 curl_seek_callback seek_func; /* function that seeks the input */
1571 curl_off_t postfieldsize; /* if POST, this might have a size to use instead
1572 of strlen(), and then the data *may* be binary
1573 (contain zero bytes) */
1574 unsigned short localport; /* local port number to bind to */
1575 int localportrange; /* number of additional port numbers to test in case the
1576 'localport' one can't be bind()ed */
1577 curl_write_callback fwrite_func; /* function that stores the output */
1578 curl_write_callback fwrite_header; /* function that stores headers */
1579 curl_write_callback fwrite_rtp; /* function that stores interleaved RTP */
1580 curl_read_callback fread_func_set; /* function that reads the input */
1581 int is_fread_set; /* boolean, has read callback been set to non-NULL? */
1582 int is_fwrite_set; /* boolean, has write callback been set to non-NULL? */
1583 curl_progress_callback fprogress; /* OLD and deprecated progress callback */
1584 curl_xferinfo_callback fxferinfo; /* progress callback */
1585 curl_debug_callback fdebug; /* function that write informational data */
1586 curl_ioctl_callback ioctl_func; /* function for I/O control */
1587 curl_sockopt_callback fsockopt; /* function for setting socket options */
1588 void *sockopt_client; /* pointer to pass to the socket options callback */
1589 curl_opensocket_callback fopensocket; /* function for checking/translating
1590 the address and opening the
1592 void *opensocket_client;
1593 curl_closesocket_callback fclosesocket; /* function for closing the
1595 void *closesocket_client;
1597 void *seek_client; /* pointer to pass to the seek callback */
1598 /* the 3 curl_conv_callback functions below are used on non-ASCII hosts */
1599 /* function to convert from the network encoding: */
1600 curl_conv_callback convfromnetwork;
1601 /* function to convert to the network encoding: */
1602 curl_conv_callback convtonetwork;
1603 /* function to convert from UTF-8 encoding: */
1604 curl_conv_callback convfromutf8;
1606 void *progress_client; /* pointer to pass to the progress callback */
1607 void *ioctl_client; /* pointer to pass to the ioctl callback */
1608 long timeout; /* in milliseconds, 0 means no timeout */
1609 long connecttimeout; /* in milliseconds, 0 means no timeout */
1610 long accepttimeout; /* in milliseconds, 0 means no timeout */
1611 long server_response_timeout; /* in milliseconds, 0 means no timeout */
1612 long tftp_blksize; /* in bytes, 0 means use default */
1613 bool tftp_no_options; /* do not send TFTP options requests */
1614 curl_off_t filesize; /* size of file to upload, -1 means unknown */
1615 long low_speed_limit; /* bytes/second */
1616 long low_speed_time; /* number of seconds */
1617 curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */
1618 curl_off_t max_recv_speed; /* high speed limit in bytes/second for
1620 curl_off_t set_resume_from; /* continue [ftp] transfer from here */
1621 struct curl_slist *headers; /* linked list of extra headers */
1622 struct curl_slist *proxyheaders; /* linked list of extra CONNECT headers */
1623 struct curl_httppost *httppost; /* linked list of POST data */
1624 bool sep_headers; /* handle host and proxy headers separately */
1625 bool cookiesession; /* new cookie session? */
1626 bool crlf; /* convert crlf on ftp upload(?) */
1627 struct curl_slist *quote; /* after connection is established */
1628 struct curl_slist *postquote; /* after the transfer */
1629 struct curl_slist *prequote; /* before the transfer, after type */
1630 struct curl_slist *source_quote; /* 3rd party quote */
1631 struct curl_slist *source_prequote; /* in 3rd party transfer mode - before
1632 the transfer on source host */
1633 struct curl_slist *source_postquote; /* in 3rd party transfer mode - after
1634 the transfer on source host */
1635 struct curl_slist *telnet_options; /* linked list of telnet options */
1636 struct curl_slist *resolve; /* list of names to add/remove from
1638 struct curl_slist *connect_to; /* list of host:port mappings to override
1639 the hostname and port to connect to */
1640 curl_TimeCond timecondition; /* kind of time/date comparison */
1641 time_t timevalue; /* what time to compare with */
1642 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
1643 long httpversion; /* when non-zero, a specific HTTP version requested to
1644 be used in the library's request(s) */
1645 struct ssl_config_data ssl; /* user defined SSL stuff */
1646 struct ssl_config_data proxy_ssl; /* user defined SSL stuff for proxy */
1647 struct ssl_general_config general_ssl; /* general user defined SSL stuff */
1648 curl_proxytype proxytype; /* what kind of proxy that is in use */
1649 long dns_cache_timeout; /* DNS cache timeout */
1650 long buffer_size; /* size of receive buffer to use */
1651 void *private_data; /* application-private data */
1653 struct curl_slist *http200aliases; /* linked list of aliases for http200 */
1655 long ipver; /* the CURL_IPRESOLVE_* defines in the public header file
1656 0 - whatever, 1 - v2, 2 - v6 */
1658 curl_off_t max_filesize; /* Maximum file size to download */
1660 curl_ftpfile ftp_filemethod; /* how to get to a file when FTP is used */
1662 int ftp_create_missing_dirs; /* 1 - create directories that don't exist
1663 2 - the same but also allow MKD to fail once
1666 curl_sshkeycallback ssh_keyfunc; /* key matching callback */
1667 void *ssh_keyfunc_userp; /* custom pointer to callback */
1669 /* Here follows boolean settings that define how to behave during
1670 this session. They are STATIC, set by libcurl users or at least initially
1671 and they don't change during operations. */
1673 bool printhost; /* printing host name in debug info */
1674 bool get_filetime; /* get the time and get of the remote file */
1675 bool tunnel_thru_httpproxy; /* use CONNECT through a HTTP proxy */
1676 bool prefer_ascii; /* ASCII rather than binary */
1677 bool ftp_append; /* append, not overwrite, on upload */
1678 bool ftp_list_only; /* switch FTP command for listing directories */
1679 bool ftp_use_port; /* use the FTP PORT command */
1680 bool hide_progress; /* don't use the progress meter */
1681 bool http_fail_on_error; /* fail on HTTP error codes >= 400 */
1682 bool http_keep_sending_on_error; /* for HTTP status codes >= 300 */
1683 bool http_follow_location; /* follow HTTP redirects */
1684 bool http_transfer_encoding; /* request compressed HTTP transfer-encoding */
1685 bool http_disable_hostname_check_before_authentication;
1686 bool include_header; /* include received protocol headers in data output */
1687 bool http_set_referer; /* is a custom referer used */
1688 bool http_auto_referer; /* set "correct" referer when following location: */
1689 bool opt_no_body; /* as set with CURLOPT_NOBODY */
1690 bool upload; /* upload request */
1691 enum CURL_NETRC_OPTION
1692 use_netrc; /* defined in include/curl.h */
1693 bool verbose; /* output verbosity */
1694 bool krb; /* Kerberos connection requested */
1695 bool reuse_forbid; /* forbidden to be reused, close after use */
1696 bool reuse_fresh; /* do not re-use an existing connection */
1697 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
1698 bool ftp_use_eprt; /* if EPRT is to be attempted or not */
1699 bool ftp_use_pret; /* if PRET is to be used before PASV or not */
1701 curl_usessl use_ssl; /* if AUTH TLS is to be attempted etc, for FTP or
1702 IMAP or POP3 or others! */
1703 curl_ftpauth ftpsslauth; /* what AUTH XXX to be attempted */
1704 curl_ftpccc ftp_ccc; /* FTP CCC options */
1705 bool no_signal; /* do not use any signal/alarm handler */
1706 bool global_dns_cache; /* subject for future removal */
1707 bool tcp_nodelay; /* whether to enable TCP_NODELAY or not */
1708 bool ignorecl; /* ignore content length */
1709 bool ftp_skip_ip; /* skip the IP address the FTP server passes on to
1711 bool connect_only; /* make connection, let application use the socket */
1712 long ssh_auth_types; /* allowed SSH auth types */
1713 bool http_te_skip; /* pass the raw body data to the user, even when
1714 transfer-encoded (chunked, compressed) */
1715 bool http_ce_skip; /* pass the raw body data to the user, even when
1716 content-encoded (chunked, compressed) */
1717 long new_file_perms; /* Permissions to use when creating remote files */
1718 long new_directory_perms; /* Permissions to use when creating remote dirs */
1719 bool proxy_transfer_mode; /* set transfer mode (;type=<a|i>) when doing FTP
1720 via an HTTP proxy */
1721 char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */
1722 unsigned int scope_id; /* Scope id for IPv6 */
1723 long allowed_protocols;
1724 long redir_protocols;
1725 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1726 bool socks5_gssapi_nec; /* Flag to support NEC SOCKS5 server */
1728 struct curl_slist *mail_rcpt; /* linked list of mail recipients */
1729 bool sasl_ir; /* Enable/disable SASL initial response */
1730 /* Common RTSP header options */
1731 Curl_RtspReq rtspreq; /* RTSP request type */
1732 long rtspversion; /* like httpversion, for RTSP */
1733 bool wildcardmatch; /* enable wildcard matching */
1734 curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer
1736 curl_chunk_end_callback chunk_end; /* called after part transferring
1738 curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds
1739 to pattern (e.g. if WILDCARDMATCH is on) */
1742 long gssapi_delegation; /* GSS-API credential delegation, see the
1743 documentation of CURLOPT_GSSAPI_DELEGATION */
1745 bool tcp_keepalive; /* use TCP keepalives */
1746 long tcp_keepidle; /* seconds in idle before sending keepalive probe */
1747 long tcp_keepintvl; /* seconds between TCP keepalive probes */
1748 bool tcp_fastopen; /* use TCP Fast Open */
1750 size_t maxconnects; /* Max idle connections in the connection cache */
1752 bool ssl_enable_npn; /* TLS NPN extension? */
1753 bool ssl_enable_alpn; /* TLS ALPN extension? */
1754 bool path_as_is; /* allow dotdots? */
1755 bool pipewait; /* wait for pipe/multiplex status before starting a
1757 long expect_100_timeout; /* in milliseconds */
1759 struct Curl_easy *stream_depends_on;
1760 bool stream_depends_e; /* set or don't set the Exclusive bit */
1763 struct Curl_http2_dep *stream_dependents;
1765 bool abstract_unix_socket;
1769 struct curl_hash *hostcache;
1771 HCACHE_NONE, /* not pointing to anything */
1772 HCACHE_GLOBAL, /* points to the (shrug) global one */
1773 HCACHE_MULTI, /* points to a shared one in the multi handle */
1774 HCACHE_SHARED /* points to a shared one in a shared object */
1779 * The 'connectdata' struct MUST have all the connection oriented stuff as we
1780 * may have several simultaneous connections and connection structs in memory.
1782 * The 'struct UserDefined' must only contain data that is set once to go for
1783 * many (perhaps) independent connections. Values that are generated or
1784 * calculated internally for the "session handle" must be defined within the
1785 * 'struct UrlState' instead.
1789 /* first, two fields for the linked list of these */
1790 struct Curl_easy *next;
1791 struct Curl_easy *prev;
1793 struct connectdata *easy_conn; /* the "unit's" connection */
1795 CURLMstate mstate; /* the handle's state */
1796 CURLcode result; /* previous result */
1798 struct Curl_message msg; /* A single posted message. */
1800 /* Array with the plain socket numbers this handle takes care of, in no
1801 particular order. Note that all sockets are added to the sockhash, where
1802 the state etc are also kept. This array is mostly used to detect when a
1803 socket is to be removed from the hash. See singlesocket(). */
1804 curl_socket_t sockets[MAX_SOCKSPEREASYHANDLE];
1808 struct Curl_multi *multi; /* if non-NULL, points to the multi handle
1809 struct to which this "belongs" when used by
1810 the multi interface */
1811 struct Curl_multi *multi_easy; /* if non-NULL, points to the multi handle
1812 struct to which this "belongs" when used
1813 by the easy interface */
1814 struct Curl_share *share; /* Share, handles global variable mutexing */
1815 struct SingleRequest req; /* Request-specific data */
1816 struct UserDefined set; /* values set by the libcurl user */
1817 struct DynamicStatic change; /* possibly modified userdefined data */
1818 struct CookieInfo *cookies; /* the cookies, read from files and servers.
1819 NOTE that the 'cookie' field in the
1820 UserDefined struct defines if the "engine"
1821 is to be used or not. */
1822 struct Progress progress; /* for all the progress meter data */
1823 struct UrlState state; /* struct for fields used for state info and
1824 other dynamic purposes */
1825 struct WildcardData wildcard; /* wildcard download state info */
1826 struct PureInfo info; /* stats, reports and info data */
1827 struct curl_tlssessioninfo tsi; /* Information about the TLS session, only
1828 valid after a client has asked for it */
1829 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
1830 iconv_t outbound_cd; /* for translating to the network encoding */
1831 iconv_t inbound_cd; /* for translating from the network encoding */
1832 iconv_t utf8_cd; /* for translating to UTF8 */
1833 #endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */
1834 unsigned int magic; /* set to a CURLEASY_MAGIC_NUMBER */
1837 #define LIBCURL_NAME "libcurl"
1839 #endif /* HEADER_CURL_URLDATA_H */