1 #ifndef HEADER_CURL_URLDATA_H
2 #define HEADER_CURL_URLDATA_H
3 /***************************************************************************
5 * Project ___| | | | _ \| |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 1998 - 2015, 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)
86 #include <openssl/ssl.h>
87 #ifdef HAVE_OPENSSL_ENGINE_H
88 #include <openssl/engine.h>
90 #endif /* USE_OPENSSL */
93 #include <gnutls/gnutls.h>
97 #include <polarssl/ssl.h>
98 #include <polarssl/version.h>
99 #if POLARSSL_VERSION_NUMBER<0x01010000
100 #include <polarssl/havege.h>
102 #include <polarssl/entropy.h>
103 #include <polarssl/ctr_drbg.h>
104 #endif /* POLARSSL_VERSION_NUMBER<0x01010000 */
105 #endif /* USE_POLARSSL */
108 #undef OCSP_REQUEST /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */
109 #undef OCSP_RESPONSE /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */
110 #include <cyassl/openssl/ssl.h>
123 #include <axTLS/config.h>
124 #include <axTLS/ssl.h>
128 #endif /* USE_AXTLS */
131 #include "curl_sspi.h"
133 #include <schannel.h>
137 #include <Security/Security.h>
138 /* For some reason, when building for iOS, the omnibus header above does
139 * not include SecureTransport.h as of iOS SDK 5.1. */
140 #include <Security/SecureTransport.h>
143 #ifdef HAVE_NETINET_IN_H
144 #include <netinet/in.h>
150 #include <zlib.h> /* for content-encoding */
152 /* zlib pollutes the namespace with this definition */
157 #include <curl/curl.h>
159 #include "http_chunks.h" /* for the structs and enum stuff */
173 #include "wildcard.h"
174 #include "multihandle.h"
179 # elif defined HAVE_GSSMIT
180 # include <gssapi/gssapi.h>
181 # include <gssapi/gssapi_generic.h>
187 #ifdef HAVE_LIBSSH2_H
189 #include <libssh2_sftp.h>
190 #endif /* HAVE_LIBSSH2_H */
192 /* Download buffer size, keep it fairly big for speed reasons */
194 #define BUFSIZE CURL_MAX_WRITE_SIZE
196 /* Initial size of the buffer to store headers in, it'll be enlarged in case
198 #define HEADERSIZE 256
200 #define CURLEASY_MAGIC_NUMBER 0xc0dedbadU
201 #define GOOD_EASY_HANDLE(x) \
202 ((x) && (((struct SessionHandle *)(x))->magic == CURLEASY_MAGIC_NUMBER))
204 /* Some convenience macros to get the larger/smaller value out of two given.
205 We prefix with CURL to prevent name collisions. */
206 #define CURLMAX(x,y) ((x)>(y)?(x):(y))
207 #define CURLMIN(x,y) ((x)<(y)?(x):(y))
211 /* Types needed for krb5-ftp connections */
219 enum protection_level {
220 PROT_NONE, /* first in list */
226 PROT_LAST /* last in list */
231 /* Structs to store Schannel handles */
232 struct curl_schannel_cred {
233 CredHandle cred_handle;
234 TimeStamp time_stamp;
239 struct curl_schannel_ctxt {
240 CtxtHandle ctxt_handle;
241 TimeStamp time_stamp;
245 /* enum for the nonblocking SSL connection state machine */
249 ssl_connect_2_reading,
250 ssl_connect_2_writing,
257 ssl_connection_negotiating,
258 ssl_connection_complete
259 } ssl_connection_state;
261 /* struct for data related to each SSL connection */
262 struct ssl_connect_data {
263 /* Use ssl encrypted communications TRUE/FALSE, not necessarily using it atm
264 but at least asked to or meaning to use it. See 'state' for the exact
265 current state of the connection. */
267 ssl_connection_state state;
269 /* these ones requires specific SSL-types */
273 ssl_connect_state connecting_state;
274 #endif /* USE_OPENSSL */
276 gnutls_session_t session;
277 gnutls_certificate_credentials_t cred;
279 gnutls_srp_client_credentials_t srp_client_cred;
281 ssl_connect_state connecting_state;
282 #endif /* USE_GNUTLS */
284 ctr_drbg_context ctr_drbg;
285 entropy_context entropy;
293 ssl_connect_state connecting_state;
294 #endif /* USE_POLARSSL */
298 ssl_connect_state connecting_state;
299 #endif /* USE_CYASSL */
302 char *client_nickname;
303 struct SessionHandle *data;
304 struct curl_llist *obj_list;
305 PK11GenericObject *obj_clicert;
306 ssl_connect_state connecting_state;
311 ssl_connect_state connecting_state;
316 ssl_connect_state connecting_state;
317 #endif /* USE_AXTLS */
319 struct curl_schannel_cred *cred;
320 struct curl_schannel_ctxt *ctxt;
321 SecPkgContext_StreamSizes stream_sizes;
322 ssl_connect_state connecting_state;
323 size_t encdata_length, decdata_length;
324 size_t encdata_offset, decdata_offset;
325 unsigned char *encdata_buffer, *decdata_buffer;
326 unsigned long req_flags, ret_flags;
327 CURLcode recv_unrecoverable_err; /* schannel_recv had an unrecoverable err */
328 bool recv_sspi_close_notify; /* true if connection closed by close_notify */
329 bool recv_connection_closed; /* true if connection closed, regardless how */
330 #endif /* USE_SCHANNEL */
332 SSLContextRef ssl_ctx;
333 curl_socket_t ssl_sockfd;
334 ssl_connect_state connecting_state;
335 bool ssl_direction; /* true if writing, false if reading */
336 size_t ssl_write_buffered_length;
337 #endif /* USE_DARWINSSL */
340 struct ssl_config_data {
341 long version; /* what version the client wants to use */
342 long certverifyresult; /* result from the certificate verification */
344 bool verifypeer; /* set TRUE if this is desired */
345 bool verifyhost; /* set TRUE if CN/SAN must match hostname */
346 bool verifystatus; /* set TRUE if certificate status must be checked */
347 char *CApath; /* certificate dir (doesn't work on windows) */
348 char *CAfile; /* certificate to verify peer against */
349 const char *CRLfile; /* CRL to check certificate revocation */
350 const char *issuercert;/* optional issuer certificate filename */
351 char *random_file; /* path to file containing "random" data */
352 char *egdsocket; /* path to file containing the EGD daemon socket */
353 char *cipher_list; /* list of ciphers to use */
354 size_t max_ssl_sessions; /* SSL session id cache size */
355 curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */
356 void *fsslctxp; /* parameter for call back */
357 bool sessionid; /* cache session IDs or not */
358 bool certinfo; /* gather lots of certificate info */
362 char *username; /* TLS username (for, e.g., SRP) */
363 char *password; /* TLS password (for, e.g., SRP) */
364 enum CURL_TLSAUTH authtype; /* TLS authentication type (default SRP) */
368 /* information stored about one single SSL session */
369 struct curl_ssl_session {
370 char *name; /* host name for which this ID was used */
371 void *sessionid; /* as returned from the SSL layer */
372 size_t idsize; /* if known, otherwise 0 */
373 long age; /* just a number, the higher the more recent */
374 int remote_port; /* remote port to connect to */
375 struct ssl_config_data ssl_config; /* setup for this session */
378 /* Struct used for Digest challenge-response authentication */
380 #if defined(USE_WINDOWS_SSPI)
382 size_t input_token_len;
388 bool stale; /* set true for re-negotiation */
392 int nc; /* nounce count */
404 #ifdef USE_WINDOWS_SSPI
405 #include "curl_sspi.h"
408 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
412 /* Struct used for GSSAPI (Kerberos V5) authentication */
413 #if defined(USE_KERBEROS5)
414 struct kerberos5data {
415 #if defined(USE_WINDOWS_SSPI)
416 CredHandle *credentials;
419 SEC_WINNT_AUTH_IDENTITY identity;
420 SEC_WINNT_AUTH_IDENTITY *p_identity;
424 gss_ctx_id_t context;
430 /* Struct used for NTLM challenge-response authentication */
431 #if defined(USE_NTLM)
434 #ifdef USE_WINDOWS_SSPI
435 CredHandle *credentials;
437 SEC_WINNT_AUTH_IDENTITY identity;
438 SEC_WINNT_AUTH_IDENTITY *p_identity;
442 size_t input_token_len;
445 unsigned char nonce[8];
446 void* target_info; /* TargetInfo received in the ntlm type-2 message */
447 unsigned int target_info_len;
453 struct negotiatedata {
454 /* When doing Negotiate (SPNEGO) auth, we first need to send a token
455 and then validate the received one. */
456 enum { GSS_AUTHNONE, GSS_AUTHRECV, GSS_AUTHSENT } state;
459 gss_ctx_id_t context;
460 gss_name_t server_name;
461 gss_buffer_desc output_token;
463 #ifdef USE_WINDOWS_SSPI
465 CredHandle *credentials;
467 SEC_WINNT_AUTH_IDENTITY identity;
468 SEC_WINNT_AUTH_IDENTITY *p_identity;
472 size_t output_token_length;
480 * Boolean values that concerns this connection.
483 /* always modify bits.close with the connclose() and connkeep() macros! */
484 bool close; /* if set, we close the connection after this request */
485 bool reuse; /* if set, this is a re-used connection */
486 bool proxy; /* if set, this transfer is done through a proxy - any type */
487 bool httpproxy; /* if set, this transfer is done through a http proxy */
488 bool user_passwd; /* do we use user+password for this connection? */
489 bool proxy_user_passwd; /* user+password for the proxy? */
490 bool ipv6_ip; /* we communicate with a remote site specified with pure IPv6
492 bool ipv6; /* we communicate with a site using an IPv6 address */
494 bool do_more; /* this is set TRUE if the ->curl_do_more() function is
495 supposed to be called, after ->curl_do() */
496 bool tcpconnect[2]; /* the TCP layer (or similar) is connected, this is set
497 the first time on the first connect function call */
498 bool protoconnstart;/* the protocol layer has STARTED its operation after
499 the TCP layer connect */
501 bool retry; /* this connection is about to get closed and then
502 re-attempted at another connection. */
503 bool tunnel_proxy; /* if CONNECT is used to "tunnel" through the proxy.
504 This is implicit when SSL-protocols are used through
505 proxies, but can also be enabled explicitly by
507 bool authneg; /* TRUE when the auth phase has started, which means
508 that we are creating a request with an auth header,
509 but it is not the final request in the auth
511 bool rewindaftersend;/* TRUE when the sending couldn't be stopped even
512 though it will be discarded. When the whole send
513 operation is done, we must call the data rewind
515 bool ftp_use_epsv; /* As set with CURLOPT_FTP_USE_EPSV, but if we find out
516 EPSV doesn't work we disable it for the forthcoming
519 bool ftp_use_eprt; /* As set with CURLOPT_FTP_USE_EPRT, but if we find out
520 EPRT doesn't work we disable it for the forthcoming
522 bool netrc; /* name+password provided by netrc */
523 bool userpwd_in_url; /* name+password found in url */
524 bool stream_was_rewound; /* Indicates that the stream was rewound after a
525 request read past the end of its response byte
527 bool proxy_connect_closed; /* set true if a proxy disconnected the
528 connection in a CONNECT request with auth, so
529 that libcurl should reconnect and continue. */
530 bool bound; /* set true if bind() has already been done on this socket/
532 bool type_set; /* type= was used in the URL */
533 bool multiplex; /* connection is multiplexed */
537 char *rawalloc; /* allocated "raw" version of the name */
538 char *encalloc; /* allocated IDN-encoded version of the name */
539 char *name; /* name to use internally, might be encoded, might be raw */
540 const char *dispname; /* name to display, as 'name' might be encoded */
544 * Flags on the keepon member of the Curl_transfer_keeper
548 #define KEEP_RECV (1<<0) /* there is or may be data to read */
549 #define KEEP_SEND (1<<1) /* there is or may be data to write */
550 #define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there
551 might still be data to read */
552 #define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there
553 might still be data to write */
554 #define KEEP_RECV_PAUSE (1<<4) /* reading is paused */
555 #define KEEP_SEND_PAUSE (1<<5) /* writing is paused */
557 #define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE)
558 #define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE)
563 ZLIB_UNINIT, /* uninitialized */
564 ZLIB_INIT, /* initialized */
565 ZLIB_GZIP_HEADER, /* reading gzip header */
566 ZLIB_GZIP_INFLATING, /* inflating gzip stream */
567 ZLIB_INIT_GZIP /* initialized in transparent gzip mode */
571 #ifdef CURLRES_ASYNCH
575 struct Curl_dns_entry *dns;
576 bool done; /* set TRUE when the lookup is complete */
577 int status; /* if done is TRUE, this is the status from the callback */
578 void *os_specific; /* 'struct thread_data' for Windows */
582 #define FIRSTSOCKET 0
583 #define SECONDARYSOCKET 1
585 /* These function pointer types are here only to allow easier typecasting
586 within the source when we need to cast between data pointers (such as NULL)
587 and function pointers. */
588 typedef CURLcode (*Curl_do_more_func)(struct connectdata *, int *);
589 typedef CURLcode (*Curl_done_func)(struct connectdata *, CURLcode, bool);
592 EXP100_SEND_DATA, /* enough waiting, just send the body now */
593 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */
594 EXP100_SENDING_REQUEST, /* still sending the request but will wait for
595 the 100 header once done with the request */
596 EXP100_FAILED /* used on 417 Expectation Failed */
600 UPGR101_INIT, /* default state */
601 UPGR101_REQUESTED, /* upgrade requested */
602 UPGR101_RECEIVED, /* response received */
603 UPGR101_WORKING /* talking upgraded protocol */
607 * Request specific data in the easy handle (SessionHandle). Previously,
608 * these members were on the connectdata struct but since a conn struct may
609 * now be shared between different SessionHandles, we store connection-specific
610 * data here. This struct only keeps stuff that's interesting for *this*
611 * request, as it will be cleared between multiple ones
613 struct SingleRequest {
614 curl_off_t size; /* -1 if unknown at this point */
615 curl_off_t *bytecountp; /* return number of bytes read or NULL */
617 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch,
618 -1 means unlimited */
619 curl_off_t *writebytecountp; /* return number of bytes written or NULL */
621 curl_off_t bytecount; /* total number of bytes read */
622 curl_off_t writebytecount; /* number of bytes written */
624 long headerbytecount; /* only count received headers */
625 long deductheadercount; /* this amount of bytes doesn't count when we check
626 if anything has been transferred at the end of a
627 connection. We use this counter to make only a
628 100 reply (without a following second response
629 code) result in a CURLE_GOT_NOTHING error code */
631 struct timeval start; /* transfer started at this time */
632 struct timeval now; /* current time */
633 bool header; /* incoming data has HTTP header */
635 HEADER_NORMAL, /* no bad header at all */
636 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest
638 HEADER_ALLBAD /* all was believed to be header */
639 } badheader; /* the header was deemed bad and will be
641 int headerline; /* counts header lines to better track the
643 char *hbufp; /* points at *end* of header line */
645 char *str; /* within buf */
646 char *str_start; /* within buf */
647 char *end_ptr; /* within buf */
648 char *p; /* within headerbuff */
649 bool content_range; /* set TRUE if Content-Range: was found */
650 curl_off_t offset; /* possible resume offset read from the
651 Content-Range: header */
652 int httpcode; /* error code from the 'HTTP/1.? XXX' or
653 'RTSP/1.? XXX' line */
654 struct timeval start100; /* time stamp to wait for the 100 code from */
655 enum expect100 exp100; /* expect 100 continue state */
656 enum upgrade101 upgr101; /* 101 upgrade state */
658 int auto_decoding; /* What content encoding. sec 3.5, RFC2616. */
660 #define IDENTITY 0 /* No encoding */
661 #define DEFLATE 1 /* zlib deflate [RFC 1950 & 1951] */
662 #define GZIP 2 /* gzip algorithm [RFC 1952] */
665 zlibInitState zlib_init; /* possible zlib init state;
666 undefined if Content-Encoding header. */
667 z_stream z; /* State structure for zlib. */
679 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
680 and we're uploading the last chunk */
682 bool ignorebody; /* we read a response-body but we ignore it! */
683 bool ignorecl; /* This HTTP response has no body so we ignore the Content-
686 char *location; /* This points to an allocated version of the Location:
688 char *newurl; /* Set to the new URL to use when a redirect or a retry is
691 /* 'upload_present' is used to keep a byte counter of how much data there is
692 still left in the buffer, aimed for upload. */
693 ssize_t upload_present;
695 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
696 buffer, so the next read should read from where this pointer points to,
697 and the 'upload_present' contains the number of bytes available at this
699 char *upload_fromhere;
701 bool chunk; /* if set, this is a chunked transfer-encoding */
702 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
704 bool getheader; /* TRUE if header parsing is wanted */
706 bool forbidchunk; /* used only to explicitly forbid chunk-upload for
707 specific upload buffers. See readmoredata() in
708 http.c for details. */
710 void *protop; /* Allocated protocol-specific data. Each protocol
711 handler makes sure this points to data it needs. */
715 * Specific protocol handler.
718 struct Curl_handler {
719 const char * scheme; /* URL scheme name. */
721 /* Complement to setup_connection_internals(). */
722 CURLcode (*setup_connection)(struct connectdata *);
724 /* These two functions MUST be set to be protocol dependent */
725 CURLcode (*do_it)(struct connectdata *, bool *done);
728 /* If the curl_do() function is better made in two halves, this
729 * curl_do_more() function will be called afterwards, if set. For example
730 * for doing the FTP stuff after the PASV/PORT command.
732 Curl_do_more_func do_more;
734 /* This function *MAY* be set to a protocol-dependent function that is run
735 * after the connect() and everything is done, as a step in the connection.
736 * The 'done' pointer points to a bool that should be set to TRUE if the
737 * function completes before return. If it doesn't complete, the caller
738 * should call the curl_connecting() function until it is.
740 CURLcode (*connect_it)(struct connectdata *, bool *done);
742 /* See above. Currently only used for FTP. */
743 CURLcode (*connecting)(struct connectdata *, bool *done);
744 CURLcode (*doing)(struct connectdata *, bool *done);
746 /* Called from the multi interface during the PROTOCONNECT phase, and it
747 should then return a proper fd set */
748 int (*proto_getsock)(struct connectdata *conn,
749 curl_socket_t *socks,
752 /* Called from the multi interface during the DOING phase, and it should
753 then return a proper fd set */
754 int (*doing_getsock)(struct connectdata *conn,
755 curl_socket_t *socks,
758 /* Called from the multi interface during the DO_MORE phase, and it should
759 then return a proper fd set */
760 int (*domore_getsock)(struct connectdata *conn,
761 curl_socket_t *socks,
764 /* Called from the multi interface during the DO_DONE, PERFORM and
765 WAITPERFORM phases, and it should then return a proper fd set. Not setting
766 this will make libcurl use the generic default one. */
767 int (*perform_getsock)(const struct connectdata *conn,
768 curl_socket_t *socks,
771 /* This function *MAY* be set to a protocol-dependent function that is run
772 * by the curl_disconnect(), as a step in the disconnection. If the handler
773 * is called because the connection has been considered dead, dead_connection
776 CURLcode (*disconnect)(struct connectdata *, bool dead_connection);
778 /* If used, this function gets called from transfer.c:readwrite_data() to
779 allow the protocol to do extra reads/writes */
780 CURLcode (*readwrite)(struct SessionHandle *data, struct connectdata *conn,
781 ssize_t *nread, bool *readmore);
783 long defport; /* Default port. */
784 unsigned int protocol; /* See CURLPROTO_* - this needs to be the single
785 specific protocol bit */
786 unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */
789 #define PROTOPT_NONE 0 /* nothing extra */
790 #define PROTOPT_SSL (1<<0) /* uses SSL */
791 #define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */
792 #define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */
793 /* some protocols will have to call the underlying functions without regard to
794 what exact state the socket signals. IE even if the socket says "readable",
795 the send function might need to be called while uploading, or vice versa.
797 #define PROTOPT_DIRLOCK (1<<3)
798 #define PROTOPT_NONETWORK (1<<4) /* protocol doesn't use the network! */
799 #define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it
801 #define PROTOPT_NOURLQUERY (1<<6) /* protocol can't handle
802 url query strings (?foo=bar) ! */
803 #define PROTOPT_CREDSPERREQUEST (1<<7) /* requires login credentials per
804 request instead of per connection */
807 /* return the count of bytes sent, or -1 on error */
808 typedef ssize_t (Curl_send)(struct connectdata *conn, /* connection data */
809 int sockindex, /* socketindex */
810 const void *buf, /* data to write */
811 size_t len, /* max amount to write */
812 CURLcode *err); /* error to return */
814 /* return the count of bytes read, or -1 on error */
815 typedef ssize_t (Curl_recv)(struct connectdata *conn, /* connection data */
816 int sockindex, /* socketindex */
817 char *buf, /* store data here */
818 size_t len, /* max amount to read */
819 CURLcode *err); /* error to return */
822 * The connectdata struct contains all fields and variables that should be
823 * unique for an entire connection.
826 /* 'data' is the CURRENT SessionHandle using this connection -- take great
827 caution that this might very well vary between different times this
828 connection is used! */
829 struct SessionHandle *data;
831 /* chunk is for HTTP chunked encoding, but is in the general connectdata
832 struct only because we can do just about any protocol through a HTTP proxy
833 and a HTTP proxy may in fact respond using chunked encoding */
834 struct Curl_chunker chunk;
836 curl_closesocket_callback fclosesocket; /* function closing the socket(s) */
837 void *closesocket_client;
839 bool inuse; /* This is a marker for the connection cache logic. If this is
840 TRUE this handle is being used by an easy handle and cannot
841 be used by any other easy handle without careful
842 consideration (== only for pipelining). */
844 /**** Fields set when inited and not modified again */
845 long connection_id; /* Contains a unique number to make it easier to
846 track the connections in the log output */
848 /* 'dns_entry' is the particular host we use. This points to an entry in the
849 DNS cache and it will not get pruned while locked. It gets unlocked in
850 Curl_done(). This entry will be NULL if the connection is re-used as then
851 there is no name resolve done. */
852 struct Curl_dns_entry *dns_entry;
854 /* 'ip_addr' is the particular IP we connected to. It points to a struct
855 within the DNS cache, so this pointer is only valid as long as the DNS
856 cache entry remains locked. It gets unlocked in Curl_done() */
857 Curl_addrinfo *ip_addr;
858 Curl_addrinfo *tempaddr[2]; /* for happy eyeballs */
860 /* 'ip_addr_str' is the ip_addr data as a human readable string.
861 It remains available as long as the connection does, which is longer than
862 the ip_addr itself. */
863 char ip_addr_str[MAX_IPADR_LEN];
865 unsigned int scope_id; /* Scope id for IPv6 */
867 int socktype; /* SOCK_STREAM or SOCK_DGRAM */
869 struct hostname host;
870 struct hostname proxy;
872 long port; /* which port to use locally */
873 int remote_port; /* what remote port to connect to, not the proxy port! */
875 /* 'primary_ip' and 'primary_port' get filled with peer's numerical
876 ip address and port number whenever an outgoing connection is
877 *attempted* from the primary socket to a remote address. When more
878 than one address is tried for a connection these will hold data
879 for the last attempt. When the connection is actually established
880 these are updated with data which comes directly from the socket. */
882 char primary_ip[MAX_IPADR_LEN];
885 /* 'local_ip' and 'local_port' get filled with local's numerical
886 ip address and port number whenever an outgoing connection is
887 **established** from the primary socket to a remote address. */
889 char local_ip[MAX_IPADR_LEN];
892 char *user; /* user name string, allocated */
893 char *passwd; /* password string, allocated */
894 char *options; /* options string, allocated */
896 char *xoauth2_bearer; /* bearer token for xoauth2, allocated */
898 char *proxyuser; /* proxy user name string, allocated */
899 char *proxypasswd; /* proxy password string, allocated */
900 curl_proxytype proxytype; /* what kind of proxy that is in use */
902 int httpversion; /* the HTTP version*10 reported by the server */
903 int rtspversion; /* the RTSP version*10 reported by the server */
905 struct timeval now; /* "current" time */
906 struct timeval created; /* creation time */
907 curl_socket_t sock[2]; /* two sockets, the second is used for the data
908 transfer when doing FTP */
909 curl_socket_t tempsock[2]; /* temporary sockets for happy eyeballs */
910 bool sock_accepted[2]; /* TRUE if the socket on this index was created with
915 struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */
916 struct ssl_config_data ssl_config;
918 struct ConnectBits bits; /* various state-flags for this connection */
920 /* connecttime: when connect() is called on the current IP address. Used to
921 be able to track when to move on to try next IP - but only when the multi
922 interface is used. */
923 struct timeval connecttime;
924 /* The two fields below get set in Curl_connecthost */
925 int num_addr; /* number of addresses to try to connect to */
926 long timeoutms_per_addr; /* how long time in milliseconds to spend on
927 trying to connect to each IP address */
929 const struct Curl_handler *handler; /* Connection's protocol handler */
930 const struct Curl_handler *given; /* The protocol first given */
932 long ip_version; /* copied from the SessionHandle at creation time */
934 /**** curl_get() phase fields */
936 curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */
937 curl_socket_t writesockfd; /* socket to write to, it may very
938 well be the same we read from.
939 CURL_SOCKET_BAD disables */
941 /** Dynamicly allocated strings, MUST be freed before this **/
942 /** struct is killed. **/
943 struct dynamically_allocated_data {
946 char *accept_encoding;
952 char *rtsp_transport;
953 char *te; /* TE: request header */
957 int sec_complete; /* if Kerberos is enabled for this connection */
958 enum protection_level command_prot;
959 enum protection_level data_prot;
960 enum protection_level request_data_prot;
962 struct krb5buffer in_buffer;
964 const struct Curl_sec_client_mech *mech;
965 struct sockaddr_in local_addr;
968 #if defined(USE_KERBEROS5) /* Consider moving some of the above GSS-API */
969 struct kerberos5data krb5; /* variables into the structure definition, */
970 #endif /* however, some of them are ftp specific. */
972 /* the two following *_inuse fields are only flags, not counters in any way.
973 If TRUE it means the channel is in use, and if FALSE it means the channel
974 is up for grabs by one. */
976 bool readchannel_inuse; /* whether the read channel is in use by an easy
978 bool writechannel_inuse; /* whether the write channel is in use by an easy
980 struct curl_llist *send_pipe; /* List of handles waiting to
981 send on this pipeline */
982 struct curl_llist *recv_pipe; /* List of handles waiting to read
983 their responses on this pipeline */
984 char* master_buffer; /* The master buffer allocated on-demand;
985 used for pipelining. */
986 size_t read_pos; /* Current read position in the master buffer */
987 size_t buf_len; /* Length of the buffer?? */
990 curl_seek_callback seek_func; /* function that seeks the input */
991 void *seek_client; /* pointer to pass to the seek() above */
993 /*************** Request - specific items ************/
995 #if defined(USE_NTLM)
996 struct ntlmdata ntlm; /* NTLM differs from other authentication schemes
997 because it authenticates connections, not
999 struct ntlmdata proxyntlm; /* NTLM data for proxy */
1001 #if defined(NTLM_WB_ENABLED)
1002 /* used for communication with Samba's winbind daemon helper ntlm_auth */
1003 curl_socket_t ntlm_auth_hlpr_socket;
1004 pid_t ntlm_auth_hlpr_pid;
1005 char* challenge_header;
1006 char* response_header;
1010 char syserr_buf [256]; /* buffer for Curl_strerror() */
1012 #ifdef CURLRES_ASYNCH
1013 /* data used for the asynch name resolve callback */
1014 struct Curl_async async;
1017 /* These three are used for chunked-encoding trailer support */
1018 char *trailer; /* allocated buffer to store trailer in */
1019 int trlMax; /* allocated buffer size */
1020 int trlPos; /* index of where to store data */
1023 struct ftp_conn ftpc;
1024 struct http_conn httpc;
1025 struct ssh_conn sshc;
1026 struct tftp_state_data *tftpc;
1027 struct imap_conn imapc;
1028 struct pop3_conn pop3c;
1029 struct smtp_conn smtpc;
1030 struct rtsp_conn rtspc;
1031 struct smb_conn smbc;
1032 void *generic; /* RTMP and LDAP use this */
1035 int cselect_bits; /* bitmask of socket events */
1036 int waitfor; /* current READ/WRITE bits to wait for */
1038 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1039 int socks5_gssapi_enctype;
1045 /* When this connection is created, store the conditions for the local end
1046 bind. This is stored before the actual bind and before any connection is
1047 made and will serve the purpose of being used for comparison reasons so
1048 that subsequent bound-requested connections aren't accidentally re-using
1049 wrong connections. */
1051 unsigned short localport;
1054 /* tunnel as in tunnel through a HTTP proxy with CONNECT */
1056 TUNNEL_INIT, /* init/default/no tunnel state */
1057 TUNNEL_CONNECT, /* CONNECT has been sent off */
1058 TUNNEL_COMPLETE /* CONNECT response received completely */
1059 } tunnel_state[2]; /* two separate ones to allow FTP */
1060 struct connectbundle *bundle; /* The bundle we are member of */
1062 int negnpn; /* APLN or NPN TLS negotiated protocol, CURL_HTTP_VERSION* */
1065 /* The end of connectdata. */
1068 * Struct to keep statistical and informational data.
1071 int httpcode; /* Recent HTTP, FTP, or RTSP response code */
1072 int httpproxycode; /* response code from proxy when received separate */
1073 int httpversion; /* the http version number X.Y = X*10+Y */
1074 long filetime; /* If requested, this is might get set. Set to -1 if the time
1075 was unretrievable. We cannot have this of type time_t,
1076 since time_t is unsigned on several platforms such as
1078 bool timecond; /* set to TRUE if the time condition didn't match, which
1079 thus made the document NOT get fetched */
1080 long header_size; /* size of read header(s) in bytes */
1081 long request_size; /* the amount of bytes sent in the request(s) */
1082 unsigned long proxyauthavail; /* what proxy auth types were announced */
1083 unsigned long httpauthavail; /* what host auth types were announced */
1084 long numconnects; /* how many new connection did libcurl created */
1085 char *contenttype; /* the content type of the object */
1086 char *wouldredirect; /* URL this would've been redirected to if asked to */
1088 /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip'
1089 and, 'conn_local_port' are copied over from the connectdata struct in
1090 order to allow curl_easy_getinfo() to return this information even when
1091 the session handle is no longer associated with a connection, and also
1092 allow curl_easy_reset() to clear this information from the session handle
1093 without disturbing information which is still alive, and that might be
1094 reused, in the connection cache. */
1096 char conn_primary_ip[MAX_IPADR_LEN];
1097 long conn_primary_port;
1099 char conn_local_ip[MAX_IPADR_LEN];
1100 long conn_local_port;
1102 struct curl_certinfo certs; /* info about the certs, only populated in
1103 OpenSSL builds. Asked for with
1104 CURLOPT_CERTINFO / CURLINFO_CERTINFO */
1109 long lastshow; /* time() of the last displayed progress meter or NULL to
1110 force redraw at next call */
1111 curl_off_t size_dl; /* total expected size */
1112 curl_off_t size_ul; /* total expected size */
1113 curl_off_t downloaded; /* transferred so far */
1114 curl_off_t uploaded; /* transferred so far */
1116 curl_off_t current_speed; /* uses the currently fastest transfer */
1118 bool callback; /* set when progress callback is used */
1119 int width; /* screen width at download start */
1120 int flags; /* see progress.h */
1129 double t_appconnect;
1130 double t_pretransfer;
1131 double t_starttransfer;
1134 struct timeval start;
1135 struct timeval t_startsingle;
1136 struct timeval t_startop;
1137 struct timeval t_acceptdata;
1138 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
1140 curl_off_t speeder[ CURR_TIME ];
1141 struct timeval speeder_time[ CURR_TIME ];
1146 HTTPREQ_NONE, /* first in list */
1149 HTTPREQ_POST_FORM, /* we make a difference internally */
1153 HTTPREQ_LAST /* last in list */
1157 RTSPREQ_NONE, /* first in list */
1165 RTSPREQ_GET_PARAMETER,
1166 RTSPREQ_SET_PARAMETER,
1169 RTSPREQ_LAST /* last in list */
1173 * Values that are generated, temporary or calculated internally for a
1174 * "session handle" must be defined within the 'struct UrlState'. This struct
1175 * will be used within the SessionHandle struct. When the 'SessionHandle'
1176 * struct is cloned, this data MUST NOT be copied.
1178 * Remember that any "state" information goes globally for the curl handle.
1179 * Session-data MUST be put in the connectdata struct and here. */
1180 #define MAX_CURL_USER_LENGTH 256
1181 #define MAX_CURL_PASSWORD_LENGTH 256
1184 unsigned long want; /* Bitmask set to the authentication methods wanted by
1185 app (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */
1186 unsigned long picked;
1187 unsigned long avail; /* Bitmask for what the server reports to support for
1189 bool done; /* TRUE when the auth phase is done and ready to do the *actual*
1191 bool multi; /* TRUE if this is not yet authenticated but within the auth
1192 multipass negotiation */
1193 bool iestyle; /* TRUE if digest should be done IE-style or FALSE if it should
1199 /* Points to the connection cache */
1200 struct conncache *conn_cache;
1202 /* when curl_easy_perform() is called, the multi handle is "owned" by
1203 the easy handle so curl_easy_cleanup() on such an easy handle will
1204 also close the multi handle! */
1205 bool multi_owned_by_easy;
1207 /* buffers to store authentication data in, as parsed from input options */
1208 struct timeval keeps_speed; /* for the progress meter really */
1210 struct connectdata *lastconnect; /* The last connection, NULL if undefined */
1212 char *headerbuff; /* allocated buffer to store headers in */
1213 size_t headersize; /* size of the allocation */
1215 char buffer[BUFSIZE+1]; /* download buffer */
1216 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
1217 curl_off_t current_speed; /* the ProgressShow() funcion sets this,
1219 bool this_is_a_follow; /* this is a followed Location: request */
1221 char *first_host; /* if set, this should be the host name that we will
1222 sent authorization to, no else. Used to make Location:
1223 following not keep sending user+password... This is
1226 struct curl_ssl_session *session; /* array of 'max_ssl_sessions' size */
1227 long sessionage; /* number of the most recent session */
1228 char *tempwrite; /* allocated buffer to keep data in when a write
1229 callback returns to make the connection paused */
1230 size_t tempwritesize; /* size of the 'tempwrite' allocated buffer */
1231 int tempwritetype; /* type of the 'tempwrite' buffer as a bitmask that is
1232 used with Curl_client_write() */
1233 char *scratch; /* huge buffer[BUFSIZE*2] when doing upload CRLF replacing */
1234 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
1235 This must be set to FALSE every time _easy_perform() is
1237 int os_errno; /* filled in with errno whenever an error occurs */
1239 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
1240 void (*prev_signal)(int sig);
1242 bool allow_port; /* Is set.use_port allowed to take effect or not. This
1243 is always set TRUE when curl_easy_perform() is called. */
1244 struct digestdata digest; /* state data for host Digest auth */
1245 struct digestdata proxydigest; /* state data for proxy Digest auth */
1248 struct negotiatedata negotiate; /* state data for host Negotiate auth */
1249 struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */
1252 struct auth authhost; /* auth details for host */
1253 struct auth authproxy; /* auth details for proxy */
1255 bool authproblem; /* TRUE if there's some problem authenticating */
1257 void *resolver; /* resolver state, if it is used in the URL state -
1258 ares_channel f.e. */
1260 #if defined(USE_OPENSSL) && defined(HAVE_OPENSSL_ENGINE_H)
1262 #endif /* USE_OPENSSL */
1263 struct timeval expiretime; /* set this with Curl_expire() only */
1264 struct Curl_tree timenode; /* for the splay stuff */
1265 struct curl_llist *timeoutlist; /* list of pending timeouts */
1267 /* a place to store the most recently set FTP entrypath */
1268 char *most_recent_ftp_entrypath;
1270 /* set after initial USER failure, to prevent an authentication loop */
1271 bool ftp_trying_alternative;
1273 int httpversion; /* the lowest HTTP version*10 reported by any server
1274 involved in this request */
1275 bool expect100header; /* TRUE if we added Expect: 100-continue */
1277 bool pipe_broke; /* TRUE if the connection we were pipelined on broke
1278 and we need to restart from the beginning */
1280 #if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) && \
1281 !defined(__SYMBIAN32__)
1282 /* do FTP line-end conversions on most platforms */
1283 #define CURL_DO_LINEEND_CONV
1284 /* for FTP downloads: track CRLF sequences that span blocks */
1285 bool prev_block_had_trailing_cr;
1286 /* for FTP downloads: how many CRLFs did we converted to LFs? */
1287 curl_off_t crlf_conversions;
1289 char *pathbuffer;/* allocated buffer to store the URL's path part in */
1290 char *path; /* path to use, points to somewhere within the pathbuffer
1292 bool slash_removed; /* set TRUE if the 'path' points to a path where the
1293 initial URL slash separator has been taken off */
1295 bool rangestringalloc; /* the range string is malloc()'ed */
1297 char *range; /* range, if used. See README for detailed specification on
1299 curl_off_t resume_from; /* continue [ftp] transfer from here */
1301 /* This RTSP state information survives requests and connections */
1302 long rtsp_next_client_CSeq; /* the session's next client CSeq */
1303 long rtsp_next_server_CSeq; /* the session's next server CSeq */
1304 long rtsp_CSeq_recv; /* most recent CSeq received */
1306 curl_off_t infilesize; /* size of file to upload, -1 means unknown.
1307 Copied from set.filesize at start of operation */
1309 int drain; /* Increased when this stream has data to read, even if its
1310 socket not necessarily is readable. Decreased when
1312 bool done; /* set to FALSE when Curl_do() is called and set to TRUE when
1313 Curl_done() is called, to prevent Curl_done() to get invoked
1314 twice when the multi interface is used. */
1319 * This 'DynamicStatic' struct defines dynamic states that actually change
1320 * values in the 'UserDefined' area, which MUST be taken into consideration
1321 * if the UserDefined struct is cloned or similar. You can probably just
1322 * copy these, but each one indicate a special action on other data.
1325 struct DynamicStatic {
1326 char *url; /* work URL, copied from UserDefined */
1327 bool url_alloc; /* URL string is malloc()'ed */
1328 char *referer; /* referer string */
1329 bool referer_alloc; /* referer sting is malloc()ed */
1330 struct curl_slist *cookielist; /* list of cookie files set by
1331 curl_easy_setopt(COOKIEFILE) calls */
1332 struct curl_slist *resolve; /* set to point to the set.resolve list when
1333 this should be dealt with in pretransfer */
1337 * This 'UserDefined' struct must only contain data that is set once to go
1338 * for many (perhaps) independent connections. Values that are generated or
1339 * calculated internally for the "session handle" MUST be defined within the
1340 * 'struct UrlState' instead. The only exceptions MUST note the changes in
1341 * the 'DynamicStatic' struct.
1342 * Character pointer fields point to dynamic storage, unless otherwise stated.
1345 struct Curl_multi; /* declared and used only in multi.c */
1348 STRING_CERT, /* client certificate file name */
1349 STRING_CERT_TYPE, /* format for certificate (default: PEM)*/
1350 STRING_COOKIE, /* HTTP cookie string to send */
1351 STRING_COOKIEJAR, /* dump all cookies to this file */
1352 STRING_CUSTOMREQUEST, /* HTTP/FTP/RTSP request/method to use */
1353 STRING_DEVICE, /* local network interface/address to use */
1354 STRING_ENCODING, /* Accept-Encoding string */
1355 STRING_FTP_ACCOUNT, /* ftp account data */
1356 STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */
1357 STRING_FTPPORT, /* port to send with the FTP PORT command */
1358 STRING_KEY, /* private key file name */
1359 STRING_KEY_PASSWD, /* plain text private key password */
1360 STRING_KEY_TYPE, /* format for private key (default: PEM) */
1361 STRING_KRB_LEVEL, /* krb security level */
1362 STRING_NETRC_FILE, /* if not NULL, use this instead of trying to find
1364 STRING_PROXY, /* proxy to use */
1365 STRING_SET_RANGE, /* range, if used */
1366 STRING_SET_REFERER, /* custom string for the HTTP referer field */
1367 STRING_SET_URL, /* what original URL to work on */
1368 STRING_SSL_CAPATH, /* CA directory name (doesn't work on windows) */
1369 STRING_SSL_CAFILE, /* certificate file to verify peer against */
1370 STRING_SSL_PINNEDPUBLICKEY, /* public key file to verify peer against */
1371 STRING_SSL_CIPHER_LIST, /* list of ciphers to use */
1372 STRING_SSL_EGDSOCKET, /* path to file containing the EGD daemon socket */
1373 STRING_SSL_RANDOM_FILE, /* path to file containing "random" data */
1374 STRING_USERAGENT, /* User-Agent string */
1375 STRING_SSL_CRLFILE, /* crl file to check certificate */
1376 STRING_SSL_ISSUERCERT, /* issuer cert file to check certificate */
1377 STRING_USERNAME, /* <username>, if used */
1378 STRING_PASSWORD, /* <password>, if used */
1379 STRING_OPTIONS, /* <options>, if used */
1380 STRING_PROXYUSERNAME, /* Proxy <username>, if used */
1381 STRING_PROXYPASSWORD, /* Proxy <password>, if used */
1382 STRING_NOPROXY, /* List of hosts which should not use the proxy, if
1384 STRING_RTSP_SESSION_ID, /* Session ID to use */
1385 STRING_RTSP_STREAM_URI, /* Stream URI for this request */
1386 STRING_RTSP_TRANSPORT, /* Transport for this session */
1388 STRING_SSH_PRIVATE_KEY, /* path to the private key file for auth */
1389 STRING_SSH_PUBLIC_KEY, /* path to the public key file for auth */
1390 STRING_SSH_HOST_PUBLIC_KEY_MD5, /* md5 of host public key in ascii hex */
1391 STRING_SSH_KNOWNHOSTS, /* file name of knownhosts file */
1393 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1394 STRING_SOCKS5_GSSAPI_SERVICE, /* GSSAPI service name */
1395 STRING_PROXY_SERVICE_NAME, /* Proxy service name */
1396 STRING_SERVICE_NAME, /* Service name */
1402 STRING_TLSAUTH_USERNAME, /* TLS auth <username> */
1403 STRING_TLSAUTH_PASSWORD, /* TLS auth <password> */
1405 STRING_BEARER, /* <bearer>, if used */
1406 #ifdef USE_UNIX_SOCKETS
1407 STRING_UNIX_SOCKET_PATH, /* path to Unix socket, if used */
1410 /* -- end of zero-terminated strings -- */
1412 STRING_LASTZEROTERMINATED,
1414 /* -- below this are pointers to binary data that cannot be strdup'ed.
1415 Each such pointer must be added manually to Curl_dupset() --- */
1417 STRING_COPYPOSTFIELDS, /* if POST, set the fields' values here */
1419 STRING_LAST /* not used, just an end-of-list marker */
1422 struct UserDefined {
1423 FILE *err; /* the stderr user data goes here */
1424 void *debugdata; /* the data that will be passed to fdebug */
1425 char *errorbuffer; /* (Static) store failure messages in here */
1426 long proxyport; /* If non-zero, use this port number by default. If the
1427 proxy string features a ":[port]" that one will override
1429 void *out; /* CURLOPT_WRITEDATA */
1430 void *in; /* CURLOPT_READDATA */
1431 void *writeheader; /* write the header to this if non-NULL */
1432 void *rtp_out; /* write RTP to this if non-NULL */
1433 long use_port; /* which port to use (when not using default) */
1434 unsigned long httpauth; /* kind of HTTP authentication to use (bitmask) */
1435 unsigned long proxyauth; /* kind of proxy authentication to use (bitmask) */
1436 long followlocation; /* as in HTTP Location: */
1437 long maxredirs; /* maximum no. of http(s) redirects to follow, set to -1
1440 int keep_post; /* keep POSTs as POSTs after a 30x request; each
1441 bit represents a request, from 301 to 303 */
1442 bool free_referer; /* set TRUE if 'referer' points to a string we
1444 void *postfields; /* if POST, set the fields' values here */
1445 curl_seek_callback seek_func; /* function that seeks the input */
1446 curl_off_t postfieldsize; /* if POST, this might have a size to use instead
1447 of strlen(), and then the data *may* be binary
1448 (contain zero bytes) */
1449 unsigned short localport; /* local port number to bind to */
1450 int localportrange; /* number of additional port numbers to test in case the
1451 'localport' one can't be bind()ed */
1452 curl_write_callback fwrite_func; /* function that stores the output */
1453 curl_write_callback fwrite_header; /* function that stores headers */
1454 curl_write_callback fwrite_rtp; /* function that stores interleaved RTP */
1455 curl_read_callback fread_func; /* function that reads the input */
1456 int is_fread_set; /* boolean, has read callback been set to non-NULL? */
1457 int is_fwrite_set; /* boolean, has write callback been set to non-NULL? */
1458 curl_progress_callback fprogress; /* OLD and deprecated progress callback */
1459 curl_xferinfo_callback fxferinfo; /* progress callback */
1460 curl_debug_callback fdebug; /* function that write informational data */
1461 curl_ioctl_callback ioctl_func; /* function for I/O control */
1462 curl_sockopt_callback fsockopt; /* function for setting socket options */
1463 void *sockopt_client; /* pointer to pass to the socket options callback */
1464 curl_opensocket_callback fopensocket; /* function for checking/translating
1465 the address and opening the
1467 void* opensocket_client;
1468 curl_closesocket_callback fclosesocket; /* function for closing the
1470 void* closesocket_client;
1472 void *seek_client; /* pointer to pass to the seek callback */
1473 /* the 3 curl_conv_callback functions below are used on non-ASCII hosts */
1474 /* function to convert from the network encoding: */
1475 curl_conv_callback convfromnetwork;
1476 /* function to convert to the network encoding: */
1477 curl_conv_callback convtonetwork;
1478 /* function to convert from UTF-8 encoding: */
1479 curl_conv_callback convfromutf8;
1481 void *progress_client; /* pointer to pass to the progress callback */
1482 void *ioctl_client; /* pointer to pass to the ioctl callback */
1483 long timeout; /* in milliseconds, 0 means no timeout */
1484 long connecttimeout; /* in milliseconds, 0 means no timeout */
1485 long accepttimeout; /* in milliseconds, 0 means no timeout */
1486 long server_response_timeout; /* in milliseconds, 0 means no timeout */
1487 long tftp_blksize ; /* in bytes, 0 means use default */
1488 curl_off_t filesize; /* size of file to upload, -1 means unknown */
1489 long low_speed_limit; /* bytes/second */
1490 long low_speed_time; /* number of seconds */
1491 curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */
1492 curl_off_t max_recv_speed; /* high speed limit in bytes/second for
1494 curl_off_t set_resume_from; /* continue [ftp] transfer from here */
1495 struct curl_slist *headers; /* linked list of extra headers */
1496 struct curl_slist *proxyheaders; /* linked list of extra CONNECT headers */
1497 struct curl_httppost *httppost; /* linked list of POST data */
1498 bool sep_headers; /* handle host and proxy headers separately */
1499 bool cookiesession; /* new cookie session? */
1500 bool crlf; /* convert crlf on ftp upload(?) */
1501 struct curl_slist *quote; /* after connection is established */
1502 struct curl_slist *postquote; /* after the transfer */
1503 struct curl_slist *prequote; /* before the transfer, after type */
1504 struct curl_slist *source_quote; /* 3rd party quote */
1505 struct curl_slist *source_prequote; /* in 3rd party transfer mode - before
1506 the transfer on source host */
1507 struct curl_slist *source_postquote; /* in 3rd party transfer mode - after
1508 the transfer on source host */
1509 struct curl_slist *telnet_options; /* linked list of telnet options */
1510 struct curl_slist *resolve; /* list of names to add/remove from
1512 curl_TimeCond timecondition; /* kind of time/date comparison */
1513 time_t timevalue; /* what time to compare with */
1514 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
1515 long httpversion; /* when non-zero, a specific HTTP version requested to
1516 be used in the library's request(s) */
1517 struct ssl_config_data ssl; /* user defined SSL stuff */
1518 curl_proxytype proxytype; /* what kind of proxy that is in use */
1519 long dns_cache_timeout; /* DNS cache timeout */
1520 long buffer_size; /* size of receive buffer to use */
1521 void *private_data; /* application-private data */
1523 struct curl_slist *http200aliases; /* linked list of aliases for http200 */
1525 long ipver; /* the CURL_IPRESOLVE_* defines in the public header file
1526 0 - whatever, 1 - v2, 2 - v6 */
1528 curl_off_t max_filesize; /* Maximum file size to download */
1530 curl_ftpfile ftp_filemethod; /* how to get to a file when FTP is used */
1532 int ftp_create_missing_dirs; /* 1 - create directories that don't exist
1533 2 - the same but also allow MKD to fail once
1536 curl_sshkeycallback ssh_keyfunc; /* key matching callback */
1537 void *ssh_keyfunc_userp; /* custom pointer to callback */
1539 /* Here follows boolean settings that define how to behave during
1540 this session. They are STATIC, set by libcurl users or at least initially
1541 and they don't change during operations. */
1543 bool printhost; /* printing host name in debug info */
1544 bool get_filetime; /* get the time and get of the remote file */
1545 bool tunnel_thru_httpproxy; /* use CONNECT through a HTTP proxy */
1546 bool prefer_ascii; /* ASCII rather than binary */
1547 bool ftp_append; /* append, not overwrite, on upload */
1548 bool ftp_list_only; /* switch FTP command for listing directories */
1549 bool ftp_use_port; /* use the FTP PORT command */
1550 bool hide_progress; /* don't use the progress meter */
1551 bool http_fail_on_error; /* fail on HTTP error codes >= 400 */
1552 bool http_follow_location; /* follow HTTP redirects */
1553 bool http_transfer_encoding; /* request compressed HTTP transfer-encoding */
1554 bool http_disable_hostname_check_before_authentication;
1555 bool include_header; /* include received protocol headers in data output */
1556 bool http_set_referer; /* is a custom referer used */
1557 bool http_auto_referer; /* set "correct" referer when following location: */
1558 bool opt_no_body; /* as set with CURLOPT_NOBODY */
1559 bool set_port; /* custom port number used */
1560 bool upload; /* upload request */
1561 enum CURL_NETRC_OPTION
1562 use_netrc; /* defined in include/curl.h */
1563 bool verbose; /* output verbosity */
1564 bool krb; /* Kerberos connection requested */
1565 bool reuse_forbid; /* forbidden to be reused, close after use */
1566 bool reuse_fresh; /* do not re-use an existing connection */
1567 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
1568 bool ftp_use_eprt; /* if EPRT is to be attempted or not */
1569 bool ftp_use_pret; /* if PRET is to be used before PASV or not */
1571 curl_usessl use_ssl; /* if AUTH TLS is to be attempted etc, for FTP or
1572 IMAP or POP3 or others! */
1573 curl_ftpauth ftpsslauth; /* what AUTH XXX to be attempted */
1574 curl_ftpccc ftp_ccc; /* FTP CCC options */
1575 bool no_signal; /* do not use any signal/alarm handler */
1576 bool global_dns_cache; /* subject for future removal */
1577 bool tcp_nodelay; /* whether to enable TCP_NODELAY or not */
1578 bool ignorecl; /* ignore content length */
1579 bool ftp_skip_ip; /* skip the IP address the FTP server passes on to
1581 bool connect_only; /* make connection, let application use the socket */
1582 bool ssl_enable_beast; /* especially allow this flaw for interoperability's
1584 bool ssl_no_revoke; /* disable SSL certificate revocation checks */
1585 long ssh_auth_types; /* allowed SSH auth types */
1586 bool http_te_skip; /* pass the raw body data to the user, even when
1587 transfer-encoded (chunked, compressed) */
1588 bool http_ce_skip; /* pass the raw body data to the user, even when
1589 content-encoded (chunked, compressed) */
1590 long new_file_perms; /* Permissions to use when creating remote files */
1591 long new_directory_perms; /* Permissions to use when creating remote dirs */
1592 bool proxy_transfer_mode; /* set transfer mode (;type=<a|i>) when doing FTP
1593 via an HTTP proxy */
1594 char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */
1595 unsigned int scope_id; /* Scope id for IPv6 */
1596 long allowed_protocols;
1597 long redir_protocols;
1598 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1599 long socks5_gssapi_nec; /* flag to support nec socks5 server */
1601 struct curl_slist *mail_rcpt; /* linked list of mail recipients */
1602 bool sasl_ir; /* Enable/disable SASL initial response */
1603 /* Common RTSP header options */
1604 Curl_RtspReq rtspreq; /* RTSP request type */
1605 long rtspversion; /* like httpversion, for RTSP */
1606 bool wildcardmatch; /* enable wildcard matching */
1607 curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer
1609 curl_chunk_end_callback chunk_end; /* called after part transferring
1611 curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds
1612 to pattern (e.g. if WILDCARDMATCH is on) */
1615 long gssapi_delegation; /* GSS-API credential delegation, see the
1616 documentation of CURLOPT_GSSAPI_DELEGATION */
1618 bool tcp_keepalive; /* use TCP keepalives */
1619 long tcp_keepidle; /* seconds in idle before sending keepalive probe */
1620 long tcp_keepintvl; /* seconds between TCP keepalive probes */
1622 size_t maxconnects; /* Max idle connections in the connection cache */
1624 bool ssl_enable_npn; /* TLS NPN extension? */
1625 bool ssl_enable_alpn; /* TLS ALPN extension? */
1626 bool path_as_is; /* allow dotdots? */
1627 bool pipewait; /* wait for pipe/multiplex status before starting a
1629 long expect_100_timeout; /* in milliseconds */
1633 struct curl_hash *hostcache;
1635 HCACHE_NONE, /* not pointing to anything */
1636 HCACHE_GLOBAL, /* points to the (shrug) global one */
1637 HCACHE_MULTI, /* points to a shared one in the multi handle */
1638 HCACHE_SHARED /* points to a shared one in a shared object */
1643 * The 'connectdata' struct MUST have all the connection oriented stuff as we
1644 * may have several simultaneous connections and connection structs in memory.
1646 * The 'struct UserDefined' must only contain data that is set once to go for
1647 * many (perhaps) independent connections. Values that are generated or
1648 * calculated internally for the "session handle" must be defined within the
1649 * 'struct UrlState' instead.
1652 struct SessionHandle {
1653 /* first, two fields for the linked list of these */
1654 struct SessionHandle *next;
1655 struct SessionHandle *prev;
1657 struct connectdata *easy_conn; /* the "unit's" connection */
1659 CURLMstate mstate; /* the handle's state */
1660 CURLcode result; /* previous result */
1662 struct Curl_message msg; /* A single posted message. */
1664 /* Array with the plain socket numbers this handle takes care of, in no
1665 particular order. Note that all sockets are added to the sockhash, where
1666 the state etc are also kept. This array is mostly used to detect when a
1667 socket is to be removed from the hash. See singlesocket(). */
1668 curl_socket_t sockets[MAX_SOCKSPEREASYHANDLE];
1672 struct Curl_multi *multi; /* if non-NULL, points to the multi handle
1673 struct to which this "belongs" when used by
1674 the multi interface */
1675 struct Curl_multi *multi_easy; /* if non-NULL, points to the multi handle
1676 struct to which this "belongs" when used
1677 by the easy interface */
1678 struct Curl_share *share; /* Share, handles global variable mutexing */
1679 struct SingleRequest req; /* Request-specific data */
1680 struct UserDefined set; /* values set by the libcurl user */
1681 struct DynamicStatic change; /* possibly modified userdefined data */
1682 struct CookieInfo *cookies; /* the cookies, read from files and servers.
1683 NOTE that the 'cookie' field in the
1684 UserDefined struct defines if the "engine"
1685 is to be used or not. */
1686 struct Progress progress; /* for all the progress meter data */
1687 struct UrlState state; /* struct for fields used for state info and
1688 other dynamic purposes */
1689 struct WildcardData wildcard; /* wildcard download state info */
1690 struct PureInfo info; /* stats, reports and info data */
1691 struct curl_tlssessioninfo tsi; /* Information about the TLS session, only
1692 valid after a client has asked for it */
1693 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
1694 iconv_t outbound_cd; /* for translating to the network encoding */
1695 iconv_t inbound_cd; /* for translating from the network encoding */
1696 iconv_t utf8_cd; /* for translating to UTF8 */
1697 #endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */
1698 unsigned int magic; /* set to a CURLEASY_MAGIC_NUMBER */
1701 #define LIBCURL_NAME "libcurl"
1703 #endif /* HEADER_CURL_URLDATA_H */
projects / platform / upstream / curl.git / blob