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