1 #ifndef HEADER_CURL_URLDATA_H
2 #define HEADER_CURL_URLDATA_H
3 /***************************************************************************
5 * Project ___| | | | _ \| |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 1998 - 2013, 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 #define DEFAULT_CONNCACHE_SIZE 5
63 /* length of longest IPv6 address string including the trailing null */
64 #define MAX_IPADR_LEN sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255")
66 /* Default FTP/IMAP etc response timeout in milliseconds.
67 Symbian OS panics when given a timeout much greater than 1/2 hour.
69 #define RESP_TIMEOUT (1800*1000)
76 #include <openssl/rsa.h>
77 #include <openssl/crypto.h>
78 #include <openssl/x509.h>
79 #include <openssl/pem.h>
80 #include <openssl/ssl.h>
81 #include <openssl/err.h>
82 #ifdef HAVE_OPENSSL_ENGINE_H
83 #include <openssl/engine.h>
85 #ifdef HAVE_OPENSSL_PKCS12_H
86 #include <openssl/pkcs12.h>
88 #else /* SSLeay-style includes */
95 #ifdef HAVE_OPENSSL_ENGINE_H
98 #ifdef HAVE_OPENSSL_PKCS12_H
101 #endif /* USE_OPENSSL */
103 #error Configuration error; cannot use GnuTLS *and* OpenSSL.
105 #endif /* USE_SSLEAY */
108 #include <gnutls/gnutls.h>
112 #include <polarssl/ssl.h>
113 #include <polarssl/version.h>
114 #if POLARSSL_VERSION_NUMBER<0x01010000
115 #include <polarssl/havege.h>
117 #include <polarssl/entropy.h>
118 #include <polarssl/ctr_drbg.h>
119 #endif /* POLARSSL_VERSION_NUMBER<0x01010000 */
120 #endif /* USE_POLARSSL */
123 #undef OCSP_REQUEST /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */
124 #undef OCSP_RESPONSE /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */
125 #include <cyassl/openssl/ssl.h>
142 #include <axTLS/ssl.h>
146 #endif /* USE_AXTLS */
149 #include "curl_sspi.h"
151 #include <schannel.h>
155 #include <Security/Security.h>
156 /* For some reason, when building for iOS, the omnibus header above does
157 * not include SecureTransport.h as of iOS SDK 5.1. */
158 #include <Security/SecureTransport.h>
161 #ifdef HAVE_NETINET_IN_H
162 #include <netinet/in.h>
168 #include <zlib.h> /* for content-encoding */
170 /* zlib pollutes the namespace with this definition */
175 #include <curl/curl.h>
177 #include "http_chunks.h" /* for the structs and enum stuff */
190 #include "wildcard.h"
191 #include "multihandle.h"
196 # elif defined HAVE_GSSMIT
197 # include <gssapi/gssapi.h>
198 # include <gssapi/gssapi_generic.h>
204 #ifdef HAVE_LIBSSH2_H
206 #include <libssh2_sftp.h>
207 #endif /* HAVE_LIBSSH2_H */
209 /* Download buffer size, keep it fairly big for speed reasons */
211 #define BUFSIZE CURL_MAX_WRITE_SIZE
213 /* Initial size of the buffer to store headers in, it'll be enlarged in case
215 #define HEADERSIZE 256
217 #define CURLEASY_MAGIC_NUMBER 0xc0dedbadU
219 /* Some convenience macros to get the larger/smaller value out of two given.
220 We prefix with CURL to prevent name collisions. */
221 #define CURLMAX(x,y) ((x)>(y)?(x):(y))
222 #define CURLMIN(x,y) ((x)<(y)?(x):(y))
226 /* Types needed for krb5-ftp connections */
234 enum protection_level {
235 PROT_NONE, /* first in list */
241 PROT_LAST /* last in list */
246 /* Structs to store Schannel handles */
247 struct curl_schannel_cred {
248 CredHandle cred_handle;
249 TimeStamp time_stamp;
254 struct curl_schannel_ctxt {
255 CtxtHandle ctxt_handle;
256 TimeStamp time_stamp;
260 /* enum for the nonblocking SSL connection state machine */
264 ssl_connect_2_reading,
265 ssl_connect_2_writing,
272 ssl_connection_negotiating,
273 ssl_connection_complete
274 } ssl_connection_state;
276 /* struct for data related to each SSL connection */
277 struct ssl_connect_data {
278 /* Use ssl encrypted communications TRUE/FALSE, not necessarily using it atm
279 but at least asked to or meaning to use it. See 'state' for the exact
280 current state of the connection. */
282 ssl_connection_state state;
284 /* these ones requires specific SSL-types */
288 ssl_connect_state connecting_state;
289 #endif /* USE_SSLEAY */
291 gnutls_session session;
292 gnutls_certificate_credentials cred;
294 gnutls_srp_client_credentials srp_client_cred;
296 ssl_connect_state connecting_state;
297 #endif /* USE_GNUTLS */
299 #if POLARSSL_VERSION_NUMBER<0x01010000
302 /* from v1.1.0, use ctr_drbg and entropy */
303 ctr_drbg_context ctr_drbg;
304 entropy_context entropy;
305 #endif /* POLARSSL_VERSION_NUMBER<0x01010000 */
313 ssl_connect_state connecting_state;
314 #endif /* USE_POLARSSL */
318 ssl_connect_state connecting_state;
319 #endif /* USE_CYASSL */
322 char *client_nickname;
323 struct SessionHandle *data;
324 struct curl_llist *obj_list;
325 PK11GenericObject *obj_clicert;
329 #endif /* USE_QSOSSL */
333 ssl_connect_state connecting_state;
338 ssl_connect_state connecting_state;
339 #endif /* USE_AXTLS */
341 struct curl_schannel_cred *cred;
342 struct curl_schannel_ctxt *ctxt;
343 SecPkgContext_StreamSizes stream_sizes;
344 ssl_connect_state connecting_state;
345 size_t encdata_length, decdata_length;
346 size_t encdata_offset, decdata_offset;
347 unsigned char *encdata_buffer, *decdata_buffer;
348 unsigned long req_flags, ret_flags;
349 #endif /* USE_SCHANNEL */
351 SSLContextRef ssl_ctx;
352 curl_socket_t ssl_sockfd;
353 ssl_connect_state connecting_state;
354 bool ssl_direction; /* true if writing, false if reading */
355 size_t ssl_write_buffered_length;
356 #endif /* USE_DARWINSSL */
359 struct ssl_config_data {
360 long version; /* what version the client wants to use */
361 long certverifyresult; /* result from the certificate verification */
363 bool verifypeer; /* set TRUE if this is desired */
364 bool verifyhost; /* set TRUE if CN/SAN must match hostname */
365 char *CApath; /* certificate dir (doesn't work on windows) */
366 char *CAfile; /* certificate to verify peer against */
367 const char *CRLfile; /* CRL to check certificate revocation */
368 const char *issuercert;/* optional issuer certificate filename */
369 char *random_file; /* path to file containing "random" data */
370 char *egdsocket; /* path to file containing the EGD daemon socket */
371 char *cipher_list; /* list of ciphers to use */
372 size_t max_ssl_sessions; /* SSL session id cache size */
373 curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */
374 void *fsslctxp; /* parameter for call back */
375 bool sessionid; /* cache session IDs or not */
376 bool certinfo; /* gather lots of certificate info */
379 char *username; /* TLS username (for, e.g., SRP) */
380 char *password; /* TLS password (for, e.g., SRP) */
381 enum CURL_TLSAUTH authtype; /* TLS authentication type (default SRP) */
385 /* information stored about one single SSL session */
386 struct curl_ssl_session {
387 char *name; /* host name for which this ID was used */
388 void *sessionid; /* as returned from the SSL layer */
389 size_t idsize; /* if known, otherwise 0 */
390 long age; /* just a number, the higher the more recent */
391 unsigned short remote_port; /* remote port to connect to */
392 struct ssl_config_data ssl_config; /* setup for this session */
395 /* Struct used for Digest challenge-response authentication */
401 bool stale; /* set true for re-negotiation */
405 int nc; /* nounce count */
416 #ifdef USE_WINDOWS_SSPI
417 #include "curl_sspi.h"
420 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
424 /* Struct used for NTLM challenge-response authentication */
427 #ifdef USE_WINDOWS_SSPI
430 SEC_WINNT_AUTH_IDENTITY identity;
431 SEC_WINNT_AUTH_IDENTITY *p_identity;
434 unsigned long n_type_2;
437 unsigned char nonce[8];
441 #ifdef USE_HTTP_NEGOTIATE
442 struct negotiatedata {
443 /* when doing Negotiate we first need to receive an auth token and then we
444 need to send our header */
445 enum { GSS_AUTHNONE, GSS_AUTHRECV, GSS_AUTHSENT } state;
446 bool gss; /* Whether we're processing GSS-Negotiate or Negotiate */
447 const char* protocol; /* "GSS-Negotiate" or "Negotiate" */
450 gss_ctx_id_t context;
451 gss_name_t server_name;
452 gss_buffer_desc output_token;
454 #ifdef USE_WINDOWS_SSPI
457 CredHandle *credentials;
458 char server_name[1024];
459 size_t max_token_length;
461 size_t output_token_length;
469 * Boolean values that concerns this connection.
472 bool close; /* if set, we close the connection after this request */
473 bool reuse; /* if set, this is a re-used connection */
474 bool proxy; /* if set, this transfer is done through a proxy - any type */
475 bool httpproxy; /* if set, this transfer is done through a http proxy */
476 bool user_passwd; /* do we use user+password for this connection? */
477 bool proxy_user_passwd; /* user+password for the proxy? */
478 bool ipv6_ip; /* we communicate with a remote site specified with pure IPv6
480 bool ipv6; /* we communicate with a site using an IPv6 address */
482 bool do_more; /* this is set TRUE if the ->curl_do_more() function is
483 supposed to be called, after ->curl_do() */
484 bool tcpconnect[2]; /* the TCP layer (or similar) is connected, this is set
485 the first time on the first connect function call */
486 bool protoconnstart;/* the protocol layer has STARTED its operation after
487 the TCP layer connect */
489 bool retry; /* this connection is about to get closed and then
490 re-attempted at another connection. */
491 bool tunnel_proxy; /* if CONNECT is used to "tunnel" through the proxy.
492 This is implicit when SSL-protocols are used through
493 proxies, but can also be enabled explicitly by
495 bool authneg; /* TRUE when the auth phase has started, which means
496 that we are creating a request with an auth header,
497 but it is not the final request in the auth
499 bool rewindaftersend;/* TRUE when the sending couldn't be stopped even
500 though it will be discarded. When the whole send
501 operation is done, we must call the data rewind
503 bool ftp_use_epsv; /* As set with CURLOPT_FTP_USE_EPSV, but if we find out
504 EPSV doesn't work we disable it for the forthcoming
507 bool ftp_use_eprt; /* As set with CURLOPT_FTP_USE_EPRT, but if we find out
508 EPRT doesn't work we disable it for the forthcoming
510 bool netrc; /* name+password provided by netrc */
511 bool userpwd_in_url; /* name+password found in url */
513 bool done; /* set to FALSE when Curl_do() is called and set to TRUE
514 when Curl_done() is called, to prevent Curl_done() to
515 get invoked twice when the multi interface is
517 bool stream_was_rewound; /* Indicates that the stream was rewound after a
518 request read past the end of its response byte
520 bool proxy_connect_closed; /* set true if a proxy disconnected the
521 connection in a CONNECT request with auth, so
522 that libcurl should reconnect and continue. */
523 bool bound; /* set true if bind() has already been done on this socket/
525 bool type_set; /* type= was used in the URL */
529 char *rawalloc; /* allocated "raw" version of the name */
530 char *encalloc; /* allocated IDN-encoded version of the name */
531 char *name; /* name to use internally, might be encoded, might be raw */
532 const char *dispname; /* name to display, as 'name' might be encoded */
536 * Flags on the keepon member of the Curl_transfer_keeper
540 #define KEEP_RECV (1<<0) /* there is or may be data to read */
541 #define KEEP_SEND (1<<1) /* there is or may be data to write */
542 #define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there
543 might still be data to read */
544 #define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there
545 might still be data to write */
546 #define KEEP_RECV_PAUSE (1<<4) /* reading is paused */
547 #define KEEP_SEND_PAUSE (1<<5) /* writing is paused */
549 #define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE)
550 #define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE)
555 ZLIB_UNINIT, /* uninitialized */
556 ZLIB_INIT, /* initialized */
557 ZLIB_GZIP_HEADER, /* reading gzip header */
558 ZLIB_GZIP_INFLATING, /* inflating gzip stream */
559 ZLIB_INIT_GZIP /* initialized in transparent gzip mode */
563 #ifdef CURLRES_ASYNCH
567 struct Curl_dns_entry *dns;
568 bool done; /* set TRUE when the lookup is complete */
569 int status; /* if done is TRUE, this is the status from the callback */
570 void *os_specific; /* 'struct thread_data' for Windows */
574 #define FIRSTSOCKET 0
575 #define SECONDARYSOCKET 1
577 /* These function pointer types are here only to allow easier typecasting
578 within the source when we need to cast between data pointers (such as NULL)
579 and function pointers. */
580 typedef CURLcode (*Curl_do_more_func)(struct connectdata *, int *);
581 typedef CURLcode (*Curl_done_func)(struct connectdata *, CURLcode, bool);
585 EXP100_SEND_DATA, /* enough waiting, just send the body now */
586 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */
587 EXP100_SENDING_REQUEST, /* still sending the request but will wait for
588 the 100 header once done with the request */
589 EXP100_FAILED /* used on 417 Expectation Failed */
593 * Request specific data in the easy handle (SessionHandle). Previously,
594 * these members were on the connectdata struct but since a conn struct may
595 * now be shared between different SessionHandles, we store connection-specific
596 * data here. This struct only keeps stuff that's interesting for *this*
597 * request, as it will be cleared between multiple ones
599 struct SingleRequest {
600 curl_off_t size; /* -1 if unknown at this point */
601 curl_off_t *bytecountp; /* return number of bytes read or NULL */
603 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch,
604 -1 means unlimited */
605 curl_off_t *writebytecountp; /* return number of bytes written or NULL */
607 curl_off_t bytecount; /* total number of bytes read */
608 curl_off_t writebytecount; /* number of bytes written */
610 long headerbytecount; /* only count received headers */
611 long deductheadercount; /* this amount of bytes doesn't count when we check
612 if anything has been transferred at the end of a
613 connection. We use this counter to make only a
614 100 reply (without a following second response
615 code) result in a CURLE_GOT_NOTHING error code */
617 struct timeval start; /* transfer started at this time */
618 struct timeval now; /* current time */
619 bool header; /* incoming data has HTTP header */
621 HEADER_NORMAL, /* no bad header at all */
622 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest
624 HEADER_ALLBAD /* all was believed to be header */
625 } badheader; /* the header was deemed bad and will be
627 int headerline; /* counts header lines to better track the
629 char *hbufp; /* points at *end* of header line */
631 char *str; /* within buf */
632 char *str_start; /* within buf */
633 char *end_ptr; /* within buf */
634 char *p; /* within headerbuff */
635 bool content_range; /* set TRUE if Content-Range: was found */
636 curl_off_t offset; /* possible resume offset read from the
637 Content-Range: header */
638 int httpcode; /* error code from the 'HTTP/1.? XXX' or
639 'RTSP/1.? XXX' line */
640 struct timeval start100; /* time stamp to wait for the 100 code from */
641 enum expect100 exp100; /* expect 100 continue state */
643 int auto_decoding; /* What content encoding. sec 3.5, RFC2616. */
645 #define IDENTITY 0 /* No encoding */
646 #define DEFLATE 1 /* zlib deflate [RFC 1950 & 1951] */
647 #define GZIP 2 /* gzip algorithm [RFC 1952] */
648 #define COMPRESS 3 /* Not handled, added for completeness */
651 zlibInitState zlib_init; /* possible zlib init state;
652 undefined if Content-Encoding header. */
653 z_stream z; /* State structure for zlib. */
665 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
666 and we're uploading the last chunk */
668 bool ignorebody; /* we read a response-body but we ignore it! */
669 bool ignorecl; /* This HTTP response has no body so we ignore the Content-
672 char *location; /* This points to an allocated version of the Location:
674 char *newurl; /* Set to the new URL to use when a redirect or a retry is
677 /* 'upload_present' is used to keep a byte counter of how much data there is
678 still left in the buffer, aimed for upload. */
679 ssize_t upload_present;
681 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
682 buffer, so the next read should read from where this pointer points to,
683 and the 'upload_present' contains the number of bytes available at this
685 char *upload_fromhere;
687 bool chunk; /* if set, this is a chunked transfer-encoding */
688 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
690 bool getheader; /* TRUE if header parsing is wanted */
692 bool forbidchunk; /* used only to explicitly forbid chunk-upload for
693 specific upload buffers. See readmoredata() in
694 http.c for details. */
696 void *protop; /* Allocated protocol-specific data. Each protocol
697 handler makes sure this points to data it needs. */
701 * Specific protocol handler.
704 struct Curl_handler {
705 const char * scheme; /* URL scheme name. */
707 /* Complement to setup_connection_internals(). */
708 CURLcode (*setup_connection)(struct connectdata *);
710 /* These two functions MUST be set to be protocol dependent */
711 CURLcode (*do_it)(struct connectdata *, bool *done);
714 /* If the curl_do() function is better made in two halves, this
715 * curl_do_more() function will be called afterwards, if set. For example
716 * for doing the FTP stuff after the PASV/PORT command.
718 Curl_do_more_func do_more;
720 /* This function *MAY* be set to a protocol-dependent function that is run
721 * after the connect() and everything is done, as a step in the connection.
722 * The 'done' pointer points to a bool that should be set to TRUE if the
723 * function completes before return. If it doesn't complete, the caller
724 * should call the curl_connecting() function until it is.
726 CURLcode (*connect_it)(struct connectdata *, bool *done);
728 /* See above. Currently only used for FTP. */
729 CURLcode (*connecting)(struct connectdata *, bool *done);
730 CURLcode (*doing)(struct connectdata *, bool *done);
732 /* Called from the multi interface during the PROTOCONNECT phase, and it
733 should then return a proper fd set */
734 int (*proto_getsock)(struct connectdata *conn,
735 curl_socket_t *socks,
738 /* Called from the multi interface during the DOING phase, and it should
739 then return a proper fd set */
740 int (*doing_getsock)(struct connectdata *conn,
741 curl_socket_t *socks,
744 /* Called from the multi interface during the DO_MORE phase, and it should
745 then return a proper fd set */
746 int (*domore_getsock)(struct connectdata *conn,
747 curl_socket_t *socks,
750 /* Called from the multi interface during the DO_DONE, PERFORM and
751 WAITPERFORM phases, and it should then return a proper fd set. Not setting
752 this will make libcurl use the generic default one. */
753 int (*perform_getsock)(const struct connectdata *conn,
754 curl_socket_t *socks,
757 /* This function *MAY* be set to a protocol-dependent function that is run
758 * by the curl_disconnect(), as a step in the disconnection. If the handler
759 * is called because the connection has been considered dead, dead_connection
762 CURLcode (*disconnect)(struct connectdata *, bool dead_connection);
764 /* If used, this function gets called from transfer.c:readwrite_data() to
765 allow the protocol to do extra reads/writes */
766 CURLcode (*readwrite)(struct SessionHandle *data, struct connectdata *conn,
767 ssize_t *nread, bool *readmore);
769 long defport; /* Default port. */
770 unsigned int protocol; /* See CURLPROTO_* */
771 unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */
774 #define PROTOPT_NONE 0 /* nothing extra */
775 #define PROTOPT_SSL (1<<0) /* uses SSL */
776 #define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */
777 #define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */
778 /* some protocols will have to call the underlying functions without regard to
779 what exact state the socket signals. IE even if the socket says "readable",
780 the send function might need to be called while uploading, or vice versa.
782 #define PROTOPT_DIRLOCK (1<<3)
783 #define PROTOPT_NONETWORK (1<<4) /* protocol doesn't use the network! */
784 #define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it
786 #define PROTOPT_NOURLQUERY (1<<6) /* protocol can't handle
787 url query strings (?foo=bar) ! */
790 /* return the count of bytes sent, or -1 on error */
791 typedef ssize_t (Curl_send)(struct connectdata *conn, /* connection data */
792 int sockindex, /* socketindex */
793 const void *buf, /* data to write */
794 size_t len, /* max amount to write */
795 CURLcode *err); /* error to return */
797 /* return the count of bytes read, or -1 on error */
798 typedef ssize_t (Curl_recv)(struct connectdata *conn, /* connection data */
799 int sockindex, /* socketindex */
800 char *buf, /* store data here */
801 size_t len, /* max amount to read */
802 CURLcode *err); /* error to return */
805 * The connectdata struct contains all fields and variables that should be
806 * unique for an entire connection.
809 /* 'data' is the CURRENT SessionHandle using this connection -- take great
810 caution that this might very well vary between different times this
811 connection is used! */
812 struct SessionHandle *data;
814 /* chunk is for HTTP chunked encoding, but is in the general connectdata
815 struct only because we can do just about any protocol through a HTTP proxy
816 and a HTTP proxy may in fact respond using chunked encoding */
817 struct Curl_chunker chunk;
819 curl_closesocket_callback fclosesocket; /* function closing the socket(s) */
820 void *closesocket_client;
822 bool inuse; /* This is a marker for the connection cache logic. If this is
823 TRUE this handle is being used by an easy handle and cannot
824 be used by any other easy handle without careful
825 consideration (== only for pipelining). */
827 /**** Fields set when inited and not modified again */
828 long connection_id; /* Contains a unique number to make it easier to
829 track the connections in the log output */
831 /* 'dns_entry' is the particular host we use. This points to an entry in the
832 DNS cache and it will not get pruned while locked. It gets unlocked in
833 Curl_done(). This entry will be NULL if the connection is re-used as then
834 there is no name resolve done. */
835 struct Curl_dns_entry *dns_entry;
837 /* 'ip_addr' is the particular IP we connected to. It points to a struct
838 within the DNS cache, so this pointer is only valid as long as the DNS
839 cache entry remains locked. It gets unlocked in Curl_done() */
840 Curl_addrinfo *ip_addr;
842 /* 'ip_addr_str' is the ip_addr data as a human readable string.
843 It remains available as long as the connection does, which is longer than
844 the ip_addr itself. */
845 char ip_addr_str[MAX_IPADR_LEN];
847 unsigned int scope; /* address scope for IPv6 */
849 int socktype; /* SOCK_STREAM or SOCK_DGRAM */
851 struct hostname host;
852 struct hostname proxy;
854 long port; /* which port to use locally */
855 unsigned short remote_port; /* what remote port to connect to,
856 not the proxy port! */
858 /* 'primary_ip' and 'primary_port' get filled with peer's numerical
859 ip address and port number whenever an outgoing connection is
860 *attempted* from the primary socket to a remote address. When more
861 than one address is tried for a connection these will hold data
862 for the last attempt. When the connection is actually established
863 these are updated with data which comes directly from the socket. */
865 char primary_ip[MAX_IPADR_LEN];
868 /* 'local_ip' and 'local_port' get filled with local's numerical
869 ip address and port number whenever an outgoing connection is
870 **established** from the primary socket to a remote address. */
872 char local_ip[MAX_IPADR_LEN];
875 char *user; /* user name string, allocated */
876 char *passwd; /* password string, allocated */
877 char *options; /* options string, allocated */
879 char *xoauth2_bearer; /* bearer token for xoauth2, allocated */
881 char *proxyuser; /* proxy user name string, allocated */
882 char *proxypasswd; /* proxy password string, allocated */
883 curl_proxytype proxytype; /* what kind of proxy that is in use */
885 int httpversion; /* the HTTP version*10 reported by the server */
886 int rtspversion; /* the RTSP version*10 reported by the server */
888 struct timeval now; /* "current" time */
889 struct timeval created; /* creation time */
890 curl_socket_t sock[2]; /* two sockets, the second is used for the data
891 transfer when doing FTP */
892 bool sock_accepted[2]; /* TRUE if the socket on this index was created with
897 struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */
898 struct ssl_config_data ssl_config;
900 struct ConnectBits bits; /* various state-flags for this connection */
902 /* connecttime: when connect() is called on the current IP address. Used to
903 be able to track when to move on to try next IP - but only when the multi
904 interface is used. */
905 struct timeval connecttime;
906 /* The two fields below get set in Curl_connecthost */
907 int num_addr; /* number of addresses to try to connect to */
908 long timeoutms_per_addr; /* how long time in milliseconds to spend on
909 trying to connect to each IP address */
911 const struct Curl_handler *handler; /* Connection's protocol handler */
912 const struct Curl_handler *given; /* The protocol first given */
914 long ip_version; /* copied from the SessionHandle at creation time */
916 /**** curl_get() phase fields */
918 curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */
919 curl_socket_t writesockfd; /* socket to write to, it may very
920 well be the same we read from.
921 CURL_SOCKET_BAD disables */
923 /** Dynamicly allocated strings, MUST be freed before this **/
924 /** struct is killed. **/
925 struct dynamically_allocated_data {
928 char *accept_encoding;
934 char *rtsp_transport;
935 char *te; /* TE: request header */
938 int sec_complete; /* if kerberos is enabled for this connection */
940 enum protection_level command_prot;
941 enum protection_level data_prot;
942 enum protection_level request_data_prot;
944 struct krb5buffer in_buffer;
946 const struct Curl_sec_client_mech *mech;
947 struct sockaddr_in local_addr;
950 /* the two following *_inuse fields are only flags, not counters in any way.
951 If TRUE it means the channel is in use, and if FALSE it means the channel
952 is up for grabs by one. */
954 bool readchannel_inuse; /* whether the read channel is in use by an easy
956 bool writechannel_inuse; /* whether the write channel is in use by an easy
958 struct curl_llist *send_pipe; /* List of handles waiting to
959 send on this pipeline */
960 struct curl_llist *recv_pipe; /* List of handles waiting to read
961 their responses on this pipeline */
962 char* master_buffer; /* The master buffer allocated on-demand;
963 used for pipelining. */
964 size_t read_pos; /* Current read position in the master buffer */
965 size_t buf_len; /* Length of the buffer?? */
968 curl_seek_callback seek_func; /* function that seeks the input */
969 void *seek_client; /* pointer to pass to the seek() above */
971 /*************** Request - specific items ************/
973 /* previously this was in the urldata struct */
974 curl_read_callback fread_func; /* function that reads the input */
975 void *fread_in; /* pointer to pass to the fread() above */
977 struct ntlmdata ntlm; /* NTLM differs from other authentication schemes
978 because it authenticates connections, not
980 struct ntlmdata proxyntlm; /* NTLM data for proxy */
982 #if defined(USE_NTLM) && defined(NTLM_WB_ENABLED)
983 /* used for communication with Samba's winbind daemon helper ntlm_auth */
984 curl_socket_t ntlm_auth_hlpr_socket;
985 pid_t ntlm_auth_hlpr_pid;
986 char* challenge_header;
987 char* response_header;
990 char syserr_buf [256]; /* buffer for Curl_strerror() */
992 #ifdef CURLRES_ASYNCH
993 /* data used for the asynch name resolve callback */
994 struct Curl_async async;
997 /* These three are used for chunked-encoding trailer support */
998 char *trailer; /* allocated buffer to store trailer in */
999 int trlMax; /* allocated buffer size */
1000 int trlPos; /* index of where to store data */
1003 struct ftp_conn ftpc;
1004 struct http_conn httpc;
1005 struct ssh_conn sshc;
1006 struct tftp_state_data *tftpc;
1007 struct imap_conn imapc;
1008 struct pop3_conn pop3c;
1009 struct smtp_conn smtpc;
1010 struct rtsp_conn rtspc;
1011 void *generic; /* RTMP and LDAP use this */
1014 int cselect_bits; /* bitmask of socket events */
1015 int waitfor; /* current READ/WRITE bits to wait for */
1017 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1018 int socks5_gssapi_enctype;
1024 /* When this connection is created, store the conditions for the local end
1025 bind. This is stored before the actual bind and before any connection is
1026 made and will serve the purpose of being used for comparison reasons so
1027 that subsequent bound-requested connections aren't accidentally re-using
1028 wrong connections. */
1030 unsigned short localport;
1033 /* tunnel as in tunnel through a HTTP proxy with CONNECT */
1035 TUNNEL_INIT, /* init/default/no tunnel state */
1036 TUNNEL_CONNECT, /* CONNECT has been sent off */
1037 TUNNEL_COMPLETE /* CONNECT response received completely */
1038 } tunnel_state[2]; /* two separate ones to allow FTP */
1039 struct connectbundle *bundle; /* The bundle we are member of */
1042 /* The end of connectdata. */
1045 * Struct to keep statistical and informational data.
1048 int httpcode; /* Recent HTTP, FTP, or RTSP response code */
1049 int httpproxycode; /* response code from proxy when received separate */
1050 int httpversion; /* the http version number X.Y = X*10+Y */
1051 long filetime; /* If requested, this is might get set. Set to -1 if the time
1052 was unretrievable. We cannot have this of type time_t,
1053 since time_t is unsigned on several platforms such as
1055 bool timecond; /* set to TRUE if the time condition didn't match, which
1056 thus made the document NOT get fetched */
1057 long header_size; /* size of read header(s) in bytes */
1058 long request_size; /* the amount of bytes sent in the request(s) */
1059 unsigned long proxyauthavail; /* what proxy auth types were announced */
1060 unsigned long httpauthavail; /* what host auth types were announced */
1061 long numconnects; /* how many new connection did libcurl created */
1062 char *contenttype; /* the content type of the object */
1063 char *wouldredirect; /* URL this would've been redirected to if asked to */
1065 /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip'
1066 and, 'conn_local_port' are copied over from the connectdata struct in
1067 order to allow curl_easy_getinfo() to return this information even when
1068 the session handle is no longer associated with a connection, and also
1069 allow curl_easy_reset() to clear this information from the session handle
1070 without disturbing information which is still alive, and that might be
1071 reused, in the connection cache. */
1073 char conn_primary_ip[MAX_IPADR_LEN];
1074 long conn_primary_port;
1076 char conn_local_ip[MAX_IPADR_LEN];
1077 long conn_local_port;
1079 struct curl_certinfo certs; /* info about the certs, only populated in
1080 OpenSSL builds. Asked for with
1081 CURLOPT_CERTINFO / CURLINFO_CERTINFO */
1086 long lastshow; /* time() of the last displayed progress meter or NULL to
1087 force redraw at next call */
1088 curl_off_t size_dl; /* total expected size */
1089 curl_off_t size_ul; /* total expected size */
1090 curl_off_t downloaded; /* transferred so far */
1091 curl_off_t uploaded; /* transferred so far */
1093 curl_off_t current_speed; /* uses the currently fastest transfer */
1095 bool callback; /* set when progress callback is used */
1096 int width; /* screen width at download start */
1097 int flags; /* see progress.h */
1106 double t_appconnect;
1107 double t_pretransfer;
1108 double t_starttransfer;
1111 struct timeval start;
1112 struct timeval t_startsingle;
1113 struct timeval t_acceptdata;
1114 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
1116 curl_off_t speeder[ CURR_TIME ];
1117 struct timeval speeder_time[ CURR_TIME ];
1122 HTTPREQ_NONE, /* first in list */
1125 HTTPREQ_POST_FORM, /* we make a difference internally */
1129 HTTPREQ_LAST /* last in list */
1133 RTSPREQ_NONE, /* first in list */
1141 RTSPREQ_GET_PARAMETER,
1142 RTSPREQ_SET_PARAMETER,
1145 RTSPREQ_LAST /* last in list */
1149 * Values that are generated, temporary or calculated internally for a
1150 * "session handle" must be defined within the 'struct UrlState'. This struct
1151 * will be used within the SessionHandle struct. When the 'SessionHandle'
1152 * struct is cloned, this data MUST NOT be copied.
1154 * Remember that any "state" information goes globally for the curl handle.
1155 * Session-data MUST be put in the connectdata struct and here. */
1156 #define MAX_CURL_USER_LENGTH 256
1157 #define MAX_CURL_PASSWORD_LENGTH 256
1160 unsigned long want; /* Bitmask set to the authentication methods wanted by
1161 app (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */
1162 unsigned long picked;
1163 unsigned long avail; /* Bitmask for what the server reports to support for
1165 bool done; /* TRUE when the auth phase is done and ready to do the *actual*
1167 bool multi; /* TRUE if this is not yet authenticated but within the auth
1168 multipass negotiation */
1169 bool iestyle; /* TRUE if digest should be done IE-style or FALSE if it should
1175 /* Points to the connection cache */
1176 struct conncache *conn_cache;
1178 /* when curl_easy_perform() is called, the multi handle is "owned" by
1179 the easy handle so curl_easy_cleanup() on such an easy handle will
1180 also close the multi handle! */
1181 bool multi_owned_by_easy;
1183 /* buffers to store authentication data in, as parsed from input options */
1184 struct timeval keeps_speed; /* for the progress meter really */
1186 struct connectdata *lastconnect; /* The last connection, NULL if undefined */
1188 char *headerbuff; /* allocated buffer to store headers in */
1189 size_t headersize; /* size of the allocation */
1191 char buffer[BUFSIZE+1]; /* download buffer */
1192 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
1193 curl_off_t current_speed; /* the ProgressShow() funcion sets this,
1195 bool this_is_a_follow; /* this is a followed Location: request */
1197 char *first_host; /* if set, this should be the host name that we will
1198 sent authorization to, no else. Used to make Location:
1199 following not keep sending user+password... This is
1202 struct curl_ssl_session *session; /* array of 'max_ssl_sessions' size */
1203 long sessionage; /* number of the most recent session */
1204 char *tempwrite; /* allocated buffer to keep data in when a write
1205 callback returns to make the connection paused */
1206 size_t tempwritesize; /* size of the 'tempwrite' allocated buffer */
1207 int tempwritetype; /* type of the 'tempwrite' buffer as a bitmask that is
1208 used with Curl_client_write() */
1209 char *scratch; /* huge buffer[BUFSIZE*2] when doing upload CRLF replacing */
1210 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
1211 This must be set to FALSE every time _easy_perform() is
1213 int os_errno; /* filled in with errno whenever an error occurs */
1215 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
1216 void (*prev_signal)(int sig);
1218 bool allow_port; /* Is set.use_port allowed to take effect or not. This
1219 is always set TRUE when curl_easy_perform() is called. */
1220 struct digestdata digest; /* state data for host Digest auth */
1221 struct digestdata proxydigest; /* state data for proxy Digest auth */
1223 #ifdef USE_HTTP_NEGOTIATE
1224 struct negotiatedata negotiate; /* state data for host Negotiate auth */
1225 struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */
1228 struct auth authhost; /* auth details for host */
1229 struct auth authproxy; /* auth details for proxy */
1231 bool authproblem; /* TRUE if there's some problem authenticating */
1233 void *resolver; /* resolver state, if it is used in the URL state -
1234 ares_channel f.e. */
1236 #if defined(USE_SSLEAY) && defined(HAVE_OPENSSL_ENGINE_H)
1238 #endif /* USE_SSLEAY */
1239 struct timeval expiretime; /* set this with Curl_expire() only */
1240 struct Curl_tree timenode; /* for the splay stuff */
1241 struct curl_llist *timeoutlist; /* list of pending timeouts */
1243 /* a place to store the most recently set FTP entrypath */
1244 char *most_recent_ftp_entrypath;
1246 /* set after initial USER failure, to prevent an authentication loop */
1247 bool ftp_trying_alternative;
1249 int httpversion; /* the lowest HTTP version*10 reported by any server
1250 involved in this request */
1251 bool expect100header; /* TRUE if we added Expect: 100-continue */
1253 bool pipe_broke; /* TRUE if the connection we were pipelined on broke
1254 and we need to restart from the beginning */
1256 #if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) && \
1257 !defined(__SYMBIAN32__)
1258 /* do FTP line-end conversions on most platforms */
1259 #define CURL_DO_LINEEND_CONV
1260 /* for FTP downloads: track CRLF sequences that span blocks */
1261 bool prev_block_had_trailing_cr;
1262 /* for FTP downloads: how many CRLFs did we converted to LFs? */
1263 curl_off_t crlf_conversions;
1265 char *pathbuffer;/* allocated buffer to store the URL's path part in */
1266 char *path; /* path to use, points to somewhere within the pathbuffer
1268 bool slash_removed; /* set TRUE if the 'path' points to a path where the
1269 initial URL slash separator has been taken off */
1271 bool rangestringalloc; /* the range string is malloc()'ed */
1273 char *range; /* range, if used. See README for detailed specification on
1275 curl_off_t resume_from; /* continue [ftp] transfer from here */
1277 /* This RTSP state information survives requests and connections */
1278 long rtsp_next_client_CSeq; /* the session's next client CSeq */
1279 long rtsp_next_server_CSeq; /* the session's next server CSeq */
1280 long rtsp_CSeq_recv; /* most recent CSeq received */
1282 /* if true, force SSL connection retry (workaround for certain servers) */
1283 bool ssl_connect_retry;
1288 * This 'DynamicStatic' struct defines dynamic states that actually change
1289 * values in the 'UserDefined' area, which MUST be taken into consideration
1290 * if the UserDefined struct is cloned or similar. You can probably just
1291 * copy these, but each one indicate a special action on other data.
1294 struct DynamicStatic {
1295 char *url; /* work URL, copied from UserDefined */
1296 bool url_alloc; /* URL string is malloc()'ed */
1297 char *referer; /* referer string */
1298 bool referer_alloc; /* referer sting is malloc()ed */
1299 struct curl_slist *cookielist; /* list of cookie files set by
1300 curl_easy_setopt(COOKIEFILE) calls */
1301 struct curl_slist *resolve; /* set to point to the set.resolve list when
1302 this should be dealt with in pretransfer */
1306 * This 'UserDefined' struct must only contain data that is set once to go
1307 * for many (perhaps) independent connections. Values that are generated or
1308 * calculated internally for the "session handle" MUST be defined within the
1309 * 'struct UrlState' instead. The only exceptions MUST note the changes in
1310 * the 'DynamicStatic' struct.
1311 * Character pointer fields point to dynamic storage, unless otherwise stated.
1314 struct Curl_multi; /* declared and used only in multi.c */
1317 STRING_CERT, /* client certificate file name */
1318 STRING_CERT_TYPE, /* format for certificate (default: PEM)*/
1319 STRING_COOKIE, /* HTTP cookie string to send */
1320 STRING_COOKIEJAR, /* dump all cookies to this file */
1321 STRING_CUSTOMREQUEST, /* HTTP/FTP/RTSP request/method to use */
1322 STRING_DEVICE, /* local network interface/address to use */
1323 STRING_ENCODING, /* Accept-Encoding string */
1324 STRING_FTP_ACCOUNT, /* ftp account data */
1325 STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */
1326 STRING_FTPPORT, /* port to send with the FTP PORT command */
1327 STRING_KEY, /* private key file name */
1328 STRING_KEY_PASSWD, /* plain text private key password */
1329 STRING_KEY_TYPE, /* format for private key (default: PEM) */
1330 STRING_KRB_LEVEL, /* krb security level */
1331 STRING_NETRC_FILE, /* if not NULL, use this instead of trying to find
1333 STRING_COPYPOSTFIELDS, /* if POST, set the fields' values here */
1334 STRING_PROXY, /* proxy to use */
1335 STRING_SET_RANGE, /* range, if used */
1336 STRING_SET_REFERER, /* custom string for the HTTP referer field */
1337 STRING_SET_URL, /* what original URL to work on */
1338 STRING_SSL_CAPATH, /* CA directory name (doesn't work on windows) */
1339 STRING_SSL_CAFILE, /* certificate file to verify peer against */
1340 STRING_SSL_CIPHER_LIST, /* list of ciphers to use */
1341 STRING_SSL_EGDSOCKET, /* path to file containing the EGD daemon socket */
1342 STRING_SSL_RANDOM_FILE, /* path to file containing "random" data */
1343 STRING_USERAGENT, /* User-Agent string */
1344 STRING_SSL_CRLFILE, /* crl file to check certificate */
1345 STRING_SSL_ISSUERCERT, /* issuer cert file to check certificate */
1346 STRING_USERNAME, /* <username>, if used */
1347 STRING_PASSWORD, /* <password>, if used */
1348 STRING_OPTIONS, /* <options>, if used */
1349 STRING_PROXYUSERNAME, /* Proxy <username>, if used */
1350 STRING_PROXYPASSWORD, /* Proxy <password>, if used */
1351 STRING_NOPROXY, /* List of hosts which should not use the proxy, if
1353 STRING_RTSP_SESSION_ID, /* Session ID to use */
1354 STRING_RTSP_STREAM_URI, /* Stream URI for this request */
1355 STRING_RTSP_TRANSPORT, /* Transport for this session */
1357 STRING_SSH_PRIVATE_KEY, /* path to the private key file for auth */
1358 STRING_SSH_PUBLIC_KEY, /* path to the public key file for auth */
1359 STRING_SSH_HOST_PUBLIC_KEY_MD5, /* md5 of host public key in ascii hex */
1360 STRING_SSH_KNOWNHOSTS, /* file name of knownhosts file */
1362 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1363 STRING_SOCKS5_GSSAPI_SERVICE, /* GSSAPI service name */
1369 STRING_TLSAUTH_USERNAME, /* TLS auth <username> */
1370 STRING_TLSAUTH_PASSWORD, /* TLS auth <password> */
1373 STRING_BEARER, /* <bearer>, if used */
1375 /* -- end of strings -- */
1376 STRING_LAST /* not used, just an end-of-list marker */
1379 struct UserDefined {
1380 FILE *err; /* the stderr user data goes here */
1381 void *debugdata; /* the data that will be passed to fdebug */
1382 char *errorbuffer; /* (Static) store failure messages in here */
1383 long proxyport; /* If non-zero, use this port number by default. If the
1384 proxy string features a ":[port]" that one will override
1386 void *out; /* the fetched file goes here */
1387 void *in; /* the uploaded file is read from here */
1388 void *writeheader; /* write the header to this if non-NULL */
1389 void *rtp_out; /* write RTP to this if non-NULL */
1390 long use_port; /* which port to use (when not using default) */
1391 unsigned long httpauth; /* kind of HTTP authentication to use (bitmask) */
1392 unsigned long proxyauth; /* kind of proxy authentication to use (bitmask) */
1393 long followlocation; /* as in HTTP Location: */
1394 long maxredirs; /* maximum no. of http(s) redirects to follow, set to -1
1397 int keep_post; /* keep POSTs as POSTs after a 30x request; each
1398 bit represents a request, from 301 to 303 */
1399 bool free_referer; /* set TRUE if 'referer' points to a string we
1401 void *postfields; /* if POST, set the fields' values here */
1402 curl_seek_callback seek_func; /* function that seeks the input */
1403 curl_off_t postfieldsize; /* if POST, this might have a size to use instead
1404 of strlen(), and then the data *may* be binary
1405 (contain zero bytes) */
1406 unsigned short localport; /* local port number to bind to */
1407 int localportrange; /* number of additional port numbers to test in case the
1408 'localport' one can't be bind()ed */
1409 curl_write_callback fwrite_func; /* function that stores the output */
1410 curl_write_callback fwrite_header; /* function that stores headers */
1411 curl_write_callback fwrite_rtp; /* function that stores interleaved RTP */
1412 curl_read_callback fread_func; /* function that reads the input */
1413 int is_fread_set; /* boolean, has read callback been set to non-NULL? */
1414 int is_fwrite_set; /* boolean, has write callback been set to non-NULL? */
1415 curl_progress_callback fprogress; /* OLD and deprecated progress callback */
1416 curl_xferinfo_callback fxferinfo; /* progress callback */
1417 curl_debug_callback fdebug; /* function that write informational data */
1418 curl_ioctl_callback ioctl_func; /* function for I/O control */
1419 curl_sockopt_callback fsockopt; /* function for setting socket options */
1420 void *sockopt_client; /* pointer to pass to the socket options callback */
1421 curl_opensocket_callback fopensocket; /* function for checking/translating
1422 the address and opening the
1424 void* opensocket_client;
1425 curl_closesocket_callback fclosesocket; /* function for closing the
1427 void* closesocket_client;
1429 void *seek_client; /* pointer to pass to the seek callback */
1430 /* the 3 curl_conv_callback functions below are used on non-ASCII hosts */
1431 /* function to convert from the network encoding: */
1432 curl_conv_callback convfromnetwork;
1433 /* function to convert to the network encoding: */
1434 curl_conv_callback convtonetwork;
1435 /* function to convert from UTF-8 encoding: */
1436 curl_conv_callback convfromutf8;
1438 void *progress_client; /* pointer to pass to the progress callback */
1439 void *ioctl_client; /* pointer to pass to the ioctl callback */
1440 long timeout; /* in milliseconds, 0 means no timeout */
1441 long connecttimeout; /* in milliseconds, 0 means no timeout */
1442 long accepttimeout; /* in milliseconds, 0 means no timeout */
1443 long server_response_timeout; /* in milliseconds, 0 means no timeout */
1444 long tftp_blksize ; /* in bytes, 0 means use default */
1445 curl_off_t infilesize; /* size of file to upload, -1 means unknown */
1446 long low_speed_limit; /* bytes/second */
1447 long low_speed_time; /* number of seconds */
1448 curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */
1449 curl_off_t max_recv_speed; /* high speed limit in bytes/second for
1451 curl_off_t set_resume_from; /* continue [ftp] transfer from here */
1452 struct curl_slist *headers; /* linked list of extra headers */
1453 struct curl_httppost *httppost; /* linked list of POST data */
1454 bool cookiesession; /* new cookie session? */
1455 bool crlf; /* convert crlf on ftp upload(?) */
1456 struct curl_slist *quote; /* after connection is established */
1457 struct curl_slist *postquote; /* after the transfer */
1458 struct curl_slist *prequote; /* before the transfer, after type */
1459 struct curl_slist *source_quote; /* 3rd party quote */
1460 struct curl_slist *source_prequote; /* in 3rd party transfer mode - before
1461 the transfer on source host */
1462 struct curl_slist *source_postquote; /* in 3rd party transfer mode - after
1463 the transfer on source host */
1464 struct curl_slist *telnet_options; /* linked list of telnet options */
1465 struct curl_slist *resolve; /* list of names to add/remove from
1467 curl_TimeCond timecondition; /* kind of time/date comparison */
1468 time_t timevalue; /* what time to compare with */
1469 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
1470 long httpversion; /* when non-zero, a specific HTTP version requested to
1471 be used in the library's request(s) */
1472 struct ssl_config_data ssl; /* user defined SSL stuff */
1473 curl_proxytype proxytype; /* what kind of proxy that is in use */
1474 long dns_cache_timeout; /* DNS cache timeout */
1475 long buffer_size; /* size of receive buffer to use */
1476 void *private_data; /* application-private data */
1478 struct curl_slist *http200aliases; /* linked list of aliases for http200 */
1480 long ipver; /* the CURL_IPRESOLVE_* defines in the public header file
1481 0 - whatever, 1 - v2, 2 - v6 */
1483 curl_off_t max_filesize; /* Maximum file size to download */
1485 curl_ftpfile ftp_filemethod; /* how to get to a file when FTP is used */
1487 int ftp_create_missing_dirs; /* 1 - create directories that don't exist
1488 2 - the same but also allow MKD to fail once
1491 curl_sshkeycallback ssh_keyfunc; /* key matching callback */
1492 void *ssh_keyfunc_userp; /* custom pointer to callback */
1494 /* Here follows boolean settings that define how to behave during
1495 this session. They are STATIC, set by libcurl users or at least initially
1496 and they don't change during operations. */
1498 bool printhost; /* printing host name in debug info */
1499 bool get_filetime; /* get the time and get of the remote file */
1500 bool tunnel_thru_httpproxy; /* use CONNECT through a HTTP proxy */
1501 bool prefer_ascii; /* ASCII rather than binary */
1502 bool ftp_append; /* append, not overwrite, on upload */
1503 bool ftp_list_only; /* switch FTP command for listing directories */
1504 bool ftp_use_port; /* use the FTP PORT command */
1505 bool hide_progress; /* don't use the progress meter */
1506 bool http_fail_on_error; /* fail on HTTP error codes >= 300 */
1507 bool http_follow_location; /* follow HTTP redirects */
1508 bool http_transfer_encoding; /* request compressed HTTP transfer-encoding */
1509 bool http_disable_hostname_check_before_authentication;
1510 bool include_header; /* include received protocol headers in data output */
1511 bool http_set_referer; /* is a custom referer used */
1512 bool http_auto_referer; /* set "correct" referer when following location: */
1513 bool opt_no_body; /* as set with CURLOPT_NOBODY */
1514 bool set_port; /* custom port number used */
1515 bool upload; /* upload request */
1516 enum CURL_NETRC_OPTION
1517 use_netrc; /* defined in include/curl.h */
1518 bool verbose; /* output verbosity */
1519 bool krb; /* kerberos connection requested */
1520 bool reuse_forbid; /* forbidden to be reused, close after use */
1521 bool reuse_fresh; /* do not re-use an existing connection */
1522 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
1523 bool ftp_use_eprt; /* if EPRT is to be attempted or not */
1524 bool ftp_use_pret; /* if PRET is to be used before PASV or not */
1526 curl_usessl use_ssl; /* if AUTH TLS is to be attempted etc, for FTP or
1527 IMAP or POP3 or others! */
1528 curl_ftpauth ftpsslauth; /* what AUTH XXX to be attempted */
1529 curl_ftpccc ftp_ccc; /* FTP CCC options */
1530 bool no_signal; /* do not use any signal/alarm handler */
1531 bool global_dns_cache; /* subject for future removal */
1532 bool tcp_nodelay; /* whether to enable TCP_NODELAY or not */
1533 bool ignorecl; /* ignore content length */
1534 bool ftp_skip_ip; /* skip the IP address the FTP server passes on to
1536 bool connect_only; /* make connection, let application use the socket */
1537 bool ssl_enable_beast; /* especially allow this flaw for interoperability's
1539 long ssh_auth_types; /* allowed SSH auth types */
1540 bool http_te_skip; /* pass the raw body data to the user, even when
1541 transfer-encoded (chunked, compressed) */
1542 bool http_ce_skip; /* pass the raw body data to the user, even when
1543 content-encoded (chunked, compressed) */
1544 long new_file_perms; /* Permissions to use when creating remote files */
1545 long new_directory_perms; /* Permissions to use when creating remote dirs */
1546 bool proxy_transfer_mode; /* set transfer mode (;type=<a|i>) when doing FTP
1547 via an HTTP proxy */
1548 char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */
1549 unsigned int scope; /* address scope for IPv6 */
1550 long allowed_protocols;
1551 long redir_protocols;
1552 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1553 long socks5_gssapi_nec; /* flag to support nec socks5 server */
1555 struct curl_slist *mail_rcpt; /* linked list of mail recipients */
1556 bool sasl_ir; /* Enable/disable SASL initial response */
1557 /* Common RTSP header options */
1558 Curl_RtspReq rtspreq; /* RTSP request type */
1559 long rtspversion; /* like httpversion, for RTSP */
1560 bool wildcardmatch; /* enable wildcard matching */
1561 curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer
1563 curl_chunk_end_callback chunk_end; /* called after part transferring
1565 curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds
1566 to pattern (e.g. if WILDCARDMATCH is on) */
1569 long gssapi_delegation; /* GSSAPI credential delegation, see the
1570 documentation of CURLOPT_GSSAPI_DELEGATION */
1572 bool tcp_keepalive; /* use TCP keepalives */
1573 long tcp_keepidle; /* seconds in idle before sending keepalive probe */
1574 long tcp_keepintvl; /* seconds between TCP keepalive probes */
1576 size_t maxconnects; /* Max idle connections in the connection cache */
1580 struct curl_hash *hostcache;
1582 HCACHE_NONE, /* not pointing to anything */
1583 HCACHE_GLOBAL, /* points to the (shrug) global one */
1584 HCACHE_MULTI, /* points to a shared one in the multi handle */
1585 HCACHE_SHARED /* points to a shared one in a shared object */
1590 * The 'connectdata' struct MUST have all the connection oriented stuff as we
1591 * may have several simultaneous connections and connection structs in memory.
1593 * The 'struct UserDefined' must only contain data that is set once to go for
1594 * many (perhaps) independent connections. Values that are generated or
1595 * calculated internally for the "session handle" must be defined within the
1596 * 'struct UrlState' instead.
1599 struct SessionHandle {
1600 /* first, two fields for the linked list of these */
1601 struct SessionHandle *next;
1602 struct SessionHandle *prev;
1604 struct connectdata *easy_conn; /* the "unit's" connection */
1606 CURLMstate mstate; /* the handle's state */
1607 CURLcode result; /* previous result */
1609 struct Curl_message msg; /* A single posted message. */
1611 /* Array with the plain socket numbers this handle takes care of, in no
1612 particular order. Note that all sockets are added to the sockhash, where
1613 the state etc are also kept. This array is mostly used to detect when a
1614 socket is to be removed from the hash. See singlesocket(). */
1615 curl_socket_t sockets[MAX_SOCKSPEREASYHANDLE];
1619 struct Curl_multi *multi; /* if non-NULL, points to the multi handle
1620 struct to which this "belongs" when used by
1621 the multi interface */
1622 struct Curl_multi *multi_easy; /* if non-NULL, points to the multi handle
1623 struct to which this "belongs" when used
1624 by the easy interface */
1625 struct Curl_share *share; /* Share, handles global variable mutexing */
1626 struct SingleRequest req; /* Request-specific data */
1627 struct UserDefined set; /* values set by the libcurl user */
1628 struct DynamicStatic change; /* possibly modified userdefined data */
1629 struct CookieInfo *cookies; /* the cookies, read from files and servers.
1630 NOTE that the 'cookie' field in the
1631 UserDefined struct defines if the "engine"
1632 is to be used or not. */
1633 struct Progress progress; /* for all the progress meter data */
1634 struct UrlState state; /* struct for fields used for state info and
1635 other dynamic purposes */
1636 struct WildcardData wildcard; /* wildcard download state info */
1637 struct PureInfo info; /* stats, reports and info data */
1638 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
1639 iconv_t outbound_cd; /* for translating to the network encoding */
1640 iconv_t inbound_cd; /* for translating from the network encoding */
1641 iconv_t utf8_cd; /* for translating to UTF8 */
1642 #endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */
1643 unsigned int magic; /* set to a CURLEASY_MAGIC_NUMBER */
1646 #define LIBCURL_NAME "libcurl"
1648 #endif /* HEADER_CURL_URLDATA_H */
projects / platform / upstream / curl.git / blob