1#ifndef HEADER_CURL_URLDATA_H 2#define HEADER_CURL_URLDATA_H 3/*************************************************************************** 4 * _ _ ____ _ 5 * Project ___| | | | _ \| | 6 * / __| | | | |_) | | 7 * | (__| |_| | _ <| |___ 8 * \___|\___/|_| \_\_____| 9 * 10 * Copyright (C) 1998 - 2013, Daniel Stenberg, <daniel@haxx.se>, et al. 11 * 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. 15 * 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. 19 * 20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY 21 * KIND, either express or implied. 22 * 23 ***************************************************************************/ 24 25/* This file is for lib internal stuff */ 26 27#include "curl_setup.h" 28 29#define PORT_FTP 21 30#define PORT_FTPS 990 31#define PORT_TELNET 23 32#define PORT_HTTP 80 33#define PORT_HTTPS 443 34#define PORT_DICT 2628 35#define PORT_LDAP 389 36#define PORT_LDAPS 636 37#define PORT_TFTP 69 38#define PORT_SSH 22 39#define PORT_IMAP 143 40#define PORT_IMAPS 993 41#define PORT_POP3 110 42#define PORT_POP3S 995 43#define PORT_SMTP 25 44#define PORT_SMTPS 465 /* sometimes called SSMTP */ 45#define PORT_RTSP 554 46#define PORT_RTMP 1935 47#define PORT_RTMPT PORT_HTTP 48#define PORT_RTMPS PORT_HTTPS 49#define PORT_GOPHER 70 50 51#define DICT_MATCH "/MATCH:" 52#define DICT_MATCH2 "/M:" 53#define DICT_MATCH3 "/FIND:" 54#define DICT_DEFINE "/DEFINE:" 55#define DICT_DEFINE2 "/D:" 56#define DICT_DEFINE3 "/LOOKUP:" 57 58#define CURL_DEFAULT_USER "anonymous" 59#define CURL_DEFAULT_PASSWORD "ftp@example.com" 60 61#define DEFAULT_CONNCACHE_SIZE 5 62 63/* length of longest IPv6 address string including the trailing null */ 64#define MAX_IPADR_LEN sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255") 65 66/* Default FTP/IMAP etc response timeout in milliseconds. 67 Symbian OS panics when given a timeout much greater than 1/2 hour. 68*/ 69#define RESP_TIMEOUT (1800*1000) 70 71#include "cookie.h" 72#include "formdata.h" 73 74#ifdef USE_SSLEAY 75#ifdef USE_OPENSSL 76#include <openssl/rsa.h> 77#include <openssl/crypto.h> 78#include <openssl/x509.h> 79#include <openssl/pem.h> 80#include <openssl/ssl.h> 81#include <openssl/err.h> 82#ifdef HAVE_OPENSSL_ENGINE_H 83#include <openssl/engine.h> 84#endif 85#ifdef HAVE_OPENSSL_PKCS12_H 86#include <openssl/pkcs12.h> 87#endif 88#else /* SSLeay-style includes */ 89#include <rsa.h> 90#include <crypto.h> 91#include <x509.h> 92#include <pem.h> 93#include <ssl.h> 94#include <err.h> 95#ifdef HAVE_OPENSSL_ENGINE_H 96#include <engine.h> 97#endif 98#ifdef HAVE_OPENSSL_PKCS12_H 99#include <pkcs12.h> 100#endif 101#endif /* USE_OPENSSL */ 102#ifdef USE_GNUTLS 103#error Configuration error; cannot use GnuTLS *and* OpenSSL. 104#endif 105#endif /* USE_SSLEAY */ 106 107#ifdef USE_GNUTLS 108#include <gnutls/gnutls.h> 109#endif 110 111#ifdef USE_POLARSSL 112#include <polarssl/ssl.h> 113#include <polarssl/version.h> 114#if POLARSSL_VERSION_NUMBER<0x01010000 115#include <polarssl/havege.h> 116#else 117#include <polarssl/entropy.h> 118#include <polarssl/ctr_drbg.h> 119#endif /* POLARSSL_VERSION_NUMBER<0x01010000 */ 120#endif /* USE_POLARSSL */ 121 122#ifdef USE_CYASSL 123#undef OCSP_REQUEST /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */ 124#undef OCSP_RESPONSE /* avoid cyassl/openssl/ssl.h clash with wincrypt.h */ 125#include <cyassl/openssl/ssl.h> 126#endif 127 128#ifdef USE_NSS 129#include <nspr.h> 130#include <pk11pub.h> 131#endif 132 133#ifdef USE_QSOSSL 134#include <qsossl.h> 135#endif 136 137#ifdef USE_AXTLS 138#include <axTLS/ssl.h> 139#undef malloc 140#undef calloc 141#undef realloc 142#endif /* USE_AXTLS */ 143 144#ifdef USE_SCHANNEL 145#include "curl_sspi.h" 146#include <schnlsp.h> 147#include <schannel.h> 148#endif 149 150#ifdef USE_DARWINSSL 151#include <Security/Security.h> 152/* For some reason, when building for iOS, the omnibus header above does 153 * not include SecureTransport.h as of iOS SDK 5.1. */ 154#include <Security/SecureTransport.h> 155#endif 156 157#ifdef HAVE_NETINET_IN_H 158#include <netinet/in.h> 159#endif 160 161#include "timeval.h" 162 163#ifdef HAVE_ZLIB_H 164#include <zlib.h> /* for content-encoding */ 165#ifdef __SYMBIAN32__ 166/* zlib pollutes the namespace with this definition */ 167#undef WIN32 168#endif 169#endif 170 171#include <curl/curl.h> 172 173#include "http_chunks.h" /* for the structs and enum stuff */ 174#include "hostip.h" 175#include "hash.h" 176#include "splay.h" 177 178#include "imap.h" 179#include "pop3.h" 180#include "smtp.h" 181#include "ftp.h" 182#include "file.h" 183#include "ssh.h" 184#include "http.h" 185#include "rtsp.h" 186#include "wildcard.h" 187 188#ifdef HAVE_GSSAPI 189# ifdef HAVE_GSSGNU 190# include <gss.h> 191# elif defined HAVE_GSSMIT 192# include <gssapi/gssapi.h> 193# include <gssapi/gssapi_generic.h> 194# else 195# include <gssapi.h> 196# endif 197#endif 198 199#ifdef HAVE_LIBSSH2_H 200#include <libssh2.h> 201#include <libssh2_sftp.h> 202#endif /* HAVE_LIBSSH2_H */ 203 204/* Download buffer size, keep it fairly big for speed reasons */ 205#undef BUFSIZE 206#define BUFSIZE CURL_MAX_WRITE_SIZE 207 208/* Initial size of the buffer to store headers in, it'll be enlarged in case 209 of need. */ 210#define HEADERSIZE 256 211 212#define CURLEASY_MAGIC_NUMBER 0xc0dedbadU 213 214/* Some convenience macros to get the larger/smaller value out of two given. 215 We prefix with CURL to prevent name collisions. */ 216#define CURLMAX(x,y) ((x)>(y)?(x):(y)) 217#define CURLMIN(x,y) ((x)<(y)?(x):(y)) 218 219 220#if defined(HAVE_KRB4) || defined(HAVE_GSSAPI) 221/* Types needed for krb4/5-ftp connections */ 222struct krb4buffer { 223 void *data; 224 size_t size; 225 size_t index; 226 int eof_flag; 227}; 228 229enum protection_level { 230 PROT_NONE, /* first in list */ 231 PROT_CLEAR, 232 PROT_SAFE, 233 PROT_CONFIDENTIAL, 234 PROT_PRIVATE, 235 PROT_CMD, 236 PROT_LAST /* last in list */ 237}; 238#endif 239 240#ifdef USE_SCHANNEL 241/* Structs to store Schannel handles */ 242struct curl_schannel_cred { 243 CredHandle cred_handle; 244 TimeStamp time_stamp; 245 int refcount; 246}; 247 248struct curl_schannel_ctxt { 249 CtxtHandle ctxt_handle; 250 TimeStamp time_stamp; 251}; 252#endif 253 254/* enum for the nonblocking SSL connection state machine */ 255typedef enum { 256 ssl_connect_1, 257 ssl_connect_2, 258 ssl_connect_2_reading, 259 ssl_connect_2_writing, 260 ssl_connect_3, 261 ssl_connect_done 262} ssl_connect_state; 263 264typedef enum { 265 ssl_connection_none, 266 ssl_connection_negotiating, 267 ssl_connection_complete 268} ssl_connection_state; 269 270/* struct for data related to each SSL connection */ 271struct ssl_connect_data { 272 /* Use ssl encrypted communications TRUE/FALSE, not necessarily using it atm 273 but at least asked to or meaning to use it. See 'state' for the exact 274 current state of the connection. */ 275 bool use; 276 ssl_connection_state state; 277#ifdef USE_SSLEAY 278 /* these ones requires specific SSL-types */ 279 SSL_CTX* ctx; 280 SSL* handle; 281 X509* server_cert; 282 ssl_connect_state connecting_state; 283#endif /* USE_SSLEAY */ 284#ifdef USE_GNUTLS 285 gnutls_session session; 286 gnutls_certificate_credentials cred; 287#ifdef USE_TLS_SRP 288 gnutls_srp_client_credentials srp_client_cred; 289#endif 290 ssl_connect_state connecting_state; 291#endif /* USE_GNUTLS */ 292#ifdef USE_POLARSSL 293#if POLARSSL_VERSION_NUMBER<0x01010000 294 havege_state hs; 295#else 296 /* from v1.1.0, use ctr_drbg and entropy */ 297 ctr_drbg_context ctr_drbg; 298 entropy_context entropy; 299#endif /* POLARSSL_VERSION_NUMBER<0x01010000 */ 300 ssl_context ssl; 301 ssl_session ssn; 302 int server_fd; 303 x509_cert cacert; 304 x509_cert clicert; 305 x509_crl crl; 306 rsa_context rsa; 307 ssl_connect_state connecting_state; 308#endif /* USE_POLARSSL */ 309#ifdef USE_CYASSL 310 SSL_CTX* ctx; 311 SSL* handle; 312 ssl_connect_state connecting_state; 313#endif /* USE_CYASSL */ 314#ifdef USE_NSS 315 PRFileDesc *handle; 316 char *client_nickname; 317 struct SessionHandle *data; 318 struct curl_llist *obj_list; 319 PK11GenericObject *obj_clicert; 320#endif /* USE_NSS */ 321#ifdef USE_QSOSSL 322 SSLHandle *handle; 323#endif /* USE_QSOSSL */ 324#ifdef USE_AXTLS 325 SSL_CTX* ssl_ctx; 326 SSL* ssl; 327#endif /* USE_AXTLS */ 328#ifdef USE_SCHANNEL 329 struct curl_schannel_cred *cred; 330 struct curl_schannel_ctxt *ctxt; 331 SecPkgContext_StreamSizes stream_sizes; 332 ssl_connect_state connecting_state; 333 size_t encdata_length, decdata_length; 334 size_t encdata_offset, decdata_offset; 335 unsigned char *encdata_buffer, *decdata_buffer; 336 unsigned long req_flags, ret_flags; 337#endif /* USE_SCHANNEL */ 338#ifdef USE_DARWINSSL 339 SSLContextRef ssl_ctx; 340 curl_socket_t ssl_sockfd; 341 ssl_connect_state connecting_state; 342 bool ssl_direction; /* true if writing, false if reading */ 343 size_t ssl_write_buffered_length; 344#endif /* USE_DARWINSSL */ 345}; 346 347struct ssl_config_data { 348 long version; /* what version the client wants to use */ 349 long certverifyresult; /* result from the certificate verification */ 350 351 bool verifypeer; /* set TRUE if this is desired */ 352 bool verifyhost; /* set TRUE if CN/SAN must match hostname */ 353 char *CApath; /* certificate dir (doesn't work on windows) */ 354 char *CAfile; /* certificate to verify peer against */ 355 const char *CRLfile; /* CRL to check certificate revocation */ 356 const char *issuercert;/* optional issuer certificate filename */ 357 char *random_file; /* path to file containing "random" data */ 358 char *egdsocket; /* path to file containing the EGD daemon socket */ 359 char *cipher_list; /* list of ciphers to use */ 360 size_t max_ssl_sessions; /* SSL session id cache size */ 361 curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */ 362 void *fsslctxp; /* parameter for call back */ 363 bool sessionid; /* cache session IDs or not */ 364 bool certinfo; /* gather lots of certificate info */ 365 366#ifdef USE_TLS_SRP 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) */ 370#endif 371}; 372 373/* information stored about one single SSL session */ 374struct curl_ssl_session { 375 char *name; /* host name for which this ID was used */ 376 void *sessionid; /* as returned from the SSL layer */ 377 size_t idsize; /* if known, otherwise 0 */ 378 long age; /* just a number, the higher the more recent */ 379 unsigned short remote_port; /* remote port to connect to */ 380 struct ssl_config_data ssl_config; /* setup for this session */ 381}; 382 383/* Struct used for Digest challenge-response authentication */ 384struct digestdata { 385 char *nonce; 386 char *cnonce; 387 char *realm; 388 int algo; 389 bool stale; /* set true for re-negotiation */ 390 char *opaque; 391 char *qop; 392 char *algorithm; 393 int nc; /* nounce count */ 394}; 395 396typedef enum { 397 NTLMSTATE_NONE, 398 NTLMSTATE_TYPE1, 399 NTLMSTATE_TYPE2, 400 NTLMSTATE_TYPE3, 401 NTLMSTATE_LAST 402} curlntlm; 403 404#ifdef USE_WINDOWS_SSPI 405#include "curl_sspi.h" 406#endif 407 408#if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV) 409#include <iconv.h> 410#endif 411 412/* Struct used for NTLM challenge-response authentication */ 413struct ntlmdata { 414 curlntlm state; 415#ifdef USE_WINDOWS_SSPI 416 CredHandle handle; 417 CtxtHandle c_handle; 418 SEC_WINNT_AUTH_IDENTITY identity; 419 SEC_WINNT_AUTH_IDENTITY *p_identity; 420 int has_handles; 421 void *type_2; 422 unsigned long n_type_2; 423#else 424 unsigned int flags; 425 unsigned char nonce[8]; 426#endif 427}; 428 429#ifdef USE_HTTP_NEGOTIATE 430struct negotiatedata { 431 /* when doing Negotiate we first need to receive an auth token and then we 432 need to send our header */ 433 enum { GSS_AUTHNONE, GSS_AUTHRECV, GSS_AUTHSENT } state; 434 bool gss; /* Whether we're processing GSS-Negotiate or Negotiate */ 435 const char* protocol; /* "GSS-Negotiate" or "Negotiate" */ 436#ifdef HAVE_GSSAPI 437 OM_uint32 status; 438 gss_ctx_id_t context; 439 gss_name_t server_name; 440 gss_buffer_desc output_token; 441#else 442#ifdef USE_WINDOWS_SSPI 443 DWORD status; 444 CtxtHandle *context; 445 CredHandle *credentials; 446 char server_name[1024]; 447 size_t max_token_length; 448 BYTE *output_token; 449 size_t output_token_length; 450#endif 451#endif 452}; 453#endif 454 455 456/* 457 * Boolean values that concerns this connection. 458 */ 459struct ConnectBits { 460 bool close; /* if set, we close the connection after this request */ 461 bool reuse; /* if set, this is a re-used connection */ 462 bool proxy; /* if set, this transfer is done through a proxy - any type */ 463 bool httpproxy; /* if set, this transfer is done through a http proxy */ 464 bool user_passwd; /* do we use user+password for this connection? */ 465 bool proxy_user_passwd; /* user+password for the proxy? */ 466 bool ipv6_ip; /* we communicate with a remote site specified with pure IPv6 467 IP address */ 468 bool ipv6; /* we communicate with a site using an IPv6 address */ 469 470 bool do_more; /* this is set TRUE if the ->curl_do_more() function is 471 supposed to be called, after ->curl_do() */ 472 bool tcpconnect[2]; /* the TCP layer (or similar) is connected, this is set 473 the first time on the first connect function call */ 474 bool protoconnstart;/* the protocol layer has STARTED its operation after 475 the TCP layer connect */ 476 477 bool retry; /* this connection is about to get closed and then 478 re-attempted at another connection. */ 479 bool tunnel_proxy; /* if CONNECT is used to "tunnel" through the proxy. 480 This is implicit when SSL-protocols are used through 481 proxies, but can also be enabled explicitly by 482 apps */ 483 bool authneg; /* TRUE when the auth phase has started, which means 484 that we are creating a request with an auth header, 485 but it is not the final request in the auth 486 negotiation. */ 487 bool rewindaftersend;/* TRUE when the sending couldn't be stopped even 488 though it will be discarded. When the whole send 489 operation is done, we must call the data rewind 490 callback. */ 491 bool ftp_use_epsv; /* As set with CURLOPT_FTP_USE_EPSV, but if we find out 492 EPSV doesn't work we disable it for the forthcoming 493 requests */ 494 495 bool ftp_use_eprt; /* As set with CURLOPT_FTP_USE_EPRT, but if we find out 496 EPRT doesn't work we disable it for the forthcoming 497 requests */ 498 bool netrc; /* name+password provided by netrc */ 499 bool userpwd_in_url; /* name+password found in url */ 500 501 bool done; /* set to FALSE when Curl_do() is called and set to TRUE 502 when Curl_done() is called, to prevent Curl_done() to 503 get invoked twice when the multi interface is 504 used. */ 505 bool stream_was_rewound; /* Indicates that the stream was rewound after a 506 request read past the end of its response byte 507 boundary */ 508 bool proxy_connect_closed; /* set true if a proxy disconnected the 509 connection in a CONNECT request with auth, so 510 that libcurl should reconnect and continue. */ 511 bool bound; /* set true if bind() has already been done on this socket/ 512 connection */ 513 bool type_set; /* type= was used in the URL */ 514}; 515 516struct hostname { 517 char *rawalloc; /* allocated "raw" version of the name */ 518 char *encalloc; /* allocated IDN-encoded version of the name */ 519 char *name; /* name to use internally, might be encoded, might be raw */ 520 const char *dispname; /* name to display, as 'name' might be encoded */ 521}; 522 523/* 524 * Flags on the keepon member of the Curl_transfer_keeper 525 */ 526 527#define KEEP_NONE 0 528#define KEEP_RECV (1<<0) /* there is or may be data to read */ 529#define KEEP_SEND (1<<1) /* there is or may be data to write */ 530#define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there 531 might still be data to read */ 532#define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there 533 might still be data to write */ 534#define KEEP_RECV_PAUSE (1<<4) /* reading is paused */ 535#define KEEP_SEND_PAUSE (1<<5) /* writing is paused */ 536 537#define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE) 538#define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE) 539 540 541#ifdef HAVE_LIBZ 542typedef enum { 543 ZLIB_UNINIT, /* uninitialized */ 544 ZLIB_INIT, /* initialized */ 545 ZLIB_GZIP_HEADER, /* reading gzip header */ 546 ZLIB_GZIP_INFLATING, /* inflating gzip stream */ 547 ZLIB_INIT_GZIP /* initialized in transparent gzip mode */ 548} zlibInitState; 549#endif 550 551#ifdef CURLRES_ASYNCH 552struct Curl_async { 553 char *hostname; 554 int port; 555 struct Curl_dns_entry *dns; 556 bool done; /* set TRUE when the lookup is complete */ 557 int status; /* if done is TRUE, this is the status from the callback */ 558 void *os_specific; /* 'struct thread_data' for Windows */ 559}; 560#endif 561 562#define FIRSTSOCKET 0 563#define SECONDARYSOCKET 1 564 565/* These function pointer types are here only to allow easier typecasting 566 within the source when we need to cast between data pointers (such as NULL) 567 and function pointers. */ 568typedef CURLcode (*Curl_do_more_func)(struct connectdata *, bool *); 569typedef CURLcode (*Curl_done_func)(struct connectdata *, CURLcode, bool); 570 571 572enum expect100 { 573 EXP100_SEND_DATA, /* enough waiting, just send the body now */ 574 EXP100_AWAITING_CONTINUE, /* waiting for the 100 Continue header */ 575 EXP100_SENDING_REQUEST, /* still sending the request but will wait for 576 the 100 header once done with the request */ 577 EXP100_FAILED /* used on 417 Expectation Failed */ 578}; 579 580/* 581 * Request specific data in the easy handle (SessionHandle). Previously, 582 * these members were on the connectdata struct but since a conn struct may 583 * now be shared between different SessionHandles, we store connection-specific 584 * data here. This struct only keeps stuff that's interesting for *this* 585 * request, as it will be cleared between multiple ones 586 */ 587struct SingleRequest { 588 curl_off_t size; /* -1 if unknown at this point */ 589 curl_off_t *bytecountp; /* return number of bytes read or NULL */ 590 591 curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch, 592 -1 means unlimited */ 593 curl_off_t *writebytecountp; /* return number of bytes written or NULL */ 594 595 curl_off_t bytecount; /* total number of bytes read */ 596 curl_off_t writebytecount; /* number of bytes written */ 597 598 long headerbytecount; /* only count received headers */ 599 long deductheadercount; /* this amount of bytes doesn't count when we check 600 if anything has been transferred at the end of a 601 connection. We use this counter to make only a 602 100 reply (without a following second response 603 code) result in a CURLE_GOT_NOTHING error code */ 604 605 struct timeval start; /* transfer started at this time */ 606 struct timeval now; /* current time */ 607 bool header; /* incoming data has HTTP header */ 608 enum { 609 HEADER_NORMAL, /* no bad header at all */ 610 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest 611 is normal data */ 612 HEADER_ALLBAD /* all was believed to be header */ 613 } badheader; /* the header was deemed bad and will be 614 written as body */ 615 int headerline; /* counts header lines to better track the 616 first one */ 617 char *hbufp; /* points at *end* of header line */ 618 size_t hbuflen; 619 char *str; /* within buf */ 620 char *str_start; /* within buf */ 621 char *end_ptr; /* within buf */ 622 char *p; /* within headerbuff */ 623 bool content_range; /* set TRUE if Content-Range: was found */ 624 curl_off_t offset; /* possible resume offset read from the 625 Content-Range: header */ 626 int httpcode; /* error code from the 'HTTP/1.? XXX' or 627 'RTSP/1.? XXX' line */ 628 struct timeval start100; /* time stamp to wait for the 100 code from */ 629 enum expect100 exp100; /* expect 100 continue state */ 630 631 int auto_decoding; /* What content encoding. sec 3.5, RFC2616. */ 632 633#define IDENTITY 0 /* No encoding */ 634#define DEFLATE 1 /* zlib deflate [RFC 1950 & 1951] */ 635#define GZIP 2 /* gzip algorithm [RFC 1952] */ 636#define COMPRESS 3 /* Not handled, added for completeness */ 637 638#ifdef HAVE_LIBZ 639 zlibInitState zlib_init; /* possible zlib init state; 640 undefined if Content-Encoding header. */ 641 z_stream z; /* State structure for zlib. */ 642#endif 643 644 time_t timeofdoc; 645 long bodywrites; 646 647 char *buf; 648 char *uploadbuf; 649 curl_socket_t maxfd; 650 651 int keepon; 652 653 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload 654 and we're uploading the last chunk */ 655 656 bool ignorebody; /* we read a response-body but we ignore it! */ 657 bool ignorecl; /* This HTTP response has no body so we ignore the Content- 658 Length: header */ 659 660 char *location; /* This points to an allocated version of the Location: 661 header data */ 662 char *newurl; /* Set to the new URL to use when a redirect or a retry is 663 wanted */ 664 665 /* 'upload_present' is used to keep a byte counter of how much data there is 666 still left in the buffer, aimed for upload. */ 667 ssize_t upload_present; 668 669 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a 670 buffer, so the next read should read from where this pointer points to, 671 and the 'upload_present' contains the number of bytes available at this 672 position */ 673 char *upload_fromhere; 674 675 bool chunk; /* if set, this is a chunked transfer-encoding */ 676 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding 677 on upload */ 678 bool getheader; /* TRUE if header parsing is wanted */ 679 680 bool forbidchunk; /* used only to explicitly forbid chunk-upload for 681 specific upload buffers. See readmoredata() in 682 http.c for details. */ 683}; 684 685/* 686 * Specific protocol handler. 687 */ 688 689struct Curl_handler { 690 const char * scheme; /* URL scheme name. */ 691 692 /* Complement to setup_connection_internals(). */ 693 CURLcode (*setup_connection)(struct connectdata *); 694 695 /* These two functions MUST be set to be protocol dependent */ 696 CURLcode (*do_it)(struct connectdata *, bool *done); 697 Curl_done_func done; 698 699 /* If the curl_do() function is better made in two halves, this 700 * curl_do_more() function will be called afterwards, if set. For example 701 * for doing the FTP stuff after the PASV/PORT command. 702 */ 703 Curl_do_more_func do_more; 704 705 /* This function *MAY* be set to a protocol-dependent function that is run 706 * after the connect() and everything is done, as a step in the connection. 707 * The 'done' pointer points to a bool that should be set to TRUE if the 708 * function completes before return. If it doesn't complete, the caller 709 * should call the curl_connecting() function until it is. 710 */ 711 CURLcode (*connect_it)(struct connectdata *, bool *done); 712 713 /* See above. Currently only used for FTP. */ 714 CURLcode (*connecting)(struct connectdata *, bool *done); 715 CURLcode (*doing)(struct connectdata *, bool *done); 716 717 /* Called from the multi interface during the PROTOCONNECT phase, and it 718 should then return a proper fd set */ 719 int (*proto_getsock)(struct connectdata *conn, 720 curl_socket_t *socks, 721 int numsocks); 722 723 /* Called from the multi interface during the DOING phase, and it should 724 then return a proper fd set */ 725 int (*doing_getsock)(struct connectdata *conn, 726 curl_socket_t *socks, 727 int numsocks); 728 729 /* Called from the multi interface during the DO_MORE phase, and it should 730 then return a proper fd set */ 731 int (*domore_getsock)(struct connectdata *conn, 732 curl_socket_t *socks, 733 int numsocks); 734 735 /* Called from the multi interface during the DO_DONE, PERFORM and 736 WAITPERFORM phases, and it should then return a proper fd set. Not setting 737 this will make libcurl use the generic default one. */ 738 int (*perform_getsock)(const struct connectdata *conn, 739 curl_socket_t *socks, 740 int numsocks); 741 742 /* This function *MAY* be set to a protocol-dependent function that is run 743 * by the curl_disconnect(), as a step in the disconnection. If the handler 744 * is called because the connection has been considered dead, dead_connection 745 * is set to TRUE. 746 */ 747 CURLcode (*disconnect)(struct connectdata *, bool dead_connection); 748 749 /* If used, this function gets called from transfer.c:readwrite_data() to 750 allow the protocol to do extra reads/writes */ 751 CURLcode (*readwrite)(struct SessionHandle *data, struct connectdata *conn, 752 ssize_t *nread, bool *readmore); 753 754 long defport; /* Default port. */ 755 unsigned int protocol; /* See CURLPROTO_* */ 756 unsigned int flags; /* Extra particular characteristics, see PROTOPT_* */ 757}; 758 759#define PROTOPT_NONE 0 /* nothing extra */ 760#define PROTOPT_SSL (1<<0) /* uses SSL */ 761#define PROTOPT_DUAL (1<<1) /* this protocol uses two connections */ 762#define PROTOPT_CLOSEACTION (1<<2) /* need action before socket close */ 763/* some protocols will have to call the underlying functions without regard to 764 what exact state the socket signals. IE even if the socket says "readable", 765 the send function might need to be called while uploading, or vice versa. 766*/ 767#define PROTOPT_DIRLOCK (1<<3) 768#define PROTOPT_NONETWORK (1<<4) /* protocol doesn't use the network! */ 769#define PROTOPT_NEEDSPWD (1<<5) /* needs a password, and if none is set it 770 gets a default */ 771#define PROTOPT_NOURLQUERY (1<<6) /* protocol can't handle 772 url query strings (?foo=bar) ! */ 773 774 775/* return the count of bytes sent, or -1 on error */ 776typedef ssize_t (Curl_send)(struct connectdata *conn, /* connection data */ 777 int sockindex, /* socketindex */ 778 const void *buf, /* data to write */ 779 size_t len, /* max amount to write */ 780 CURLcode *err); /* error to return */ 781 782/* return the count of bytes read, or -1 on error */ 783typedef ssize_t (Curl_recv)(struct connectdata *conn, /* connection data */ 784 int sockindex, /* socketindex */ 785 char *buf, /* store data here */ 786 size_t len, /* max amount to read */ 787 CURLcode *err); /* error to return */ 788 789/* 790 * The connectdata struct contains all fields and variables that should be 791 * unique for an entire connection. 792 */ 793struct connectdata { 794 /* 'data' is the CURRENT SessionHandle using this connection -- take great 795 caution that this might very well vary between different times this 796 connection is used! */ 797 struct SessionHandle *data; 798 799 /* chunk is for HTTP chunked encoding, but is in the general connectdata 800 struct only because we can do just about any protocol through a HTTP proxy 801 and a HTTP proxy may in fact respond using chunked encoding */ 802 struct Curl_chunker chunk; 803 804 curl_closesocket_callback fclosesocket; /* function closing the socket(s) */ 805 void *closesocket_client; 806 807 bool inuse; /* This is a marker for the connection cache logic. If this is 808 TRUE this handle is being used by an easy handle and cannot 809 be used by any other easy handle without careful 810 consideration (== only for pipelining). */ 811 812 /**** Fields set when inited and not modified again */ 813 long connection_id; /* Contains a unique number to make it easier to 814 track the connections in the log output */ 815 816 /* 'dns_entry' is the particular host we use. This points to an entry in the 817 DNS cache and it will not get pruned while locked. It gets unlocked in 818 Curl_done(). This entry will be NULL if the connection is re-used as then 819 there is no name resolve done. */ 820 struct Curl_dns_entry *dns_entry; 821 822 /* 'ip_addr' is the particular IP we connected to. It points to a struct 823 within the DNS cache, so this pointer is only valid as long as the DNS 824 cache entry remains locked. It gets unlocked in Curl_done() */ 825 Curl_addrinfo *ip_addr; 826 827 /* 'ip_addr_str' is the ip_addr data as a human readable string. 828 It remains available as long as the connection does, which is longer than 829 the ip_addr itself. */ 830 char ip_addr_str[MAX_IPADR_LEN]; 831 832 unsigned int scope; /* address scope for IPv6 */ 833 834 int socktype; /* SOCK_STREAM or SOCK_DGRAM */ 835 836 struct hostname host; 837 struct hostname proxy; 838 839 long port; /* which port to use locally */ 840 unsigned short remote_port; /* what remote port to connect to, 841 not the proxy port! */ 842 843 /* 'primary_ip' and 'primary_port' get filled with peer's numerical 844 ip address and port number whenever an outgoing connection is 845 *attempted* from the primary socket to a remote address. When more 846 than one address is tried for a connection these will hold data 847 for the last attempt. When the connection is actually established 848 these are updated with data which comes directly from the socket. */ 849 850 char primary_ip[MAX_IPADR_LEN]; 851 long primary_port; 852 853 /* 'local_ip' and 'local_port' get filled with local's numerical 854 ip address and port number whenever an outgoing connection is 855 **established** from the primary socket to a remote address. */ 856 857 char local_ip[MAX_IPADR_LEN]; 858 long local_port; 859 860 char *user; /* user name string, allocated */ 861 char *passwd; /* password string, allocated */ 862 863 char *proxyuser; /* proxy user name string, allocated */ 864 char *proxypasswd; /* proxy password string, allocated */ 865 curl_proxytype proxytype; /* what kind of proxy that is in use */ 866 867 int httpversion; /* the HTTP version*10 reported by the server */ 868 int rtspversion; /* the RTSP version*10 reported by the server */ 869 870 struct timeval now; /* "current" time */ 871 struct timeval created; /* creation time */ 872 curl_socket_t sock[2]; /* two sockets, the second is used for the data 873 transfer when doing FTP */ 874 bool sock_accepted[2]; /* TRUE if the socket on this index was created with 875 accept() */ 876 Curl_recv *recv[2]; 877 Curl_send *send[2]; 878 879 struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */ 880 struct ssl_config_data ssl_config; 881 882 struct ConnectBits bits; /* various state-flags for this connection */ 883 884 /* connecttime: when connect() is called on the current IP address. Used to 885 be able to track when to move on to try next IP - but only when the multi 886 interface is used. */ 887 struct timeval connecttime; 888 /* The two fields below get set in Curl_connecthost */ 889 int num_addr; /* number of addresses to try to connect to */ 890 long timeoutms_per_addr; /* how long time in milliseconds to spend on 891 trying to connect to each IP address */ 892 893 const struct Curl_handler *handler; /* Connection's protocol handler */ 894 const struct Curl_handler *given; /* The protocol first given */ 895 896 long ip_version; /* copied from the SessionHandle at creation time */ 897 898 /**** curl_get() phase fields */ 899 900 curl_socket_t sockfd; /* socket to read from or CURL_SOCKET_BAD */ 901 curl_socket_t writesockfd; /* socket to write to, it may very 902 well be the same we read from. 903 CURL_SOCKET_BAD disables */ 904 905 /** Dynamicly allocated strings, MUST be freed before this **/ 906 /** struct is killed. **/ 907 struct dynamically_allocated_data { 908 char *proxyuserpwd; 909 char *uagent; 910 char *accept_encoding; 911 char *userpwd; 912 char *rangeline; 913 char *ref; 914 char *host; 915 char *cookiehost; 916 char *rtsp_transport; 917 char *te; /* TE: request header */ 918 } allocptr; 919 920 int sec_complete; /* if kerberos is enabled for this connection */ 921#if defined(HAVE_KRB4) || defined(HAVE_GSSAPI) 922 enum protection_level command_prot; 923 enum protection_level data_prot; 924 enum protection_level request_data_prot; 925 size_t buffer_size; 926 struct krb4buffer in_buffer; 927 void *app_data; 928 const struct Curl_sec_client_mech *mech; 929 struct sockaddr_in local_addr; 930#endif 931 932 /* the two following *_inuse fields are only flags, not counters in any way. 933 If TRUE it means the channel is in use, and if FALSE it means the channel 934 is up for grabs by one. */ 935 936 bool readchannel_inuse; /* whether the read channel is in use by an easy 937 handle */ 938 bool writechannel_inuse; /* whether the write channel is in use by an easy 939 handle */ 940 struct curl_llist *send_pipe; /* List of handles waiting to 941 send on this pipeline */ 942 struct curl_llist *recv_pipe; /* List of handles waiting to read 943 their responses on this pipeline */ 944 char* master_buffer; /* The master buffer allocated on-demand; 945 used for pipelining. */ 946 size_t read_pos; /* Current read position in the master buffer */ 947 size_t buf_len; /* Length of the buffer?? */ 948 949 950 curl_seek_callback seek_func; /* function that seeks the input */ 951 void *seek_client; /* pointer to pass to the seek() above */ 952 953 /*************** Request - specific items ************/ 954 955 /* previously this was in the urldata struct */ 956 curl_read_callback fread_func; /* function that reads the input */ 957 void *fread_in; /* pointer to pass to the fread() above */ 958 959 struct ntlmdata ntlm; /* NTLM differs from other authentication schemes 960 because it authenticates connections, not 961 single requests! */ 962 struct ntlmdata proxyntlm; /* NTLM data for proxy */ 963 964#if defined(USE_NTLM) && defined(NTLM_WB_ENABLED) 965 /* used for communication with Samba's winbind daemon helper ntlm_auth */ 966 curl_socket_t ntlm_auth_hlpr_socket; 967 pid_t ntlm_auth_hlpr_pid; 968 char* challenge_header; 969 char* response_header; 970#endif 971 972 char syserr_buf [256]; /* buffer for Curl_strerror() */ 973 974#ifdef CURLRES_ASYNCH 975 /* data used for the asynch name resolve callback */ 976 struct Curl_async async; 977#endif 978 979 /* These three are used for chunked-encoding trailer support */ 980 char *trailer; /* allocated buffer to store trailer in */ 981 int trlMax; /* allocated buffer size */ 982 int trlPos; /* index of where to store data */ 983 984 union { 985 struct ftp_conn ftpc; 986 struct ssh_conn sshc; 987 struct tftp_state_data *tftpc; 988 struct imap_conn imapc; 989 struct pop3_conn pop3c; 990 struct smtp_conn smtpc; 991 struct rtsp_conn rtspc; 992 void *generic; 993 } proto; 994 995 int cselect_bits; /* bitmask of socket events */ 996 int waitfor; /* current READ/WRITE bits to wait for */ 997 998#if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI) 999 int socks5_gssapi_enctype; 1000#endif 1001 1002 bool verifypeer; 1003 bool verifyhost; 1004 1005 /* When this connection is created, store the conditions for the local end 1006 bind. This is stored before the actual bind and before any connection is 1007 made and will serve the purpose of being used for comparison reasons so 1008 that subsequent bound-requested connections aren't accidentally re-using 1009 wrong connections. */ 1010 char *localdev; 1011 unsigned short localport; 1012 int localportrange; 1013 1014 /* tunnel as in tunnel through a HTTP proxy with CONNECT */ 1015 enum { 1016 TUNNEL_INIT, /* init/default/no tunnel state */ 1017 TUNNEL_CONNECT, /* CONNECT has been sent off */ 1018 TUNNEL_COMPLETE /* CONNECT response received completely */ 1019 } tunnel_state[2]; /* two separate ones to allow FTP */ 1020 struct connectbundle *bundle; /* The bundle we are member of */ 1021}; 1022 1023/* The end of connectdata. */ 1024 1025/* 1026 * Struct to keep statistical and informational data. 1027 */ 1028struct PureInfo { 1029 int httpcode; /* Recent HTTP, FTP, or RTSP response code */ 1030 int httpproxycode; /* response code from proxy when received separate */ 1031 int httpversion; /* the http version number X.Y = X*10+Y */ 1032 long filetime; /* If requested, this is might get set. Set to -1 if the time 1033 was unretrievable. We cannot have this of type time_t, 1034 since time_t is unsigned on several platforms such as 1035 OpenVMS. */ 1036 bool timecond; /* set to TRUE if the time condition didn't match, which 1037 thus made the document NOT get fetched */ 1038 long header_size; /* size of read header(s) in bytes */ 1039 long request_size; /* the amount of bytes sent in the request(s) */ 1040 unsigned long proxyauthavail; /* what proxy auth types were announced */ 1041 unsigned long httpauthavail; /* what host auth types were announced */ 1042 long numconnects; /* how many new connection did libcurl created */ 1043 char *contenttype; /* the content type of the object */ 1044 char *wouldredirect; /* URL this would've been redirected to if asked to */ 1045 1046 /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip' 1047 and, 'conn_local_port' are copied over from the connectdata struct in 1048 order to allow curl_easy_getinfo() to return this information even when 1049 the session handle is no longer associated with a connection, and also 1050 allow curl_easy_reset() to clear this information from the session handle 1051 without disturbing information which is still alive, and that might be 1052 reused, in the connection cache. */ 1053 1054 char conn_primary_ip[MAX_IPADR_LEN]; 1055 long conn_primary_port; 1056 1057 char conn_local_ip[MAX_IPADR_LEN]; 1058 long conn_local_port; 1059 1060 struct curl_certinfo certs; /* info about the certs, only populated in 1061 OpenSSL builds. Asked for with 1062 CURLOPT_CERTINFO / CURLINFO_CERTINFO */ 1063}; 1064 1065 1066struct Progress { 1067 long lastshow; /* time() of the last displayed progress meter or NULL to 1068 force redraw at next call */ 1069 curl_off_t size_dl; /* total expected size */ 1070 curl_off_t size_ul; /* total expected size */ 1071 curl_off_t downloaded; /* transferred so far */ 1072 curl_off_t uploaded; /* transferred so far */ 1073 1074 curl_off_t current_speed; /* uses the currently fastest transfer */ 1075 1076 bool callback; /* set when progress callback is used */ 1077 int width; /* screen width at download start */ 1078 int flags; /* see progress.h */ 1079 1080 double timespent; 1081 1082 curl_off_t dlspeed; 1083 curl_off_t ulspeed; 1084 1085 double t_nslookup; 1086 double t_connect; 1087 double t_appconnect; 1088 double t_pretransfer; 1089 double t_starttransfer; 1090 double t_redirect; 1091 1092 struct timeval start; 1093 struct timeval t_startsingle; 1094 struct timeval t_acceptdata; 1095#define CURR_TIME (5+1) /* 6 entries for 5 seconds */ 1096 1097 curl_off_t speeder[ CURR_TIME ]; 1098 struct timeval speeder_time[ CURR_TIME ]; 1099 int speeder_c; 1100}; 1101 1102typedef enum { 1103 HTTPREQ_NONE, /* first in list */ 1104 HTTPREQ_GET, 1105 HTTPREQ_POST, 1106 HTTPREQ_POST_FORM, /* we make a difference internally */ 1107 HTTPREQ_PUT, 1108 HTTPREQ_HEAD, 1109 HTTPREQ_CUSTOM, 1110 HTTPREQ_LAST /* last in list */ 1111} Curl_HttpReq; 1112 1113typedef enum { 1114 RTSPREQ_NONE, /* first in list */ 1115 RTSPREQ_OPTIONS, 1116 RTSPREQ_DESCRIBE, 1117 RTSPREQ_ANNOUNCE, 1118 RTSPREQ_SETUP, 1119 RTSPREQ_PLAY, 1120 RTSPREQ_PAUSE, 1121 RTSPREQ_TEARDOWN, 1122 RTSPREQ_GET_PARAMETER, 1123 RTSPREQ_SET_PARAMETER, 1124 RTSPREQ_RECORD, 1125 RTSPREQ_RECEIVE, 1126 RTSPREQ_LAST /* last in list */ 1127} Curl_RtspReq; 1128 1129/* 1130 * Values that are generated, temporary or calculated internally for a 1131 * "session handle" must be defined within the 'struct UrlState'. This struct 1132 * will be used within the SessionHandle struct. When the 'SessionHandle' 1133 * struct is cloned, this data MUST NOT be copied. 1134 * 1135 * Remember that any "state" information goes globally for the curl handle. 1136 * Session-data MUST be put in the connectdata struct and here. */ 1137#define MAX_CURL_USER_LENGTH 256 1138#define MAX_CURL_PASSWORD_LENGTH 256 1139#define MAX_CURL_USER_LENGTH_TXT "255" 1140#define MAX_CURL_PASSWORD_LENGTH_TXT "255" 1141 1142struct auth { 1143 unsigned long want; /* Bitmask set to the authentication methods wanted by 1144 app (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */ 1145 unsigned long picked; 1146 unsigned long avail; /* Bitmask for what the server reports to support for 1147 this resource */ 1148 bool done; /* TRUE when the auth phase is done and ready to do the *actual* 1149 request */ 1150 bool multi; /* TRUE if this is not yet authenticated but within the auth 1151 multipass negotiation */ 1152 bool iestyle; /* TRUE if digest should be done IE-style or FALSE if it should 1153 be RFC compliant */ 1154}; 1155 1156struct UrlState { 1157 1158 /* Points to the connection cache */ 1159 struct conncache *conn_cache; 1160 1161 /* when curl_easy_perform() is called, the multi handle is "owned" by 1162 the easy handle so curl_easy_cleanup() on such an easy handle will 1163 also close the multi handle! */ 1164 bool multi_owned_by_easy; 1165 1166 /* buffers to store authentication data in, as parsed from input options */ 1167 struct timeval keeps_speed; /* for the progress meter really */ 1168 1169 struct connectdata *lastconnect; /* The last connection, NULL if undefined */ 1170 1171 char *headerbuff; /* allocated buffer to store headers in */ 1172 size_t headersize; /* size of the allocation */ 1173 1174 char buffer[BUFSIZE+1]; /* download buffer */ 1175 char uploadbuffer[BUFSIZE+1]; /* upload buffer */ 1176 curl_off_t current_speed; /* the ProgressShow() funcion sets this, 1177 bytes / second */ 1178 bool this_is_a_follow; /* this is a followed Location: request */ 1179 1180 char *first_host; /* if set, this should be the host name that we will 1181 sent authorization to, no else. Used to make Location: 1182 following not keep sending user+password... This is 1183 strdup() data. 1184 */ 1185 struct curl_ssl_session *session; /* array of 'max_ssl_sessions' size */ 1186 long sessionage; /* number of the most recent session */ 1187 char *tempwrite; /* allocated buffer to keep data in when a write 1188 callback returns to make the connection paused */ 1189 size_t tempwritesize; /* size of the 'tempwrite' allocated buffer */ 1190 int tempwritetype; /* type of the 'tempwrite' buffer as a bitmask that is 1191 used with Curl_client_write() */ 1192 char *scratch; /* huge buffer[BUFSIZE*2] when doing upload CRLF replacing */ 1193 bool errorbuf; /* Set to TRUE if the error buffer is already filled in. 1194 This must be set to FALSE every time _easy_perform() is 1195 called. */ 1196 int os_errno; /* filled in with errno whenever an error occurs */ 1197#ifdef HAVE_SIGNAL 1198 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */ 1199 void (*prev_signal)(int sig); 1200#endif 1201 bool allow_port; /* Is set.use_port allowed to take effect or not. This 1202 is always set TRUE when curl_easy_perform() is called. */ 1203 struct digestdata digest; /* state data for host Digest auth */ 1204 struct digestdata proxydigest; /* state data for proxy Digest auth */ 1205 1206#ifdef USE_HTTP_NEGOTIATE 1207 struct negotiatedata negotiate; /* state data for host Negotiate auth */ 1208 struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */ 1209#endif 1210 1211 struct auth authhost; /* auth details for host */ 1212 struct auth authproxy; /* auth details for proxy */ 1213 1214 bool authproblem; /* TRUE if there's some problem authenticating */ 1215 1216 void *resolver; /* resolver state, if it is used in the URL state - 1217 ares_channel f.e. */ 1218 1219#if defined(USE_SSLEAY) && defined(HAVE_OPENSSL_ENGINE_H) 1220 ENGINE *engine; 1221#endif /* USE_SSLEAY */ 1222 struct timeval expiretime; /* set this with Curl_expire() only */ 1223 struct Curl_tree timenode; /* for the splay stuff */ 1224 struct curl_llist *timeoutlist; /* list of pending timeouts */ 1225 1226 /* a place to store the most recently set FTP entrypath */ 1227 char *most_recent_ftp_entrypath; 1228 1229 /* set after initial USER failure, to prevent an authentication loop */ 1230 bool ftp_trying_alternative; 1231 1232 int httpversion; /* the lowest HTTP version*10 reported by any server 1233 involved in this request */ 1234 bool expect100header; /* TRUE if we added Expect: 100-continue */ 1235 1236 bool pipe_broke; /* TRUE if the connection we were pipelined on broke 1237 and we need to restart from the beginning */ 1238 1239#if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) && \ 1240 !defined(__SYMBIAN32__) 1241/* do FTP line-end conversions on most platforms */ 1242#define CURL_DO_LINEEND_CONV 1243 /* for FTP downloads: track CRLF sequences that span blocks */ 1244 bool prev_block_had_trailing_cr; 1245 /* for FTP downloads: how many CRLFs did we converted to LFs? */ 1246 curl_off_t crlf_conversions; 1247#endif 1248 char *pathbuffer;/* allocated buffer to store the URL's path part in */ 1249 char *path; /* path to use, points to somewhere within the pathbuffer 1250 area */ 1251 bool slash_removed; /* set TRUE if the 'path' points to a path where the 1252 initial URL slash separator has been taken off */ 1253 bool use_range; 1254 bool rangestringalloc; /* the range string is malloc()'ed */ 1255 1256 char *range; /* range, if used. See README for detailed specification on 1257 this syntax. */ 1258 curl_off_t resume_from; /* continue [ftp] transfer from here */ 1259 1260 /* This RTSP state information survives requests and connections */ 1261 long rtsp_next_client_CSeq; /* the session's next client CSeq */ 1262 long rtsp_next_server_CSeq; /* the session's next server CSeq */ 1263 long rtsp_CSeq_recv; /* most recent CSeq received */ 1264 1265 /* Protocol specific data. 1266 * 1267 ************************************************************************* 1268 * Note that this data will be REMOVED after each request, so anything that 1269 * should be kept/stored on a per-connection basis and thus live for the 1270 * next request on the same connection MUST be put in the connectdata struct! 1271 *************************************************************************/ 1272 union { 1273 struct HTTP *http; 1274 struct HTTP *https; /* alias, just for the sake of being more readable */ 1275 struct RTSP *rtsp; 1276 struct FTP *ftp; 1277 /* void *tftp; not used */ 1278 struct FILEPROTO *file; 1279 void *telnet; /* private for telnet.c-eyes only */ 1280 void *generic; 1281 struct SSHPROTO *ssh; 1282 struct IMAP *imap; 1283 struct POP3 *pop3; 1284 struct SMTP *smtp; 1285 } proto; 1286 /* current user of this SessionHandle instance, or NULL */ 1287 struct connectdata *current_conn; 1288 1289 /* if true, force SSL connection retry (workaround for certain servers) */ 1290 bool ssl_connect_retry; 1291}; 1292 1293 1294/* 1295 * This 'DynamicStatic' struct defines dynamic states that actually change 1296 * values in the 'UserDefined' area, which MUST be taken into consideration 1297 * if the UserDefined struct is cloned or similar. You can probably just 1298 * copy these, but each one indicate a special action on other data. 1299 */ 1300 1301struct DynamicStatic { 1302 char *url; /* work URL, copied from UserDefined */ 1303 bool url_alloc; /* URL string is malloc()'ed */ 1304 char *referer; /* referer string */ 1305 bool referer_alloc; /* referer sting is malloc()ed */ 1306 struct curl_slist *cookielist; /* list of cookie files set by 1307 curl_easy_setopt(COOKIEFILE) calls */ 1308 struct curl_slist *resolve; /* set to point to the set.resolve list when 1309 this should be dealt with in pretransfer */ 1310}; 1311 1312/* 1313 * This 'UserDefined' struct must only contain data that is set once to go 1314 * for many (perhaps) independent connections. Values that are generated or 1315 * calculated internally for the "session handle" MUST be defined within the 1316 * 'struct UrlState' instead. The only exceptions MUST note the changes in 1317 * the 'DynamicStatic' struct. 1318 * Character pointer fields point to dynamic storage, unless otherwise stated. 1319 */ 1320struct Curl_one_easy; /* declared and used only in multi.c */ 1321struct Curl_multi; /* declared and used only in multi.c */ 1322 1323enum dupstring { 1324 STRING_CERT, /* client certificate file name */ 1325 STRING_CERT_TYPE, /* format for certificate (default: PEM)*/ 1326 STRING_COOKIE, /* HTTP cookie string to send */ 1327 STRING_COOKIEJAR, /* dump all cookies to this file */ 1328 STRING_CUSTOMREQUEST, /* HTTP/FTP/RTSP request/method to use */ 1329 STRING_DEVICE, /* local network interface/address to use */ 1330 STRING_ENCODING, /* Accept-Encoding string */ 1331 STRING_FTP_ACCOUNT, /* ftp account data */ 1332 STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */ 1333 STRING_FTPPORT, /* port to send with the FTP PORT command */ 1334 STRING_KEY, /* private key file name */ 1335 STRING_KEY_PASSWD, /* plain text private key password */ 1336 STRING_KEY_TYPE, /* format for private key (default: PEM) */ 1337 STRING_KRB_LEVEL, /* krb security level */ 1338 STRING_NETRC_FILE, /* if not NULL, use this instead of trying to find 1339 $HOME/.netrc */ 1340 STRING_COPYPOSTFIELDS, /* if POST, set the fields' values here */ 1341 STRING_PROXY, /* proxy to use */ 1342 STRING_SET_RANGE, /* range, if used */ 1343 STRING_SET_REFERER, /* custom string for the HTTP referer field */ 1344 STRING_SET_URL, /* what original URL to work on */ 1345 STRING_SSL_CAPATH, /* CA directory name (doesn't work on windows) */ 1346 STRING_SSL_CAFILE, /* certificate file to verify peer against */ 1347 STRING_SSL_CIPHER_LIST, /* list of ciphers to use */ 1348 STRING_SSL_EGDSOCKET, /* path to file containing the EGD daemon socket */ 1349 STRING_SSL_RANDOM_FILE, /* path to file containing "random" data */ 1350 STRING_USERAGENT, /* User-Agent string */ 1351 STRING_SSL_CRLFILE, /* crl file to check certificate */ 1352 STRING_SSL_ISSUERCERT, /* issuer cert file to check certificate */ 1353 STRING_USERNAME, /* <username>, if used */ 1354 STRING_PASSWORD, /* <password>, if used */ 1355 STRING_PROXYUSERNAME, /* Proxy <username>, if used */ 1356 STRING_PROXYPASSWORD, /* Proxy <password>, if used */ 1357 STRING_NOPROXY, /* List of hosts which should not use the proxy, if 1358 used */ 1359 STRING_RTSP_SESSION_ID, /* Session ID to use */ 1360 STRING_RTSP_STREAM_URI, /* Stream URI for this request */ 1361 STRING_RTSP_TRANSPORT, /* Transport for this session */ 1362#ifdef USE_LIBSSH2 1363 STRING_SSH_PRIVATE_KEY, /* path to the private key file for auth */ 1364 STRING_SSH_PUBLIC_KEY, /* path to the public key file for auth */ 1365 STRING_SSH_HOST_PUBLIC_KEY_MD5, /* md5 of host public key in ascii hex */ 1366 STRING_SSH_KNOWNHOSTS, /* file name of knownhosts file */ 1367#endif 1368#if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI) 1369 STRING_SOCKS5_GSSAPI_SERVICE, /* GSSAPI service name */ 1370#endif 1371 STRING_MAIL_FROM, 1372 STRING_MAIL_AUTH, 1373 1374#ifdef USE_TLS_SRP 1375 STRING_TLSAUTH_USERNAME, /* TLS auth <username> */ 1376 STRING_TLSAUTH_PASSWORD, /* TLS auth <password> */ 1377#endif 1378 1379 /* -- end of strings -- */ 1380 STRING_LAST /* not used, just an end-of-list marker */ 1381}; 1382 1383struct UserDefined { 1384 FILE *err; /* the stderr user data goes here */ 1385 void *debugdata; /* the data that will be passed to fdebug */ 1386 char *errorbuffer; /* (Static) store failure messages in here */ 1387 long proxyport; /* If non-zero, use this port number by default. If the 1388 proxy string features a ":[port]" that one will override 1389 this. */ 1390 void *out; /* the fetched file goes here */ 1391 void *in; /* the uploaded file is read from here */ 1392 void *writeheader; /* write the header to this if non-NULL */ 1393 void *rtp_out; /* write RTP to this if non-NULL */ 1394 long use_port; /* which port to use (when not using default) */ 1395 unsigned long httpauth; /* kind of HTTP authentication to use (bitmask) */ 1396 unsigned long proxyauth; /* kind of proxy authentication to use (bitmask) */ 1397 long followlocation; /* as in HTTP Location: */ 1398 long maxredirs; /* maximum no. of http(s) redirects to follow, set to -1 1399 for infinity */ 1400 1401 int keep_post; /* keep POSTs as POSTs after a 30x request; each 1402 bit represents a request, from 301 to 303 */ 1403 bool free_referer; /* set TRUE if 'referer' points to a string we 1404 allocated */ 1405 void *postfields; /* if POST, set the fields' values here */ 1406 curl_seek_callback seek_func; /* function that seeks the input */ 1407 curl_off_t postfieldsize; /* if POST, this might have a size to use instead 1408 of strlen(), and then the data *may* be binary 1409 (contain zero bytes) */ 1410 unsigned short localport; /* local port number to bind to */ 1411 int localportrange; /* number of additional port numbers to test in case the 1412 'localport' one can't be bind()ed */ 1413 curl_write_callback fwrite_func; /* function that stores the output */ 1414 curl_write_callback fwrite_header; /* function that stores headers */ 1415 curl_write_callback fwrite_rtp; /* function that stores interleaved RTP */ 1416 curl_read_callback fread_func; /* function that reads the input */ 1417 int is_fread_set; /* boolean, has read callback been set to non-NULL? */ 1418 int is_fwrite_set; /* boolean, has write callback been set to non-NULL? */ 1419 curl_progress_callback fprogress; /* function for progress information */ 1420 curl_debug_callback fdebug; /* function that write informational data */ 1421 curl_ioctl_callback ioctl_func; /* function for I/O control */ 1422 curl_sockopt_callback fsockopt; /* function for setting socket options */ 1423 void *sockopt_client; /* pointer to pass to the socket options callback */ 1424 curl_opensocket_callback fopensocket; /* function for checking/translating 1425 the address and opening the 1426 socket */ 1427 void* opensocket_client; 1428 curl_closesocket_callback fclosesocket; /* function for closing the 1429 socket */ 1430 void* closesocket_client; 1431 1432 void *seek_client; /* pointer to pass to the seek callback */ 1433 /* the 3 curl_conv_callback functions below are used on non-ASCII hosts */ 1434 /* function to convert from the network encoding: */ 1435 curl_conv_callback convfromnetwork; 1436 /* function to convert to the network encoding: */ 1437 curl_conv_callback convtonetwork; 1438 /* function to convert from UTF-8 encoding: */ 1439 curl_conv_callback convfromutf8; 1440 1441 void *progress_client; /* pointer to pass to the progress callback */ 1442 void *ioctl_client; /* pointer to pass to the ioctl callback */ 1443 long timeout; /* in milliseconds, 0 means no timeout */ 1444 long connecttimeout; /* in milliseconds, 0 means no timeout */ 1445 long accepttimeout; /* in milliseconds, 0 means no timeout */ 1446 long server_response_timeout; /* in milliseconds, 0 means no timeout */ 1447 long tftp_blksize ; /* in bytes, 0 means use default */ 1448 curl_off_t infilesize; /* size of file to upload, -1 means unknown */ 1449 long low_speed_limit; /* bytes/second */ 1450 long low_speed_time; /* number of seconds */ 1451 curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */ 1452 curl_off_t max_recv_speed; /* high speed limit in bytes/second for 1453 download */ 1454 curl_off_t set_resume_from; /* continue [ftp] transfer from here */ 1455 struct curl_slist *headers; /* linked list of extra headers */ 1456 struct curl_httppost *httppost; /* linked list of POST data */ 1457 bool cookiesession; /* new cookie session? */ 1458 bool crlf; /* convert crlf on ftp upload(?) */ 1459 struct curl_slist *quote; /* after connection is established */ 1460 struct curl_slist *postquote; /* after the transfer */ 1461 struct curl_slist *prequote; /* before the transfer, after type */ 1462 struct curl_slist *source_quote; /* 3rd party quote */ 1463 struct curl_slist *source_prequote; /* in 3rd party transfer mode - before 1464 the transfer on source host */ 1465 struct curl_slist *source_postquote; /* in 3rd party transfer mode - after 1466 the transfer on source host */ 1467 struct curl_slist *telnet_options; /* linked list of telnet options */ 1468 struct curl_slist *resolve; /* list of names to add/remove from 1469 DNS cache */ 1470 curl_TimeCond timecondition; /* kind of time/date comparison */ 1471 time_t timevalue; /* what time to compare with */ 1472 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */ 1473 long httpversion; /* when non-zero, a specific HTTP version requested to 1474 be used in the library's request(s) */ 1475 struct ssl_config_data ssl; /* user defined SSL stuff */ 1476 curl_proxytype proxytype; /* what kind of proxy that is in use */ 1477 long dns_cache_timeout; /* DNS cache timeout */ 1478 long buffer_size; /* size of receive buffer to use */ 1479 void *private_data; /* application-private data */ 1480 1481 struct Curl_one_easy *one_easy; /* When adding an easy handle to a multi 1482 handle, an internal 'Curl_one_easy' 1483 struct is created and this is a pointer 1484 to the particular struct associated with 1485 this SessionHandle */ 1486 1487 struct curl_slist *http200aliases; /* linked list of aliases for http200 */ 1488 1489 long ipver; /* the CURL_IPRESOLVE_* defines in the public header file 1490 0 - whatever, 1 - v2, 2 - v6 */ 1491 1492 curl_off_t max_filesize; /* Maximum file size to download */ 1493 1494 curl_ftpfile ftp_filemethod; /* how to get to a file when FTP is used */ 1495 1496 int ftp_create_missing_dirs; /* 1 - create directories that don't exist 1497 2 - the same but also allow MKD to fail once 1498 */ 1499 1500 curl_sshkeycallback ssh_keyfunc; /* key matching callback */ 1501 void *ssh_keyfunc_userp; /* custom pointer to callback */ 1502 1503/* Here follows boolean settings that define how to behave during 1504 this session. They are STATIC, set by libcurl users or at least initially 1505 and they don't change during operations. */ 1506 1507 bool printhost; /* printing host name in debug info */ 1508 bool get_filetime; /* get the time and get of the remote file */ 1509 bool tunnel_thru_httpproxy; /* use CONNECT through a HTTP proxy */ 1510 bool prefer_ascii; /* ASCII rather than binary */ 1511 bool ftp_append; /* append, not overwrite, on upload */ 1512 bool ftp_list_only; /* switch FTP command for listing directories */ 1513 bool ftp_use_port; /* use the FTP PORT command */ 1514 bool hide_progress; /* don't use the progress meter */ 1515 bool http_fail_on_error; /* fail on HTTP error codes >= 300 */ 1516 bool http_follow_location; /* follow HTTP redirects */ 1517 bool http_transfer_encoding; /* request compressed HTTP transfer-encoding */ 1518 bool http_disable_hostname_check_before_authentication; 1519 bool include_header; /* include received protocol headers in data output */ 1520 bool http_set_referer; /* is a custom referer used */ 1521 bool http_auto_referer; /* set "correct" referer when following location: */ 1522 bool opt_no_body; /* as set with CURLOPT_NOBODY */ 1523 bool set_port; /* custom port number used */ 1524 bool upload; /* upload request */ 1525 enum CURL_NETRC_OPTION 1526 use_netrc; /* defined in include/curl.h */ 1527 bool verbose; /* output verbosity */ 1528 bool krb; /* kerberos connection requested */ 1529 bool reuse_forbid; /* forbidden to be reused, close after use */ 1530 bool reuse_fresh; /* do not re-use an existing connection */ 1531 bool ftp_use_epsv; /* if EPSV is to be attempted or not */ 1532 bool ftp_use_eprt; /* if EPRT is to be attempted or not */ 1533 bool ftp_use_pret; /* if PRET is to be used before PASV or not */ 1534 1535 curl_usessl use_ssl; /* if AUTH TLS is to be attempted etc, for FTP or 1536 IMAP or POP3 or others! */ 1537 curl_ftpauth ftpsslauth; /* what AUTH XXX to be attempted */ 1538 curl_ftpccc ftp_ccc; /* FTP CCC options */ 1539 bool no_signal; /* do not use any signal/alarm handler */ 1540 bool global_dns_cache; /* subject for future removal */ 1541 bool tcp_nodelay; /* whether to enable TCP_NODELAY or not */ 1542 bool ignorecl; /* ignore content length */ 1543 bool ftp_skip_ip; /* skip the IP address the FTP server passes on to 1544 us */ 1545 bool connect_only; /* make connection, let application use the socket */ 1546 bool ssl_enable_beast; /* especially allow this flaw for interoperability's 1547 sake*/ 1548 long ssh_auth_types; /* allowed SSH auth types */ 1549 bool http_te_skip; /* pass the raw body data to the user, even when 1550 transfer-encoded (chunked, compressed) */ 1551 bool http_ce_skip; /* pass the raw body data to the user, even when 1552 content-encoded (chunked, compressed) */ 1553 long new_file_perms; /* Permissions to use when creating remote files */ 1554 long new_directory_perms; /* Permissions to use when creating remote dirs */ 1555 bool proxy_transfer_mode; /* set transfer mode (;type=<a|i>) when doing FTP 1556 via an HTTP proxy */ 1557 char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */ 1558 unsigned int scope; /* address scope for IPv6 */ 1559 long allowed_protocols; 1560 long redir_protocols; 1561#if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI) 1562 long socks5_gssapi_nec; /* flag to support nec socks5 server */ 1563#endif 1564 struct curl_slist *mail_rcpt; /* linked list of mail recipients */ 1565 /* Common RTSP header options */ 1566 Curl_RtspReq rtspreq; /* RTSP request type */ 1567 long rtspversion; /* like httpversion, for RTSP */ 1568 bool wildcardmatch; /* enable wildcard matching */ 1569 curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer 1570 starts */ 1571 curl_chunk_end_callback chunk_end; /* called after part transferring 1572 stopped */ 1573 curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds 1574 to pattern (e.g. if WILDCARDMATCH is on) */ 1575 void *fnmatch_data; 1576 1577 long gssapi_delegation; /* GSSAPI credential delegation, see the 1578 documentation of CURLOPT_GSSAPI_DELEGATION */ 1579 1580 bool tcp_keepalive; /* use TCP keepalives */ 1581 long tcp_keepidle; /* seconds in idle before sending keepalive probe */ 1582 long tcp_keepintvl; /* seconds between TCP keepalive probes */ 1583 1584 size_t maxconnects; /* Max idle connections in the connection cache */ 1585}; 1586 1587struct Names { 1588 struct curl_hash *hostcache; 1589 enum { 1590 HCACHE_NONE, /* not pointing to anything */ 1591 HCACHE_GLOBAL, /* points to the (shrug) global one */ 1592 HCACHE_MULTI, /* points to a shared one in the multi handle */ 1593 HCACHE_SHARED /* points to a shared one in a shared object */ 1594 } hostcachetype; 1595}; 1596 1597/* 1598 * The 'connectdata' struct MUST have all the connection oriented stuff as we 1599 * may have several simultaneous connections and connection structs in memory. 1600 * 1601 * The 'struct UserDefined' must only contain data that is set once to go for 1602 * many (perhaps) independent connections. Values that are generated or 1603 * calculated internally for the "session handle" must be defined within the 1604 * 'struct UrlState' instead. 1605 */ 1606 1607struct SessionHandle { 1608 struct Names dns; 1609 struct Curl_multi *multi; /* if non-NULL, points to the multi handle 1610 struct to which this "belongs" when used by 1611 the multi interface */ 1612 struct Curl_multi *multi_easy; /* if non-NULL, points to the multi handle 1613 struct to which this "belongs" when used 1614 by the easy interface */ 1615 struct Curl_one_easy *multi_pos; /* if non-NULL, points to its position 1616 in multi controlling structure to assist 1617 in removal. */ 1618 struct Curl_share *share; /* Share, handles global variable mutexing */ 1619 struct SingleRequest req; /* Request-specific data */ 1620 struct UserDefined set; /* values set by the libcurl user */ 1621 struct DynamicStatic change; /* possibly modified userdefined data */ 1622 struct CookieInfo *cookies; /* the cookies, read from files and servers. 1623 NOTE that the 'cookie' field in the 1624 UserDefined struct defines if the "engine" 1625 is to be used or not. */ 1626 struct Progress progress; /* for all the progress meter data */ 1627 struct UrlState state; /* struct for fields used for state info and 1628 other dynamic purposes */ 1629 struct WildcardData wildcard; /* wildcard download state info */ 1630 struct PureInfo info; /* stats, reports and info data */ 1631#if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV) 1632 iconv_t outbound_cd; /* for translating to the network encoding */ 1633 iconv_t inbound_cd; /* for translating from the network encoding */ 1634 iconv_t utf8_cd; /* for translating to UTF8 */ 1635#endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */ 1636 unsigned int magic; /* set to a CURLEASY_MAGIC_NUMBER */ 1637}; 1638 1639#define LIBCURL_NAME "libcurl" 1640 1641#endif /* HEADER_CURL_URLDATA_H */ 1642