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;
249 struct curl_schannel_ctxt {
250 CtxtHandle ctxt_handle;
251 TimeStamp time_stamp;
255 /* enum for the nonblocking SSL connection state machine */
259 ssl_connect_2_reading,
260 ssl_connect_2_writing,
267 ssl_connection_negotiating,
268 ssl_connection_complete
269 } ssl_connection_state;
271 /* struct for data related to each SSL connection */
272 struct ssl_connect_data {
273 /* Use ssl encrypted communications TRUE/FALSE, not necessarily using it atm
274 but at least asked to or meaning to use it. See 'state' for the exact
275 current state of the connection. */
277 ssl_connection_state state;
279 /* these ones requires specific SSL-types */
283 ssl_connect_state connecting_state;
284 #endif /* USE_SSLEAY */
286 gnutls_session session;
287 gnutls_certificate_credentials cred;
289 gnutls_srp_client_credentials srp_client_cred;
291 ssl_connect_state connecting_state;
292 #endif /* USE_GNUTLS */
294 #if POLARSSL_VERSION_NUMBER<0x01010000
297 /* from v1.1.0, use ctr_drbg and entropy */
298 ctr_drbg_context ctr_drbg;
299 entropy_context entropy;
300 #endif /* POLARSSL_VERSION_NUMBER<0x01010000 */
308 ssl_connect_state connecting_state;
309 #endif /* USE_POLARSSL */
313 ssl_connect_state connecting_state;
314 #endif /* USE_CYASSL */
317 char *client_nickname;
318 struct SessionHandle *data;
319 struct curl_llist *obj_list;
320 PK11GenericObject *obj_clicert;
324 #endif /* USE_QSOSSL */
328 ssl_connect_state connecting_state;
329 #endif /* USE_AXTLS */
331 struct curl_schannel_cred *cred;
332 struct curl_schannel_ctxt *ctxt;
333 SecPkgContext_StreamSizes stream_sizes;
334 ssl_connect_state connecting_state;
335 size_t encdata_length, decdata_length;
336 size_t encdata_offset, decdata_offset;
337 unsigned char *encdata_buffer, *decdata_buffer;
338 unsigned long req_flags, ret_flags;
339 #endif /* USE_SCHANNEL */
341 SSLContextRef ssl_ctx;
342 curl_socket_t ssl_sockfd;
343 ssl_connect_state connecting_state;
344 bool ssl_direction; /* true if writing, false if reading */
345 size_t ssl_write_buffered_length;
346 #endif /* USE_DARWINSSL */
349 struct ssl_config_data {
350 long version; /* what version the client wants to use */
351 long certverifyresult; /* result from the certificate verification */
353 bool verifypeer; /* set TRUE if this is desired */
354 bool verifyhost; /* set TRUE if CN/SAN must match hostname */
355 char *CApath; /* certificate dir (doesn't work on windows) */
356 char *CAfile; /* certificate to verify peer against */
357 const char *CRLfile; /* CRL to check certificate revocation */
358 const char *issuercert;/* optional issuer certificate filename */
359 char *random_file; /* path to file containing "random" data */
360 char *egdsocket; /* path to file containing the EGD daemon socket */
361 char *cipher_list; /* list of ciphers to use */
362 size_t max_ssl_sessions; /* SSL session id cache size */
363 curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */
364 void *fsslctxp; /* parameter for call back */
365 bool sessionid; /* cache session IDs or not */
366 bool certinfo; /* gather lots of certificate info */
369 char *username; /* TLS username (for, e.g., SRP) */
370 char *password; /* TLS password (for, e.g., SRP) */
371 enum CURL_TLSAUTH authtype; /* TLS authentication type (default SRP) */
375 /* information stored about one single SSL session */
376 struct curl_ssl_session {
377 char *name; /* host name for which this ID was used */
378 void *sessionid; /* as returned from the SSL layer */
379 size_t idsize; /* if known, otherwise 0 */
380 long age; /* just a number, the higher the more recent */
381 unsigned short remote_port; /* remote port to connect to */
382 struct ssl_config_data ssl_config; /* setup for this session */
385 /* Struct used for Digest challenge-response authentication */
391 bool stale; /* set true for re-negotiation */
395 int nc; /* nounce count */
406 #ifdef USE_WINDOWS_SSPI
407 #include "curl_sspi.h"
410 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
414 /* Struct used for NTLM challenge-response authentication */
417 #ifdef USE_WINDOWS_SSPI
420 SEC_WINNT_AUTH_IDENTITY identity;
421 SEC_WINNT_AUTH_IDENTITY *p_identity;
424 unsigned long n_type_2;
427 unsigned char nonce[8];
431 #ifdef USE_HTTP_NEGOTIATE
432 struct negotiatedata {
433 /* when doing Negotiate we first need to receive an auth token and then we
434 need to send our header */
435 enum { GSS_AUTHNONE, GSS_AUTHRECV, GSS_AUTHSENT } state;
436 bool gss; /* Whether we're processing GSS-Negotiate or Negotiate */
437 const char* protocol; /* "GSS-Negotiate" or "Negotiate" */
440 gss_ctx_id_t context;
441 gss_name_t server_name;
442 gss_buffer_desc output_token;
444 #ifdef USE_WINDOWS_SSPI
447 CredHandle *credentials;
448 char server_name[1024];
449 size_t max_token_length;
451 size_t output_token_length;
459 * Boolean values that concerns this connection.
462 bool close; /* if set, we close the connection after this request */
463 bool reuse; /* if set, this is a re-used connection */
464 bool proxy; /* if set, this transfer is done through a proxy - any type */
465 bool httpproxy; /* if set, this transfer is done through a http proxy */
466 bool user_passwd; /* do we use user+password for this connection? */
467 bool proxy_user_passwd; /* user+password for the proxy? */
468 bool ipv6_ip; /* we communicate with a remote site specified with pure IPv6
470 bool ipv6; /* we communicate with a site using an IPv6 address */
472 bool do_more; /* this is set TRUE if the ->curl_do_more() function is
473 supposed to be called, after ->curl_do() */
474 bool tcpconnect[2]; /* the TCP layer (or similar) is connected, this is set
475 the first time on the first connect function call */
476 bool protoconnstart;/* the protocol layer has STARTED its operation after
477 the TCP layer connect */
479 bool retry; /* this connection is about to get closed and then
480 re-attempted at another connection. */
481 bool tunnel_proxy; /* if CONNECT is used to "tunnel" through the proxy.
482 This is implicit when SSL-protocols are used through
483 proxies, but can also be enabled explicitly by
485 bool authneg; /* TRUE when the auth phase has started, which means
486 that we are creating a request with an auth header,
487 but it is not the final request in the auth
489 bool rewindaftersend;/* TRUE when the sending couldn't be stopped even
490 though it will be discarded. When the whole send
491 operation is done, we must call the data rewind
493 bool ftp_use_epsv; /* As set with CURLOPT_FTP_USE_EPSV, but if we find out
494 EPSV doesn't work we disable it for the forthcoming
497 bool ftp_use_eprt; /* As set with CURLOPT_FTP_USE_EPRT, but if we find out
498 EPRT doesn't work we disable it for the forthcoming
500 bool netrc; /* name+password provided by netrc */
501 bool userpwd_in_url; /* name+password found in url */
503 bool done; /* set to FALSE when Curl_do() is called and set to TRUE
504 when Curl_done() is called, to prevent Curl_done() to
505 get invoked twice when the multi interface is
507 bool stream_was_rewound; /* Indicates that the stream was rewound after a
508 request read past the end of its response byte
510 bool proxy_connect_closed; /* set true if a proxy disconnected the
511 connection in a CONNECT request with auth, so
512 that libcurl should reconnect and continue. */
513 bool bound; /* set true if bind() has already been done on this socket/
515 bool type_set; /* type= was used in the URL */
519 char *rawalloc; /* allocated "raw" version of the name */
520 char *encalloc; /* allocated IDN-encoded version of the name */
521 char *name; /* name to use internally, might be encoded, might be raw */
522 const char *dispname; /* name to display, as 'name' might be encoded */
526 * Flags on the keepon member of the Curl_transfer_keeper
530 #define KEEP_RECV (1<<0) /* there is or may be data to read */
531 #define KEEP_SEND (1<<1) /* there is or may be data to write */
532 #define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there
533 might still be data to read */
534 #define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there
535 might still be data to write */
536 #define KEEP_RECV_PAUSE (1<<4) /* reading is paused */
537 #define KEEP_SEND_PAUSE (1<<5) /* writing is paused */
539 #define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE)
540 #define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE)
545 ZLIB_UNINIT, /* uninitialized */
546 ZLIB_INIT, /* initialized */
547 ZLIB_GZIP_HEADER, /* reading gzip header */
548 ZLIB_GZIP_INFLATING, /* inflating gzip stream */
549 ZLIB_INIT_GZIP /* initialized in transparent gzip mode */
553 #ifdef CURLRES_ASYNCH
557 struct Curl_dns_entry *dns;
558 bool done; /* set TRUE when the lookup is complete */
559 int status; /* if done is TRUE, this is the status from the callback */
560 void *os_specific; /* 'struct thread_data' for Windows */
564 #define FIRSTSOCKET 0
565 #define SECONDARYSOCKET 1
567 /* These function pointer types are here only to allow easier typecasting
568 within the source when we need to cast between data pointers (such as NULL)
569 and function pointers. */
570 typedef CURLcode (*Curl_do_more_func)(struct connectdata *, bool *);
571 typedef CURLcode (*Curl_done_func)(struct connectdata *, CURLcode, bool);
575 EXP100_SEND_DATA, /* enough waiting, just send the body now */
576 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */
577 EXP100_SENDING_REQUEST, /* still sending the request but will wait for
578 the 100 header once done with the request */
579 EXP100_FAILED /* used on 417 Expectation Failed */
583 * Request specific data in the easy handle (SessionHandle). Previously,
584 * these members were on the connectdata struct but since a conn struct may
585 * now be shared between different SessionHandles, we store connection-specific
586 * data here. This struct only keeps stuff that's interesting for *this*
587 * request, as it will be cleared between multiple ones
589 struct SingleRequest {
590 curl_off_t size; /* -1 if unknown at this point */
591 curl_off_t *bytecountp; /* return number of bytes read or NULL */
593 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch,
594 -1 means unlimited */
595 curl_off_t *writebytecountp; /* return number of bytes written or NULL */
597 curl_off_t bytecount; /* total number of bytes read */
598 curl_off_t writebytecount; /* number of bytes written */
600 long headerbytecount; /* only count received headers */
601 long deductheadercount; /* this amount of bytes doesn't count when we check
602 if anything has been transferred at the end of a
603 connection. We use this counter to make only a
604 100 reply (without a following second response
605 code) result in a CURLE_GOT_NOTHING error code */
607 struct timeval start; /* transfer started at this time */
608 struct timeval now; /* current time */
609 bool header; /* incoming data has HTTP header */
611 HEADER_NORMAL, /* no bad header at all */
612 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest
614 HEADER_ALLBAD /* all was believed to be header */
615 } badheader; /* the header was deemed bad and will be
617 int headerline; /* counts header lines to better track the
619 char *hbufp; /* points at *end* of header line */
621 char *str; /* within buf */
622 char *str_start; /* within buf */
623 char *end_ptr; /* within buf */
624 char *p; /* within headerbuff */
625 bool content_range; /* set TRUE if Content-Range: was found */
626 curl_off_t offset; /* possible resume offset read from the
627 Content-Range: header */
628 int httpcode; /* error code from the 'HTTP/1.? XXX' or
629 'RTSP/1.? XXX' line */
630 struct timeval start100; /* time stamp to wait for the 100 code from */
631 enum expect100 exp100; /* expect 100 continue state */
633 int auto_decoding; /* What content encoding. sec 3.5, RFC2616. */
635 #define IDENTITY 0 /* No encoding */
636 #define DEFLATE 1 /* zlib deflate [RFC 1950 & 1951] */
637 #define GZIP 2 /* gzip algorithm [RFC 1952] */
638 #define COMPRESS 3 /* Not handled, added for completeness */
641 zlibInitState zlib_init; /* possible zlib init state;
642 undefined if Content-Encoding header. */
643 z_stream z; /* State structure for zlib. */
655 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
656 and we're uploading the last chunk */
658 bool ignorebody; /* we read a response-body but we ignore it! */
659 bool ignorecl; /* This HTTP response has no body so we ignore the Content-
662 char *location; /* This points to an allocated version of the Location:
664 char *newurl; /* Set to the new URL to use when a redirect or a retry is
667 /* 'upload_present' is used to keep a byte counter of how much data there is
668 still left in the buffer, aimed for upload. */
669 ssize_t upload_present;
671 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
672 buffer, so the next read should read from where this pointer points to,
673 and the 'upload_present' contains the number of bytes available at this
675 char *upload_fromhere;
677 bool chunk; /* if set, this is a chunked transfer-encoding */
678 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
680 bool getheader; /* TRUE if header parsing is wanted */
682 bool forbidchunk; /* used only to explicitly forbid chunk-upload for
683 specific upload buffers. See readmoredata() in
684 http.c for details. */
688 * Specific protocol handler.
691 struct Curl_handler {
692 const char * scheme; /* URL scheme name. */
694 /* Complement to setup_connection_internals(). */
695 CURLcode (*setup_connection)(struct connectdata *);
697 /* These two functions MUST be set to be protocol dependent */
698 CURLcode (*do_it)(struct connectdata *, bool *done);
701 /* If the curl_do() function is better made in two halves, this
702 * curl_do_more() function will be called afterwards, if set. For example
703 * for doing the FTP stuff after the PASV/PORT command.
705 Curl_do_more_func do_more;
707 /* This function *MAY* be set to a protocol-dependent function that is run
708 * after the connect() and everything is done, as a step in the connection.
709 * The 'done' pointer points to a bool that should be set to TRUE if the
710 * function completes before return. If it doesn't complete, the caller
711 * should call the curl_connecting() function until it is.
713 CURLcode (*connect_it)(struct connectdata *, bool *done);
715 /* See above. Currently only used for FTP. */
716 CURLcode (*connecting)(struct connectdata *, bool *done);
717 CURLcode (*doing)(struct connectdata *, bool *done);
719 /* Called from the multi interface during the PROTOCONNECT phase, and it
720 should then return a proper fd set */
721 int (*proto_getsock)(struct connectdata *conn,
722 curl_socket_t *socks,
725 /* Called from the multi interface during the DOING phase, and it should
726 then return a proper fd set */
727 int (*doing_getsock)(struct connectdata *conn,
728 curl_socket_t *socks,
731 /* Called from the multi interface during the DO_MORE phase, and it should
732 then return a proper fd set */
733 int (*domore_getsock)(struct connectdata *conn,
734 curl_socket_t *socks,
737 /* Called from the multi interface during the DO_DONE, PERFORM and
738 WAITPERFORM phases, and it should then return a proper fd set. Not setting
739 this will make libcurl use the generic default one. */
740 int (*perform_getsock)(const struct connectdata *conn,
741 curl_socket_t *socks,
744 /* This function *MAY* be set to a protocol-dependent function that is run
745 * by the curl_disconnect(), as a step in the disconnection. If the handler
746 * is called because the connection has been considered dead, dead_connection
749 CURLcode (*disconnect)(struct connectdata *, bool dead_connection);
751 /* If used, this function gets called from transfer.c:readwrite_data() to
752 allow the protocol to do extra reads/writes */
753 CURLcode (*readwrite)(struct SessionHandle *data, struct connectdata *conn,
754 ssize_t *nread, bool *readmore);
756 long defport; /* Default port. */
757 unsigned int protocol; /* See CURLPROTO_* */
758 unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */
761 #define PROTOPT_NONE 0 /* nothing extra */
762 #define PROTOPT_SSL (1<<0) /* uses SSL */
763 #define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */
764 #define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */
765 /* some protocols will have to call the underlying functions without regard to
766 what exact state the socket signals. IE even if the socket says "readable",
767 the send function might need to be called while uploading, or vice versa.
769 #define PROTOPT_DIRLOCK (1<<3)
770 #define PROTOPT_NONETWORK (1<<4) /* protocol doesn't use the network! */
771 #define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it
773 #define PROTOPT_NOURLQUERY (1<<6) /* protocol can't handle
774 url query strings (?foo=bar) ! */
777 /* return the count of bytes sent, or -1 on error */
778 typedef ssize_t (Curl_send)(struct connectdata *conn, /* connection data */
779 int sockindex, /* socketindex */
780 const void *buf, /* data to write */
781 size_t len, /* max amount to write */
782 CURLcode *err); /* error to return */
784 /* return the count of bytes read, or -1 on error */
785 typedef ssize_t (Curl_recv)(struct connectdata *conn, /* connection data */
786 int sockindex, /* socketindex */
787 char *buf, /* store data here */
788 size_t len, /* max amount to read */
789 CURLcode *err); /* error to return */
792 * The connectdata struct contains all fields and variables that should be
793 * unique for an entire connection.
796 /* 'data' is the CURRENT SessionHandle using this connection -- take great
797 caution that this might very well vary between different times this
798 connection is used! */
799 struct SessionHandle *data;
801 /* chunk is for HTTP chunked encoding, but is in the general connectdata
802 struct only because we can do just about any protocol through a HTTP proxy
803 and a HTTP proxy may in fact respond using chunked encoding */
804 struct Curl_chunker chunk;
806 curl_closesocket_callback fclosesocket; /* function closing the socket(s) */
807 void *closesocket_client;
809 bool inuse; /* This is a marker for the connection cache logic. If this is
810 TRUE this handle is being used by an easy handle and cannot
811 be used by any other easy handle without careful
812 consideration (== only for pipelining). */
814 /**** Fields set when inited and not modified again */
815 long connection_id; /* Contains a unique number to make it easier to
816 track the connections in the log output */
818 /* 'dns_entry' is the particular host we use. This points to an entry in the
819 DNS cache and it will not get pruned while locked. It gets unlocked in
820 Curl_done(). This entry will be NULL if the connection is re-used as then
821 there is no name resolve done. */
822 struct Curl_dns_entry *dns_entry;
824 /* 'ip_addr' is the particular IP we connected to. It points to a struct
825 within the DNS cache, so this pointer is only valid as long as the DNS
826 cache entry remains locked. It gets unlocked in Curl_done() */
827 Curl_addrinfo *ip_addr;
829 /* 'ip_addr_str' is the ip_addr data as a human readable string.
830 It remains available as long as the connection does, which is longer than
831 the ip_addr itself. */
832 char ip_addr_str[MAX_IPADR_LEN];
834 unsigned int scope; /* address scope for IPv6 */
836 int socktype; /* SOCK_STREAM or SOCK_DGRAM */
838 struct hostname host;
839 struct hostname proxy;
841 long port; /* which port to use locally */
842 unsigned short remote_port; /* what remote port to connect to,
843 not the proxy port! */
845 /* 'primary_ip' and 'primary_port' get filled with peer's numerical
846 ip address and port number whenever an outgoing connection is
847 *attempted* from the primary socket to a remote address. When more
848 than one address is tried for a connection these will hold data
849 for the last attempt. When the connection is actually established
850 these are updated with data which comes directly from the socket. */
852 char primary_ip[MAX_IPADR_LEN];
855 /* 'local_ip' and 'local_port' get filled with local's numerical
856 ip address and port number whenever an outgoing connection is
857 **established** from the primary socket to a remote address. */
859 char local_ip[MAX_IPADR_LEN];
862 char *user; /* user name string, allocated */
863 char *passwd; /* password string, allocated */
864 char *options; /* options string, allocated */
866 char *proxyuser; /* proxy user name string, allocated */
867 char *proxypasswd; /* proxy password string, allocated */
868 curl_proxytype proxytype; /* what kind of proxy that is in use */
870 int httpversion; /* the HTTP version*10 reported by the server */
871 int rtspversion; /* the RTSP version*10 reported by the server */
873 struct timeval now; /* "current" time */
874 struct timeval created; /* creation time */
875 curl_socket_t sock[2]; /* two sockets, the second is used for the data
876 transfer when doing FTP */
877 bool sock_accepted[2]; /* TRUE if the socket on this index was created with
882 struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */
883 struct ssl_config_data ssl_config;
885 struct ConnectBits bits; /* various state-flags for this connection */
887 /* connecttime: when connect() is called on the current IP address. Used to
888 be able to track when to move on to try next IP - but only when the multi
889 interface is used. */
890 struct timeval connecttime;
891 /* The two fields below get set in Curl_connecthost */
892 int num_addr; /* number of addresses to try to connect to */
893 long timeoutms_per_addr; /* how long time in milliseconds to spend on
894 trying to connect to each IP address */
896 const struct Curl_handler *handler; /* Connection's protocol handler */
897 const struct Curl_handler *given; /* The protocol first given */
899 long ip_version; /* copied from the SessionHandle at creation time */
901 /**** curl_get() phase fields */
903 curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */
904 curl_socket_t writesockfd; /* socket to write to, it may very
905 well be the same we read from.
906 CURL_SOCKET_BAD disables */
908 /** Dynamicly allocated strings, MUST be freed before this **/
909 /** struct is killed. **/
910 struct dynamically_allocated_data {
913 char *accept_encoding;
919 char *rtsp_transport;
920 char *te; /* TE: request header */
923 int sec_complete; /* if kerberos is enabled for this connection */
924 #if defined(HAVE_KRB4) || defined(HAVE_GSSAPI)
925 enum protection_level command_prot;
926 enum protection_level data_prot;
927 enum protection_level request_data_prot;
929 struct krb4buffer in_buffer;
931 const struct Curl_sec_client_mech *mech;
932 struct sockaddr_in local_addr;
935 /* the two following *_inuse fields are only flags, not counters in any way.
936 If TRUE it means the channel is in use, and if FALSE it means the channel
937 is up for grabs by one. */
939 bool readchannel_inuse; /* whether the read channel is in use by an easy
941 bool writechannel_inuse; /* whether the write channel is in use by an easy
943 struct curl_llist *send_pipe; /* List of handles waiting to
944 send on this pipeline */
945 struct curl_llist *recv_pipe; /* List of handles waiting to read
946 their responses on this pipeline */
947 char* master_buffer; /* The master buffer allocated on-demand;
948 used for pipelining. */
949 size_t read_pos; /* Current read position in the master buffer */
950 size_t buf_len; /* Length of the buffer?? */
953 curl_seek_callback seek_func; /* function that seeks the input */
954 void *seek_client; /* pointer to pass to the seek() above */
956 /*************** Request - specific items ************/
958 /* previously this was in the urldata struct */
959 curl_read_callback fread_func; /* function that reads the input */
960 void *fread_in; /* pointer to pass to the fread() above */
962 struct ntlmdata ntlm; /* NTLM differs from other authentication schemes
963 because it authenticates connections, not
965 struct ntlmdata proxyntlm; /* NTLM data for proxy */
967 #if defined(USE_NTLM) && defined(NTLM_WB_ENABLED)
968 /* used for communication with Samba's winbind daemon helper ntlm_auth */
969 curl_socket_t ntlm_auth_hlpr_socket;
970 pid_t ntlm_auth_hlpr_pid;
971 char* challenge_header;
972 char* response_header;
975 char syserr_buf [256]; /* buffer for Curl_strerror() */
977 #ifdef CURLRES_ASYNCH
978 /* data used for the asynch name resolve callback */
979 struct Curl_async async;
982 /* These three are used for chunked-encoding trailer support */
983 char *trailer; /* allocated buffer to store trailer in */
984 int trlMax; /* allocated buffer size */
985 int trlPos; /* index of where to store data */
988 struct ftp_conn ftpc;
989 struct ssh_conn sshc;
990 struct tftp_state_data *tftpc;
991 struct imap_conn imapc;
992 struct pop3_conn pop3c;
993 struct smtp_conn smtpc;
994 struct rtsp_conn rtspc;
998 int cselect_bits; /* bitmask of socket events */
999 int waitfor; /* current READ/WRITE bits to wait for */
1001 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1002 int socks5_gssapi_enctype;
1008 /* When this connection is created, store the conditions for the local end
1009 bind. This is stored before the actual bind and before any connection is
1010 made and will serve the purpose of being used for comparison reasons so
1011 that subsequent bound-requested connections aren't accidentally re-using
1012 wrong connections. */
1014 unsigned short localport;
1017 /* tunnel as in tunnel through a HTTP proxy with CONNECT */
1019 TUNNEL_INIT, /* init/default/no tunnel state */
1020 TUNNEL_CONNECT, /* CONNECT has been sent off */
1021 TUNNEL_COMPLETE /* CONNECT response received completely */
1022 } tunnel_state[2]; /* two separate ones to allow FTP */
1023 struct connectbundle *bundle; /* The bundle we are member of */
1026 /* The end of connectdata. */
1029 * Struct to keep statistical and informational data.
1032 int httpcode; /* Recent HTTP, FTP, or RTSP response code */
1033 int httpproxycode; /* response code from proxy when received separate */
1034 int httpversion; /* the http version number X.Y = X*10+Y */
1035 long filetime; /* If requested, this is might get set. Set to -1 if the time
1036 was unretrievable. We cannot have this of type time_t,
1037 since time_t is unsigned on several platforms such as
1039 bool timecond; /* set to TRUE if the time condition didn't match, which
1040 thus made the document NOT get fetched */
1041 long header_size; /* size of read header(s) in bytes */
1042 long request_size; /* the amount of bytes sent in the request(s) */
1043 unsigned long proxyauthavail; /* what proxy auth types were announced */
1044 unsigned long httpauthavail; /* what host auth types were announced */
1045 long numconnects; /* how many new connection did libcurl created */
1046 char *contenttype; /* the content type of the object */
1047 char *wouldredirect; /* URL this would've been redirected to if asked to */
1049 /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip'
1050 and, 'conn_local_port' are copied over from the connectdata struct in
1051 order to allow curl_easy_getinfo() to return this information even when
1052 the session handle is no longer associated with a connection, and also
1053 allow curl_easy_reset() to clear this information from the session handle
1054 without disturbing information which is still alive, and that might be
1055 reused, in the connection cache. */
1057 char conn_primary_ip[MAX_IPADR_LEN];
1058 long conn_primary_port;
1060 char conn_local_ip[MAX_IPADR_LEN];
1061 long conn_local_port;
1063 struct curl_certinfo certs; /* info about the certs, only populated in
1064 OpenSSL builds. Asked for with
1065 CURLOPT_CERTINFO / CURLINFO_CERTINFO */
1070 long lastshow; /* time() of the last displayed progress meter or NULL to
1071 force redraw at next call */
1072 curl_off_t size_dl; /* total expected size */
1073 curl_off_t size_ul; /* total expected size */
1074 curl_off_t downloaded; /* transferred so far */
1075 curl_off_t uploaded; /* transferred so far */
1077 curl_off_t current_speed; /* uses the currently fastest transfer */
1079 bool callback; /* set when progress callback is used */
1080 int width; /* screen width at download start */
1081 int flags; /* see progress.h */
1090 double t_appconnect;
1091 double t_pretransfer;
1092 double t_starttransfer;
1095 struct timeval start;
1096 struct timeval t_startsingle;
1097 struct timeval t_acceptdata;
1098 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
1100 curl_off_t speeder[ CURR_TIME ];
1101 struct timeval speeder_time[ CURR_TIME ];
1106 HTTPREQ_NONE, /* first in list */
1109 HTTPREQ_POST_FORM, /* we make a difference internally */
1113 HTTPREQ_LAST /* last in list */
1117 RTSPREQ_NONE, /* first in list */
1125 RTSPREQ_GET_PARAMETER,
1126 RTSPREQ_SET_PARAMETER,
1129 RTSPREQ_LAST /* last in list */
1133 * Values that are generated, temporary or calculated internally for a
1134 * "session handle" must be defined within the 'struct UrlState'. This struct
1135 * will be used within the SessionHandle struct. When the 'SessionHandle'
1136 * struct is cloned, this data MUST NOT be copied.
1138 * Remember that any "state" information goes globally for the curl handle.
1139 * Session-data MUST be put in the connectdata struct and here. */
1140 #define MAX_CURL_USER_LENGTH 256
1141 #define MAX_CURL_PASSWORD_LENGTH 256
1142 #define MAX_CURL_OPTIONS_LENGTH 256
1145 unsigned long want; /* Bitmask set to the authentication methods wanted by
1146 app (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */
1147 unsigned long picked;
1148 unsigned long avail; /* Bitmask for what the server reports to support for
1150 bool done; /* TRUE when the auth phase is done and ready to do the *actual*
1152 bool multi; /* TRUE if this is not yet authenticated but within the auth
1153 multipass negotiation */
1154 bool iestyle; /* TRUE if digest should be done IE-style or FALSE if it should
1160 /* Points to the connection cache */
1161 struct conncache *conn_cache;
1163 /* when curl_easy_perform() is called, the multi handle is "owned" by
1164 the easy handle so curl_easy_cleanup() on such an easy handle will
1165 also close the multi handle! */
1166 bool multi_owned_by_easy;
1168 /* buffers to store authentication data in, as parsed from input options */
1169 struct timeval keeps_speed; /* for the progress meter really */
1171 struct connectdata *lastconnect; /* The last connection, NULL if undefined */
1173 char *headerbuff; /* allocated buffer to store headers in */
1174 size_t headersize; /* size of the allocation */
1176 char buffer[BUFSIZE+1]; /* download buffer */
1177 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
1178 curl_off_t current_speed; /* the ProgressShow() funcion sets this,
1180 bool this_is_a_follow; /* this is a followed Location: request */
1182 char *first_host; /* if set, this should be the host name that we will
1183 sent authorization to, no else. Used to make Location:
1184 following not keep sending user+password... This is
1187 struct curl_ssl_session *session; /* array of 'max_ssl_sessions' size */
1188 long sessionage; /* number of the most recent session */
1189 char *tempwrite; /* allocated buffer to keep data in when a write
1190 callback returns to make the connection paused */
1191 size_t tempwritesize; /* size of the 'tempwrite' allocated buffer */
1192 int tempwritetype; /* type of the 'tempwrite' buffer as a bitmask that is
1193 used with Curl_client_write() */
1194 char *scratch; /* huge buffer[BUFSIZE*2] when doing upload CRLF replacing */
1195 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
1196 This must be set to FALSE every time _easy_perform() is
1198 int os_errno; /* filled in with errno whenever an error occurs */
1200 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
1201 void (*prev_signal)(int sig);
1203 bool allow_port; /* Is set.use_port allowed to take effect or not. This
1204 is always set TRUE when curl_easy_perform() is called. */
1205 struct digestdata digest; /* state data for host Digest auth */
1206 struct digestdata proxydigest; /* state data for proxy Digest auth */
1208 #ifdef USE_HTTP_NEGOTIATE
1209 struct negotiatedata negotiate; /* state data for host Negotiate auth */
1210 struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */
1213 struct auth authhost; /* auth details for host */
1214 struct auth authproxy; /* auth details for proxy */
1216 bool authproblem; /* TRUE if there's some problem authenticating */
1218 void *resolver; /* resolver state, if it is used in the URL state -
1219 ares_channel f.e. */
1221 #if defined(USE_SSLEAY) && defined(HAVE_OPENSSL_ENGINE_H)
1223 #endif /* USE_SSLEAY */
1224 struct timeval expiretime; /* set this with Curl_expire() only */
1225 struct Curl_tree timenode; /* for the splay stuff */
1226 struct curl_llist *timeoutlist; /* list of pending timeouts */
1228 /* a place to store the most recently set FTP entrypath */
1229 char *most_recent_ftp_entrypath;
1231 /* set after initial USER failure, to prevent an authentication loop */
1232 bool ftp_trying_alternative;
1234 int httpversion; /* the lowest HTTP version*10 reported by any server
1235 involved in this request */
1236 bool expect100header; /* TRUE if we added Expect: 100-continue */
1238 bool pipe_broke; /* TRUE if the connection we were pipelined on broke
1239 and we need to restart from the beginning */
1241 #if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) && \
1242 !defined(__SYMBIAN32__)
1243 /* do FTP line-end conversions on most platforms */
1244 #define CURL_DO_LINEEND_CONV
1245 /* for FTP downloads: track CRLF sequences that span blocks */
1246 bool prev_block_had_trailing_cr;
1247 /* for FTP downloads: how many CRLFs did we converted to LFs? */
1248 curl_off_t crlf_conversions;
1250 char *pathbuffer;/* allocated buffer to store the URL's path part in */
1251 char *path; /* path to use, points to somewhere within the pathbuffer
1253 bool slash_removed; /* set TRUE if the 'path' points to a path where the
1254 initial URL slash separator has been taken off */
1256 bool rangestringalloc; /* the range string is malloc()'ed */
1258 char *range; /* range, if used. See README for detailed specification on
1260 curl_off_t resume_from; /* continue [ftp] transfer from here */
1262 /* This RTSP state information survives requests and connections */
1263 long rtsp_next_client_CSeq; /* the session's next client CSeq */
1264 long rtsp_next_server_CSeq; /* the session's next server CSeq */
1265 long rtsp_CSeq_recv; /* most recent CSeq received */
1267 /* Protocol specific data.
1269 *************************************************************************
1270 * Note that this data will be REMOVED after each request, so anything that
1271 * should be kept/stored on a per-connection basis and thus live for the
1272 * next request on the same connection MUST be put in the connectdata struct!
1273 *************************************************************************/
1276 struct HTTP *https; /* alias, just for the sake of being more readable */
1279 /* void *tftp; not used */
1280 struct FILEPROTO *file;
1281 void *telnet; /* private for telnet.c-eyes only */
1283 struct SSHPROTO *ssh;
1288 /* current user of this SessionHandle instance, or NULL */
1289 struct connectdata *current_conn;
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.
1322 struct Curl_one_easy; /* declared and used only in multi.c */
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 /* -- 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 bool sasl_ir; /* Enable/disable SASL initial response */
1569 /* Common RTSP header options */
1570 Curl_RtspReq rtspreq; /* RTSP request type */
1571 long rtspversion; /* like httpversion, for RTSP */
1572 bool wildcardmatch; /* enable wildcard matching */
1573 curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer
1575 curl_chunk_end_callback chunk_end; /* called after part transferring
1577 curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds
1578 to pattern (e.g. if WILDCARDMATCH is on) */
1581 long gssapi_delegation; /* GSSAPI credential delegation, see the
1582 documentation of CURLOPT_GSSAPI_DELEGATION */
1584 bool tcp_keepalive; /* use TCP keepalives */
1585 long tcp_keepidle; /* seconds in idle before sending keepalive probe */
1586 long tcp_keepintvl; /* seconds between TCP keepalive probes */
1588 size_t maxconnects; /* Max idle connections in the connection cache */
1592 struct curl_hash *hostcache;
1594 HCACHE_NONE, /* not pointing to anything */
1595 HCACHE_GLOBAL, /* points to the (shrug) global one */
1596 HCACHE_MULTI, /* points to a shared one in the multi handle */
1597 HCACHE_SHARED /* points to a shared one in a shared object */
1602 * The 'connectdata' struct MUST have all the connection oriented stuff as we
1603 * may have several simultaneous connections and connection structs in memory.
1605 * The 'struct UserDefined' must only contain data that is set once to go for
1606 * many (perhaps) independent connections. Values that are generated or
1607 * calculated internally for the "session handle" must be defined within the
1608 * 'struct UrlState' instead.
1611 struct SessionHandle {
1613 struct Curl_multi *multi; /* if non-NULL, points to the multi handle
1614 struct to which this "belongs" when used by
1615 the multi interface */
1616 struct Curl_multi *multi_easy; /* if non-NULL, points to the multi handle
1617 struct to which this "belongs" when used
1618 by the easy interface */
1619 struct Curl_one_easy *multi_pos; /* if non-NULL, points to its position
1620 in multi controlling structure to assist
1622 struct Curl_share *share; /* Share, handles global variable mutexing */
1623 struct SingleRequest req; /* Request-specific data */
1624 struct UserDefined set; /* values set by the libcurl user */
1625 struct DynamicStatic change; /* possibly modified userdefined data */
1626 struct CookieInfo *cookies; /* the cookies, read from files and servers.
1627 NOTE that the 'cookie' field in the
1628 UserDefined struct defines if the "engine"
1629 is to be used or not. */
1630 struct Progress progress; /* for all the progress meter data */
1631 struct UrlState state; /* struct for fields used for state info and
1632 other dynamic purposes */
1633 struct WildcardData wildcard; /* wildcard download state info */
1634 struct PureInfo info; /* stats, reports and info data */
1635 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
1636 iconv_t outbound_cd; /* for translating to the network encoding */
1637 iconv_t inbound_cd; /* for translating from the network encoding */
1638 iconv_t utf8_cd; /* for translating to UTF8 */
1639 #endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */
1640 unsigned int magic; /* set to a CURLEASY_MAGIC_NUMBER */
1643 #define LIBCURL_NAME "libcurl"
1645 #endif /* HEADER_CURL_URLDATA_H */
projects / platform / upstream / curl.git / blob