1 #ifndef HEADER_CURL_URLDATA_H
2 #define HEADER_CURL_URLDATA_H
3 /***************************************************************************
5 * Project ___| | | | _ \| |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 1998 - 2016, 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 https://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>
98 #include <mbedtls/ssl.h>
99 #include <mbedtls/version.h>
100 #include <mbedtls/entropy.h>
101 #include <mbedtls/ctr_drbg.h>
103 #elif defined USE_POLARSSL
105 #include <polarssl/ssl.h>
106 #include <polarssl/version.h>
107 #if POLARSSL_VERSION_NUMBER<0x01010000
108 #include <polarssl/havege.h>
110 #include <polarssl/entropy.h>
111 #include <polarssl/ctr_drbg.h>
112 #endif /* POLARSSL_VERSION_NUMBER<0x01010000 */
114 #endif /* USE_POLARSSL */
117 #undef OCSP_REQUEST /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */
118 #undef OCSP_RESPONSE /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */
119 #include <cyassl/openssl/ssl.h>
132 #include <axTLS/config.h>
133 #include <axTLS/ssl.h>
137 #endif /* USE_AXTLS */
140 #include "curl_sspi.h"
142 #include <schannel.h>
146 #include <Security/Security.h>
147 /* For some reason, when building for iOS, the omnibus header above does
148 * not include SecureTransport.h as of iOS SDK 5.1. */
149 #include <Security/SecureTransport.h>
152 #ifdef HAVE_NETINET_IN_H
153 #include <netinet/in.h>
159 #include <zlib.h> /* for content-encoding */
161 /* zlib pollutes the namespace with this definition */
166 #include <curl/curl.h>
168 #include "http_chunks.h" /* for the structs and enum stuff */
182 #include "wildcard.h"
183 #include "multihandle.h"
188 # elif defined HAVE_GSSMIT
189 # include <gssapi/gssapi.h>
190 # include <gssapi/gssapi_generic.h>
196 #ifdef HAVE_LIBSSH2_H
198 #include <libssh2_sftp.h>
199 #endif /* HAVE_LIBSSH2_H */
201 /* Download buffer size, keep it fairly big for speed reasons */
203 #define BUFSIZE CURL_MAX_WRITE_SIZE
205 /* Initial size of the buffer to store headers in, it'll be enlarged in case
207 #define HEADERSIZE 256
209 #define CURLEASY_MAGIC_NUMBER 0xc0dedbadU
210 #define GOOD_EASY_HANDLE(x) \
211 ((x) && ((x)->magic == CURLEASY_MAGIC_NUMBER))
213 /* Some convenience macros to get the larger/smaller value out of two given.
214 We prefix with CURL to prevent name collisions. */
215 #define CURLMAX(x,y) ((x)>(y)?(x):(y))
216 #define CURLMIN(x,y) ((x)<(y)?(x):(y))
219 /* Types needed for krb5-ftp connections */
227 enum protection_level {
228 PROT_NONE, /* first in list */
234 PROT_LAST /* last in list */
239 /* Structs to store Schannel handles */
240 struct curl_schannel_cred {
241 CredHandle cred_handle;
242 TimeStamp time_stamp;
246 struct curl_schannel_ctxt {
247 CtxtHandle ctxt_handle;
248 TimeStamp time_stamp;
252 /* enum for the nonblocking SSL connection state machine */
256 ssl_connect_2_reading,
257 ssl_connect_2_writing,
264 ssl_connection_negotiating,
265 ssl_connection_complete
266 } ssl_connection_state;
268 /* struct for data related to each SSL connection */
269 struct ssl_connect_data {
270 /* Use ssl encrypted communications TRUE/FALSE, not necessarily using it atm
271 but at least asked to or meaning to use it. See 'state' for the exact
272 current state of the connection. */
274 ssl_connection_state state;
275 ssl_connect_state connecting_state;
276 #if defined(USE_OPENSSL)
277 /* these ones requires specific SSL-types */
281 #elif defined(USE_GNUTLS)
282 gnutls_session_t session;
283 gnutls_certificate_credentials_t cred;
285 gnutls_srp_client_credentials_t srp_client_cred;
287 #elif defined(USE_MBEDTLS)
288 mbedtls_ctr_drbg_context ctr_drbg;
289 mbedtls_entropy_context entropy;
290 mbedtls_ssl_context ssl;
292 mbedtls_x509_crt cacert;
293 mbedtls_x509_crt clicert;
294 mbedtls_x509_crl crl;
295 mbedtls_pk_context pk;
296 mbedtls_ssl_config config;
297 const char *protocols[3];
298 #elif defined(USE_POLARSSL)
299 ctr_drbg_context ctr_drbg;
300 entropy_context entropy;
307 #elif defined(USE_CYASSL)
310 #elif defined(USE_NSS)
312 char *client_nickname;
313 struct Curl_easy *data;
314 struct curl_llist *obj_list;
315 PK11GenericObject *obj_clicert;
316 #elif defined(USE_GSKIT)
319 #elif defined(USE_AXTLS)
322 #elif defined(USE_SCHANNEL)
323 struct curl_schannel_cred *cred;
324 struct curl_schannel_ctxt *ctxt;
325 SecPkgContext_StreamSizes stream_sizes;
326 size_t encdata_length, decdata_length;
327 size_t encdata_offset, decdata_offset;
328 unsigned char *encdata_buffer, *decdata_buffer;
329 unsigned long req_flags, ret_flags;
330 CURLcode recv_unrecoverable_err; /* schannel_recv had an unrecoverable err */
331 bool recv_sspi_close_notify; /* true if connection closed by close_notify */
332 bool recv_connection_closed; /* true if connection closed, regardless how */
333 bool use_alpn; /* true if ALPN is used for this connection */
334 #elif defined(USE_DARWINSSL)
335 SSLContextRef ssl_ctx;
336 curl_socket_t ssl_sockfd;
337 bool ssl_direction; /* true if writing, false if reading */
338 size_t ssl_write_buffered_length;
339 #elif defined(USE_SSL)
340 #error "SSL backend specific information missing from ssl_connect_data"
344 struct ssl_config_data {
345 long version; /* what version the client wants to use */
346 long certverifyresult; /* result from the certificate verification */
348 bool verifypeer; /* set TRUE if this is desired */
349 bool verifyhost; /* set TRUE if CN/SAN must match hostname */
350 bool verifystatus; /* set TRUE if certificate status must be checked */
351 char *CApath; /* certificate dir (doesn't work on windows) */
352 char *CAfile; /* certificate to verify peer against */
353 const char *CRLfile; /* CRL to check certificate revocation */
354 const char *issuercert;/* optional issuer certificate filename */
356 char *random_file; /* path to file containing "random" data */
357 char *egdsocket; /* path to file containing the EGD daemon socket */
358 char *cipher_list; /* list of ciphers to use */
359 size_t max_ssl_sessions; /* SSL session id cache size */
360 curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */
361 void *fsslctxp; /* parameter for call back */
362 bool sessionid; /* cache session IDs or not */
363 bool certinfo; /* gather lots of certificate info */
367 char *username; /* TLS username (for, e.g., SRP) */
368 char *password; /* TLS password (for, e.g., SRP) */
369 enum CURL_TLSAUTH authtype; /* TLS authentication type (default SRP) */
373 /* information stored about one single SSL session */
374 struct curl_ssl_session {
375 char *name; /* host name for which this ID was used */
376 char *conn_to_host; /* host name for the connection (may be NULL) */
377 void *sessionid; /* as returned from the SSL layer */
378 size_t idsize; /* if known, otherwise 0 */
379 long age; /* just a number, the higher the more recent */
380 int remote_port; /* remote port */
381 int conn_to_port; /* remote port for the connection (may be -1) */
382 struct ssl_config_data ssl_config; /* setup for this session */
385 /* Struct used for Digest challenge-response authentication */
387 #if defined(USE_WINDOWS_SSPI)
389 size_t input_token_len;
395 bool stale; /* set true for re-negotiation */
399 int nc; /* nounce count */
411 #ifdef USE_WINDOWS_SSPI
412 #include "curl_sspi.h"
415 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
419 /* Struct used for GSSAPI (Kerberos V5) authentication */
420 #if defined(USE_KERBEROS5)
421 struct kerberos5data {
422 #if defined(USE_WINDOWS_SSPI)
423 CredHandle *credentials;
426 SEC_WINNT_AUTH_IDENTITY identity;
427 SEC_WINNT_AUTH_IDENTITY *p_identity;
431 gss_ctx_id_t context;
437 /* Struct used for NTLM challenge-response authentication */
438 #if defined(USE_NTLM)
441 #ifdef USE_WINDOWS_SSPI
442 CredHandle *credentials;
444 SEC_WINNT_AUTH_IDENTITY identity;
445 SEC_WINNT_AUTH_IDENTITY *p_identity;
449 size_t input_token_len;
452 unsigned char nonce[8];
453 void* target_info; /* TargetInfo received in the ntlm type-2 message */
454 unsigned int target_info_len;
460 struct negotiatedata {
461 /* When doing Negotiate (SPNEGO) auth, we first need to send a token
462 and then validate the received one. */
463 enum { GSS_AUTHNONE, GSS_AUTHRECV, GSS_AUTHSENT } state;
466 gss_ctx_id_t context;
468 gss_buffer_desc output_token;
470 #ifdef USE_WINDOWS_SSPI
472 CredHandle *credentials;
474 SEC_WINNT_AUTH_IDENTITY identity;
475 SEC_WINNT_AUTH_IDENTITY *p_identity;
479 size_t output_token_length;
487 * Boolean values that concerns this connection.
490 /* always modify bits.close with the connclose() and connkeep() macros! */
491 bool close; /* if set, we close the connection after this request */
492 bool reuse; /* if set, this is a re-used connection */
493 bool conn_to_host; /* if set, this connection has a "connect to host"
494 that overrides the host in the URL */
495 bool conn_to_port; /* if set, this connection has a "connect to port"
496 that overrides the port in the URL (remote port) */
497 bool proxy; /* if set, this transfer is done through a proxy - any type */
498 bool httpproxy; /* if set, this transfer is done through a http proxy */
499 bool user_passwd; /* do we use user+password for this connection? */
500 bool proxy_user_passwd; /* user+password for the proxy? */
501 bool ipv6_ip; /* we communicate with a remote site specified with pure IPv6
503 bool ipv6; /* we communicate with a site using an IPv6 address */
505 bool do_more; /* this is set TRUE if the ->curl_do_more() function is
506 supposed to be called, after ->curl_do() */
507 bool tcpconnect[2]; /* the TCP layer (or similar) is connected, this is set
508 the first time on the first connect function call */
509 bool protoconnstart;/* the protocol layer has STARTED its operation after
510 the TCP layer connect */
512 bool retry; /* this connection is about to get closed and then
513 re-attempted at another connection. */
514 bool tunnel_proxy; /* if CONNECT is used to "tunnel" through the proxy.
515 This is implicit when SSL-protocols are used through
516 proxies, but can also be enabled explicitly by
518 bool authneg; /* TRUE when the auth phase has started, which means
519 that we are creating a request with an auth header,
520 but it is not the final request in the auth
522 bool rewindaftersend;/* TRUE when the sending couldn't be stopped even
523 though it will be discarded. When the whole send
524 operation is done, we must call the data rewind
526 bool ftp_use_epsv; /* As set with CURLOPT_FTP_USE_EPSV, but if we find out
527 EPSV doesn't work we disable it for the forthcoming
530 bool ftp_use_eprt; /* As set with CURLOPT_FTP_USE_EPRT, but if we find out
531 EPRT doesn't work we disable it for the forthcoming
533 bool netrc; /* name+password provided by netrc */
534 bool userpwd_in_url; /* name+password found in url */
535 bool stream_was_rewound; /* Indicates that the stream was rewound after a
536 request read past the end of its response byte
538 bool proxy_connect_closed; /* set true if a proxy disconnected the
539 connection in a CONNECT request with auth, so
540 that libcurl should reconnect and continue. */
541 bool bound; /* set true if bind() has already been done on this socket/
543 bool type_set; /* type= was used in the URL */
544 bool multiplex; /* connection is multiplexed */
546 bool tcp_fastopen; /* use TCP Fast Open */
547 bool tls_enable_npn; /* TLS NPN extension? */
548 bool tls_enable_alpn; /* TLS ALPN extension? */
552 char *rawalloc; /* allocated "raw" version of the name */
553 char *encalloc; /* allocated IDN-encoded version of the name */
554 char *name; /* name to use internally, might be encoded, might be raw */
555 const char *dispname; /* name to display, as 'name' might be encoded */
559 * Flags on the keepon member of the Curl_transfer_keeper
563 #define KEEP_RECV (1<<0) /* there is or may be data to read */
564 #define KEEP_SEND (1<<1) /* there is or may be data to write */
565 #define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there
566 might still be data to read */
567 #define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there
568 might still be data to write */
569 #define KEEP_RECV_PAUSE (1<<4) /* reading is paused */
570 #define KEEP_SEND_PAUSE (1<<5) /* writing is paused */
572 #define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE)
573 #define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE)
578 ZLIB_UNINIT, /* uninitialized */
579 ZLIB_INIT, /* initialized */
580 ZLIB_GZIP_HEADER, /* reading gzip header */
581 ZLIB_GZIP_INFLATING, /* inflating gzip stream */
582 ZLIB_INIT_GZIP /* initialized in transparent gzip mode */
586 #ifdef CURLRES_ASYNCH
590 struct Curl_dns_entry *dns;
591 bool done; /* set TRUE when the lookup is complete */
592 int status; /* if done is TRUE, this is the status from the callback */
593 void *os_specific; /* 'struct thread_data' for Windows */
597 #define FIRSTSOCKET 0
598 #define SECONDARYSOCKET 1
600 /* These function pointer types are here only to allow easier typecasting
601 within the source when we need to cast between data pointers (such as NULL)
602 and function pointers. */
603 typedef CURLcode (*Curl_do_more_func)(struct connectdata *, int *);
604 typedef CURLcode (*Curl_done_func)(struct connectdata *, CURLcode, bool);
607 EXP100_SEND_DATA, /* enough waiting, just send the body now */
608 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */
609 EXP100_SENDING_REQUEST, /* still sending the request but will wait for
610 the 100 header once done with the request */
611 EXP100_FAILED /* used on 417 Expectation Failed */
615 UPGR101_INIT, /* default state */
616 UPGR101_REQUESTED, /* upgrade requested */
617 UPGR101_RECEIVED, /* response received */
618 UPGR101_WORKING /* talking upgraded protocol */
622 * Request specific data in the easy handle (Curl_easy). Previously,
623 * these members were on the connectdata struct but since a conn struct may
624 * now be shared between different Curl_easys, we store connection-specific
625 * data here. This struct only keeps stuff that's interesting for *this*
626 * request, as it will be cleared between multiple ones
628 struct SingleRequest {
629 curl_off_t size; /* -1 if unknown at this point */
630 curl_off_t *bytecountp; /* return number of bytes read or NULL */
632 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch,
633 -1 means unlimited */
634 curl_off_t *writebytecountp; /* return number of bytes written or NULL */
636 curl_off_t bytecount; /* total number of bytes read */
637 curl_off_t writebytecount; /* number of bytes written */
639 long headerbytecount; /* only count received headers */
640 long deductheadercount; /* this amount of bytes doesn't count when we check
641 if anything has been transferred at the end of a
642 connection. We use this counter to make only a
643 100 reply (without a following second response
644 code) result in a CURLE_GOT_NOTHING error code */
646 struct timeval start; /* transfer started at this time */
647 struct timeval now; /* current time */
648 bool header; /* incoming data has HTTP header */
650 HEADER_NORMAL, /* no bad header at all */
651 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest
653 HEADER_ALLBAD /* all was believed to be header */
654 } badheader; /* the header was deemed bad and will be
656 int headerline; /* counts header lines to better track the
658 char *hbufp; /* points at *end* of header line */
660 char *str; /* within buf */
661 char *str_start; /* within buf */
662 char *end_ptr; /* within buf */
663 char *p; /* within headerbuff */
664 bool content_range; /* set TRUE if Content-Range: was found */
665 curl_off_t offset; /* possible resume offset read from the
666 Content-Range: header */
667 int httpcode; /* error code from the 'HTTP/1.? XXX' or
668 'RTSP/1.? XXX' line */
669 struct timeval start100; /* time stamp to wait for the 100 code from */
670 enum expect100 exp100; /* expect 100 continue state */
671 enum upgrade101 upgr101; /* 101 upgrade state */
673 int auto_decoding; /* What content encoding. sec 3.5, RFC2616. */
675 #define IDENTITY 0 /* No encoding */
676 #define DEFLATE 1 /* zlib deflate [RFC 1950 & 1951] */
677 #define GZIP 2 /* gzip algorithm [RFC 1952] */
680 zlibInitState zlib_init; /* possible zlib init state;
681 undefined if Content-Encoding header. */
682 z_stream z; /* State structure for zlib. */
694 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
695 and we're uploading the last chunk */
697 bool ignorebody; /* we read a response-body but we ignore it! */
698 bool ignorecl; /* This HTTP response has no body so we ignore the Content-
701 char *location; /* This points to an allocated version of the Location:
703 char *newurl; /* Set to the new URL to use when a redirect or a retry is
706 /* 'upload_present' is used to keep a byte counter of how much data there is
707 still left in the buffer, aimed for upload. */
708 ssize_t upload_present;
710 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
711 buffer, so the next read should read from where this pointer points to,
712 and the 'upload_present' contains the number of bytes available at this
714 char *upload_fromhere;
716 bool chunk; /* if set, this is a chunked transfer-encoding */
717 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
719 bool getheader; /* TRUE if header parsing is wanted */
721 bool forbidchunk; /* used only to explicitly forbid chunk-upload for
722 specific upload buffers. See readmoredata() in
723 http.c for details. */
725 void *protop; /* Allocated protocol-specific data. Each protocol
726 handler makes sure this points to data it needs. */
730 * Specific protocol handler.
733 struct Curl_handler {
734 const char * scheme; /* URL scheme name. */
736 /* Complement to setup_connection_internals(). */
737 CURLcode (*setup_connection)(struct connectdata *);
739 /* These two functions MUST be set to be protocol dependent */
740 CURLcode (*do_it)(struct connectdata *, bool *done);
743 /* If the curl_do() function is better made in two halves, this
744 * curl_do_more() function will be called afterwards, if set. For example
745 * for doing the FTP stuff after the PASV/PORT command.
747 Curl_do_more_func do_more;
749 /* This function *MAY* be set to a protocol-dependent function that is run
750 * after the connect() and everything is done, as a step in the connection.
751 * The 'done' pointer points to a bool that should be set to TRUE if the
752 * function completes before return. If it doesn't complete, the caller
753 * should call the curl_connecting() function until it is.
755 CURLcode (*connect_it)(struct connectdata *, bool *done);
757 /* See above. Currently only used for FTP. */
758 CURLcode (*connecting)(struct connectdata *, bool *done);
759 CURLcode (*doing)(struct connectdata *, bool *done);
761 /* Called from the multi interface during the PROTOCONNECT phase, and it
762 should then return a proper fd set */
763 int (*proto_getsock)(struct connectdata *conn,
764 curl_socket_t *socks,
767 /* Called from the multi interface during the DOING phase, and it should
768 then return a proper fd set */
769 int (*doing_getsock)(struct connectdata *conn,
770 curl_socket_t *socks,
773 /* Called from the multi interface during the DO_MORE phase, and it should
774 then return a proper fd set */
775 int (*domore_getsock)(struct connectdata *conn,
776 curl_socket_t *socks,
779 /* Called from the multi interface during the DO_DONE, PERFORM and
780 WAITPERFORM phases, and it should then return a proper fd set. Not setting
781 this will make libcurl use the generic default one. */
782 int (*perform_getsock)(const struct connectdata *conn,
783 curl_socket_t *socks,
786 /* This function *MAY* be set to a protocol-dependent function that is run
787 * by the curl_disconnect(), as a step in the disconnection. If the handler
788 * is called because the connection has been considered dead, dead_connection
791 CURLcode (*disconnect)(struct connectdata *, bool dead_connection);
793 /* If used, this function gets called from transfer.c:readwrite_data() to
794 allow the protocol to do extra reads/writes */
795 CURLcode (*readwrite)(struct Curl_easy *data, struct connectdata *conn,
796 ssize_t *nread, bool *readmore);
798 long defport; /* Default port. */
799 unsigned int protocol; /* See CURLPROTO_* - this needs to be the single
800 specific protocol bit */
801 unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */
804 #define PROTOPT_NONE 0 /* nothing extra */
805 #define PROTOPT_SSL (1<<0) /* uses SSL */
806 #define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */
807 #define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */
808 /* some protocols will have to call the underlying functions without regard to
809 what exact state the socket signals. IE even if the socket says "readable",
810 the send function might need to be called while uploading, or vice versa.
812 #define PROTOPT_DIRLOCK (1<<3)
813 #define PROTOPT_NONETWORK (1<<4) /* protocol doesn't use the network! */
814 #define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it
816 #define PROTOPT_NOURLQUERY (1<<6) /* protocol can't handle
817 url query strings (?foo=bar) ! */
818 #define PROTOPT_CREDSPERREQUEST (1<<7) /* requires login credentials per
819 request instead of per connection */
820 #define PROTOPT_ALPN_NPN (1<<8) /* set ALPN and/or NPN for this */
821 #define PROTOPT_STREAM (1<<9) /* a protocol with individual logical streams */
823 /* return the count of bytes sent, or -1 on error */
824 typedef ssize_t (Curl_send)(struct connectdata *conn, /* connection data */
825 int sockindex, /* socketindex */
826 const void *buf, /* data to write */
827 size_t len, /* max amount to write */
828 CURLcode *err); /* error to return */
830 /* return the count of bytes read, or -1 on error */
831 typedef ssize_t (Curl_recv)(struct connectdata *conn, /* connection data */
832 int sockindex, /* socketindex */
833 char *buf, /* store data here */
834 size_t len, /* max amount to read */
835 CURLcode *err); /* error to return */
837 #ifdef USE_RECV_BEFORE_SEND_WORKAROUND
838 struct postponed_data {
839 char *buffer; /* Temporal store for received data during
840 sending, must be freed */
841 size_t allocated_size; /* Size of temporal store */
842 size_t recv_size; /* Size of received data during sending */
843 size_t recv_processed; /* Size of processed part of postponed data */
845 curl_socket_t bindsock;/* Structure must be bound to specific socket,
846 used only for DEBUGASSERT */
847 #endif /* DEBUGBUILD */
849 #endif /* USE_RECV_BEFORE_SEND_WORKAROUND */
852 * The connectdata struct contains all fields and variables that should be
853 * unique for an entire connection.
856 /* 'data' is the CURRENT Curl_easy using this connection -- take great
857 caution that this might very well vary between different times this
858 connection is used! */
859 struct Curl_easy *data;
861 /* chunk is for HTTP chunked encoding, but is in the general connectdata
862 struct only because we can do just about any protocol through a HTTP proxy
863 and a HTTP proxy may in fact respond using chunked encoding */
864 struct Curl_chunker chunk;
866 curl_closesocket_callback fclosesocket; /* function closing the socket(s) */
867 void *closesocket_client;
869 bool inuse; /* This is a marker for the connection cache logic. If this is
870 TRUE this handle is being used by an easy handle and cannot
871 be used by any other easy handle without careful
872 consideration (== only for pipelining). */
874 /**** Fields set when inited and not modified again */
875 long connection_id; /* Contains a unique number to make it easier to
876 track the connections in the log output */
878 /* 'dns_entry' is the particular host we use. This points to an entry in the
879 DNS cache and it will not get pruned while locked. It gets unlocked in
880 Curl_done(). This entry will be NULL if the connection is re-used as then
881 there is no name resolve done. */
882 struct Curl_dns_entry *dns_entry;
884 /* 'ip_addr' is the particular IP we connected to. It points to a struct
885 within the DNS cache, so this pointer is only valid as long as the DNS
886 cache entry remains locked. It gets unlocked in Curl_done() */
887 Curl_addrinfo *ip_addr;
888 Curl_addrinfo *tempaddr[2]; /* for happy eyeballs */
890 /* 'ip_addr_str' is the ip_addr data as a human readable string.
891 It remains available as long as the connection does, which is longer than
892 the ip_addr itself. */
893 char ip_addr_str[MAX_IPADR_LEN];
895 unsigned int scope_id; /* Scope id for IPv6 */
897 int socktype; /* SOCK_STREAM or SOCK_DGRAM */
899 struct hostname host;
900 struct hostname conn_to_host; /* the host to connect to. valid only if
901 bits.conn_to_host is set */
902 struct hostname proxy;
904 long port; /* which port to use locally */
905 int remote_port; /* the remote port, not the proxy port! */
906 int conn_to_port; /* the remote port to connect to. valid only if
907 bits.conn_to_port is set */
909 /* 'primary_ip' and 'primary_port' get filled with peer's numerical
910 ip address and port number whenever an outgoing connection is
911 *attempted* from the primary socket to a remote address. When more
912 than one address is tried for a connection these will hold data
913 for the last attempt. When the connection is actually established
914 these are updated with data which comes directly from the socket. */
916 char primary_ip[MAX_IPADR_LEN];
919 /* 'local_ip' and 'local_port' get filled with local's numerical
920 ip address and port number whenever an outgoing connection is
921 **established** from the primary socket to a remote address. */
923 char local_ip[MAX_IPADR_LEN];
926 char *user; /* user name string, allocated */
927 char *passwd; /* password string, allocated */
928 char *options; /* options string, allocated */
930 char *oauth_bearer; /* bearer token for OAuth 2.0, allocated */
932 char *proxyuser; /* proxy user name string, allocated */
933 char *proxypasswd; /* proxy password string, allocated */
934 curl_proxytype proxytype; /* what kind of proxy that is in use */
936 int httpversion; /* the HTTP version*10 reported by the server */
937 int rtspversion; /* the RTSP version*10 reported by the server */
939 struct timeval now; /* "current" time */
940 struct timeval created; /* creation time */
941 curl_socket_t sock[2]; /* two sockets, the second is used for the data
942 transfer when doing FTP */
943 curl_socket_t tempsock[2]; /* temporary sockets for happy eyeballs */
944 bool sock_accepted[2]; /* TRUE if the socket on this index was created with
949 #ifdef USE_RECV_BEFORE_SEND_WORKAROUND
950 struct postponed_data postponed[2]; /* two buffers for two sockets */
951 #endif /* USE_RECV_BEFORE_SEND_WORKAROUND */
952 struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */
953 struct ssl_config_data ssl_config;
956 struct ConnectBits bits; /* various state-flags for this connection */
958 /* connecttime: when connect() is called on the current IP address. Used to
959 be able to track when to move on to try next IP - but only when the multi
960 interface is used. */
961 struct timeval connecttime;
962 /* The two fields below get set in Curl_connecthost */
963 int num_addr; /* number of addresses to try to connect to */
964 long timeoutms_per_addr; /* how long time in milliseconds to spend on
965 trying to connect to each IP address */
967 const struct Curl_handler *handler; /* Connection's protocol handler */
968 const struct Curl_handler *given; /* The protocol first given */
970 long ip_version; /* copied from the Curl_easy at creation time */
972 /**** curl_get() phase fields */
974 curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */
975 curl_socket_t writesockfd; /* socket to write to, it may very
976 well be the same we read from.
977 CURL_SOCKET_BAD disables */
979 /** Dynamicly allocated strings, MUST be freed before this **/
980 /** struct is killed. **/
981 struct dynamically_allocated_data {
984 char *accept_encoding;
990 char *rtsp_transport;
991 char *te; /* TE: request header */
995 int sec_complete; /* if Kerberos is enabled for this connection */
996 enum protection_level command_prot;
997 enum protection_level data_prot;
998 enum protection_level request_data_prot;
1000 struct krb5buffer in_buffer;
1002 const struct Curl_sec_client_mech *mech;
1003 struct sockaddr_in local_addr;
1006 #if defined(USE_KERBEROS5) /* Consider moving some of the above GSS-API */
1007 struct kerberos5data krb5; /* variables into the structure definition, */
1008 #endif /* however, some of them are ftp specific. */
1010 /* the two following *_inuse fields are only flags, not counters in any way.
1011 If TRUE it means the channel is in use, and if FALSE it means the channel
1012 is up for grabs by one. */
1014 bool readchannel_inuse; /* whether the read channel is in use by an easy
1016 bool writechannel_inuse; /* whether the write channel is in use by an easy
1018 struct curl_llist *send_pipe; /* List of handles waiting to
1019 send on this pipeline */
1020 struct curl_llist *recv_pipe; /* List of handles waiting to read
1021 their responses on this pipeline */
1022 char* master_buffer; /* The master buffer allocated on-demand;
1023 used for pipelining. */
1024 size_t read_pos; /* Current read position in the master buffer */
1025 size_t buf_len; /* Length of the buffer?? */
1028 curl_seek_callback seek_func; /* function that seeks the input */
1029 void *seek_client; /* pointer to pass to the seek() above */
1031 /*************** Request - specific items ************/
1033 #if defined(USE_NTLM)
1034 struct ntlmdata ntlm; /* NTLM differs from other authentication schemes
1035 because it authenticates connections, not
1037 struct ntlmdata proxyntlm; /* NTLM data for proxy */
1039 #if defined(NTLM_WB_ENABLED)
1040 /* used for communication with Samba's winbind daemon helper ntlm_auth */
1041 curl_socket_t ntlm_auth_hlpr_socket;
1042 pid_t ntlm_auth_hlpr_pid;
1043 char* challenge_header;
1044 char* response_header;
1048 char syserr_buf [256]; /* buffer for Curl_strerror() */
1050 #ifdef CURLRES_ASYNCH
1051 /* data used for the asynch name resolve callback */
1052 struct Curl_async async;
1055 /* These three are used for chunked-encoding trailer support */
1056 char *trailer; /* allocated buffer to store trailer in */
1057 int trlMax; /* allocated buffer size */
1058 int trlPos; /* index of where to store data */
1061 struct ftp_conn ftpc;
1062 struct http_conn httpc;
1063 struct ssh_conn sshc;
1064 struct tftp_state_data *tftpc;
1065 struct imap_conn imapc;
1066 struct pop3_conn pop3c;
1067 struct smtp_conn smtpc;
1068 struct rtsp_conn rtspc;
1069 struct smb_conn smbc;
1070 void *generic; /* RTMP and LDAP use this */
1073 int cselect_bits; /* bitmask of socket events */
1074 int waitfor; /* current READ/WRITE bits to wait for */
1076 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1077 int socks5_gssapi_enctype;
1083 /* When this connection is created, store the conditions for the local end
1084 bind. This is stored before the actual bind and before any connection is
1085 made and will serve the purpose of being used for comparison reasons so
1086 that subsequent bound-requested connections aren't accidentally re-using
1087 wrong connections. */
1089 unsigned short localport;
1092 /* tunnel as in tunnel through a HTTP proxy with CONNECT */
1094 TUNNEL_INIT, /* init/default/no tunnel state */
1095 TUNNEL_CONNECT, /* CONNECT has been sent off */
1096 TUNNEL_COMPLETE /* CONNECT response received completely */
1097 } tunnel_state[2]; /* two separate ones to allow FTP */
1098 struct connectbundle *bundle; /* The bundle we are member of */
1100 int negnpn; /* APLN or NPN TLS negotiated protocol, CURL_HTTP_VERSION* */
1103 /* The end of connectdata. */
1106 * Struct to keep statistical and informational data.
1109 int httpcode; /* Recent HTTP, FTP, RTSP or SMTP response code */
1110 int httpproxycode; /* response code from proxy when received separate */
1111 int httpversion; /* the http version number X.Y = X*10+Y */
1112 long filetime; /* If requested, this is might get set. Set to -1 if the time
1113 was unretrievable. We cannot have this of type time_t,
1114 since time_t is unsigned on several platforms such as
1116 bool timecond; /* set to TRUE if the time condition didn't match, which
1117 thus made the document NOT get fetched */
1118 long header_size; /* size of read header(s) in bytes */
1119 long request_size; /* the amount of bytes sent in the request(s) */
1120 unsigned long proxyauthavail; /* what proxy auth types were announced */
1121 unsigned long httpauthavail; /* what host auth types were announced */
1122 long numconnects; /* how many new connection did libcurl created */
1123 char *contenttype; /* the content type of the object */
1124 char *wouldredirect; /* URL this would've been redirected to if asked to */
1126 /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip'
1127 and, 'conn_local_port' are copied over from the connectdata struct in
1128 order to allow curl_easy_getinfo() to return this information even when
1129 the session handle is no longer associated with a connection, and also
1130 allow curl_easy_reset() to clear this information from the session handle
1131 without disturbing information which is still alive, and that might be
1132 reused, in the connection cache. */
1134 char conn_primary_ip[MAX_IPADR_LEN];
1135 long conn_primary_port;
1137 char conn_local_ip[MAX_IPADR_LEN];
1138 long conn_local_port;
1140 struct curl_certinfo certs; /* info about the certs, only populated in
1141 OpenSSL builds. Asked for with
1142 CURLOPT_CERTINFO / CURLINFO_CERTINFO */
1147 long lastshow; /* time() of the last displayed progress meter or NULL to
1148 force redraw at next call */
1149 curl_off_t size_dl; /* total expected size */
1150 curl_off_t size_ul; /* total expected size */
1151 curl_off_t downloaded; /* transferred so far */
1152 curl_off_t uploaded; /* transferred so far */
1154 curl_off_t current_speed; /* uses the currently fastest transfer */
1156 bool callback; /* set when progress callback is used */
1157 int width; /* screen width at download start */
1158 int flags; /* see progress.h */
1167 double t_appconnect;
1168 double t_pretransfer;
1169 double t_starttransfer;
1172 struct timeval start;
1173 struct timeval t_startsingle;
1174 struct timeval t_startop;
1175 struct timeval t_acceptdata;
1177 /* upload speed limit */
1178 struct timeval ul_limit_start;
1179 curl_off_t ul_limit_size;
1180 /* download speed limit */
1181 struct timeval dl_limit_start;
1182 curl_off_t dl_limit_size;
1184 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
1186 curl_off_t speeder[ CURR_TIME ];
1187 struct timeval speeder_time[ CURR_TIME ];
1192 HTTPREQ_NONE, /* first in list */
1195 HTTPREQ_POST_FORM, /* we make a difference internally */
1199 HTTPREQ_LAST /* last in list */
1203 RTSPREQ_NONE, /* first in list */
1211 RTSPREQ_GET_PARAMETER,
1212 RTSPREQ_SET_PARAMETER,
1215 RTSPREQ_LAST /* last in list */
1219 * Values that are generated, temporary or calculated internally for a
1220 * "session handle" must be defined within the 'struct UrlState'. This struct
1221 * will be used within the Curl_easy struct. When the 'Curl_easy'
1222 * struct is cloned, this data MUST NOT be copied.
1224 * Remember that any "state" information goes globally for the curl handle.
1225 * Session-data MUST be put in the connectdata struct and here. */
1226 #define MAX_CURL_USER_LENGTH 256
1227 #define MAX_CURL_PASSWORD_LENGTH 256
1230 unsigned long want; /* Bitmask set to the authentication methods wanted by
1231 app (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */
1232 unsigned long picked;
1233 unsigned long avail; /* Bitmask for what the server reports to support for
1235 bool done; /* TRUE when the auth phase is done and ready to do the *actual*
1237 bool multi; /* TRUE if this is not yet authenticated but within the auth
1238 multipass negotiation */
1239 bool iestyle; /* TRUE if digest should be done IE-style or FALSE if it should
1245 /* Points to the connection cache */
1246 struct conncache *conn_cache;
1248 /* when curl_easy_perform() is called, the multi handle is "owned" by
1249 the easy handle so curl_easy_cleanup() on such an easy handle will
1250 also close the multi handle! */
1251 bool multi_owned_by_easy;
1253 /* buffers to store authentication data in, as parsed from input options */
1254 struct timeval keeps_speed; /* for the progress meter really */
1256 struct connectdata *lastconnect; /* The last connection, NULL if undefined */
1258 char *headerbuff; /* allocated buffer to store headers in */
1259 size_t headersize; /* size of the allocation */
1261 char buffer[BUFSIZE+1]; /* download buffer */
1262 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
1263 curl_off_t current_speed; /* the ProgressShow() funcion sets this,
1265 bool this_is_a_follow; /* this is a followed Location: request */
1267 char *first_host; /* host name of the first (not followed) request.
1268 if set, this should be the host name that we will
1269 sent authorization to, no else. Used to make Location:
1270 following not keep sending user+password... This is
1273 int first_remote_port; /* remote port of the first (not followed) request */
1274 struct curl_ssl_session *session; /* array of 'max_ssl_sessions' size */
1275 long sessionage; /* number of the most recent session */
1276 char *tempwrite; /* allocated buffer to keep data in when a write
1277 callback returns to make the connection paused */
1278 size_t tempwritesize; /* size of the 'tempwrite' allocated buffer */
1279 int tempwritetype; /* type of the 'tempwrite' buffer as a bitmask that is
1280 used with Curl_client_write() */
1281 char *scratch; /* huge buffer[BUFSIZE*2] when doing upload CRLF replacing */
1282 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
1283 This must be set to FALSE every time _easy_perform() is
1285 int os_errno; /* filled in with errno whenever an error occurs */
1287 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
1288 void (*prev_signal)(int sig);
1290 bool allow_port; /* Is set.use_port allowed to take effect or not. This
1291 is always set TRUE when curl_easy_perform() is called. */
1292 struct digestdata digest; /* state data for host Digest auth */
1293 struct digestdata proxydigest; /* state data for proxy Digest auth */
1296 struct negotiatedata negotiate; /* state data for host Negotiate auth */
1297 struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */
1300 struct auth authhost; /* auth details for host */
1301 struct auth authproxy; /* auth details for proxy */
1303 bool authproblem; /* TRUE if there's some problem authenticating */
1305 void *resolver; /* resolver state, if it is used in the URL state -
1306 ares_channel f.e. */
1308 #if defined(USE_OPENSSL) && defined(HAVE_OPENSSL_ENGINE_H)
1310 #endif /* USE_OPENSSL */
1311 struct timeval expiretime; /* set this with Curl_expire() only */
1312 struct Curl_tree timenode; /* for the splay stuff */
1313 struct curl_llist *timeoutlist; /* list of pending timeouts */
1315 /* a place to store the most recently set FTP entrypath */
1316 char *most_recent_ftp_entrypath;
1318 /* set after initial USER failure, to prevent an authentication loop */
1319 bool ftp_trying_alternative;
1321 int httpversion; /* the lowest HTTP version*10 reported by any server
1322 involved in this request */
1323 bool expect100header; /* TRUE if we added Expect: 100-continue */
1325 bool pipe_broke; /* TRUE if the connection we were pipelined on broke
1326 and we need to restart from the beginning */
1328 #if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) && \
1329 !defined(__SYMBIAN32__)
1330 /* do FTP line-end conversions on most platforms */
1331 #define CURL_DO_LINEEND_CONV
1332 /* for FTP downloads: track CRLF sequences that span blocks */
1333 bool prev_block_had_trailing_cr;
1334 /* for FTP downloads: how many CRLFs did we converted to LFs? */
1335 curl_off_t crlf_conversions;
1337 char *pathbuffer;/* allocated buffer to store the URL's path part in */
1338 char *path; /* path to use, points to somewhere within the pathbuffer
1340 bool slash_removed; /* set TRUE if the 'path' points to a path where the
1341 initial URL slash separator has been taken off */
1343 bool rangestringalloc; /* the range string is malloc()'ed */
1345 char *range; /* range, if used. See README for detailed specification on
1347 curl_off_t resume_from; /* continue [ftp] transfer from here */
1349 /* This RTSP state information survives requests and connections */
1350 long rtsp_next_client_CSeq; /* the session's next client CSeq */
1351 long rtsp_next_server_CSeq; /* the session's next server CSeq */
1352 long rtsp_CSeq_recv; /* most recent CSeq received */
1354 curl_off_t infilesize; /* size of file to upload, -1 means unknown.
1355 Copied from set.filesize at start of operation */
1357 size_t drain; /* Increased when this stream has data to read, even if its
1358 socket is not necessarily is readable. Decreased when
1360 bool done; /* set to FALSE when Curl_init_do() is called and set to TRUE
1361 when multi_done() is called, to prevent multi_done() to get
1362 invoked twice when the multi interface is used. */
1364 curl_read_callback fread_func; /* read callback/function */
1365 void *in; /* CURLOPT_READDATA */
1367 struct Curl_easy *stream_depends_on;
1368 bool stream_depends_e; /* set or don't set the Exclusive bit */
1374 * This 'DynamicStatic' struct defines dynamic states that actually change
1375 * values in the 'UserDefined' area, which MUST be taken into consideration
1376 * if the UserDefined struct is cloned or similar. You can probably just
1377 * copy these, but each one indicate a special action on other data.
1380 struct DynamicStatic {
1381 char *url; /* work URL, copied from UserDefined */
1382 bool url_alloc; /* URL string is malloc()'ed */
1383 char *referer; /* referer string */
1384 bool referer_alloc; /* referer sting is malloc()ed */
1385 struct curl_slist *cookielist; /* list of cookie files set by
1386 curl_easy_setopt(COOKIEFILE) calls */
1387 struct curl_slist *resolve; /* set to point to the set.resolve list when
1388 this should be dealt with in pretransfer */
1392 * This 'UserDefined' struct must only contain data that is set once to go
1393 * for many (perhaps) independent connections. Values that are generated or
1394 * calculated internally for the "session handle" MUST be defined within the
1395 * 'struct UrlState' instead. The only exceptions MUST note the changes in
1396 * the 'DynamicStatic' struct.
1397 * Character pointer fields point to dynamic storage, unless otherwise stated.
1400 struct Curl_multi; /* declared and used only in multi.c */
1403 STRING_CERT, /* client certificate file name */
1404 STRING_CERT_TYPE, /* format for certificate (default: PEM)*/
1405 STRING_COOKIE, /* HTTP cookie string to send */
1406 STRING_COOKIEJAR, /* dump all cookies to this file */
1407 STRING_CUSTOMREQUEST, /* HTTP/FTP/RTSP request/method to use */
1408 STRING_DEFAULT_PROTOCOL, /* Protocol to use when the URL doesn't specify */
1409 STRING_DEVICE, /* local network interface/address to use */
1410 STRING_ENCODING, /* Accept-Encoding string */
1411 STRING_FTP_ACCOUNT, /* ftp account data */
1412 STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */
1413 STRING_FTPPORT, /* port to send with the FTP PORT command */
1414 STRING_KEY, /* private key file name */
1415 STRING_KEY_PASSWD, /* plain text private key password */
1416 STRING_KEY_TYPE, /* format for private key (default: PEM) */
1417 STRING_KRB_LEVEL, /* krb security level */
1418 STRING_NETRC_FILE, /* if not NULL, use this instead of trying to find
1420 STRING_PROXY, /* proxy to use */
1421 STRING_SET_RANGE, /* range, if used */
1422 STRING_SET_REFERER, /* custom string for the HTTP referer field */
1423 STRING_SET_URL, /* what original URL to work on */
1424 STRING_SSL_CAPATH, /* CA directory name (doesn't work on windows) */
1425 STRING_SSL_CAFILE, /* certificate file to verify peer against */
1426 STRING_SSL_PINNEDPUBLICKEY, /* public key file to verify peer against */
1427 STRING_SSL_CIPHER_LIST, /* list of ciphers to use */
1428 STRING_SSL_EGDSOCKET, /* path to file containing the EGD daemon socket */
1429 STRING_SSL_RANDOM_FILE, /* path to file containing "random" data */
1430 STRING_USERAGENT, /* User-Agent string */
1431 STRING_SSL_CRLFILE, /* crl file to check certificate */
1432 STRING_SSL_ISSUERCERT, /* issuer cert file to check certificate */
1433 STRING_USERNAME, /* <username>, if used */
1434 STRING_PASSWORD, /* <password>, if used */
1435 STRING_OPTIONS, /* <options>, if used */
1436 STRING_PROXYUSERNAME, /* Proxy <username>, if used */
1437 STRING_PROXYPASSWORD, /* Proxy <password>, if used */
1438 STRING_NOPROXY, /* List of hosts which should not use the proxy, if
1440 STRING_RTSP_SESSION_ID, /* Session ID to use */
1441 STRING_RTSP_STREAM_URI, /* Stream URI for this request */
1442 STRING_RTSP_TRANSPORT, /* Transport for this session */
1444 STRING_SSH_PRIVATE_KEY, /* path to the private key file for auth */
1445 STRING_SSH_PUBLIC_KEY, /* path to the public key file for auth */
1446 STRING_SSH_HOST_PUBLIC_KEY_MD5, /* md5 of host public key in ascii hex */
1447 STRING_SSH_KNOWNHOSTS, /* file name of knownhosts file */
1449 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1450 STRING_PROXY_SERVICE_NAME, /* Proxy service name */
1452 #if !defined(CURL_DISABLE_CRYPTO_AUTH) || defined(USE_KERBEROS5) || \
1454 STRING_SERVICE_NAME, /* Service name */
1460 STRING_TLSAUTH_USERNAME, /* TLS auth <username> */
1461 STRING_TLSAUTH_PASSWORD, /* TLS auth <password> */
1463 STRING_BEARER, /* <bearer>, if used */
1464 #ifdef USE_UNIX_SOCKETS
1465 STRING_UNIX_SOCKET_PATH, /* path to Unix socket, if used */
1468 /* -- end of zero-terminated strings -- */
1470 STRING_LASTZEROTERMINATED,
1472 /* -- below this are pointers to binary data that cannot be strdup'ed.
1473 Each such pointer must be added manually to Curl_dupset() --- */
1475 STRING_COPYPOSTFIELDS, /* if POST, set the fields' values here */
1477 STRING_LAST /* not used, just an end-of-list marker */
1480 struct UserDefined {
1481 FILE *err; /* the stderr user data goes here */
1482 void *debugdata; /* the data that will be passed to fdebug */
1483 char *errorbuffer; /* (Static) store failure messages in here */
1484 long proxyport; /* If non-zero, use this port number by default. If the
1485 proxy string features a ":[port]" that one will override
1487 void *out; /* CURLOPT_WRITEDATA */
1488 void *in_set; /* CURLOPT_READDATA */
1489 void *writeheader; /* write the header to this if non-NULL */
1490 void *rtp_out; /* write RTP to this if non-NULL */
1491 long use_port; /* which port to use (when not using default) */
1492 unsigned long httpauth; /* kind of HTTP authentication to use (bitmask) */
1493 unsigned long proxyauth; /* kind of proxy authentication to use (bitmask) */
1494 long followlocation; /* as in HTTP Location: */
1495 long maxredirs; /* maximum no. of http(s) redirects to follow, set to -1
1498 int keep_post; /* keep POSTs as POSTs after a 30x request; each
1499 bit represents a request, from 301 to 303 */
1500 bool free_referer; /* set TRUE if 'referer' points to a string we
1502 void *postfields; /* if POST, set the fields' values here */
1503 curl_seek_callback seek_func; /* function that seeks the input */
1504 curl_off_t postfieldsize; /* if POST, this might have a size to use instead
1505 of strlen(), and then the data *may* be binary
1506 (contain zero bytes) */
1507 unsigned short localport; /* local port number to bind to */
1508 int localportrange; /* number of additional port numbers to test in case the
1509 'localport' one can't be bind()ed */
1510 curl_write_callback fwrite_func; /* function that stores the output */
1511 curl_write_callback fwrite_header; /* function that stores headers */
1512 curl_write_callback fwrite_rtp; /* function that stores interleaved RTP */
1513 curl_read_callback fread_func_set; /* function that reads the input */
1514 int is_fread_set; /* boolean, has read callback been set to non-NULL? */
1515 int is_fwrite_set; /* boolean, has write callback been set to non-NULL? */
1516 curl_progress_callback fprogress; /* OLD and deprecated progress callback */
1517 curl_xferinfo_callback fxferinfo; /* progress callback */
1518 curl_debug_callback fdebug; /* function that write informational data */
1519 curl_ioctl_callback ioctl_func; /* function for I/O control */
1520 curl_sockopt_callback fsockopt; /* function for setting socket options */
1521 void *sockopt_client; /* pointer to pass to the socket options callback */
1522 curl_opensocket_callback fopensocket; /* function for checking/translating
1523 the address and opening the
1525 void* opensocket_client;
1526 curl_closesocket_callback fclosesocket; /* function for closing the
1528 void* closesocket_client;
1530 void *seek_client; /* pointer to pass to the seek callback */
1531 /* the 3 curl_conv_callback functions below are used on non-ASCII hosts */
1532 /* function to convert from the network encoding: */
1533 curl_conv_callback convfromnetwork;
1534 /* function to convert to the network encoding: */
1535 curl_conv_callback convtonetwork;
1536 /* function to convert from UTF-8 encoding: */
1537 curl_conv_callback convfromutf8;
1539 void *progress_client; /* pointer to pass to the progress callback */
1540 void *ioctl_client; /* pointer to pass to the ioctl callback */
1541 long timeout; /* in milliseconds, 0 means no timeout */
1542 long connecttimeout; /* in milliseconds, 0 means no timeout */
1543 long accepttimeout; /* in milliseconds, 0 means no timeout */
1544 long server_response_timeout; /* in milliseconds, 0 means no timeout */
1545 long tftp_blksize; /* in bytes, 0 means use default */
1546 bool tftp_no_options; /* do not send TFTP options requests */
1547 curl_off_t filesize; /* size of file to upload, -1 means unknown */
1548 long low_speed_limit; /* bytes/second */
1549 long low_speed_time; /* number of seconds */
1550 curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */
1551 curl_off_t max_recv_speed; /* high speed limit in bytes/second for
1553 curl_off_t set_resume_from; /* continue [ftp] transfer from here */
1554 struct curl_slist *headers; /* linked list of extra headers */
1555 struct curl_slist *proxyheaders; /* linked list of extra CONNECT headers */
1556 struct curl_httppost *httppost; /* linked list of POST data */
1557 bool sep_headers; /* handle host and proxy headers separately */
1558 bool cookiesession; /* new cookie session? */
1559 bool crlf; /* convert crlf on ftp upload(?) */
1560 struct curl_slist *quote; /* after connection is established */
1561 struct curl_slist *postquote; /* after the transfer */
1562 struct curl_slist *prequote; /* before the transfer, after type */
1563 struct curl_slist *source_quote; /* 3rd party quote */
1564 struct curl_slist *source_prequote; /* in 3rd party transfer mode - before
1565 the transfer on source host */
1566 struct curl_slist *source_postquote; /* in 3rd party transfer mode - after
1567 the transfer on source host */
1568 struct curl_slist *telnet_options; /* linked list of telnet options */
1569 struct curl_slist *resolve; /* list of names to add/remove from
1571 struct curl_slist *connect_to; /* list of host:port mappings to override
1572 the hostname and port to connect to */
1573 curl_TimeCond timecondition; /* kind of time/date comparison */
1574 time_t timevalue; /* what time to compare with */
1575 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
1576 long httpversion; /* when non-zero, a specific HTTP version requested to
1577 be used in the library's request(s) */
1578 struct ssl_config_data ssl; /* user defined SSL stuff */
1579 curl_proxytype proxytype; /* what kind of proxy that is in use */
1580 long dns_cache_timeout; /* DNS cache timeout */
1581 long buffer_size; /* size of receive buffer to use */
1582 void *private_data; /* application-private data */
1584 struct curl_slist *http200aliases; /* linked list of aliases for http200 */
1586 long ipver; /* the CURL_IPRESOLVE_* defines in the public header file
1587 0 - whatever, 1 - v2, 2 - v6 */
1589 curl_off_t max_filesize; /* Maximum file size to download */
1591 curl_ftpfile ftp_filemethod; /* how to get to a file when FTP is used */
1593 int ftp_create_missing_dirs; /* 1 - create directories that don't exist
1594 2 - the same but also allow MKD to fail once
1597 curl_sshkeycallback ssh_keyfunc; /* key matching callback */
1598 void *ssh_keyfunc_userp; /* custom pointer to callback */
1600 /* Here follows boolean settings that define how to behave during
1601 this session. They are STATIC, set by libcurl users or at least initially
1602 and they don't change during operations. */
1604 bool printhost; /* printing host name in debug info */
1605 bool get_filetime; /* get the time and get of the remote file */
1606 bool tunnel_thru_httpproxy; /* use CONNECT through a HTTP proxy */
1607 bool prefer_ascii; /* ASCII rather than binary */
1608 bool ftp_append; /* append, not overwrite, on upload */
1609 bool ftp_list_only; /* switch FTP command for listing directories */
1610 bool ftp_use_port; /* use the FTP PORT command */
1611 bool hide_progress; /* don't use the progress meter */
1612 bool http_fail_on_error; /* fail on HTTP error codes >= 400 */
1613 bool http_follow_location; /* follow HTTP redirects */
1614 bool http_transfer_encoding; /* request compressed HTTP transfer-encoding */
1615 bool http_disable_hostname_check_before_authentication;
1616 bool include_header; /* include received protocol headers in data output */
1617 bool http_set_referer; /* is a custom referer used */
1618 bool http_auto_referer; /* set "correct" referer when following location: */
1619 bool opt_no_body; /* as set with CURLOPT_NOBODY */
1620 bool upload; /* upload request */
1621 enum CURL_NETRC_OPTION
1622 use_netrc; /* defined in include/curl.h */
1623 bool verbose; /* output verbosity */
1624 bool krb; /* Kerberos connection requested */
1625 bool reuse_forbid; /* forbidden to be reused, close after use */
1626 bool reuse_fresh; /* do not re-use an existing connection */
1627 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
1628 bool ftp_use_eprt; /* if EPRT is to be attempted or not */
1629 bool ftp_use_pret; /* if PRET is to be used before PASV or not */
1631 curl_usessl use_ssl; /* if AUTH TLS is to be attempted etc, for FTP or
1632 IMAP or POP3 or others! */
1633 curl_ftpauth ftpsslauth; /* what AUTH XXX to be attempted */
1634 curl_ftpccc ftp_ccc; /* FTP CCC options */
1635 bool no_signal; /* do not use any signal/alarm handler */
1636 bool global_dns_cache; /* subject for future removal */
1637 bool tcp_nodelay; /* whether to enable TCP_NODELAY or not */
1638 bool ignorecl; /* ignore content length */
1639 bool ftp_skip_ip; /* skip the IP address the FTP server passes on to
1641 bool connect_only; /* make connection, let application use the socket */
1642 bool ssl_enable_beast; /* especially allow this flaw for interoperability's
1644 bool ssl_no_revoke; /* disable SSL certificate revocation checks */
1645 long ssh_auth_types; /* allowed SSH auth types */
1646 bool http_te_skip; /* pass the raw body data to the user, even when
1647 transfer-encoded (chunked, compressed) */
1648 bool http_ce_skip; /* pass the raw body data to the user, even when
1649 content-encoded (chunked, compressed) */
1650 long new_file_perms; /* Permissions to use when creating remote files */
1651 long new_directory_perms; /* Permissions to use when creating remote dirs */
1652 bool proxy_transfer_mode; /* set transfer mode (;type=<a|i>) when doing FTP
1653 via an HTTP proxy */
1654 char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */
1655 unsigned int scope_id; /* Scope id for IPv6 */
1656 long allowed_protocols;
1657 long redir_protocols;
1658 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1659 bool socks5_gssapi_nec; /* Flag to support NEC SOCKS5 server */
1661 struct curl_slist *mail_rcpt; /* linked list of mail recipients */
1662 bool sasl_ir; /* Enable/disable SASL initial response */
1663 /* Common RTSP header options */
1664 Curl_RtspReq rtspreq; /* RTSP request type */
1665 long rtspversion; /* like httpversion, for RTSP */
1666 bool wildcardmatch; /* enable wildcard matching */
1667 curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer
1669 curl_chunk_end_callback chunk_end; /* called after part transferring
1671 curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds
1672 to pattern (e.g. if WILDCARDMATCH is on) */
1675 long gssapi_delegation; /* GSS-API credential delegation, see the
1676 documentation of CURLOPT_GSSAPI_DELEGATION */
1678 bool tcp_keepalive; /* use TCP keepalives */
1679 long tcp_keepidle; /* seconds in idle before sending keepalive probe */
1680 long tcp_keepintvl; /* seconds between TCP keepalive probes */
1681 bool tcp_fastopen; /* use TCP Fast Open */
1683 size_t maxconnects; /* Max idle connections in the connection cache */
1685 bool ssl_enable_npn; /* TLS NPN extension? */
1686 bool ssl_enable_alpn; /* TLS ALPN extension? */
1687 bool path_as_is; /* allow dotdots? */
1688 bool pipewait; /* wait for pipe/multiplex status before starting a
1690 long expect_100_timeout; /* in milliseconds */
1692 struct Curl_easy *stream_depends_on;
1693 bool stream_depends_e; /* set or don't set the Exclusive bit */
1698 struct curl_hash *hostcache;
1700 HCACHE_NONE, /* not pointing to anything */
1701 HCACHE_GLOBAL, /* points to the (shrug) global one */
1702 HCACHE_MULTI, /* points to a shared one in the multi handle */
1703 HCACHE_SHARED /* points to a shared one in a shared object */
1708 * The 'connectdata' struct MUST have all the connection oriented stuff as we
1709 * may have several simultaneous connections and connection structs in memory.
1711 * The 'struct UserDefined' must only contain data that is set once to go for
1712 * many (perhaps) independent connections. Values that are generated or
1713 * calculated internally for the "session handle" must be defined within the
1714 * 'struct UrlState' instead.
1718 /* first, two fields for the linked list of these */
1719 struct Curl_easy *next;
1720 struct Curl_easy *prev;
1722 struct connectdata *easy_conn; /* the "unit's" connection */
1724 CURLMstate mstate; /* the handle's state */
1725 CURLcode result; /* previous result */
1727 struct Curl_message msg; /* A single posted message. */
1729 /* Array with the plain socket numbers this handle takes care of, in no
1730 particular order. Note that all sockets are added to the sockhash, where
1731 the state etc are also kept. This array is mostly used to detect when a
1732 socket is to be removed from the hash. See singlesocket(). */
1733 curl_socket_t sockets[MAX_SOCKSPEREASYHANDLE];
1737 struct Curl_multi *multi; /* if non-NULL, points to the multi handle
1738 struct to which this "belongs" when used by
1739 the multi interface */
1740 struct Curl_multi *multi_easy; /* if non-NULL, points to the multi handle
1741 struct to which this "belongs" when used
1742 by the easy interface */
1743 struct Curl_share *share; /* Share, handles global variable mutexing */
1744 struct SingleRequest req; /* Request-specific data */
1745 struct UserDefined set; /* values set by the libcurl user */
1746 struct DynamicStatic change; /* possibly modified userdefined data */
1747 struct CookieInfo *cookies; /* the cookies, read from files and servers.
1748 NOTE that the 'cookie' field in the
1749 UserDefined struct defines if the "engine"
1750 is to be used or not. */
1751 struct Progress progress; /* for all the progress meter data */
1752 struct UrlState state; /* struct for fields used for state info and
1753 other dynamic purposes */
1754 struct WildcardData wildcard; /* wildcard download state info */
1755 struct PureInfo info; /* stats, reports and info data */
1756 struct curl_tlssessioninfo tsi; /* Information about the TLS session, only
1757 valid after a client has asked for it */
1758 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
1759 iconv_t outbound_cd; /* for translating to the network encoding */
1760 iconv_t inbound_cd; /* for translating from the network encoding */
1761 iconv_t utf8_cd; /* for translating to UTF8 */
1762 #endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */
1763 unsigned int magic; /* set to a CURLEASY_MAGIC_NUMBER */
1766 #define LIBCURL_NAME "libcurl"
1768 #endif /* HEADER_CURL_URLDATA_H */