1 #ifndef HEADER_CURL_URLDATA_H
2 #define HEADER_CURL_URLDATA_H
3 /***************************************************************************
5 * Project ___| | | | _ \| |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 1998 - 2012, 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 */
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 #include <cyassl/openssl/ssl.h>
128 #include <axTLS/ssl.h>
132 #endif /* USE_AXTLS */
134 #ifdef HAVE_NETINET_IN_H
135 #include <netinet/in.h>
141 #include <zlib.h> /* for content-encoding */
143 /* zlib pollutes the namespace with this definition */
148 #include <curl/curl.h>
150 #include "http_chunks.h" /* for the structs and enum stuff */
163 #include "wildcard.h"
168 # elif defined HAVE_GSSMIT
169 # include <gssapi/gssapi.h>
170 # include <gssapi/gssapi_generic.h>
176 #ifdef HAVE_LIBSSH2_H
178 #include <libssh2_sftp.h>
179 #endif /* HAVE_LIBSSH2_H */
181 /* Download buffer size, keep it fairly big for speed reasons */
183 #define BUFSIZE CURL_MAX_WRITE_SIZE
185 /* Initial size of the buffer to store headers in, it'll be enlarged in case
187 #define HEADERSIZE 256
189 #define CURLEASY_MAGIC_NUMBER 0xc0dedbadU
191 /* Some convenience macros to get the larger/smaller value out of two given.
192 We prefix with CURL to prevent name collisions. */
193 #define CURLMAX(x,y) ((x)>(y)?(x):(y))
194 #define CURLMIN(x,y) ((x)<(y)?(x):(y))
197 #if defined(HAVE_KRB4) || defined(HAVE_GSSAPI)
198 /* Types needed for krb4/5-ftp connections */
206 enum protection_level {
207 PROT_NONE, /* first in list */
213 PROT_LAST /* last in list */
217 /* enum for the nonblocking SSL connection state machine */
221 ssl_connect_2_reading,
222 ssl_connect_2_writing,
229 ssl_connection_negotiating,
230 ssl_connection_complete
231 } ssl_connection_state;
233 /* struct for data related to each SSL connection */
234 struct ssl_connect_data {
235 /* Use ssl encrypted communications TRUE/FALSE, not necessarily using it atm
236 but at least asked to or meaning to use it. See 'state' for the exact
237 current state of the connection. */
239 ssl_connection_state state;
241 /* these ones requires specific SSL-types */
245 ssl_connect_state connecting_state;
246 #endif /* USE_SSLEAY */
248 gnutls_session session;
249 gnutls_certificate_credentials cred;
251 gnutls_srp_client_credentials srp_client_cred;
253 ssl_connect_state connecting_state;
254 #endif /* USE_GNUTLS */
264 ssl_connect_state connecting_state;
265 #endif /* USE_POLARSSL */
269 ssl_connect_state connecting_state;
270 #endif /* USE_CYASSL */
273 char *client_nickname;
274 struct SessionHandle *data;
275 #ifdef HAVE_PK11_CREATEGENERICOBJECT
276 struct curl_llist *obj_list;
277 PK11GenericObject *obj_clicert;
282 #endif /* USE_QSOSSL */
286 #endif /* USE_AXTLS */
289 struct ssl_config_data {
290 long version; /* what version the client wants to use */
291 long certverifyresult; /* result from the certificate verification */
292 long verifypeer; /* set TRUE if this is desired */
293 long verifyhost; /* 0: no verify
294 1: check that CN exists
295 2: CN must match hostname */
296 char *CApath; /* certificate dir (doesn't work on windows) */
297 char *CAfile; /* certificate to verify peer against */
298 const char *CRLfile; /* CRL to check certificate revocation */
299 const char *issuercert;/* optional issuer certificate filename */
300 char *random_file; /* path to file containing "random" data */
301 char *egdsocket; /* path to file containing the EGD daemon socket */
302 char *cipher_list; /* list of ciphers to use */
303 size_t max_ssl_sessions; /* SSL session id cache size */
304 curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */
305 void *fsslctxp; /* parameter for call back */
306 bool sessionid; /* cache session IDs or not */
307 bool certinfo; /* gather lots of certificate info */
310 char *username; /* TLS username (for, e.g., SRP) */
311 char *password; /* TLS password (for, e.g., SRP) */
312 enum CURL_TLSAUTH authtype; /* TLS authentication type (default SRP) */
316 /* information stored about one single SSL session */
317 struct curl_ssl_session {
318 char *name; /* host name for which this ID was used */
319 void *sessionid; /* as returned from the SSL layer */
320 size_t idsize; /* if known, otherwise 0 */
321 long age; /* just a number, the higher the more recent */
322 unsigned short remote_port; /* remote port to connect to */
323 struct ssl_config_data ssl_config; /* setup for this session */
326 /* Struct used for Digest challenge-response authentication */
332 bool stale; /* set true for re-negotiation */
336 int nc; /* nounce count */
347 #ifdef USE_WINDOWS_SSPI
348 #include "curl_sspi.h"
351 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
355 /* Struct used for NTLM challenge-response authentication */
358 #ifdef USE_WINDOWS_SSPI
361 SEC_WINNT_AUTH_IDENTITY identity;
362 SEC_WINNT_AUTH_IDENTITY *p_identity;
365 unsigned long n_type_2;
368 unsigned char nonce[8];
372 #ifdef USE_HTTP_NEGOTIATE
373 struct negotiatedata {
374 /* when doing Negotiate we first need to receive an auth token and then we
375 need to send our header */
376 enum { GSS_AUTHNONE, GSS_AUTHRECV, GSS_AUTHSENT } state;
377 bool gss; /* Whether we're processing GSS-Negotiate or Negotiate */
378 const char* protocol; /* "GSS-Negotiate" or "Negotiate" */
381 gss_ctx_id_t context;
382 gss_name_t server_name;
383 gss_buffer_desc output_token;
385 #ifdef USE_WINDOWS_SSPI
388 CredHandle *credentials;
389 char server_name[1024];
390 size_t max_token_length;
392 size_t output_token_length;
400 * Boolean values that concerns this connection.
403 bool close; /* if set, we close the connection after this request */
404 bool reuse; /* if set, this is a re-used connection */
405 bool proxy; /* if set, this transfer is done through a proxy - any type */
406 bool httpproxy; /* if set, this transfer is done through a http proxy */
407 bool user_passwd; /* do we use user+password for this connection? */
408 bool proxy_user_passwd; /* user+password for the proxy? */
409 bool ipv6_ip; /* we communicate with a remote site specified with pure IPv6
411 bool ipv6; /* we communicate with a site using an IPv6 address */
413 bool do_more; /* this is set TRUE if the ->curl_do_more() function is
414 supposed to be called, after ->curl_do() */
415 bool tcpconnect[2]; /* the TCP layer (or similar) is connected, this is set
416 the first time on the first connect function call */
417 bool protoconnstart;/* the protocol layer has STARTED its operation after
418 the TCP layer connect */
420 bool retry; /* this connection is about to get closed and then
421 re-attempted at another connection. */
422 bool tunnel_proxy; /* if CONNECT is used to "tunnel" through the proxy.
423 This is implicit when SSL-protocols are used through
424 proxies, but can also be enabled explicitly by
426 bool authneg; /* TRUE when the auth phase has started, which means
427 that we are creating a request with an auth header,
428 but it is not the final request in the auth
430 bool rewindaftersend;/* TRUE when the sending couldn't be stopped even
431 though it will be discarded. When the whole send
432 operation is done, we must call the data rewind
434 bool ftp_use_epsv; /* As set with CURLOPT_FTP_USE_EPSV, but if we find out
435 EPSV doesn't work we disable it for the forthcoming
438 bool ftp_use_eprt; /* As set with CURLOPT_FTP_USE_EPRT, but if we find out
439 EPRT doesn't work we disable it for the forthcoming
441 bool netrc; /* name+password provided by netrc */
442 bool userpwd_in_url; /* name+password found in url */
444 bool done; /* set to FALSE when Curl_do() is called and set to TRUE
445 when Curl_done() is called, to prevent Curl_done() to
446 get invoked twice when the multi interface is
448 bool stream_was_rewound; /* Indicates that the stream was rewound after a
449 request read past the end of its response byte
451 bool proxy_connect_closed; /* set true if a proxy disconnected the
452 connection in a CONNECT request with auth, so
453 that libcurl should reconnect and continue. */
454 bool bound; /* set true if bind() has already been done on this socket/
456 bool type_set; /* type= was used in the URL */
460 char *rawalloc; /* allocated "raw" version of the name */
461 char *encalloc; /* allocated IDN-encoded version of the name */
462 char *name; /* name to use internally, might be encoded, might be raw */
463 const char *dispname; /* name to display, as 'name' might be encoded */
467 * Flags on the keepon member of the Curl_transfer_keeper
471 #define KEEP_RECV (1<<0) /* there is or may be data to read */
472 #define KEEP_SEND (1<<1) /* there is or may be data to write */
473 #define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there
474 might still be data to read */
475 #define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there
476 might still be data to write */
477 #define KEEP_RECV_PAUSE (1<<4) /* reading is paused */
478 #define KEEP_SEND_PAUSE (1<<5) /* writing is paused */
480 #define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE)
481 #define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE)
486 ZLIB_UNINIT, /* uninitialized */
487 ZLIB_INIT, /* initialized */
488 ZLIB_GZIP_HEADER, /* reading gzip header */
489 ZLIB_GZIP_INFLATING, /* inflating gzip stream */
490 ZLIB_INIT_GZIP /* initialized in transparent gzip mode */
494 #ifdef CURLRES_ASYNCH
498 struct Curl_dns_entry *dns;
499 bool done; /* set TRUE when the lookup is complete */
500 int status; /* if done is TRUE, this is the status from the callback */
501 void *os_specific; /* 'struct thread_data' for Windows */
505 #define FIRSTSOCKET 0
506 #define SECONDARYSOCKET 1
508 /* These function pointer types are here only to allow easier typecasting
509 within the source when we need to cast between data pointers (such as NULL)
510 and function pointers. */
511 typedef CURLcode (*Curl_do_more_func)(struct connectdata *, bool *);
512 typedef CURLcode (*Curl_done_func)(struct connectdata *, CURLcode, bool);
516 EXP100_SEND_DATA, /* enough waiting, just send the body now */
517 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */
518 EXP100_SENDING_REQUEST, /* still sending the request but will wait for
519 the 100 header once done with the request */
520 EXP100_FAILED /* used on 417 Expectation Failed */
524 * Request specific data in the easy handle (SessionHandle). Previously,
525 * these members were on the connectdata struct but since a conn struct may
526 * now be shared between different SessionHandles, we store connection-specific
527 * data here. This struct only keeps stuff that's interesting for *this*
528 * request, as it will be cleared between multiple ones
530 struct SingleRequest {
531 curl_off_t size; /* -1 if unknown at this point */
532 curl_off_t *bytecountp; /* return number of bytes read or NULL */
534 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch,
535 -1 means unlimited */
536 curl_off_t *writebytecountp; /* return number of bytes written or NULL */
538 curl_off_t bytecount; /* total number of bytes read */
539 curl_off_t writebytecount; /* number of bytes written */
541 long headerbytecount; /* only count received headers */
542 long deductheadercount; /* this amount of bytes doesn't count when we check
543 if anything has been transferred at the end of a
544 connection. We use this counter to make only a
545 100 reply (without a following second response
546 code) result in a CURLE_GOT_NOTHING error code */
548 struct timeval start; /* transfer started at this time */
549 struct timeval now; /* current time */
550 bool header; /* incoming data has HTTP header */
552 HEADER_NORMAL, /* no bad header at all */
553 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest
555 HEADER_ALLBAD /* all was believed to be header */
556 } badheader; /* the header was deemed bad and will be
558 int headerline; /* counts header lines to better track the
560 char *hbufp; /* points at *end* of header line */
562 char *str; /* within buf */
563 char *str_start; /* within buf */
564 char *end_ptr; /* within buf */
565 char *p; /* within headerbuff */
566 bool content_range; /* set TRUE if Content-Range: was found */
567 curl_off_t offset; /* possible resume offset read from the
568 Content-Range: header */
569 int httpcode; /* error code from the 'HTTP/1.? XXX' or
570 'RTSP/1.? XXX' line */
571 struct timeval start100; /* time stamp to wait for the 100 code from */
572 enum expect100 exp100; /* expect 100 continue state */
574 int auto_decoding; /* What content encoding. sec 3.5, RFC2616. */
576 #define IDENTITY 0 /* No encoding */
577 #define DEFLATE 1 /* zlib deflate [RFC 1950 & 1951] */
578 #define GZIP 2 /* gzip algorithm [RFC 1952] */
579 #define COMPRESS 3 /* Not handled, added for completeness */
582 zlibInitState zlib_init; /* possible zlib init state;
583 undefined if Content-Encoding header. */
584 z_stream z; /* State structure for zlib. */
596 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
597 and we're uploading the last chunk */
599 bool ignorebody; /* we read a response-body but we ignore it! */
600 bool ignorecl; /* This HTTP response has no body so we ignore the Content-
603 char *location; /* This points to an allocated version of the Location:
605 char *newurl; /* Set to the new URL to use when a redirect or a retry is
608 /* 'upload_present' is used to keep a byte counter of how much data there is
609 still left in the buffer, aimed for upload. */
610 ssize_t upload_present;
612 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
613 buffer, so the next read should read from where this pointer points to,
614 and the 'upload_present' contains the number of bytes available at this
616 char *upload_fromhere;
618 bool chunk; /* if set, this is a chunked transfer-encoding */
619 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
621 bool getheader; /* TRUE if header parsing is wanted */
623 bool forbidchunk; /* used only to explicitly forbid chunk-upload for
624 specific upload buffers. See readmoredata() in
625 http.c for details. */
629 * Specific protocol handler.
632 struct Curl_handler {
633 const char * scheme; /* URL scheme name. */
635 /* Complement to setup_connection_internals(). */
636 CURLcode (*setup_connection)(struct connectdata *);
638 /* These two functions MUST be set to be protocol dependent */
639 CURLcode (*do_it)(struct connectdata *, bool *done);
642 /* If the curl_do() function is better made in two halves, this
643 * curl_do_more() function will be called afterwards, if set. For example
644 * for doing the FTP stuff after the PASV/PORT command.
646 Curl_do_more_func do_more;
648 /* This function *MAY* be set to a protocol-dependent function that is run
649 * after the connect() and everything is done, as a step in the connection.
650 * The 'done' pointer points to a bool that should be set to TRUE if the
651 * function completes before return. If it doesn't complete, the caller
652 * should call the curl_connecting() function until it is.
654 CURLcode (*connect_it)(struct connectdata *, bool *done);
656 /* See above. Currently only used for FTP. */
657 CURLcode (*connecting)(struct connectdata *, bool *done);
658 CURLcode (*doing)(struct connectdata *, bool *done);
660 /* Called from the multi interface during the PROTOCONNECT phase, and it
661 should then return a proper fd set */
662 int (*proto_getsock)(struct connectdata *conn,
663 curl_socket_t *socks,
666 /* Called from the multi interface during the DOING phase, and it should
667 then return a proper fd set */
668 int (*doing_getsock)(struct connectdata *conn,
669 curl_socket_t *socks,
672 /* Called from the multi interface during the DO_MORE phase, and it should
673 then return a proper fd set */
674 int (*domore_getsock)(struct connectdata *conn,
675 curl_socket_t *socks,
678 /* Called from the multi interface during the DO_DONE, PERFORM and
679 WAITPERFORM phases, and it should then return a proper fd set. Not setting
680 this will make libcurl use the generic default one. */
681 int (*perform_getsock)(const struct connectdata *conn,
682 curl_socket_t *socks,
685 /* This function *MAY* be set to a protocol-dependent function that is run
686 * by the curl_disconnect(), as a step in the disconnection. If the handler
687 * is called because the connection has been considered dead, dead_connection
690 CURLcode (*disconnect)(struct connectdata *, bool dead_connection);
692 /* If used, this function gets called from transfer.c:readwrite_data() to
693 allow the protocol to do extra reads/writes */
694 CURLcode (*readwrite)(struct SessionHandle *data, struct connectdata *conn,
695 ssize_t *nread, bool *readmore);
697 long defport; /* Default port. */
698 unsigned int protocol; /* See CURLPROTO_* */
699 unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */
702 #define PROTOPT_NONE 0 /* nothing extra */
703 #define PROTOPT_SSL (1<<0) /* uses SSL */
704 #define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */
705 #define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */
706 /* some protocols will have to call the underlying functions without regard to
707 what exact state the socket signals. IE even if the socket says "readable",
708 the send function might need to be called while uploading, or vice versa.
710 #define PROTOPT_DIRLOCK (1<<3)
711 #define PROTOPT_NONETWORK (1<<4) /* protocol doesn't use the network! */
712 #define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it
714 #define PROTOPT_NOURLQUERY (1<<6) /* protocol can't handle
715 url query strings (?foo=bar) ! */
718 /* return the count of bytes sent, or -1 on error */
719 typedef ssize_t (Curl_send)(struct connectdata *conn, /* connection data */
720 int sockindex, /* socketindex */
721 const void *buf, /* data to write */
722 size_t len, /* max amount to write */
723 CURLcode *err); /* error to return */
725 /* return the count of bytes read, or -1 on error */
726 typedef ssize_t (Curl_recv)(struct connectdata *conn, /* connection data */
727 int sockindex, /* socketindex */
728 char *buf, /* store data here */
729 size_t len, /* max amount to read */
730 CURLcode *err); /* error to return */
733 * The connectdata struct contains all fields and variables that should be
734 * unique for an entire connection.
737 /* 'data' is the CURRENT SessionHandle using this connection -- take great
738 caution that this might very well vary between different times this
739 connection is used! */
740 struct SessionHandle *data;
742 /* chunk is for HTTP chunked encoding, but is in the general connectdata
743 struct only because we can do just about any protocol through a HTTP proxy
744 and a HTTP proxy may in fact respond using chunked encoding */
745 struct Curl_chunker chunk;
747 curl_closesocket_callback fclosesocket; /* function closing the socket(s) */
748 void *closesocket_client;
750 bool inuse; /* This is a marker for the connection cache logic. If this is
751 TRUE this handle is being used by an easy handle and cannot
752 be used by any other easy handle without careful
753 consideration (== only for pipelining). */
755 /**** Fields set when inited and not modified again */
756 long connectindex; /* what index in the connection cache connects index this
757 particular struct has */
759 /* 'dns_entry' is the particular host we use. This points to an entry in the
760 DNS cache and it will not get pruned while locked. It gets unlocked in
761 Curl_done(). This entry will be NULL if the connection is re-used as then
762 there is no name resolve done. */
763 struct Curl_dns_entry *dns_entry;
765 /* 'ip_addr' is the particular IP we connected to. It points to a struct
766 within the DNS cache, so this pointer is only valid as long as the DNS
767 cache entry remains locked. It gets unlocked in Curl_done() */
768 Curl_addrinfo *ip_addr;
770 /* 'ip_addr_str' is the ip_addr data as a human readable string.
771 It remains available as long as the connection does, which is longer than
772 the ip_addr itself. */
773 char ip_addr_str[MAX_IPADR_LEN];
775 unsigned int scope; /* address scope for IPv6 */
777 int socktype; /* SOCK_STREAM or SOCK_DGRAM */
779 struct hostname host;
780 struct hostname proxy;
782 long port; /* which port to use locally */
783 unsigned short remote_port; /* what remote port to connect to,
784 not the proxy port! */
786 /* 'primary_ip' and 'primary_port' get filled with peer's numerical
787 ip address and port number whenever an outgoing connection is
788 *attempted* from the primary socket to a remote address. When more
789 than one address is tried for a connection these will hold data
790 for the last attempt. When the connection is actually established
791 these are updated with data which comes directly from the socket. */
793 char primary_ip[MAX_IPADR_LEN];
796 /* 'local_ip' and 'local_port' get filled with local's numerical
797 ip address and port number whenever an outgoing connection is
798 **established** from the primary socket to a remote address. */
800 char local_ip[MAX_IPADR_LEN];
803 char *user; /* user name string, allocated */
804 char *passwd; /* password string, allocated */
806 char *proxyuser; /* proxy user name string, allocated */
807 char *proxypasswd; /* proxy password string, allocated */
808 curl_proxytype proxytype; /* what kind of proxy that is in use */
810 int httpversion; /* the HTTP version*10 reported by the server */
811 int rtspversion; /* the RTSP version*10 reported by the server */
813 struct timeval now; /* "current" time */
814 struct timeval created; /* creation time */
815 curl_socket_t sock[2]; /* two sockets, the second is used for the data
816 transfer when doing FTP */
817 bool sock_accepted[2]; /* TRUE if the socket on this index was created with
822 struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */
823 struct ssl_config_data ssl_config;
825 struct ConnectBits bits; /* various state-flags for this connection */
827 /* connecttime: when connect() is called on the current IP address. Used to
828 be able to track when to move on to try next IP - but only when the multi
829 interface is used. */
830 struct timeval connecttime;
831 /* The two fields below get set in Curl_connecthost */
832 int num_addr; /* number of addresses to try to connect to */
833 long timeoutms_per_addr; /* how long time in milliseconds to spend on
834 trying to connect to each IP address */
836 const struct Curl_handler *handler; /* Connection's protocol handler */
837 const struct Curl_handler *given; /* The protocol first given */
839 long ip_version; /* copied from the SessionHandle at creation time */
841 /**** curl_get() phase fields */
843 curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */
844 curl_socket_t writesockfd; /* socket to write to, it may very
845 well be the same we read from.
846 CURL_SOCKET_BAD disables */
848 /** Dynamicly allocated strings, MUST be freed before this **/
849 /** struct is killed. **/
850 struct dynamically_allocated_data {
853 char *accept_encoding;
859 char *rtsp_transport;
860 char *te; /* TE: request header */
863 int sec_complete; /* if kerberos is enabled for this connection */
864 #if defined(HAVE_KRB4) || defined(HAVE_GSSAPI)
865 enum protection_level command_prot;
866 enum protection_level data_prot;
867 enum protection_level request_data_prot;
869 struct krb4buffer in_buffer;
871 const struct Curl_sec_client_mech *mech;
872 struct sockaddr_in local_addr;
875 /* the two following *_inuse fields are only flags, not counters in any way.
876 If TRUE it means the channel is in use, and if FALSE it means the channel
877 is up for grabs by one. */
879 bool readchannel_inuse; /* whether the read channel is in use by an easy
881 bool writechannel_inuse; /* whether the write channel is in use by an easy
883 bool server_supports_pipelining; /* TRUE if server supports pipelining,
884 set after first response */
886 struct curl_llist *send_pipe; /* List of handles waiting to
887 send on this pipeline */
888 struct curl_llist *recv_pipe; /* List of handles waiting to read
889 their responses on this pipeline */
890 struct curl_llist *pend_pipe; /* List of pending handles on
892 struct curl_llist *done_pipe; /* Handles that are finished, but
893 still reference this connectdata */
894 #define MAX_PIPELINE_LENGTH 5
896 char* master_buffer; /* The master buffer allocated on-demand;
897 used for pipelining. */
898 size_t read_pos; /* Current read position in the master buffer */
899 size_t buf_len; /* Length of the buffer?? */
902 curl_seek_callback seek_func; /* function that seeks the input */
903 void *seek_client; /* pointer to pass to the seek() above */
905 /*************** Request - specific items ************/
907 /* previously this was in the urldata struct */
908 curl_read_callback fread_func; /* function that reads the input */
909 void *fread_in; /* pointer to pass to the fread() above */
911 struct ntlmdata ntlm; /* NTLM differs from other authentication schemes
912 because it authenticates connections, not
914 struct ntlmdata proxyntlm; /* NTLM data for proxy */
916 #if defined(USE_NTLM) && defined(NTLM_WB_ENABLED)
917 /* used for communication with Samba's winbind daemon helper ntlm_auth */
918 curl_socket_t ntlm_auth_hlpr_socket;
919 pid_t ntlm_auth_hlpr_pid;
920 char* challenge_header;
921 char* response_header;
924 char syserr_buf [256]; /* buffer for Curl_strerror() */
926 #ifdef CURLRES_ASYNCH
927 /* data used for the asynch name resolve callback */
928 struct Curl_async async;
931 /* These three are used for chunked-encoding trailer support */
932 char *trailer; /* allocated buffer to store trailer in */
933 int trlMax; /* allocated buffer size */
934 int trlPos; /* index of where to store data */
937 struct ftp_conn ftpc;
938 struct ssh_conn sshc;
939 struct tftp_state_data *tftpc;
940 struct imap_conn imapc;
941 struct pop3_conn pop3c;
942 struct smtp_conn smtpc;
943 struct rtsp_conn rtspc;
947 int cselect_bits; /* bitmask of socket events */
948 int waitfor; /* current READ/WRITE bits to wait for */
950 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
951 int socks5_gssapi_enctype;
957 /* When this connection is created, store the conditions for the local end
958 bind. This is stored before the actual bind and before any connection is
959 made and will serve the purpose of being used for comparison reasons so
960 that subsequent bound-requested connections aren't accidentally re-using
961 wrong connections. */
963 unsigned short localport;
966 /* tunnel as in tunnel through a HTTP proxy with CONNECT */
968 TUNNEL_INIT, /* init/default/no tunnel state */
969 TUNNEL_CONNECT, /* CONNECT has been sent off */
970 TUNNEL_COMPLETE /* CONNECT response received completely */
971 } tunnel_state[2]; /* two separate ones to allow FTP */
974 /* The end of connectdata. */
977 * Struct to keep statistical and informational data.
980 int httpcode; /* Recent HTTP, FTP, or RTSP response code */
981 int httpproxycode; /* response code from proxy when received separate */
982 int httpversion; /* the http version number X.Y = X*10+Y */
983 long filetime; /* If requested, this is might get set. Set to -1 if the time
984 was unretrievable. We cannot have this of type time_t,
985 since time_t is unsigned on several platforms such as
987 bool timecond; /* set to TRUE if the time condition didn't match, which
988 thus made the document NOT get fetched */
989 long header_size; /* size of read header(s) in bytes */
990 long request_size; /* the amount of bytes sent in the request(s) */
991 long proxyauthavail; /* what proxy auth types were announced */
992 long httpauthavail; /* what host auth types were announced */
993 long numconnects; /* how many new connection did libcurl created */
994 char *contenttype; /* the content type of the object */
995 char *wouldredirect; /* URL this would've been redirected to if asked to */
997 /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip'
998 and, 'conn_local_port' are copied over from the connectdata struct in
999 order to allow curl_easy_getinfo() to return this information even when
1000 the session handle is no longer associated with a connection, and also
1001 allow curl_easy_reset() to clear this information from the session handle
1002 without disturbing information which is still alive, and that might be
1003 reused, in the connection cache. */
1005 char conn_primary_ip[MAX_IPADR_LEN];
1006 long conn_primary_port;
1008 char conn_local_ip[MAX_IPADR_LEN];
1009 long conn_local_port;
1011 struct curl_certinfo certs; /* info about the certs, only populated in
1012 OpenSSL builds. Asked for with
1013 CURLOPT_CERTINFO / CURLINFO_CERTINFO */
1018 long lastshow; /* time() of the last displayed progress meter or NULL to
1019 force redraw at next call */
1020 curl_off_t size_dl; /* total expected size */
1021 curl_off_t size_ul; /* total expected size */
1022 curl_off_t downloaded; /* transferred so far */
1023 curl_off_t uploaded; /* transferred so far */
1025 curl_off_t current_speed; /* uses the currently fastest transfer */
1027 bool callback; /* set when progress callback is used */
1028 int width; /* screen width at download start */
1029 int flags; /* see progress.h */
1038 double t_appconnect;
1039 double t_pretransfer;
1040 double t_starttransfer;
1043 struct timeval start;
1044 struct timeval t_startsingle;
1045 struct timeval t_acceptdata;
1046 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
1048 curl_off_t speeder[ CURR_TIME ];
1049 struct timeval speeder_time[ CURR_TIME ];
1054 HTTPREQ_NONE, /* first in list */
1057 HTTPREQ_POST_FORM, /* we make a difference internally */
1061 HTTPREQ_LAST /* last in list */
1065 RTSPREQ_NONE, /* first in list */
1073 RTSPREQ_GET_PARAMETER,
1074 RTSPREQ_SET_PARAMETER,
1077 RTSPREQ_LAST /* last in list */
1081 * Values that are generated, temporary or calculated internally for a
1082 * "session handle" must be defined within the 'struct UrlState'. This struct
1083 * will be used within the SessionHandle struct. When the 'SessionHandle'
1084 * struct is cloned, this data MUST NOT be copied.
1086 * Remember that any "state" information goes globally for the curl handle.
1087 * Session-data MUST be put in the connectdata struct and here. */
1088 #define MAX_CURL_USER_LENGTH 256
1089 #define MAX_CURL_PASSWORD_LENGTH 256
1090 #define MAX_CURL_USER_LENGTH_TXT "255"
1091 #define MAX_CURL_PASSWORD_LENGTH_TXT "255"
1094 long want; /* Bitmask set to the authentication methods wanted by the app
1095 (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */
1097 long avail; /* bitmask for what the server reports to support for this
1099 bool done; /* TRUE when the auth phase is done and ready to do the *actual*
1101 bool multi; /* TRUE if this is not yet authenticated but within the auth
1102 multipass negotiation */
1103 bool iestyle; /* TRUE if digest should be done IE-style or FALSE if it should
1108 /* 'connects' will be an allocated array with pointers. If the pointer is
1109 set, it holds an allocated connection. */
1110 struct connectdata **connects;
1111 long num; /* number of entries of the 'connects' array */
1113 CONNCACHE_PRIVATE, /* used for an easy handle alone */
1114 CONNCACHE_MULTI /* shared within a multi handle */
1126 struct conncache *connc; /* points to the connection cache this handle
1129 /* buffers to store authentication data in, as parsed from input options */
1130 struct timeval keeps_speed; /* for the progress meter really */
1132 long lastconnect; /* index of most recent connect or -1 if undefined */
1134 char *headerbuff; /* allocated buffer to store headers in */
1135 size_t headersize; /* size of the allocation */
1137 char buffer[BUFSIZE+1]; /* download buffer */
1138 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
1139 curl_off_t current_speed; /* the ProgressShow() funcion sets this,
1141 bool this_is_a_follow; /* this is a followed Location: request */
1143 char *first_host; /* if set, this should be the host name that we will
1144 sent authorization to, no else. Used to make Location:
1145 following not keep sending user+password... This is
1148 struct curl_ssl_session *session; /* array of 'max_ssl_sessions' size */
1149 long sessionage; /* number of the most recent session */
1150 char *tempwrite; /* allocated buffer to keep data in when a write
1151 callback returns to make the connection paused */
1152 size_t tempwritesize; /* size of the 'tempwrite' allocated buffer */
1153 int tempwritetype; /* type of the 'tempwrite' buffer as a bitmask that is
1154 used with Curl_client_write() */
1155 char *scratch; /* huge buffer[BUFSIZE*2] when doing upload CRLF replacing */
1156 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
1157 This must be set to FALSE every time _easy_perform() is
1159 int os_errno; /* filled in with errno whenever an error occurs */
1161 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
1162 void (*prev_signal)(int sig);
1164 bool allow_port; /* Is set.use_port allowed to take effect or not. This
1165 is always set TRUE when curl_easy_perform() is called. */
1166 struct digestdata digest; /* state data for host Digest auth */
1167 struct digestdata proxydigest; /* state data for proxy Digest auth */
1169 #ifdef USE_HTTP_NEGOTIATE
1170 struct negotiatedata negotiate; /* state data for host Negotiate auth */
1171 struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */
1174 struct auth authhost; /* auth details for host */
1175 struct auth authproxy; /* auth details for proxy */
1177 bool authproblem; /* TRUE if there's some problem authenticating */
1179 void *resolver; /* resolver state, if it is used in the URL state -
1180 ares_channel f.e. */
1182 #if defined(USE_SSLEAY) && defined(HAVE_OPENSSL_ENGINE_H)
1184 #endif /* USE_SSLEAY */
1185 struct timeval expiretime; /* set this with Curl_expire() only */
1186 struct Curl_tree timenode; /* for the splay stuff */
1187 struct curl_llist *timeoutlist; /* list of pending timeouts */
1189 /* a place to store the most recently set FTP entrypath */
1190 char *most_recent_ftp_entrypath;
1192 /* set after initial USER failure, to prevent an authentication loop */
1193 bool ftp_trying_alternative;
1195 int httpversion; /* the lowest HTTP version*10 reported by any server
1196 involved in this request */
1197 bool expect100header; /* TRUE if we added Expect: 100-continue */
1199 bool pipe_broke; /* TRUE if the connection we were pipelined on broke
1200 and we need to restart from the beginning */
1202 #if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) && \
1203 !defined(__SYMBIAN32__)
1204 /* do FTP line-end conversions on most platforms */
1205 #define CURL_DO_LINEEND_CONV
1206 /* for FTP downloads: track CRLF sequences that span blocks */
1207 bool prev_block_had_trailing_cr;
1208 /* for FTP downloads: how many CRLFs did we converted to LFs? */
1209 curl_off_t crlf_conversions;
1211 /* If set to non-NULL, there's a connection in a shared connection cache
1212 that uses this handle so we can't kill this SessionHandle just yet but
1213 must keep it around and add it to the list of handles to kill once all
1214 its connections are gone */
1216 bool closed; /* set to TRUE when curl_easy_cleanup() has been called on this
1217 handle, but it is kept around as mentioned for
1219 char *pathbuffer;/* allocated buffer to store the URL's path part in */
1220 char *path; /* path to use, points to somewhere within the pathbuffer
1222 bool slash_removed; /* set TRUE if the 'path' points to a path where the
1223 initial URL slash separator has been taken off */
1225 bool rangestringalloc; /* the range string is malloc()'ed */
1227 char *range; /* range, if used. See README for detailed specification on
1229 curl_off_t resume_from; /* continue [ftp] transfer from here */
1231 /* This RTSP state information survives requests and connections */
1232 long rtsp_next_client_CSeq; /* the session's next client CSeq */
1233 long rtsp_next_server_CSeq; /* the session's next server CSeq */
1234 long rtsp_CSeq_recv; /* most recent CSeq received */
1236 /* Protocol specific data.
1238 *************************************************************************
1239 * Note that this data will be REMOVED after each request, so anything that
1240 * should be kept/stored on a per-connection basis and thus live for the
1241 * next request on the same connection MUST be put in the connectdata struct!
1242 *************************************************************************/
1245 struct HTTP *https; /* alias, just for the sake of being more readable */
1248 /* void *tftp; not used */
1249 struct FILEPROTO *file;
1250 void *telnet; /* private for telnet.c-eyes only */
1252 struct SSHPROTO *ssh;
1257 /* current user of this SessionHandle instance, or NULL */
1258 struct connectdata *current_conn;
1260 /* if true, force SSL connection retry (workaround for certain servers) */
1261 bool ssl_connect_retry;
1266 * This 'DynamicStatic' struct defines dynamic states that actually change
1267 * values in the 'UserDefined' area, which MUST be taken into consideration
1268 * if the UserDefined struct is cloned or similar. You can probably just
1269 * copy these, but each one indicate a special action on other data.
1272 struct DynamicStatic {
1273 char *url; /* work URL, copied from UserDefined */
1274 bool url_alloc; /* URL string is malloc()'ed */
1275 char *referer; /* referer string */
1276 bool referer_alloc; /* referer sting is malloc()ed */
1277 struct curl_slist *cookielist; /* list of cookie files set by
1278 curl_easy_setopt(COOKIEFILE) calls */
1279 struct curl_slist *resolve; /* set to point to the set.resolve list when
1280 this should be dealt with in pretransfer */
1284 * This 'UserDefined' struct must only contain data that is set once to go
1285 * for many (perhaps) independent connections. Values that are generated or
1286 * calculated internally for the "session handle" MUST be defined within the
1287 * 'struct UrlState' instead. The only exceptions MUST note the changes in
1288 * the 'DynamicStatic' struct.
1289 * Character pointer fields point to dynamic storage, unless otherwise stated.
1291 struct Curl_one_easy; /* declared and used only in multi.c */
1292 struct Curl_multi; /* declared and used only in multi.c */
1295 STRING_CERT, /* client certificate file name */
1296 STRING_CERT_TYPE, /* format for certificate (default: PEM)*/
1297 STRING_COOKIE, /* HTTP cookie string to send */
1298 STRING_COOKIEJAR, /* dump all cookies to this file */
1299 STRING_CUSTOMREQUEST, /* HTTP/FTP/RTSP request/method to use */
1300 STRING_DEVICE, /* local network interface/address to use */
1301 STRING_ENCODING, /* Accept-Encoding string */
1302 STRING_FTP_ACCOUNT, /* ftp account data */
1303 STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */
1304 STRING_FTPPORT, /* port to send with the FTP PORT command */
1305 STRING_KEY, /* private key file name */
1306 STRING_KEY_PASSWD, /* plain text private key password */
1307 STRING_KEY_TYPE, /* format for private key (default: PEM) */
1308 STRING_KRB_LEVEL, /* krb security level */
1309 STRING_NETRC_FILE, /* if not NULL, use this instead of trying to find
1311 STRING_COPYPOSTFIELDS, /* if POST, set the fields' values here */
1312 STRING_PROXY, /* proxy to use */
1313 STRING_SET_RANGE, /* range, if used */
1314 STRING_SET_REFERER, /* custom string for the HTTP referer field */
1315 STRING_SET_URL, /* what original URL to work on */
1316 STRING_SSL_CAPATH, /* CA directory name (doesn't work on windows) */
1317 STRING_SSL_CAFILE, /* certificate file to verify peer against */
1318 STRING_SSL_CIPHER_LIST, /* list of ciphers to use */
1319 STRING_SSL_EGDSOCKET, /* path to file containing the EGD daemon socket */
1320 STRING_SSL_RANDOM_FILE, /* path to file containing "random" data */
1321 STRING_USERAGENT, /* User-Agent string */
1322 STRING_SSL_CRLFILE, /* crl file to check certificate */
1323 STRING_SSL_ISSUERCERT, /* issuer cert file to check certificate */
1324 STRING_USERNAME, /* <username>, if used */
1325 STRING_PASSWORD, /* <password>, if used */
1326 STRING_PROXYUSERNAME, /* Proxy <username>, if used */
1327 STRING_PROXYPASSWORD, /* Proxy <password>, if used */
1328 STRING_NOPROXY, /* List of hosts which should not use the proxy, if
1330 STRING_RTSP_SESSION_ID, /* Session ID to use */
1331 STRING_RTSP_STREAM_URI, /* Stream URI for this request */
1332 STRING_RTSP_TRANSPORT, /* Transport for this session */
1334 STRING_SSH_PRIVATE_KEY, /* path to the private key file for auth */
1335 STRING_SSH_PUBLIC_KEY, /* path to the public key file for auth */
1336 STRING_SSH_HOST_PUBLIC_KEY_MD5, /* md5 of host public key in ascii hex */
1337 STRING_SSH_KNOWNHOSTS, /* file name of knownhosts file */
1339 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1340 STRING_SOCKS5_GSSAPI_SERVICE, /* GSSAPI service name */
1346 STRING_TLSAUTH_USERNAME, /* TLS auth <username> */
1347 STRING_TLSAUTH_PASSWORD, /* TLS auth <password> */
1350 /* -- end of strings -- */
1351 STRING_LAST /* not used, just an end-of-list marker */
1354 struct UserDefined {
1355 FILE *err; /* the stderr user data goes here */
1356 void *debugdata; /* the data that will be passed to fdebug */
1357 char *errorbuffer; /* (Static) store failure messages in here */
1358 long proxyport; /* If non-zero, use this port number by default. If the
1359 proxy string features a ":[port]" that one will override
1361 void *out; /* the fetched file goes here */
1362 void *in; /* the uploaded file is read from here */
1363 void *writeheader; /* write the header to this if non-NULL */
1364 void *rtp_out; /* write RTP to this if non-NULL */
1365 long use_port; /* which port to use (when not using default) */
1366 long httpauth; /* what kind of HTTP authentication to use (bitmask) */
1367 long proxyauth; /* what kind of proxy authentication to use (bitmask) */
1368 long followlocation; /* as in HTTP Location: */
1369 long maxredirs; /* maximum no. of http(s) redirects to follow, set to -1
1372 int keep_post; /* keep POSTs as POSTs after a 30x request; each
1373 bit represents a request, from 301 to 303 */
1374 bool free_referer; /* set TRUE if 'referer' points to a string we
1376 void *postfields; /* if POST, set the fields' values here */
1377 curl_seek_callback seek_func; /* function that seeks the input */
1378 curl_off_t postfieldsize; /* if POST, this might have a size to use instead
1379 of strlen(), and then the data *may* be binary
1380 (contain zero bytes) */
1381 unsigned short localport; /* local port number to bind to */
1382 int localportrange; /* number of additional port numbers to test in case the
1383 'localport' one can't be bind()ed */
1384 curl_write_callback fwrite_func; /* function that stores the output */
1385 curl_write_callback fwrite_header; /* function that stores headers */
1386 curl_write_callback fwrite_rtp; /* function that stores interleaved RTP */
1387 curl_read_callback fread_func; /* function that reads the input */
1388 int is_fread_set; /* boolean, has read callback been set to non-NULL? */
1389 int is_fwrite_set; /* boolean, has write callback been set to non-NULL? */
1390 curl_progress_callback fprogress; /* function for progress information */
1391 curl_debug_callback fdebug; /* function that write informational data */
1392 curl_ioctl_callback ioctl_func; /* function for I/O control */
1393 curl_sockopt_callback fsockopt; /* function for setting socket options */
1394 void *sockopt_client; /* pointer to pass to the socket options callback */
1395 curl_opensocket_callback fopensocket; /* function for checking/translating
1396 the address and opening the
1398 void* opensocket_client;
1399 curl_closesocket_callback fclosesocket; /* function for closing the
1401 void* closesocket_client;
1403 void *seek_client; /* pointer to pass to the seek callback */
1404 /* the 3 curl_conv_callback functions below are used on non-ASCII hosts */
1405 /* function to convert from the network encoding: */
1406 curl_conv_callback convfromnetwork;
1407 /* function to convert to the network encoding: */
1408 curl_conv_callback convtonetwork;
1409 /* function to convert from UTF-8 encoding: */
1410 curl_conv_callback convfromutf8;
1412 void *progress_client; /* pointer to pass to the progress callback */
1413 void *ioctl_client; /* pointer to pass to the ioctl callback */
1414 long timeout; /* in milliseconds, 0 means no timeout */
1415 long connecttimeout; /* in milliseconds, 0 means no timeout */
1416 long accepttimeout; /* in milliseconds, 0 means no timeout */
1417 long server_response_timeout; /* in milliseconds, 0 means no timeout */
1418 long tftp_blksize ; /* in bytes, 0 means use default */
1419 curl_off_t infilesize; /* size of file to upload, -1 means unknown */
1420 long low_speed_limit; /* bytes/second */
1421 long low_speed_time; /* number of seconds */
1422 curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */
1423 curl_off_t max_recv_speed; /* high speed limit in bytes/second for
1425 curl_off_t set_resume_from; /* continue [ftp] transfer from here */
1426 struct curl_slist *headers; /* linked list of extra headers */
1427 struct curl_httppost *httppost; /* linked list of POST data */
1428 bool cookiesession; /* new cookie session? */
1429 bool crlf; /* convert crlf on ftp upload(?) */
1430 struct curl_slist *quote; /* after connection is established */
1431 struct curl_slist *postquote; /* after the transfer */
1432 struct curl_slist *prequote; /* before the transfer, after type */
1433 struct curl_slist *source_quote; /* 3rd party quote */
1434 struct curl_slist *source_prequote; /* in 3rd party transfer mode - before
1435 the transfer on source host */
1436 struct curl_slist *source_postquote; /* in 3rd party transfer mode - after
1437 the transfer on source host */
1438 struct curl_slist *telnet_options; /* linked list of telnet options */
1439 struct curl_slist *resolve; /* list of names to add/remove from
1441 curl_TimeCond timecondition; /* kind of time/date comparison */
1442 time_t timevalue; /* what time to compare with */
1443 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
1444 long httpversion; /* when non-zero, a specific HTTP version requested to
1445 be used in the library's request(s) */
1446 struct ssl_config_data ssl; /* user defined SSL stuff */
1447 curl_proxytype proxytype; /* what kind of proxy that is in use */
1448 long dns_cache_timeout; /* DNS cache timeout */
1449 long buffer_size; /* size of receive buffer to use */
1450 void *private_data; /* application-private data */
1452 struct Curl_one_easy *one_easy; /* When adding an easy handle to a multi
1453 handle, an internal 'Curl_one_easy'
1454 struct is created and this is a pointer
1455 to the particular struct associated with
1456 this SessionHandle */
1458 struct curl_slist *http200aliases; /* linked list of aliases for http200 */
1460 long ipver; /* the CURL_IPRESOLVE_* defines in the public header file
1461 0 - whatever, 1 - v2, 2 - v6 */
1463 curl_off_t max_filesize; /* Maximum file size to download */
1465 curl_ftpfile ftp_filemethod; /* how to get to a file when FTP is used */
1467 int ftp_create_missing_dirs; /* 1 - create directories that don't exist
1468 2 - the same but also allow MKD to fail once
1471 curl_sshkeycallback ssh_keyfunc; /* key matching callback */
1472 void *ssh_keyfunc_userp; /* custom pointer to callback */
1474 /* Here follows boolean settings that define how to behave during
1475 this session. They are STATIC, set by libcurl users or at least initially
1476 and they don't change during operations. */
1478 bool printhost; /* printing host name in debug info */
1479 bool get_filetime; /* get the time and get of the remote file */
1480 bool tunnel_thru_httpproxy; /* use CONNECT through a HTTP proxy */
1481 bool prefer_ascii; /* ASCII rather than binary */
1482 bool ftp_append; /* append, not overwrite, on upload */
1483 bool ftp_list_only; /* switch FTP command for listing directories */
1484 bool ftp_use_port; /* use the FTP PORT command */
1485 bool hide_progress; /* don't use the progress meter */
1486 bool http_fail_on_error; /* fail on HTTP error codes >= 300 */
1487 bool http_follow_location; /* follow HTTP redirects */
1488 bool http_transfer_encoding; /* request compressed HTTP transfer-encoding */
1489 bool http_disable_hostname_check_before_authentication;
1490 bool include_header; /* include received protocol headers in data output */
1491 bool http_set_referer; /* is a custom referer used */
1492 bool http_auto_referer; /* set "correct" referer when following location: */
1493 bool opt_no_body; /* as set with CURLOPT_NO_BODY */
1494 bool set_port; /* custom port number used */
1495 bool upload; /* upload request */
1496 enum CURL_NETRC_OPTION
1497 use_netrc; /* defined in include/curl.h */
1498 bool verbose; /* output verbosity */
1499 bool krb; /* kerberos connection requested */
1500 bool reuse_forbid; /* forbidden to be reused, close after use */
1501 bool reuse_fresh; /* do not re-use an existing connection */
1502 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
1503 bool ftp_use_eprt; /* if EPRT is to be attempted or not */
1504 bool ftp_use_pret; /* if PRET is to be used before PASV or not */
1506 curl_usessl use_ssl; /* if AUTH TLS is to be attempted etc, for FTP or
1507 IMAP or POP3 or others! */
1508 curl_ftpauth ftpsslauth; /* what AUTH XXX to be attempted */
1509 curl_ftpccc ftp_ccc; /* FTP CCC options */
1510 bool no_signal; /* do not use any signal/alarm handler */
1511 bool global_dns_cache; /* subject for future removal */
1512 bool tcp_nodelay; /* whether to enable TCP_NODELAY or not */
1513 bool ignorecl; /* ignore content length */
1514 bool ftp_skip_ip; /* skip the IP address the FTP server passes on to
1516 bool connect_only; /* make connection, let application use the socket */
1517 bool ssl_enable_beast; /* especially allow this flaw for interoperability's
1519 long ssh_auth_types; /* allowed SSH auth types */
1520 bool http_te_skip; /* pass the raw body data to the user, even when
1521 transfer-encoded (chunked, compressed) */
1522 bool http_ce_skip; /* pass the raw body data to the user, even when
1523 content-encoded (chunked, compressed) */
1524 long new_file_perms; /* Permissions to use when creating remote files */
1525 long new_directory_perms; /* Permissions to use when creating remote dirs */
1526 bool proxy_transfer_mode; /* set transfer mode (;type=<a|i>) when doing FTP
1527 via an HTTP proxy */
1528 char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */
1529 unsigned int scope; /* address scope for IPv6 */
1530 long allowed_protocols;
1531 long redir_protocols;
1532 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1533 long socks5_gssapi_nec; /* flag to support nec socks5 server */
1535 struct curl_slist *mail_rcpt; /* linked list of mail recipients */
1536 /* Common RTSP header options */
1537 Curl_RtspReq rtspreq; /* RTSP request type */
1538 long rtspversion; /* like httpversion, for RTSP */
1539 bool wildcardmatch; /* enable wildcard matching */
1540 curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer
1542 curl_chunk_end_callback chunk_end; /* called after part transferring
1544 curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds
1545 to pattern (e.g. if WILDCARDMATCH is on) */
1548 long gssapi_delegation; /* GSSAPI credential delegation, see the
1549 documentation of CURLOPT_GSSAPI_DELEGATION */
1551 bool tcp_keepalive; /* use TCP keepalives */
1552 long tcp_keepidle; /* seconds in idle before sending keepalive probe */
1553 long tcp_keepintvl; /* seconds between TCP keepalive probes */
1557 struct curl_hash *hostcache;
1559 HCACHE_NONE, /* not pointing to anything */
1560 HCACHE_PRIVATE, /* points to our own */
1561 HCACHE_GLOBAL, /* points to the (shrug) global one */
1562 HCACHE_MULTI, /* points to a shared one in the multi handle */
1563 HCACHE_SHARED /* points to a shared one in a shared object */
1568 * The 'connectdata' struct MUST have all the connection oriented stuff as we
1569 * may have several simultaneous connections and connection structs in memory.
1571 * The 'struct UserDefined' must only contain data that is set once to go for
1572 * many (perhaps) independent connections. Values that are generated or
1573 * calculated internally for the "session handle" must be defined within the
1574 * 'struct UrlState' instead.
1577 struct SessionHandle {
1579 struct Curl_multi *multi; /* if non-NULL, points to the multi handle
1580 struct to which this "belongs" */
1581 struct Curl_one_easy *multi_pos; /* if non-NULL, points to its position
1582 in multi controlling structure to assist
1584 struct Curl_share *share; /* Share, handles global variable mutexing */
1585 struct SingleRequest req; /* Request-specific data */
1586 struct UserDefined set; /* values set by the libcurl user */
1587 struct DynamicStatic change; /* possibly modified userdefined data */
1588 struct CookieInfo *cookies; /* the cookies, read from files and servers.
1589 NOTE that the 'cookie' field in the
1590 UserDefined struct defines if the "engine"
1591 is to be used or not. */
1592 struct Progress progress; /* for all the progress meter data */
1593 struct UrlState state; /* struct for fields used for state info and
1594 other dynamic purposes */
1595 struct WildcardData wildcard; /* wildcard download state info */
1596 struct PureInfo info; /* stats, reports and info data */
1597 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
1598 iconv_t outbound_cd; /* for translating to the network encoding */
1599 iconv_t inbound_cd; /* for translating from the network encoding */
1600 iconv_t utf8_cd; /* for translating to UTF8 */
1601 #endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */
1602 unsigned int magic; /* set to a CURLEASY_MAGIC_NUMBER */
1605 #define LIBCURL_NAME "libcurl"
1607 #endif /* HEADER_CURL_URLDATA_H */
projects / platform / upstream / curl.git / blob