1 #ifndef HEADER_CURL_URLDATA_H
2 #define HEADER_CURL_URLDATA_H
3 /***************************************************************************
5 * Project ___| | | | _ \| |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 1998 - 2014, 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
46 #define PORT_SMTPS 465 /* sometimes called SSMTP */
48 #define PORT_RTMP 1935
49 #define PORT_RTMPT PORT_HTTP
50 #define PORT_RTMPS PORT_HTTPS
51 #define PORT_GOPHER 70
53 #define DICT_MATCH "/MATCH:"
54 #define DICT_MATCH2 "/M:"
55 #define DICT_MATCH3 "/FIND:"
56 #define DICT_DEFINE "/DEFINE:"
57 #define DICT_DEFINE2 "/D:"
58 #define DICT_DEFINE3 "/LOOKUP:"
60 #define CURL_DEFAULT_USER "anonymous"
61 #define CURL_DEFAULT_PASSWORD "ftp@example.com"
63 /* Convenience defines for checking protocols or their SSL based version. Each
64 protocol handler should only ever have a single CURLPROTO_ in its protocol
66 #define PROTO_FAMILY_HTTP (CURLPROTO_HTTP|CURLPROTO_HTTPS)
67 #define PROTO_FAMILY_FTP (CURLPROTO_FTP|CURLPROTO_FTPS)
68 #define PROTO_FAMILY_POP3 (CURLPROTO_POP3|CURLPROTO_POP3S)
69 #define PROTO_FAMILY_SMB (CURLPROTO_SMB|CURLPROTO_SMBS)
70 #define PROTO_FAMILY_SMTP (CURLPROTO_SMTP|CURLPROTO_SMTPS)
72 #define DEFAULT_CONNCACHE_SIZE 5
74 /* length of longest IPv6 address string including the trailing null */
75 #define MAX_IPADR_LEN sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255")
77 /* Default FTP/IMAP etc response timeout in milliseconds.
78 Symbian OS panics when given a timeout much greater than 1/2 hour.
80 #define RESP_TIMEOUT (1800*1000)
87 #include <openssl/rsa.h>
88 #include <openssl/crypto.h>
89 #include <openssl/x509.h>
90 #include <openssl/pem.h>
91 #include <openssl/ssl.h>
92 #include <openssl/err.h>
93 #ifdef HAVE_OPENSSL_ENGINE_H
94 #include <openssl/engine.h>
96 #ifdef HAVE_OPENSSL_PKCS12_H
97 #include <openssl/pkcs12.h>
99 #else /* SSLeay-style includes */
106 #ifdef HAVE_OPENSSL_ENGINE_H
109 #ifdef HAVE_OPENSSL_PKCS12_H
112 #endif /* USE_OPENSSL */
114 #error Configuration error; cannot use GnuTLS *and* OpenSSL.
116 #endif /* USE_SSLEAY */
119 #include <gnutls/gnutls.h>
123 #include <polarssl/ssl.h>
124 #include <polarssl/version.h>
125 #if POLARSSL_VERSION_NUMBER<0x01010000
126 #include <polarssl/havege.h>
128 #include <polarssl/entropy.h>
129 #include <polarssl/ctr_drbg.h>
130 #endif /* POLARSSL_VERSION_NUMBER<0x01010000 */
131 #endif /* USE_POLARSSL */
134 #undef OCSP_REQUEST /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */
135 #undef OCSP_RESPONSE /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */
136 #include <cyassl/openssl/ssl.h>
149 #include <axTLS/ssl.h>
153 #endif /* USE_AXTLS */
156 #include "curl_sspi.h"
158 #include <schannel.h>
162 #include <Security/Security.h>
163 /* For some reason, when building for iOS, the omnibus header above does
164 * not include SecureTransport.h as of iOS SDK 5.1. */
165 #include <Security/SecureTransport.h>
168 #ifdef HAVE_NETINET_IN_H
169 #include <netinet/in.h>
175 #include <zlib.h> /* for content-encoding */
177 /* zlib pollutes the namespace with this definition */
182 #include <curl/curl.h>
184 #include "http_chunks.h" /* for the structs and enum stuff */
198 #include "wildcard.h"
199 #include "multihandle.h"
204 # elif defined HAVE_GSSMIT
205 # include <gssapi/gssapi.h>
206 # include <gssapi/gssapi_generic.h>
212 #ifdef HAVE_LIBSSH2_H
214 #include <libssh2_sftp.h>
215 #endif /* HAVE_LIBSSH2_H */
217 /* Download buffer size, keep it fairly big for speed reasons */
219 #define BUFSIZE CURL_MAX_WRITE_SIZE
221 /* Initial size of the buffer to store headers in, it'll be enlarged in case
223 #define HEADERSIZE 256
225 #define CURLEASY_MAGIC_NUMBER 0xc0dedbadU
227 /* Some convenience macros to get the larger/smaller value out of two given.
228 We prefix with CURL to prevent name collisions. */
229 #define CURLMAX(x,y) ((x)>(y)?(x):(y))
230 #define CURLMIN(x,y) ((x)<(y)?(x):(y))
234 /* Types needed for krb5-ftp connections */
242 enum protection_level {
243 PROT_NONE, /* first in list */
249 PROT_LAST /* last in list */
254 /* Structs to store Schannel handles */
255 struct curl_schannel_cred {
256 CredHandle cred_handle;
257 TimeStamp time_stamp;
262 struct curl_schannel_ctxt {
263 CtxtHandle ctxt_handle;
264 TimeStamp time_stamp;
268 /* enum for the nonblocking SSL connection state machine */
272 ssl_connect_2_reading,
273 ssl_connect_2_writing,
280 ssl_connection_negotiating,
281 ssl_connection_complete
282 } ssl_connection_state;
284 /* struct for data related to each SSL connection */
285 struct ssl_connect_data {
286 /* Use ssl encrypted communications TRUE/FALSE, not necessarily using it atm
287 but at least asked to or meaning to use it. See 'state' for the exact
288 current state of the connection. */
290 ssl_connection_state state;
295 /* these ones requires specific SSL-types */
299 ssl_connect_state connecting_state;
300 #endif /* USE_SSLEAY */
302 gnutls_session_t session;
303 gnutls_certificate_credentials_t cred;
305 gnutls_srp_client_credentials_t srp_client_cred;
307 ssl_connect_state connecting_state;
308 #endif /* USE_GNUTLS */
310 ctr_drbg_context ctr_drbg;
311 entropy_context entropy;
319 ssl_connect_state connecting_state;
320 #endif /* USE_POLARSSL */
324 ssl_connect_state connecting_state;
325 #endif /* USE_CYASSL */
328 char *client_nickname;
329 struct SessionHandle *data;
330 struct curl_llist *obj_list;
331 PK11GenericObject *obj_clicert;
332 ssl_connect_state connecting_state;
337 ssl_connect_state connecting_state;
342 ssl_connect_state connecting_state;
343 #endif /* USE_AXTLS */
345 struct curl_schannel_cred *cred;
346 struct curl_schannel_ctxt *ctxt;
347 SecPkgContext_StreamSizes stream_sizes;
348 ssl_connect_state connecting_state;
349 size_t encdata_length, decdata_length;
350 size_t encdata_offset, decdata_offset;
351 unsigned char *encdata_buffer, *decdata_buffer;
352 unsigned long req_flags, ret_flags;
353 #endif /* USE_SCHANNEL */
355 SSLContextRef ssl_ctx;
356 curl_socket_t ssl_sockfd;
357 ssl_connect_state connecting_state;
358 bool ssl_direction; /* true if writing, false if reading */
359 size_t ssl_write_buffered_length;
360 #endif /* USE_DARWINSSL */
363 struct ssl_config_data {
364 long version; /* what version the client wants to use */
365 long certverifyresult; /* result from the certificate verification */
367 bool verifypeer; /* set TRUE if this is desired */
368 bool verifyhost; /* set TRUE if CN/SAN must match hostname */
369 char *CApath; /* certificate dir (doesn't work on windows) */
370 char *CAfile; /* certificate to verify peer against */
371 const char *CRLfile; /* CRL to check certificate revocation */
372 const char *issuercert;/* optional issuer certificate filename */
373 char *random_file; /* path to file containing "random" data */
374 char *egdsocket; /* path to file containing the EGD daemon socket */
375 char *cipher_list; /* list of ciphers to use */
376 size_t max_ssl_sessions; /* SSL session id cache size */
377 curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */
378 void *fsslctxp; /* parameter for call back */
379 bool sessionid; /* cache session IDs or not */
380 bool certinfo; /* gather lots of certificate info */
383 char *username; /* TLS username (for, e.g., SRP) */
384 char *password; /* TLS password (for, e.g., SRP) */
385 enum CURL_TLSAUTH authtype; /* TLS authentication type (default SRP) */
389 /* information stored about one single SSL session */
390 struct curl_ssl_session {
391 char *name; /* host name for which this ID was used */
392 void *sessionid; /* as returned from the SSL layer */
393 size_t idsize; /* if known, otherwise 0 */
394 long age; /* just a number, the higher the more recent */
395 int remote_port; /* remote port to connect to */
396 struct ssl_config_data ssl_config; /* setup for this session */
399 /* Struct used for Digest challenge-response authentication */
401 #if defined(USE_WINDOWS_SSPI)
403 size_t input_token_len;
409 bool stale; /* set true for re-negotiation */
413 int nc; /* nounce count */
425 #ifdef USE_WINDOWS_SSPI
426 #include "curl_sspi.h"
429 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
433 /* Struct used for GSSAPI (Kerberos V5) authentication */
434 #if defined(USE_KERBEROS5)
435 struct kerberos5data {
436 #if defined(USE_WINDOWS_SSPI)
437 CredHandle *credentials;
440 SEC_WINNT_AUTH_IDENTITY identity;
441 SEC_WINNT_AUTH_IDENTITY *p_identity;
445 gss_ctx_id_t context;
451 /* Struct used for NTLM challenge-response authentication */
452 #if defined(USE_NTLM)
455 #ifdef USE_WINDOWS_SSPI
456 CredHandle *credentials;
458 SEC_WINNT_AUTH_IDENTITY identity;
459 SEC_WINNT_AUTH_IDENTITY *p_identity;
463 size_t input_token_len;
466 unsigned char nonce[8];
467 void* target_info; /* TargetInfo received in the ntlm type-2 message */
468 unsigned int target_info_len;
474 struct negotiatedata {
475 /* When doing Negotiate (SPNEGO) auth, we first need to send a token
476 and then validate the received one. */
477 enum { GSS_AUTHNONE, GSS_AUTHRECV, GSS_AUTHSENT } state;
480 gss_ctx_id_t context;
481 gss_name_t server_name;
482 gss_buffer_desc output_token;
484 #ifdef USE_WINDOWS_SSPI
486 CredHandle *credentials;
488 SEC_WINNT_AUTH_IDENTITY identity;
489 SEC_WINNT_AUTH_IDENTITY *p_identity;
493 size_t output_token_length;
501 * Boolean values that concerns this connection.
504 /* always modify bits.close with the connclose() and connkeep() macros! */
505 bool close; /* if set, we close the connection after this request */
506 bool reuse; /* if set, this is a re-used connection */
507 bool proxy; /* if set, this transfer is done through a proxy - any type */
508 bool httpproxy; /* if set, this transfer is done through a http proxy */
509 bool user_passwd; /* do we use user+password for this connection? */
510 bool proxy_user_passwd; /* user+password for the proxy? */
511 bool ipv6_ip; /* we communicate with a remote site specified with pure IPv6
513 bool ipv6; /* we communicate with a site using an IPv6 address */
515 bool do_more; /* this is set TRUE if the ->curl_do_more() function is
516 supposed to be called, after ->curl_do() */
517 bool tcpconnect[2]; /* the TCP layer (or similar) is connected, this is set
518 the first time on the first connect function call */
519 bool protoconnstart;/* the protocol layer has STARTED its operation after
520 the TCP layer connect */
522 bool retry; /* this connection is about to get closed and then
523 re-attempted at another connection. */
524 bool tunnel_proxy; /* if CONNECT is used to "tunnel" through the proxy.
525 This is implicit when SSL-protocols are used through
526 proxies, but can also be enabled explicitly by
528 bool authneg; /* TRUE when the auth phase has started, which means
529 that we are creating a request with an auth header,
530 but it is not the final request in the auth
532 bool rewindaftersend;/* TRUE when the sending couldn't be stopped even
533 though it will be discarded. When the whole send
534 operation is done, we must call the data rewind
536 bool ftp_use_epsv; /* As set with CURLOPT_FTP_USE_EPSV, but if we find out
537 EPSV doesn't work we disable it for the forthcoming
540 bool ftp_use_eprt; /* As set with CURLOPT_FTP_USE_EPRT, but if we find out
541 EPRT doesn't work we disable it for the forthcoming
543 bool netrc; /* name+password provided by netrc */
544 bool userpwd_in_url; /* name+password found in url */
546 bool done; /* set to FALSE when Curl_do() is called and set to TRUE
547 when Curl_done() is called, to prevent Curl_done() to
548 get invoked twice when the multi interface is
550 bool stream_was_rewound; /* Indicates that the stream was rewound after a
551 request read past the end of its response byte
553 bool proxy_connect_closed; /* set true if a proxy disconnected the
554 connection in a CONNECT request with auth, so
555 that libcurl should reconnect and continue. */
556 bool bound; /* set true if bind() has already been done on this socket/
558 bool type_set; /* type= was used in the URL */
562 char *rawalloc; /* allocated "raw" version of the name */
563 char *encalloc; /* allocated IDN-encoded version of the name */
564 char *name; /* name to use internally, might be encoded, might be raw */
565 const char *dispname; /* name to display, as 'name' might be encoded */
569 * Flags on the keepon member of the Curl_transfer_keeper
573 #define KEEP_RECV (1<<0) /* there is or may be data to read */
574 #define KEEP_SEND (1<<1) /* there is or may be data to write */
575 #define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there
576 might still be data to read */
577 #define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there
578 might still be data to write */
579 #define KEEP_RECV_PAUSE (1<<4) /* reading is paused */
580 #define KEEP_SEND_PAUSE (1<<5) /* writing is paused */
582 #define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE)
583 #define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE)
588 ZLIB_UNINIT, /* uninitialized */
589 ZLIB_INIT, /* initialized */
590 ZLIB_GZIP_HEADER, /* reading gzip header */
591 ZLIB_GZIP_INFLATING, /* inflating gzip stream */
592 ZLIB_INIT_GZIP /* initialized in transparent gzip mode */
596 #ifdef CURLRES_ASYNCH
600 struct Curl_dns_entry *dns;
601 bool done; /* set TRUE when the lookup is complete */
602 int status; /* if done is TRUE, this is the status from the callback */
603 void *os_specific; /* 'struct thread_data' for Windows */
607 #define FIRSTSOCKET 0
608 #define SECONDARYSOCKET 1
610 /* These function pointer types are here only to allow easier typecasting
611 within the source when we need to cast between data pointers (such as NULL)
612 and function pointers. */
613 typedef CURLcode (*Curl_do_more_func)(struct connectdata *, int *);
614 typedef CURLcode (*Curl_done_func)(struct connectdata *, CURLcode, bool);
617 EXP100_SEND_DATA, /* enough waiting, just send the body now */
618 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */
619 EXP100_SENDING_REQUEST, /* still sending the request but will wait for
620 the 100 header once done with the request */
621 EXP100_FAILED /* used on 417 Expectation Failed */
625 UPGR101_INIT, /* default state */
626 UPGR101_REQUESTED, /* upgrade requested */
627 UPGR101_RECEIVED, /* response received */
628 UPGR101_WORKING /* talking upgraded protocol */
632 NPN_INIT, /* default state */
633 NPN_HTTP1_1, /* HTTP/1.1 negotiated */
634 NPN_HTTP2 /* HTTP2 (draft-xx) negotiated */
638 * Request specific data in the easy handle (SessionHandle). Previously,
639 * these members were on the connectdata struct but since a conn struct may
640 * now be shared between different SessionHandles, we store connection-specific
641 * data here. This struct only keeps stuff that's interesting for *this*
642 * request, as it will be cleared between multiple ones
644 struct SingleRequest {
645 curl_off_t size; /* -1 if unknown at this point */
646 curl_off_t *bytecountp; /* return number of bytes read or NULL */
648 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch,
649 -1 means unlimited */
650 curl_off_t *writebytecountp; /* return number of bytes written or NULL */
652 curl_off_t bytecount; /* total number of bytes read */
653 curl_off_t writebytecount; /* number of bytes written */
655 long headerbytecount; /* only count received headers */
656 long deductheadercount; /* this amount of bytes doesn't count when we check
657 if anything has been transferred at the end of a
658 connection. We use this counter to make only a
659 100 reply (without a following second response
660 code) result in a CURLE_GOT_NOTHING error code */
662 struct timeval start; /* transfer started at this time */
663 struct timeval now; /* current time */
664 bool header; /* incoming data has HTTP header */
666 HEADER_NORMAL, /* no bad header at all */
667 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest
669 HEADER_ALLBAD /* all was believed to be header */
670 } badheader; /* the header was deemed bad and will be
672 int headerline; /* counts header lines to better track the
674 char *hbufp; /* points at *end* of header line */
676 char *str; /* within buf */
677 char *str_start; /* within buf */
678 char *end_ptr; /* within buf */
679 char *p; /* within headerbuff */
680 bool content_range; /* set TRUE if Content-Range: was found */
681 curl_off_t offset; /* possible resume offset read from the
682 Content-Range: header */
683 int httpcode; /* error code from the 'HTTP/1.? XXX' or
684 'RTSP/1.? XXX' line */
685 struct timeval start100; /* time stamp to wait for the 100 code from */
686 enum expect100 exp100; /* expect 100 continue state */
687 enum upgrade101 upgr101; /* 101 upgrade state */
689 int auto_decoding; /* What content encoding. sec 3.5, RFC2616. */
691 #define IDENTITY 0 /* No encoding */
692 #define DEFLATE 1 /* zlib deflate [RFC 1950 & 1951] */
693 #define GZIP 2 /* gzip algorithm [RFC 1952] */
694 #define COMPRESS 3 /* Not handled, added for completeness */
697 zlibInitState zlib_init; /* possible zlib init state;
698 undefined if Content-Encoding header. */
699 z_stream z; /* State structure for zlib. */
711 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
712 and we're uploading the last chunk */
714 bool ignorebody; /* we read a response-body but we ignore it! */
715 bool ignorecl; /* This HTTP response has no body so we ignore the Content-
718 char *location; /* This points to an allocated version of the Location:
720 char *newurl; /* Set to the new URL to use when a redirect or a retry is
723 /* 'upload_present' is used to keep a byte counter of how much data there is
724 still left in the buffer, aimed for upload. */
725 ssize_t upload_present;
727 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
728 buffer, so the next read should read from where this pointer points to,
729 and the 'upload_present' contains the number of bytes available at this
731 char *upload_fromhere;
733 bool chunk; /* if set, this is a chunked transfer-encoding */
734 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
736 bool getheader; /* TRUE if header parsing is wanted */
738 bool forbidchunk; /* used only to explicitly forbid chunk-upload for
739 specific upload buffers. See readmoredata() in
740 http.c for details. */
742 void *protop; /* Allocated protocol-specific data. Each protocol
743 handler makes sure this points to data it needs. */
747 * Specific protocol handler.
750 struct Curl_handler {
751 const char * scheme; /* URL scheme name. */
753 /* Complement to setup_connection_internals(). */
754 CURLcode (*setup_connection)(struct connectdata *);
756 /* These two functions MUST be set to be protocol dependent */
757 CURLcode (*do_it)(struct connectdata *, bool *done);
760 /* If the curl_do() function is better made in two halves, this
761 * curl_do_more() function will be called afterwards, if set. For example
762 * for doing the FTP stuff after the PASV/PORT command.
764 Curl_do_more_func do_more;
766 /* This function *MAY* be set to a protocol-dependent function that is run
767 * after the connect() and everything is done, as a step in the connection.
768 * The 'done' pointer points to a bool that should be set to TRUE if the
769 * function completes before return. If it doesn't complete, the caller
770 * should call the curl_connecting() function until it is.
772 CURLcode (*connect_it)(struct connectdata *, bool *done);
774 /* See above. Currently only used for FTP. */
775 CURLcode (*connecting)(struct connectdata *, bool *done);
776 CURLcode (*doing)(struct connectdata *, bool *done);
778 /* Called from the multi interface during the PROTOCONNECT phase, and it
779 should then return a proper fd set */
780 int (*proto_getsock)(struct connectdata *conn,
781 curl_socket_t *socks,
784 /* Called from the multi interface during the DOING phase, and it should
785 then return a proper fd set */
786 int (*doing_getsock)(struct connectdata *conn,
787 curl_socket_t *socks,
790 /* Called from the multi interface during the DO_MORE phase, and it should
791 then return a proper fd set */
792 int (*domore_getsock)(struct connectdata *conn,
793 curl_socket_t *socks,
796 /* Called from the multi interface during the DO_DONE, PERFORM and
797 WAITPERFORM phases, and it should then return a proper fd set. Not setting
798 this will make libcurl use the generic default one. */
799 int (*perform_getsock)(const struct connectdata *conn,
800 curl_socket_t *socks,
803 /* This function *MAY* be set to a protocol-dependent function that is run
804 * by the curl_disconnect(), as a step in the disconnection. If the handler
805 * is called because the connection has been considered dead, dead_connection
808 CURLcode (*disconnect)(struct connectdata *, bool dead_connection);
810 /* If used, this function gets called from transfer.c:readwrite_data() to
811 allow the protocol to do extra reads/writes */
812 CURLcode (*readwrite)(struct SessionHandle *data, struct connectdata *conn,
813 ssize_t *nread, bool *readmore);
815 long defport; /* Default port. */
816 unsigned int protocol; /* See CURLPROTO_* - this needs to be the single
817 specific protocol bit */
818 unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */
821 #define PROTOPT_NONE 0 /* nothing extra */
822 #define PROTOPT_SSL (1<<0) /* uses SSL */
823 #define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */
824 #define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */
825 /* some protocols will have to call the underlying functions without regard to
826 what exact state the socket signals. IE even if the socket says "readable",
827 the send function might need to be called while uploading, or vice versa.
829 #define PROTOPT_DIRLOCK (1<<3)
830 #define PROTOPT_NONETWORK (1<<4) /* protocol doesn't use the network! */
831 #define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it
833 #define PROTOPT_NOURLQUERY (1<<6) /* protocol can't handle
834 url query strings (?foo=bar) ! */
835 #define PROTOPT_CREDSPERREQUEST (1<<7) /* requires login credentials per
836 request instead of per connection */
839 /* return the count of bytes sent, or -1 on error */
840 typedef ssize_t (Curl_send)(struct connectdata *conn, /* connection data */
841 int sockindex, /* socketindex */
842 const void *buf, /* data to write */
843 size_t len, /* max amount to write */
844 CURLcode *err); /* error to return */
846 /* return the count of bytes read, or -1 on error */
847 typedef ssize_t (Curl_recv)(struct connectdata *conn, /* connection data */
848 int sockindex, /* socketindex */
849 char *buf, /* store data here */
850 size_t len, /* max amount to read */
851 CURLcode *err); /* error to return */
854 * The connectdata struct contains all fields and variables that should be
855 * unique for an entire connection.
858 /* 'data' is the CURRENT SessionHandle using this connection -- take great
859 caution that this might very well vary between different times this
860 connection is used! */
861 struct SessionHandle *data;
863 /* chunk is for HTTP chunked encoding, but is in the general connectdata
864 struct only because we can do just about any protocol through a HTTP proxy
865 and a HTTP proxy may in fact respond using chunked encoding */
866 struct Curl_chunker chunk;
868 curl_closesocket_callback fclosesocket; /* function closing the socket(s) */
869 void *closesocket_client;
871 bool inuse; /* This is a marker for the connection cache logic. If this is
872 TRUE this handle is being used by an easy handle and cannot
873 be used by any other easy handle without careful
874 consideration (== only for pipelining). */
876 /**** Fields set when inited and not modified again */
877 long connection_id; /* Contains a unique number to make it easier to
878 track the connections in the log output */
880 /* 'dns_entry' is the particular host we use. This points to an entry in the
881 DNS cache and it will not get pruned while locked. It gets unlocked in
882 Curl_done(). This entry will be NULL if the connection is re-used as then
883 there is no name resolve done. */
884 struct Curl_dns_entry *dns_entry;
886 /* 'ip_addr' is the particular IP we connected to. It points to a struct
887 within the DNS cache, so this pointer is only valid as long as the DNS
888 cache entry remains locked. It gets unlocked in Curl_done() */
889 Curl_addrinfo *ip_addr;
890 Curl_addrinfo *tempaddr[2]; /* for happy eyeballs */
892 /* 'ip_addr_str' is the ip_addr data as a human readable string.
893 It remains available as long as the connection does, which is longer than
894 the ip_addr itself. */
895 char ip_addr_str[MAX_IPADR_LEN];
897 unsigned int scope_id; /* Scope id for IPv6 */
899 int socktype; /* SOCK_STREAM or SOCK_DGRAM */
901 struct hostname host;
902 struct hostname proxy;
904 long port; /* which port to use locally */
905 int remote_port; /* what remote port to connect to, not the proxy port! */
907 /* 'primary_ip' and 'primary_port' get filled with peer's numerical
908 ip address and port number whenever an outgoing connection is
909 *attempted* from the primary socket to a remote address. When more
910 than one address is tried for a connection these will hold data
911 for the last attempt. When the connection is actually established
912 these are updated with data which comes directly from the socket. */
914 char primary_ip[MAX_IPADR_LEN];
917 /* 'local_ip' and 'local_port' get filled with local's numerical
918 ip address and port number whenever an outgoing connection is
919 **established** from the primary socket to a remote address. */
921 char local_ip[MAX_IPADR_LEN];
924 char *user; /* user name string, allocated */
925 char *passwd; /* password string, allocated */
926 char *options; /* options string, allocated */
928 char *xoauth2_bearer; /* bearer token for xoauth2, allocated */
930 char *proxyuser; /* proxy user name string, allocated */
931 char *proxypasswd; /* proxy password string, allocated */
932 curl_proxytype proxytype; /* what kind of proxy that is in use */
934 int httpversion; /* the HTTP version*10 reported by the server */
935 int rtspversion; /* the RTSP version*10 reported by the server */
937 struct timeval now; /* "current" time */
938 struct timeval created; /* creation time */
939 curl_socket_t sock[2]; /* two sockets, the second is used for the data
940 transfer when doing FTP */
941 curl_socket_t tempsock[2]; /* temporary sockets for happy eyeballs */
942 bool sock_accepted[2]; /* TRUE if the socket on this index was created with
947 struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */
948 struct ssl_config_data ssl_config;
950 struct ConnectBits bits; /* various state-flags for this connection */
952 /* connecttime: when connect() is called on the current IP address. Used to
953 be able to track when to move on to try next IP - but only when the multi
954 interface is used. */
955 struct timeval connecttime;
956 /* The two fields below get set in Curl_connecthost */
957 int num_addr; /* number of addresses to try to connect to */
958 long timeoutms_per_addr; /* how long time in milliseconds to spend on
959 trying to connect to each IP address */
961 const struct Curl_handler *handler; /* Connection's protocol handler */
962 const struct Curl_handler *given; /* The protocol first given */
964 long ip_version; /* copied from the SessionHandle at creation time */
966 /**** curl_get() phase fields */
968 curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */
969 curl_socket_t writesockfd; /* socket to write to, it may very
970 well be the same we read from.
971 CURL_SOCKET_BAD disables */
973 /** Dynamicly allocated strings, MUST be freed before this **/
974 /** struct is killed. **/
975 struct dynamically_allocated_data {
978 char *accept_encoding;
984 char *rtsp_transport;
985 char *te; /* TE: request header */
989 int sec_complete; /* if Kerberos is enabled for this connection */
990 enum protection_level command_prot;
991 enum protection_level data_prot;
992 enum protection_level request_data_prot;
994 struct krb5buffer in_buffer;
996 const struct Curl_sec_client_mech *mech;
997 struct sockaddr_in local_addr;
1000 #if defined(USE_KERBEROS5) /* Consider moving some of the above GSS-API */
1001 struct kerberos5data krb5; /* variables into the structure definition, */
1002 #endif /* however, some of them are ftp specific. */
1004 /* the two following *_inuse fields are only flags, not counters in any way.
1005 If TRUE it means the channel is in use, and if FALSE it means the channel
1006 is up for grabs by one. */
1008 bool readchannel_inuse; /* whether the read channel is in use by an easy
1010 bool writechannel_inuse; /* whether the write channel is in use by an easy
1012 struct curl_llist *send_pipe; /* List of handles waiting to
1013 send on this pipeline */
1014 struct curl_llist *recv_pipe; /* List of handles waiting to read
1015 their responses on this pipeline */
1016 char* master_buffer; /* The master buffer allocated on-demand;
1017 used for pipelining. */
1018 size_t read_pos; /* Current read position in the master buffer */
1019 size_t buf_len; /* Length of the buffer?? */
1022 curl_seek_callback seek_func; /* function that seeks the input */
1023 void *seek_client; /* pointer to pass to the seek() above */
1025 /*************** Request - specific items ************/
1027 /* previously this was in the urldata struct */
1028 curl_read_callback fread_func; /* function that reads the input */
1029 void *fread_in; /* pointer to pass to the fread() above */
1031 #if defined(USE_NTLM)
1032 struct ntlmdata ntlm; /* NTLM differs from other authentication schemes
1033 because it authenticates connections, not
1035 struct ntlmdata proxyntlm; /* NTLM data for proxy */
1037 #if defined(NTLM_WB_ENABLED)
1038 /* used for communication with Samba's winbind daemon helper ntlm_auth */
1039 curl_socket_t ntlm_auth_hlpr_socket;
1040 pid_t ntlm_auth_hlpr_pid;
1041 char* challenge_header;
1042 char* response_header;
1046 char syserr_buf [256]; /* buffer for Curl_strerror() */
1048 #ifdef CURLRES_ASYNCH
1049 /* data used for the asynch name resolve callback */
1050 struct Curl_async async;
1053 /* These three are used for chunked-encoding trailer support */
1054 char *trailer; /* allocated buffer to store trailer in */
1055 int trlMax; /* allocated buffer size */
1056 int trlPos; /* index of where to store data */
1059 struct ftp_conn ftpc;
1060 struct http_conn httpc;
1061 struct ssh_conn sshc;
1062 struct tftp_state_data *tftpc;
1063 struct imap_conn imapc;
1064 struct pop3_conn pop3c;
1065 struct smtp_conn smtpc;
1066 struct rtsp_conn rtspc;
1067 struct smb_conn smbc;
1068 void *generic; /* RTMP and LDAP use this */
1071 int cselect_bits; /* bitmask of socket events */
1072 int waitfor; /* current READ/WRITE bits to wait for */
1074 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1075 int socks5_gssapi_enctype;
1081 /* When this connection is created, store the conditions for the local end
1082 bind. This is stored before the actual bind and before any connection is
1083 made and will serve the purpose of being used for comparison reasons so
1084 that subsequent bound-requested connections aren't accidentally re-using
1085 wrong connections. */
1087 unsigned short localport;
1090 /* tunnel as in tunnel through a HTTP proxy with CONNECT */
1092 TUNNEL_INIT, /* init/default/no tunnel state */
1093 TUNNEL_CONNECT, /* CONNECT has been sent off */
1094 TUNNEL_COMPLETE /* CONNECT response received completely */
1095 } tunnel_state[2]; /* two separate ones to allow FTP */
1096 struct connectbundle *bundle; /* The bundle we are member of */
1098 enum negotiatenpn negnpn;
1101 /* The end of connectdata. */
1104 * Struct to keep statistical and informational data.
1107 int httpcode; /* Recent HTTP, FTP, or RTSP response code */
1108 int httpproxycode; /* response code from proxy when received separate */
1109 int httpversion; /* the http version number X.Y = X*10+Y */
1110 long filetime; /* If requested, this is might get set. Set to -1 if the time
1111 was unretrievable. We cannot have this of type time_t,
1112 since time_t is unsigned on several platforms such as
1114 bool timecond; /* set to TRUE if the time condition didn't match, which
1115 thus made the document NOT get fetched */
1116 long header_size; /* size of read header(s) in bytes */
1117 long request_size; /* the amount of bytes sent in the request(s) */
1118 unsigned long proxyauthavail; /* what proxy auth types were announced */
1119 unsigned long httpauthavail; /* what host auth types were announced */
1120 long numconnects; /* how many new connection did libcurl created */
1121 char *contenttype; /* the content type of the object */
1122 char *wouldredirect; /* URL this would've been redirected to if asked to */
1124 /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip'
1125 and, 'conn_local_port' are copied over from the connectdata struct in
1126 order to allow curl_easy_getinfo() to return this information even when
1127 the session handle is no longer associated with a connection, and also
1128 allow curl_easy_reset() to clear this information from the session handle
1129 without disturbing information which is still alive, and that might be
1130 reused, in the connection cache. */
1132 char conn_primary_ip[MAX_IPADR_LEN];
1133 long conn_primary_port;
1135 char conn_local_ip[MAX_IPADR_LEN];
1136 long conn_local_port;
1138 struct curl_certinfo certs; /* info about the certs, only populated in
1139 OpenSSL builds. Asked for with
1140 CURLOPT_CERTINFO / CURLINFO_CERTINFO */
1145 long lastshow; /* time() of the last displayed progress meter or NULL to
1146 force redraw at next call */
1147 curl_off_t size_dl; /* total expected size */
1148 curl_off_t size_ul; /* total expected size */
1149 curl_off_t downloaded; /* transferred so far */
1150 curl_off_t uploaded; /* transferred so far */
1152 curl_off_t current_speed; /* uses the currently fastest transfer */
1154 bool callback; /* set when progress callback is used */
1155 int width; /* screen width at download start */
1156 int flags; /* see progress.h */
1165 double t_appconnect;
1166 double t_pretransfer;
1167 double t_starttransfer;
1170 struct timeval start;
1171 struct timeval t_startsingle;
1172 struct timeval t_startop;
1173 struct timeval t_acceptdata;
1174 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
1176 curl_off_t speeder[ CURR_TIME ];
1177 struct timeval speeder_time[ CURR_TIME ];
1182 HTTPREQ_NONE, /* first in list */
1185 HTTPREQ_POST_FORM, /* we make a difference internally */
1189 HTTPREQ_LAST /* last in list */
1193 RTSPREQ_NONE, /* first in list */
1201 RTSPREQ_GET_PARAMETER,
1202 RTSPREQ_SET_PARAMETER,
1205 RTSPREQ_LAST /* last in list */
1209 * Values that are generated, temporary or calculated internally for a
1210 * "session handle" must be defined within the 'struct UrlState'. This struct
1211 * will be used within the SessionHandle struct. When the 'SessionHandle'
1212 * struct is cloned, this data MUST NOT be copied.
1214 * Remember that any "state" information goes globally for the curl handle.
1215 * Session-data MUST be put in the connectdata struct and here. */
1216 #define MAX_CURL_USER_LENGTH 256
1217 #define MAX_CURL_PASSWORD_LENGTH 256
1220 unsigned long want; /* Bitmask set to the authentication methods wanted by
1221 app (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */
1222 unsigned long picked;
1223 unsigned long avail; /* Bitmask for what the server reports to support for
1225 bool done; /* TRUE when the auth phase is done and ready to do the *actual*
1227 bool multi; /* TRUE if this is not yet authenticated but within the auth
1228 multipass negotiation */
1229 bool iestyle; /* TRUE if digest should be done IE-style or FALSE if it should
1235 /* Points to the connection cache */
1236 struct conncache *conn_cache;
1238 /* when curl_easy_perform() is called, the multi handle is "owned" by
1239 the easy handle so curl_easy_cleanup() on such an easy handle will
1240 also close the multi handle! */
1241 bool multi_owned_by_easy;
1243 /* buffers to store authentication data in, as parsed from input options */
1244 struct timeval keeps_speed; /* for the progress meter really */
1246 struct connectdata *lastconnect; /* The last connection, NULL if undefined */
1248 char *headerbuff; /* allocated buffer to store headers in */
1249 size_t headersize; /* size of the allocation */
1251 char buffer[BUFSIZE+1]; /* download buffer */
1252 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
1253 curl_off_t current_speed; /* the ProgressShow() funcion sets this,
1255 bool this_is_a_follow; /* this is a followed Location: request */
1257 char *first_host; /* if set, this should be the host name that we will
1258 sent authorization to, no else. Used to make Location:
1259 following not keep sending user+password... This is
1262 struct curl_ssl_session *session; /* array of 'max_ssl_sessions' size */
1263 long sessionage; /* number of the most recent session */
1264 char *tempwrite; /* allocated buffer to keep data in when a write
1265 callback returns to make the connection paused */
1266 size_t tempwritesize; /* size of the 'tempwrite' allocated buffer */
1267 int tempwritetype; /* type of the 'tempwrite' buffer as a bitmask that is
1268 used with Curl_client_write() */
1269 char *scratch; /* huge buffer[BUFSIZE*2] when doing upload CRLF replacing */
1270 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
1271 This must be set to FALSE every time _easy_perform() is
1273 int os_errno; /* filled in with errno whenever an error occurs */
1275 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
1276 void (*prev_signal)(int sig);
1278 bool allow_port; /* Is set.use_port allowed to take effect or not. This
1279 is always set TRUE when curl_easy_perform() is called. */
1280 struct digestdata digest; /* state data for host Digest auth */
1281 struct digestdata proxydigest; /* state data for proxy Digest auth */
1284 struct negotiatedata negotiate; /* state data for host Negotiate auth */
1285 struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */
1288 struct auth authhost; /* auth details for host */
1289 struct auth authproxy; /* auth details for proxy */
1291 bool authproblem; /* TRUE if there's some problem authenticating */
1293 void *resolver; /* resolver state, if it is used in the URL state -
1294 ares_channel f.e. */
1296 #if defined(USE_SSLEAY) && defined(HAVE_OPENSSL_ENGINE_H)
1298 #endif /* USE_SSLEAY */
1299 struct timeval expiretime; /* set this with Curl_expire() only */
1300 struct Curl_tree timenode; /* for the splay stuff */
1301 struct curl_llist *timeoutlist; /* list of pending timeouts */
1303 /* a place to store the most recently set FTP entrypath */
1304 char *most_recent_ftp_entrypath;
1306 /* set after initial USER failure, to prevent an authentication loop */
1307 bool ftp_trying_alternative;
1309 int httpversion; /* the lowest HTTP version*10 reported by any server
1310 involved in this request */
1311 bool expect100header; /* TRUE if we added Expect: 100-continue */
1313 bool pipe_broke; /* TRUE if the connection we were pipelined on broke
1314 and we need to restart from the beginning */
1316 #if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) && \
1317 !defined(__SYMBIAN32__)
1318 /* do FTP line-end conversions on most platforms */
1319 #define CURL_DO_LINEEND_CONV
1320 /* for FTP downloads: track CRLF sequences that span blocks */
1321 bool prev_block_had_trailing_cr;
1322 /* for FTP downloads: how many CRLFs did we converted to LFs? */
1323 curl_off_t crlf_conversions;
1325 char *pathbuffer;/* allocated buffer to store the URL's path part in */
1326 char *path; /* path to use, points to somewhere within the pathbuffer
1328 bool slash_removed; /* set TRUE if the 'path' points to a path where the
1329 initial URL slash separator has been taken off */
1331 bool rangestringalloc; /* the range string is malloc()'ed */
1333 char *range; /* range, if used. See README for detailed specification on
1335 curl_off_t resume_from; /* continue [ftp] transfer from here */
1337 /* This RTSP state information survives requests and connections */
1338 long rtsp_next_client_CSeq; /* the session's next client CSeq */
1339 long rtsp_next_server_CSeq; /* the session's next server CSeq */
1340 long rtsp_CSeq_recv; /* most recent CSeq received */
1342 curl_off_t infilesize; /* size of file to upload, -1 means unknown.
1343 Copied from set.filesize at start of operation */
1348 * This 'DynamicStatic' struct defines dynamic states that actually change
1349 * values in the 'UserDefined' area, which MUST be taken into consideration
1350 * if the UserDefined struct is cloned or similar. You can probably just
1351 * copy these, but each one indicate a special action on other data.
1354 struct DynamicStatic {
1355 char *url; /* work URL, copied from UserDefined */
1356 bool url_alloc; /* URL string is malloc()'ed */
1357 char *referer; /* referer string */
1358 bool referer_alloc; /* referer sting is malloc()ed */
1359 struct curl_slist *cookielist; /* list of cookie files set by
1360 curl_easy_setopt(COOKIEFILE) calls */
1361 struct curl_slist *resolve; /* set to point to the set.resolve list when
1362 this should be dealt with in pretransfer */
1366 * This 'UserDefined' struct must only contain data that is set once to go
1367 * for many (perhaps) independent connections. Values that are generated or
1368 * calculated internally for the "session handle" MUST be defined within the
1369 * 'struct UrlState' instead. The only exceptions MUST note the changes in
1370 * the 'DynamicStatic' struct.
1371 * Character pointer fields point to dynamic storage, unless otherwise stated.
1374 struct Curl_multi; /* declared and used only in multi.c */
1377 STRING_CERT, /* client certificate file name */
1378 STRING_CERT_TYPE, /* format for certificate (default: PEM)*/
1379 STRING_COOKIE, /* HTTP cookie string to send */
1380 STRING_COOKIEJAR, /* dump all cookies to this file */
1381 STRING_CUSTOMREQUEST, /* HTTP/FTP/RTSP request/method to use */
1382 STRING_DEVICE, /* local network interface/address to use */
1383 STRING_ENCODING, /* Accept-Encoding string */
1384 STRING_FTP_ACCOUNT, /* ftp account data */
1385 STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */
1386 STRING_FTPPORT, /* port to send with the FTP PORT command */
1387 STRING_KEY, /* private key file name */
1388 STRING_KEY_PASSWD, /* plain text private key password */
1389 STRING_KEY_TYPE, /* format for private key (default: PEM) */
1390 STRING_KRB_LEVEL, /* krb security level */
1391 STRING_NETRC_FILE, /* if not NULL, use this instead of trying to find
1393 STRING_PROXY, /* proxy to use */
1394 STRING_SET_RANGE, /* range, if used */
1395 STRING_SET_REFERER, /* custom string for the HTTP referer field */
1396 STRING_SET_URL, /* what original URL to work on */
1397 STRING_SSL_CAPATH, /* CA directory name (doesn't work on windows) */
1398 STRING_SSL_CAFILE, /* certificate file to verify peer against */
1399 STRING_SSL_PINNEDPUBLICKEY, /* public key file to verify peer against */
1400 STRING_SSL_CIPHER_LIST, /* list of ciphers to use */
1401 STRING_SSL_EGDSOCKET, /* path to file containing the EGD daemon socket */
1402 STRING_SSL_RANDOM_FILE, /* path to file containing "random" data */
1403 STRING_USERAGENT, /* User-Agent string */
1404 STRING_SSL_CRLFILE, /* crl file to check certificate */
1405 STRING_SSL_ISSUERCERT, /* issuer cert file to check certificate */
1406 STRING_USERNAME, /* <username>, if used */
1407 STRING_PASSWORD, /* <password>, if used */
1408 STRING_OPTIONS, /* <options>, if used */
1409 STRING_PROXYUSERNAME, /* Proxy <username>, if used */
1410 STRING_PROXYPASSWORD, /* Proxy <password>, if used */
1411 STRING_NOPROXY, /* List of hosts which should not use the proxy, if
1413 STRING_RTSP_SESSION_ID, /* Session ID to use */
1414 STRING_RTSP_STREAM_URI, /* Stream URI for this request */
1415 STRING_RTSP_TRANSPORT, /* Transport for this session */
1417 STRING_SSH_PRIVATE_KEY, /* path to the private key file for auth */
1418 STRING_SSH_PUBLIC_KEY, /* path to the public key file for auth */
1419 STRING_SSH_HOST_PUBLIC_KEY_MD5, /* md5 of host public key in ascii hex */
1420 STRING_SSH_KNOWNHOSTS, /* file name of knownhosts file */
1422 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1423 STRING_SOCKS5_GSSAPI_SERVICE, /* GSSAPI service name */
1429 STRING_TLSAUTH_USERNAME, /* TLS auth <username> */
1430 STRING_TLSAUTH_PASSWORD, /* TLS auth <password> */
1432 STRING_BEARER, /* <bearer>, if used */
1433 #ifdef USE_UNIX_SOCKETS
1434 STRING_UNIX_SOCKET_PATH, /* path to Unix socket, if used */
1437 /* -- end of zero-terminated strings -- */
1439 STRING_LASTZEROTERMINATED,
1441 /* -- below this are pointers to binary data that cannot be strdup'ed.
1442 Each such pointer must be added manually to Curl_dupset() --- */
1444 STRING_COPYPOSTFIELDS, /* if POST, set the fields' values here */
1446 STRING_LAST /* not used, just an end-of-list marker */
1449 struct UserDefined {
1450 FILE *err; /* the stderr user data goes here */
1451 void *debugdata; /* the data that will be passed to fdebug */
1452 char *errorbuffer; /* (Static) store failure messages in here */
1453 long proxyport; /* If non-zero, use this port number by default. If the
1454 proxy string features a ":[port]" that one will override
1456 void *out; /* the fetched file goes here */
1457 void *in; /* the uploaded file is read from here */
1458 void *writeheader; /* write the header to this if non-NULL */
1459 void *rtp_out; /* write RTP to this if non-NULL */
1460 long use_port; /* which port to use (when not using default) */
1461 unsigned long httpauth; /* kind of HTTP authentication to use (bitmask) */
1462 unsigned long proxyauth; /* kind of proxy authentication to use (bitmask) */
1463 long followlocation; /* as in HTTP Location: */
1464 long maxredirs; /* maximum no. of http(s) redirects to follow, set to -1
1467 int keep_post; /* keep POSTs as POSTs after a 30x request; each
1468 bit represents a request, from 301 to 303 */
1469 bool free_referer; /* set TRUE if 'referer' points to a string we
1471 void *postfields; /* if POST, set the fields' values here */
1472 curl_seek_callback seek_func; /* function that seeks the input */
1473 curl_off_t postfieldsize; /* if POST, this might have a size to use instead
1474 of strlen(), and then the data *may* be binary
1475 (contain zero bytes) */
1476 unsigned short localport; /* local port number to bind to */
1477 int localportrange; /* number of additional port numbers to test in case the
1478 'localport' one can't be bind()ed */
1479 curl_write_callback fwrite_func; /* function that stores the output */
1480 curl_write_callback fwrite_header; /* function that stores headers */
1481 curl_write_callback fwrite_rtp; /* function that stores interleaved RTP */
1482 curl_read_callback fread_func; /* function that reads the input */
1483 int is_fread_set; /* boolean, has read callback been set to non-NULL? */
1484 int is_fwrite_set; /* boolean, has write callback been set to non-NULL? */
1485 curl_progress_callback fprogress; /* OLD and deprecated progress callback */
1486 curl_xferinfo_callback fxferinfo; /* progress callback */
1487 curl_debug_callback fdebug; /* function that write informational data */
1488 curl_ioctl_callback ioctl_func; /* function for I/O control */
1489 curl_sockopt_callback fsockopt; /* function for setting socket options */
1490 void *sockopt_client; /* pointer to pass to the socket options callback */
1491 curl_opensocket_callback fopensocket; /* function for checking/translating
1492 the address and opening the
1494 void* opensocket_client;
1495 curl_closesocket_callback fclosesocket; /* function for closing the
1497 void* closesocket_client;
1499 void *seek_client; /* pointer to pass to the seek callback */
1500 /* the 3 curl_conv_callback functions below are used on non-ASCII hosts */
1501 /* function to convert from the network encoding: */
1502 curl_conv_callback convfromnetwork;
1503 /* function to convert to the network encoding: */
1504 curl_conv_callback convtonetwork;
1505 /* function to convert from UTF-8 encoding: */
1506 curl_conv_callback convfromutf8;
1508 void *progress_client; /* pointer to pass to the progress callback */
1509 void *ioctl_client; /* pointer to pass to the ioctl callback */
1510 long timeout; /* in milliseconds, 0 means no timeout */
1511 long connecttimeout; /* in milliseconds, 0 means no timeout */
1512 long accepttimeout; /* in milliseconds, 0 means no timeout */
1513 long server_response_timeout; /* in milliseconds, 0 means no timeout */
1514 long tftp_blksize ; /* in bytes, 0 means use default */
1515 curl_off_t filesize; /* size of file to upload, -1 means unknown */
1516 long low_speed_limit; /* bytes/second */
1517 long low_speed_time; /* number of seconds */
1518 curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */
1519 curl_off_t max_recv_speed; /* high speed limit in bytes/second for
1521 curl_off_t set_resume_from; /* continue [ftp] transfer from here */
1522 struct curl_slist *headers; /* linked list of extra headers */
1523 struct curl_slist *proxyheaders; /* linked list of extra CONNECT headers */
1524 struct curl_httppost *httppost; /* linked list of POST data */
1525 bool sep_headers; /* handle host and proxy headers separately */
1526 bool cookiesession; /* new cookie session? */
1527 bool crlf; /* convert crlf on ftp upload(?) */
1528 struct curl_slist *quote; /* after connection is established */
1529 struct curl_slist *postquote; /* after the transfer */
1530 struct curl_slist *prequote; /* before the transfer, after type */
1531 struct curl_slist *source_quote; /* 3rd party quote */
1532 struct curl_slist *source_prequote; /* in 3rd party transfer mode - before
1533 the transfer on source host */
1534 struct curl_slist *source_postquote; /* in 3rd party transfer mode - after
1535 the transfer on source host */
1536 struct curl_slist *telnet_options; /* linked list of telnet options */
1537 struct curl_slist *resolve; /* list of names to add/remove from
1539 curl_TimeCond timecondition; /* kind of time/date comparison */
1540 time_t timevalue; /* what time to compare with */
1541 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
1542 long httpversion; /* when non-zero, a specific HTTP version requested to
1543 be used in the library's request(s) */
1544 struct ssl_config_data ssl; /* user defined SSL stuff */
1545 curl_proxytype proxytype; /* what kind of proxy that is in use */
1546 long dns_cache_timeout; /* DNS cache timeout */
1547 long buffer_size; /* size of receive buffer to use */
1548 void *private_data; /* application-private data */
1550 struct curl_slist *http200aliases; /* linked list of aliases for http200 */
1552 long ipver; /* the CURL_IPRESOLVE_* defines in the public header file
1553 0 - whatever, 1 - v2, 2 - v6 */
1555 curl_off_t max_filesize; /* Maximum file size to download */
1557 curl_ftpfile ftp_filemethod; /* how to get to a file when FTP is used */
1559 int ftp_create_missing_dirs; /* 1 - create directories that don't exist
1560 2 - the same but also allow MKD to fail once
1563 curl_sshkeycallback ssh_keyfunc; /* key matching callback */
1564 void *ssh_keyfunc_userp; /* custom pointer to callback */
1566 /* Here follows boolean settings that define how to behave during
1567 this session. They are STATIC, set by libcurl users or at least initially
1568 and they don't change during operations. */
1570 bool printhost; /* printing host name in debug info */
1571 bool get_filetime; /* get the time and get of the remote file */
1572 bool tunnel_thru_httpproxy; /* use CONNECT through a HTTP proxy */
1573 bool prefer_ascii; /* ASCII rather than binary */
1574 bool ftp_append; /* append, not overwrite, on upload */
1575 bool ftp_list_only; /* switch FTP command for listing directories */
1576 bool ftp_use_port; /* use the FTP PORT command */
1577 bool hide_progress; /* don't use the progress meter */
1578 bool http_fail_on_error; /* fail on HTTP error codes >= 400 */
1579 bool http_follow_location; /* follow HTTP redirects */
1580 bool http_transfer_encoding; /* request compressed HTTP transfer-encoding */
1581 bool http_disable_hostname_check_before_authentication;
1582 bool include_header; /* include received protocol headers in data output */
1583 bool http_set_referer; /* is a custom referer used */
1584 bool http_auto_referer; /* set "correct" referer when following location: */
1585 bool opt_no_body; /* as set with CURLOPT_NOBODY */
1586 bool set_port; /* custom port number used */
1587 bool upload; /* upload request */
1588 enum CURL_NETRC_OPTION
1589 use_netrc; /* defined in include/curl.h */
1590 bool verbose; /* output verbosity */
1591 bool krb; /* Kerberos connection requested */
1592 bool reuse_forbid; /* forbidden to be reused, close after use */
1593 bool reuse_fresh; /* do not re-use an existing connection */
1594 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
1595 bool ftp_use_eprt; /* if EPRT is to be attempted or not */
1596 bool ftp_use_pret; /* if PRET is to be used before PASV or not */
1598 curl_usessl use_ssl; /* if AUTH TLS is to be attempted etc, for FTP or
1599 IMAP or POP3 or others! */
1600 curl_ftpauth ftpsslauth; /* what AUTH XXX to be attempted */
1601 curl_ftpccc ftp_ccc; /* FTP CCC options */
1602 bool no_signal; /* do not use any signal/alarm handler */
1603 bool global_dns_cache; /* subject for future removal */
1604 bool tcp_nodelay; /* whether to enable TCP_NODELAY or not */
1605 bool ignorecl; /* ignore content length */
1606 bool ftp_skip_ip; /* skip the IP address the FTP server passes on to
1608 bool connect_only; /* make connection, let application use the socket */
1609 bool ssl_enable_beast; /* especially allow this flaw for interoperability's
1611 long ssh_auth_types; /* allowed SSH auth types */
1612 bool http_te_skip; /* pass the raw body data to the user, even when
1613 transfer-encoded (chunked, compressed) */
1614 bool http_ce_skip; /* pass the raw body data to the user, even when
1615 content-encoded (chunked, compressed) */
1616 long new_file_perms; /* Permissions to use when creating remote files */
1617 long new_directory_perms; /* Permissions to use when creating remote dirs */
1618 bool proxy_transfer_mode; /* set transfer mode (;type=<a|i>) when doing FTP
1619 via an HTTP proxy */
1620 char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */
1621 unsigned int scope_id; /* Scope id for IPv6 */
1622 long allowed_protocols;
1623 long redir_protocols;
1624 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1625 long socks5_gssapi_nec; /* flag to support nec socks5 server */
1627 struct curl_slist *mail_rcpt; /* linked list of mail recipients */
1628 bool sasl_ir; /* Enable/disable SASL initial response */
1629 /* Common RTSP header options */
1630 Curl_RtspReq rtspreq; /* RTSP request type */
1631 long rtspversion; /* like httpversion, for RTSP */
1632 bool wildcardmatch; /* enable wildcard matching */
1633 curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer
1635 curl_chunk_end_callback chunk_end; /* called after part transferring
1637 curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds
1638 to pattern (e.g. if WILDCARDMATCH is on) */
1641 long gssapi_delegation; /* GSS-API credential delegation, see the
1642 documentation of CURLOPT_GSSAPI_DELEGATION */
1644 bool tcp_keepalive; /* use TCP keepalives */
1645 long tcp_keepidle; /* seconds in idle before sending keepalive probe */
1646 long tcp_keepintvl; /* seconds between TCP keepalive probes */
1648 size_t maxconnects; /* Max idle connections in the connection cache */
1650 bool ssl_enable_npn; /* TLS NPN extension? */
1651 bool ssl_enable_alpn; /* TLS ALPN extension? */
1653 long expect_100_timeout; /* in milliseconds */
1657 struct curl_hash *hostcache;
1659 HCACHE_NONE, /* not pointing to anything */
1660 HCACHE_GLOBAL, /* points to the (shrug) global one */
1661 HCACHE_MULTI, /* points to a shared one in the multi handle */
1662 HCACHE_SHARED /* points to a shared one in a shared object */
1667 * The 'connectdata' struct MUST have all the connection oriented stuff as we
1668 * may have several simultaneous connections and connection structs in memory.
1670 * The 'struct UserDefined' must only contain data that is set once to go for
1671 * many (perhaps) independent connections. Values that are generated or
1672 * calculated internally for the "session handle" must be defined within the
1673 * 'struct UrlState' instead.
1676 struct SessionHandle {
1677 /* first, two fields for the linked list of these */
1678 struct SessionHandle *next;
1679 struct SessionHandle *prev;
1681 struct connectdata *easy_conn; /* the "unit's" connection */
1683 CURLMstate mstate; /* the handle's state */
1684 CURLcode result; /* previous result */
1686 struct Curl_message msg; /* A single posted message. */
1688 /* Array with the plain socket numbers this handle takes care of, in no
1689 particular order. Note that all sockets are added to the sockhash, where
1690 the state etc are also kept. This array is mostly used to detect when a
1691 socket is to be removed from the hash. See singlesocket(). */
1692 curl_socket_t sockets[MAX_SOCKSPEREASYHANDLE];
1696 struct Curl_multi *multi; /* if non-NULL, points to the multi handle
1697 struct to which this "belongs" when used by
1698 the multi interface */
1699 struct Curl_multi *multi_easy; /* if non-NULL, points to the multi handle
1700 struct to which this "belongs" when used
1701 by the easy interface */
1702 struct Curl_share *share; /* Share, handles global variable mutexing */
1703 struct SingleRequest req; /* Request-specific data */
1704 struct UserDefined set; /* values set by the libcurl user */
1705 struct DynamicStatic change; /* possibly modified userdefined data */
1706 struct CookieInfo *cookies; /* the cookies, read from files and servers.
1707 NOTE that the 'cookie' field in the
1708 UserDefined struct defines if the "engine"
1709 is to be used or not. */
1710 struct Progress progress; /* for all the progress meter data */
1711 struct UrlState state; /* struct for fields used for state info and
1712 other dynamic purposes */
1713 struct WildcardData wildcard; /* wildcard download state info */
1714 struct PureInfo info; /* stats, reports and info data */
1715 struct curl_tlssessioninfo tsi; /* Information about the TLS session, only
1716 valid after a client has asked for it */
1717 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
1718 iconv_t outbound_cd; /* for translating to the network encoding */
1719 iconv_t inbound_cd; /* for translating from the network encoding */
1720 iconv_t utf8_cd; /* for translating to UTF8 */
1721 #endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */
1722 unsigned int magic; /* set to a CURLEASY_MAGIC_NUMBER */
1725 #define LIBCURL_NAME "libcurl"
1727 #endif /* HEADER_CURL_URLDATA_H */
projects / platform / upstream / curl.git / blob