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 <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 #endif /* USE_POLARSSL */
268 ssl_connect_state connecting_state;
269 #endif /* USE_CYASSL */
272 char *client_nickname;
273 struct SessionHandle *data;
274 #ifdef HAVE_PK11_CREATEGENERICOBJECT
275 struct curl_llist *obj_list;
276 PK11GenericObject *obj_clicert;
281 #endif /* USE_QSOSSL */
285 #endif /* USE_AXTLS */
288 struct ssl_config_data {
289 long version; /* what version the client wants to use */
290 long certverifyresult; /* result from the certificate verification */
291 long verifypeer; /* set TRUE if this is desired */
292 long verifyhost; /* 0: no verify
293 1: check that CN exists
294 2: CN must match hostname */
295 char *CApath; /* certificate dir (doesn't work on windows) */
296 char *CAfile; /* certificate to verify peer against */
297 const char *CRLfile; /* CRL to check certificate revocation */
298 const char *issuercert;/* optional issuer certificate filename */
299 char *random_file; /* path to file containing "random" data */
300 char *egdsocket; /* path to file containing the EGD daemon socket */
301 char *cipher_list; /* list of ciphers to use */
302 size_t max_ssl_sessions; /* SSL session id cache size */
303 curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */
304 void *fsslctxp; /* parameter for call back */
305 bool sessionid; /* cache session IDs or not */
306 bool certinfo; /* gather lots of certificate info */
309 char *username; /* TLS username (for, e.g., SRP) */
310 char *password; /* TLS password (for, e.g., SRP) */
311 enum CURL_TLSAUTH authtype; /* TLS authentication type (default SRP) */
315 /* information stored about one single SSL session */
316 struct curl_ssl_session {
317 char *name; /* host name for which this ID was used */
318 void *sessionid; /* as returned from the SSL layer */
319 size_t idsize; /* if known, otherwise 0 */
320 long age; /* just a number, the higher the more recent */
321 unsigned short remote_port; /* remote port to connect to */
322 struct ssl_config_data ssl_config; /* setup for this session */
325 /* Struct used for Digest challenge-response authentication */
331 bool stale; /* set true for re-negotiation */
335 int nc; /* nounce count */
346 #ifdef USE_WINDOWS_SSPI
347 #include "curl_sspi.h"
350 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
354 /* Struct used for NTLM challenge-response authentication */
357 #ifdef USE_WINDOWS_SSPI
360 SEC_WINNT_AUTH_IDENTITY identity;
361 SEC_WINNT_AUTH_IDENTITY *p_identity;
364 unsigned long n_type_2;
367 unsigned char nonce[8];
371 #ifdef USE_HTTP_NEGOTIATE
372 struct negotiatedata {
373 /* when doing Negotiate we first need to receive an auth token and then we
374 need to send our header */
375 enum { GSS_AUTHNONE, GSS_AUTHRECV, GSS_AUTHSENT } state;
376 bool gss; /* Whether we're processing GSS-Negotiate or Negotiate */
377 const char* protocol; /* "GSS-Negotiate" or "Negotiate" */
380 gss_ctx_id_t context;
381 gss_name_t server_name;
382 gss_buffer_desc output_token;
384 #ifdef USE_WINDOWS_SSPI
387 CredHandle *credentials;
388 char server_name[1024];
389 size_t max_token_length;
391 size_t output_token_length;
399 * Boolean values that concerns this connection.
402 bool close; /* if set, we close the connection after this request */
403 bool reuse; /* if set, this is a re-used connection */
404 bool proxy; /* if set, this transfer is done through a proxy - any type */
405 bool httpproxy; /* if set, this transfer is done through a http proxy */
406 bool user_passwd; /* do we use user+password for this connection? */
407 bool proxy_user_passwd; /* user+password for the proxy? */
408 bool ipv6_ip; /* we communicate with a remote site specified with pure IPv6
410 bool ipv6; /* we communicate with a site using an IPv6 address */
412 bool do_more; /* this is set TRUE if the ->curl_do_more() function is
413 supposed to be called, after ->curl_do() */
414 bool tcpconnect[2]; /* the TCP layer (or similar) is connected, this is set
415 the first time on the first connect function call */
416 bool protoconnstart;/* the protocol layer has STARTED its operation after
417 the TCP layer connect */
419 bool retry; /* this connection is about to get closed and then
420 re-attempted at another connection. */
421 bool tunnel_proxy; /* if CONNECT is used to "tunnel" through the proxy.
422 This is implicit when SSL-protocols are used through
423 proxies, but can also be enabled explicitly by
425 bool tunnel_connecting; /* TRUE while we're still waiting for a proxy CONNECT
427 bool authneg; /* TRUE when the auth phase has started, which means
428 that we are creating a request with an auth header,
429 but it is not the final request in the auth
431 bool rewindaftersend;/* TRUE when the sending couldn't be stopped even
432 though it will be discarded. When the whole send
433 operation is done, we must call the data rewind
435 bool ftp_use_epsv; /* As set with CURLOPT_FTP_USE_EPSV, but if we find out
436 EPSV doesn't work we disable it for the forthcoming
439 bool ftp_use_eprt; /* As set with CURLOPT_FTP_USE_EPRT, but if we find out
440 EPRT doesn't work we disable it for the forthcoming
442 bool netrc; /* name+password provided by netrc */
443 bool userpwd_in_url; /* name+password found in url */
445 bool done; /* set to FALSE when Curl_do() is called and set to TRUE
446 when Curl_done() is called, to prevent Curl_done() to
447 get invoked twice when the multi interface is
449 bool stream_was_rewound; /* Indicates that the stream was rewound after a
450 request read past the end of its response byte
452 bool proxy_connect_closed; /* set true if a proxy disconnected the
453 connection in a CONNECT request with auth, so
454 that libcurl should reconnect and continue. */
455 bool bound; /* set true if bind() has already been done on this socket/
457 bool type_set; /* type= was used in the URL */
461 char *rawalloc; /* allocated "raw" version of the name */
462 char *encalloc; /* allocated IDN-encoded version of the name */
463 char *name; /* name to use internally, might be encoded, might be raw */
464 const char *dispname; /* name to display, as 'name' might be encoded */
468 * Flags on the keepon member of the Curl_transfer_keeper
472 #define KEEP_RECV (1<<0) /* there is or may be data to read */
473 #define KEEP_SEND (1<<1) /* there is or may be data to write */
474 #define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there
475 might still be data to read */
476 #define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there
477 might still be data to write */
478 #define KEEP_RECV_PAUSE (1<<4) /* reading is paused */
479 #define KEEP_SEND_PAUSE (1<<5) /* writing is paused */
481 #define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE)
482 #define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE)
487 ZLIB_UNINIT, /* uninitialized */
488 ZLIB_INIT, /* initialized */
489 ZLIB_GZIP_HEADER, /* reading gzip header */
490 ZLIB_GZIP_INFLATING, /* inflating gzip stream */
491 ZLIB_INIT_GZIP /* initialized in transparent gzip mode */
495 #ifdef CURLRES_ASYNCH
499 struct Curl_dns_entry *dns;
500 bool done; /* set TRUE when the lookup is complete */
501 int status; /* if done is TRUE, this is the status from the callback */
502 void *os_specific; /* 'struct thread_data' for Windows */
506 #define FIRSTSOCKET 0
507 #define SECONDARYSOCKET 1
509 /* These function pointer types are here only to allow easier typecasting
510 within the source when we need to cast between data pointers (such as NULL)
511 and function pointers. */
512 typedef CURLcode (*Curl_do_more_func)(struct connectdata *, bool *);
513 typedef CURLcode (*Curl_done_func)(struct connectdata *, CURLcode, bool);
517 EXP100_SEND_DATA, /* enough waiting, just send the body now */
518 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */
519 EXP100_SENDING_REQUEST, /* still sending the request but will wait for
520 the 100 header once done with the request */
521 EXP100_FAILED /* used on 417 Expectation Failed */
525 * Request specific data in the easy handle (SessionHandle). Previously,
526 * these members were on the connectdata struct but since a conn struct may
527 * now be shared between different SessionHandles, we store connection-specific
528 * data here. This struct only keeps stuff that's interesting for *this*
529 * request, as it will be cleared between multiple ones
531 struct SingleRequest {
532 curl_off_t size; /* -1 if unknown at this point */
533 curl_off_t *bytecountp; /* return number of bytes read or NULL */
535 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch,
536 -1 means unlimited */
537 curl_off_t *writebytecountp; /* return number of bytes written or NULL */
539 curl_off_t bytecount; /* total number of bytes read */
540 curl_off_t writebytecount; /* number of bytes written */
542 long headerbytecount; /* only count received headers */
543 long deductheadercount; /* this amount of bytes doesn't count when we check
544 if anything has been transferred at the end of a
545 connection. We use this counter to make only a
546 100 reply (without a following second response
547 code) result in a CURLE_GOT_NOTHING error code */
549 struct timeval start; /* transfer started at this time */
550 struct timeval now; /* current time */
551 bool header; /* incoming data has HTTP header */
553 HEADER_NORMAL, /* no bad header at all */
554 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest
556 HEADER_ALLBAD /* all was believed to be header */
557 } badheader; /* the header was deemed bad and will be
559 int headerline; /* counts header lines to better track the
561 char *hbufp; /* points at *end* of header line */
563 char *str; /* within buf */
564 char *str_start; /* within buf */
565 char *end_ptr; /* within buf */
566 char *p; /* within headerbuff */
567 bool content_range; /* set TRUE if Content-Range: was found */
568 curl_off_t offset; /* possible resume offset read from the
569 Content-Range: header */
570 int httpcode; /* error code from the 'HTTP/1.? XXX' or
571 'RTSP/1.? XXX' line */
572 struct timeval start100; /* time stamp to wait for the 100 code from */
573 enum expect100 exp100; /* expect 100 continue state */
575 int auto_decoding; /* What content encoding. sec 3.5, RFC2616. */
577 #define IDENTITY 0 /* No encoding */
578 #define DEFLATE 1 /* zlib deflate [RFC 1950 & 1951] */
579 #define GZIP 2 /* gzip algorithm [RFC 1952] */
580 #define COMPRESS 3 /* Not handled, added for completeness */
583 zlibInitState zlib_init; /* possible zlib init state;
584 undefined if Content-Encoding header. */
585 z_stream z; /* State structure for zlib. */
597 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
598 and we're uploading the last chunk */
600 bool ignorebody; /* we read a response-body but we ignore it! */
601 bool ignorecl; /* This HTTP response has no body so we ignore the Content-
604 char *location; /* This points to an allocated version of the Location:
606 char *newurl; /* Set to the new URL to use when a redirect or a retry is
609 /* 'upload_present' is used to keep a byte counter of how much data there is
610 still left in the buffer, aimed for upload. */
611 ssize_t upload_present;
613 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
614 buffer, so the next read should read from where this pointer points to,
615 and the 'upload_present' contains the number of bytes available at this
617 char *upload_fromhere;
619 bool chunk; /* if set, this is a chunked transfer-encoding */
620 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
622 bool getheader; /* TRUE if header parsing is wanted */
624 bool forbidchunk; /* used only to explicitly forbid chunk-upload for
625 specific upload buffers. See readmoredata() in
626 http.c for details. */
630 * Specific protocol handler.
633 struct Curl_handler {
634 const char * scheme; /* URL scheme name. */
636 /* Complement to setup_connection_internals(). */
637 CURLcode (*setup_connection)(struct connectdata *);
639 /* These two functions MUST be set to be protocol dependent */
640 CURLcode (*do_it)(struct connectdata *, bool *done);
643 /* If the curl_do() function is better made in two halves, this
644 * curl_do_more() function will be called afterwards, if set. For example
645 * for doing the FTP stuff after the PASV/PORT command.
647 Curl_do_more_func do_more;
649 /* This function *MAY* be set to a protocol-dependent function that is run
650 * after the connect() and everything is done, as a step in the connection.
651 * The 'done' pointer points to a bool that should be set to TRUE if the
652 * function completes before return. If it doesn't complete, the caller
653 * should call the curl_connecting() function until it is.
655 CURLcode (*connect_it)(struct connectdata *, bool *done);
657 /* See above. Currently only used for FTP. */
658 CURLcode (*connecting)(struct connectdata *, bool *done);
659 CURLcode (*doing)(struct connectdata *, bool *done);
661 /* Called from the multi interface during the PROTOCONNECT phase, and it
662 should then return a proper fd set */
663 int (*proto_getsock)(struct connectdata *conn,
664 curl_socket_t *socks,
667 /* Called from the multi interface during the DOING phase, and it should
668 then return a proper fd set */
669 int (*doing_getsock)(struct connectdata *conn,
670 curl_socket_t *socks,
673 /* Called from the multi interface during the DO_MORE phase, and it should
674 then return a proper fd set */
675 int (*domore_getsock)(struct connectdata *conn,
676 curl_socket_t *socks,
679 /* Called from the multi interface during the DO_DONE, PERFORM and
680 WAITPERFORM phases, and it should then return a proper fd set. Not setting
681 this will make libcurl use the generic default one. */
682 int (*perform_getsock)(const struct connectdata *conn,
683 curl_socket_t *socks,
686 /* This function *MAY* be set to a protocol-dependent function that is run
687 * by the curl_disconnect(), as a step in the disconnection. If the handler
688 * is called because the connection has been considered dead, dead_connection
691 CURLcode (*disconnect)(struct connectdata *, bool dead_connection);
693 /* If used, this function gets called from transfer.c:readwrite_data() to
694 allow the protocol to do extra reads/writes */
695 CURLcode (*readwrite)(struct SessionHandle *data, struct connectdata *conn,
696 ssize_t *nread, bool *readmore);
698 long defport; /* Default port. */
699 unsigned int protocol; /* See CURLPROTO_* */
700 unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */
703 #define PROTOPT_NONE 0 /* nothing extra */
704 #define PROTOPT_SSL (1<<0) /* uses SSL */
705 #define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */
706 #define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */
707 /* some protocols will have to call the underlying functions without regard to
708 what exact state the socket signals. IE even if the socket says "readable",
709 the send function might need to be called while uploading, or vice versa.
711 #define PROTOPT_DIRLOCK (1<<3)
712 #define PROTOPT_NONETWORK (1<<4) /* protocol doesn't use the network! */
713 #define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it
715 #define PROTOPT_NOURLQUERY (1<<6) /* protocol can't handle
716 url query strings (?foo=bar) ! */
719 /* return the count of bytes sent, or -1 on error */
720 typedef ssize_t (Curl_send)(struct connectdata *conn, /* connection data */
721 int sockindex, /* socketindex */
722 const void *buf, /* data to write */
723 size_t len, /* max amount to write */
724 CURLcode *err); /* error to return */
726 /* return the count of bytes read, or -1 on error */
727 typedef ssize_t (Curl_recv)(struct connectdata *conn, /* connection data */
728 int sockindex, /* socketindex */
729 char *buf, /* store data here */
730 size_t len, /* max amount to read */
731 CURLcode *err); /* error to return */
734 * The connectdata struct contains all fields and variables that should be
735 * unique for an entire connection.
738 /* 'data' is the CURRENT SessionHandle using this connection -- take great
739 caution that this might very well vary between different times this
740 connection is used! */
741 struct SessionHandle *data;
743 /* chunk is for HTTP chunked encoding, but is in the general connectdata
744 struct only because we can do just about any protocol through a HTTP proxy
745 and a HTTP proxy may in fact respond using chunked encoding */
746 struct Curl_chunker chunk;
748 curl_closesocket_callback fclosesocket; /* function closing the socket(s) */
749 void *closesocket_client;
751 bool inuse; /* This is a marker for the connection cache logic. If this is
752 TRUE this handle is being used by an easy handle and cannot
753 be used by any other easy handle without careful
754 consideration (== only for pipelining). */
756 /**** Fields set when inited and not modified again */
757 long connectindex; /* what index in the connection cache connects index this
758 particular struct has */
760 /* 'dns_entry' is the particular host we use. This points to an entry in the
761 DNS cache and it will not get pruned while locked. It gets unlocked in
762 Curl_done(). This entry will be NULL if the connection is re-used as then
763 there is no name resolve done. */
764 struct Curl_dns_entry *dns_entry;
766 /* 'ip_addr' is the particular IP we connected to. It points to a struct
767 within the DNS cache, so this pointer is only valid as long as the DNS
768 cache entry remains locked. It gets unlocked in Curl_done() */
769 Curl_addrinfo *ip_addr;
771 /* 'ip_addr_str' is the ip_addr data as a human readable string.
772 It remains available as long as the connection does, which is longer than
773 the ip_addr itself. */
774 char ip_addr_str[MAX_IPADR_LEN];
776 unsigned int scope; /* address scope for IPv6 */
778 int socktype; /* SOCK_STREAM or SOCK_DGRAM */
780 struct hostname host;
781 struct hostname proxy;
783 long port; /* which port to use locally */
784 unsigned short remote_port; /* what remote port to connect to,
785 not the proxy port! */
787 /* 'primary_ip' and 'primary_port' get filled with peer's numerical
788 ip address and port number whenever an outgoing connection is
789 *attempted* from the primary socket to a remote address. When more
790 than one address is tried for a connection these will hold data
791 for the last attempt. When the connection is actually established
792 these are updated with data which comes directly from the socket. */
794 char primary_ip[MAX_IPADR_LEN];
797 /* 'local_ip' and 'local_port' get filled with local's numerical
798 ip address and port number whenever an outgoing connection is
799 **established** from the primary socket to a remote address. */
801 char local_ip[MAX_IPADR_LEN];
804 char *user; /* user name string, allocated */
805 char *passwd; /* password string, allocated */
807 char *proxyuser; /* proxy user name string, allocated */
808 char *proxypasswd; /* proxy password string, allocated */
809 curl_proxytype proxytype; /* what kind of proxy that is in use */
811 int httpversion; /* the HTTP version*10 reported by the server */
812 int rtspversion; /* the RTSP version*10 reported by the server */
814 struct timeval now; /* "current" time */
815 struct timeval created; /* creation time */
816 curl_socket_t sock[2]; /* two sockets, the second is used for the data
817 transfer when doing FTP */
818 bool sock_accepted[2]; /* TRUE if the socket on this index was created with
823 struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */
824 struct ssl_config_data ssl_config;
826 struct ConnectBits bits; /* various state-flags for this connection */
828 /* connecttime: when connect() is called on the current IP address. Used to
829 be able to track when to move on to try next IP - but only when the multi
830 interface is used. */
831 struct timeval connecttime;
832 /* The two fields below get set in Curl_connecthost */
833 int num_addr; /* number of addresses to try to connect to */
834 long timeoutms_per_addr; /* how long time in milliseconds to spend on
835 trying to connect to each IP address */
837 const struct Curl_handler *handler; /* Connection's protocol handler */
838 const struct Curl_handler *given; /* The protocol first given */
840 long ip_version; /* copied from the SessionHandle at creation time */
842 /**** curl_get() phase fields */
844 curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */
845 curl_socket_t writesockfd; /* socket to write to, it may very
846 well be the same we read from.
847 CURL_SOCKET_BAD disables */
849 /** Dynamicly allocated strings, MUST be freed before this **/
850 /** struct is killed. **/
851 struct dynamically_allocated_data {
854 char *accept_encoding;
860 char *rtsp_transport;
861 char *te; /* TE: request header */
864 int sec_complete; /* if kerberos is enabled for this connection */
865 #if defined(HAVE_KRB4) || defined(HAVE_GSSAPI)
866 enum protection_level command_prot;
867 enum protection_level data_prot;
868 enum protection_level request_data_prot;
870 struct krb4buffer in_buffer;
872 const struct Curl_sec_client_mech *mech;
873 struct sockaddr_in local_addr;
876 /* the two following *_inuse fields are only flags, not counters in any way.
877 If TRUE it means the channel is in use, and if FALSE it means the channel
878 is up for grabs by one. */
880 bool readchannel_inuse; /* whether the read channel is in use by an easy
882 bool writechannel_inuse; /* whether the write channel is in use by an easy
884 bool server_supports_pipelining; /* TRUE if server supports pipelining,
885 set after first response */
887 struct curl_llist *send_pipe; /* List of handles waiting to
888 send on this pipeline */
889 struct curl_llist *recv_pipe; /* List of handles waiting to read
890 their responses on this pipeline */
891 struct curl_llist *pend_pipe; /* List of pending handles on
893 struct curl_llist *done_pipe; /* Handles that are finished, but
894 still reference this connectdata */
895 #define MAX_PIPELINE_LENGTH 5
897 char* master_buffer; /* The master buffer allocated on-demand;
898 used for pipelining. */
899 size_t read_pos; /* Current read position in the master buffer */
900 size_t buf_len; /* Length of the buffer?? */
903 curl_seek_callback seek_func; /* function that seeks the input */
904 void *seek_client; /* pointer to pass to the seek() above */
906 /*************** Request - specific items ************/
908 /* previously this was in the urldata struct */
909 curl_read_callback fread_func; /* function that reads the input */
910 void *fread_in; /* pointer to pass to the fread() above */
912 struct ntlmdata ntlm; /* NTLM differs from other authentication schemes
913 because it authenticates connections, not
915 struct ntlmdata proxyntlm; /* NTLM data for proxy */
917 #if defined(USE_NTLM) && defined(NTLM_WB_ENABLED)
918 /* used for communication with Samba's winbind daemon helper ntlm_auth */
919 curl_socket_t ntlm_auth_hlpr_socket;
920 pid_t ntlm_auth_hlpr_pid;
921 char* challenge_header;
922 char* response_header;
925 char syserr_buf [256]; /* buffer for Curl_strerror() */
927 #ifdef CURLRES_ASYNCH
928 /* data used for the asynch name resolve callback */
929 struct Curl_async async;
932 /* These three are used for chunked-encoding trailer support */
933 char *trailer; /* allocated buffer to store trailer in */
934 int trlMax; /* allocated buffer size */
935 int trlPos; /* index of where to store data */
938 struct ftp_conn ftpc;
939 struct ssh_conn sshc;
940 struct tftp_state_data *tftpc;
941 struct imap_conn imapc;
942 struct pop3_conn pop3c;
943 struct smtp_conn smtpc;
944 struct rtsp_conn rtspc;
948 int cselect_bits; /* bitmask of socket events */
949 int waitfor; /* current READ/WRITE bits to wait for */
951 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
952 int socks5_gssapi_enctype;
958 /* When this connection is created, store the conditions for the local end
959 bind. This is stored before the actual bind and before any connection is
960 made and will serve the purpose of being used for comparison reasons so
961 that subsequent bound-requested connections aren't accidentally re-using
962 wrong connections. */
964 unsigned short localport;
969 /* The end of connectdata. */
972 * Struct to keep statistical and informational data.
975 int httpcode; /* Recent HTTP, FTP, or RTSP response code */
976 int httpproxycode; /* response code from proxy when received separate */
977 int httpversion; /* the http version number X.Y = X*10+Y */
978 long filetime; /* If requested, this is might get set. Set to -1 if the time
979 was unretrievable. We cannot have this of type time_t,
980 since time_t is unsigned on several platforms such as
982 bool timecond; /* set to TRUE if the time condition didn't match, which
983 thus made the document NOT get fetched */
984 long header_size; /* size of read header(s) in bytes */
985 long request_size; /* the amount of bytes sent in the request(s) */
986 long proxyauthavail; /* what proxy auth types were announced */
987 long httpauthavail; /* what host auth types were announced */
988 long numconnects; /* how many new connection did libcurl created */
989 char *contenttype; /* the content type of the object */
990 char *wouldredirect; /* URL this would've been redirected to if asked to */
992 /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip'
993 and, 'conn_local_port' are copied over from the connectdata struct in
994 order to allow curl_easy_getinfo() to return this information even when
995 the session handle is no longer associated with a connection, and also
996 allow curl_easy_reset() to clear this information from the session handle
997 without disturbing information which is still alive, and that might be
998 reused, in the connection cache. */
1000 char conn_primary_ip[MAX_IPADR_LEN];
1001 long conn_primary_port;
1003 char conn_local_ip[MAX_IPADR_LEN];
1004 long conn_local_port;
1006 struct curl_certinfo certs; /* info about the certs, only populated in
1007 OpenSSL builds. Asked for with
1008 CURLOPT_CERTINFO / CURLINFO_CERTINFO */
1013 long lastshow; /* time() of the last displayed progress meter or NULL to
1014 force redraw at next call */
1015 curl_off_t size_dl; /* total expected size */
1016 curl_off_t size_ul; /* total expected size */
1017 curl_off_t downloaded; /* transferred so far */
1018 curl_off_t uploaded; /* transferred so far */
1020 curl_off_t current_speed; /* uses the currently fastest transfer */
1022 bool callback; /* set when progress callback is used */
1023 int width; /* screen width at download start */
1024 int flags; /* see progress.h */
1033 double t_appconnect;
1034 double t_pretransfer;
1035 double t_starttransfer;
1038 struct timeval start;
1039 struct timeval t_startsingle;
1040 struct timeval t_acceptdata;
1041 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
1043 curl_off_t speeder[ CURR_TIME ];
1044 struct timeval speeder_time[ CURR_TIME ];
1049 HTTPREQ_NONE, /* first in list */
1052 HTTPREQ_POST_FORM, /* we make a difference internally */
1056 HTTPREQ_LAST /* last in list */
1060 RTSPREQ_NONE, /* first in list */
1068 RTSPREQ_GET_PARAMETER,
1069 RTSPREQ_SET_PARAMETER,
1072 RTSPREQ_LAST /* last in list */
1076 * Values that are generated, temporary or calculated internally for a
1077 * "session handle" must be defined within the 'struct UrlState'. This struct
1078 * will be used within the SessionHandle struct. When the 'SessionHandle'
1079 * struct is cloned, this data MUST NOT be copied.
1081 * Remember that any "state" information goes globally for the curl handle.
1082 * Session-data MUST be put in the connectdata struct and here. */
1083 #define MAX_CURL_USER_LENGTH 256
1084 #define MAX_CURL_PASSWORD_LENGTH 256
1085 #define MAX_CURL_USER_LENGTH_TXT "255"
1086 #define MAX_CURL_PASSWORD_LENGTH_TXT "255"
1089 long want; /* Bitmask set to the authentication methods wanted by the app
1090 (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */
1092 long avail; /* bitmask for what the server reports to support for this
1094 bool done; /* TRUE when the auth phase is done and ready to do the *actual*
1096 bool multi; /* TRUE if this is not yet authenticated but within the auth
1097 multipass negotiation */
1098 bool iestyle; /* TRUE if digest should be done IE-style or FALSE if it should
1103 /* 'connects' will be an allocated array with pointers. If the pointer is
1104 set, it holds an allocated connection. */
1105 struct connectdata **connects;
1106 long num; /* number of entries of the 'connects' array */
1108 CONNCACHE_PRIVATE, /* used for an easy handle alone */
1109 CONNCACHE_MULTI /* shared within a multi handle */
1121 struct conncache *connc; /* points to the connection cache this handle
1124 /* buffers to store authentication data in, as parsed from input options */
1125 struct timeval keeps_speed; /* for the progress meter really */
1127 long lastconnect; /* index of most recent connect or -1 if undefined */
1129 char *headerbuff; /* allocated buffer to store headers in */
1130 size_t headersize; /* size of the allocation */
1132 char buffer[BUFSIZE+1]; /* download buffer */
1133 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
1134 curl_off_t current_speed; /* the ProgressShow() funcion sets this,
1136 bool this_is_a_follow; /* this is a followed Location: request */
1138 char *first_host; /* if set, this should be the host name that we will
1139 sent authorization to, no else. Used to make Location:
1140 following not keep sending user+password... This is
1143 struct curl_ssl_session *session; /* array of 'max_ssl_sessions' size */
1144 long sessionage; /* number of the most recent session */
1145 char *tempwrite; /* allocated buffer to keep data in when a write
1146 callback returns to make the connection paused */
1147 size_t tempwritesize; /* size of the 'tempwrite' allocated buffer */
1148 int tempwritetype; /* type of the 'tempwrite' buffer as a bitmask that is
1149 used with Curl_client_write() */
1150 char *scratch; /* huge buffer[BUFSIZE*2] when doing upload CRLF replacing */
1151 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
1152 This must be set to FALSE every time _easy_perform() is
1154 int os_errno; /* filled in with errno whenever an error occurs */
1156 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
1157 void (*prev_signal)(int sig);
1159 bool allow_port; /* Is set.use_port allowed to take effect or not. This
1160 is always set TRUE when curl_easy_perform() is called. */
1161 struct digestdata digest; /* state data for host Digest auth */
1162 struct digestdata proxydigest; /* state data for proxy Digest auth */
1164 #ifdef USE_HTTP_NEGOTIATE
1165 struct negotiatedata negotiate; /* state data for host Negotiate auth */
1166 struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */
1169 struct auth authhost; /* auth details for host */
1170 struct auth authproxy; /* auth details for proxy */
1172 bool authproblem; /* TRUE if there's some problem authenticating */
1174 void *resolver; /* resolver state, if it is used in the URL state -
1175 ares_channel f.e. */
1177 #if defined(USE_SSLEAY) && defined(HAVE_OPENSSL_ENGINE_H)
1179 #endif /* USE_SSLEAY */
1180 struct timeval expiretime; /* set this with Curl_expire() only */
1181 struct Curl_tree timenode; /* for the splay stuff */
1182 struct curl_llist *timeoutlist; /* list of pending timeouts */
1184 /* a place to store the most recently set FTP entrypath */
1185 char *most_recent_ftp_entrypath;
1187 /* set after initial USER failure, to prevent an authentication loop */
1188 bool ftp_trying_alternative;
1190 int httpversion; /* the lowest HTTP version*10 reported by any server
1191 involved in this request */
1192 bool expect100header; /* TRUE if we added Expect: 100-continue */
1194 bool pipe_broke; /* TRUE if the connection we were pipelined on broke
1195 and we need to restart from the beginning */
1197 #if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) && \
1198 !defined(__SYMBIAN32__)
1199 /* do FTP line-end conversions on most platforms */
1200 #define CURL_DO_LINEEND_CONV
1201 /* for FTP downloads: track CRLF sequences that span blocks */
1202 bool prev_block_had_trailing_cr;
1203 /* for FTP downloads: how many CRLFs did we converted to LFs? */
1204 curl_off_t crlf_conversions;
1206 /* If set to non-NULL, there's a connection in a shared connection cache
1207 that uses this handle so we can't kill this SessionHandle just yet but
1208 must keep it around and add it to the list of handles to kill once all
1209 its connections are gone */
1211 bool closed; /* set to TRUE when curl_easy_cleanup() has been called on this
1212 handle, but it is kept around as mentioned for
1214 char *pathbuffer;/* allocated buffer to store the URL's path part in */
1215 char *path; /* path to use, points to somewhere within the pathbuffer
1217 bool slash_removed; /* set TRUE if the 'path' points to a path where the
1218 initial URL slash separator has been taken off */
1220 bool rangestringalloc; /* the range string is malloc()'ed */
1222 char *range; /* range, if used. See README for detailed specification on
1224 curl_off_t resume_from; /* continue [ftp] transfer from here */
1226 /* This RTSP state information survives requests and connections */
1227 long rtsp_next_client_CSeq; /* the session's next client CSeq */
1228 long rtsp_next_server_CSeq; /* the session's next server CSeq */
1229 long rtsp_CSeq_recv; /* most recent CSeq received */
1231 /* Protocol specific data.
1233 *************************************************************************
1234 * Note that this data will be REMOVED after each request, so anything that
1235 * should be kept/stored on a per-connection basis and thus live for the
1236 * next request on the same connection MUST be put in the connectdata struct!
1237 *************************************************************************/
1240 struct HTTP *https; /* alias, just for the sake of being more readable */
1243 /* void *tftp; not used */
1244 struct FILEPROTO *file;
1245 void *telnet; /* private for telnet.c-eyes only */
1247 struct SSHPROTO *ssh;
1252 /* current user of this SessionHandle instance, or NULL */
1253 struct connectdata *current_conn;
1255 /* if true, force SSL connection retry (workaround for certain servers) */
1256 bool ssl_connect_retry;
1261 * This 'DynamicStatic' struct defines dynamic states that actually change
1262 * values in the 'UserDefined' area, which MUST be taken into consideration
1263 * if the UserDefined struct is cloned or similar. You can probably just
1264 * copy these, but each one indicate a special action on other data.
1267 struct DynamicStatic {
1268 char *url; /* work URL, copied from UserDefined */
1269 bool url_alloc; /* URL string is malloc()'ed */
1270 char *referer; /* referer string */
1271 bool referer_alloc; /* referer sting is malloc()ed */
1272 struct curl_slist *cookielist; /* list of cookie files set by
1273 curl_easy_setopt(COOKIEFILE) calls */
1274 struct curl_slist *resolve; /* set to point to the set.resolve list when
1275 this should be dealt with in pretransfer */
1279 * This 'UserDefined' struct must only contain data that is set once to go
1280 * for many (perhaps) independent connections. Values that are generated or
1281 * calculated internally for the "session handle" MUST be defined within the
1282 * 'struct UrlState' instead. The only exceptions MUST note the changes in
1283 * the 'DynamicStatic' struct.
1284 * Character pointer fields point to dynamic storage, unless otherwise stated.
1286 struct Curl_one_easy; /* declared and used only in multi.c */
1287 struct Curl_multi; /* declared and used only in multi.c */
1290 STRING_CERT, /* client certificate file name */
1291 STRING_CERT_TYPE, /* format for certificate (default: PEM)*/
1292 STRING_COOKIE, /* HTTP cookie string to send */
1293 STRING_COOKIEJAR, /* dump all cookies to this file */
1294 STRING_CUSTOMREQUEST, /* HTTP/FTP/RTSP request/method to use */
1295 STRING_DEVICE, /* local network interface/address to use */
1296 STRING_ENCODING, /* Accept-Encoding string */
1297 STRING_FTP_ACCOUNT, /* ftp account data */
1298 STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */
1299 STRING_FTPPORT, /* port to send with the FTP PORT command */
1300 STRING_KEY, /* private key file name */
1301 STRING_KEY_PASSWD, /* plain text private key password */
1302 STRING_KEY_TYPE, /* format for private key (default: PEM) */
1303 STRING_KRB_LEVEL, /* krb security level */
1304 STRING_NETRC_FILE, /* if not NULL, use this instead of trying to find
1306 STRING_COPYPOSTFIELDS, /* if POST, set the fields' values here */
1307 STRING_PROXY, /* proxy to use */
1308 STRING_SET_RANGE, /* range, if used */
1309 STRING_SET_REFERER, /* custom string for the HTTP referer field */
1310 STRING_SET_URL, /* what original URL to work on */
1311 STRING_SSL_CAPATH, /* CA directory name (doesn't work on windows) */
1312 STRING_SSL_CAFILE, /* certificate file to verify peer against */
1313 STRING_SSL_CIPHER_LIST, /* list of ciphers to use */
1314 STRING_SSL_EGDSOCKET, /* path to file containing the EGD daemon socket */
1315 STRING_SSL_RANDOM_FILE, /* path to file containing "random" data */
1316 STRING_USERAGENT, /* User-Agent string */
1317 STRING_SSL_CRLFILE, /* crl file to check certificate */
1318 STRING_SSL_ISSUERCERT, /* issuer cert file to check certificate */
1319 STRING_USERNAME, /* <username>, if used */
1320 STRING_PASSWORD, /* <password>, if used */
1321 STRING_PROXYUSERNAME, /* Proxy <username>, if used */
1322 STRING_PROXYPASSWORD, /* Proxy <password>, if used */
1323 STRING_NOPROXY, /* List of hosts which should not use the proxy, if
1325 STRING_RTSP_SESSION_ID, /* Session ID to use */
1326 STRING_RTSP_STREAM_URI, /* Stream URI for this request */
1327 STRING_RTSP_TRANSPORT, /* Transport for this session */
1329 STRING_SSH_PRIVATE_KEY, /* path to the private key file for auth */
1330 STRING_SSH_PUBLIC_KEY, /* path to the public key file for auth */
1331 STRING_SSH_HOST_PUBLIC_KEY_MD5, /* md5 of host public key in ascii hex */
1332 STRING_SSH_KNOWNHOSTS, /* file name of knownhosts file */
1334 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1335 STRING_SOCKS5_GSSAPI_SERVICE, /* GSSAPI service name */
1340 STRING_TLSAUTH_USERNAME, /* TLS auth <username> */
1341 STRING_TLSAUTH_PASSWORD, /* TLS auth <password> */
1344 /* -- end of strings -- */
1345 STRING_LAST /* not used, just an end-of-list marker */
1348 struct UserDefined {
1349 FILE *err; /* the stderr user data goes here */
1350 void *debugdata; /* the data that will be passed to fdebug */
1351 char *errorbuffer; /* (Static) store failure messages in here */
1352 long proxyport; /* If non-zero, use this port number by default. If the
1353 proxy string features a ":[port]" that one will override
1355 void *out; /* the fetched file goes here */
1356 void *in; /* the uploaded file is read from here */
1357 void *writeheader; /* write the header to this if non-NULL */
1358 void *rtp_out; /* write RTP to this if non-NULL */
1359 long use_port; /* which port to use (when not using default) */
1360 long httpauth; /* what kind of HTTP authentication to use (bitmask) */
1361 long proxyauth; /* what kind of proxy authentication to use (bitmask) */
1362 long followlocation; /* as in HTTP Location: */
1363 long maxredirs; /* maximum no. of http(s) redirects to follow, set to -1
1365 bool post301; /* Obey RFC 2616/10.3.2 and keep POSTs as POSTs after a
1367 bool post302; /* keep POSTs as POSTs after a 302 */
1368 bool free_referer; /* set TRUE if 'referer' points to a string we
1370 void *postfields; /* if POST, set the fields' values here */
1371 curl_seek_callback seek_func; /* function that seeks the input */
1372 curl_off_t postfieldsize; /* if POST, this might have a size to use instead
1373 of strlen(), and then the data *may* be binary
1374 (contain zero bytes) */
1375 unsigned short localport; /* local port number to bind to */
1376 int localportrange; /* number of additional port numbers to test in case the
1377 'localport' one can't be bind()ed */
1378 curl_write_callback fwrite_func; /* function that stores the output */
1379 curl_write_callback fwrite_header; /* function that stores headers */
1380 curl_write_callback fwrite_rtp; /* function that stores interleaved RTP */
1381 curl_read_callback fread_func; /* function that reads the input */
1382 int is_fread_set; /* boolean, has read callback been set to non-NULL? */
1383 int is_fwrite_set; /* boolean, has write callback been set to non-NULL? */
1384 curl_progress_callback fprogress; /* function for progress information */
1385 curl_debug_callback fdebug; /* function that write informational data */
1386 curl_ioctl_callback ioctl_func; /* function for I/O control */
1387 curl_sockopt_callback fsockopt; /* function for setting socket options */
1388 void *sockopt_client; /* pointer to pass to the socket options callback */
1389 curl_opensocket_callback fopensocket; /* function for checking/translating
1390 the address and opening the
1392 void* opensocket_client;
1393 curl_closesocket_callback fclosesocket; /* function for closing the
1395 void* closesocket_client;
1397 void *seek_client; /* pointer to pass to the seek callback */
1398 /* the 3 curl_conv_callback functions below are used on non-ASCII hosts */
1399 /* function to convert from the network encoding: */
1400 curl_conv_callback convfromnetwork;
1401 /* function to convert to the network encoding: */
1402 curl_conv_callback convtonetwork;
1403 /* function to convert from UTF-8 encoding: */
1404 curl_conv_callback convfromutf8;
1406 void *progress_client; /* pointer to pass to the progress callback */
1407 void *ioctl_client; /* pointer to pass to the ioctl callback */
1408 long timeout; /* in milliseconds, 0 means no timeout */
1409 long connecttimeout; /* in milliseconds, 0 means no timeout */
1410 long accepttimeout; /* in milliseconds, 0 means no timeout */
1411 long server_response_timeout; /* in milliseconds, 0 means no timeout */
1412 long tftp_blksize ; /* in bytes, 0 means use default */
1413 curl_off_t infilesize; /* size of file to upload, -1 means unknown */
1414 long low_speed_limit; /* bytes/second */
1415 long low_speed_time; /* number of seconds */
1416 curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */
1417 curl_off_t max_recv_speed; /* high speed limit in bytes/second for
1419 curl_off_t set_resume_from; /* continue [ftp] transfer from here */
1420 struct curl_slist *headers; /* linked list of extra headers */
1421 struct curl_httppost *httppost; /* linked list of POST data */
1422 bool cookiesession; /* new cookie session? */
1423 bool crlf; /* convert crlf on ftp upload(?) */
1424 struct curl_slist *quote; /* after connection is established */
1425 struct curl_slist *postquote; /* after the transfer */
1426 struct curl_slist *prequote; /* before the transfer, after type */
1427 struct curl_slist *source_quote; /* 3rd party quote */
1428 struct curl_slist *source_prequote; /* in 3rd party transfer mode - before
1429 the transfer on source host */
1430 struct curl_slist *source_postquote; /* in 3rd party transfer mode - after
1431 the transfer on source host */
1432 struct curl_slist *telnet_options; /* linked list of telnet options */
1433 struct curl_slist *resolve; /* list of names to add/remove from
1435 curl_TimeCond timecondition; /* kind of time/date comparison */
1436 time_t timevalue; /* what time to compare with */
1437 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
1438 long httpversion; /* when non-zero, a specific HTTP version requested to
1439 be used in the library's request(s) */
1440 struct ssl_config_data ssl; /* user defined SSL stuff */
1441 curl_proxytype proxytype; /* what kind of proxy that is in use */
1442 long dns_cache_timeout; /* DNS cache timeout */
1443 long buffer_size; /* size of receive buffer to use */
1444 void *private_data; /* application-private data */
1446 struct Curl_one_easy *one_easy; /* When adding an easy handle to a multi
1447 handle, an internal 'Curl_one_easy'
1448 struct is created and this is a pointer
1449 to the particular struct associated with
1450 this SessionHandle */
1452 struct curl_slist *http200aliases; /* linked list of aliases for http200 */
1454 long ipver; /* the CURL_IPRESOLVE_* defines in the public header file
1455 0 - whatever, 1 - v2, 2 - v6 */
1457 curl_off_t max_filesize; /* Maximum file size to download */
1459 curl_ftpfile ftp_filemethod; /* how to get to a file when FTP is used */
1461 int ftp_create_missing_dirs; /* 1 - create directories that don't exist
1462 2 - the same but also allow MKD to fail once
1465 curl_sshkeycallback ssh_keyfunc; /* key matching callback */
1466 void *ssh_keyfunc_userp; /* custom pointer to callback */
1468 /* Here follows boolean settings that define how to behave during
1469 this session. They are STATIC, set by libcurl users or at least initially
1470 and they don't change during operations. */
1472 bool printhost; /* printing host name in debug info */
1473 bool get_filetime; /* get the time and get of the remote file */
1474 bool tunnel_thru_httpproxy; /* use CONNECT through a HTTP proxy */
1475 bool prefer_ascii; /* ASCII rather than binary */
1476 bool ftp_append; /* append, not overwrite, on upload */
1477 bool ftp_list_only; /* switch FTP command for listing directories */
1478 bool ftp_use_port; /* use the FTP PORT command */
1479 bool hide_progress; /* don't use the progress meter */
1480 bool http_fail_on_error; /* fail on HTTP error codes >= 300 */
1481 bool http_follow_location; /* follow HTTP redirects */
1482 bool http_transfer_encoding; /* request compressed HTTP transfer-encoding */
1483 bool http_disable_hostname_check_before_authentication;
1484 bool include_header; /* include received protocol headers in data output */
1485 bool http_set_referer; /* is a custom referer used */
1486 bool http_auto_referer; /* set "correct" referer when following location: */
1487 bool opt_no_body; /* as set with CURLOPT_NO_BODY */
1488 bool set_port; /* custom port number used */
1489 bool upload; /* upload request */
1490 enum CURL_NETRC_OPTION
1491 use_netrc; /* defined in include/curl.h */
1492 bool verbose; /* output verbosity */
1493 bool krb; /* kerberos connection requested */
1494 bool reuse_forbid; /* forbidden to be reused, close after use */
1495 bool reuse_fresh; /* do not re-use an existing connection */
1496 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
1497 bool ftp_use_eprt; /* if EPRT is to be attempted or not */
1498 bool ftp_use_pret; /* if PRET is to be used before PASV or not */
1500 curl_usessl use_ssl; /* if AUTH TLS is to be attempted etc, for FTP or
1501 IMAP or POP3 or others! */
1502 curl_ftpauth ftpsslauth; /* what AUTH XXX to be attempted */
1503 curl_ftpccc ftp_ccc; /* FTP CCC options */
1504 bool no_signal; /* do not use any signal/alarm handler */
1505 bool global_dns_cache; /* subject for future removal */
1506 bool tcp_nodelay; /* whether to enable TCP_NODELAY or not */
1507 bool ignorecl; /* ignore content length */
1508 bool ftp_skip_ip; /* skip the IP address the FTP server passes on to
1510 bool connect_only; /* make connection, let application use the socket */
1511 long ssh_auth_types; /* allowed SSH auth types */
1512 bool http_te_skip; /* pass the raw body data to the user, even when
1513 transfer-encoded (chunked, compressed) */
1514 bool http_ce_skip; /* pass the raw body data to the user, even when
1515 content-encoded (chunked, compressed) */
1516 long new_file_perms; /* Permissions to use when creating remote files */
1517 long new_directory_perms; /* Permissions to use when creating remote dirs */
1518 bool proxy_transfer_mode; /* set transfer mode (;type=<a|i>) when doing FTP
1519 via an HTTP proxy */
1520 char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */
1521 unsigned int scope; /* address scope for IPv6 */
1522 long allowed_protocols;
1523 long redir_protocols;
1524 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1525 long socks5_gssapi_nec; /* flag to support nec socks5 server */
1527 struct curl_slist *mail_rcpt; /* linked list of mail recipients */
1528 /* Common RTSP header options */
1529 Curl_RtspReq rtspreq; /* RTSP request type */
1530 long rtspversion; /* like httpversion, for RTSP */
1531 bool wildcardmatch; /* enable wildcard matching */
1532 curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer
1534 curl_chunk_end_callback chunk_end; /* called after part transferring
1536 curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds
1537 to pattern (e.g. if WILDCARDMATCH is on) */
1540 long gssapi_delegation; /* GSSAPI credential delegation, see the
1541 documentation of CURLOPT_GSSAPI_DELEGATION */
1543 bool tcp_keepalive; /* use TCP keepalives */
1544 long tcp_keepidle; /* seconds in idle before sending keepalive probe */
1545 long tcp_keepintvl; /* seconds between TCP keepalive probes */
1549 struct curl_hash *hostcache;
1551 HCACHE_NONE, /* not pointing to anything */
1552 HCACHE_PRIVATE, /* points to our own */
1553 HCACHE_GLOBAL, /* points to the (shrug) global one */
1554 HCACHE_MULTI, /* points to a shared one in the multi handle */
1555 HCACHE_SHARED /* points to a shared one in a shared object */
1560 * The 'connectdata' struct MUST have all the connection oriented stuff as we
1561 * may have several simultaneous connections and connection structs in memory.
1563 * The 'struct UserDefined' must only contain data that is set once to go for
1564 * many (perhaps) independent connections. Values that are generated or
1565 * calculated internally for the "session handle" must be defined within the
1566 * 'struct UrlState' instead.
1569 struct SessionHandle {
1571 struct Curl_multi *multi; /* if non-NULL, points to the multi handle
1572 struct to which this "belongs" */
1573 struct Curl_one_easy *multi_pos; /* if non-NULL, points to its position
1574 in multi controlling structure to assist
1576 struct Curl_share *share; /* Share, handles global variable mutexing */
1577 struct SingleRequest req; /* Request-specific data */
1578 struct UserDefined set; /* values set by the libcurl user */
1579 struct DynamicStatic change; /* possibly modified userdefined data */
1580 struct CookieInfo *cookies; /* the cookies, read from files and servers.
1581 NOTE that the 'cookie' field in the
1582 UserDefined struct defines if the "engine"
1583 is to be used or not. */
1584 struct Progress progress; /* for all the progress meter data */
1585 struct UrlState state; /* struct for fields used for state info and
1586 other dynamic purposes */
1587 struct WildcardData wildcard; /* wildcard download state info */
1588 struct PureInfo info; /* stats, reports and info data */
1589 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
1590 iconv_t outbound_cd; /* for translating to the network encoding */
1591 iconv_t inbound_cd; /* for translating from the network encoding */
1592 iconv_t utf8_cd; /* for translating to UTF8 */
1593 #endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */
1594 unsigned int magic; /* set to a CURLEASY_MAGIC_NUMBER */
1597 #define LIBCURL_NAME "libcurl"
1599 #endif /* HEADER_CURL_URLDATA_H */
projects / platform / upstream / curl.git / blob