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>
138 #include <axTLS/ssl.h>
142 #endif /* USE_AXTLS */
145 #include "curl_sspi.h"
147 #include <schannel.h>
151 #include <Security/Security.h>
152 /* For some reason, when building for iOS, the omnibus header above does
153 * not include SecureTransport.h as of iOS SDK 5.1. */
154 #include <Security/SecureTransport.h>
157 #ifdef HAVE_NETINET_IN_H
158 #include <netinet/in.h>
164 #include <zlib.h> /* for content-encoding */
166 /* zlib pollutes the namespace with this definition */
171 #include <curl/curl.h>
173 #include "http_chunks.h" /* for the structs and enum stuff */
186 #include "wildcard.h"
191 # elif defined HAVE_GSSMIT
192 # include <gssapi/gssapi.h>
193 # include <gssapi/gssapi_generic.h>
199 #ifdef HAVE_LIBSSH2_H
201 #include <libssh2_sftp.h>
202 #endif /* HAVE_LIBSSH2_H */
204 /* Download buffer size, keep it fairly big for speed reasons */
206 #define BUFSIZE CURL_MAX_WRITE_SIZE
208 /* Initial size of the buffer to store headers in, it'll be enlarged in case
210 #define HEADERSIZE 256
212 #define CURLEASY_MAGIC_NUMBER 0xc0dedbadU
214 /* Some convenience macros to get the larger/smaller value out of two given.
215 We prefix with CURL to prevent name collisions. */
216 #define CURLMAX(x,y) ((x)>(y)?(x):(y))
217 #define CURLMIN(x,y) ((x)<(y)?(x):(y))
220 #if defined(HAVE_KRB4) || defined(HAVE_GSSAPI)
221 /* Types needed for krb4/5-ftp connections */
229 enum protection_level {
230 PROT_NONE, /* first in list */
236 PROT_LAST /* last in list */
241 /* Structs to store Schannel handles */
242 struct curl_schannel_cred {
243 CredHandle cred_handle;
244 TimeStamp time_stamp;
248 struct curl_schannel_ctxt {
249 CtxtHandle ctxt_handle;
250 TimeStamp time_stamp;
254 /* enum for the nonblocking SSL connection state machine */
258 ssl_connect_2_reading,
259 ssl_connect_2_writing,
266 ssl_connection_negotiating,
267 ssl_connection_complete
268 } ssl_connection_state;
270 /* struct for data related to each SSL connection */
271 struct ssl_connect_data {
272 /* Use ssl encrypted communications TRUE/FALSE, not necessarily using it atm
273 but at least asked to or meaning to use it. See 'state' for the exact
274 current state of the connection. */
276 ssl_connection_state state;
278 /* these ones requires specific SSL-types */
282 ssl_connect_state connecting_state;
283 #endif /* USE_SSLEAY */
285 gnutls_session session;
286 gnutls_certificate_credentials cred;
288 gnutls_srp_client_credentials srp_client_cred;
290 ssl_connect_state connecting_state;
291 #endif /* USE_GNUTLS */
293 #if POLARSSL_VERSION_NUMBER<0x01010000
296 /* from v1.1.0, use ctr_drbg and entropy */
297 ctr_drbg_context ctr_drbg;
298 entropy_context entropy;
299 #endif /* POLARSSL_VERSION_NUMBER<0x01010000 */
307 ssl_connect_state connecting_state;
308 #endif /* USE_POLARSSL */
312 ssl_connect_state connecting_state;
313 #endif /* USE_CYASSL */
316 char *client_nickname;
317 struct SessionHandle *data;
318 struct curl_llist *obj_list;
319 PK11GenericObject *obj_clicert;
323 #endif /* USE_QSOSSL */
327 #endif /* USE_AXTLS */
329 struct curl_schannel_cred *cred;
330 struct curl_schannel_ctxt *ctxt;
331 SecPkgContext_StreamSizes stream_sizes;
332 ssl_connect_state connecting_state;
333 size_t encdata_length, decdata_length;
334 size_t encdata_offset, decdata_offset;
335 unsigned char *encdata_buffer, *decdata_buffer;
336 unsigned long req_flags, ret_flags;
337 #endif /* USE_SCHANNEL */
339 SSLContextRef ssl_ctx;
340 curl_socket_t ssl_sockfd;
341 ssl_connect_state connecting_state;
342 bool ssl_direction; /* true if writing, false if reading */
343 size_t ssl_write_buffered_length;
344 #endif /* USE_DARWINSSL */
347 struct ssl_config_data {
348 long version; /* what version the client wants to use */
349 long certverifyresult; /* result from the certificate verification */
351 bool verifypeer; /* set TRUE if this is desired */
352 bool verifyhost; /* set TRUE if CN/SAN must match hostname */
353 char *CApath; /* certificate dir (doesn't work on windows) */
354 char *CAfile; /* certificate to verify peer against */
355 const char *CRLfile; /* CRL to check certificate revocation */
356 const char *issuercert;/* optional issuer certificate filename */
357 char *random_file; /* path to file containing "random" data */
358 char *egdsocket; /* path to file containing the EGD daemon socket */
359 char *cipher_list; /* list of ciphers to use */
360 size_t max_ssl_sessions; /* SSL session id cache size */
361 curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */
362 void *fsslctxp; /* parameter for call back */
363 bool sessionid; /* cache session IDs or not */
364 bool certinfo; /* gather lots of certificate info */
367 char *username; /* TLS username (for, e.g., SRP) */
368 char *password; /* TLS password (for, e.g., SRP) */
369 enum CURL_TLSAUTH authtype; /* TLS authentication type (default SRP) */
373 /* information stored about one single SSL session */
374 struct curl_ssl_session {
375 char *name; /* host name for which this ID was used */
376 void *sessionid; /* as returned from the SSL layer */
377 size_t idsize; /* if known, otherwise 0 */
378 long age; /* just a number, the higher the more recent */
379 unsigned short remote_port; /* remote port to connect to */
380 struct ssl_config_data ssl_config; /* setup for this session */
383 /* Struct used for Digest challenge-response authentication */
389 bool stale; /* set true for re-negotiation */
393 int nc; /* nounce count */
404 #ifdef USE_WINDOWS_SSPI
405 #include "curl_sspi.h"
408 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
412 /* Struct used for NTLM challenge-response authentication */
415 #ifdef USE_WINDOWS_SSPI
418 SEC_WINNT_AUTH_IDENTITY identity;
419 SEC_WINNT_AUTH_IDENTITY *p_identity;
422 unsigned long n_type_2;
425 unsigned char nonce[8];
429 #ifdef USE_HTTP_NEGOTIATE
430 struct negotiatedata {
431 /* when doing Negotiate we first need to receive an auth token and then we
432 need to send our header */
433 enum { GSS_AUTHNONE, GSS_AUTHRECV, GSS_AUTHSENT } state;
434 bool gss; /* Whether we're processing GSS-Negotiate or Negotiate */
435 const char* protocol; /* "GSS-Negotiate" or "Negotiate" */
438 gss_ctx_id_t context;
439 gss_name_t server_name;
440 gss_buffer_desc output_token;
442 #ifdef USE_WINDOWS_SSPI
445 CredHandle *credentials;
446 char server_name[1024];
447 size_t max_token_length;
449 size_t output_token_length;
457 * Boolean values that concerns this connection.
460 bool close; /* if set, we close the connection after this request */
461 bool reuse; /* if set, this is a re-used connection */
462 bool proxy; /* if set, this transfer is done through a proxy - any type */
463 bool httpproxy; /* if set, this transfer is done through a http proxy */
464 bool user_passwd; /* do we use user+password for this connection? */
465 bool proxy_user_passwd; /* user+password for the proxy? */
466 bool ipv6_ip; /* we communicate with a remote site specified with pure IPv6
468 bool ipv6; /* we communicate with a site using an IPv6 address */
470 bool do_more; /* this is set TRUE if the ->curl_do_more() function is
471 supposed to be called, after ->curl_do() */
472 bool tcpconnect[2]; /* the TCP layer (or similar) is connected, this is set
473 the first time on the first connect function call */
474 bool protoconnstart;/* the protocol layer has STARTED its operation after
475 the TCP layer connect */
477 bool retry; /* this connection is about to get closed and then
478 re-attempted at another connection. */
479 bool tunnel_proxy; /* if CONNECT is used to "tunnel" through the proxy.
480 This is implicit when SSL-protocols are used through
481 proxies, but can also be enabled explicitly by
483 bool authneg; /* TRUE when the auth phase has started, which means
484 that we are creating a request with an auth header,
485 but it is not the final request in the auth
487 bool rewindaftersend;/* TRUE when the sending couldn't be stopped even
488 though it will be discarded. When the whole send
489 operation is done, we must call the data rewind
491 bool ftp_use_epsv; /* As set with CURLOPT_FTP_USE_EPSV, but if we find out
492 EPSV doesn't work we disable it for the forthcoming
495 bool ftp_use_eprt; /* As set with CURLOPT_FTP_USE_EPRT, but if we find out
496 EPRT doesn't work we disable it for the forthcoming
498 bool netrc; /* name+password provided by netrc */
499 bool userpwd_in_url; /* name+password found in url */
501 bool done; /* set to FALSE when Curl_do() is called and set to TRUE
502 when Curl_done() is called, to prevent Curl_done() to
503 get invoked twice when the multi interface is
505 bool stream_was_rewound; /* Indicates that the stream was rewound after a
506 request read past the end of its response byte
508 bool proxy_connect_closed; /* set true if a proxy disconnected the
509 connection in a CONNECT request with auth, so
510 that libcurl should reconnect and continue. */
511 bool bound; /* set true if bind() has already been done on this socket/
513 bool type_set; /* type= was used in the URL */
517 char *rawalloc; /* allocated "raw" version of the name */
518 char *encalloc; /* allocated IDN-encoded version of the name */
519 char *name; /* name to use internally, might be encoded, might be raw */
520 const char *dispname; /* name to display, as 'name' might be encoded */
524 * Flags on the keepon member of the Curl_transfer_keeper
528 #define KEEP_RECV (1<<0) /* there is or may be data to read */
529 #define KEEP_SEND (1<<1) /* there is or may be data to write */
530 #define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there
531 might still be data to read */
532 #define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there
533 might still be data to write */
534 #define KEEP_RECV_PAUSE (1<<4) /* reading is paused */
535 #define KEEP_SEND_PAUSE (1<<5) /* writing is paused */
537 #define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE)
538 #define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE)
543 ZLIB_UNINIT, /* uninitialized */
544 ZLIB_INIT, /* initialized */
545 ZLIB_GZIP_HEADER, /* reading gzip header */
546 ZLIB_GZIP_INFLATING, /* inflating gzip stream */
547 ZLIB_INIT_GZIP /* initialized in transparent gzip mode */
551 #ifdef CURLRES_ASYNCH
555 struct Curl_dns_entry *dns;
556 bool done; /* set TRUE when the lookup is complete */
557 int status; /* if done is TRUE, this is the status from the callback */
558 void *os_specific; /* 'struct thread_data' for Windows */
562 #define FIRSTSOCKET 0
563 #define SECONDARYSOCKET 1
565 /* These function pointer types are here only to allow easier typecasting
566 within the source when we need to cast between data pointers (such as NULL)
567 and function pointers. */
568 typedef CURLcode (*Curl_do_more_func)(struct connectdata *, bool *);
569 typedef CURLcode (*Curl_done_func)(struct connectdata *, CURLcode, bool);
573 EXP100_SEND_DATA, /* enough waiting, just send the body now */
574 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */
575 EXP100_SENDING_REQUEST, /* still sending the request but will wait for
576 the 100 header once done with the request */
577 EXP100_FAILED /* used on 417 Expectation Failed */
581 * Request specific data in the easy handle (SessionHandle). Previously,
582 * these members were on the connectdata struct but since a conn struct may
583 * now be shared between different SessionHandles, we store connection-specific
584 * data here. This struct only keeps stuff that's interesting for *this*
585 * request, as it will be cleared between multiple ones
587 struct SingleRequest {
588 curl_off_t size; /* -1 if unknown at this point */
589 curl_off_t *bytecountp; /* return number of bytes read or NULL */
591 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch,
592 -1 means unlimited */
593 curl_off_t *writebytecountp; /* return number of bytes written or NULL */
595 curl_off_t bytecount; /* total number of bytes read */
596 curl_off_t writebytecount; /* number of bytes written */
598 long headerbytecount; /* only count received headers */
599 long deductheadercount; /* this amount of bytes doesn't count when we check
600 if anything has been transferred at the end of a
601 connection. We use this counter to make only a
602 100 reply (without a following second response
603 code) result in a CURLE_GOT_NOTHING error code */
605 struct timeval start; /* transfer started at this time */
606 struct timeval now; /* current time */
607 bool header; /* incoming data has HTTP header */
609 HEADER_NORMAL, /* no bad header at all */
610 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest
612 HEADER_ALLBAD /* all was believed to be header */
613 } badheader; /* the header was deemed bad and will be
615 int headerline; /* counts header lines to better track the
617 char *hbufp; /* points at *end* of header line */
619 char *str; /* within buf */
620 char *str_start; /* within buf */
621 char *end_ptr; /* within buf */
622 char *p; /* within headerbuff */
623 bool content_range; /* set TRUE if Content-Range: was found */
624 curl_off_t offset; /* possible resume offset read from the
625 Content-Range: header */
626 int httpcode; /* error code from the 'HTTP/1.? XXX' or
627 'RTSP/1.? XXX' line */
628 struct timeval start100; /* time stamp to wait for the 100 code from */
629 enum expect100 exp100; /* expect 100 continue state */
631 int auto_decoding; /* What content encoding. sec 3.5, RFC2616. */
633 #define IDENTITY 0 /* No encoding */
634 #define DEFLATE 1 /* zlib deflate [RFC 1950 & 1951] */
635 #define GZIP 2 /* gzip algorithm [RFC 1952] */
636 #define COMPRESS 3 /* Not handled, added for completeness */
639 zlibInitState zlib_init; /* possible zlib init state;
640 undefined if Content-Encoding header. */
641 z_stream z; /* State structure for zlib. */
653 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
654 and we're uploading the last chunk */
656 bool ignorebody; /* we read a response-body but we ignore it! */
657 bool ignorecl; /* This HTTP response has no body so we ignore the Content-
660 char *location; /* This points to an allocated version of the Location:
662 char *newurl; /* Set to the new URL to use when a redirect or a retry is
665 /* 'upload_present' is used to keep a byte counter of how much data there is
666 still left in the buffer, aimed for upload. */
667 ssize_t upload_present;
669 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
670 buffer, so the next read should read from where this pointer points to,
671 and the 'upload_present' contains the number of bytes available at this
673 char *upload_fromhere;
675 bool chunk; /* if set, this is a chunked transfer-encoding */
676 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
678 bool getheader; /* TRUE if header parsing is wanted */
680 bool forbidchunk; /* used only to explicitly forbid chunk-upload for
681 specific upload buffers. See readmoredata() in
682 http.c for details. */
686 * Specific protocol handler.
689 struct Curl_handler {
690 const char * scheme; /* URL scheme name. */
692 /* Complement to setup_connection_internals(). */
693 CURLcode (*setup_connection)(struct connectdata *);
695 /* These two functions MUST be set to be protocol dependent */
696 CURLcode (*do_it)(struct connectdata *, bool *done);
699 /* If the curl_do() function is better made in two halves, this
700 * curl_do_more() function will be called afterwards, if set. For example
701 * for doing the FTP stuff after the PASV/PORT command.
703 Curl_do_more_func do_more;
705 /* This function *MAY* be set to a protocol-dependent function that is run
706 * after the connect() and everything is done, as a step in the connection.
707 * The 'done' pointer points to a bool that should be set to TRUE if the
708 * function completes before return. If it doesn't complete, the caller
709 * should call the curl_connecting() function until it is.
711 CURLcode (*connect_it)(struct connectdata *, bool *done);
713 /* See above. Currently only used for FTP. */
714 CURLcode (*connecting)(struct connectdata *, bool *done);
715 CURLcode (*doing)(struct connectdata *, bool *done);
717 /* Called from the multi interface during the PROTOCONNECT phase, and it
718 should then return a proper fd set */
719 int (*proto_getsock)(struct connectdata *conn,
720 curl_socket_t *socks,
723 /* Called from the multi interface during the DOING phase, and it should
724 then return a proper fd set */
725 int (*doing_getsock)(struct connectdata *conn,
726 curl_socket_t *socks,
729 /* Called from the multi interface during the DO_MORE phase, and it should
730 then return a proper fd set */
731 int (*domore_getsock)(struct connectdata *conn,
732 curl_socket_t *socks,
735 /* Called from the multi interface during the DO_DONE, PERFORM and
736 WAITPERFORM phases, and it should then return a proper fd set. Not setting
737 this will make libcurl use the generic default one. */
738 int (*perform_getsock)(const struct connectdata *conn,
739 curl_socket_t *socks,
742 /* This function *MAY* be set to a protocol-dependent function that is run
743 * by the curl_disconnect(), as a step in the disconnection. If the handler
744 * is called because the connection has been considered dead, dead_connection
747 CURLcode (*disconnect)(struct connectdata *, bool dead_connection);
749 /* If used, this function gets called from transfer.c:readwrite_data() to
750 allow the protocol to do extra reads/writes */
751 CURLcode (*readwrite)(struct SessionHandle *data, struct connectdata *conn,
752 ssize_t *nread, bool *readmore);
754 long defport; /* Default port. */
755 unsigned int protocol; /* See CURLPROTO_* */
756 unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */
759 #define PROTOPT_NONE 0 /* nothing extra */
760 #define PROTOPT_SSL (1<<0) /* uses SSL */
761 #define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */
762 #define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */
763 /* some protocols will have to call the underlying functions without regard to
764 what exact state the socket signals. IE even if the socket says "readable",
765 the send function might need to be called while uploading, or vice versa.
767 #define PROTOPT_DIRLOCK (1<<3)
768 #define PROTOPT_NONETWORK (1<<4) /* protocol doesn't use the network! */
769 #define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it
771 #define PROTOPT_NOURLQUERY (1<<6) /* protocol can't handle
772 url query strings (?foo=bar) ! */
775 /* return the count of bytes sent, or -1 on error */
776 typedef ssize_t (Curl_send)(struct connectdata *conn, /* connection data */
777 int sockindex, /* socketindex */
778 const void *buf, /* data to write */
779 size_t len, /* max amount to write */
780 CURLcode *err); /* error to return */
782 /* return the count of bytes read, or -1 on error */
783 typedef ssize_t (Curl_recv)(struct connectdata *conn, /* connection data */
784 int sockindex, /* socketindex */
785 char *buf, /* store data here */
786 size_t len, /* max amount to read */
787 CURLcode *err); /* error to return */
790 * The connectdata struct contains all fields and variables that should be
791 * unique for an entire connection.
794 /* 'data' is the CURRENT SessionHandle using this connection -- take great
795 caution that this might very well vary between different times this
796 connection is used! */
797 struct SessionHandle *data;
799 /* chunk is for HTTP chunked encoding, but is in the general connectdata
800 struct only because we can do just about any protocol through a HTTP proxy
801 and a HTTP proxy may in fact respond using chunked encoding */
802 struct Curl_chunker chunk;
804 curl_closesocket_callback fclosesocket; /* function closing the socket(s) */
805 void *closesocket_client;
807 bool inuse; /* This is a marker for the connection cache logic. If this is
808 TRUE this handle is being used by an easy handle and cannot
809 be used by any other easy handle without careful
810 consideration (== only for pipelining). */
812 /**** Fields set when inited and not modified again */
813 long connection_id; /* Contains a unique number to make it easier to
814 track the connections in the log output */
816 /* 'dns_entry' is the particular host we use. This points to an entry in the
817 DNS cache and it will not get pruned while locked. It gets unlocked in
818 Curl_done(). This entry will be NULL if the connection is re-used as then
819 there is no name resolve done. */
820 struct Curl_dns_entry *dns_entry;
822 /* 'ip_addr' is the particular IP we connected to. It points to a struct
823 within the DNS cache, so this pointer is only valid as long as the DNS
824 cache entry remains locked. It gets unlocked in Curl_done() */
825 Curl_addrinfo *ip_addr;
827 /* 'ip_addr_str' is the ip_addr data as a human readable string.
828 It remains available as long as the connection does, which is longer than
829 the ip_addr itself. */
830 char ip_addr_str[MAX_IPADR_LEN];
832 unsigned int scope; /* address scope for IPv6 */
834 int socktype; /* SOCK_STREAM or SOCK_DGRAM */
836 struct hostname host;
837 struct hostname proxy;
839 long port; /* which port to use locally */
840 unsigned short remote_port; /* what remote port to connect to,
841 not the proxy port! */
843 /* 'primary_ip' and 'primary_port' get filled with peer's numerical
844 ip address and port number whenever an outgoing connection is
845 *attempted* from the primary socket to a remote address. When more
846 than one address is tried for a connection these will hold data
847 for the last attempt. When the connection is actually established
848 these are updated with data which comes directly from the socket. */
850 char primary_ip[MAX_IPADR_LEN];
853 /* 'local_ip' and 'local_port' get filled with local's numerical
854 ip address and port number whenever an outgoing connection is
855 **established** from the primary socket to a remote address. */
857 char local_ip[MAX_IPADR_LEN];
860 char *user; /* user name string, allocated */
861 char *passwd; /* password string, allocated */
862 char *options; /* options string, allocated */
864 char *proxyuser; /* proxy user name string, allocated */
865 char *proxypasswd; /* proxy password string, allocated */
866 curl_proxytype proxytype; /* what kind of proxy that is in use */
868 int httpversion; /* the HTTP version*10 reported by the server */
869 int rtspversion; /* the RTSP version*10 reported by the server */
871 struct timeval now; /* "current" time */
872 struct timeval created; /* creation time */
873 curl_socket_t sock[2]; /* two sockets, the second is used for the data
874 transfer when doing FTP */
875 bool sock_accepted[2]; /* TRUE if the socket on this index was created with
880 struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */
881 struct ssl_config_data ssl_config;
883 struct ConnectBits bits; /* various state-flags for this connection */
885 /* connecttime: when connect() is called on the current IP address. Used to
886 be able to track when to move on to try next IP - but only when the multi
887 interface is used. */
888 struct timeval connecttime;
889 /* The two fields below get set in Curl_connecthost */
890 int num_addr; /* number of addresses to try to connect to */
891 long timeoutms_per_addr; /* how long time in milliseconds to spend on
892 trying to connect to each IP address */
894 const struct Curl_handler *handler; /* Connection's protocol handler */
895 const struct Curl_handler *given; /* The protocol first given */
897 long ip_version; /* copied from the SessionHandle at creation time */
899 /**** curl_get() phase fields */
901 curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */
902 curl_socket_t writesockfd; /* socket to write to, it may very
903 well be the same we read from.
904 CURL_SOCKET_BAD disables */
906 /** Dynamicly allocated strings, MUST be freed before this **/
907 /** struct is killed. **/
908 struct dynamically_allocated_data {
911 char *accept_encoding;
917 char *rtsp_transport;
918 char *te; /* TE: request header */
921 int sec_complete; /* if kerberos is enabled for this connection */
922 #if defined(HAVE_KRB4) || defined(HAVE_GSSAPI)
923 enum protection_level command_prot;
924 enum protection_level data_prot;
925 enum protection_level request_data_prot;
927 struct krb4buffer in_buffer;
929 const struct Curl_sec_client_mech *mech;
930 struct sockaddr_in local_addr;
933 /* the two following *_inuse fields are only flags, not counters in any way.
934 If TRUE it means the channel is in use, and if FALSE it means the channel
935 is up for grabs by one. */
937 bool readchannel_inuse; /* whether the read channel is in use by an easy
939 bool writechannel_inuse; /* whether the write channel is in use by an easy
941 struct curl_llist *send_pipe; /* List of handles waiting to
942 send on this pipeline */
943 struct curl_llist *recv_pipe; /* List of handles waiting to read
944 their responses on this pipeline */
945 char* master_buffer; /* The master buffer allocated on-demand;
946 used for pipelining. */
947 size_t read_pos; /* Current read position in the master buffer */
948 size_t buf_len; /* Length of the buffer?? */
951 curl_seek_callback seek_func; /* function that seeks the input */
952 void *seek_client; /* pointer to pass to the seek() above */
954 /*************** Request - specific items ************/
956 /* previously this was in the urldata struct */
957 curl_read_callback fread_func; /* function that reads the input */
958 void *fread_in; /* pointer to pass to the fread() above */
960 struct ntlmdata ntlm; /* NTLM differs from other authentication schemes
961 because it authenticates connections, not
963 struct ntlmdata proxyntlm; /* NTLM data for proxy */
965 #if defined(USE_NTLM) && defined(NTLM_WB_ENABLED)
966 /* used for communication with Samba's winbind daemon helper ntlm_auth */
967 curl_socket_t ntlm_auth_hlpr_socket;
968 pid_t ntlm_auth_hlpr_pid;
969 char* challenge_header;
970 char* response_header;
973 char syserr_buf [256]; /* buffer for Curl_strerror() */
975 #ifdef CURLRES_ASYNCH
976 /* data used for the asynch name resolve callback */
977 struct Curl_async async;
980 /* These three are used for chunked-encoding trailer support */
981 char *trailer; /* allocated buffer to store trailer in */
982 int trlMax; /* allocated buffer size */
983 int trlPos; /* index of where to store data */
986 struct ftp_conn ftpc;
987 struct ssh_conn sshc;
988 struct tftp_state_data *tftpc;
989 struct imap_conn imapc;
990 struct pop3_conn pop3c;
991 struct smtp_conn smtpc;
992 struct rtsp_conn rtspc;
996 int cselect_bits; /* bitmask of socket events */
997 int waitfor; /* current READ/WRITE bits to wait for */
999 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1000 int socks5_gssapi_enctype;
1006 /* When this connection is created, store the conditions for the local end
1007 bind. This is stored before the actual bind and before any connection is
1008 made and will serve the purpose of being used for comparison reasons so
1009 that subsequent bound-requested connections aren't accidentally re-using
1010 wrong connections. */
1012 unsigned short localport;
1015 /* tunnel as in tunnel through a HTTP proxy with CONNECT */
1017 TUNNEL_INIT, /* init/default/no tunnel state */
1018 TUNNEL_CONNECT, /* CONNECT has been sent off */
1019 TUNNEL_COMPLETE /* CONNECT response received completely */
1020 } tunnel_state[2]; /* two separate ones to allow FTP */
1021 struct connectbundle *bundle; /* The bundle we are member of */
1024 /* The end of connectdata. */
1027 * Struct to keep statistical and informational data.
1030 int httpcode; /* Recent HTTP, FTP, or RTSP response code */
1031 int httpproxycode; /* response code from proxy when received separate */
1032 int httpversion; /* the http version number X.Y = X*10+Y */
1033 long filetime; /* If requested, this is might get set. Set to -1 if the time
1034 was unretrievable. We cannot have this of type time_t,
1035 since time_t is unsigned on several platforms such as
1037 bool timecond; /* set to TRUE if the time condition didn't match, which
1038 thus made the document NOT get fetched */
1039 long header_size; /* size of read header(s) in bytes */
1040 long request_size; /* the amount of bytes sent in the request(s) */
1041 unsigned long proxyauthavail; /* what proxy auth types were announced */
1042 unsigned long httpauthavail; /* what host auth types were announced */
1043 long numconnects; /* how many new connection did libcurl created */
1044 char *contenttype; /* the content type of the object */
1045 char *wouldredirect; /* URL this would've been redirected to if asked to */
1047 /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip'
1048 and, 'conn_local_port' are copied over from the connectdata struct in
1049 order to allow curl_easy_getinfo() to return this information even when
1050 the session handle is no longer associated with a connection, and also
1051 allow curl_easy_reset() to clear this information from the session handle
1052 without disturbing information which is still alive, and that might be
1053 reused, in the connection cache. */
1055 char conn_primary_ip[MAX_IPADR_LEN];
1056 long conn_primary_port;
1058 char conn_local_ip[MAX_IPADR_LEN];
1059 long conn_local_port;
1061 struct curl_certinfo certs; /* info about the certs, only populated in
1062 OpenSSL builds. Asked for with
1063 CURLOPT_CERTINFO / CURLINFO_CERTINFO */
1068 long lastshow; /* time() of the last displayed progress meter or NULL to
1069 force redraw at next call */
1070 curl_off_t size_dl; /* total expected size */
1071 curl_off_t size_ul; /* total expected size */
1072 curl_off_t downloaded; /* transferred so far */
1073 curl_off_t uploaded; /* transferred so far */
1075 curl_off_t current_speed; /* uses the currently fastest transfer */
1077 bool callback; /* set when progress callback is used */
1078 int width; /* screen width at download start */
1079 int flags; /* see progress.h */
1088 double t_appconnect;
1089 double t_pretransfer;
1090 double t_starttransfer;
1093 struct timeval start;
1094 struct timeval t_startsingle;
1095 struct timeval t_acceptdata;
1096 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
1098 curl_off_t speeder[ CURR_TIME ];
1099 struct timeval speeder_time[ CURR_TIME ];
1104 HTTPREQ_NONE, /* first in list */
1107 HTTPREQ_POST_FORM, /* we make a difference internally */
1111 HTTPREQ_LAST /* last in list */
1115 RTSPREQ_NONE, /* first in list */
1123 RTSPREQ_GET_PARAMETER,
1124 RTSPREQ_SET_PARAMETER,
1127 RTSPREQ_LAST /* last in list */
1131 * Values that are generated, temporary or calculated internally for a
1132 * "session handle" must be defined within the 'struct UrlState'. This struct
1133 * will be used within the SessionHandle struct. When the 'SessionHandle'
1134 * struct is cloned, this data MUST NOT be copied.
1136 * Remember that any "state" information goes globally for the curl handle.
1137 * Session-data MUST be put in the connectdata struct and here. */
1138 #define MAX_CURL_USER_LENGTH 256
1139 #define MAX_CURL_PASSWORD_LENGTH 256
1140 #define MAX_CURL_OPTIONS_LENGTH 256
1141 #define MAX_CURL_USER_LENGTH_TXT "255"
1142 #define MAX_CURL_PASSWORD_LENGTH_TXT "255"
1143 #define MAX_CURL_OPTIONS_LENGTH_TXT "255"
1146 unsigned long want; /* Bitmask set to the authentication methods wanted by
1147 app (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */
1148 unsigned long picked;
1149 unsigned long avail; /* Bitmask for what the server reports to support for
1151 bool done; /* TRUE when the auth phase is done and ready to do the *actual*
1153 bool multi; /* TRUE if this is not yet authenticated but within the auth
1154 multipass negotiation */
1155 bool iestyle; /* TRUE if digest should be done IE-style or FALSE if it should
1161 /* Points to the connection cache */
1162 struct conncache *conn_cache;
1164 /* when curl_easy_perform() is called, the multi handle is "owned" by
1165 the easy handle so curl_easy_cleanup() on such an easy handle will
1166 also close the multi handle! */
1167 bool multi_owned_by_easy;
1169 /* buffers to store authentication data in, as parsed from input options */
1170 struct timeval keeps_speed; /* for the progress meter really */
1172 struct connectdata *lastconnect; /* The last connection, NULL if undefined */
1174 char *headerbuff; /* allocated buffer to store headers in */
1175 size_t headersize; /* size of the allocation */
1177 char buffer[BUFSIZE+1]; /* download buffer */
1178 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
1179 curl_off_t current_speed; /* the ProgressShow() funcion sets this,
1181 bool this_is_a_follow; /* this is a followed Location: request */
1183 char *first_host; /* if set, this should be the host name that we will
1184 sent authorization to, no else. Used to make Location:
1185 following not keep sending user+password... This is
1188 struct curl_ssl_session *session; /* array of 'max_ssl_sessions' size */
1189 long sessionage; /* number of the most recent session */
1190 char *tempwrite; /* allocated buffer to keep data in when a write
1191 callback returns to make the connection paused */
1192 size_t tempwritesize; /* size of the 'tempwrite' allocated buffer */
1193 int tempwritetype; /* type of the 'tempwrite' buffer as a bitmask that is
1194 used with Curl_client_write() */
1195 char *scratch; /* huge buffer[BUFSIZE*2] when doing upload CRLF replacing */
1196 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
1197 This must be set to FALSE every time _easy_perform() is
1199 int os_errno; /* filled in with errno whenever an error occurs */
1201 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
1202 void (*prev_signal)(int sig);
1204 bool allow_port; /* Is set.use_port allowed to take effect or not. This
1205 is always set TRUE when curl_easy_perform() is called. */
1206 struct digestdata digest; /* state data for host Digest auth */
1207 struct digestdata proxydigest; /* state data for proxy Digest auth */
1209 #ifdef USE_HTTP_NEGOTIATE
1210 struct negotiatedata negotiate; /* state data for host Negotiate auth */
1211 struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */
1214 struct auth authhost; /* auth details for host */
1215 struct auth authproxy; /* auth details for proxy */
1217 bool authproblem; /* TRUE if there's some problem authenticating */
1219 void *resolver; /* resolver state, if it is used in the URL state -
1220 ares_channel f.e. */
1222 #if defined(USE_SSLEAY) && defined(HAVE_OPENSSL_ENGINE_H)
1224 #endif /* USE_SSLEAY */
1225 struct timeval expiretime; /* set this with Curl_expire() only */
1226 struct Curl_tree timenode; /* for the splay stuff */
1227 struct curl_llist *timeoutlist; /* list of pending timeouts */
1229 /* a place to store the most recently set FTP entrypath */
1230 char *most_recent_ftp_entrypath;
1232 /* set after initial USER failure, to prevent an authentication loop */
1233 bool ftp_trying_alternative;
1235 int httpversion; /* the lowest HTTP version*10 reported by any server
1236 involved in this request */
1237 bool expect100header; /* TRUE if we added Expect: 100-continue */
1239 bool pipe_broke; /* TRUE if the connection we were pipelined on broke
1240 and we need to restart from the beginning */
1242 #if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) && \
1243 !defined(__SYMBIAN32__)
1244 /* do FTP line-end conversions on most platforms */
1245 #define CURL_DO_LINEEND_CONV
1246 /* for FTP downloads: track CRLF sequences that span blocks */
1247 bool prev_block_had_trailing_cr;
1248 /* for FTP downloads: how many CRLFs did we converted to LFs? */
1249 curl_off_t crlf_conversions;
1251 char *pathbuffer;/* allocated buffer to store the URL's path part in */
1252 char *path; /* path to use, points to somewhere within the pathbuffer
1254 bool slash_removed; /* set TRUE if the 'path' points to a path where the
1255 initial URL slash separator has been taken off */
1257 bool rangestringalloc; /* the range string is malloc()'ed */
1259 char *range; /* range, if used. See README for detailed specification on
1261 curl_off_t resume_from; /* continue [ftp] transfer from here */
1263 /* This RTSP state information survives requests and connections */
1264 long rtsp_next_client_CSeq; /* the session's next client CSeq */
1265 long rtsp_next_server_CSeq; /* the session's next server CSeq */
1266 long rtsp_CSeq_recv; /* most recent CSeq received */
1268 /* Protocol specific data.
1270 *************************************************************************
1271 * Note that this data will be REMOVED after each request, so anything that
1272 * should be kept/stored on a per-connection basis and thus live for the
1273 * next request on the same connection MUST be put in the connectdata struct!
1274 *************************************************************************/
1277 struct HTTP *https; /* alias, just for the sake of being more readable */
1280 /* void *tftp; not used */
1281 struct FILEPROTO *file;
1282 void *telnet; /* private for telnet.c-eyes only */
1284 struct SSHPROTO *ssh;
1289 /* current user of this SessionHandle instance, or NULL */
1290 struct connectdata *current_conn;
1292 /* if true, force SSL connection retry (workaround for certain servers) */
1293 bool ssl_connect_retry;
1298 * This 'DynamicStatic' struct defines dynamic states that actually change
1299 * values in the 'UserDefined' area, which MUST be taken into consideration
1300 * if the UserDefined struct is cloned or similar. You can probably just
1301 * copy these, but each one indicate a special action on other data.
1304 struct DynamicStatic {
1305 char *url; /* work URL, copied from UserDefined */
1306 bool url_alloc; /* URL string is malloc()'ed */
1307 char *referer; /* referer string */
1308 bool referer_alloc; /* referer sting is malloc()ed */
1309 struct curl_slist *cookielist; /* list of cookie files set by
1310 curl_easy_setopt(COOKIEFILE) calls */
1311 struct curl_slist *resolve; /* set to point to the set.resolve list when
1312 this should be dealt with in pretransfer */
1316 * This 'UserDefined' struct must only contain data that is set once to go
1317 * for many (perhaps) independent connections. Values that are generated or
1318 * calculated internally for the "session handle" MUST be defined within the
1319 * 'struct UrlState' instead. The only exceptions MUST note the changes in
1320 * the 'DynamicStatic' struct.
1321 * Character pointer fields point to dynamic storage, unless otherwise stated.
1323 struct Curl_one_easy; /* declared and used only in multi.c */
1324 struct Curl_multi; /* declared and used only in multi.c */
1327 STRING_CERT, /* client certificate file name */
1328 STRING_CERT_TYPE, /* format for certificate (default: PEM)*/
1329 STRING_COOKIE, /* HTTP cookie string to send */
1330 STRING_COOKIEJAR, /* dump all cookies to this file */
1331 STRING_CUSTOMREQUEST, /* HTTP/FTP/RTSP request/method to use */
1332 STRING_DEVICE, /* local network interface/address to use */
1333 STRING_ENCODING, /* Accept-Encoding string */
1334 STRING_FTP_ACCOUNT, /* ftp account data */
1335 STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */
1336 STRING_FTPPORT, /* port to send with the FTP PORT command */
1337 STRING_KEY, /* private key file name */
1338 STRING_KEY_PASSWD, /* plain text private key password */
1339 STRING_KEY_TYPE, /* format for private key (default: PEM) */
1340 STRING_KRB_LEVEL, /* krb security level */
1341 STRING_NETRC_FILE, /* if not NULL, use this instead of trying to find
1343 STRING_COPYPOSTFIELDS, /* if POST, set the fields' values here */
1344 STRING_PROXY, /* proxy to use */
1345 STRING_SET_RANGE, /* range, if used */
1346 STRING_SET_REFERER, /* custom string for the HTTP referer field */
1347 STRING_SET_URL, /* what original URL to work on */
1348 STRING_SSL_CAPATH, /* CA directory name (doesn't work on windows) */
1349 STRING_SSL_CAFILE, /* certificate file to verify peer against */
1350 STRING_SSL_CIPHER_LIST, /* list of ciphers to use */
1351 STRING_SSL_EGDSOCKET, /* path to file containing the EGD daemon socket */
1352 STRING_SSL_RANDOM_FILE, /* path to file containing "random" data */
1353 STRING_USERAGENT, /* User-Agent string */
1354 STRING_SSL_CRLFILE, /* crl file to check certificate */
1355 STRING_SSL_ISSUERCERT, /* issuer cert file to check certificate */
1356 STRING_USERNAME, /* <username>, if used */
1357 STRING_PASSWORD, /* <password>, if used */
1358 STRING_PROXYUSERNAME, /* Proxy <username>, if used */
1359 STRING_PROXYPASSWORD, /* Proxy <password>, if used */
1360 STRING_NOPROXY, /* List of hosts which should not use the proxy, if
1362 STRING_RTSP_SESSION_ID, /* Session ID to use */
1363 STRING_RTSP_STREAM_URI, /* Stream URI for this request */
1364 STRING_RTSP_TRANSPORT, /* Transport for this session */
1366 STRING_SSH_PRIVATE_KEY, /* path to the private key file for auth */
1367 STRING_SSH_PUBLIC_KEY, /* path to the public key file for auth */
1368 STRING_SSH_HOST_PUBLIC_KEY_MD5, /* md5 of host public key in ascii hex */
1369 STRING_SSH_KNOWNHOSTS, /* file name of knownhosts file */
1371 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1372 STRING_SOCKS5_GSSAPI_SERVICE, /* GSSAPI service name */
1378 STRING_TLSAUTH_USERNAME, /* TLS auth <username> */
1379 STRING_TLSAUTH_PASSWORD, /* TLS auth <password> */
1382 /* -- end of strings -- */
1383 STRING_LAST /* not used, just an end-of-list marker */
1386 struct UserDefined {
1387 FILE *err; /* the stderr user data goes here */
1388 void *debugdata; /* the data that will be passed to fdebug */
1389 char *errorbuffer; /* (Static) store failure messages in here */
1390 long proxyport; /* If non-zero, use this port number by default. If the
1391 proxy string features a ":[port]" that one will override
1393 void *out; /* the fetched file goes here */
1394 void *in; /* the uploaded file is read from here */
1395 void *writeheader; /* write the header to this if non-NULL */
1396 void *rtp_out; /* write RTP to this if non-NULL */
1397 long use_port; /* which port to use (when not using default) */
1398 unsigned long httpauth; /* kind of HTTP authentication to use (bitmask) */
1399 unsigned long proxyauth; /* kind of proxy authentication to use (bitmask) */
1400 long followlocation; /* as in HTTP Location: */
1401 long maxredirs; /* maximum no. of http(s) redirects to follow, set to -1
1404 int keep_post; /* keep POSTs as POSTs after a 30x request; each
1405 bit represents a request, from 301 to 303 */
1406 bool free_referer; /* set TRUE if 'referer' points to a string we
1408 void *postfields; /* if POST, set the fields' values here */
1409 curl_seek_callback seek_func; /* function that seeks the input */
1410 curl_off_t postfieldsize; /* if POST, this might have a size to use instead
1411 of strlen(), and then the data *may* be binary
1412 (contain zero bytes) */
1413 unsigned short localport; /* local port number to bind to */
1414 int localportrange; /* number of additional port numbers to test in case the
1415 'localport' one can't be bind()ed */
1416 curl_write_callback fwrite_func; /* function that stores the output */
1417 curl_write_callback fwrite_header; /* function that stores headers */
1418 curl_write_callback fwrite_rtp; /* function that stores interleaved RTP */
1419 curl_read_callback fread_func; /* function that reads the input */
1420 int is_fread_set; /* boolean, has read callback been set to non-NULL? */
1421 int is_fwrite_set; /* boolean, has write callback been set to non-NULL? */
1422 curl_progress_callback fprogress; /* function for progress information */
1423 curl_debug_callback fdebug; /* function that write informational data */
1424 curl_ioctl_callback ioctl_func; /* function for I/O control */
1425 curl_sockopt_callback fsockopt; /* function for setting socket options */
1426 void *sockopt_client; /* pointer to pass to the socket options callback */
1427 curl_opensocket_callback fopensocket; /* function for checking/translating
1428 the address and opening the
1430 void* opensocket_client;
1431 curl_closesocket_callback fclosesocket; /* function for closing the
1433 void* closesocket_client;
1435 void *seek_client; /* pointer to pass to the seek callback */
1436 /* the 3 curl_conv_callback functions below are used on non-ASCII hosts */
1437 /* function to convert from the network encoding: */
1438 curl_conv_callback convfromnetwork;
1439 /* function to convert to the network encoding: */
1440 curl_conv_callback convtonetwork;
1441 /* function to convert from UTF-8 encoding: */
1442 curl_conv_callback convfromutf8;
1444 void *progress_client; /* pointer to pass to the progress callback */
1445 void *ioctl_client; /* pointer to pass to the ioctl callback */
1446 long timeout; /* in milliseconds, 0 means no timeout */
1447 long connecttimeout; /* in milliseconds, 0 means no timeout */
1448 long accepttimeout; /* in milliseconds, 0 means no timeout */
1449 long server_response_timeout; /* in milliseconds, 0 means no timeout */
1450 long tftp_blksize ; /* in bytes, 0 means use default */
1451 curl_off_t infilesize; /* size of file to upload, -1 means unknown */
1452 long low_speed_limit; /* bytes/second */
1453 long low_speed_time; /* number of seconds */
1454 curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */
1455 curl_off_t max_recv_speed; /* high speed limit in bytes/second for
1457 curl_off_t set_resume_from; /* continue [ftp] transfer from here */
1458 struct curl_slist *headers; /* linked list of extra headers */
1459 struct curl_httppost *httppost; /* linked list of POST data */
1460 bool cookiesession; /* new cookie session? */
1461 bool crlf; /* convert crlf on ftp upload(?) */
1462 struct curl_slist *quote; /* after connection is established */
1463 struct curl_slist *postquote; /* after the transfer */
1464 struct curl_slist *prequote; /* before the transfer, after type */
1465 struct curl_slist *source_quote; /* 3rd party quote */
1466 struct curl_slist *source_prequote; /* in 3rd party transfer mode - before
1467 the transfer on source host */
1468 struct curl_slist *source_postquote; /* in 3rd party transfer mode - after
1469 the transfer on source host */
1470 struct curl_slist *telnet_options; /* linked list of telnet options */
1471 struct curl_slist *resolve; /* list of names to add/remove from
1473 curl_TimeCond timecondition; /* kind of time/date comparison */
1474 time_t timevalue; /* what time to compare with */
1475 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
1476 long httpversion; /* when non-zero, a specific HTTP version requested to
1477 be used in the library's request(s) */
1478 struct ssl_config_data ssl; /* user defined SSL stuff */
1479 curl_proxytype proxytype; /* what kind of proxy that is in use */
1480 long dns_cache_timeout; /* DNS cache timeout */
1481 long buffer_size; /* size of receive buffer to use */
1482 void *private_data; /* application-private data */
1484 struct Curl_one_easy *one_easy; /* When adding an easy handle to a multi
1485 handle, an internal 'Curl_one_easy'
1486 struct is created and this is a pointer
1487 to the particular struct associated with
1488 this SessionHandle */
1490 struct curl_slist *http200aliases; /* linked list of aliases for http200 */
1492 long ipver; /* the CURL_IPRESOLVE_* defines in the public header file
1493 0 - whatever, 1 - v2, 2 - v6 */
1495 curl_off_t max_filesize; /* Maximum file size to download */
1497 curl_ftpfile ftp_filemethod; /* how to get to a file when FTP is used */
1499 int ftp_create_missing_dirs; /* 1 - create directories that don't exist
1500 2 - the same but also allow MKD to fail once
1503 curl_sshkeycallback ssh_keyfunc; /* key matching callback */
1504 void *ssh_keyfunc_userp; /* custom pointer to callback */
1506 /* Here follows boolean settings that define how to behave during
1507 this session. They are STATIC, set by libcurl users or at least initially
1508 and they don't change during operations. */
1510 bool printhost; /* printing host name in debug info */
1511 bool get_filetime; /* get the time and get of the remote file */
1512 bool tunnel_thru_httpproxy; /* use CONNECT through a HTTP proxy */
1513 bool prefer_ascii; /* ASCII rather than binary */
1514 bool ftp_append; /* append, not overwrite, on upload */
1515 bool ftp_list_only; /* switch FTP command for listing directories */
1516 bool ftp_use_port; /* use the FTP PORT command */
1517 bool hide_progress; /* don't use the progress meter */
1518 bool http_fail_on_error; /* fail on HTTP error codes >= 300 */
1519 bool http_follow_location; /* follow HTTP redirects */
1520 bool http_transfer_encoding; /* request compressed HTTP transfer-encoding */
1521 bool http_disable_hostname_check_before_authentication;
1522 bool include_header; /* include received protocol headers in data output */
1523 bool http_set_referer; /* is a custom referer used */
1524 bool http_auto_referer; /* set "correct" referer when following location: */
1525 bool opt_no_body; /* as set with CURLOPT_NOBODY */
1526 bool set_port; /* custom port number used */
1527 bool upload; /* upload request */
1528 enum CURL_NETRC_OPTION
1529 use_netrc; /* defined in include/curl.h */
1530 bool verbose; /* output verbosity */
1531 bool krb; /* kerberos connection requested */
1532 bool reuse_forbid; /* forbidden to be reused, close after use */
1533 bool reuse_fresh; /* do not re-use an existing connection */
1534 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
1535 bool ftp_use_eprt; /* if EPRT is to be attempted or not */
1536 bool ftp_use_pret; /* if PRET is to be used before PASV or not */
1538 curl_usessl use_ssl; /* if AUTH TLS is to be attempted etc, for FTP or
1539 IMAP or POP3 or others! */
1540 curl_ftpauth ftpsslauth; /* what AUTH XXX to be attempted */
1541 curl_ftpccc ftp_ccc; /* FTP CCC options */
1542 bool no_signal; /* do not use any signal/alarm handler */
1543 bool global_dns_cache; /* subject for future removal */
1544 bool tcp_nodelay; /* whether to enable TCP_NODELAY or not */
1545 bool ignorecl; /* ignore content length */
1546 bool ftp_skip_ip; /* skip the IP address the FTP server passes on to
1548 bool connect_only; /* make connection, let application use the socket */
1549 bool ssl_enable_beast; /* especially allow this flaw for interoperability's
1551 long ssh_auth_types; /* allowed SSH auth types */
1552 bool http_te_skip; /* pass the raw body data to the user, even when
1553 transfer-encoded (chunked, compressed) */
1554 bool http_ce_skip; /* pass the raw body data to the user, even when
1555 content-encoded (chunked, compressed) */
1556 long new_file_perms; /* Permissions to use when creating remote files */
1557 long new_directory_perms; /* Permissions to use when creating remote dirs */
1558 bool proxy_transfer_mode; /* set transfer mode (;type=<a|i>) when doing FTP
1559 via an HTTP proxy */
1560 char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */
1561 unsigned int scope; /* address scope for IPv6 */
1562 long allowed_protocols;
1563 long redir_protocols;
1564 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1565 long socks5_gssapi_nec; /* flag to support nec socks5 server */
1567 struct curl_slist *mail_rcpt; /* linked list of mail recipients */
1568 /* Common RTSP header options */
1569 Curl_RtspReq rtspreq; /* RTSP request type */
1570 long rtspversion; /* like httpversion, for RTSP */
1571 bool wildcardmatch; /* enable wildcard matching */
1572 curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer
1574 curl_chunk_end_callback chunk_end; /* called after part transferring
1576 curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds
1577 to pattern (e.g. if WILDCARDMATCH is on) */
1580 long gssapi_delegation; /* GSSAPI credential delegation, see the
1581 documentation of CURLOPT_GSSAPI_DELEGATION */
1583 bool tcp_keepalive; /* use TCP keepalives */
1584 long tcp_keepidle; /* seconds in idle before sending keepalive probe */
1585 long tcp_keepintvl; /* seconds between TCP keepalive probes */
1587 size_t maxconnects; /* Max idle connections in the connection cache */
1591 struct curl_hash *hostcache;
1593 HCACHE_NONE, /* not pointing to anything */
1594 HCACHE_GLOBAL, /* points to the (shrug) global one */
1595 HCACHE_MULTI, /* points to a shared one in the multi handle */
1596 HCACHE_SHARED /* points to a shared one in a shared object */
1601 * The 'connectdata' struct MUST have all the connection oriented stuff as we
1602 * may have several simultaneous connections and connection structs in memory.
1604 * The 'struct UserDefined' must only contain data that is set once to go for
1605 * many (perhaps) independent connections. Values that are generated or
1606 * calculated internally for the "session handle" must be defined within the
1607 * 'struct UrlState' instead.
1610 struct SessionHandle {
1612 struct Curl_multi *multi; /* if non-NULL, points to the multi handle
1613 struct to which this "belongs" when used by
1614 the multi interface */
1615 struct Curl_multi *multi_easy; /* if non-NULL, points to the multi handle
1616 struct to which this "belongs" when used
1617 by the easy interface */
1618 struct Curl_one_easy *multi_pos; /* if non-NULL, points to its position
1619 in multi controlling structure to assist
1621 struct Curl_share *share; /* Share, handles global variable mutexing */
1622 struct SingleRequest req; /* Request-specific data */
1623 struct UserDefined set; /* values set by the libcurl user */
1624 struct DynamicStatic change; /* possibly modified userdefined data */
1625 struct CookieInfo *cookies; /* the cookies, read from files and servers.
1626 NOTE that the 'cookie' field in the
1627 UserDefined struct defines if the "engine"
1628 is to be used or not. */
1629 struct Progress progress; /* for all the progress meter data */
1630 struct UrlState state; /* struct for fields used for state info and
1631 other dynamic purposes */
1632 struct WildcardData wildcard; /* wildcard download state info */
1633 struct PureInfo info; /* stats, reports and info data */
1634 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
1635 iconv_t outbound_cd; /* for translating to the network encoding */
1636 iconv_t inbound_cd; /* for translating from the network encoding */
1637 iconv_t utf8_cd; /* for translating to UTF8 */
1638 #endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */
1639 unsigned int magic; /* set to a CURLEASY_MAGIC_NUMBER */
1642 #define LIBCURL_NAME "libcurl"
1644 #endif /* HEADER_CURL_URLDATA_H */
projects / platform / upstream / curl.git / blob