1 #ifndef HEADER_CURL_URLDATA_H
2 #define HEADER_CURL_URLDATA_H
3 /***************************************************************************
5 * Project ___| | | | _ \| |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 1998 - 2013, Daniel Stenberg, <daniel@haxx.se>, et al.
12 * This software is licensed as described in the file COPYING, which
13 * you should have received as part of this distribution. The terms
14 * are also available at http://curl.haxx.se/docs/copyright.html.
16 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17 * copies of the Software, and permit persons to whom the Software is
18 * furnished to do so, under the terms of the COPYING file.
20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21 * KIND, either express or implied.
23 ***************************************************************************/
25 /* This file is for lib internal stuff */
27 #include "curl_setup.h"
31 #define PORT_TELNET 23
33 #define PORT_HTTPS 443
34 #define PORT_DICT 2628
36 #define PORT_LDAPS 636
40 #define PORT_IMAPS 993
42 #define PORT_POP3S 995
44 #define PORT_SMTPS 465 /* sometimes called SSMTP */
46 #define PORT_RTMP 1935
47 #define PORT_RTMPT PORT_HTTP
48 #define PORT_RTMPS PORT_HTTPS
49 #define PORT_GOPHER 70
51 #define DICT_MATCH "/MATCH:"
52 #define DICT_MATCH2 "/M:"
53 #define DICT_MATCH3 "/FIND:"
54 #define DICT_DEFINE "/DEFINE:"
55 #define DICT_DEFINE2 "/D:"
56 #define DICT_DEFINE3 "/LOOKUP:"
58 #define CURL_DEFAULT_USER "anonymous"
59 #define CURL_DEFAULT_PASSWORD "ftp@example.com"
61 /* length of longest IPv6 address string including the trailing null */
62 #define MAX_IPADR_LEN sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255")
64 /* Default FTP/IMAP etc response timeout in milliseconds.
65 Symbian OS panics when given a timeout much greater than 1/2 hour.
67 #define RESP_TIMEOUT (1800*1000)
74 #include <openssl/rsa.h>
75 #include <openssl/crypto.h>
76 #include <openssl/x509.h>
77 #include <openssl/pem.h>
78 #include <openssl/ssl.h>
79 #include <openssl/err.h>
80 #ifdef HAVE_OPENSSL_ENGINE_H
81 #include <openssl/engine.h>
83 #ifdef HAVE_OPENSSL_PKCS12_H
84 #include <openssl/pkcs12.h>
86 #else /* SSLeay-style includes */
93 #ifdef HAVE_OPENSSL_ENGINE_H
96 #ifdef HAVE_OPENSSL_PKCS12_H
99 #endif /* USE_OPENSSL */
101 #error Configuration error; cannot use GnuTLS *and* OpenSSL.
103 #endif /* USE_SSLEAY */
106 #include <gnutls/gnutls.h>
110 #include <polarssl/ssl.h>
111 #include <polarssl/version.h>
112 #if POLARSSL_VERSION_NUMBER<0x01010000
113 #include <polarssl/havege.h>
115 #include <polarssl/entropy.h>
116 #include <polarssl/ctr_drbg.h>
117 #endif /* POLARSSL_VERSION_NUMBER<0x01010000 */
118 #endif /* USE_POLARSSL */
121 #undef OCSP_REQUEST /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */
122 #undef OCSP_RESPONSE /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */
123 #include <cyassl/openssl/ssl.h>
136 #include <axTLS/ssl.h>
140 #endif /* USE_AXTLS */
143 #include "curl_sspi.h"
145 #include <schannel.h>
149 #include <Security/Security.h>
150 /* For some reason, when building for iOS, the omnibus header above does
151 * not include SecureTransport.h as of iOS SDK 5.1. */
152 #include <Security/SecureTransport.h>
155 #ifdef HAVE_NETINET_IN_H
156 #include <netinet/in.h>
162 #include <zlib.h> /* for content-encoding */
164 /* zlib pollutes the namespace with this definition */
169 #include <curl/curl.h>
171 #include "http_chunks.h" /* for the structs and enum stuff */
184 #include "wildcard.h"
189 # elif defined HAVE_GSSMIT
190 # include <gssapi/gssapi.h>
191 # include <gssapi/gssapi_generic.h>
197 #ifdef HAVE_LIBSSH2_H
199 #include <libssh2_sftp.h>
200 #endif /* HAVE_LIBSSH2_H */
202 /* Download buffer size, keep it fairly big for speed reasons */
204 #define BUFSIZE CURL_MAX_WRITE_SIZE
206 /* Initial size of the buffer to store headers in, it'll be enlarged in case
208 #define HEADERSIZE 256
210 #define CURLEASY_MAGIC_NUMBER 0xc0dedbadU
212 /* Some convenience macros to get the larger/smaller value out of two given.
213 We prefix with CURL to prevent name collisions. */
214 #define CURLMAX(x,y) ((x)>(y)?(x):(y))
215 #define CURLMIN(x,y) ((x)<(y)?(x):(y))
218 #if defined(HAVE_KRB4) || defined(HAVE_GSSAPI)
219 /* Types needed for krb4/5-ftp connections */
227 enum protection_level {
228 PROT_NONE, /* first in list */
234 PROT_LAST /* last in list */
239 /* Structs to store Schannel handles */
240 struct curl_schannel_cred {
241 CredHandle cred_handle;
242 TimeStamp time_stamp;
246 struct curl_schannel_ctxt {
247 CtxtHandle ctxt_handle;
248 TimeStamp time_stamp;
252 /* enum for the nonblocking SSL connection state machine */
256 ssl_connect_2_reading,
257 ssl_connect_2_writing,
264 ssl_connection_negotiating,
265 ssl_connection_complete
266 } ssl_connection_state;
268 /* struct for data related to each SSL connection */
269 struct ssl_connect_data {
270 /* Use ssl encrypted communications TRUE/FALSE, not necessarily using it atm
271 but at least asked to or meaning to use it. See 'state' for the exact
272 current state of the connection. */
274 ssl_connection_state state;
276 /* these ones requires specific SSL-types */
280 ssl_connect_state connecting_state;
281 #endif /* USE_SSLEAY */
283 gnutls_session session;
284 gnutls_certificate_credentials cred;
286 gnutls_srp_client_credentials srp_client_cred;
288 ssl_connect_state connecting_state;
289 #endif /* USE_GNUTLS */
291 #if POLARSSL_VERSION_NUMBER<0x01010000
294 /* from v1.1.0, use ctr_drbg and entropy */
295 ctr_drbg_context ctr_drbg;
296 entropy_context entropy;
297 #endif /* POLARSSL_VERSION_NUMBER<0x01010000 */
305 ssl_connect_state connecting_state;
306 #endif /* USE_POLARSSL */
310 ssl_connect_state connecting_state;
311 #endif /* USE_CYASSL */
314 char *client_nickname;
315 struct SessionHandle *data;
316 struct curl_llist *obj_list;
317 PK11GenericObject *obj_clicert;
321 #endif /* USE_QSOSSL */
325 #endif /* USE_AXTLS */
327 struct curl_schannel_cred *cred;
328 struct curl_schannel_ctxt *ctxt;
329 SecPkgContext_StreamSizes stream_sizes;
330 ssl_connect_state connecting_state;
331 size_t encdata_length, decdata_length;
332 size_t encdata_offset, decdata_offset;
333 unsigned char *encdata_buffer, *decdata_buffer;
334 unsigned long req_flags, ret_flags;
335 #endif /* USE_SCHANNEL */
337 SSLContextRef ssl_ctx;
338 curl_socket_t ssl_sockfd;
339 ssl_connect_state connecting_state;
340 bool ssl_direction; /* true if writing, false if reading */
341 size_t ssl_write_buffered_length;
342 #endif /* USE_DARWINSSL */
345 struct ssl_config_data {
346 long version; /* what version the client wants to use */
347 long certverifyresult; /* result from the certificate verification */
349 bool verifypeer; /* set TRUE if this is desired */
350 bool verifyhost; /* set TRUE if CN/SAN must match hostname */
351 char *CApath; /* certificate dir (doesn't work on windows) */
352 char *CAfile; /* certificate to verify peer against */
353 const char *CRLfile; /* CRL to check certificate revocation */
354 const char *issuercert;/* optional issuer certificate filename */
355 char *random_file; /* path to file containing "random" data */
356 char *egdsocket; /* path to file containing the EGD daemon socket */
357 char *cipher_list; /* list of ciphers to use */
358 size_t max_ssl_sessions; /* SSL session id cache size */
359 curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */
360 void *fsslctxp; /* parameter for call back */
361 bool sessionid; /* cache session IDs or not */
362 bool certinfo; /* gather lots of certificate info */
365 char *username; /* TLS username (for, e.g., SRP) */
366 char *password; /* TLS password (for, e.g., SRP) */
367 enum CURL_TLSAUTH authtype; /* TLS authentication type (default SRP) */
371 /* information stored about one single SSL session */
372 struct curl_ssl_session {
373 char *name; /* host name for which this ID was used */
374 void *sessionid; /* as returned from the SSL layer */
375 size_t idsize; /* if known, otherwise 0 */
376 long age; /* just a number, the higher the more recent */
377 unsigned short remote_port; /* remote port to connect to */
378 struct ssl_config_data ssl_config; /* setup for this session */
381 /* Struct used for Digest challenge-response authentication */
387 bool stale; /* set true for re-negotiation */
391 int nc; /* nounce count */
402 #ifdef USE_WINDOWS_SSPI
403 #include "curl_sspi.h"
406 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
410 /* Struct used for NTLM challenge-response authentication */
413 #ifdef USE_WINDOWS_SSPI
416 SEC_WINNT_AUTH_IDENTITY identity;
417 SEC_WINNT_AUTH_IDENTITY *p_identity;
420 unsigned long n_type_2;
423 unsigned char nonce[8];
427 #ifdef USE_HTTP_NEGOTIATE
428 struct negotiatedata {
429 /* when doing Negotiate we first need to receive an auth token and then we
430 need to send our header */
431 enum { GSS_AUTHNONE, GSS_AUTHRECV, GSS_AUTHSENT } state;
432 bool gss; /* Whether we're processing GSS-Negotiate or Negotiate */
433 const char* protocol; /* "GSS-Negotiate" or "Negotiate" */
436 gss_ctx_id_t context;
437 gss_name_t server_name;
438 gss_buffer_desc output_token;
440 #ifdef USE_WINDOWS_SSPI
443 CredHandle *credentials;
444 char server_name[1024];
445 size_t max_token_length;
447 size_t output_token_length;
455 * Boolean values that concerns this connection.
458 bool close; /* if set, we close the connection after this request */
459 bool reuse; /* if set, this is a re-used connection */
460 bool proxy; /* if set, this transfer is done through a proxy - any type */
461 bool httpproxy; /* if set, this transfer is done through a http proxy */
462 bool user_passwd; /* do we use user+password for this connection? */
463 bool proxy_user_passwd; /* user+password for the proxy? */
464 bool ipv6_ip; /* we communicate with a remote site specified with pure IPv6
466 bool ipv6; /* we communicate with a site using an IPv6 address */
468 bool do_more; /* this is set TRUE if the ->curl_do_more() function is
469 supposed to be called, after ->curl_do() */
470 bool tcpconnect[2]; /* the TCP layer (or similar) is connected, this is set
471 the first time on the first connect function call */
472 bool protoconnstart;/* the protocol layer has STARTED its operation after
473 the TCP layer connect */
475 bool retry; /* this connection is about to get closed and then
476 re-attempted at another connection. */
477 bool tunnel_proxy; /* if CONNECT is used to "tunnel" through the proxy.
478 This is implicit when SSL-protocols are used through
479 proxies, but can also be enabled explicitly by
481 bool authneg; /* TRUE when the auth phase has started, which means
482 that we are creating a request with an auth header,
483 but it is not the final request in the auth
485 bool rewindaftersend;/* TRUE when the sending couldn't be stopped even
486 though it will be discarded. When the whole send
487 operation is done, we must call the data rewind
489 bool ftp_use_epsv; /* As set with CURLOPT_FTP_USE_EPSV, but if we find out
490 EPSV doesn't work we disable it for the forthcoming
493 bool ftp_use_eprt; /* As set with CURLOPT_FTP_USE_EPRT, but if we find out
494 EPRT doesn't work we disable it for the forthcoming
496 bool netrc; /* name+password provided by netrc */
497 bool userpwd_in_url; /* name+password found in url */
499 bool done; /* set to FALSE when Curl_do() is called and set to TRUE
500 when Curl_done() is called, to prevent Curl_done() to
501 get invoked twice when the multi interface is
503 bool stream_was_rewound; /* Indicates that the stream was rewound after a
504 request read past the end of its response byte
506 bool proxy_connect_closed; /* set true if a proxy disconnected the
507 connection in a CONNECT request with auth, so
508 that libcurl should reconnect and continue. */
509 bool bound; /* set true if bind() has already been done on this socket/
511 bool type_set; /* type= was used in the URL */
515 char *rawalloc; /* allocated "raw" version of the name */
516 char *encalloc; /* allocated IDN-encoded version of the name */
517 char *name; /* name to use internally, might be encoded, might be raw */
518 const char *dispname; /* name to display, as 'name' might be encoded */
522 * Flags on the keepon member of the Curl_transfer_keeper
526 #define KEEP_RECV (1<<0) /* there is or may be data to read */
527 #define KEEP_SEND (1<<1) /* there is or may be data to write */
528 #define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there
529 might still be data to read */
530 #define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there
531 might still be data to write */
532 #define KEEP_RECV_PAUSE (1<<4) /* reading is paused */
533 #define KEEP_SEND_PAUSE (1<<5) /* writing is paused */
535 #define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE)
536 #define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE)
541 ZLIB_UNINIT, /* uninitialized */
542 ZLIB_INIT, /* initialized */
543 ZLIB_GZIP_HEADER, /* reading gzip header */
544 ZLIB_GZIP_INFLATING, /* inflating gzip stream */
545 ZLIB_INIT_GZIP /* initialized in transparent gzip mode */
549 #ifdef CURLRES_ASYNCH
553 struct Curl_dns_entry *dns;
554 bool done; /* set TRUE when the lookup is complete */
555 int status; /* if done is TRUE, this is the status from the callback */
556 void *os_specific; /* 'struct thread_data' for Windows */
560 #define FIRSTSOCKET 0
561 #define SECONDARYSOCKET 1
563 /* These function pointer types are here only to allow easier typecasting
564 within the source when we need to cast between data pointers (such as NULL)
565 and function pointers. */
566 typedef CURLcode (*Curl_do_more_func)(struct connectdata *, bool *);
567 typedef CURLcode (*Curl_done_func)(struct connectdata *, CURLcode, bool);
571 EXP100_SEND_DATA, /* enough waiting, just send the body now */
572 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */
573 EXP100_SENDING_REQUEST, /* still sending the request but will wait for
574 the 100 header once done with the request */
575 EXP100_FAILED /* used on 417 Expectation Failed */
579 * Request specific data in the easy handle (SessionHandle). Previously,
580 * these members were on the connectdata struct but since a conn struct may
581 * now be shared between different SessionHandles, we store connection-specific
582 * data here. This struct only keeps stuff that's interesting for *this*
583 * request, as it will be cleared between multiple ones
585 struct SingleRequest {
586 curl_off_t size; /* -1 if unknown at this point */
587 curl_off_t *bytecountp; /* return number of bytes read or NULL */
589 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch,
590 -1 means unlimited */
591 curl_off_t *writebytecountp; /* return number of bytes written or NULL */
593 curl_off_t bytecount; /* total number of bytes read */
594 curl_off_t writebytecount; /* number of bytes written */
596 long headerbytecount; /* only count received headers */
597 long deductheadercount; /* this amount of bytes doesn't count when we check
598 if anything has been transferred at the end of a
599 connection. We use this counter to make only a
600 100 reply (without a following second response
601 code) result in a CURLE_GOT_NOTHING error code */
603 struct timeval start; /* transfer started at this time */
604 struct timeval now; /* current time */
605 bool header; /* incoming data has HTTP header */
607 HEADER_NORMAL, /* no bad header at all */
608 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest
610 HEADER_ALLBAD /* all was believed to be header */
611 } badheader; /* the header was deemed bad and will be
613 int headerline; /* counts header lines to better track the
615 char *hbufp; /* points at *end* of header line */
617 char *str; /* within buf */
618 char *str_start; /* within buf */
619 char *end_ptr; /* within buf */
620 char *p; /* within headerbuff */
621 bool content_range; /* set TRUE if Content-Range: was found */
622 curl_off_t offset; /* possible resume offset read from the
623 Content-Range: header */
624 int httpcode; /* error code from the 'HTTP/1.? XXX' or
625 'RTSP/1.? XXX' line */
626 struct timeval start100; /* time stamp to wait for the 100 code from */
627 enum expect100 exp100; /* expect 100 continue state */
629 int auto_decoding; /* What content encoding. sec 3.5, RFC2616. */
631 #define IDENTITY 0 /* No encoding */
632 #define DEFLATE 1 /* zlib deflate [RFC 1950 & 1951] */
633 #define GZIP 2 /* gzip algorithm [RFC 1952] */
634 #define COMPRESS 3 /* Not handled, added for completeness */
637 zlibInitState zlib_init; /* possible zlib init state;
638 undefined if Content-Encoding header. */
639 z_stream z; /* State structure for zlib. */
651 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
652 and we're uploading the last chunk */
654 bool ignorebody; /* we read a response-body but we ignore it! */
655 bool ignorecl; /* This HTTP response has no body so we ignore the Content-
658 char *location; /* This points to an allocated version of the Location:
660 char *newurl; /* Set to the new URL to use when a redirect or a retry is
663 /* 'upload_present' is used to keep a byte counter of how much data there is
664 still left in the buffer, aimed for upload. */
665 ssize_t upload_present;
667 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
668 buffer, so the next read should read from where this pointer points to,
669 and the 'upload_present' contains the number of bytes available at this
671 char *upload_fromhere;
673 bool chunk; /* if set, this is a chunked transfer-encoding */
674 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
676 bool getheader; /* TRUE if header parsing is wanted */
678 bool forbidchunk; /* used only to explicitly forbid chunk-upload for
679 specific upload buffers. See readmoredata() in
680 http.c for details. */
684 * Specific protocol handler.
687 struct Curl_handler {
688 const char * scheme; /* URL scheme name. */
690 /* Complement to setup_connection_internals(). */
691 CURLcode (*setup_connection)(struct connectdata *);
693 /* These two functions MUST be set to be protocol dependent */
694 CURLcode (*do_it)(struct connectdata *, bool *done);
697 /* If the curl_do() function is better made in two halves, this
698 * curl_do_more() function will be called afterwards, if set. For example
699 * for doing the FTP stuff after the PASV/PORT command.
701 Curl_do_more_func do_more;
703 /* This function *MAY* be set to a protocol-dependent function that is run
704 * after the connect() and everything is done, as a step in the connection.
705 * The 'done' pointer points to a bool that should be set to TRUE if the
706 * function completes before return. If it doesn't complete, the caller
707 * should call the curl_connecting() function until it is.
709 CURLcode (*connect_it)(struct connectdata *, bool *done);
711 /* See above. Currently only used for FTP. */
712 CURLcode (*connecting)(struct connectdata *, bool *done);
713 CURLcode (*doing)(struct connectdata *, bool *done);
715 /* Called from the multi interface during the PROTOCONNECT phase, and it
716 should then return a proper fd set */
717 int (*proto_getsock)(struct connectdata *conn,
718 curl_socket_t *socks,
721 /* Called from the multi interface during the DOING phase, and it should
722 then return a proper fd set */
723 int (*doing_getsock)(struct connectdata *conn,
724 curl_socket_t *socks,
727 /* Called from the multi interface during the DO_MORE phase, and it should
728 then return a proper fd set */
729 int (*domore_getsock)(struct connectdata *conn,
730 curl_socket_t *socks,
733 /* Called from the multi interface during the DO_DONE, PERFORM and
734 WAITPERFORM phases, and it should then return a proper fd set. Not setting
735 this will make libcurl use the generic default one. */
736 int (*perform_getsock)(const struct connectdata *conn,
737 curl_socket_t *socks,
740 /* This function *MAY* be set to a protocol-dependent function that is run
741 * by the curl_disconnect(), as a step in the disconnection. If the handler
742 * is called because the connection has been considered dead, dead_connection
745 CURLcode (*disconnect)(struct connectdata *, bool dead_connection);
747 /* If used, this function gets called from transfer.c:readwrite_data() to
748 allow the protocol to do extra reads/writes */
749 CURLcode (*readwrite)(struct SessionHandle *data, struct connectdata *conn,
750 ssize_t *nread, bool *readmore);
752 long defport; /* Default port. */
753 unsigned int protocol; /* See CURLPROTO_* */
754 unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */
757 #define PROTOPT_NONE 0 /* nothing extra */
758 #define PROTOPT_SSL (1<<0) /* uses SSL */
759 #define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */
760 #define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */
761 /* some protocols will have to call the underlying functions without regard to
762 what exact state the socket signals. IE even if the socket says "readable",
763 the send function might need to be called while uploading, or vice versa.
765 #define PROTOPT_DIRLOCK (1<<3)
766 #define PROTOPT_NONETWORK (1<<4) /* protocol doesn't use the network! */
767 #define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it
769 #define PROTOPT_NOURLQUERY (1<<6) /* protocol can't handle
770 url query strings (?foo=bar) ! */
773 /* return the count of bytes sent, or -1 on error */
774 typedef ssize_t (Curl_send)(struct connectdata *conn, /* connection data */
775 int sockindex, /* socketindex */
776 const void *buf, /* data to write */
777 size_t len, /* max amount to write */
778 CURLcode *err); /* error to return */
780 /* return the count of bytes read, or -1 on error */
781 typedef ssize_t (Curl_recv)(struct connectdata *conn, /* connection data */
782 int sockindex, /* socketindex */
783 char *buf, /* store data here */
784 size_t len, /* max amount to read */
785 CURLcode *err); /* error to return */
788 * The connectdata struct contains all fields and variables that should be
789 * unique for an entire connection.
792 /* 'data' is the CURRENT SessionHandle using this connection -- take great
793 caution that this might very well vary between different times this
794 connection is used! */
795 struct SessionHandle *data;
797 /* chunk is for HTTP chunked encoding, but is in the general connectdata
798 struct only because we can do just about any protocol through a HTTP proxy
799 and a HTTP proxy may in fact respond using chunked encoding */
800 struct Curl_chunker chunk;
802 curl_closesocket_callback fclosesocket; /* function closing the socket(s) */
803 void *closesocket_client;
805 bool inuse; /* This is a marker for the connection cache logic. If this is
806 TRUE this handle is being used by an easy handle and cannot
807 be used by any other easy handle without careful
808 consideration (== only for pipelining). */
810 /**** Fields set when inited and not modified again */
811 long connection_id; /* Contains a unique number to make it easier to
812 track the connections in the log output */
814 /* 'dns_entry' is the particular host we use. This points to an entry in the
815 DNS cache and it will not get pruned while locked. It gets unlocked in
816 Curl_done(). This entry will be NULL if the connection is re-used as then
817 there is no name resolve done. */
818 struct Curl_dns_entry *dns_entry;
820 /* 'ip_addr' is the particular IP we connected to. It points to a struct
821 within the DNS cache, so this pointer is only valid as long as the DNS
822 cache entry remains locked. It gets unlocked in Curl_done() */
823 Curl_addrinfo *ip_addr;
825 /* 'ip_addr_str' is the ip_addr data as a human readable string.
826 It remains available as long as the connection does, which is longer than
827 the ip_addr itself. */
828 char ip_addr_str[MAX_IPADR_LEN];
830 unsigned int scope; /* address scope for IPv6 */
832 int socktype; /* SOCK_STREAM or SOCK_DGRAM */
834 struct hostname host;
835 struct hostname proxy;
837 long port; /* which port to use locally */
838 unsigned short remote_port; /* what remote port to connect to,
839 not the proxy port! */
841 /* 'primary_ip' and 'primary_port' get filled with peer's numerical
842 ip address and port number whenever an outgoing connection is
843 *attempted* from the primary socket to a remote address. When more
844 than one address is tried for a connection these will hold data
845 for the last attempt. When the connection is actually established
846 these are updated with data which comes directly from the socket. */
848 char primary_ip[MAX_IPADR_LEN];
851 /* 'local_ip' and 'local_port' get filled with local's numerical
852 ip address and port number whenever an outgoing connection is
853 **established** from the primary socket to a remote address. */
855 char local_ip[MAX_IPADR_LEN];
858 char *user; /* user name string, allocated */
859 char *passwd; /* password string, allocated */
861 char *proxyuser; /* proxy user name string, allocated */
862 char *proxypasswd; /* proxy password string, allocated */
863 curl_proxytype proxytype; /* what kind of proxy that is in use */
865 int httpversion; /* the HTTP version*10 reported by the server */
866 int rtspversion; /* the RTSP version*10 reported by the server */
868 struct timeval now; /* "current" time */
869 struct timeval created; /* creation time */
870 curl_socket_t sock[2]; /* two sockets, the second is used for the data
871 transfer when doing FTP */
872 bool sock_accepted[2]; /* TRUE if the socket on this index was created with
877 struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */
878 struct ssl_config_data ssl_config;
880 struct ConnectBits bits; /* various state-flags for this connection */
882 /* connecttime: when connect() is called on the current IP address. Used to
883 be able to track when to move on to try next IP - but only when the multi
884 interface is used. */
885 struct timeval connecttime;
886 /* The two fields below get set in Curl_connecthost */
887 int num_addr; /* number of addresses to try to connect to */
888 long timeoutms_per_addr; /* how long time in milliseconds to spend on
889 trying to connect to each IP address */
891 const struct Curl_handler *handler; /* Connection's protocol handler */
892 const struct Curl_handler *given; /* The protocol first given */
894 long ip_version; /* copied from the SessionHandle at creation time */
896 /**** curl_get() phase fields */
898 curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */
899 curl_socket_t writesockfd; /* socket to write to, it may very
900 well be the same we read from.
901 CURL_SOCKET_BAD disables */
903 /** Dynamicly allocated strings, MUST be freed before this **/
904 /** struct is killed. **/
905 struct dynamically_allocated_data {
908 char *accept_encoding;
914 char *rtsp_transport;
915 char *te; /* TE: request header */
918 int sec_complete; /* if kerberos is enabled for this connection */
919 #if defined(HAVE_KRB4) || defined(HAVE_GSSAPI)
920 enum protection_level command_prot;
921 enum protection_level data_prot;
922 enum protection_level request_data_prot;
924 struct krb4buffer in_buffer;
926 const struct Curl_sec_client_mech *mech;
927 struct sockaddr_in local_addr;
930 /* the two following *_inuse fields are only flags, not counters in any way.
931 If TRUE it means the channel is in use, and if FALSE it means the channel
932 is up for grabs by one. */
934 bool readchannel_inuse; /* whether the read channel is in use by an easy
936 bool writechannel_inuse; /* whether the write channel is in use by an easy
938 bool server_supports_pipelining; /* TRUE if server supports pipelining,
939 set after first response */
940 struct curl_llist *send_pipe; /* List of handles waiting to
941 send on this pipeline */
942 struct curl_llist *recv_pipe; /* List of handles waiting to read
943 their responses on this pipeline */
944 struct curl_llist *pend_pipe; /* List of pending handles on
946 struct curl_llist *done_pipe; /* Handles that are finished, but
947 still reference this connectdata */
948 #define MAX_PIPELINE_LENGTH 5
949 char* master_buffer; /* The master buffer allocated on-demand;
950 used for pipelining. */
951 size_t read_pos; /* Current read position in the master buffer */
952 size_t buf_len; /* Length of the buffer?? */
955 curl_seek_callback seek_func; /* function that seeks the input */
956 void *seek_client; /* pointer to pass to the seek() above */
958 /*************** Request - specific items ************/
960 /* previously this was in the urldata struct */
961 curl_read_callback fread_func; /* function that reads the input */
962 void *fread_in; /* pointer to pass to the fread() above */
964 struct ntlmdata ntlm; /* NTLM differs from other authentication schemes
965 because it authenticates connections, not
967 struct ntlmdata proxyntlm; /* NTLM data for proxy */
969 #if defined(USE_NTLM) && defined(NTLM_WB_ENABLED)
970 /* used for communication with Samba's winbind daemon helper ntlm_auth */
971 curl_socket_t ntlm_auth_hlpr_socket;
972 pid_t ntlm_auth_hlpr_pid;
973 char* challenge_header;
974 char* response_header;
977 char syserr_buf [256]; /* buffer for Curl_strerror() */
979 #ifdef CURLRES_ASYNCH
980 /* data used for the asynch name resolve callback */
981 struct Curl_async async;
984 /* These three are used for chunked-encoding trailer support */
985 char *trailer; /* allocated buffer to store trailer in */
986 int trlMax; /* allocated buffer size */
987 int trlPos; /* index of where to store data */
990 struct ftp_conn ftpc;
991 struct ssh_conn sshc;
992 struct tftp_state_data *tftpc;
993 struct imap_conn imapc;
994 struct pop3_conn pop3c;
995 struct smtp_conn smtpc;
996 struct rtsp_conn rtspc;
1000 int cselect_bits; /* bitmask of socket events */
1001 int waitfor; /* current READ/WRITE bits to wait for */
1003 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1004 int socks5_gssapi_enctype;
1010 /* When this connection is created, store the conditions for the local end
1011 bind. This is stored before the actual bind and before any connection is
1012 made and will serve the purpose of being used for comparison reasons so
1013 that subsequent bound-requested connections aren't accidentally re-using
1014 wrong connections. */
1016 unsigned short localport;
1019 /* tunnel as in tunnel through a HTTP proxy with CONNECT */
1021 TUNNEL_INIT, /* init/default/no tunnel state */
1022 TUNNEL_CONNECT, /* CONNECT has been sent off */
1023 TUNNEL_COMPLETE /* CONNECT response received completely */
1024 } tunnel_state[2]; /* two separate ones to allow FTP */
1026 struct connectbundle *bundle; /* The bundle we are member of */
1029 /* The end of connectdata. */
1032 * Struct to keep statistical and informational data.
1035 int httpcode; /* Recent HTTP, FTP, or RTSP response code */
1036 int httpproxycode; /* response code from proxy when received separate */
1037 int httpversion; /* the http version number X.Y = X*10+Y */
1038 long filetime; /* If requested, this is might get set. Set to -1 if the time
1039 was unretrievable. We cannot have this of type time_t,
1040 since time_t is unsigned on several platforms such as
1042 bool timecond; /* set to TRUE if the time condition didn't match, which
1043 thus made the document NOT get fetched */
1044 long header_size; /* size of read header(s) in bytes */
1045 long request_size; /* the amount of bytes sent in the request(s) */
1046 unsigned long proxyauthavail; /* what proxy auth types were announced */
1047 unsigned long httpauthavail; /* what host auth types were announced */
1048 long numconnects; /* how many new connection did libcurl created */
1049 char *contenttype; /* the content type of the object */
1050 char *wouldredirect; /* URL this would've been redirected to if asked to */
1052 /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip'
1053 and, 'conn_local_port' are copied over from the connectdata struct in
1054 order to allow curl_easy_getinfo() to return this information even when
1055 the session handle is no longer associated with a connection, and also
1056 allow curl_easy_reset() to clear this information from the session handle
1057 without disturbing information which is still alive, and that might be
1058 reused, in the connection cache. */
1060 char conn_primary_ip[MAX_IPADR_LEN];
1061 long conn_primary_port;
1063 char conn_local_ip[MAX_IPADR_LEN];
1064 long conn_local_port;
1066 struct curl_certinfo certs; /* info about the certs, only populated in
1067 OpenSSL builds. Asked for with
1068 CURLOPT_CERTINFO / CURLINFO_CERTINFO */
1073 long lastshow; /* time() of the last displayed progress meter or NULL to
1074 force redraw at next call */
1075 curl_off_t size_dl; /* total expected size */
1076 curl_off_t size_ul; /* total expected size */
1077 curl_off_t downloaded; /* transferred so far */
1078 curl_off_t uploaded; /* transferred so far */
1080 curl_off_t current_speed; /* uses the currently fastest transfer */
1082 bool callback; /* set when progress callback is used */
1083 int width; /* screen width at download start */
1084 int flags; /* see progress.h */
1093 double t_appconnect;
1094 double t_pretransfer;
1095 double t_starttransfer;
1098 struct timeval start;
1099 struct timeval t_startsingle;
1100 struct timeval t_acceptdata;
1101 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
1103 curl_off_t speeder[ CURR_TIME ];
1104 struct timeval speeder_time[ CURR_TIME ];
1109 HTTPREQ_NONE, /* first in list */
1112 HTTPREQ_POST_FORM, /* we make a difference internally */
1116 HTTPREQ_LAST /* last in list */
1120 RTSPREQ_NONE, /* first in list */
1128 RTSPREQ_GET_PARAMETER,
1129 RTSPREQ_SET_PARAMETER,
1132 RTSPREQ_LAST /* last in list */
1136 * Values that are generated, temporary or calculated internally for a
1137 * "session handle" must be defined within the 'struct UrlState'. This struct
1138 * will be used within the SessionHandle struct. When the 'SessionHandle'
1139 * struct is cloned, this data MUST NOT be copied.
1141 * Remember that any "state" information goes globally for the curl handle.
1142 * Session-data MUST be put in the connectdata struct and here. */
1143 #define MAX_CURL_USER_LENGTH 256
1144 #define MAX_CURL_PASSWORD_LENGTH 256
1145 #define MAX_CURL_USER_LENGTH_TXT "255"
1146 #define MAX_CURL_PASSWORD_LENGTH_TXT "255"
1149 unsigned long want; /* Bitmask set to the authentication methods wanted by
1150 app (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */
1151 unsigned long picked;
1152 unsigned long avail; /* Bitmask for what the server reports to support for
1154 bool done; /* TRUE when the auth phase is done and ready to do the *actual*
1156 bool multi; /* TRUE if this is not yet authenticated but within the auth
1157 multipass negotiation */
1158 bool iestyle; /* TRUE if digest should be done IE-style or FALSE if it should
1164 /* Points to the connection cache */
1165 struct conncache *conn_cache;
1167 /* when curl_easy_perform() is called, the multi handle is "owned" by
1168 the easy handle so curl_easy_cleanup() on such an easy handle will
1169 also close the multi handle! */
1170 bool multi_owned_by_easy;
1172 /* buffers to store authentication data in, as parsed from input options */
1173 struct timeval keeps_speed; /* for the progress meter really */
1175 struct connectdata *pending_conn; /* This points to the connection we want
1176 to open when we are waiting in the
1177 CONNECT_PEND state in the multi
1178 interface. This to avoid recreating it
1179 when we enter the CONNECT state again.
1182 struct connectdata *lastconnect; /* The last connection, NULL if undefined */
1184 char *headerbuff; /* allocated buffer to store headers in */
1185 size_t headersize; /* size of the allocation */
1187 char buffer[BUFSIZE+1]; /* download buffer */
1188 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
1189 curl_off_t current_speed; /* the ProgressShow() funcion sets this,
1191 bool this_is_a_follow; /* this is a followed Location: request */
1193 char *first_host; /* if set, this should be the host name that we will
1194 sent authorization to, no else. Used to make Location:
1195 following not keep sending user+password... This is
1198 struct curl_ssl_session *session; /* array of 'max_ssl_sessions' size */
1199 long sessionage; /* number of the most recent session */
1200 char *tempwrite; /* allocated buffer to keep data in when a write
1201 callback returns to make the connection paused */
1202 size_t tempwritesize; /* size of the 'tempwrite' allocated buffer */
1203 int tempwritetype; /* type of the 'tempwrite' buffer as a bitmask that is
1204 used with Curl_client_write() */
1205 char *scratch; /* huge buffer[BUFSIZE*2] when doing upload CRLF replacing */
1206 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
1207 This must be set to FALSE every time _easy_perform() is
1209 int os_errno; /* filled in with errno whenever an error occurs */
1211 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
1212 void (*prev_signal)(int sig);
1214 bool allow_port; /* Is set.use_port allowed to take effect or not. This
1215 is always set TRUE when curl_easy_perform() is called. */
1216 struct digestdata digest; /* state data for host Digest auth */
1217 struct digestdata proxydigest; /* state data for proxy Digest auth */
1219 #ifdef USE_HTTP_NEGOTIATE
1220 struct negotiatedata negotiate; /* state data for host Negotiate auth */
1221 struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */
1224 struct auth authhost; /* auth details for host */
1225 struct auth authproxy; /* auth details for proxy */
1227 bool authproblem; /* TRUE if there's some problem authenticating */
1229 void *resolver; /* resolver state, if it is used in the URL state -
1230 ares_channel f.e. */
1232 #if defined(USE_SSLEAY) && defined(HAVE_OPENSSL_ENGINE_H)
1234 #endif /* USE_SSLEAY */
1235 struct timeval expiretime; /* set this with Curl_expire() only */
1236 struct Curl_tree timenode; /* for the splay stuff */
1237 struct curl_llist *timeoutlist; /* list of pending timeouts */
1239 /* a place to store the most recently set FTP entrypath */
1240 char *most_recent_ftp_entrypath;
1242 /* set after initial USER failure, to prevent an authentication loop */
1243 bool ftp_trying_alternative;
1245 int httpversion; /* the lowest HTTP version*10 reported by any server
1246 involved in this request */
1247 bool expect100header; /* TRUE if we added Expect: 100-continue */
1249 bool pipe_broke; /* TRUE if the connection we were pipelined on broke
1250 and we need to restart from the beginning */
1252 #if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) && \
1253 !defined(__SYMBIAN32__)
1254 /* do FTP line-end conversions on most platforms */
1255 #define CURL_DO_LINEEND_CONV
1256 /* for FTP downloads: track CRLF sequences that span blocks */
1257 bool prev_block_had_trailing_cr;
1258 /* for FTP downloads: how many CRLFs did we converted to LFs? */
1259 curl_off_t crlf_conversions;
1261 char *pathbuffer;/* allocated buffer to store the URL's path part in */
1262 char *path; /* path to use, points to somewhere within the pathbuffer
1264 bool slash_removed; /* set TRUE if the 'path' points to a path where the
1265 initial URL slash separator has been taken off */
1267 bool rangestringalloc; /* the range string is malloc()'ed */
1269 char *range; /* range, if used. See README for detailed specification on
1271 curl_off_t resume_from; /* continue [ftp] transfer from here */
1273 /* This RTSP state information survives requests and connections */
1274 long rtsp_next_client_CSeq; /* the session's next client CSeq */
1275 long rtsp_next_server_CSeq; /* the session's next server CSeq */
1276 long rtsp_CSeq_recv; /* most recent CSeq received */
1278 /* Protocol specific data.
1280 *************************************************************************
1281 * Note that this data will be REMOVED after each request, so anything that
1282 * should be kept/stored on a per-connection basis and thus live for the
1283 * next request on the same connection MUST be put in the connectdata struct!
1284 *************************************************************************/
1287 struct HTTP *https; /* alias, just for the sake of being more readable */
1290 /* void *tftp; not used */
1291 struct FILEPROTO *file;
1292 void *telnet; /* private for telnet.c-eyes only */
1294 struct SSHPROTO *ssh;
1299 /* current user of this SessionHandle instance, or NULL */
1300 struct connectdata *current_conn;
1302 /* if true, force SSL connection retry (workaround for certain servers) */
1303 bool ssl_connect_retry;
1308 * This 'DynamicStatic' struct defines dynamic states that actually change
1309 * values in the 'UserDefined' area, which MUST be taken into consideration
1310 * if the UserDefined struct is cloned or similar. You can probably just
1311 * copy these, but each one indicate a special action on other data.
1314 struct DynamicStatic {
1315 char *url; /* work URL, copied from UserDefined */
1316 bool url_alloc; /* URL string is malloc()'ed */
1317 char *referer; /* referer string */
1318 bool referer_alloc; /* referer sting is malloc()ed */
1319 struct curl_slist *cookielist; /* list of cookie files set by
1320 curl_easy_setopt(COOKIEFILE) calls */
1321 struct curl_slist *resolve; /* set to point to the set.resolve list when
1322 this should be dealt with in pretransfer */
1326 * This 'UserDefined' struct must only contain data that is set once to go
1327 * for many (perhaps) independent connections. Values that are generated or
1328 * calculated internally for the "session handle" MUST be defined within the
1329 * 'struct UrlState' instead. The only exceptions MUST note the changes in
1330 * the 'DynamicStatic' struct.
1331 * Character pointer fields point to dynamic storage, unless otherwise stated.
1333 struct Curl_one_easy; /* declared and used only in multi.c */
1334 struct Curl_multi; /* declared and used only in multi.c */
1337 STRING_CERT, /* client certificate file name */
1338 STRING_CERT_TYPE, /* format for certificate (default: PEM)*/
1339 STRING_COOKIE, /* HTTP cookie string to send */
1340 STRING_COOKIEJAR, /* dump all cookies to this file */
1341 STRING_CUSTOMREQUEST, /* HTTP/FTP/RTSP request/method to use */
1342 STRING_DEVICE, /* local network interface/address to use */
1343 STRING_ENCODING, /* Accept-Encoding string */
1344 STRING_FTP_ACCOUNT, /* ftp account data */
1345 STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */
1346 STRING_FTPPORT, /* port to send with the FTP PORT command */
1347 STRING_KEY, /* private key file name */
1348 STRING_KEY_PASSWD, /* plain text private key password */
1349 STRING_KEY_TYPE, /* format for private key (default: PEM) */
1350 STRING_KRB_LEVEL, /* krb security level */
1351 STRING_NETRC_FILE, /* if not NULL, use this instead of trying to find
1353 STRING_COPYPOSTFIELDS, /* if POST, set the fields' values here */
1354 STRING_PROXY, /* proxy to use */
1355 STRING_SET_RANGE, /* range, if used */
1356 STRING_SET_REFERER, /* custom string for the HTTP referer field */
1357 STRING_SET_URL, /* what original URL to work on */
1358 STRING_SSL_CAPATH, /* CA directory name (doesn't work on windows) */
1359 STRING_SSL_CAFILE, /* certificate file to verify peer against */
1360 STRING_SSL_CIPHER_LIST, /* list of ciphers to use */
1361 STRING_SSL_EGDSOCKET, /* path to file containing the EGD daemon socket */
1362 STRING_SSL_RANDOM_FILE, /* path to file containing "random" data */
1363 STRING_USERAGENT, /* User-Agent string */
1364 STRING_SSL_CRLFILE, /* crl file to check certificate */
1365 STRING_SSL_ISSUERCERT, /* issuer cert file to check certificate */
1366 STRING_USERNAME, /* <username>, if used */
1367 STRING_PASSWORD, /* <password>, if used */
1368 STRING_PROXYUSERNAME, /* Proxy <username>, if used */
1369 STRING_PROXYPASSWORD, /* Proxy <password>, if used */
1370 STRING_NOPROXY, /* List of hosts which should not use the proxy, if
1372 STRING_RTSP_SESSION_ID, /* Session ID to use */
1373 STRING_RTSP_STREAM_URI, /* Stream URI for this request */
1374 STRING_RTSP_TRANSPORT, /* Transport for this session */
1376 STRING_SSH_PRIVATE_KEY, /* path to the private key file for auth */
1377 STRING_SSH_PUBLIC_KEY, /* path to the public key file for auth */
1378 STRING_SSH_HOST_PUBLIC_KEY_MD5, /* md5 of host public key in ascii hex */
1379 STRING_SSH_KNOWNHOSTS, /* file name of knownhosts file */
1381 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1382 STRING_SOCKS5_GSSAPI_SERVICE, /* GSSAPI service name */
1388 STRING_TLSAUTH_USERNAME, /* TLS auth <username> */
1389 STRING_TLSAUTH_PASSWORD, /* TLS auth <password> */
1392 /* -- end of strings -- */
1393 STRING_LAST /* not used, just an end-of-list marker */
1396 struct UserDefined {
1397 FILE *err; /* the stderr user data goes here */
1398 void *debugdata; /* the data that will be passed to fdebug */
1399 char *errorbuffer; /* (Static) store failure messages in here */
1400 long proxyport; /* If non-zero, use this port number by default. If the
1401 proxy string features a ":[port]" that one will override
1403 void *out; /* the fetched file goes here */
1404 void *in; /* the uploaded file is read from here */
1405 void *writeheader; /* write the header to this if non-NULL */
1406 void *rtp_out; /* write RTP to this if non-NULL */
1407 long use_port; /* which port to use (when not using default) */
1408 unsigned long httpauth; /* kind of HTTP authentication to use (bitmask) */
1409 unsigned long proxyauth; /* kind of proxy authentication to use (bitmask) */
1410 long followlocation; /* as in HTTP Location: */
1411 long maxredirs; /* maximum no. of http(s) redirects to follow, set to -1
1414 int keep_post; /* keep POSTs as POSTs after a 30x request; each
1415 bit represents a request, from 301 to 303 */
1416 bool free_referer; /* set TRUE if 'referer' points to a string we
1418 void *postfields; /* if POST, set the fields' values here */
1419 curl_seek_callback seek_func; /* function that seeks the input */
1420 curl_off_t postfieldsize; /* if POST, this might have a size to use instead
1421 of strlen(), and then the data *may* be binary
1422 (contain zero bytes) */
1423 unsigned short localport; /* local port number to bind to */
1424 int localportrange; /* number of additional port numbers to test in case the
1425 'localport' one can't be bind()ed */
1426 curl_write_callback fwrite_func; /* function that stores the output */
1427 curl_write_callback fwrite_header; /* function that stores headers */
1428 curl_write_callback fwrite_rtp; /* function that stores interleaved RTP */
1429 curl_read_callback fread_func; /* function that reads the input */
1430 int is_fread_set; /* boolean, has read callback been set to non-NULL? */
1431 int is_fwrite_set; /* boolean, has write callback been set to non-NULL? */
1432 curl_progress_callback fprogress; /* function for progress information */
1433 curl_debug_callback fdebug; /* function that write informational data */
1434 curl_ioctl_callback ioctl_func; /* function for I/O control */
1435 curl_sockopt_callback fsockopt; /* function for setting socket options */
1436 void *sockopt_client; /* pointer to pass to the socket options callback */
1437 curl_opensocket_callback fopensocket; /* function for checking/translating
1438 the address and opening the
1440 void* opensocket_client;
1441 curl_closesocket_callback fclosesocket; /* function for closing the
1443 void* closesocket_client;
1445 void *seek_client; /* pointer to pass to the seek callback */
1446 /* the 3 curl_conv_callback functions below are used on non-ASCII hosts */
1447 /* function to convert from the network encoding: */
1448 curl_conv_callback convfromnetwork;
1449 /* function to convert to the network encoding: */
1450 curl_conv_callback convtonetwork;
1451 /* function to convert from UTF-8 encoding: */
1452 curl_conv_callback convfromutf8;
1454 void *progress_client; /* pointer to pass to the progress callback */
1455 void *ioctl_client; /* pointer to pass to the ioctl callback */
1456 long timeout; /* in milliseconds, 0 means no timeout */
1457 long connecttimeout; /* in milliseconds, 0 means no timeout */
1458 long accepttimeout; /* in milliseconds, 0 means no timeout */
1459 long server_response_timeout; /* in milliseconds, 0 means no timeout */
1460 long tftp_blksize ; /* in bytes, 0 means use default */
1461 curl_off_t infilesize; /* size of file to upload, -1 means unknown */
1462 long low_speed_limit; /* bytes/second */
1463 long low_speed_time; /* number of seconds */
1464 curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */
1465 curl_off_t max_recv_speed; /* high speed limit in bytes/second for
1467 curl_off_t set_resume_from; /* continue [ftp] transfer from here */
1468 struct curl_slist *headers; /* linked list of extra headers */
1469 struct curl_httppost *httppost; /* linked list of POST data */
1470 bool cookiesession; /* new cookie session? */
1471 bool crlf; /* convert crlf on ftp upload(?) */
1472 struct curl_slist *quote; /* after connection is established */
1473 struct curl_slist *postquote; /* after the transfer */
1474 struct curl_slist *prequote; /* before the transfer, after type */
1475 struct curl_slist *source_quote; /* 3rd party quote */
1476 struct curl_slist *source_prequote; /* in 3rd party transfer mode - before
1477 the transfer on source host */
1478 struct curl_slist *source_postquote; /* in 3rd party transfer mode - after
1479 the transfer on source host */
1480 struct curl_slist *telnet_options; /* linked list of telnet options */
1481 struct curl_slist *resolve; /* list of names to add/remove from
1483 curl_TimeCond timecondition; /* kind of time/date comparison */
1484 time_t timevalue; /* what time to compare with */
1485 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
1486 long httpversion; /* when non-zero, a specific HTTP version requested to
1487 be used in the library's request(s) */
1488 struct ssl_config_data ssl; /* user defined SSL stuff */
1489 curl_proxytype proxytype; /* what kind of proxy that is in use */
1490 long dns_cache_timeout; /* DNS cache timeout */
1491 long buffer_size; /* size of receive buffer to use */
1492 void *private_data; /* application-private data */
1494 struct Curl_one_easy *one_easy; /* When adding an easy handle to a multi
1495 handle, an internal 'Curl_one_easy'
1496 struct is created and this is a pointer
1497 to the particular struct associated with
1498 this SessionHandle */
1500 struct curl_slist *http200aliases; /* linked list of aliases for http200 */
1502 long ipver; /* the CURL_IPRESOLVE_* defines in the public header file
1503 0 - whatever, 1 - v2, 2 - v6 */
1505 curl_off_t max_filesize; /* Maximum file size to download */
1507 curl_ftpfile ftp_filemethod; /* how to get to a file when FTP is used */
1509 int ftp_create_missing_dirs; /* 1 - create directories that don't exist
1510 2 - the same but also allow MKD to fail once
1513 curl_sshkeycallback ssh_keyfunc; /* key matching callback */
1514 void *ssh_keyfunc_userp; /* custom pointer to callback */
1516 /* Here follows boolean settings that define how to behave during
1517 this session. They are STATIC, set by libcurl users or at least initially
1518 and they don't change during operations. */
1520 bool printhost; /* printing host name in debug info */
1521 bool get_filetime; /* get the time and get of the remote file */
1522 bool tunnel_thru_httpproxy; /* use CONNECT through a HTTP proxy */
1523 bool prefer_ascii; /* ASCII rather than binary */
1524 bool ftp_append; /* append, not overwrite, on upload */
1525 bool ftp_list_only; /* switch FTP command for listing directories */
1526 bool ftp_use_port; /* use the FTP PORT command */
1527 bool hide_progress; /* don't use the progress meter */
1528 bool http_fail_on_error; /* fail on HTTP error codes >= 300 */
1529 bool http_follow_location; /* follow HTTP redirects */
1530 bool http_transfer_encoding; /* request compressed HTTP transfer-encoding */
1531 bool http_disable_hostname_check_before_authentication;
1532 bool include_header; /* include received protocol headers in data output */
1533 bool http_set_referer; /* is a custom referer used */
1534 bool http_auto_referer; /* set "correct" referer when following location: */
1535 bool opt_no_body; /* as set with CURLOPT_NO_BODY */
1536 bool set_port; /* custom port number used */
1537 bool upload; /* upload request */
1538 enum CURL_NETRC_OPTION
1539 use_netrc; /* defined in include/curl.h */
1540 bool verbose; /* output verbosity */
1541 bool krb; /* kerberos connection requested */
1542 bool reuse_forbid; /* forbidden to be reused, close after use */
1543 bool reuse_fresh; /* do not re-use an existing connection */
1544 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
1545 bool ftp_use_eprt; /* if EPRT is to be attempted or not */
1546 bool ftp_use_pret; /* if PRET is to be used before PASV or not */
1548 curl_usessl use_ssl; /* if AUTH TLS is to be attempted etc, for FTP or
1549 IMAP or POP3 or others! */
1550 curl_ftpauth ftpsslauth; /* what AUTH XXX to be attempted */
1551 curl_ftpccc ftp_ccc; /* FTP CCC options */
1552 bool no_signal; /* do not use any signal/alarm handler */
1553 bool global_dns_cache; /* subject for future removal */
1554 bool tcp_nodelay; /* whether to enable TCP_NODELAY or not */
1555 bool ignorecl; /* ignore content length */
1556 bool ftp_skip_ip; /* skip the IP address the FTP server passes on to
1558 bool connect_only; /* make connection, let application use the socket */
1559 bool ssl_enable_beast; /* especially allow this flaw for interoperability's
1561 long ssh_auth_types; /* allowed SSH auth types */
1562 bool http_te_skip; /* pass the raw body data to the user, even when
1563 transfer-encoded (chunked, compressed) */
1564 bool http_ce_skip; /* pass the raw body data to the user, even when
1565 content-encoded (chunked, compressed) */
1566 long new_file_perms; /* Permissions to use when creating remote files */
1567 long new_directory_perms; /* Permissions to use when creating remote dirs */
1568 bool proxy_transfer_mode; /* set transfer mode (;type=<a|i>) when doing FTP
1569 via an HTTP proxy */
1570 char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */
1571 unsigned int scope; /* address scope for IPv6 */
1572 long allowed_protocols;
1573 long redir_protocols;
1574 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1575 long socks5_gssapi_nec; /* flag to support nec socks5 server */
1577 struct curl_slist *mail_rcpt; /* linked list of mail recipients */
1578 /* Common RTSP header options */
1579 Curl_RtspReq rtspreq; /* RTSP request type */
1580 long rtspversion; /* like httpversion, for RTSP */
1581 bool wildcardmatch; /* enable wildcard matching */
1582 curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer
1584 curl_chunk_end_callback chunk_end; /* called after part transferring
1586 curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds
1587 to pattern (e.g. if WILDCARDMATCH is on) */
1590 long gssapi_delegation; /* GSSAPI credential delegation, see the
1591 documentation of CURLOPT_GSSAPI_DELEGATION */
1593 bool tcp_keepalive; /* use TCP keepalives */
1594 long tcp_keepidle; /* seconds in idle before sending keepalive probe */
1595 long tcp_keepintvl; /* seconds between TCP keepalive probes */
1597 size_t maxconnects; /* Max idle connections in the connection cache */
1601 struct curl_hash *hostcache;
1603 HCACHE_NONE, /* not pointing to anything */
1604 HCACHE_GLOBAL, /* points to the (shrug) global one */
1605 HCACHE_MULTI, /* points to a shared one in the multi handle */
1606 HCACHE_SHARED /* points to a shared one in a shared object */
1611 * The 'connectdata' struct MUST have all the connection oriented stuff as we
1612 * may have several simultaneous connections and connection structs in memory.
1614 * The 'struct UserDefined' must only contain data that is set once to go for
1615 * many (perhaps) independent connections. Values that are generated or
1616 * calculated internally for the "session handle" must be defined within the
1617 * 'struct UrlState' instead.
1620 struct SessionHandle {
1622 struct Curl_multi *multi; /* if non-NULL, points to the multi handle
1623 struct to which this "belongs" when used by
1624 the multi interface */
1625 struct Curl_multi *multi_easy; /* if non-NULL, points to the multi handle
1626 struct to which this "belongs" when used
1627 by the easy interface */
1628 struct Curl_one_easy *multi_pos; /* if non-NULL, points to its position
1629 in multi controlling structure to assist
1631 struct Curl_share *share; /* Share, handles global variable mutexing */
1632 struct SingleRequest req; /* Request-specific data */
1633 struct UserDefined set; /* values set by the libcurl user */
1634 struct DynamicStatic change; /* possibly modified userdefined data */
1635 struct CookieInfo *cookies; /* the cookies, read from files and servers.
1636 NOTE that the 'cookie' field in the
1637 UserDefined struct defines if the "engine"
1638 is to be used or not. */
1639 struct Progress progress; /* for all the progress meter data */
1640 struct UrlState state; /* struct for fields used for state info and
1641 other dynamic purposes */
1642 struct WildcardData wildcard; /* wildcard download state info */
1643 struct PureInfo info; /* stats, reports and info data */
1644 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
1645 iconv_t outbound_cd; /* for translating to the network encoding */
1646 iconv_t inbound_cd; /* for translating from the network encoding */
1647 iconv_t utf8_cd; /* for translating to UTF8 */
1648 #endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */
1649 unsigned int magic; /* set to a CURLEASY_MAGIC_NUMBER */
1652 #define LIBCURL_NAME "libcurl"
1654 #endif /* HEADER_CURL_URLDATA_H */
projects / platform / upstream / curl.git / blob