1 #ifndef HEADER_CURL_URLDATA_H
2 #define HEADER_CURL_URLDATA_H
3 /***************************************************************************
5 * Project ___| | | | _ \| |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 1998 - 2014, 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 http://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
44 #define PORT_SMTPS 465 /* sometimes called SSMTP */
46 #define PORT_RTMP 1935
47 #define PORT_RTMPT PORT_HTTP
48 #define PORT_RTMPS PORT_HTTPS
49 #define PORT_GOPHER 70
51 #define DICT_MATCH "/MATCH:"
52 #define DICT_MATCH2 "/M:"
53 #define DICT_MATCH3 "/FIND:"
54 #define DICT_DEFINE "/DEFINE:"
55 #define DICT_DEFINE2 "/D:"
56 #define DICT_DEFINE3 "/LOOKUP:"
58 #define CURL_DEFAULT_USER "anonymous"
59 #define CURL_DEFAULT_PASSWORD "ftp@example.com"
61 /* Convenience defines for checking protocols or their SSL based version. Each
62 protocol handler should only ever have a single CURLPROTO_ in its protocol
64 #define PROTO_FAMILY_HTTP (CURLPROTO_HTTP|CURLPROTO_HTTPS)
65 #define PROTO_FAMILY_FTP (CURLPROTO_FTP|CURLPROTO_FTPS)
66 #define PROTO_FAMILY_POP3 (CURLPROTO_POP3|CURLPROTO_POP3S)
67 #define PROTO_FAMILY_SMTP (CURLPROTO_SMTP|CURLPROTO_SMTPS)
69 #define DEFAULT_CONNCACHE_SIZE 5
71 /* length of longest IPv6 address string including the trailing null */
72 #define MAX_IPADR_LEN sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255")
74 /* Default FTP/IMAP etc response timeout in milliseconds.
75 Symbian OS panics when given a timeout much greater than 1/2 hour.
77 #define RESP_TIMEOUT (1800*1000)
84 #include <openssl/rsa.h>
85 #include <openssl/crypto.h>
86 #include <openssl/x509.h>
87 #include <openssl/pem.h>
88 #include <openssl/ssl.h>
89 #include <openssl/err.h>
90 #ifdef HAVE_OPENSSL_ENGINE_H
91 #include <openssl/engine.h>
93 #ifdef HAVE_OPENSSL_PKCS12_H
94 #include <openssl/pkcs12.h>
96 #else /* SSLeay-style includes */
103 #ifdef HAVE_OPENSSL_ENGINE_H
106 #ifdef HAVE_OPENSSL_PKCS12_H
109 #endif /* USE_OPENSSL */
111 #error Configuration error; cannot use GnuTLS *and* OpenSSL.
113 #endif /* USE_SSLEAY */
116 #include <gnutls/gnutls.h>
120 #include <polarssl/ssl.h>
121 #include <polarssl/version.h>
122 #if POLARSSL_VERSION_NUMBER<0x01010000
123 #include <polarssl/havege.h>
125 #include <polarssl/entropy.h>
126 #include <polarssl/ctr_drbg.h>
127 #endif /* POLARSSL_VERSION_NUMBER<0x01010000 */
128 #endif /* USE_POLARSSL */
131 #undef OCSP_REQUEST /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */
132 #undef OCSP_RESPONSE /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */
133 #include <cyassl/openssl/ssl.h>
150 #include <axTLS/ssl.h>
154 #endif /* USE_AXTLS */
157 #include "curl_sspi.h"
159 #include <schannel.h>
163 #include <Security/Security.h>
164 /* For some reason, when building for iOS, the omnibus header above does
165 * not include SecureTransport.h as of iOS SDK 5.1. */
166 #include <Security/SecureTransport.h>
169 #ifdef HAVE_NETINET_IN_H
170 #include <netinet/in.h>
176 #include <zlib.h> /* for content-encoding */
178 /* zlib pollutes the namespace with this definition */
183 #include <curl/curl.h>
185 #include "http_chunks.h" /* for the structs and enum stuff */
198 #include "wildcard.h"
199 #include "multihandle.h"
204 # elif defined HAVE_GSSMIT
205 # include <gssapi/gssapi.h>
206 # include <gssapi/gssapi_generic.h>
212 #ifdef HAVE_LIBSSH2_H
214 #include <libssh2_sftp.h>
215 #endif /* HAVE_LIBSSH2_H */
217 /* Download buffer size, keep it fairly big for speed reasons */
219 #define BUFSIZE CURL_MAX_WRITE_SIZE
221 /* Initial size of the buffer to store headers in, it'll be enlarged in case
223 #define HEADERSIZE 256
225 #define CURLEASY_MAGIC_NUMBER 0xc0dedbadU
227 /* Some convenience macros to get the larger/smaller value out of two given.
228 We prefix with CURL to prevent name collisions. */
229 #define CURLMAX(x,y) ((x)>(y)?(x):(y))
230 #define CURLMIN(x,y) ((x)<(y)?(x):(y))
234 /* Types needed for krb5-ftp connections */
242 enum protection_level {
243 PROT_NONE, /* first in list */
249 PROT_LAST /* last in list */
254 /* Structs to store Schannel handles */
255 struct curl_schannel_cred {
256 CredHandle cred_handle;
257 TimeStamp time_stamp;
262 struct curl_schannel_ctxt {
263 CtxtHandle ctxt_handle;
264 TimeStamp time_stamp;
268 /* enum for the nonblocking SSL connection state machine */
272 ssl_connect_2_reading,
273 ssl_connect_2_writing,
280 ssl_connection_negotiating,
281 ssl_connection_complete
282 } ssl_connection_state;
284 /* struct for data related to each SSL connection */
285 struct ssl_connect_data {
286 /* Use ssl encrypted communications TRUE/FALSE, not necessarily using it atm
287 but at least asked to or meaning to use it. See 'state' for the exact
288 current state of the connection. */
290 ssl_connection_state state;
292 /* these ones requires specific SSL-types */
296 ssl_connect_state connecting_state;
297 #endif /* USE_SSLEAY */
299 gnutls_session_t session;
300 gnutls_certificate_credentials_t cred;
302 gnutls_srp_client_credentials_t srp_client_cred;
304 ssl_connect_state connecting_state;
305 #endif /* USE_GNUTLS */
307 ctr_drbg_context ctr_drbg;
308 entropy_context entropy;
316 ssl_connect_state connecting_state;
317 #endif /* USE_POLARSSL */
321 ssl_connect_state connecting_state;
322 #endif /* USE_CYASSL */
325 char *client_nickname;
326 struct SessionHandle *data;
327 struct curl_llist *obj_list;
328 PK11GenericObject *obj_clicert;
329 ssl_connect_state connecting_state;
333 #endif /* USE_QSOSSL */
337 ssl_connect_state connecting_state;
342 ssl_connect_state connecting_state;
343 #endif /* USE_AXTLS */
345 struct curl_schannel_cred *cred;
346 struct curl_schannel_ctxt *ctxt;
347 SecPkgContext_StreamSizes stream_sizes;
348 ssl_connect_state connecting_state;
349 size_t encdata_length, decdata_length;
350 size_t encdata_offset, decdata_offset;
351 unsigned char *encdata_buffer, *decdata_buffer;
352 unsigned long req_flags, ret_flags;
353 #endif /* USE_SCHANNEL */
355 SSLContextRef ssl_ctx;
356 curl_socket_t ssl_sockfd;
357 ssl_connect_state connecting_state;
358 bool ssl_direction; /* true if writing, false if reading */
359 size_t ssl_write_buffered_length;
360 #endif /* USE_DARWINSSL */
363 struct ssl_config_data {
364 long version; /* what version the client wants to use */
365 long certverifyresult; /* result from the certificate verification */
367 bool verifypeer; /* set TRUE if this is desired */
368 bool verifyhost; /* set TRUE if CN/SAN must match hostname */
369 char *CApath; /* certificate dir (doesn't work on windows) */
370 char *CAfile; /* certificate to verify peer against */
371 const char *CRLfile; /* CRL to check certificate revocation */
372 const char *issuercert;/* optional issuer certificate filename */
373 char *random_file; /* path to file containing "random" data */
374 char *egdsocket; /* path to file containing the EGD daemon socket */
375 char *cipher_list; /* list of ciphers to use */
376 size_t max_ssl_sessions; /* SSL session id cache size */
377 curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */
378 void *fsslctxp; /* parameter for call back */
379 bool sessionid; /* cache session IDs or not */
380 bool certinfo; /* gather lots of certificate info */
383 char *username; /* TLS username (for, e.g., SRP) */
384 char *password; /* TLS password (for, e.g., SRP) */
385 enum CURL_TLSAUTH authtype; /* TLS authentication type (default SRP) */
389 /* information stored about one single SSL session */
390 struct curl_ssl_session {
391 char *name; /* host name for which this ID was used */
392 void *sessionid; /* as returned from the SSL layer */
393 size_t idsize; /* if known, otherwise 0 */
394 long age; /* just a number, the higher the more recent */
395 int remote_port; /* remote port to connect to */
396 struct ssl_config_data ssl_config; /* setup for this session */
399 /* Struct used for Digest challenge-response authentication */
405 bool stale; /* set true for re-negotiation */
409 int nc; /* nounce count */
420 #ifdef USE_WINDOWS_SSPI
421 #include "curl_sspi.h"
424 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
428 /* Struct used for NTLM challenge-response authentication */
431 #ifdef USE_WINDOWS_SSPI
434 SEC_WINNT_AUTH_IDENTITY identity;
435 SEC_WINNT_AUTH_IDENTITY *p_identity;
438 unsigned long n_type_2;
441 unsigned char nonce[8];
442 void* target_info; /* TargetInfo received in the ntlm type-2 message */
443 unsigned int target_info_len;
447 #ifdef USE_HTTP_NEGOTIATE
448 struct negotiatedata {
449 /* when doing Negotiate we first need to receive an auth token and then we
450 need to send our header */
451 enum { GSS_AUTHNONE, GSS_AUTHRECV, GSS_AUTHSENT } state;
452 bool gss; /* Whether we're processing GSS-Negotiate or Negotiate */
453 const char* protocol; /* "GSS-Negotiate" or "Negotiate" */
456 gss_ctx_id_t context;
457 gss_name_t server_name;
458 gss_buffer_desc output_token;
460 #ifdef USE_WINDOWS_SSPI
463 CredHandle *credentials;
464 char server_name[1024];
465 size_t max_token_length;
467 size_t output_token_length;
475 * Boolean values that concerns this connection.
478 /* always modify bits.close with the connclose() and connkeep() macros! */
479 bool close; /* if set, we close the connection after this request */
480 bool reuse; /* if set, this is a re-used connection */
481 bool proxy; /* if set, this transfer is done through a proxy - any type */
482 bool httpproxy; /* if set, this transfer is done through a http proxy */
483 bool user_passwd; /* do we use user+password for this connection? */
484 bool proxy_user_passwd; /* user+password for the proxy? */
485 bool ipv6_ip; /* we communicate with a remote site specified with pure IPv6
487 bool ipv6; /* we communicate with a site using an IPv6 address */
489 bool do_more; /* this is set TRUE if the ->curl_do_more() function is
490 supposed to be called, after ->curl_do() */
491 bool tcpconnect[2]; /* the TCP layer (or similar) is connected, this is set
492 the first time on the first connect function call */
493 bool protoconnstart;/* the protocol layer has STARTED its operation after
494 the TCP layer connect */
496 bool retry; /* this connection is about to get closed and then
497 re-attempted at another connection. */
498 bool tunnel_proxy; /* if CONNECT is used to "tunnel" through the proxy.
499 This is implicit when SSL-protocols are used through
500 proxies, but can also be enabled explicitly by
502 bool authneg; /* TRUE when the auth phase has started, which means
503 that we are creating a request with an auth header,
504 but it is not the final request in the auth
506 bool rewindaftersend;/* TRUE when the sending couldn't be stopped even
507 though it will be discarded. When the whole send
508 operation is done, we must call the data rewind
510 bool ftp_use_epsv; /* As set with CURLOPT_FTP_USE_EPSV, but if we find out
511 EPSV doesn't work we disable it for the forthcoming
514 bool ftp_use_eprt; /* As set with CURLOPT_FTP_USE_EPRT, but if we find out
515 EPRT doesn't work we disable it for the forthcoming
517 bool netrc; /* name+password provided by netrc */
518 bool userpwd_in_url; /* name+password found in url */
520 bool done; /* set to FALSE when Curl_do() is called and set to TRUE
521 when Curl_done() is called, to prevent Curl_done() to
522 get invoked twice when the multi interface is
524 bool stream_was_rewound; /* Indicates that the stream was rewound after a
525 request read past the end of its response byte
527 bool proxy_connect_closed; /* set true if a proxy disconnected the
528 connection in a CONNECT request with auth, so
529 that libcurl should reconnect and continue. */
530 bool bound; /* set true if bind() has already been done on this socket/
532 bool type_set; /* type= was used in the URL */
536 char *rawalloc; /* allocated "raw" version of the name */
537 char *encalloc; /* allocated IDN-encoded version of the name */
538 char *name; /* name to use internally, might be encoded, might be raw */
539 const char *dispname; /* name to display, as 'name' might be encoded */
543 * Flags on the keepon member of the Curl_transfer_keeper
547 #define KEEP_RECV (1<<0) /* there is or may be data to read */
548 #define KEEP_SEND (1<<1) /* there is or may be data to write */
549 #define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there
550 might still be data to read */
551 #define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there
552 might still be data to write */
553 #define KEEP_RECV_PAUSE (1<<4) /* reading is paused */
554 #define KEEP_SEND_PAUSE (1<<5) /* writing is paused */
556 #define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE)
557 #define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE)
562 ZLIB_UNINIT, /* uninitialized */
563 ZLIB_INIT, /* initialized */
564 ZLIB_GZIP_HEADER, /* reading gzip header */
565 ZLIB_GZIP_INFLATING, /* inflating gzip stream */
566 ZLIB_INIT_GZIP /* initialized in transparent gzip mode */
570 #ifdef CURLRES_ASYNCH
574 struct Curl_dns_entry *dns;
575 bool done; /* set TRUE when the lookup is complete */
576 int status; /* if done is TRUE, this is the status from the callback */
577 void *os_specific; /* 'struct thread_data' for Windows */
581 #define FIRSTSOCKET 0
582 #define SECONDARYSOCKET 1
584 /* These function pointer types are here only to allow easier typecasting
585 within the source when we need to cast between data pointers (such as NULL)
586 and function pointers. */
587 typedef CURLcode (*Curl_do_more_func)(struct connectdata *, int *);
588 typedef CURLcode (*Curl_done_func)(struct connectdata *, CURLcode, bool);
591 EXP100_SEND_DATA, /* enough waiting, just send the body now */
592 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */
593 EXP100_SENDING_REQUEST, /* still sending the request but will wait for
594 the 100 header once done with the request */
595 EXP100_FAILED /* used on 417 Expectation Failed */
599 UPGR101_INIT, /* default state */
600 UPGR101_REQUESTED, /* upgrade requested */
601 UPGR101_RECEIVED, /* response received */
602 UPGR101_WORKING /* talking upgraded protocol */
606 NPN_INIT, /* default state */
607 NPN_HTTP1_1, /* HTTP/1.1 negotiated */
608 NPN_HTTP2 /* HTTP2 (draft-xx) negotiated */
612 * Request specific data in the easy handle (SessionHandle). Previously,
613 * these members were on the connectdata struct but since a conn struct may
614 * now be shared between different SessionHandles, we store connection-specific
615 * data here. This struct only keeps stuff that's interesting for *this*
616 * request, as it will be cleared between multiple ones
618 struct SingleRequest {
619 curl_off_t size; /* -1 if unknown at this point */
620 curl_off_t *bytecountp; /* return number of bytes read or NULL */
622 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch,
623 -1 means unlimited */
624 curl_off_t *writebytecountp; /* return number of bytes written or NULL */
626 curl_off_t bytecount; /* total number of bytes read */
627 curl_off_t writebytecount; /* number of bytes written */
629 long headerbytecount; /* only count received headers */
630 long deductheadercount; /* this amount of bytes doesn't count when we check
631 if anything has been transferred at the end of a
632 connection. We use this counter to make only a
633 100 reply (without a following second response
634 code) result in a CURLE_GOT_NOTHING error code */
636 struct timeval start; /* transfer started at this time */
637 struct timeval now; /* current time */
638 bool header; /* incoming data has HTTP header */
640 HEADER_NORMAL, /* no bad header at all */
641 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest
643 HEADER_ALLBAD /* all was believed to be header */
644 } badheader; /* the header was deemed bad and will be
646 int headerline; /* counts header lines to better track the
648 char *hbufp; /* points at *end* of header line */
650 char *str; /* within buf */
651 char *str_start; /* within buf */
652 char *end_ptr; /* within buf */
653 char *p; /* within headerbuff */
654 bool content_range; /* set TRUE if Content-Range: was found */
655 curl_off_t offset; /* possible resume offset read from the
656 Content-Range: header */
657 int httpcode; /* error code from the 'HTTP/1.? XXX' or
658 'RTSP/1.? XXX' line */
659 struct timeval start100; /* time stamp to wait for the 100 code from */
660 enum expect100 exp100; /* expect 100 continue state */
661 enum upgrade101 upgr101; /* 101 upgrade state */
663 int auto_decoding; /* What content encoding. sec 3.5, RFC2616. */
665 #define IDENTITY 0 /* No encoding */
666 #define DEFLATE 1 /* zlib deflate [RFC 1950 & 1951] */
667 #define GZIP 2 /* gzip algorithm [RFC 1952] */
668 #define COMPRESS 3 /* Not handled, added for completeness */
671 zlibInitState zlib_init; /* possible zlib init state;
672 undefined if Content-Encoding header. */
673 z_stream z; /* State structure for zlib. */
685 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
686 and we're uploading the last chunk */
688 bool ignorebody; /* we read a response-body but we ignore it! */
689 bool ignorecl; /* This HTTP response has no body so we ignore the Content-
692 char *location; /* This points to an allocated version of the Location:
694 char *newurl; /* Set to the new URL to use when a redirect or a retry is
697 /* 'upload_present' is used to keep a byte counter of how much data there is
698 still left in the buffer, aimed for upload. */
699 ssize_t upload_present;
701 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
702 buffer, so the next read should read from where this pointer points to,
703 and the 'upload_present' contains the number of bytes available at this
705 char *upload_fromhere;
707 bool chunk; /* if set, this is a chunked transfer-encoding */
708 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
710 bool getheader; /* TRUE if header parsing is wanted */
712 bool forbidchunk; /* used only to explicitly forbid chunk-upload for
713 specific upload buffers. See readmoredata() in
714 http.c for details. */
716 void *protop; /* Allocated protocol-specific data. Each protocol
717 handler makes sure this points to data it needs. */
721 * Specific protocol handler.
724 struct Curl_handler {
725 const char * scheme; /* URL scheme name. */
727 /* Complement to setup_connection_internals(). */
728 CURLcode (*setup_connection)(struct connectdata *);
730 /* These two functions MUST be set to be protocol dependent */
731 CURLcode (*do_it)(struct connectdata *, bool *done);
734 /* If the curl_do() function is better made in two halves, this
735 * curl_do_more() function will be called afterwards, if set. For example
736 * for doing the FTP stuff after the PASV/PORT command.
738 Curl_do_more_func do_more;
740 /* This function *MAY* be set to a protocol-dependent function that is run
741 * after the connect() and everything is done, as a step in the connection.
742 * The 'done' pointer points to a bool that should be set to TRUE if the
743 * function completes before return. If it doesn't complete, the caller
744 * should call the curl_connecting() function until it is.
746 CURLcode (*connect_it)(struct connectdata *, bool *done);
748 /* See above. Currently only used for FTP. */
749 CURLcode (*connecting)(struct connectdata *, bool *done);
750 CURLcode (*doing)(struct connectdata *, bool *done);
752 /* Called from the multi interface during the PROTOCONNECT phase, and it
753 should then return a proper fd set */
754 int (*proto_getsock)(struct connectdata *conn,
755 curl_socket_t *socks,
758 /* Called from the multi interface during the DOING phase, and it should
759 then return a proper fd set */
760 int (*doing_getsock)(struct connectdata *conn,
761 curl_socket_t *socks,
764 /* Called from the multi interface during the DO_MORE phase, and it should
765 then return a proper fd set */
766 int (*domore_getsock)(struct connectdata *conn,
767 curl_socket_t *socks,
770 /* Called from the multi interface during the DO_DONE, PERFORM and
771 WAITPERFORM phases, and it should then return a proper fd set. Not setting
772 this will make libcurl use the generic default one. */
773 int (*perform_getsock)(const struct connectdata *conn,
774 curl_socket_t *socks,
777 /* This function *MAY* be set to a protocol-dependent function that is run
778 * by the curl_disconnect(), as a step in the disconnection. If the handler
779 * is called because the connection has been considered dead, dead_connection
782 CURLcode (*disconnect)(struct connectdata *, bool dead_connection);
784 /* If used, this function gets called from transfer.c:readwrite_data() to
785 allow the protocol to do extra reads/writes */
786 CURLcode (*readwrite)(struct SessionHandle *data, struct connectdata *conn,
787 ssize_t *nread, bool *readmore);
789 long defport; /* Default port. */
790 unsigned int protocol; /* See CURLPROTO_* - this needs to be the single
791 specific protocol bit */
792 unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */
795 #define PROTOPT_NONE 0 /* nothing extra */
796 #define PROTOPT_SSL (1<<0) /* uses SSL */
797 #define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */
798 #define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */
799 /* some protocols will have to call the underlying functions without regard to
800 what exact state the socket signals. IE even if the socket says "readable",
801 the send function might need to be called while uploading, or vice versa.
803 #define PROTOPT_DIRLOCK (1<<3)
804 #define PROTOPT_NONETWORK (1<<4) /* protocol doesn't use the network! */
805 #define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it
807 #define PROTOPT_NOURLQUERY (1<<6) /* protocol can't handle
808 url query strings (?foo=bar) ! */
809 #define PROTOPT_CREDSPERREQUEST (1<<7) /* requires login credentials per
810 request instead of per connection */
813 /* return the count of bytes sent, or -1 on error */
814 typedef ssize_t (Curl_send)(struct connectdata *conn, /* connection data */
815 int sockindex, /* socketindex */
816 const void *buf, /* data to write */
817 size_t len, /* max amount to write */
818 CURLcode *err); /* error to return */
820 /* return the count of bytes read, or -1 on error */
821 typedef ssize_t (Curl_recv)(struct connectdata *conn, /* connection data */
822 int sockindex, /* socketindex */
823 char *buf, /* store data here */
824 size_t len, /* max amount to read */
825 CURLcode *err); /* error to return */
828 * The connectdata struct contains all fields and variables that should be
829 * unique for an entire connection.
832 /* 'data' is the CURRENT SessionHandle using this connection -- take great
833 caution that this might very well vary between different times this
834 connection is used! */
835 struct SessionHandle *data;
837 /* chunk is for HTTP chunked encoding, but is in the general connectdata
838 struct only because we can do just about any protocol through a HTTP proxy
839 and a HTTP proxy may in fact respond using chunked encoding */
840 struct Curl_chunker chunk;
842 curl_closesocket_callback fclosesocket; /* function closing the socket(s) */
843 void *closesocket_client;
845 bool inuse; /* This is a marker for the connection cache logic. If this is
846 TRUE this handle is being used by an easy handle and cannot
847 be used by any other easy handle without careful
848 consideration (== only for pipelining). */
850 /**** Fields set when inited and not modified again */
851 long connection_id; /* Contains a unique number to make it easier to
852 track the connections in the log output */
854 /* 'dns_entry' is the particular host we use. This points to an entry in the
855 DNS cache and it will not get pruned while locked. It gets unlocked in
856 Curl_done(). This entry will be NULL if the connection is re-used as then
857 there is no name resolve done. */
858 struct Curl_dns_entry *dns_entry;
860 /* 'ip_addr' is the particular IP we connected to. It points to a struct
861 within the DNS cache, so this pointer is only valid as long as the DNS
862 cache entry remains locked. It gets unlocked in Curl_done() */
863 Curl_addrinfo *ip_addr;
864 Curl_addrinfo *tempaddr[2]; /* for happy eyeballs */
866 /* 'ip_addr_str' is the ip_addr data as a human readable string.
867 It remains available as long as the connection does, which is longer than
868 the ip_addr itself. */
869 char ip_addr_str[MAX_IPADR_LEN];
871 unsigned int scope; /* address scope for IPv6 */
873 int socktype; /* SOCK_STREAM or SOCK_DGRAM */
875 struct hostname host;
876 struct hostname proxy;
878 long port; /* which port to use locally */
879 int remote_port; /* what remote port to connect to, not the proxy port! */
881 /* 'primary_ip' and 'primary_port' get filled with peer's numerical
882 ip address and port number whenever an outgoing connection is
883 *attempted* from the primary socket to a remote address. When more
884 than one address is tried for a connection these will hold data
885 for the last attempt. When the connection is actually established
886 these are updated with data which comes directly from the socket. */
888 char primary_ip[MAX_IPADR_LEN];
891 /* 'local_ip' and 'local_port' get filled with local's numerical
892 ip address and port number whenever an outgoing connection is
893 **established** from the primary socket to a remote address. */
895 char local_ip[MAX_IPADR_LEN];
898 char *user; /* user name string, allocated */
899 char *passwd; /* password string, allocated */
900 char *options; /* options string, allocated */
902 char *xoauth2_bearer; /* bearer token for xoauth2, allocated */
904 char *proxyuser; /* proxy user name string, allocated */
905 char *proxypasswd; /* proxy password string, allocated */
906 curl_proxytype proxytype; /* what kind of proxy that is in use */
908 int httpversion; /* the HTTP version*10 reported by the server */
909 int rtspversion; /* the RTSP version*10 reported by the server */
911 struct timeval now; /* "current" time */
912 struct timeval created; /* creation time */
913 curl_socket_t sock[2]; /* two sockets, the second is used for the data
914 transfer when doing FTP */
915 curl_socket_t tempsock[2]; /* temporary sockets for happy eyeballs */
916 bool sock_accepted[2]; /* TRUE if the socket on this index was created with
921 struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */
922 struct ssl_config_data ssl_config;
924 struct ConnectBits bits; /* various state-flags for this connection */
926 /* connecttime: when connect() is called on the current IP address. Used to
927 be able to track when to move on to try next IP - but only when the multi
928 interface is used. */
929 struct timeval connecttime;
930 /* The two fields below get set in Curl_connecthost */
931 int num_addr; /* number of addresses to try to connect to */
932 long timeoutms_per_addr; /* how long time in milliseconds to spend on
933 trying to connect to each IP address */
935 const struct Curl_handler *handler; /* Connection's protocol handler */
936 const struct Curl_handler *given; /* The protocol first given */
938 long ip_version; /* copied from the SessionHandle at creation time */
940 /**** curl_get() phase fields */
942 curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */
943 curl_socket_t writesockfd; /* socket to write to, it may very
944 well be the same we read from.
945 CURL_SOCKET_BAD disables */
947 /** Dynamicly allocated strings, MUST be freed before this **/
948 /** struct is killed. **/
949 struct dynamically_allocated_data {
952 char *accept_encoding;
958 char *rtsp_transport;
959 char *te; /* TE: request header */
962 int sec_complete; /* if kerberos is enabled for this connection */
964 enum protection_level command_prot;
965 enum protection_level data_prot;
966 enum protection_level request_data_prot;
968 struct krb5buffer in_buffer;
970 const struct Curl_sec_client_mech *mech;
971 struct sockaddr_in local_addr;
974 /* the two following *_inuse fields are only flags, not counters in any way.
975 If TRUE it means the channel is in use, and if FALSE it means the channel
976 is up for grabs by one. */
978 bool readchannel_inuse; /* whether the read channel is in use by an easy
980 bool writechannel_inuse; /* whether the write channel is in use by an easy
982 struct curl_llist *send_pipe; /* List of handles waiting to
983 send on this pipeline */
984 struct curl_llist *recv_pipe; /* List of handles waiting to read
985 their responses on this pipeline */
986 char* master_buffer; /* The master buffer allocated on-demand;
987 used for pipelining. */
988 size_t read_pos; /* Current read position in the master buffer */
989 size_t buf_len; /* Length of the buffer?? */
992 curl_seek_callback seek_func; /* function that seeks the input */
993 void *seek_client; /* pointer to pass to the seek() above */
995 /*************** Request - specific items ************/
997 /* previously this was in the urldata struct */
998 curl_read_callback fread_func; /* function that reads the input */
999 void *fread_in; /* pointer to pass to the fread() above */
1001 struct ntlmdata ntlm; /* NTLM differs from other authentication schemes
1002 because it authenticates connections, not
1004 struct ntlmdata proxyntlm; /* NTLM data for proxy */
1006 #if defined(USE_NTLM) && defined(NTLM_WB_ENABLED)
1007 /* used for communication with Samba's winbind daemon helper ntlm_auth */
1008 curl_socket_t ntlm_auth_hlpr_socket;
1009 pid_t ntlm_auth_hlpr_pid;
1010 char* challenge_header;
1011 char* response_header;
1014 char syserr_buf [256]; /* buffer for Curl_strerror() */
1016 #ifdef CURLRES_ASYNCH
1017 /* data used for the asynch name resolve callback */
1018 struct Curl_async async;
1021 /* These three are used for chunked-encoding trailer support */
1022 char *trailer; /* allocated buffer to store trailer in */
1023 int trlMax; /* allocated buffer size */
1024 int trlPos; /* index of where to store data */
1027 struct ftp_conn ftpc;
1028 struct http_conn httpc;
1029 struct ssh_conn sshc;
1030 struct tftp_state_data *tftpc;
1031 struct imap_conn imapc;
1032 struct pop3_conn pop3c;
1033 struct smtp_conn smtpc;
1034 struct rtsp_conn rtspc;
1035 void *generic; /* RTMP and LDAP use this */
1038 int cselect_bits; /* bitmask of socket events */
1039 int waitfor; /* current READ/WRITE bits to wait for */
1041 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1042 int socks5_gssapi_enctype;
1048 /* When this connection is created, store the conditions for the local end
1049 bind. This is stored before the actual bind and before any connection is
1050 made and will serve the purpose of being used for comparison reasons so
1051 that subsequent bound-requested connections aren't accidentally re-using
1052 wrong connections. */
1054 unsigned short localport;
1057 /* tunnel as in tunnel through a HTTP proxy with CONNECT */
1059 TUNNEL_INIT, /* init/default/no tunnel state */
1060 TUNNEL_CONNECT, /* CONNECT has been sent off */
1061 TUNNEL_COMPLETE /* CONNECT response received completely */
1062 } tunnel_state[2]; /* two separate ones to allow FTP */
1063 struct connectbundle *bundle; /* The bundle we are member of */
1065 enum negotiatenpn negnpn;
1068 /* The end of connectdata. */
1071 * Struct to keep statistical and informational data.
1074 int httpcode; /* Recent HTTP, FTP, or RTSP response code */
1075 int httpproxycode; /* response code from proxy when received separate */
1076 int httpversion; /* the http version number X.Y = X*10+Y */
1077 long filetime; /* If requested, this is might get set. Set to -1 if the time
1078 was unretrievable. We cannot have this of type time_t,
1079 since time_t is unsigned on several platforms such as
1081 bool timecond; /* set to TRUE if the time condition didn't match, which
1082 thus made the document NOT get fetched */
1083 long header_size; /* size of read header(s) in bytes */
1084 long request_size; /* the amount of bytes sent in the request(s) */
1085 unsigned long proxyauthavail; /* what proxy auth types were announced */
1086 unsigned long httpauthavail; /* what host auth types were announced */
1087 long numconnects; /* how many new connection did libcurl created */
1088 char *contenttype; /* the content type of the object */
1089 char *wouldredirect; /* URL this would've been redirected to if asked to */
1091 /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip'
1092 and, 'conn_local_port' are copied over from the connectdata struct in
1093 order to allow curl_easy_getinfo() to return this information even when
1094 the session handle is no longer associated with a connection, and also
1095 allow curl_easy_reset() to clear this information from the session handle
1096 without disturbing information which is still alive, and that might be
1097 reused, in the connection cache. */
1099 char conn_primary_ip[MAX_IPADR_LEN];
1100 long conn_primary_port;
1102 char conn_local_ip[MAX_IPADR_LEN];
1103 long conn_local_port;
1105 struct curl_certinfo certs; /* info about the certs, only populated in
1106 OpenSSL builds. Asked for with
1107 CURLOPT_CERTINFO / CURLINFO_CERTINFO */
1112 long lastshow; /* time() of the last displayed progress meter or NULL to
1113 force redraw at next call */
1114 curl_off_t size_dl; /* total expected size */
1115 curl_off_t size_ul; /* total expected size */
1116 curl_off_t downloaded; /* transferred so far */
1117 curl_off_t uploaded; /* transferred so far */
1119 curl_off_t current_speed; /* uses the currently fastest transfer */
1121 bool callback; /* set when progress callback is used */
1122 int width; /* screen width at download start */
1123 int flags; /* see progress.h */
1132 double t_appconnect;
1133 double t_pretransfer;
1134 double t_starttransfer;
1137 struct timeval start;
1138 struct timeval t_startsingle;
1139 struct timeval t_startop;
1140 struct timeval t_acceptdata;
1141 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
1143 curl_off_t speeder[ CURR_TIME ];
1144 struct timeval speeder_time[ CURR_TIME ];
1149 HTTPREQ_NONE, /* first in list */
1152 HTTPREQ_POST_FORM, /* we make a difference internally */
1156 HTTPREQ_LAST /* last in list */
1160 RTSPREQ_NONE, /* first in list */
1168 RTSPREQ_GET_PARAMETER,
1169 RTSPREQ_SET_PARAMETER,
1172 RTSPREQ_LAST /* last in list */
1176 * Values that are generated, temporary or calculated internally for a
1177 * "session handle" must be defined within the 'struct UrlState'. This struct
1178 * will be used within the SessionHandle struct. When the 'SessionHandle'
1179 * struct is cloned, this data MUST NOT be copied.
1181 * Remember that any "state" information goes globally for the curl handle.
1182 * Session-data MUST be put in the connectdata struct and here. */
1183 #define MAX_CURL_USER_LENGTH 256
1184 #define MAX_CURL_PASSWORD_LENGTH 256
1187 unsigned long want; /* Bitmask set to the authentication methods wanted by
1188 app (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */
1189 unsigned long picked;
1190 unsigned long avail; /* Bitmask for what the server reports to support for
1192 bool done; /* TRUE when the auth phase is done and ready to do the *actual*
1194 bool multi; /* TRUE if this is not yet authenticated but within the auth
1195 multipass negotiation */
1196 bool iestyle; /* TRUE if digest should be done IE-style or FALSE if it should
1202 /* Points to the connection cache */
1203 struct conncache *conn_cache;
1205 /* when curl_easy_perform() is called, the multi handle is "owned" by
1206 the easy handle so curl_easy_cleanup() on such an easy handle will
1207 also close the multi handle! */
1208 bool multi_owned_by_easy;
1210 /* buffers to store authentication data in, as parsed from input options */
1211 struct timeval keeps_speed; /* for the progress meter really */
1213 struct connectdata *lastconnect; /* The last connection, NULL if undefined */
1215 char *headerbuff; /* allocated buffer to store headers in */
1216 size_t headersize; /* size of the allocation */
1218 char buffer[BUFSIZE+1]; /* download buffer */
1219 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
1220 curl_off_t current_speed; /* the ProgressShow() funcion sets this,
1222 bool this_is_a_follow; /* this is a followed Location: request */
1224 char *first_host; /* if set, this should be the host name that we will
1225 sent authorization to, no else. Used to make Location:
1226 following not keep sending user+password... This is
1229 struct curl_ssl_session *session; /* array of 'max_ssl_sessions' size */
1230 long sessionage; /* number of the most recent session */
1231 char *tempwrite; /* allocated buffer to keep data in when a write
1232 callback returns to make the connection paused */
1233 size_t tempwritesize; /* size of the 'tempwrite' allocated buffer */
1234 int tempwritetype; /* type of the 'tempwrite' buffer as a bitmask that is
1235 used with Curl_client_write() */
1236 char *scratch; /* huge buffer[BUFSIZE*2] when doing upload CRLF replacing */
1237 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
1238 This must be set to FALSE every time _easy_perform() is
1240 int os_errno; /* filled in with errno whenever an error occurs */
1242 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
1243 void (*prev_signal)(int sig);
1245 bool allow_port; /* Is set.use_port allowed to take effect or not. This
1246 is always set TRUE when curl_easy_perform() is called. */
1247 struct digestdata digest; /* state data for host Digest auth */
1248 struct digestdata proxydigest; /* state data for proxy Digest auth */
1250 #ifdef USE_HTTP_NEGOTIATE
1251 struct negotiatedata negotiate; /* state data for host Negotiate auth */
1252 struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */
1255 struct auth authhost; /* auth details for host */
1256 struct auth authproxy; /* auth details for proxy */
1258 bool authproblem; /* TRUE if there's some problem authenticating */
1260 void *resolver; /* resolver state, if it is used in the URL state -
1261 ares_channel f.e. */
1263 #if defined(USE_SSLEAY) && defined(HAVE_OPENSSL_ENGINE_H)
1265 #endif /* USE_SSLEAY */
1266 struct timeval expiretime; /* set this with Curl_expire() only */
1267 struct Curl_tree timenode; /* for the splay stuff */
1268 struct curl_llist *timeoutlist; /* list of pending timeouts */
1270 /* a place to store the most recently set FTP entrypath */
1271 char *most_recent_ftp_entrypath;
1273 /* set after initial USER failure, to prevent an authentication loop */
1274 bool ftp_trying_alternative;
1276 int httpversion; /* the lowest HTTP version*10 reported by any server
1277 involved in this request */
1278 bool expect100header; /* TRUE if we added Expect: 100-continue */
1280 bool pipe_broke; /* TRUE if the connection we were pipelined on broke
1281 and we need to restart from the beginning */
1283 #if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) && \
1284 !defined(__SYMBIAN32__)
1285 /* do FTP line-end conversions on most platforms */
1286 #define CURL_DO_LINEEND_CONV
1287 /* for FTP downloads: track CRLF sequences that span blocks */
1288 bool prev_block_had_trailing_cr;
1289 /* for FTP downloads: how many CRLFs did we converted to LFs? */
1290 curl_off_t crlf_conversions;
1292 char *pathbuffer;/* allocated buffer to store the URL's path part in */
1293 char *path; /* path to use, points to somewhere within the pathbuffer
1295 bool slash_removed; /* set TRUE if the 'path' points to a path where the
1296 initial URL slash separator has been taken off */
1298 bool rangestringalloc; /* the range string is malloc()'ed */
1300 char *range; /* range, if used. See README for detailed specification on
1302 curl_off_t resume_from; /* continue [ftp] transfer from here */
1304 /* This RTSP state information survives requests and connections */
1305 long rtsp_next_client_CSeq; /* the session's next client CSeq */
1306 long rtsp_next_server_CSeq; /* the session's next server CSeq */
1307 long rtsp_CSeq_recv; /* most recent CSeq received */
1309 /* if true, force SSL connection retry (workaround for certain servers) */
1310 bool ssl_connect_retry;
1311 curl_off_t infilesize; /* size of file to upload, -1 means unknown.
1312 Copied from set.filesize at start of operation */
1317 * This 'DynamicStatic' struct defines dynamic states that actually change
1318 * values in the 'UserDefined' area, which MUST be taken into consideration
1319 * if the UserDefined struct is cloned or similar. You can probably just
1320 * copy these, but each one indicate a special action on other data.
1323 struct DynamicStatic {
1324 char *url; /* work URL, copied from UserDefined */
1325 bool url_alloc; /* URL string is malloc()'ed */
1326 char *referer; /* referer string */
1327 bool referer_alloc; /* referer sting is malloc()ed */
1328 struct curl_slist *cookielist; /* list of cookie files set by
1329 curl_easy_setopt(COOKIEFILE) calls */
1330 struct curl_slist *resolve; /* set to point to the set.resolve list when
1331 this should be dealt with in pretransfer */
1335 * This 'UserDefined' struct must only contain data that is set once to go
1336 * for many (perhaps) independent connections. Values that are generated or
1337 * calculated internally for the "session handle" MUST be defined within the
1338 * 'struct UrlState' instead. The only exceptions MUST note the changes in
1339 * the 'DynamicStatic' struct.
1340 * Character pointer fields point to dynamic storage, unless otherwise stated.
1343 struct Curl_multi; /* declared and used only in multi.c */
1346 STRING_CERT, /* client certificate file name */
1347 STRING_CERT_TYPE, /* format for certificate (default: PEM)*/
1348 STRING_COOKIE, /* HTTP cookie string to send */
1349 STRING_COOKIEJAR, /* dump all cookies to this file */
1350 STRING_CUSTOMREQUEST, /* HTTP/FTP/RTSP request/method to use */
1351 STRING_DEVICE, /* local network interface/address to use */
1352 STRING_ENCODING, /* Accept-Encoding string */
1353 STRING_FTP_ACCOUNT, /* ftp account data */
1354 STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */
1355 STRING_FTPPORT, /* port to send with the FTP PORT command */
1356 STRING_KEY, /* private key file name */
1357 STRING_KEY_PASSWD, /* plain text private key password */
1358 STRING_KEY_TYPE, /* format for private key (default: PEM) */
1359 STRING_KRB_LEVEL, /* krb security level */
1360 STRING_NETRC_FILE, /* if not NULL, use this instead of trying to find
1362 STRING_COPYPOSTFIELDS, /* if POST, set the fields' values here */
1363 STRING_PROXY, /* proxy to use */
1364 STRING_SET_RANGE, /* range, if used */
1365 STRING_SET_REFERER, /* custom string for the HTTP referer field */
1366 STRING_SET_URL, /* what original URL to work on */
1367 STRING_SSL_CAPATH, /* CA directory name (doesn't work on windows) */
1368 STRING_SSL_CAFILE, /* certificate file to verify peer against */
1369 STRING_SSL_CIPHER_LIST, /* list of ciphers to use */
1370 STRING_SSL_EGDSOCKET, /* path to file containing the EGD daemon socket */
1371 STRING_SSL_RANDOM_FILE, /* path to file containing "random" data */
1372 STRING_USERAGENT, /* User-Agent string */
1373 STRING_SSL_CRLFILE, /* crl file to check certificate */
1374 STRING_SSL_ISSUERCERT, /* issuer cert file to check certificate */
1375 STRING_USERNAME, /* <username>, if used */
1376 STRING_PASSWORD, /* <password>, if used */
1377 STRING_OPTIONS, /* <options>, if used */
1378 STRING_PROXYUSERNAME, /* Proxy <username>, if used */
1379 STRING_PROXYPASSWORD, /* Proxy <password>, if used */
1380 STRING_NOPROXY, /* List of hosts which should not use the proxy, if
1382 STRING_RTSP_SESSION_ID, /* Session ID to use */
1383 STRING_RTSP_STREAM_URI, /* Stream URI for this request */
1384 STRING_RTSP_TRANSPORT, /* Transport for this session */
1386 STRING_SSH_PRIVATE_KEY, /* path to the private key file for auth */
1387 STRING_SSH_PUBLIC_KEY, /* path to the public key file for auth */
1388 STRING_SSH_HOST_PUBLIC_KEY_MD5, /* md5 of host public key in ascii hex */
1389 STRING_SSH_KNOWNHOSTS, /* file name of knownhosts file */
1391 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1392 STRING_SOCKS5_GSSAPI_SERVICE, /* GSSAPI service name */
1398 STRING_TLSAUTH_USERNAME, /* TLS auth <username> */
1399 STRING_TLSAUTH_PASSWORD, /* TLS auth <password> */
1402 STRING_BEARER, /* <bearer>, if used */
1404 /* -- end of strings -- */
1405 STRING_LAST /* not used, just an end-of-list marker */
1408 struct UserDefined {
1409 FILE *err; /* the stderr user data goes here */
1410 void *debugdata; /* the data that will be passed to fdebug */
1411 char *errorbuffer; /* (Static) store failure messages in here */
1412 long proxyport; /* If non-zero, use this port number by default. If the
1413 proxy string features a ":[port]" that one will override
1415 void *out; /* the fetched file goes here */
1416 void *in; /* the uploaded file is read from here */
1417 void *writeheader; /* write the header to this if non-NULL */
1418 void *rtp_out; /* write RTP to this if non-NULL */
1419 long use_port; /* which port to use (when not using default) */
1420 unsigned long httpauth; /* kind of HTTP authentication to use (bitmask) */
1421 unsigned long proxyauth; /* kind of proxy authentication to use (bitmask) */
1422 long followlocation; /* as in HTTP Location: */
1423 long maxredirs; /* maximum no. of http(s) redirects to follow, set to -1
1426 int keep_post; /* keep POSTs as POSTs after a 30x request; each
1427 bit represents a request, from 301 to 303 */
1428 bool free_referer; /* set TRUE if 'referer' points to a string we
1430 void *postfields; /* if POST, set the fields' values here */
1431 curl_seek_callback seek_func; /* function that seeks the input */
1432 curl_off_t postfieldsize; /* if POST, this might have a size to use instead
1433 of strlen(), and then the data *may* be binary
1434 (contain zero bytes) */
1435 unsigned short localport; /* local port number to bind to */
1436 int localportrange; /* number of additional port numbers to test in case the
1437 'localport' one can't be bind()ed */
1438 curl_write_callback fwrite_func; /* function that stores the output */
1439 curl_write_callback fwrite_header; /* function that stores headers */
1440 curl_write_callback fwrite_rtp; /* function that stores interleaved RTP */
1441 curl_read_callback fread_func; /* function that reads the input */
1442 int is_fread_set; /* boolean, has read callback been set to non-NULL? */
1443 int is_fwrite_set; /* boolean, has write callback been set to non-NULL? */
1444 curl_progress_callback fprogress; /* OLD and deprecated progress callback */
1445 curl_xferinfo_callback fxferinfo; /* progress callback */
1446 curl_debug_callback fdebug; /* function that write informational data */
1447 curl_ioctl_callback ioctl_func; /* function for I/O control */
1448 curl_sockopt_callback fsockopt; /* function for setting socket options */
1449 void *sockopt_client; /* pointer to pass to the socket options callback */
1450 curl_opensocket_callback fopensocket; /* function for checking/translating
1451 the address and opening the
1453 void* opensocket_client;
1454 curl_closesocket_callback fclosesocket; /* function for closing the
1456 void* closesocket_client;
1458 void *seek_client; /* pointer to pass to the seek callback */
1459 /* the 3 curl_conv_callback functions below are used on non-ASCII hosts */
1460 /* function to convert from the network encoding: */
1461 curl_conv_callback convfromnetwork;
1462 /* function to convert to the network encoding: */
1463 curl_conv_callback convtonetwork;
1464 /* function to convert from UTF-8 encoding: */
1465 curl_conv_callback convfromutf8;
1467 void *progress_client; /* pointer to pass to the progress callback */
1468 void *ioctl_client; /* pointer to pass to the ioctl callback */
1469 long timeout; /* in milliseconds, 0 means no timeout */
1470 long connecttimeout; /* in milliseconds, 0 means no timeout */
1471 long accepttimeout; /* in milliseconds, 0 means no timeout */
1472 long server_response_timeout; /* in milliseconds, 0 means no timeout */
1473 long tftp_blksize ; /* in bytes, 0 means use default */
1474 curl_off_t filesize; /* size of file to upload, -1 means unknown */
1475 long low_speed_limit; /* bytes/second */
1476 long low_speed_time; /* number of seconds */
1477 curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */
1478 curl_off_t max_recv_speed; /* high speed limit in bytes/second for
1480 curl_off_t set_resume_from; /* continue [ftp] transfer from here */
1481 struct curl_slist *headers; /* linked list of extra headers */
1482 struct curl_slist *proxyheaders; /* linked list of extra CONNECT headers */
1483 struct curl_httppost *httppost; /* linked list of POST data */
1484 bool sep_headers; /* handle host and proxy headers separately */
1485 bool cookiesession; /* new cookie session? */
1486 bool crlf; /* convert crlf on ftp upload(?) */
1487 struct curl_slist *quote; /* after connection is established */
1488 struct curl_slist *postquote; /* after the transfer */
1489 struct curl_slist *prequote; /* before the transfer, after type */
1490 struct curl_slist *source_quote; /* 3rd party quote */
1491 struct curl_slist *source_prequote; /* in 3rd party transfer mode - before
1492 the transfer on source host */
1493 struct curl_slist *source_postquote; /* in 3rd party transfer mode - after
1494 the transfer on source host */
1495 struct curl_slist *telnet_options; /* linked list of telnet options */
1496 struct curl_slist *resolve; /* list of names to add/remove from
1498 curl_TimeCond timecondition; /* kind of time/date comparison */
1499 time_t timevalue; /* what time to compare with */
1500 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
1501 long httpversion; /* when non-zero, a specific HTTP version requested to
1502 be used in the library's request(s) */
1503 struct ssl_config_data ssl; /* user defined SSL stuff */
1504 curl_proxytype proxytype; /* what kind of proxy that is in use */
1505 long dns_cache_timeout; /* DNS cache timeout */
1506 long buffer_size; /* size of receive buffer to use */
1507 void *private_data; /* application-private data */
1509 struct curl_slist *http200aliases; /* linked list of aliases for http200 */
1511 long ipver; /* the CURL_IPRESOLVE_* defines in the public header file
1512 0 - whatever, 1 - v2, 2 - v6 */
1514 curl_off_t max_filesize; /* Maximum file size to download */
1516 curl_ftpfile ftp_filemethod; /* how to get to a file when FTP is used */
1518 int ftp_create_missing_dirs; /* 1 - create directories that don't exist
1519 2 - the same but also allow MKD to fail once
1522 curl_sshkeycallback ssh_keyfunc; /* key matching callback */
1523 void *ssh_keyfunc_userp; /* custom pointer to callback */
1525 /* Here follows boolean settings that define how to behave during
1526 this session. They are STATIC, set by libcurl users or at least initially
1527 and they don't change during operations. */
1529 bool printhost; /* printing host name in debug info */
1530 bool get_filetime; /* get the time and get of the remote file */
1531 bool tunnel_thru_httpproxy; /* use CONNECT through a HTTP proxy */
1532 bool prefer_ascii; /* ASCII rather than binary */
1533 bool ftp_append; /* append, not overwrite, on upload */
1534 bool ftp_list_only; /* switch FTP command for listing directories */
1535 bool ftp_use_port; /* use the FTP PORT command */
1536 bool hide_progress; /* don't use the progress meter */
1537 bool http_fail_on_error; /* fail on HTTP error codes >= 300 */
1538 bool http_follow_location; /* follow HTTP redirects */
1539 bool http_transfer_encoding; /* request compressed HTTP transfer-encoding */
1540 bool http_disable_hostname_check_before_authentication;
1541 bool include_header; /* include received protocol headers in data output */
1542 bool http_set_referer; /* is a custom referer used */
1543 bool http_auto_referer; /* set "correct" referer when following location: */
1544 bool opt_no_body; /* as set with CURLOPT_NOBODY */
1545 bool set_port; /* custom port number used */
1546 bool upload; /* upload request */
1547 enum CURL_NETRC_OPTION
1548 use_netrc; /* defined in include/curl.h */
1549 bool verbose; /* output verbosity */
1550 bool krb; /* kerberos connection requested */
1551 bool reuse_forbid; /* forbidden to be reused, close after use */
1552 bool reuse_fresh; /* do not re-use an existing connection */
1553 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
1554 bool ftp_use_eprt; /* if EPRT is to be attempted or not */
1555 bool ftp_use_pret; /* if PRET is to be used before PASV or not */
1557 curl_usessl use_ssl; /* if AUTH TLS is to be attempted etc, for FTP or
1558 IMAP or POP3 or others! */
1559 curl_ftpauth ftpsslauth; /* what AUTH XXX to be attempted */
1560 curl_ftpccc ftp_ccc; /* FTP CCC options */
1561 bool no_signal; /* do not use any signal/alarm handler */
1562 bool global_dns_cache; /* subject for future removal */
1563 bool tcp_nodelay; /* whether to enable TCP_NODELAY or not */
1564 bool ignorecl; /* ignore content length */
1565 bool ftp_skip_ip; /* skip the IP address the FTP server passes on to
1567 bool connect_only; /* make connection, let application use the socket */
1568 bool ssl_enable_beast; /* especially allow this flaw for interoperability's
1570 long ssh_auth_types; /* allowed SSH auth types */
1571 bool http_te_skip; /* pass the raw body data to the user, even when
1572 transfer-encoded (chunked, compressed) */
1573 bool http_ce_skip; /* pass the raw body data to the user, even when
1574 content-encoded (chunked, compressed) */
1575 long new_file_perms; /* Permissions to use when creating remote files */
1576 long new_directory_perms; /* Permissions to use when creating remote dirs */
1577 bool proxy_transfer_mode; /* set transfer mode (;type=<a|i>) when doing FTP
1578 via an HTTP proxy */
1579 char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */
1580 unsigned int scope; /* address scope for IPv6 */
1581 long allowed_protocols;
1582 long redir_protocols;
1583 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1584 long socks5_gssapi_nec; /* flag to support nec socks5 server */
1586 struct curl_slist *mail_rcpt; /* linked list of mail recipients */
1587 bool sasl_ir; /* Enable/disable SASL initial response */
1588 /* Common RTSP header options */
1589 Curl_RtspReq rtspreq; /* RTSP request type */
1590 long rtspversion; /* like httpversion, for RTSP */
1591 bool wildcardmatch; /* enable wildcard matching */
1592 curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer
1594 curl_chunk_end_callback chunk_end; /* called after part transferring
1596 curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds
1597 to pattern (e.g. if WILDCARDMATCH is on) */
1600 long gssapi_delegation; /* GSSAPI credential delegation, see the
1601 documentation of CURLOPT_GSSAPI_DELEGATION */
1603 bool tcp_keepalive; /* use TCP keepalives */
1604 long tcp_keepidle; /* seconds in idle before sending keepalive probe */
1605 long tcp_keepintvl; /* seconds between TCP keepalive probes */
1607 size_t maxconnects; /* Max idle connections in the connection cache */
1609 bool ssl_enable_npn; /* TLS NPN extension? */
1610 bool ssl_enable_alpn; /* TLS ALPN extension? */
1612 long expect_100_timeout; /* in milliseconds */
1616 struct curl_hash *hostcache;
1618 HCACHE_NONE, /* not pointing to anything */
1619 HCACHE_GLOBAL, /* points to the (shrug) global one */
1620 HCACHE_MULTI, /* points to a shared one in the multi handle */
1621 HCACHE_SHARED /* points to a shared one in a shared object */
1626 * The 'connectdata' struct MUST have all the connection oriented stuff as we
1627 * may have several simultaneous connections and connection structs in memory.
1629 * The 'struct UserDefined' must only contain data that is set once to go for
1630 * many (perhaps) independent connections. Values that are generated or
1631 * calculated internally for the "session handle" must be defined within the
1632 * 'struct UrlState' instead.
1635 struct SessionHandle {
1636 /* first, two fields for the linked list of these */
1637 struct SessionHandle *next;
1638 struct SessionHandle *prev;
1640 struct connectdata *easy_conn; /* the "unit's" connection */
1642 CURLMstate mstate; /* the handle's state */
1643 CURLcode result; /* previous result */
1645 struct Curl_message msg; /* A single posted message. */
1647 /* Array with the plain socket numbers this handle takes care of, in no
1648 particular order. Note that all sockets are added to the sockhash, where
1649 the state etc are also kept. This array is mostly used to detect when a
1650 socket is to be removed from the hash. See singlesocket(). */
1651 curl_socket_t sockets[MAX_SOCKSPEREASYHANDLE];
1655 struct Curl_multi *multi; /* if non-NULL, points to the multi handle
1656 struct to which this "belongs" when used by
1657 the multi interface */
1658 struct Curl_multi *multi_easy; /* if non-NULL, points to the multi handle
1659 struct to which this "belongs" when used
1660 by the easy interface */
1661 struct Curl_share *share; /* Share, handles global variable mutexing */
1662 struct SingleRequest req; /* Request-specific data */
1663 struct UserDefined set; /* values set by the libcurl user */
1664 struct DynamicStatic change; /* possibly modified userdefined data */
1665 struct CookieInfo *cookies; /* the cookies, read from files and servers.
1666 NOTE that the 'cookie' field in the
1667 UserDefined struct defines if the "engine"
1668 is to be used or not. */
1669 struct Progress progress; /* for all the progress meter data */
1670 struct UrlState state; /* struct for fields used for state info and
1671 other dynamic purposes */
1672 struct WildcardData wildcard; /* wildcard download state info */
1673 struct PureInfo info; /* stats, reports and info data */
1674 struct curl_tlssessioninfo tsi; /* Information about the TLS session, only
1675 valid after a client has asked for it */
1676 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
1677 iconv_t outbound_cd; /* for translating to the network encoding */
1678 iconv_t inbound_cd; /* for translating from the network encoding */
1679 iconv_t utf8_cd; /* for translating to UTF8 */
1680 #endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */
1681 unsigned int magic; /* set to a CURLEASY_MAGIC_NUMBER */
1684 #define LIBCURL_NAME "libcurl"
1686 #endif /* HEADER_CURL_URLDATA_H */
projects / platform / upstream / curl.git / blob