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 /* length of longest IPv6 address string including the trailing null */
62 #define MAX_IPADR_LEN sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255")
64 /* Default FTP/IMAP etc response timeout in milliseconds.
65 Symbian OS panics when given a timeout much greater than 1/2 hour.
67 #define RESP_TIMEOUT (1800*1000)
74 #include <openssl/rsa.h>
75 #include <openssl/crypto.h>
76 #include <openssl/x509.h>
77 #include <openssl/pem.h>
78 #include <openssl/ssl.h>
79 #include <openssl/err.h>
80 #ifdef HAVE_OPENSSL_ENGINE_H
81 #include <openssl/engine.h>
83 #ifdef HAVE_OPENSSL_PKCS12_H
84 #include <openssl/pkcs12.h>
86 #else /* SSLeay-style includes */
93 #ifdef HAVE_OPENSSL_ENGINE_H
96 #ifdef HAVE_OPENSSL_PKCS12_H
99 #endif /* USE_OPENSSL */
101 #error Configuration error; cannot use GnuTLS *and* OpenSSL.
103 #endif /* USE_SSLEAY */
106 #include <gnutls/gnutls.h>
110 #include <polarssl/havege.h>
111 #include <polarssl/ssl.h>
115 #undef OCSP_REQUEST /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */
116 #undef OCSP_RESPONSE /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */
117 #include <cyassl/openssl/ssl.h>
130 #include <axTLS/ssl.h>
134 #endif /* USE_AXTLS */
137 #include "curl_sspi.h"
139 #include <schannel.h>
143 #include <Security/Security.h>
144 /* For some reason, when building for iOS, the omnibus header above does
145 * not include SecureTransport.h as of iOS SDK 5.1. */
146 #include <Security/SecureTransport.h>
149 #ifdef HAVE_NETINET_IN_H
150 #include <netinet/in.h>
156 #include <zlib.h> /* for content-encoding */
158 /* zlib pollutes the namespace with this definition */
163 #include <curl/curl.h>
165 #include "http_chunks.h" /* for the structs and enum stuff */
178 #include "wildcard.h"
183 # elif defined HAVE_GSSMIT
184 # include <gssapi/gssapi.h>
185 # include <gssapi/gssapi_generic.h>
191 #ifdef HAVE_LIBSSH2_H
193 #include <libssh2_sftp.h>
194 #endif /* HAVE_LIBSSH2_H */
196 /* Download buffer size, keep it fairly big for speed reasons */
198 #define BUFSIZE CURL_MAX_WRITE_SIZE
200 /* Initial size of the buffer to store headers in, it'll be enlarged in case
202 #define HEADERSIZE 256
204 #define CURLEASY_MAGIC_NUMBER 0xc0dedbadU
206 /* Some convenience macros to get the larger/smaller value out of two given.
207 We prefix with CURL to prevent name collisions. */
208 #define CURLMAX(x,y) ((x)>(y)?(x):(y))
209 #define CURLMIN(x,y) ((x)<(y)?(x):(y))
212 #if defined(HAVE_KRB4) || defined(HAVE_GSSAPI)
213 /* Types needed for krb4/5-ftp connections */
221 enum protection_level {
222 PROT_NONE, /* first in list */
228 PROT_LAST /* last in list */
233 /* Structs to store Schannel handles */
234 struct curl_schannel_cred {
235 CredHandle cred_handle;
236 TimeStamp time_stamp;
240 struct curl_schannel_ctxt {
241 CtxtHandle ctxt_handle;
242 TimeStamp time_stamp;
246 /* enum for the nonblocking SSL connection state machine */
250 ssl_connect_2_reading,
251 ssl_connect_2_writing,
258 ssl_connection_negotiating,
259 ssl_connection_complete
260 } ssl_connection_state;
262 /* struct for data related to each SSL connection */
263 struct ssl_connect_data {
264 /* Use ssl encrypted communications TRUE/FALSE, not necessarily using it atm
265 but at least asked to or meaning to use it. See 'state' for the exact
266 current state of the connection. */
268 ssl_connection_state state;
270 /* these ones requires specific SSL-types */
274 ssl_connect_state connecting_state;
275 #endif /* USE_SSLEAY */
277 gnutls_session session;
278 gnutls_certificate_credentials cred;
280 gnutls_srp_client_credentials srp_client_cred;
282 ssl_connect_state connecting_state;
283 #endif /* USE_GNUTLS */
293 ssl_connect_state connecting_state;
294 #endif /* USE_POLARSSL */
298 ssl_connect_state connecting_state;
299 #endif /* USE_CYASSL */
302 char *client_nickname;
303 struct SessionHandle *data;
304 struct curl_llist *obj_list;
305 PK11GenericObject *obj_clicert;
309 #endif /* USE_QSOSSL */
313 #endif /* USE_AXTLS */
315 struct curl_schannel_cred *cred;
316 struct curl_schannel_ctxt *ctxt;
317 SecPkgContext_StreamSizes stream_sizes;
318 ssl_connect_state connecting_state;
319 size_t encdata_length, decdata_length;
320 size_t encdata_offset, decdata_offset;
321 unsigned char *encdata_buffer, *decdata_buffer;
322 unsigned long req_flags, ret_flags;
323 #endif /* USE_SCHANNEL */
325 SSLContextRef ssl_ctx;
326 curl_socket_t ssl_sockfd;
327 ssl_connect_state connecting_state;
328 bool ssl_direction; /* true if writing, false if reading */
329 size_t ssl_write_buffered_length;
330 #endif /* USE_DARWINSSL */
333 struct ssl_config_data {
334 long version; /* what version the client wants to use */
335 long certverifyresult; /* result from the certificate verification */
337 bool verifypeer; /* set TRUE if this is desired */
338 bool verifyhost; /* set TRUE if CN/SAN must match hostname */
339 char *CApath; /* certificate dir (doesn't work on windows) */
340 char *CAfile; /* certificate to verify peer against */
341 const char *CRLfile; /* CRL to check certificate revocation */
342 const char *issuercert;/* optional issuer certificate filename */
343 char *random_file; /* path to file containing "random" data */
344 char *egdsocket; /* path to file containing the EGD daemon socket */
345 char *cipher_list; /* list of ciphers to use */
346 size_t max_ssl_sessions; /* SSL session id cache size */
347 curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */
348 void *fsslctxp; /* parameter for call back */
349 bool sessionid; /* cache session IDs or not */
350 bool certinfo; /* gather lots of certificate info */
353 char *username; /* TLS username (for, e.g., SRP) */
354 char *password; /* TLS password (for, e.g., SRP) */
355 enum CURL_TLSAUTH authtype; /* TLS authentication type (default SRP) */
359 /* information stored about one single SSL session */
360 struct curl_ssl_session {
361 char *name; /* host name for which this ID was used */
362 void *sessionid; /* as returned from the SSL layer */
363 size_t idsize; /* if known, otherwise 0 */
364 long age; /* just a number, the higher the more recent */
365 unsigned short remote_port; /* remote port to connect to */
366 struct ssl_config_data ssl_config; /* setup for this session */
369 /* Struct used for Digest challenge-response authentication */
375 bool stale; /* set true for re-negotiation */
379 int nc; /* nounce count */
390 #ifdef USE_WINDOWS_SSPI
391 #include "curl_sspi.h"
394 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
398 /* Struct used for NTLM challenge-response authentication */
401 #ifdef USE_WINDOWS_SSPI
404 SEC_WINNT_AUTH_IDENTITY identity;
405 SEC_WINNT_AUTH_IDENTITY *p_identity;
408 unsigned long n_type_2;
411 unsigned char nonce[8];
415 #ifdef USE_HTTP_NEGOTIATE
416 struct negotiatedata {
417 /* when doing Negotiate we first need to receive an auth token and then we
418 need to send our header */
419 enum { GSS_AUTHNONE, GSS_AUTHRECV, GSS_AUTHSENT } state;
420 bool gss; /* Whether we're processing GSS-Negotiate or Negotiate */
421 const char* protocol; /* "GSS-Negotiate" or "Negotiate" */
424 gss_ctx_id_t context;
425 gss_name_t server_name;
426 gss_buffer_desc output_token;
428 #ifdef USE_WINDOWS_SSPI
431 CredHandle *credentials;
432 char server_name[1024];
433 size_t max_token_length;
435 size_t output_token_length;
443 * Boolean values that concerns this connection.
446 bool close; /* if set, we close the connection after this request */
447 bool reuse; /* if set, this is a re-used connection */
448 bool proxy; /* if set, this transfer is done through a proxy - any type */
449 bool httpproxy; /* if set, this transfer is done through a http proxy */
450 bool user_passwd; /* do we use user+password for this connection? */
451 bool proxy_user_passwd; /* user+password for the proxy? */
452 bool ipv6_ip; /* we communicate with a remote site specified with pure IPv6
454 bool ipv6; /* we communicate with a site using an IPv6 address */
456 bool do_more; /* this is set TRUE if the ->curl_do_more() function is
457 supposed to be called, after ->curl_do() */
458 bool tcpconnect[2]; /* the TCP layer (or similar) is connected, this is set
459 the first time on the first connect function call */
460 bool protoconnstart;/* the protocol layer has STARTED its operation after
461 the TCP layer connect */
463 bool retry; /* this connection is about to get closed and then
464 re-attempted at another connection. */
465 bool tunnel_proxy; /* if CONNECT is used to "tunnel" through the proxy.
466 This is implicit when SSL-protocols are used through
467 proxies, but can also be enabled explicitly by
469 bool authneg; /* TRUE when the auth phase has started, which means
470 that we are creating a request with an auth header,
471 but it is not the final request in the auth
473 bool rewindaftersend;/* TRUE when the sending couldn't be stopped even
474 though it will be discarded. When the whole send
475 operation is done, we must call the data rewind
477 bool ftp_use_epsv; /* As set with CURLOPT_FTP_USE_EPSV, but if we find out
478 EPSV doesn't work we disable it for the forthcoming
481 bool ftp_use_eprt; /* As set with CURLOPT_FTP_USE_EPRT, but if we find out
482 EPRT doesn't work we disable it for the forthcoming
484 bool netrc; /* name+password provided by netrc */
485 bool userpwd_in_url; /* name+password found in url */
487 bool done; /* set to FALSE when Curl_do() is called and set to TRUE
488 when Curl_done() is called, to prevent Curl_done() to
489 get invoked twice when the multi interface is
491 bool stream_was_rewound; /* Indicates that the stream was rewound after a
492 request read past the end of its response byte
494 bool proxy_connect_closed; /* set true if a proxy disconnected the
495 connection in a CONNECT request with auth, so
496 that libcurl should reconnect and continue. */
497 bool bound; /* set true if bind() has already been done on this socket/
499 bool type_set; /* type= was used in the URL */
503 char *rawalloc; /* allocated "raw" version of the name */
504 char *encalloc; /* allocated IDN-encoded version of the name */
505 char *name; /* name to use internally, might be encoded, might be raw */
506 const char *dispname; /* name to display, as 'name' might be encoded */
510 * Flags on the keepon member of the Curl_transfer_keeper
514 #define KEEP_RECV (1<<0) /* there is or may be data to read */
515 #define KEEP_SEND (1<<1) /* there is or may be data to write */
516 #define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there
517 might still be data to read */
518 #define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there
519 might still be data to write */
520 #define KEEP_RECV_PAUSE (1<<4) /* reading is paused */
521 #define KEEP_SEND_PAUSE (1<<5) /* writing is paused */
523 #define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE)
524 #define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE)
529 ZLIB_UNINIT, /* uninitialized */
530 ZLIB_INIT, /* initialized */
531 ZLIB_GZIP_HEADER, /* reading gzip header */
532 ZLIB_GZIP_INFLATING, /* inflating gzip stream */
533 ZLIB_INIT_GZIP /* initialized in transparent gzip mode */
537 #ifdef CURLRES_ASYNCH
541 struct Curl_dns_entry *dns;
542 bool done; /* set TRUE when the lookup is complete */
543 int status; /* if done is TRUE, this is the status from the callback */
544 void *os_specific; /* 'struct thread_data' for Windows */
548 #define FIRSTSOCKET 0
549 #define SECONDARYSOCKET 1
551 /* These function pointer types are here only to allow easier typecasting
552 within the source when we need to cast between data pointers (such as NULL)
553 and function pointers. */
554 typedef CURLcode (*Curl_do_more_func)(struct connectdata *, bool *);
555 typedef CURLcode (*Curl_done_func)(struct connectdata *, CURLcode, bool);
559 EXP100_SEND_DATA, /* enough waiting, just send the body now */
560 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */
561 EXP100_SENDING_REQUEST, /* still sending the request but will wait for
562 the 100 header once done with the request */
563 EXP100_FAILED /* used on 417 Expectation Failed */
567 * Request specific data in the easy handle (SessionHandle). Previously,
568 * these members were on the connectdata struct but since a conn struct may
569 * now be shared between different SessionHandles, we store connection-specific
570 * data here. This struct only keeps stuff that's interesting for *this*
571 * request, as it will be cleared between multiple ones
573 struct SingleRequest {
574 curl_off_t size; /* -1 if unknown at this point */
575 curl_off_t *bytecountp; /* return number of bytes read or NULL */
577 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch,
578 -1 means unlimited */
579 curl_off_t *writebytecountp; /* return number of bytes written or NULL */
581 curl_off_t bytecount; /* total number of bytes read */
582 curl_off_t writebytecount; /* number of bytes written */
584 long headerbytecount; /* only count received headers */
585 long deductheadercount; /* this amount of bytes doesn't count when we check
586 if anything has been transferred at the end of a
587 connection. We use this counter to make only a
588 100 reply (without a following second response
589 code) result in a CURLE_GOT_NOTHING error code */
591 struct timeval start; /* transfer started at this time */
592 struct timeval now; /* current time */
593 bool header; /* incoming data has HTTP header */
595 HEADER_NORMAL, /* no bad header at all */
596 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest
598 HEADER_ALLBAD /* all was believed to be header */
599 } badheader; /* the header was deemed bad and will be
601 int headerline; /* counts header lines to better track the
603 char *hbufp; /* points at *end* of header line */
605 char *str; /* within buf */
606 char *str_start; /* within buf */
607 char *end_ptr; /* within buf */
608 char *p; /* within headerbuff */
609 bool content_range; /* set TRUE if Content-Range: was found */
610 curl_off_t offset; /* possible resume offset read from the
611 Content-Range: header */
612 int httpcode; /* error code from the 'HTTP/1.? XXX' or
613 'RTSP/1.? XXX' line */
614 struct timeval start100; /* time stamp to wait for the 100 code from */
615 enum expect100 exp100; /* expect 100 continue state */
617 int auto_decoding; /* What content encoding. sec 3.5, RFC2616. */
619 #define IDENTITY 0 /* No encoding */
620 #define DEFLATE 1 /* zlib deflate [RFC 1950 & 1951] */
621 #define GZIP 2 /* gzip algorithm [RFC 1952] */
622 #define COMPRESS 3 /* Not handled, added for completeness */
625 zlibInitState zlib_init; /* possible zlib init state;
626 undefined if Content-Encoding header. */
627 z_stream z; /* State structure for zlib. */
639 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
640 and we're uploading the last chunk */
642 bool ignorebody; /* we read a response-body but we ignore it! */
643 bool ignorecl; /* This HTTP response has no body so we ignore the Content-
646 char *location; /* This points to an allocated version of the Location:
648 char *newurl; /* Set to the new URL to use when a redirect or a retry is
651 /* 'upload_present' is used to keep a byte counter of how much data there is
652 still left in the buffer, aimed for upload. */
653 ssize_t upload_present;
655 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
656 buffer, so the next read should read from where this pointer points to,
657 and the 'upload_present' contains the number of bytes available at this
659 char *upload_fromhere;
661 bool chunk; /* if set, this is a chunked transfer-encoding */
662 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
664 bool getheader; /* TRUE if header parsing is wanted */
666 bool forbidchunk; /* used only to explicitly forbid chunk-upload for
667 specific upload buffers. See readmoredata() in
668 http.c for details. */
672 * Specific protocol handler.
675 struct Curl_handler {
676 const char * scheme; /* URL scheme name. */
678 /* Complement to setup_connection_internals(). */
679 CURLcode (*setup_connection)(struct connectdata *);
681 /* These two functions MUST be set to be protocol dependent */
682 CURLcode (*do_it)(struct connectdata *, bool *done);
685 /* If the curl_do() function is better made in two halves, this
686 * curl_do_more() function will be called afterwards, if set. For example
687 * for doing the FTP stuff after the PASV/PORT command.
689 Curl_do_more_func do_more;
691 /* This function *MAY* be set to a protocol-dependent function that is run
692 * after the connect() and everything is done, as a step in the connection.
693 * The 'done' pointer points to a bool that should be set to TRUE if the
694 * function completes before return. If it doesn't complete, the caller
695 * should call the curl_connecting() function until it is.
697 CURLcode (*connect_it)(struct connectdata *, bool *done);
699 /* See above. Currently only used for FTP. */
700 CURLcode (*connecting)(struct connectdata *, bool *done);
701 CURLcode (*doing)(struct connectdata *, bool *done);
703 /* Called from the multi interface during the PROTOCONNECT phase, and it
704 should then return a proper fd set */
705 int (*proto_getsock)(struct connectdata *conn,
706 curl_socket_t *socks,
709 /* Called from the multi interface during the DOING phase, and it should
710 then return a proper fd set */
711 int (*doing_getsock)(struct connectdata *conn,
712 curl_socket_t *socks,
715 /* Called from the multi interface during the DO_MORE phase, and it should
716 then return a proper fd set */
717 int (*domore_getsock)(struct connectdata *conn,
718 curl_socket_t *socks,
721 /* Called from the multi interface during the DO_DONE, PERFORM and
722 WAITPERFORM phases, and it should then return a proper fd set. Not setting
723 this will make libcurl use the generic default one. */
724 int (*perform_getsock)(const struct connectdata *conn,
725 curl_socket_t *socks,
728 /* This function *MAY* be set to a protocol-dependent function that is run
729 * by the curl_disconnect(), as a step in the disconnection. If the handler
730 * is called because the connection has been considered dead, dead_connection
733 CURLcode (*disconnect)(struct connectdata *, bool dead_connection);
735 /* If used, this function gets called from transfer.c:readwrite_data() to
736 allow the protocol to do extra reads/writes */
737 CURLcode (*readwrite)(struct SessionHandle *data, struct connectdata *conn,
738 ssize_t *nread, bool *readmore);
740 long defport; /* Default port. */
741 unsigned int protocol; /* See CURLPROTO_* */
742 unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */
745 #define PROTOPT_NONE 0 /* nothing extra */
746 #define PROTOPT_SSL (1<<0) /* uses SSL */
747 #define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */
748 #define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */
749 /* some protocols will have to call the underlying functions without regard to
750 what exact state the socket signals. IE even if the socket says "readable",
751 the send function might need to be called while uploading, or vice versa.
753 #define PROTOPT_DIRLOCK (1<<3)
754 #define PROTOPT_NONETWORK (1<<4) /* protocol doesn't use the network! */
755 #define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it
757 #define PROTOPT_NOURLQUERY (1<<6) /* protocol can't handle
758 url query strings (?foo=bar) ! */
761 /* return the count of bytes sent, or -1 on error */
762 typedef ssize_t (Curl_send)(struct connectdata *conn, /* connection data */
763 int sockindex, /* socketindex */
764 const void *buf, /* data to write */
765 size_t len, /* max amount to write */
766 CURLcode *err); /* error to return */
768 /* return the count of bytes read, or -1 on error */
769 typedef ssize_t (Curl_recv)(struct connectdata *conn, /* connection data */
770 int sockindex, /* socketindex */
771 char *buf, /* store data here */
772 size_t len, /* max amount to read */
773 CURLcode *err); /* error to return */
776 * The connectdata struct contains all fields and variables that should be
777 * unique for an entire connection.
780 /* 'data' is the CURRENT SessionHandle using this connection -- take great
781 caution that this might very well vary between different times this
782 connection is used! */
783 struct SessionHandle *data;
785 /* chunk is for HTTP chunked encoding, but is in the general connectdata
786 struct only because we can do just about any protocol through a HTTP proxy
787 and a HTTP proxy may in fact respond using chunked encoding */
788 struct Curl_chunker chunk;
790 curl_closesocket_callback fclosesocket; /* function closing the socket(s) */
791 void *closesocket_client;
793 bool inuse; /* This is a marker for the connection cache logic. If this is
794 TRUE this handle is being used by an easy handle and cannot
795 be used by any other easy handle without careful
796 consideration (== only for pipelining). */
798 /**** Fields set when inited and not modified again */
799 long connection_id; /* Contains a unique number to make it easier to
800 track the connections in the log output */
802 /* 'dns_entry' is the particular host we use. This points to an entry in the
803 DNS cache and it will not get pruned while locked. It gets unlocked in
804 Curl_done(). This entry will be NULL if the connection is re-used as then
805 there is no name resolve done. */
806 struct Curl_dns_entry *dns_entry;
808 /* 'ip_addr' is the particular IP we connected to. It points to a struct
809 within the DNS cache, so this pointer is only valid as long as the DNS
810 cache entry remains locked. It gets unlocked in Curl_done() */
811 Curl_addrinfo *ip_addr;
813 /* 'ip_addr_str' is the ip_addr data as a human readable string.
814 It remains available as long as the connection does, which is longer than
815 the ip_addr itself. */
816 char ip_addr_str[MAX_IPADR_LEN];
818 unsigned int scope; /* address scope for IPv6 */
820 int socktype; /* SOCK_STREAM or SOCK_DGRAM */
822 struct hostname host;
823 struct hostname proxy;
825 long port; /* which port to use locally */
826 unsigned short remote_port; /* what remote port to connect to,
827 not the proxy port! */
829 /* 'primary_ip' and 'primary_port' get filled with peer's numerical
830 ip address and port number whenever an outgoing connection is
831 *attempted* from the primary socket to a remote address. When more
832 than one address is tried for a connection these will hold data
833 for the last attempt. When the connection is actually established
834 these are updated with data which comes directly from the socket. */
836 char primary_ip[MAX_IPADR_LEN];
839 /* 'local_ip' and 'local_port' get filled with local's numerical
840 ip address and port number whenever an outgoing connection is
841 **established** from the primary socket to a remote address. */
843 char local_ip[MAX_IPADR_LEN];
846 char *user; /* user name string, allocated */
847 char *passwd; /* password string, allocated */
849 char *proxyuser; /* proxy user name string, allocated */
850 char *proxypasswd; /* proxy password string, allocated */
851 curl_proxytype proxytype; /* what kind of proxy that is in use */
853 int httpversion; /* the HTTP version*10 reported by the server */
854 int rtspversion; /* the RTSP version*10 reported by the server */
856 struct timeval now; /* "current" time */
857 struct timeval created; /* creation time */
858 curl_socket_t sock[2]; /* two sockets, the second is used for the data
859 transfer when doing FTP */
860 bool sock_accepted[2]; /* TRUE if the socket on this index was created with
865 struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */
866 struct ssl_config_data ssl_config;
868 struct ConnectBits bits; /* various state-flags for this connection */
870 /* connecttime: when connect() is called on the current IP address. Used to
871 be able to track when to move on to try next IP - but only when the multi
872 interface is used. */
873 struct timeval connecttime;
874 /* The two fields below get set in Curl_connecthost */
875 int num_addr; /* number of addresses to try to connect to */
876 long timeoutms_per_addr; /* how long time in milliseconds to spend on
877 trying to connect to each IP address */
879 const struct Curl_handler *handler; /* Connection's protocol handler */
880 const struct Curl_handler *given; /* The protocol first given */
882 long ip_version; /* copied from the SessionHandle at creation time */
884 /**** curl_get() phase fields */
886 curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */
887 curl_socket_t writesockfd; /* socket to write to, it may very
888 well be the same we read from.
889 CURL_SOCKET_BAD disables */
891 /** Dynamicly allocated strings, MUST be freed before this **/
892 /** struct is killed. **/
893 struct dynamically_allocated_data {
896 char *accept_encoding;
902 char *rtsp_transport;
903 char *te; /* TE: request header */
906 int sec_complete; /* if kerberos is enabled for this connection */
907 #if defined(HAVE_KRB4) || defined(HAVE_GSSAPI)
908 enum protection_level command_prot;
909 enum protection_level data_prot;
910 enum protection_level request_data_prot;
912 struct krb4buffer in_buffer;
914 const struct Curl_sec_client_mech *mech;
915 struct sockaddr_in local_addr;
918 /* the two following *_inuse fields are only flags, not counters in any way.
919 If TRUE it means the channel is in use, and if FALSE it means the channel
920 is up for grabs by one. */
922 bool readchannel_inuse; /* whether the read channel is in use by an easy
924 bool writechannel_inuse; /* whether the write channel is in use by an easy
926 bool server_supports_pipelining; /* TRUE if server supports pipelining,
927 set after first response */
928 struct curl_llist *send_pipe; /* List of handles waiting to
929 send on this pipeline */
930 struct curl_llist *recv_pipe; /* List of handles waiting to read
931 their responses on this pipeline */
932 struct curl_llist *pend_pipe; /* List of pending handles on
934 struct curl_llist *done_pipe; /* Handles that are finished, but
935 still reference this connectdata */
936 #define MAX_PIPELINE_LENGTH 5
937 char* master_buffer; /* The master buffer allocated on-demand;
938 used for pipelining. */
939 size_t read_pos; /* Current read position in the master buffer */
940 size_t buf_len; /* Length of the buffer?? */
943 curl_seek_callback seek_func; /* function that seeks the input */
944 void *seek_client; /* pointer to pass to the seek() above */
946 /*************** Request - specific items ************/
948 /* previously this was in the urldata struct */
949 curl_read_callback fread_func; /* function that reads the input */
950 void *fread_in; /* pointer to pass to the fread() above */
952 struct ntlmdata ntlm; /* NTLM differs from other authentication schemes
953 because it authenticates connections, not
955 struct ntlmdata proxyntlm; /* NTLM data for proxy */
957 #if defined(USE_NTLM) && defined(NTLM_WB_ENABLED)
958 /* used for communication with Samba's winbind daemon helper ntlm_auth */
959 curl_socket_t ntlm_auth_hlpr_socket;
960 pid_t ntlm_auth_hlpr_pid;
961 char* challenge_header;
962 char* response_header;
965 char syserr_buf [256]; /* buffer for Curl_strerror() */
967 #ifdef CURLRES_ASYNCH
968 /* data used for the asynch name resolve callback */
969 struct Curl_async async;
972 /* These three are used for chunked-encoding trailer support */
973 char *trailer; /* allocated buffer to store trailer in */
974 int trlMax; /* allocated buffer size */
975 int trlPos; /* index of where to store data */
978 struct ftp_conn ftpc;
979 struct ssh_conn sshc;
980 struct tftp_state_data *tftpc;
981 struct imap_conn imapc;
982 struct pop3_conn pop3c;
983 struct smtp_conn smtpc;
984 struct rtsp_conn rtspc;
988 int cselect_bits; /* bitmask of socket events */
989 int waitfor; /* current READ/WRITE bits to wait for */
991 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
992 int socks5_gssapi_enctype;
998 /* When this connection is created, store the conditions for the local end
999 bind. This is stored before the actual bind and before any connection is
1000 made and will serve the purpose of being used for comparison reasons so
1001 that subsequent bound-requested connections aren't accidentally re-using
1002 wrong connections. */
1004 unsigned short localport;
1007 /* tunnel as in tunnel through a HTTP proxy with CONNECT */
1009 TUNNEL_INIT, /* init/default/no tunnel state */
1010 TUNNEL_CONNECT, /* CONNECT has been sent off */
1011 TUNNEL_COMPLETE /* CONNECT response received completely */
1012 } tunnel_state[2]; /* two separate ones to allow FTP */
1014 struct connectbundle *bundle; /* The bundle we are member of */
1017 /* The end of connectdata. */
1020 * Struct to keep statistical and informational data.
1023 int httpcode; /* Recent HTTP, FTP, or RTSP response code */
1024 int httpproxycode; /* response code from proxy when received separate */
1025 int httpversion; /* the http version number X.Y = X*10+Y */
1026 long filetime; /* If requested, this is might get set. Set to -1 if the time
1027 was unretrievable. We cannot have this of type time_t,
1028 since time_t is unsigned on several platforms such as
1030 bool timecond; /* set to TRUE if the time condition didn't match, which
1031 thus made the document NOT get fetched */
1032 long header_size; /* size of read header(s) in bytes */
1033 long request_size; /* the amount of bytes sent in the request(s) */
1034 unsigned long proxyauthavail; /* what proxy auth types were announced */
1035 unsigned long httpauthavail; /* what host auth types were announced */
1036 long numconnects; /* how many new connection did libcurl created */
1037 char *contenttype; /* the content type of the object */
1038 char *wouldredirect; /* URL this would've been redirected to if asked to */
1040 /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip'
1041 and, 'conn_local_port' are copied over from the connectdata struct in
1042 order to allow curl_easy_getinfo() to return this information even when
1043 the session handle is no longer associated with a connection, and also
1044 allow curl_easy_reset() to clear this information from the session handle
1045 without disturbing information which is still alive, and that might be
1046 reused, in the connection cache. */
1048 char conn_primary_ip[MAX_IPADR_LEN];
1049 long conn_primary_port;
1051 char conn_local_ip[MAX_IPADR_LEN];
1052 long conn_local_port;
1054 struct curl_certinfo certs; /* info about the certs, only populated in
1055 OpenSSL builds. Asked for with
1056 CURLOPT_CERTINFO / CURLINFO_CERTINFO */
1061 long lastshow; /* time() of the last displayed progress meter or NULL to
1062 force redraw at next call */
1063 curl_off_t size_dl; /* total expected size */
1064 curl_off_t size_ul; /* total expected size */
1065 curl_off_t downloaded; /* transferred so far */
1066 curl_off_t uploaded; /* transferred so far */
1068 curl_off_t current_speed; /* uses the currently fastest transfer */
1070 bool callback; /* set when progress callback is used */
1071 int width; /* screen width at download start */
1072 int flags; /* see progress.h */
1081 double t_appconnect;
1082 double t_pretransfer;
1083 double t_starttransfer;
1086 struct timeval start;
1087 struct timeval t_startsingle;
1088 struct timeval t_acceptdata;
1089 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
1091 curl_off_t speeder[ CURR_TIME ];
1092 struct timeval speeder_time[ CURR_TIME ];
1097 HTTPREQ_NONE, /* first in list */
1100 HTTPREQ_POST_FORM, /* we make a difference internally */
1104 HTTPREQ_LAST /* last in list */
1108 RTSPREQ_NONE, /* first in list */
1116 RTSPREQ_GET_PARAMETER,
1117 RTSPREQ_SET_PARAMETER,
1120 RTSPREQ_LAST /* last in list */
1124 * Values that are generated, temporary or calculated internally for a
1125 * "session handle" must be defined within the 'struct UrlState'. This struct
1126 * will be used within the SessionHandle struct. When the 'SessionHandle'
1127 * struct is cloned, this data MUST NOT be copied.
1129 * Remember that any "state" information goes globally for the curl handle.
1130 * Session-data MUST be put in the connectdata struct and here. */
1131 #define MAX_CURL_USER_LENGTH 256
1132 #define MAX_CURL_PASSWORD_LENGTH 256
1133 #define MAX_CURL_USER_LENGTH_TXT "255"
1134 #define MAX_CURL_PASSWORD_LENGTH_TXT "255"
1137 unsigned long want; /* Bitmask set to the authentication methods wanted by
1138 app (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */
1139 unsigned long picked;
1140 unsigned long avail; /* Bitmask for what the server reports to support for
1142 bool done; /* TRUE when the auth phase is done and ready to do the *actual*
1144 bool multi; /* TRUE if this is not yet authenticated but within the auth
1145 multipass negotiation */
1146 bool iestyle; /* TRUE if digest should be done IE-style or FALSE if it should
1152 /* Points to the connection cache */
1153 struct conncache *conn_cache;
1155 /* when curl_easy_perform() is called, the multi handle is "owned" by
1156 the easy handle so curl_easy_cleanup() on such an easy handle will
1157 also close the multi handle! */
1158 bool multi_owned_by_easy;
1160 /* buffers to store authentication data in, as parsed from input options */
1161 struct timeval keeps_speed; /* for the progress meter really */
1163 struct connectdata *pending_conn; /* This points to the connection we want
1164 to open when we are waiting in the
1165 CONNECT_PEND state in the multi
1166 interface. This to avoid recreating it
1167 when we enter the CONNECT state again.
1170 struct connectdata *lastconnect; /* The last connection, NULL if undefined */
1172 char *headerbuff; /* allocated buffer to store headers in */
1173 size_t headersize; /* size of the allocation */
1175 char buffer[BUFSIZE+1]; /* download buffer */
1176 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
1177 curl_off_t current_speed; /* the ProgressShow() funcion sets this,
1179 bool this_is_a_follow; /* this is a followed Location: request */
1181 char *first_host; /* if set, this should be the host name that we will
1182 sent authorization to, no else. Used to make Location:
1183 following not keep sending user+password... This is
1186 struct curl_ssl_session *session; /* array of 'max_ssl_sessions' size */
1187 long sessionage; /* number of the most recent session */
1188 char *tempwrite; /* allocated buffer to keep data in when a write
1189 callback returns to make the connection paused */
1190 size_t tempwritesize; /* size of the 'tempwrite' allocated buffer */
1191 int tempwritetype; /* type of the 'tempwrite' buffer as a bitmask that is
1192 used with Curl_client_write() */
1193 char *scratch; /* huge buffer[BUFSIZE*2] when doing upload CRLF replacing */
1194 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
1195 This must be set to FALSE every time _easy_perform() is
1197 int os_errno; /* filled in with errno whenever an error occurs */
1199 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
1200 void (*prev_signal)(int sig);
1202 bool allow_port; /* Is set.use_port allowed to take effect or not. This
1203 is always set TRUE when curl_easy_perform() is called. */
1204 struct digestdata digest; /* state data for host Digest auth */
1205 struct digestdata proxydigest; /* state data for proxy Digest auth */
1207 #ifdef USE_HTTP_NEGOTIATE
1208 struct negotiatedata negotiate; /* state data for host Negotiate auth */
1209 struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */
1212 struct auth authhost; /* auth details for host */
1213 struct auth authproxy; /* auth details for proxy */
1215 bool authproblem; /* TRUE if there's some problem authenticating */
1217 void *resolver; /* resolver state, if it is used in the URL state -
1218 ares_channel f.e. */
1220 #if defined(USE_SSLEAY) && defined(HAVE_OPENSSL_ENGINE_H)
1222 #endif /* USE_SSLEAY */
1223 struct timeval expiretime; /* set this with Curl_expire() only */
1224 struct Curl_tree timenode; /* for the splay stuff */
1225 struct curl_llist *timeoutlist; /* list of pending timeouts */
1227 /* a place to store the most recently set FTP entrypath */
1228 char *most_recent_ftp_entrypath;
1230 /* set after initial USER failure, to prevent an authentication loop */
1231 bool ftp_trying_alternative;
1233 int httpversion; /* the lowest HTTP version*10 reported by any server
1234 involved in this request */
1235 bool expect100header; /* TRUE if we added Expect: 100-continue */
1237 bool pipe_broke; /* TRUE if the connection we were pipelined on broke
1238 and we need to restart from the beginning */
1240 #if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) && \
1241 !defined(__SYMBIAN32__)
1242 /* do FTP line-end conversions on most platforms */
1243 #define CURL_DO_LINEEND_CONV
1244 /* for FTP downloads: track CRLF sequences that span blocks */
1245 bool prev_block_had_trailing_cr;
1246 /* for FTP downloads: how many CRLFs did we converted to LFs? */
1247 curl_off_t crlf_conversions;
1249 char *pathbuffer;/* allocated buffer to store the URL's path part in */
1250 char *path; /* path to use, points to somewhere within the pathbuffer
1252 bool slash_removed; /* set TRUE if the 'path' points to a path where the
1253 initial URL slash separator has been taken off */
1255 bool rangestringalloc; /* the range string is malloc()'ed */
1257 char *range; /* range, if used. See README for detailed specification on
1259 curl_off_t resume_from; /* continue [ftp] transfer from here */
1261 /* This RTSP state information survives requests and connections */
1262 long rtsp_next_client_CSeq; /* the session's next client CSeq */
1263 long rtsp_next_server_CSeq; /* the session's next server CSeq */
1264 long rtsp_CSeq_recv; /* most recent CSeq received */
1266 /* Protocol specific data.
1268 *************************************************************************
1269 * Note that this data will be REMOVED after each request, so anything that
1270 * should be kept/stored on a per-connection basis and thus live for the
1271 * next request on the same connection MUST be put in the connectdata struct!
1272 *************************************************************************/
1275 struct HTTP *https; /* alias, just for the sake of being more readable */
1278 /* void *tftp; not used */
1279 struct FILEPROTO *file;
1280 void *telnet; /* private for telnet.c-eyes only */
1282 struct SSHPROTO *ssh;
1287 /* current user of this SessionHandle instance, or NULL */
1288 struct connectdata *current_conn;
1290 /* if true, force SSL connection retry (workaround for certain servers) */
1291 bool ssl_connect_retry;
1296 * This 'DynamicStatic' struct defines dynamic states that actually change
1297 * values in the 'UserDefined' area, which MUST be taken into consideration
1298 * if the UserDefined struct is cloned or similar. You can probably just
1299 * copy these, but each one indicate a special action on other data.
1302 struct DynamicStatic {
1303 char *url; /* work URL, copied from UserDefined */
1304 bool url_alloc; /* URL string is malloc()'ed */
1305 char *referer; /* referer string */
1306 bool referer_alloc; /* referer sting is malloc()ed */
1307 struct curl_slist *cookielist; /* list of cookie files set by
1308 curl_easy_setopt(COOKIEFILE) calls */
1309 struct curl_slist *resolve; /* set to point to the set.resolve list when
1310 this should be dealt with in pretransfer */
1314 * This 'UserDefined' struct must only contain data that is set once to go
1315 * for many (perhaps) independent connections. Values that are generated or
1316 * calculated internally for the "session handle" MUST be defined within the
1317 * 'struct UrlState' instead. The only exceptions MUST note the changes in
1318 * the 'DynamicStatic' struct.
1319 * Character pointer fields point to dynamic storage, unless otherwise stated.
1321 struct Curl_one_easy; /* declared and used only in multi.c */
1322 struct Curl_multi; /* declared and used only in multi.c */
1325 STRING_CERT, /* client certificate file name */
1326 STRING_CERT_TYPE, /* format for certificate (default: PEM)*/
1327 STRING_COOKIE, /* HTTP cookie string to send */
1328 STRING_COOKIEJAR, /* dump all cookies to this file */
1329 STRING_CUSTOMREQUEST, /* HTTP/FTP/RTSP request/method to use */
1330 STRING_DEVICE, /* local network interface/address to use */
1331 STRING_ENCODING, /* Accept-Encoding string */
1332 STRING_FTP_ACCOUNT, /* ftp account data */
1333 STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */
1334 STRING_FTPPORT, /* port to send with the FTP PORT command */
1335 STRING_KEY, /* private key file name */
1336 STRING_KEY_PASSWD, /* plain text private key password */
1337 STRING_KEY_TYPE, /* format for private key (default: PEM) */
1338 STRING_KRB_LEVEL, /* krb security level */
1339 STRING_NETRC_FILE, /* if not NULL, use this instead of trying to find
1341 STRING_COPYPOSTFIELDS, /* if POST, set the fields' values here */
1342 STRING_PROXY, /* proxy to use */
1343 STRING_SET_RANGE, /* range, if used */
1344 STRING_SET_REFERER, /* custom string for the HTTP referer field */
1345 STRING_SET_URL, /* what original URL to work on */
1346 STRING_SSL_CAPATH, /* CA directory name (doesn't work on windows) */
1347 STRING_SSL_CAFILE, /* certificate file to verify peer against */
1348 STRING_SSL_CIPHER_LIST, /* list of ciphers to use */
1349 STRING_SSL_EGDSOCKET, /* path to file containing the EGD daemon socket */
1350 STRING_SSL_RANDOM_FILE, /* path to file containing "random" data */
1351 STRING_USERAGENT, /* User-Agent string */
1352 STRING_SSL_CRLFILE, /* crl file to check certificate */
1353 STRING_SSL_ISSUERCERT, /* issuer cert file to check certificate */
1354 STRING_USERNAME, /* <username>, if used */
1355 STRING_PASSWORD, /* <password>, if used */
1356 STRING_PROXYUSERNAME, /* Proxy <username>, if used */
1357 STRING_PROXYPASSWORD, /* Proxy <password>, if used */
1358 STRING_NOPROXY, /* List of hosts which should not use the proxy, if
1360 STRING_RTSP_SESSION_ID, /* Session ID to use */
1361 STRING_RTSP_STREAM_URI, /* Stream URI for this request */
1362 STRING_RTSP_TRANSPORT, /* Transport for this session */
1364 STRING_SSH_PRIVATE_KEY, /* path to the private key file for auth */
1365 STRING_SSH_PUBLIC_KEY, /* path to the public key file for auth */
1366 STRING_SSH_HOST_PUBLIC_KEY_MD5, /* md5 of host public key in ascii hex */
1367 STRING_SSH_KNOWNHOSTS, /* file name of knownhosts file */
1369 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1370 STRING_SOCKS5_GSSAPI_SERVICE, /* GSSAPI service name */
1376 STRING_TLSAUTH_USERNAME, /* TLS auth <username> */
1377 STRING_TLSAUTH_PASSWORD, /* TLS auth <password> */
1380 /* -- end of strings -- */
1381 STRING_LAST /* not used, just an end-of-list marker */
1384 struct UserDefined {
1385 FILE *err; /* the stderr user data goes here */
1386 void *debugdata; /* the data that will be passed to fdebug */
1387 char *errorbuffer; /* (Static) store failure messages in here */
1388 long proxyport; /* If non-zero, use this port number by default. If the
1389 proxy string features a ":[port]" that one will override
1391 void *out; /* the fetched file goes here */
1392 void *in; /* the uploaded file is read from here */
1393 void *writeheader; /* write the header to this if non-NULL */
1394 void *rtp_out; /* write RTP to this if non-NULL */
1395 long use_port; /* which port to use (when not using default) */
1396 unsigned long httpauth; /* kind of HTTP authentication to use (bitmask) */
1397 unsigned long proxyauth; /* kind of proxy authentication to use (bitmask) */
1398 long followlocation; /* as in HTTP Location: */
1399 long maxredirs; /* maximum no. of http(s) redirects to follow, set to -1
1402 int keep_post; /* keep POSTs as POSTs after a 30x request; each
1403 bit represents a request, from 301 to 303 */
1404 bool free_referer; /* set TRUE if 'referer' points to a string we
1406 void *postfields; /* if POST, set the fields' values here */
1407 curl_seek_callback seek_func; /* function that seeks the input */
1408 curl_off_t postfieldsize; /* if POST, this might have a size to use instead
1409 of strlen(), and then the data *may* be binary
1410 (contain zero bytes) */
1411 unsigned short localport; /* local port number to bind to */
1412 int localportrange; /* number of additional port numbers to test in case the
1413 'localport' one can't be bind()ed */
1414 curl_write_callback fwrite_func; /* function that stores the output */
1415 curl_write_callback fwrite_header; /* function that stores headers */
1416 curl_write_callback fwrite_rtp; /* function that stores interleaved RTP */
1417 curl_read_callback fread_func; /* function that reads the input */
1418 int is_fread_set; /* boolean, has read callback been set to non-NULL? */
1419 int is_fwrite_set; /* boolean, has write callback been set to non-NULL? */
1420 curl_progress_callback fprogress; /* function for progress information */
1421 curl_debug_callback fdebug; /* function that write informational data */
1422 curl_ioctl_callback ioctl_func; /* function for I/O control */
1423 curl_sockopt_callback fsockopt; /* function for setting socket options */
1424 void *sockopt_client; /* pointer to pass to the socket options callback */
1425 curl_opensocket_callback fopensocket; /* function for checking/translating
1426 the address and opening the
1428 void* opensocket_client;
1429 curl_closesocket_callback fclosesocket; /* function for closing the
1431 void* closesocket_client;
1433 void *seek_client; /* pointer to pass to the seek callback */
1434 /* the 3 curl_conv_callback functions below are used on non-ASCII hosts */
1435 /* function to convert from the network encoding: */
1436 curl_conv_callback convfromnetwork;
1437 /* function to convert to the network encoding: */
1438 curl_conv_callback convtonetwork;
1439 /* function to convert from UTF-8 encoding: */
1440 curl_conv_callback convfromutf8;
1442 void *progress_client; /* pointer to pass to the progress callback */
1443 void *ioctl_client; /* pointer to pass to the ioctl callback */
1444 long timeout; /* in milliseconds, 0 means no timeout */
1445 long connecttimeout; /* in milliseconds, 0 means no timeout */
1446 long accepttimeout; /* in milliseconds, 0 means no timeout */
1447 long server_response_timeout; /* in milliseconds, 0 means no timeout */
1448 long tftp_blksize ; /* in bytes, 0 means use default */
1449 curl_off_t infilesize; /* size of file to upload, -1 means unknown */
1450 long low_speed_limit; /* bytes/second */
1451 long low_speed_time; /* number of seconds */
1452 curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */
1453 curl_off_t max_recv_speed; /* high speed limit in bytes/second for
1455 curl_off_t set_resume_from; /* continue [ftp] transfer from here */
1456 struct curl_slist *headers; /* linked list of extra headers */
1457 struct curl_httppost *httppost; /* linked list of POST data */
1458 bool cookiesession; /* new cookie session? */
1459 bool crlf; /* convert crlf on ftp upload(?) */
1460 struct curl_slist *quote; /* after connection is established */
1461 struct curl_slist *postquote; /* after the transfer */
1462 struct curl_slist *prequote; /* before the transfer, after type */
1463 struct curl_slist *source_quote; /* 3rd party quote */
1464 struct curl_slist *source_prequote; /* in 3rd party transfer mode - before
1465 the transfer on source host */
1466 struct curl_slist *source_postquote; /* in 3rd party transfer mode - after
1467 the transfer on source host */
1468 struct curl_slist *telnet_options; /* linked list of telnet options */
1469 struct curl_slist *resolve; /* list of names to add/remove from
1471 curl_TimeCond timecondition; /* kind of time/date comparison */
1472 time_t timevalue; /* what time to compare with */
1473 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
1474 long httpversion; /* when non-zero, a specific HTTP version requested to
1475 be used in the library's request(s) */
1476 struct ssl_config_data ssl; /* user defined SSL stuff */
1477 curl_proxytype proxytype; /* what kind of proxy that is in use */
1478 long dns_cache_timeout; /* DNS cache timeout */
1479 long buffer_size; /* size of receive buffer to use */
1480 void *private_data; /* application-private data */
1482 struct Curl_one_easy *one_easy; /* When adding an easy handle to a multi
1483 handle, an internal 'Curl_one_easy'
1484 struct is created and this is a pointer
1485 to the particular struct associated with
1486 this SessionHandle */
1488 struct curl_slist *http200aliases; /* linked list of aliases for http200 */
1490 long ipver; /* the CURL_IPRESOLVE_* defines in the public header file
1491 0 - whatever, 1 - v2, 2 - v6 */
1493 curl_off_t max_filesize; /* Maximum file size to download */
1495 curl_ftpfile ftp_filemethod; /* how to get to a file when FTP is used */
1497 int ftp_create_missing_dirs; /* 1 - create directories that don't exist
1498 2 - the same but also allow MKD to fail once
1501 curl_sshkeycallback ssh_keyfunc; /* key matching callback */
1502 void *ssh_keyfunc_userp; /* custom pointer to callback */
1504 /* Here follows boolean settings that define how to behave during
1505 this session. They are STATIC, set by libcurl users or at least initially
1506 and they don't change during operations. */
1508 bool printhost; /* printing host name in debug info */
1509 bool get_filetime; /* get the time and get of the remote file */
1510 bool tunnel_thru_httpproxy; /* use CONNECT through a HTTP proxy */
1511 bool prefer_ascii; /* ASCII rather than binary */
1512 bool ftp_append; /* append, not overwrite, on upload */
1513 bool ftp_list_only; /* switch FTP command for listing directories */
1514 bool ftp_use_port; /* use the FTP PORT command */
1515 bool hide_progress; /* don't use the progress meter */
1516 bool http_fail_on_error; /* fail on HTTP error codes >= 300 */
1517 bool http_follow_location; /* follow HTTP redirects */
1518 bool http_transfer_encoding; /* request compressed HTTP transfer-encoding */
1519 bool http_disable_hostname_check_before_authentication;
1520 bool include_header; /* include received protocol headers in data output */
1521 bool http_set_referer; /* is a custom referer used */
1522 bool http_auto_referer; /* set "correct" referer when following location: */
1523 bool opt_no_body; /* as set with CURLOPT_NO_BODY */
1524 bool set_port; /* custom port number used */
1525 bool upload; /* upload request */
1526 enum CURL_NETRC_OPTION
1527 use_netrc; /* defined in include/curl.h */
1528 bool verbose; /* output verbosity */
1529 bool krb; /* kerberos connection requested */
1530 bool reuse_forbid; /* forbidden to be reused, close after use */
1531 bool reuse_fresh; /* do not re-use an existing connection */
1532 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
1533 bool ftp_use_eprt; /* if EPRT is to be attempted or not */
1534 bool ftp_use_pret; /* if PRET is to be used before PASV or not */
1536 curl_usessl use_ssl; /* if AUTH TLS is to be attempted etc, for FTP or
1537 IMAP or POP3 or others! */
1538 curl_ftpauth ftpsslauth; /* what AUTH XXX to be attempted */
1539 curl_ftpccc ftp_ccc; /* FTP CCC options */
1540 bool no_signal; /* do not use any signal/alarm handler */
1541 bool global_dns_cache; /* subject for future removal */
1542 bool tcp_nodelay; /* whether to enable TCP_NODELAY or not */
1543 bool ignorecl; /* ignore content length */
1544 bool ftp_skip_ip; /* skip the IP address the FTP server passes on to
1546 bool connect_only; /* make connection, let application use the socket */
1547 bool ssl_enable_beast; /* especially allow this flaw for interoperability's
1549 long ssh_auth_types; /* allowed SSH auth types */
1550 bool http_te_skip; /* pass the raw body data to the user, even when
1551 transfer-encoded (chunked, compressed) */
1552 bool http_ce_skip; /* pass the raw body data to the user, even when
1553 content-encoded (chunked, compressed) */
1554 long new_file_perms; /* Permissions to use when creating remote files */
1555 long new_directory_perms; /* Permissions to use when creating remote dirs */
1556 bool proxy_transfer_mode; /* set transfer mode (;type=<a|i>) when doing FTP
1557 via an HTTP proxy */
1558 char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */
1559 unsigned int scope; /* address scope for IPv6 */
1560 long allowed_protocols;
1561 long redir_protocols;
1562 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1563 long socks5_gssapi_nec; /* flag to support nec socks5 server */
1565 struct curl_slist *mail_rcpt; /* linked list of mail recipients */
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 {
1610 struct Curl_multi *multi; /* if non-NULL, points to the multi handle
1611 struct to which this "belongs" when used by
1612 the multi interface */
1613 struct Curl_multi *multi_easy; /* if non-NULL, points to the multi handle
1614 struct to which this "belongs" when used
1615 by the easy interface */
1616 struct Curl_one_easy *multi_pos; /* if non-NULL, points to its position
1617 in multi controlling structure to assist
1619 struct Curl_share *share; /* Share, handles global variable mutexing */
1620 struct SingleRequest req; /* Request-specific data */
1621 struct UserDefined set; /* values set by the libcurl user */
1622 struct DynamicStatic change; /* possibly modified userdefined data */
1623 struct CookieInfo *cookies; /* the cookies, read from files and servers.
1624 NOTE that the 'cookie' field in the
1625 UserDefined struct defines if the "engine"
1626 is to be used or not. */
1627 struct Progress progress; /* for all the progress meter data */
1628 struct UrlState state; /* struct for fields used for state info and
1629 other dynamic purposes */
1630 struct WildcardData wildcard; /* wildcard download state info */
1631 struct PureInfo info; /* stats, reports and info data */
1632 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
1633 iconv_t outbound_cd; /* for translating to the network encoding */
1634 iconv_t inbound_cd; /* for translating from the network encoding */
1635 iconv_t utf8_cd; /* for translating to UTF8 */
1636 #endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */
1637 unsigned int magic; /* set to a CURLEASY_MAGIC_NUMBER */
1640 #define LIBCURL_NAME "libcurl"
1642 #endif /* HEADER_CURL_URLDATA_H */
projects / platform / upstream / curl.git / blob