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);
584 EXP100_SEND_DATA, /* enough waiting, just send the body now */
585 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */
586 EXP100_SENDING_REQUEST, /* still sending the request but will wait for
587 the 100 header once done with the request */
588 EXP100_FAILED /* used on 417 Expectation Failed */
592 UPGR101_INIT, /* default state */
593 UPGR101_REQUESTED, /* upgrade requested */
594 UPGR101_RECEIVED, /* response received */
595 UPGR101_WORKING /* talking upgraded protocol */
599 * Request specific data in the easy handle (SessionHandle). Previously,
600 * these members were on the connectdata struct but since a conn struct may
601 * now be shared between different SessionHandles, we store connection-specific
602 * data here. This struct only keeps stuff that's interesting for *this*
603 * request, as it will be cleared between multiple ones
605 struct SingleRequest {
606 curl_off_t size; /* -1 if unknown at this point */
607 curl_off_t *bytecountp; /* return number of bytes read or NULL */
609 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch,
610 -1 means unlimited */
611 curl_off_t *writebytecountp; /* return number of bytes written or NULL */
613 curl_off_t bytecount; /* total number of bytes read */
614 curl_off_t writebytecount; /* number of bytes written */
616 long headerbytecount; /* only count received headers */
617 long deductheadercount; /* this amount of bytes doesn't count when we check
618 if anything has been transferred at the end of a
619 connection. We use this counter to make only a
620 100 reply (without a following second response
621 code) result in a CURLE_GOT_NOTHING error code */
623 struct timeval start; /* transfer started at this time */
624 struct timeval now; /* current time */
625 bool header; /* incoming data has HTTP header */
627 HEADER_NORMAL, /* no bad header at all */
628 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest
630 HEADER_ALLBAD /* all was believed to be header */
631 } badheader; /* the header was deemed bad and will be
633 int headerline; /* counts header lines to better track the
635 char *hbufp; /* points at *end* of header line */
637 char *str; /* within buf */
638 char *str_start; /* within buf */
639 char *end_ptr; /* within buf */
640 char *p; /* within headerbuff */
641 bool content_range; /* set TRUE if Content-Range: was found */
642 curl_off_t offset; /* possible resume offset read from the
643 Content-Range: header */
644 int httpcode; /* error code from the 'HTTP/1.? XXX' or
645 'RTSP/1.? XXX' line */
646 struct timeval start100; /* time stamp to wait for the 100 code from */
647 enum expect100 exp100; /* expect 100 continue state */
648 enum upgrade101 upgr101; /* 101 upgrade state */
650 int auto_decoding; /* What content encoding. sec 3.5, RFC2616. */
652 #define IDENTITY 0 /* No encoding */
653 #define DEFLATE 1 /* zlib deflate [RFC 1950 & 1951] */
654 #define GZIP 2 /* gzip algorithm [RFC 1952] */
655 #define COMPRESS 3 /* Not handled, added for completeness */
658 zlibInitState zlib_init; /* possible zlib init state;
659 undefined if Content-Encoding header. */
660 z_stream z; /* State structure for zlib. */
672 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
673 and we're uploading the last chunk */
675 bool ignorebody; /* we read a response-body but we ignore it! */
676 bool ignorecl; /* This HTTP response has no body so we ignore the Content-
679 char *location; /* This points to an allocated version of the Location:
681 char *newurl; /* Set to the new URL to use when a redirect or a retry is
684 /* 'upload_present' is used to keep a byte counter of how much data there is
685 still left in the buffer, aimed for upload. */
686 ssize_t upload_present;
688 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
689 buffer, so the next read should read from where this pointer points to,
690 and the 'upload_present' contains the number of bytes available at this
692 char *upload_fromhere;
694 bool chunk; /* if set, this is a chunked transfer-encoding */
695 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
697 bool getheader; /* TRUE if header parsing is wanted */
699 bool forbidchunk; /* used only to explicitly forbid chunk-upload for
700 specific upload buffers. See readmoredata() in
701 http.c for details. */
703 void *protop; /* Allocated protocol-specific data. Each protocol
704 handler makes sure this points to data it needs. */
708 * Specific protocol handler.
711 struct Curl_handler {
712 const char * scheme; /* URL scheme name. */
714 /* Complement to setup_connection_internals(). */
715 CURLcode (*setup_connection)(struct connectdata *);
717 /* These two functions MUST be set to be protocol dependent */
718 CURLcode (*do_it)(struct connectdata *, bool *done);
721 /* If the curl_do() function is better made in two halves, this
722 * curl_do_more() function will be called afterwards, if set. For example
723 * for doing the FTP stuff after the PASV/PORT command.
725 Curl_do_more_func do_more;
727 /* This function *MAY* be set to a protocol-dependent function that is run
728 * after the connect() and everything is done, as a step in the connection.
729 * The 'done' pointer points to a bool that should be set to TRUE if the
730 * function completes before return. If it doesn't complete, the caller
731 * should call the curl_connecting() function until it is.
733 CURLcode (*connect_it)(struct connectdata *, bool *done);
735 /* See above. Currently only used for FTP. */
736 CURLcode (*connecting)(struct connectdata *, bool *done);
737 CURLcode (*doing)(struct connectdata *, bool *done);
739 /* Called from the multi interface during the PROTOCONNECT phase, and it
740 should then return a proper fd set */
741 int (*proto_getsock)(struct connectdata *conn,
742 curl_socket_t *socks,
745 /* Called from the multi interface during the DOING phase, and it should
746 then return a proper fd set */
747 int (*doing_getsock)(struct connectdata *conn,
748 curl_socket_t *socks,
751 /* Called from the multi interface during the DO_MORE phase, and it should
752 then return a proper fd set */
753 int (*domore_getsock)(struct connectdata *conn,
754 curl_socket_t *socks,
757 /* Called from the multi interface during the DO_DONE, PERFORM and
758 WAITPERFORM phases, and it should then return a proper fd set. Not setting
759 this will make libcurl use the generic default one. */
760 int (*perform_getsock)(const struct connectdata *conn,
761 curl_socket_t *socks,
764 /* This function *MAY* be set to a protocol-dependent function that is run
765 * by the curl_disconnect(), as a step in the disconnection. If the handler
766 * is called because the connection has been considered dead, dead_connection
769 CURLcode (*disconnect)(struct connectdata *, bool dead_connection);
771 /* If used, this function gets called from transfer.c:readwrite_data() to
772 allow the protocol to do extra reads/writes */
773 CURLcode (*readwrite)(struct SessionHandle *data, struct connectdata *conn,
774 ssize_t *nread, bool *readmore);
776 long defport; /* Default port. */
777 unsigned int protocol; /* See CURLPROTO_* */
778 unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */
781 #define PROTOPT_NONE 0 /* nothing extra */
782 #define PROTOPT_SSL (1<<0) /* uses SSL */
783 #define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */
784 #define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */
785 /* some protocols will have to call the underlying functions without regard to
786 what exact state the socket signals. IE even if the socket says "readable",
787 the send function might need to be called while uploading, or vice versa.
789 #define PROTOPT_DIRLOCK (1<<3)
790 #define PROTOPT_NONETWORK (1<<4) /* protocol doesn't use the network! */
791 #define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it
793 #define PROTOPT_NOURLQUERY (1<<6) /* protocol can't handle
794 url query strings (?foo=bar) ! */
797 /* return the count of bytes sent, or -1 on error */
798 typedef ssize_t (Curl_send)(struct connectdata *conn, /* connection data */
799 int sockindex, /* socketindex */
800 const void *buf, /* data to write */
801 size_t len, /* max amount to write */
802 CURLcode *err); /* error to return */
804 /* return the count of bytes read, or -1 on error */
805 typedef ssize_t (Curl_recv)(struct connectdata *conn, /* connection data */
806 int sockindex, /* socketindex */
807 char *buf, /* store data here */
808 size_t len, /* max amount to read */
809 CURLcode *err); /* error to return */
812 * The connectdata struct contains all fields and variables that should be
813 * unique for an entire connection.
816 /* 'data' is the CURRENT SessionHandle using this connection -- take great
817 caution that this might very well vary between different times this
818 connection is used! */
819 struct SessionHandle *data;
821 /* chunk is for HTTP chunked encoding, but is in the general connectdata
822 struct only because we can do just about any protocol through a HTTP proxy
823 and a HTTP proxy may in fact respond using chunked encoding */
824 struct Curl_chunker chunk;
826 curl_closesocket_callback fclosesocket; /* function closing the socket(s) */
827 void *closesocket_client;
829 bool inuse; /* This is a marker for the connection cache logic. If this is
830 TRUE this handle is being used by an easy handle and cannot
831 be used by any other easy handle without careful
832 consideration (== only for pipelining). */
834 /**** Fields set when inited and not modified again */
835 long connection_id; /* Contains a unique number to make it easier to
836 track the connections in the log output */
838 /* 'dns_entry' is the particular host we use. This points to an entry in the
839 DNS cache and it will not get pruned while locked. It gets unlocked in
840 Curl_done(). This entry will be NULL if the connection is re-used as then
841 there is no name resolve done. */
842 struct Curl_dns_entry *dns_entry;
844 /* 'ip_addr' is the particular IP we connected to. It points to a struct
845 within the DNS cache, so this pointer is only valid as long as the DNS
846 cache entry remains locked. It gets unlocked in Curl_done() */
847 Curl_addrinfo *ip_addr;
848 Curl_addrinfo *tempaddr[2]; /* for happy eyeballs */
850 /* 'ip_addr_str' is the ip_addr data as a human readable string.
851 It remains available as long as the connection does, which is longer than
852 the ip_addr itself. */
853 char ip_addr_str[MAX_IPADR_LEN];
855 unsigned int scope; /* address scope for IPv6 */
857 int socktype; /* SOCK_STREAM or SOCK_DGRAM */
859 struct hostname host;
860 struct hostname proxy;
862 long port; /* which port to use locally */
863 unsigned short remote_port; /* what remote port to connect to,
864 not the proxy port! */
866 /* 'primary_ip' and 'primary_port' get filled with peer's numerical
867 ip address and port number whenever an outgoing connection is
868 *attempted* from the primary socket to a remote address. When more
869 than one address is tried for a connection these will hold data
870 for the last attempt. When the connection is actually established
871 these are updated with data which comes directly from the socket. */
873 char primary_ip[MAX_IPADR_LEN];
876 /* 'local_ip' and 'local_port' get filled with local's numerical
877 ip address and port number whenever an outgoing connection is
878 **established** from the primary socket to a remote address. */
880 char local_ip[MAX_IPADR_LEN];
883 char *user; /* user name string, allocated */
884 char *passwd; /* password string, allocated */
885 char *options; /* options string, allocated */
887 char *xoauth2_bearer; /* bearer token for xoauth2, allocated */
889 char *proxyuser; /* proxy user name string, allocated */
890 char *proxypasswd; /* proxy password string, allocated */
891 curl_proxytype proxytype; /* what kind of proxy that is in use */
893 int httpversion; /* the HTTP version*10 reported by the server */
894 int rtspversion; /* the RTSP version*10 reported by the server */
896 struct timeval now; /* "current" time */
897 struct timeval created; /* creation time */
898 curl_socket_t sock[2]; /* two sockets, the second is used for the data
899 transfer when doing FTP */
900 curl_socket_t tempsock[2]; /* temporary sockets for happy eyeballs */
901 bool sock_accepted[2]; /* TRUE if the socket on this index was created with
906 struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */
907 struct ssl_config_data ssl_config;
909 struct ConnectBits bits; /* various state-flags for this connection */
911 /* connecttime: when connect() is called on the current IP address. Used to
912 be able to track when to move on to try next IP - but only when the multi
913 interface is used. */
914 struct timeval connecttime;
915 /* The two fields below get set in Curl_connecthost */
916 int num_addr; /* number of addresses to try to connect to */
917 long timeoutms_per_addr; /* how long time in milliseconds to spend on
918 trying to connect to each IP address */
920 const struct Curl_handler *handler; /* Connection's protocol handler */
921 const struct Curl_handler *given; /* The protocol first given */
923 long ip_version; /* copied from the SessionHandle at creation time */
925 /**** curl_get() phase fields */
927 curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */
928 curl_socket_t writesockfd; /* socket to write to, it may very
929 well be the same we read from.
930 CURL_SOCKET_BAD disables */
932 /** Dynamicly allocated strings, MUST be freed before this **/
933 /** struct is killed. **/
934 struct dynamically_allocated_data {
937 char *accept_encoding;
943 char *rtsp_transport;
944 char *te; /* TE: request header */
947 int sec_complete; /* if kerberos is enabled for this connection */
949 enum protection_level command_prot;
950 enum protection_level data_prot;
951 enum protection_level request_data_prot;
953 struct krb5buffer in_buffer;
955 const struct Curl_sec_client_mech *mech;
956 struct sockaddr_in local_addr;
959 /* the two following *_inuse fields are only flags, not counters in any way.
960 If TRUE it means the channel is in use, and if FALSE it means the channel
961 is up for grabs by one. */
963 bool readchannel_inuse; /* whether the read channel is in use by an easy
965 bool writechannel_inuse; /* whether the write channel is in use by an easy
967 struct curl_llist *send_pipe; /* List of handles waiting to
968 send on this pipeline */
969 struct curl_llist *recv_pipe; /* List of handles waiting to read
970 their responses on this pipeline */
971 char* master_buffer; /* The master buffer allocated on-demand;
972 used for pipelining. */
973 size_t read_pos; /* Current read position in the master buffer */
974 size_t buf_len; /* Length of the buffer?? */
977 curl_seek_callback seek_func; /* function that seeks the input */
978 void *seek_client; /* pointer to pass to the seek() above */
980 /*************** Request - specific items ************/
982 /* previously this was in the urldata struct */
983 curl_read_callback fread_func; /* function that reads the input */
984 void *fread_in; /* pointer to pass to the fread() above */
986 struct ntlmdata ntlm; /* NTLM differs from other authentication schemes
987 because it authenticates connections, not
989 struct ntlmdata proxyntlm; /* NTLM data for proxy */
991 #if defined(USE_NTLM) && defined(NTLM_WB_ENABLED)
992 /* used for communication with Samba's winbind daemon helper ntlm_auth */
993 curl_socket_t ntlm_auth_hlpr_socket;
994 pid_t ntlm_auth_hlpr_pid;
995 char* challenge_header;
996 char* response_header;
999 char syserr_buf [256]; /* buffer for Curl_strerror() */
1001 #ifdef CURLRES_ASYNCH
1002 /* data used for the asynch name resolve callback */
1003 struct Curl_async async;
1006 /* These three are used for chunked-encoding trailer support */
1007 char *trailer; /* allocated buffer to store trailer in */
1008 int trlMax; /* allocated buffer size */
1009 int trlPos; /* index of where to store data */
1012 struct ftp_conn ftpc;
1013 struct http_conn httpc;
1014 struct ssh_conn sshc;
1015 struct tftp_state_data *tftpc;
1016 struct imap_conn imapc;
1017 struct pop3_conn pop3c;
1018 struct smtp_conn smtpc;
1019 struct rtsp_conn rtspc;
1020 void *generic; /* RTMP and LDAP use this */
1023 int cselect_bits; /* bitmask of socket events */
1024 int waitfor; /* current READ/WRITE bits to wait for */
1026 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1027 int socks5_gssapi_enctype;
1033 /* When this connection is created, store the conditions for the local end
1034 bind. This is stored before the actual bind and before any connection is
1035 made and will serve the purpose of being used for comparison reasons so
1036 that subsequent bound-requested connections aren't accidentally re-using
1037 wrong connections. */
1039 unsigned short localport;
1042 /* tunnel as in tunnel through a HTTP proxy with CONNECT */
1044 TUNNEL_INIT, /* init/default/no tunnel state */
1045 TUNNEL_CONNECT, /* CONNECT has been sent off */
1046 TUNNEL_COMPLETE /* CONNECT response received completely */
1047 } tunnel_state[2]; /* two separate ones to allow FTP */
1048 struct connectbundle *bundle; /* The bundle we are member of */
1051 /* The end of connectdata. */
1054 * Struct to keep statistical and informational data.
1057 int httpcode; /* Recent HTTP, FTP, or RTSP response code */
1058 int httpproxycode; /* response code from proxy when received separate */
1059 int httpversion; /* the http version number X.Y = X*10+Y */
1060 long filetime; /* If requested, this is might get set. Set to -1 if the time
1061 was unretrievable. We cannot have this of type time_t,
1062 since time_t is unsigned on several platforms such as
1064 bool timecond; /* set to TRUE if the time condition didn't match, which
1065 thus made the document NOT get fetched */
1066 long header_size; /* size of read header(s) in bytes */
1067 long request_size; /* the amount of bytes sent in the request(s) */
1068 unsigned long proxyauthavail; /* what proxy auth types were announced */
1069 unsigned long httpauthavail; /* what host auth types were announced */
1070 long numconnects; /* how many new connection did libcurl created */
1071 char *contenttype; /* the content type of the object */
1072 char *wouldredirect; /* URL this would've been redirected to if asked to */
1074 /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip'
1075 and, 'conn_local_port' are copied over from the connectdata struct in
1076 order to allow curl_easy_getinfo() to return this information even when
1077 the session handle is no longer associated with a connection, and also
1078 allow curl_easy_reset() to clear this information from the session handle
1079 without disturbing information which is still alive, and that might be
1080 reused, in the connection cache. */
1082 char conn_primary_ip[MAX_IPADR_LEN];
1083 long conn_primary_port;
1085 char conn_local_ip[MAX_IPADR_LEN];
1086 long conn_local_port;
1088 struct curl_certinfo certs; /* info about the certs, only populated in
1089 OpenSSL builds. Asked for with
1090 CURLOPT_CERTINFO / CURLINFO_CERTINFO */
1095 long lastshow; /* time() of the last displayed progress meter or NULL to
1096 force redraw at next call */
1097 curl_off_t size_dl; /* total expected size */
1098 curl_off_t size_ul; /* total expected size */
1099 curl_off_t downloaded; /* transferred so far */
1100 curl_off_t uploaded; /* transferred so far */
1102 curl_off_t current_speed; /* uses the currently fastest transfer */
1104 bool callback; /* set when progress callback is used */
1105 int width; /* screen width at download start */
1106 int flags; /* see progress.h */
1115 double t_appconnect;
1116 double t_pretransfer;
1117 double t_starttransfer;
1120 struct timeval start;
1121 struct timeval t_startsingle;
1122 struct timeval t_acceptdata;
1123 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
1125 curl_off_t speeder[ CURR_TIME ];
1126 struct timeval speeder_time[ CURR_TIME ];
1131 HTTPREQ_NONE, /* first in list */
1134 HTTPREQ_POST_FORM, /* we make a difference internally */
1138 HTTPREQ_LAST /* last in list */
1142 RTSPREQ_NONE, /* first in list */
1150 RTSPREQ_GET_PARAMETER,
1151 RTSPREQ_SET_PARAMETER,
1154 RTSPREQ_LAST /* last in list */
1158 * Values that are generated, temporary or calculated internally for a
1159 * "session handle" must be defined within the 'struct UrlState'. This struct
1160 * will be used within the SessionHandle struct. When the 'SessionHandle'
1161 * struct is cloned, this data MUST NOT be copied.
1163 * Remember that any "state" information goes globally for the curl handle.
1164 * Session-data MUST be put in the connectdata struct and here. */
1165 #define MAX_CURL_USER_LENGTH 256
1166 #define MAX_CURL_PASSWORD_LENGTH 256
1169 unsigned long want; /* Bitmask set to the authentication methods wanted by
1170 app (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */
1171 unsigned long picked;
1172 unsigned long avail; /* Bitmask for what the server reports to support for
1174 bool done; /* TRUE when the auth phase is done and ready to do the *actual*
1176 bool multi; /* TRUE if this is not yet authenticated but within the auth
1177 multipass negotiation */
1178 bool iestyle; /* TRUE if digest should be done IE-style or FALSE if it should
1184 /* Points to the connection cache */
1185 struct conncache *conn_cache;
1187 /* when curl_easy_perform() is called, the multi handle is "owned" by
1188 the easy handle so curl_easy_cleanup() on such an easy handle will
1189 also close the multi handle! */
1190 bool multi_owned_by_easy;
1192 /* buffers to store authentication data in, as parsed from input options */
1193 struct timeval keeps_speed; /* for the progress meter really */
1195 struct connectdata *lastconnect; /* The last connection, NULL if undefined */
1197 char *headerbuff; /* allocated buffer to store headers in */
1198 size_t headersize; /* size of the allocation */
1200 char buffer[BUFSIZE+1]; /* download buffer */
1201 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
1202 curl_off_t current_speed; /* the ProgressShow() funcion sets this,
1204 bool this_is_a_follow; /* this is a followed Location: request */
1206 char *first_host; /* if set, this should be the host name that we will
1207 sent authorization to, no else. Used to make Location:
1208 following not keep sending user+password... This is
1211 struct curl_ssl_session *session; /* array of 'max_ssl_sessions' size */
1212 long sessionage; /* number of the most recent session */
1213 char *tempwrite; /* allocated buffer to keep data in when a write
1214 callback returns to make the connection paused */
1215 size_t tempwritesize; /* size of the 'tempwrite' allocated buffer */
1216 int tempwritetype; /* type of the 'tempwrite' buffer as a bitmask that is
1217 used with Curl_client_write() */
1218 char *scratch; /* huge buffer[BUFSIZE*2] when doing upload CRLF replacing */
1219 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
1220 This must be set to FALSE every time _easy_perform() is
1222 int os_errno; /* filled in with errno whenever an error occurs */
1224 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
1225 void (*prev_signal)(int sig);
1227 bool allow_port; /* Is set.use_port allowed to take effect or not. This
1228 is always set TRUE when curl_easy_perform() is called. */
1229 struct digestdata digest; /* state data for host Digest auth */
1230 struct digestdata proxydigest; /* state data for proxy Digest auth */
1232 #ifdef USE_HTTP_NEGOTIATE
1233 struct negotiatedata negotiate; /* state data for host Negotiate auth */
1234 struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */
1237 struct auth authhost; /* auth details for host */
1238 struct auth authproxy; /* auth details for proxy */
1240 bool authproblem; /* TRUE if there's some problem authenticating */
1242 void *resolver; /* resolver state, if it is used in the URL state -
1243 ares_channel f.e. */
1245 #if defined(USE_SSLEAY) && defined(HAVE_OPENSSL_ENGINE_H)
1247 #endif /* USE_SSLEAY */
1248 struct timeval expiretime; /* set this with Curl_expire() only */
1249 struct Curl_tree timenode; /* for the splay stuff */
1250 struct curl_llist *timeoutlist; /* list of pending timeouts */
1252 /* a place to store the most recently set FTP entrypath */
1253 char *most_recent_ftp_entrypath;
1255 /* set after initial USER failure, to prevent an authentication loop */
1256 bool ftp_trying_alternative;
1258 int httpversion; /* the lowest HTTP version*10 reported by any server
1259 involved in this request */
1260 bool expect100header; /* TRUE if we added Expect: 100-continue */
1262 bool pipe_broke; /* TRUE if the connection we were pipelined on broke
1263 and we need to restart from the beginning */
1265 #if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) && \
1266 !defined(__SYMBIAN32__)
1267 /* do FTP line-end conversions on most platforms */
1268 #define CURL_DO_LINEEND_CONV
1269 /* for FTP downloads: track CRLF sequences that span blocks */
1270 bool prev_block_had_trailing_cr;
1271 /* for FTP downloads: how many CRLFs did we converted to LFs? */
1272 curl_off_t crlf_conversions;
1274 char *pathbuffer;/* allocated buffer to store the URL's path part in */
1275 char *path; /* path to use, points to somewhere within the pathbuffer
1277 bool slash_removed; /* set TRUE if the 'path' points to a path where the
1278 initial URL slash separator has been taken off */
1280 bool rangestringalloc; /* the range string is malloc()'ed */
1282 char *range; /* range, if used. See README for detailed specification on
1284 curl_off_t resume_from; /* continue [ftp] transfer from here */
1286 /* This RTSP state information survives requests and connections */
1287 long rtsp_next_client_CSeq; /* the session's next client CSeq */
1288 long rtsp_next_server_CSeq; /* the session's next server CSeq */
1289 long rtsp_CSeq_recv; /* most recent CSeq received */
1291 /* if true, force SSL connection retry (workaround for certain servers) */
1292 bool ssl_connect_retry;
1297 * This 'DynamicStatic' struct defines dynamic states that actually change
1298 * values in the 'UserDefined' area, which MUST be taken into consideration
1299 * if the UserDefined struct is cloned or similar. You can probably just
1300 * copy these, but each one indicate a special action on other data.
1303 struct DynamicStatic {
1304 char *url; /* work URL, copied from UserDefined */
1305 bool url_alloc; /* URL string is malloc()'ed */
1306 char *referer; /* referer string */
1307 bool referer_alloc; /* referer sting is malloc()ed */
1308 struct curl_slist *cookielist; /* list of cookie files set by
1309 curl_easy_setopt(COOKIEFILE) calls */
1310 struct curl_slist *resolve; /* set to point to the set.resolve list when
1311 this should be dealt with in pretransfer */
1315 * This 'UserDefined' struct must only contain data that is set once to go
1316 * for many (perhaps) independent connections. Values that are generated or
1317 * calculated internally for the "session handle" MUST be defined within the
1318 * 'struct UrlState' instead. The only exceptions MUST note the changes in
1319 * the 'DynamicStatic' struct.
1320 * Character pointer fields point to dynamic storage, unless otherwise stated.
1323 struct Curl_multi; /* declared and used only in multi.c */
1326 STRING_CERT, /* client certificate file name */
1327 STRING_CERT_TYPE, /* format for certificate (default: PEM)*/
1328 STRING_COOKIE, /* HTTP cookie string to send */
1329 STRING_COOKIEJAR, /* dump all cookies to this file */
1330 STRING_CUSTOMREQUEST, /* HTTP/FTP/RTSP request/method to use */
1331 STRING_DEVICE, /* local network interface/address to use */
1332 STRING_ENCODING, /* Accept-Encoding string */
1333 STRING_FTP_ACCOUNT, /* ftp account data */
1334 STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */
1335 STRING_FTPPORT, /* port to send with the FTP PORT command */
1336 STRING_KEY, /* private key file name */
1337 STRING_KEY_PASSWD, /* plain text private key password */
1338 STRING_KEY_TYPE, /* format for private key (default: PEM) */
1339 STRING_KRB_LEVEL, /* krb security level */
1340 STRING_NETRC_FILE, /* if not NULL, use this instead of trying to find
1342 STRING_COPYPOSTFIELDS, /* if POST, set the fields' values here */
1343 STRING_PROXY, /* proxy to use */
1344 STRING_SET_RANGE, /* range, if used */
1345 STRING_SET_REFERER, /* custom string for the HTTP referer field */
1346 STRING_SET_URL, /* what original URL to work on */
1347 STRING_SSL_CAPATH, /* CA directory name (doesn't work on windows) */
1348 STRING_SSL_CAFILE, /* certificate file to verify peer against */
1349 STRING_SSL_CIPHER_LIST, /* list of ciphers to use */
1350 STRING_SSL_EGDSOCKET, /* path to file containing the EGD daemon socket */
1351 STRING_SSL_RANDOM_FILE, /* path to file containing "random" data */
1352 STRING_USERAGENT, /* User-Agent string */
1353 STRING_SSL_CRLFILE, /* crl file to check certificate */
1354 STRING_SSL_ISSUERCERT, /* issuer cert file to check certificate */
1355 STRING_USERNAME, /* <username>, if used */
1356 STRING_PASSWORD, /* <password>, if used */
1357 STRING_OPTIONS, /* <options>, 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 STRING_BEARER, /* <bearer>, if used */
1384 /* -- end of strings -- */
1385 STRING_LAST /* not used, just an end-of-list marker */
1388 struct UserDefined {
1389 FILE *err; /* the stderr user data goes here */
1390 void *debugdata; /* the data that will be passed to fdebug */
1391 char *errorbuffer; /* (Static) store failure messages in here */
1392 long proxyport; /* If non-zero, use this port number by default. If the
1393 proxy string features a ":[port]" that one will override
1395 void *out; /* the fetched file goes here */
1396 void *in; /* the uploaded file is read from here */
1397 void *writeheader; /* write the header to this if non-NULL */
1398 void *rtp_out; /* write RTP to this if non-NULL */
1399 long use_port; /* which port to use (when not using default) */
1400 unsigned long httpauth; /* kind of HTTP authentication to use (bitmask) */
1401 unsigned long proxyauth; /* kind of proxy authentication to use (bitmask) */
1402 long followlocation; /* as in HTTP Location: */
1403 long maxredirs; /* maximum no. of http(s) redirects to follow, set to -1
1406 int keep_post; /* keep POSTs as POSTs after a 30x request; each
1407 bit represents a request, from 301 to 303 */
1408 bool free_referer; /* set TRUE if 'referer' points to a string we
1410 void *postfields; /* if POST, set the fields' values here */
1411 curl_seek_callback seek_func; /* function that seeks the input */
1412 curl_off_t postfieldsize; /* if POST, this might have a size to use instead
1413 of strlen(), and then the data *may* be binary
1414 (contain zero bytes) */
1415 unsigned short localport; /* local port number to bind to */
1416 int localportrange; /* number of additional port numbers to test in case the
1417 'localport' one can't be bind()ed */
1418 curl_write_callback fwrite_func; /* function that stores the output */
1419 curl_write_callback fwrite_header; /* function that stores headers */
1420 curl_write_callback fwrite_rtp; /* function that stores interleaved RTP */
1421 curl_read_callback fread_func; /* function that reads the input */
1422 int is_fread_set; /* boolean, has read callback been set to non-NULL? */
1423 int is_fwrite_set; /* boolean, has write callback been set to non-NULL? */
1424 curl_progress_callback fprogress; /* OLD and deprecated progress callback */
1425 curl_xferinfo_callback fxferinfo; /* progress callback */
1426 curl_debug_callback fdebug; /* function that write informational data */
1427 curl_ioctl_callback ioctl_func; /* function for I/O control */
1428 curl_sockopt_callback fsockopt; /* function for setting socket options */
1429 void *sockopt_client; /* pointer to pass to the socket options callback */
1430 curl_opensocket_callback fopensocket; /* function for checking/translating
1431 the address and opening the
1433 void* opensocket_client;
1434 curl_closesocket_callback fclosesocket; /* function for closing the
1436 void* closesocket_client;
1438 void *seek_client; /* pointer to pass to the seek callback */
1439 /* the 3 curl_conv_callback functions below are used on non-ASCII hosts */
1440 /* function to convert from the network encoding: */
1441 curl_conv_callback convfromnetwork;
1442 /* function to convert to the network encoding: */
1443 curl_conv_callback convtonetwork;
1444 /* function to convert from UTF-8 encoding: */
1445 curl_conv_callback convfromutf8;
1447 void *progress_client; /* pointer to pass to the progress callback */
1448 void *ioctl_client; /* pointer to pass to the ioctl callback */
1449 long timeout; /* in milliseconds, 0 means no timeout */
1450 long connecttimeout; /* in milliseconds, 0 means no timeout */
1451 long accepttimeout; /* in milliseconds, 0 means no timeout */
1452 long server_response_timeout; /* in milliseconds, 0 means no timeout */
1453 long tftp_blksize ; /* in bytes, 0 means use default */
1454 curl_off_t infilesize; /* size of file to upload, -1 means unknown */
1455 long low_speed_limit; /* bytes/second */
1456 long low_speed_time; /* number of seconds */
1457 curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */
1458 curl_off_t max_recv_speed; /* high speed limit in bytes/second for
1460 curl_off_t set_resume_from; /* continue [ftp] transfer from here */
1461 struct curl_slist *headers; /* linked list of extra headers */
1462 struct curl_httppost *httppost; /* linked list of POST data */
1463 bool cookiesession; /* new cookie session? */
1464 bool crlf; /* convert crlf on ftp upload(?) */
1465 struct curl_slist *quote; /* after connection is established */
1466 struct curl_slist *postquote; /* after the transfer */
1467 struct curl_slist *prequote; /* before the transfer, after type */
1468 struct curl_slist *source_quote; /* 3rd party quote */
1469 struct curl_slist *source_prequote; /* in 3rd party transfer mode - before
1470 the transfer on source host */
1471 struct curl_slist *source_postquote; /* in 3rd party transfer mode - after
1472 the transfer on source host */
1473 struct curl_slist *telnet_options; /* linked list of telnet options */
1474 struct curl_slist *resolve; /* list of names to add/remove from
1476 curl_TimeCond timecondition; /* kind of time/date comparison */
1477 time_t timevalue; /* what time to compare with */
1478 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
1479 long httpversion; /* when non-zero, a specific HTTP version requested to
1480 be used in the library's request(s) */
1481 struct ssl_config_data ssl; /* user defined SSL stuff */
1482 curl_proxytype proxytype; /* what kind of proxy that is in use */
1483 long dns_cache_timeout; /* DNS cache timeout */
1484 long buffer_size; /* size of receive buffer to use */
1485 void *private_data; /* application-private data */
1487 struct curl_slist *http200aliases; /* linked list of aliases for http200 */
1489 long ipver; /* the CURL_IPRESOLVE_* defines in the public header file
1490 0 - whatever, 1 - v2, 2 - v6 */
1492 curl_off_t max_filesize; /* Maximum file size to download */
1494 curl_ftpfile ftp_filemethod; /* how to get to a file when FTP is used */
1496 int ftp_create_missing_dirs; /* 1 - create directories that don't exist
1497 2 - the same but also allow MKD to fail once
1500 curl_sshkeycallback ssh_keyfunc; /* key matching callback */
1501 void *ssh_keyfunc_userp; /* custom pointer to callback */
1503 /* Here follows boolean settings that define how to behave during
1504 this session. They are STATIC, set by libcurl users or at least initially
1505 and they don't change during operations. */
1507 bool printhost; /* printing host name in debug info */
1508 bool get_filetime; /* get the time and get of the remote file */
1509 bool tunnel_thru_httpproxy; /* use CONNECT through a HTTP proxy */
1510 bool prefer_ascii; /* ASCII rather than binary */
1511 bool ftp_append; /* append, not overwrite, on upload */
1512 bool ftp_list_only; /* switch FTP command for listing directories */
1513 bool ftp_use_port; /* use the FTP PORT command */
1514 bool hide_progress; /* don't use the progress meter */
1515 bool http_fail_on_error; /* fail on HTTP error codes >= 300 */
1516 bool http_follow_location; /* follow HTTP redirects */
1517 bool http_transfer_encoding; /* request compressed HTTP transfer-encoding */
1518 bool http_disable_hostname_check_before_authentication;
1519 bool include_header; /* include received protocol headers in data output */
1520 bool http_set_referer; /* is a custom referer used */
1521 bool http_auto_referer; /* set "correct" referer when following location: */
1522 bool opt_no_body; /* as set with CURLOPT_NOBODY */
1523 bool set_port; /* custom port number used */
1524 bool upload; /* upload request */
1525 enum CURL_NETRC_OPTION
1526 use_netrc; /* defined in include/curl.h */
1527 bool verbose; /* output verbosity */
1528 bool krb; /* kerberos connection requested */
1529 bool reuse_forbid; /* forbidden to be reused, close after use */
1530 bool reuse_fresh; /* do not re-use an existing connection */
1531 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
1532 bool ftp_use_eprt; /* if EPRT is to be attempted or not */
1533 bool ftp_use_pret; /* if PRET is to be used before PASV or not */
1535 curl_usessl use_ssl; /* if AUTH TLS is to be attempted etc, for FTP or
1536 IMAP or POP3 or others! */
1537 curl_ftpauth ftpsslauth; /* what AUTH XXX to be attempted */
1538 curl_ftpccc ftp_ccc; /* FTP CCC options */
1539 bool no_signal; /* do not use any signal/alarm handler */
1540 bool global_dns_cache; /* subject for future removal */
1541 bool tcp_nodelay; /* whether to enable TCP_NODELAY or not */
1542 bool ignorecl; /* ignore content length */
1543 bool ftp_skip_ip; /* skip the IP address the FTP server passes on to
1545 bool connect_only; /* make connection, let application use the socket */
1546 bool ssl_enable_beast; /* especially allow this flaw for interoperability's
1548 long ssh_auth_types; /* allowed SSH auth types */
1549 bool http_te_skip; /* pass the raw body data to the user, even when
1550 transfer-encoded (chunked, compressed) */
1551 bool http_ce_skip; /* pass the raw body data to the user, even when
1552 content-encoded (chunked, compressed) */
1553 long new_file_perms; /* Permissions to use when creating remote files */
1554 long new_directory_perms; /* Permissions to use when creating remote dirs */
1555 bool proxy_transfer_mode; /* set transfer mode (;type=<a|i>) when doing FTP
1556 via an HTTP proxy */
1557 char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */
1558 unsigned int scope; /* address scope for IPv6 */
1559 long allowed_protocols;
1560 long redir_protocols;
1561 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1562 long socks5_gssapi_nec; /* flag to support nec socks5 server */
1564 struct curl_slist *mail_rcpt; /* linked list of mail recipients */
1565 bool sasl_ir; /* Enable/disable SASL initial response */
1566 /* Common RTSP header options */
1567 Curl_RtspReq rtspreq; /* RTSP request type */
1568 long rtspversion; /* like httpversion, for RTSP */
1569 bool wildcardmatch; /* enable wildcard matching */
1570 curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer
1572 curl_chunk_end_callback chunk_end; /* called after part transferring
1574 curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds
1575 to pattern (e.g. if WILDCARDMATCH is on) */
1578 long gssapi_delegation; /* GSSAPI credential delegation, see the
1579 documentation of CURLOPT_GSSAPI_DELEGATION */
1581 bool tcp_keepalive; /* use TCP keepalives */
1582 long tcp_keepidle; /* seconds in idle before sending keepalive probe */
1583 long tcp_keepintvl; /* seconds between TCP keepalive probes */
1585 size_t maxconnects; /* Max idle connections in the connection cache */
1589 struct curl_hash *hostcache;
1591 HCACHE_NONE, /* not pointing to anything */
1592 HCACHE_GLOBAL, /* points to the (shrug) global one */
1593 HCACHE_MULTI, /* points to a shared one in the multi handle */
1594 HCACHE_SHARED /* points to a shared one in a shared object */
1599 * The 'connectdata' struct MUST have all the connection oriented stuff as we
1600 * may have several simultaneous connections and connection structs in memory.
1602 * The 'struct UserDefined' must only contain data that is set once to go for
1603 * many (perhaps) independent connections. Values that are generated or
1604 * calculated internally for the "session handle" must be defined within the
1605 * 'struct UrlState' instead.
1608 struct SessionHandle {
1609 /* first, two fields for the linked list of these */
1610 struct SessionHandle *next;
1611 struct SessionHandle *prev;
1613 struct connectdata *easy_conn; /* the "unit's" connection */
1615 CURLMstate mstate; /* the handle's state */
1616 CURLcode result; /* previous result */
1618 struct Curl_message msg; /* A single posted message. */
1620 /* Array with the plain socket numbers this handle takes care of, in no
1621 particular order. Note that all sockets are added to the sockhash, where
1622 the state etc are also kept. This array is mostly used to detect when a
1623 socket is to be removed from the hash. See singlesocket(). */
1624 curl_socket_t sockets[MAX_SOCKSPEREASYHANDLE];
1628 struct Curl_multi *multi; /* if non-NULL, points to the multi handle
1629 struct to which this "belongs" when used by
1630 the multi interface */
1631 struct Curl_multi *multi_easy; /* if non-NULL, points to the multi handle
1632 struct to which this "belongs" when used
1633 by the easy interface */
1634 struct Curl_share *share; /* Share, handles global variable mutexing */
1635 struct SingleRequest req; /* Request-specific data */
1636 struct UserDefined set; /* values set by the libcurl user */
1637 struct DynamicStatic change; /* possibly modified userdefined data */
1638 struct CookieInfo *cookies; /* the cookies, read from files and servers.
1639 NOTE that the 'cookie' field in the
1640 UserDefined struct defines if the "engine"
1641 is to be used or not. */
1642 struct Progress progress; /* for all the progress meter data */
1643 struct UrlState state; /* struct for fields used for state info and
1644 other dynamic purposes */
1645 struct WildcardData wildcard; /* wildcard download state info */
1646 struct PureInfo info; /* stats, reports and info data */
1647 struct curl_tlssessioninfo tsi; /* Information about the TLS session, only
1648 valid after a client has asked for it */
1649 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
1650 iconv_t outbound_cd; /* for translating to the network encoding */
1651 iconv_t inbound_cd; /* for translating from the network encoding */
1652 iconv_t utf8_cd; /* for translating to UTF8 */
1653 #endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */
1654 unsigned int magic; /* set to a CURLEASY_MAGIC_NUMBER */
1657 #define LIBCURL_NAME "libcurl"
1659 #endif /* HEADER_CURL_URLDATA_H */
projects / platform / upstream / curl.git / blob