lib/url.c

   1 /***************************************************************************
   2  *                                  _   _ ____  _
   3  *  Project                     ___| | | |  _ \| |
   4  *                             / __| | | | |_) | |
   5  *                            | (__| |_| |  _ <| |___
   6  *                             \___|\___/|_| \_\_____|
   7  *
   8  * Copyright (C) 1998 - 2013, Daniel Stenberg, <daniel@haxx.se>, et al.
   9  *
  10  * This software is licensed as described in the file COPYING, which
  11  * you should have received as part of this distribution. The terms
  12  * are also available at http://curl.haxx.se/docs/copyright.html.
  13  *
  14  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15  * copies of the Software, and permit persons to whom the Software is
  16  * furnished to do so, under the terms of the COPYING file.
  17  *
  18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19  * KIND, either express or implied.
  20  *
  21  ***************************************************************************/
  22
  23 #include "curl_setup.h"
  24
  25 #ifdef HAVE_NETINET_IN_H
  26 #include <netinet/in.h>
  27 #endif
  28 #ifdef HAVE_NETDB_H
  29 #include <netdb.h>
  30 #endif
  31 #ifdef HAVE_ARPA_INET_H
  32 #include <arpa/inet.h>
  33 #endif
  34 #ifdef HAVE_NET_IF_H
  35 #include <net/if.h>
  36 #endif
  37 #ifdef HAVE_SYS_IOCTL_H
  38 #include <sys/ioctl.h>
  39 #endif
  40
  41 #ifdef HAVE_SYS_PARAM_H
  42 #include <sys/param.h>
  43 #endif
  44
  45 #ifdef __VMS
  46 #include <in.h>
  47 #include <inet.h>
  48 #endif
  49
  50 #ifndef HAVE_SOCKET
  51 #error "We can't compile without socket() support!"
  52 #endif
  53
  54 #ifdef HAVE_LIMITS_H
  55 #include <limits.h>
  56 #endif
  57
  58 #ifdef USE_LIBIDN
  59 #include <idna.h>
  60 #include <tld.h>
  61 #include <stringprep.h>
  62 #ifdef HAVE_IDN_FREE_H
  63 #include <idn-free.h>
  64 #else
  65 /* prototype from idn-free.h, not provided by libidn 0.4.5's make install! */
  66 void idn_free (void *ptr);
  67 #endif
  68 #ifndef HAVE_IDN_FREE
  69 /* if idn_free() was not found in this version of libidn use free() instead */
  70 #define idn_free(x) (free)(x)
  71 #endif
  72 #elif defined(USE_WIN32_IDN)
  73 /* prototype for curl_win32_idn_to_ascii() */
  74 int curl_win32_idn_to_ascii(const char *in, char **out);
  75 #endif  /* USE_LIBIDN */
  76
  77 #include "urldata.h"
  78 #include "netrc.h"
  79
  80 #include "formdata.h"
  81 #include "sslgen.h"
  82 #include "hostip.h"
  83 #include "transfer.h"
  84 #include "sendf.h"
  85 #include "progress.h"
  86 #include "cookie.h"
  87 #include "strequal.h"
  88 #include "strerror.h"
  89 #include "escape.h"
  90 #include "strtok.h"
  91 #include "share.h"
  92 #include "content_encoding.h"
  93 #include "http_digest.h"
  94 #include "http_negotiate.h"
  95 #include "select.h"
  96 #include "multiif.h"
  97 #include "easyif.h"
  98 #include "speedcheck.h"
  99 #include "rawstr.h"
 100 #include "warnless.h"
 101 #include "non-ascii.h"
 102 #include "inet_pton.h"
 103
 104 /* And now for the protocols */
 105 #include "ftp.h"
 106 #include "dict.h"
 107 #include "telnet.h"
 108 #include "tftp.h"
 109 #include "http.h"
 110 #include "file.h"
 111 #include "curl_ldap.h"
 112 #include "ssh.h"
 113 #include "imap.h"
 114 #include "url.h"
 115 #include "connect.h"
 116 #include "inet_ntop.h"
 117 #include "curl_ntlm.h"
 118 #include "curl_ntlm_wb.h"
 119 #include "socks.h"
 120 #include "curl_rtmp.h"
 121 #include "gopher.h"
 122 #include "http_proxy.h"
 123 #include "bundles.h"
 124 #include "conncache.h"
 125 #include "multihandle.h"
 126 #include "pipeline.h"
 127 #include "dotdot.h"
 128
 129 #define _MPRINTF_REPLACE /* use our functions only */
 130 #include <curl/mprintf.h>
 131
 132 #include "curl_memory.h"
 133 /* The last #include file should be: */
 134 #include "memdebug.h"
 135
 136 /* Local static prototypes */
 137 static struct connectdata *
 138 find_oldest_idle_connection(struct SessionHandle *data);
 139 static struct connectdata *
 140 find_oldest_idle_connection_in_bundle(struct SessionHandle *data,
 141                                       struct connectbundle *bundle);
 142 static void conn_free(struct connectdata *conn);
 143 static void signalPipeClose(struct curl_llist *pipeline, bool pipe_broke);
 144 static CURLcode do_init(struct connectdata *conn);
 145 static CURLcode parse_url_login(struct SessionHandle *data,
 146                                 struct connectdata *conn,
 147                                 char **userptr, char **passwdptr,
 148                                 char **optionsptr);
 149 static CURLcode parse_login_details(const char *login, const size_t len,
 150                                     char **userptr, char **passwdptr,
 151                                     char **optionsptr);
 152 /*
 153  * Protocol table.
 154  */
 155
 156 static const struct Curl_handler * const protocols[] = {
 157
 158 #ifndef CURL_DISABLE_HTTP
 159   &Curl_handler_http,
 160 #endif
 161
 162 #if defined(USE_SSL) && !defined(CURL_DISABLE_HTTP)
 163   &Curl_handler_https,
 164 #endif
 165
 166 #ifndef CURL_DISABLE_FTP
 167   &Curl_handler_ftp,
 168 #endif
 169
 170 #if defined(USE_SSL) && !defined(CURL_DISABLE_FTP)
 171   &Curl_handler_ftps,
 172 #endif
 173
 174 #ifndef CURL_DISABLE_TELNET
 175   &Curl_handler_telnet,
 176 #endif
 177
 178 #ifndef CURL_DISABLE_DICT
 179   &Curl_handler_dict,
 180 #endif
 181
 182 #ifndef CURL_DISABLE_LDAP
 183   &Curl_handler_ldap,
 184 #if !defined(CURL_DISABLE_LDAPS) && \
 185     ((defined(USE_OPENLDAP) && defined(USE_SSL)) || \
 186      (!defined(USE_OPENLDAP) && defined(HAVE_LDAP_SSL)))
 187   &Curl_handler_ldaps,
 188 #endif
 189 #endif
 190
 191 #ifndef CURL_DISABLE_FILE
 192   &Curl_handler_file,
 193 #endif
 194
 195 #ifndef CURL_DISABLE_TFTP
 196   &Curl_handler_tftp,
 197 #endif
 198
 199 #ifdef USE_LIBSSH2
 200   &Curl_handler_scp,
 201   &Curl_handler_sftp,
 202 #endif
 203
 204 #ifndef CURL_DISABLE_IMAP
 205   &Curl_handler_imap,
 206 #ifdef USE_SSL
 207   &Curl_handler_imaps,
 208 #endif
 209 #endif
 210
 211 #ifndef CURL_DISABLE_POP3
 212   &Curl_handler_pop3,
 213 #ifdef USE_SSL
 214   &Curl_handler_pop3s,
 215 #endif
 216 #endif
 217
 218 #ifndef CURL_DISABLE_SMTP
 219   &Curl_handler_smtp,
 220 #ifdef USE_SSL
 221   &Curl_handler_smtps,
 222 #endif
 223 #endif
 224
 225 #ifndef CURL_DISABLE_RTSP
 226   &Curl_handler_rtsp,
 227 #endif
 228
 229 #ifndef CURL_DISABLE_GOPHER
 230   &Curl_handler_gopher,
 231 #endif
 232
 233 #ifdef USE_LIBRTMP
 234   &Curl_handler_rtmp,
 235   &Curl_handler_rtmpt,
 236   &Curl_handler_rtmpe,
 237   &Curl_handler_rtmpte,
 238   &Curl_handler_rtmps,
 239   &Curl_handler_rtmpts,
 240 #endif
 241
 242   (struct Curl_handler *) NULL
 243 };
 244
 245 /*
 246  * Dummy handler for undefined protocol schemes.
 247  */
 248
 249 static const struct Curl_handler Curl_handler_dummy = {
 250   "<no protocol>",                      /* scheme */
 251   ZERO_NULL,                            /* setup_connection */
 252   ZERO_NULL,                            /* do_it */
 253   ZERO_NULL,                            /* done */
 254   ZERO_NULL,                            /* do_more */
 255   ZERO_NULL,                            /* connect_it */
 256   ZERO_NULL,                            /* connecting */
 257   ZERO_NULL,                            /* doing */
 258   ZERO_NULL,                            /* proto_getsock */
 259   ZERO_NULL,                            /* doing_getsock */
 260   ZERO_NULL,                            /* domore_getsock */
 261   ZERO_NULL,                            /* perform_getsock */
 262   ZERO_NULL,                            /* disconnect */
 263   ZERO_NULL,                            /* readwrite */
 264   0,                                    /* defport */
 265   0,                                    /* protocol */
 266   PROTOPT_NONE                          /* flags */
 267 };
 268
 269 void Curl_freeset(struct SessionHandle *data)
 270 {
 271   /* Free all dynamic strings stored in the data->set substructure. */
 272   enum dupstring i;
 273   for(i=(enum dupstring)0; i < STRING_LAST; i++)
 274     Curl_safefree(data->set.str[i]);
 275
 276   if(data->change.referer_alloc) {
 277     Curl_safefree(data->change.referer);
 278     data->change.referer_alloc = FALSE;
 279   }
 280   data->change.referer = NULL;
 281 }
 282
 283 static CURLcode setstropt(char **charp, char *s)
 284 {
 285   /* Release the previous storage at `charp' and replace by a dynamic storage
 286      copy of `s'. Return CURLE_OK or CURLE_OUT_OF_MEMORY. */
 287
 288   Curl_safefree(*charp);
 289
 290   if(s) {
 291     s = strdup(s);
 292
 293     if(!s)
 294       return CURLE_OUT_OF_MEMORY;
 295
 296     *charp = s;
 297   }
 298
 299   return CURLE_OK;
 300 }
 301
 302 static CURLcode setstropt_userpwd(char *option, char **userp, char **passwdp,
 303                                   char **optionsp)
 304 {
 305   CURLcode result = CURLE_OK;
 306   char *user = NULL;
 307   char *passwd = NULL;
 308   char *options = NULL;
 309
 310   /* Parse the login details if specified. It not then we treat NULL as a hint
 311      to clear the existing data */
 312   if(option) {
 313     result = parse_login_details(option, strlen(option),
 314                                  (userp ? &user : NULL),
 315                                  (passwdp ? &passwd : NULL),
 316                                  (optionsp ? &options : NULL));
 317   }
 318
 319   if(!result) {
 320     /* Store the username part of option if required */
 321     if(userp) {
 322       if(!user && option && option[0] == ':') {
 323         /* Allocate an empty string instead of returning NULL as user name */
 324         user = strdup("");
 325         if(!user)
 326           result = CURLE_OUT_OF_MEMORY;
 327       }
 328
 329       Curl_safefree(*userp);
 330       *userp = user;
 331     }
 332
 333     /* Store the password part of option if required */
 334     if(passwdp) {
 335       Curl_safefree(*passwdp);
 336       *passwdp = passwd;
 337     }
 338
 339     /* Store the options part of option if required */
 340     if(optionsp) {
 341       Curl_safefree(*optionsp);
 342       *optionsp = options;
 343     }
 344   }
 345
 346   return result;
 347 }
 348
 349 CURLcode Curl_dupset(struct SessionHandle *dst, struct SessionHandle *src)
 350 {
 351   CURLcode r = CURLE_OK;
 352   enum dupstring i;
 353
 354   /* Copy src->set into dst->set first, then deal with the strings
 355      afterwards */
 356   dst->set = src->set;
 357
 358   /* clear all string pointers first */
 359   memset(dst->set.str, 0, STRING_LAST * sizeof(char *));
 360
 361   /* duplicate all strings */
 362   for(i=(enum dupstring)0; i< STRING_LAST; i++) {
 363     r = setstropt(&dst->set.str[i], src->set.str[i]);
 364     if(r != CURLE_OK)
 365       break;
 366   }
 367
 368   /* If a failure occurred, freeing has to be performed externally. */
 369   return r;
 370 }
 371
 372 /*
 373  * This is the internal function curl_easy_cleanup() calls. This should
 374  * cleanup and free all resources associated with this sessionhandle.
 375  *
 376  * NOTE: if we ever add something that attempts to write to a socket or
 377  * similar here, we must ignore SIGPIPE first. It is currently only done
 378  * when curl_easy_perform() is invoked.
 379  */
 380
 381 CURLcode Curl_close(struct SessionHandle *data)
 382 {
 383   struct Curl_multi *m;
 384
 385   if(!data)
 386     return CURLE_OK;
 387
 388   Curl_expire(data, 0); /* shut off timers */
 389
 390   m = data->multi;
 391
 392   if(m)
 393     /* This handle is still part of a multi handle, take care of this first
 394        and detach this handle from there. */
 395     curl_multi_remove_handle(data->multi, data);
 396
 397   if(data->multi_easy)
 398     /* when curl_easy_perform() is used, it creates its own multi handle to
 399        use and this is the one */
 400     curl_multi_cleanup(data->multi_easy);
 401
 402   /* Destroy the timeout list that is held in the easy handle. It is
 403      /normally/ done by curl_multi_remove_handle() but this is "just in
 404      case" */
 405   if(data->state.timeoutlist) {
 406     Curl_llist_destroy(data->state.timeoutlist, NULL);
 407     data->state.timeoutlist = NULL;
 408   }
 409
 410   data->magic = 0; /* force a clear AFTER the possibly enforced removal from
 411                       the multi handle, since that function uses the magic
 412                       field! */
 413
 414   if(data->state.rangestringalloc)
 415     free(data->state.range);
 416
 417   /* Free the pathbuffer */
 418   Curl_safefree(data->state.pathbuffer);
 419   data->state.path = NULL;
 420
 421   /* freed here just in case DONE wasn't called */
 422   Curl_free_request_state(data);
 423
 424   /* Close down all open SSL info and sessions */
 425   Curl_ssl_close_all(data);
 426   Curl_safefree(data->state.first_host);
 427   Curl_safefree(data->state.scratch);
 428   Curl_ssl_free_certinfo(data);
 429
 430   if(data->change.referer_alloc) {
 431     Curl_safefree(data->change.referer);
 432     data->change.referer_alloc = FALSE;
 433   }
 434   data->change.referer = NULL;
 435
 436   if(data->change.url_alloc) {
 437     Curl_safefree(data->change.url);
 438     data->change.url_alloc = FALSE;
 439   }
 440   data->change.url = NULL;
 441
 442   Curl_safefree(data->state.headerbuff);
 443
 444   Curl_flush_cookies(data, 1);
 445
 446   Curl_digest_cleanup(data);
 447
 448   Curl_safefree(data->info.contenttype);
 449   Curl_safefree(data->info.wouldredirect);
 450
 451   /* this destroys the channel and we cannot use it anymore after this */
 452   Curl_resolver_cleanup(data->state.resolver);
 453
 454   Curl_convert_close(data);
 455
 456   /* No longer a dirty share, if it exists */
 457   if(data->share) {
 458     Curl_share_lock(data, CURL_LOCK_DATA_SHARE, CURL_LOCK_ACCESS_SINGLE);
 459     data->share->dirty--;
 460     Curl_share_unlock(data, CURL_LOCK_DATA_SHARE);
 461   }
 462
 463   Curl_freeset(data);
 464   free(data);
 465   return CURLE_OK;
 466 }
 467
 468 /*
 469  * Initialize the UserDefined fields within a SessionHandle.
 470  * This may be safely called on a new or existing SessionHandle.
 471  */
 472 CURLcode Curl_init_userdefined(struct UserDefined *set)
 473 {
 474   CURLcode res = CURLE_OK;
 475
 476   set->out = stdout; /* default output to stdout */
 477   set->in  = stdin;  /* default input from stdin */
 478   set->err  = stderr;  /* default stderr to stderr */
 479
 480   /* use fwrite as default function to store output */
 481   set->fwrite_func = (curl_write_callback)fwrite;
 482
 483   /* use fread as default function to read input */
 484   set->fread_func = (curl_read_callback)fread;
 485   set->is_fread_set = 0;
 486   set->is_fwrite_set = 0;
 487
 488   set->seek_func = ZERO_NULL;
 489   set->seek_client = ZERO_NULL;
 490
 491   /* conversion callbacks for non-ASCII hosts */
 492   set->convfromnetwork = ZERO_NULL;
 493   set->convtonetwork   = ZERO_NULL;
 494   set->convfromutf8    = ZERO_NULL;
 495
 496   set->infilesize = -1;      /* we don't know any size */
 497   set->postfieldsize = -1;   /* unknown size */
 498   set->maxredirs = -1;       /* allow any amount by default */
 499
 500   set->httpreq = HTTPREQ_GET; /* Default HTTP request */
 501   set->rtspreq = RTSPREQ_OPTIONS; /* Default RTSP request */
 502   set->ftp_use_epsv = TRUE;   /* FTP defaults to EPSV operations */
 503   set->ftp_use_eprt = TRUE;   /* FTP defaults to EPRT operations */
 504   set->ftp_use_pret = FALSE;  /* mainly useful for drftpd servers */
 505   set->ftp_filemethod = FTPFILE_MULTICWD;
 506
 507   set->dns_cache_timeout = 60; /* Timeout every 60 seconds by default */
 508
 509   /* Set the default size of the SSL session ID cache */
 510   set->ssl.max_ssl_sessions = 5;
 511
 512   set->proxyport = CURL_DEFAULT_PROXY_PORT; /* from url.h */
 513   set->proxytype = CURLPROXY_HTTP; /* defaults to HTTP proxy */
 514   set->httpauth = CURLAUTH_BASIC;  /* defaults to basic */
 515   set->proxyauth = CURLAUTH_BASIC; /* defaults to basic */
 516
 517   /* make libcurl quiet by default: */
 518   set->hide_progress = TRUE;  /* CURLOPT_NOPROGRESS changes these */
 519
 520   /*
 521    * libcurl 7.10 introduced SSL verification *by default*! This needs to be
 522    * switched off unless wanted.
 523    */
 524   set->ssl.verifypeer = TRUE;
 525   set->ssl.verifyhost = TRUE;
 526 #ifdef USE_TLS_SRP
 527   set->ssl.authtype = CURL_TLSAUTH_NONE;
 528 #endif
 529   set->ssh_auth_types = CURLSSH_AUTH_DEFAULT; /* defaults to any auth
 530                                                       type */
 531   set->ssl.sessionid = TRUE; /* session ID caching enabled by default */
 532
 533   set->new_file_perms = 0644;    /* Default permissions */
 534   set->new_directory_perms = 0755; /* Default permissions */
 535
 536   /* for the *protocols fields we don't use the CURLPROTO_ALL convenience
 537      define since we internally only use the lower 16 bits for the passed
 538      in bitmask to not conflict with the private bits */
 539   set->allowed_protocols = CURLPROTO_ALL;
 540   set->redir_protocols =
 541     CURLPROTO_ALL & ~(CURLPROTO_FILE|CURLPROTO_SCP); /* not FILE or SCP */
 542
 543 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
 544   /*
 545    * disallow unprotected protection negotiation NEC reference implementation
 546    * seem not to follow rfc1961 section 4.3/4.4
 547    */
 548   set->socks5_gssapi_nec = FALSE;
 549   /* set default gssapi service name */
 550   res = setstropt(&set->str[STRING_SOCKS5_GSSAPI_SERVICE],
 551                   (char *) CURL_DEFAULT_SOCKS5_GSSAPI_SERVICE);
 552   if(res != CURLE_OK)
 553     return res;
 554 #endif
 555
 556   /* This is our preferred CA cert bundle/path since install time */
 557 #if defined(CURL_CA_BUNDLE)
 558   res = setstropt(&set->str[STRING_SSL_CAFILE], (char *) CURL_CA_BUNDLE);
 559 #elif defined(CURL_CA_PATH)
 560   res = setstropt(&set->str[STRING_SSL_CAPATH], (char *) CURL_CA_PATH);
 561 #endif
 562
 563   set->wildcardmatch  = FALSE;
 564   set->chunk_bgn      = ZERO_NULL;
 565   set->chunk_end      = ZERO_NULL;
 566
 567   /* tcp keepalives are disabled by default, but provide reasonable values for
 568    * the interval and idle times.
 569    */
 570   set->tcp_keepalive = FALSE;
 571   set->tcp_keepintvl = 60;
 572   set->tcp_keepidle = 60;
 573
 574   return res;
 575 }
 576
 577 /**
 578  * Curl_open()
 579  *
 580  * @param curl is a pointer to a sessionhandle pointer that gets set by this
 581  * function.
 582  * @return CURLcode
 583  */
 584
 585 CURLcode Curl_open(struct SessionHandle **curl)
 586 {
 587   CURLcode res = CURLE_OK;
 588   struct SessionHandle *data;
 589   CURLcode status;
 590
 591   /* Very simple start-up: alloc the struct, init it with zeroes and return */
 592   data = calloc(1, sizeof(struct SessionHandle));
 593   if(!data) {
 594     /* this is a very serious error */
 595     DEBUGF(fprintf(stderr, "Error: calloc of SessionHandle failed\n"));
 596     return CURLE_OUT_OF_MEMORY;
 597   }
 598
 599   data->magic = CURLEASY_MAGIC_NUMBER;
 600
 601   status = Curl_resolver_init(&data->state.resolver);
 602   if(status) {
 603     DEBUGF(fprintf(stderr, "Error: resolver_init failed\n"));
 604     free(data);
 605     return status;
 606   }
 607
 608   /* We do some initial setup here, all those fields that can't be just 0 */
 609
 610   data->state.headerbuff = malloc(HEADERSIZE);
 611   if(!data->state.headerbuff) {
 612     DEBUGF(fprintf(stderr, "Error: malloc of headerbuff failed\n"));
 613     res = CURLE_OUT_OF_MEMORY;
 614   }
 615   else {
 616     res = Curl_init_userdefined(&data->set);
 617
 618     data->state.headersize=HEADERSIZE;
 619
 620     Curl_convert_init(data);
 621
 622     /* most recent connection is not yet defined */
 623     data->state.lastconnect = NULL;
 624
 625     data->progress.flags |= PGRS_HIDE;
 626     data->state.current_speed = -1; /* init to negative == impossible */
 627
 628     data->wildcard.state = CURLWC_INIT;
 629     data->wildcard.filelist = NULL;
 630     data->set.fnmatch = ZERO_NULL;
 631     data->set.maxconnects = DEFAULT_CONNCACHE_SIZE; /* for easy handles */
 632   }
 633
 634   if(res) {
 635     Curl_resolver_cleanup(data->state.resolver);
 636     if(data->state.headerbuff)
 637       free(data->state.headerbuff);
 638     Curl_freeset(data);
 639     free(data);
 640     data = NULL;
 641   }
 642   else
 643     *curl = data;
 644
 645   return res;
 646 }
 647
 648 CURLcode Curl_setopt(struct SessionHandle *data, CURLoption option,
 649                      va_list param)
 650 {
 651   char *argptr;
 652   CURLcode result = CURLE_OK;
 653   long arg;
 654 #ifndef CURL_DISABLE_HTTP
 655   curl_off_t bigsize;
 656 #endif
 657
 658   switch(option) {
 659   case CURLOPT_DNS_CACHE_TIMEOUT:
 660     data->set.dns_cache_timeout = va_arg(param, long);
 661     break;
 662   case CURLOPT_DNS_USE_GLOBAL_CACHE:
 663     /* remember we want this enabled */
 664     arg = va_arg(param, long);
 665     data->set.global_dns_cache = (0 != arg)?TRUE:FALSE;
 666     break;
 667   case CURLOPT_SSL_CIPHER_LIST:
 668     /* set a list of cipher we want to use in the SSL connection */
 669     result = setstropt(&data->set.str[STRING_SSL_CIPHER_LIST],
 670                        va_arg(param, char *));
 671     break;
 672
 673   case CURLOPT_RANDOM_FILE:
 674     /*
 675      * This is the path name to a file that contains random data to seed
 676      * the random SSL stuff with. The file is only used for reading.
 677      */
 678     result = setstropt(&data->set.str[STRING_SSL_RANDOM_FILE],
 679                        va_arg(param, char *));
 680     break;
 681   case CURLOPT_EGDSOCKET:
 682     /*
 683      * The Entropy Gathering Daemon socket pathname
 684      */
 685     result = setstropt(&data->set.str[STRING_SSL_EGDSOCKET],
 686                        va_arg(param, char *));
 687     break;
 688   case CURLOPT_MAXCONNECTS:
 689     /*
 690      * Set the absolute number of maximum simultaneous alive connection that
 691      * libcurl is allowed to have.
 692      */
 693     data->set.maxconnects = va_arg(param, long);
 694     break;
 695   case CURLOPT_FORBID_REUSE:
 696     /*
 697      * When this transfer is done, it must not be left to be reused by a
 698      * subsequent transfer but shall be closed immediately.
 699      */
 700     data->set.reuse_forbid = (0 != va_arg(param, long))?TRUE:FALSE;
 701     break;
 702   case CURLOPT_FRESH_CONNECT:
 703     /*
 704      * This transfer shall not use a previously cached connection but
 705      * should be made with a fresh new connect!
 706      */
 707     data->set.reuse_fresh = (0 != va_arg(param, long))?TRUE:FALSE;
 708     break;
 709   case CURLOPT_VERBOSE:
 710     /*
 711      * Verbose means infof() calls that give a lot of information about
 712      * the connection and transfer procedures as well as internal choices.
 713      */
 714     data->set.verbose = (0 != va_arg(param, long))?TRUE:FALSE;
 715     break;
 716   case CURLOPT_HEADER:
 717     /*
 718      * Set to include the header in the general data output stream.
 719      */
 720     data->set.include_header = (0 != va_arg(param, long))?TRUE:FALSE;
 721     break;
 722   case CURLOPT_NOPROGRESS:
 723     /*
 724      * Shut off the internal supported progress meter
 725      */
 726     data->set.hide_progress = (0 != va_arg(param, long))?TRUE:FALSE;
 727     if(data->set.hide_progress)
 728       data->progress.flags |= PGRS_HIDE;
 729     else
 730       data->progress.flags &= ~PGRS_HIDE;
 731     break;
 732   case CURLOPT_NOBODY:
 733     /*
 734      * Do not include the body part in the output data stream.
 735      */
 736     data->set.opt_no_body = (0 != va_arg(param, long))?TRUE:FALSE;
 737     break;
 738   case CURLOPT_FAILONERROR:
 739     /*
 740      * Don't output the >=300 error code HTML-page, but instead only
 741      * return error.
 742      */
 743     data->set.http_fail_on_error = (0 != va_arg(param, long))?TRUE:FALSE;
 744     break;
 745   case CURLOPT_UPLOAD:
 746   case CURLOPT_PUT:
 747     /*
 748      * We want to sent data to the remote host. If this is HTTP, that equals
 749      * using the PUT request.
 750      */
 751     data->set.upload = (0 != va_arg(param, long))?TRUE:FALSE;
 752     if(data->set.upload) {
 753       /* If this is HTTP, PUT is what's needed to "upload" */
 754       data->set.httpreq = HTTPREQ_PUT;
 755       data->set.opt_no_body = FALSE; /* this is implied */
 756     }
 757     else
 758       /* In HTTP, the opposite of upload is GET (unless NOBODY is true as
 759          then this can be changed to HEAD later on) */
 760       data->set.httpreq = HTTPREQ_GET;
 761     break;
 762   case CURLOPT_FILETIME:
 763     /*
 764      * Try to get the file time of the remote document. The time will
 765      * later (possibly) become available using curl_easy_getinfo().
 766      */
 767     data->set.get_filetime = (0 != va_arg(param, long))?TRUE:FALSE;
 768     break;
 769   case CURLOPT_FTP_CREATE_MISSING_DIRS:
 770     /*
 771      * An FTP option that modifies an upload to create missing directories on
 772      * the server.
 773      */
 774     switch(va_arg(param, long)) {
 775     case 0:
 776       data->set.ftp_create_missing_dirs = 0;
 777       break;
 778     case 1:
 779       data->set.ftp_create_missing_dirs = 1;
 780       break;
 781     case 2:
 782       data->set.ftp_create_missing_dirs = 2;
 783       break;
 784     default:
 785       /* reserve other values for future use */
 786       result = CURLE_UNKNOWN_OPTION;
 787       break;
 788     }
 789     break;
 790   case CURLOPT_SERVER_RESPONSE_TIMEOUT:
 791     /*
 792      * Option that specifies how quickly an server response must be obtained
 793      * before it is considered failure. For pingpong protocols.
 794      */
 795     data->set.server_response_timeout = va_arg( param , long ) * 1000;
 796     break;
 797   case CURLOPT_TFTP_BLKSIZE:
 798     /*
 799      * TFTP option that specifies the block size to use for data transmission
 800      */
 801     data->set.tftp_blksize = va_arg(param, long);
 802     break;
 803   case CURLOPT_DIRLISTONLY:
 804     /*
 805      * An option that changes the command to one that asks for a list
 806      * only, no file info details.
 807      */
 808     data->set.ftp_list_only = (0 != va_arg(param, long))?TRUE:FALSE;
 809     break;
 810   case CURLOPT_APPEND:
 811     /*
 812      * We want to upload and append to an existing file.
 813      */
 814     data->set.ftp_append = (0 != va_arg(param, long))?TRUE:FALSE;
 815     break;
 816   case CURLOPT_FTP_FILEMETHOD:
 817     /*
 818      * How do access files over FTP.
 819      */
 820     data->set.ftp_filemethod = (curl_ftpfile)va_arg(param, long);
 821     break;
 822   case CURLOPT_NETRC:
 823     /*
 824      * Parse the $HOME/.netrc file
 825      */
 826     data->set.use_netrc = (enum CURL_NETRC_OPTION)va_arg(param, long);
 827     break;
 828   case CURLOPT_NETRC_FILE:
 829     /*
 830      * Use this file instead of the $HOME/.netrc file
 831      */
 832     result = setstropt(&data->set.str[STRING_NETRC_FILE],
 833                        va_arg(param, char *));
 834     break;
 835   case CURLOPT_TRANSFERTEXT:
 836     /*
 837      * This option was previously named 'FTPASCII'. Renamed to work with
 838      * more protocols than merely FTP.
 839      *
 840      * Transfer using ASCII (instead of BINARY).
 841      */
 842     data->set.prefer_ascii = (0 != va_arg(param, long))?TRUE:FALSE;
 843     break;
 844   case CURLOPT_TIMECONDITION:
 845     /*
 846      * Set HTTP time condition. This must be one of the defines in the
 847      * curl/curl.h header file.
 848      */
 849     data->set.timecondition = (curl_TimeCond)va_arg(param, long);
 850     break;
 851   case CURLOPT_TIMEVALUE:
 852     /*
 853      * This is the value to compare with the remote document with the
 854      * method set with CURLOPT_TIMECONDITION
 855      */
 856     data->set.timevalue = (time_t)va_arg(param, long);
 857     break;
 858   case CURLOPT_SSLVERSION:
 859     /*
 860      * Set explicit SSL version to try to connect with, as some SSL
 861      * implementations are lame.
 862      */
 863     data->set.ssl.version = va_arg(param, long);
 864     break;
 865
 866 #ifndef CURL_DISABLE_HTTP
 867   case CURLOPT_AUTOREFERER:
 868     /*
 869      * Switch on automatic referer that gets set if curl follows locations.
 870      */
 871     data->set.http_auto_referer = (0 != va_arg(param, long))?TRUE:FALSE;
 872     break;
 873
 874   case CURLOPT_ACCEPT_ENCODING:
 875     /*
 876      * String to use at the value of Accept-Encoding header.
 877      *
 878      * If the encoding is set to "" we use an Accept-Encoding header that
 879      * encompasses all the encodings we support.
 880      * If the encoding is set to NULL we don't send an Accept-Encoding header
 881      * and ignore an received Content-Encoding header.
 882      *
 883      */
 884     argptr = va_arg(param, char *);
 885     result = setstropt(&data->set.str[STRING_ENCODING],
 886                        (argptr && !*argptr)?
 887                        (char *) ALL_CONTENT_ENCODINGS: argptr);
 888     break;
 889
 890   case CURLOPT_TRANSFER_ENCODING:
 891     data->set.http_transfer_encoding = (0 != va_arg(param, long))?TRUE:FALSE;
 892     break;
 893
 894   case CURLOPT_FOLLOWLOCATION:
 895     /*
 896      * Follow Location: header hints on a HTTP-server.
 897      */
 898     data->set.http_follow_location = (0 != va_arg(param, long))?TRUE:FALSE;
 899     break;
 900
 901   case CURLOPT_UNRESTRICTED_AUTH:
 902     /*
 903      * Send authentication (user+password) when following locations, even when
 904      * hostname changed.
 905      */
 906     data->set.http_disable_hostname_check_before_authentication =
 907       (0 != va_arg(param, long))?TRUE:FALSE;
 908     break;
 909
 910   case CURLOPT_MAXREDIRS:
 911     /*
 912      * The maximum amount of hops you allow curl to follow Location:
 913      * headers. This should mostly be used to detect never-ending loops.
 914      */
 915     data->set.maxredirs = va_arg(param, long);
 916     break;
 917
 918   case CURLOPT_POSTREDIR:
 919   {
 920     /*
 921      * Set the behaviour of POST when redirecting
 922      * CURL_REDIR_GET_ALL - POST is changed to GET after 301 and 302
 923      * CURL_REDIR_POST_301 - POST is kept as POST after 301
 924      * CURL_REDIR_POST_302 - POST is kept as POST after 302
 925      * CURL_REDIR_POST_303 - POST is kept as POST after 303
 926      * CURL_REDIR_POST_ALL - POST is kept as POST after 301, 302 and 303
 927      * other - POST is kept as POST after 301 and 302
 928      */
 929     int postRedir = curlx_sltosi(va_arg(param, long));
 930     data->set.keep_post = postRedir & CURL_REDIR_POST_ALL;
 931   }
 932   break;
 933
 934   case CURLOPT_POST:
 935     /* Does this option serve a purpose anymore? Yes it does, when
 936        CURLOPT_POSTFIELDS isn't used and the POST data is read off the
 937        callback! */
 938     if(va_arg(param, long)) {
 939       data->set.httpreq = HTTPREQ_POST;
 940       data->set.opt_no_body = FALSE; /* this is implied */
 941     }
 942     else
 943       data->set.httpreq = HTTPREQ_GET;
 944     break;
 945
 946   case CURLOPT_COPYPOSTFIELDS:
 947     /*
 948      * A string with POST data. Makes curl HTTP POST. Even if it is NULL.
 949      * If needed, CURLOPT_POSTFIELDSIZE must have been set prior to
 950      *  CURLOPT_COPYPOSTFIELDS and not altered later.
 951      */
 952     argptr = va_arg(param, char *);
 953
 954     if(!argptr || data->set.postfieldsize == -1)
 955       result = setstropt(&data->set.str[STRING_COPYPOSTFIELDS], argptr);
 956     else {
 957       /*
 958        *  Check that requested length does not overflow the size_t type.
 959        */
 960
 961       if((data->set.postfieldsize < 0) ||
 962          ((sizeof(curl_off_t) != sizeof(size_t)) &&
 963           (data->set.postfieldsize > (curl_off_t)((size_t)-1))))
 964         result = CURLE_OUT_OF_MEMORY;
 965       else {
 966         char * p;
 967
 968         (void) setstropt(&data->set.str[STRING_COPYPOSTFIELDS], NULL);
 969
 970         /* Allocate even when size == 0. This satisfies the need of possible
 971            later address compare to detect the COPYPOSTFIELDS mode, and
 972            to mark that postfields is used rather than read function or
 973            form data.
 974         */
 975         p = malloc((size_t)(data->set.postfieldsize?
 976                             data->set.postfieldsize:1));
 977
 978         if(!p)
 979           result = CURLE_OUT_OF_MEMORY;
 980         else {
 981           if(data->set.postfieldsize)
 982             memcpy(p, argptr, (size_t)data->set.postfieldsize);
 983
 984           data->set.str[STRING_COPYPOSTFIELDS] = p;
 985         }
 986       }
 987     }
 988
 989     data->set.postfields = data->set.str[STRING_COPYPOSTFIELDS];
 990     data->set.httpreq = HTTPREQ_POST;
 991     break;
 992
 993   case CURLOPT_POSTFIELDS:
 994     /*
 995      * Like above, but use static data instead of copying it.
 996      */
 997     data->set.postfields = va_arg(param, void *);
 998     /* Release old copied data. */
 999     (void) setstropt(&data->set.str[STRING_COPYPOSTFIELDS], NULL);
1000     data->set.httpreq = HTTPREQ_POST;
1001     break;
1002
1003   case CURLOPT_POSTFIELDSIZE:
1004     /*
1005      * The size of the POSTFIELD data to prevent libcurl to do strlen() to
1006      * figure it out. Enables binary posts.
1007      */
1008     bigsize = va_arg(param, long);
1009
1010     if(data->set.postfieldsize < bigsize &&
1011        data->set.postfields == data->set.str[STRING_COPYPOSTFIELDS]) {
1012       /* Previous CURLOPT_COPYPOSTFIELDS is no longer valid. */
1013       (void) setstropt(&data->set.str[STRING_COPYPOSTFIELDS], NULL);
1014       data->set.postfields = NULL;
1015     }
1016
1017     data->set.postfieldsize = bigsize;
1018     break;
1019
1020   case CURLOPT_POSTFIELDSIZE_LARGE:
1021     /*
1022      * The size of the POSTFIELD data to prevent libcurl to do strlen() to
1023      * figure it out. Enables binary posts.
1024      */
1025     bigsize = va_arg(param, curl_off_t);
1026
1027     if(data->set.postfieldsize < bigsize &&
1028        data->set.postfields == data->set.str[STRING_COPYPOSTFIELDS]) {
1029       /* Previous CURLOPT_COPYPOSTFIELDS is no longer valid. */
1030       (void) setstropt(&data->set.str[STRING_COPYPOSTFIELDS], NULL);
1031       data->set.postfields = NULL;
1032     }
1033
1034     data->set.postfieldsize = bigsize;
1035     break;
1036
1037   case CURLOPT_HTTPPOST:
1038     /*
1039      * Set to make us do HTTP POST
1040      */
1041     data->set.httppost = va_arg(param, struct curl_httppost *);
1042     data->set.httpreq = HTTPREQ_POST_FORM;
1043     data->set.opt_no_body = FALSE; /* this is implied */
1044     break;
1045
1046   case CURLOPT_REFERER:
1047     /*
1048      * String to set in the HTTP Referer: field.
1049      */
1050     if(data->change.referer_alloc) {
1051       Curl_safefree(data->change.referer);
1052       data->change.referer_alloc = FALSE;
1053     }
1054     result = setstropt(&data->set.str[STRING_SET_REFERER],
1055                        va_arg(param, char *));
1056     data->change.referer = data->set.str[STRING_SET_REFERER];
1057     break;
1058
1059   case CURLOPT_USERAGENT:
1060     /*
1061      * String to use in the HTTP User-Agent field
1062      */
1063     result = setstropt(&data->set.str[STRING_USERAGENT],
1064                        va_arg(param, char *));
1065     break;
1066
1067   case CURLOPT_HTTPHEADER:
1068     /*
1069      * Set a list with HTTP headers to use (or replace internals with)
1070      */
1071     data->set.headers = va_arg(param, struct curl_slist *);
1072     break;
1073
1074   case CURLOPT_HTTP200ALIASES:
1075     /*
1076      * Set a list of aliases for HTTP 200 in response header
1077      */
1078     data->set.http200aliases = va_arg(param, struct curl_slist *);
1079     break;
1080
1081 #if !defined(CURL_DISABLE_COOKIES)
1082   case CURLOPT_COOKIE:
1083     /*
1084      * Cookie string to send to the remote server in the request.
1085      */
1086     result = setstropt(&data->set.str[STRING_COOKIE],
1087                        va_arg(param, char *));
1088     break;
1089
1090   case CURLOPT_COOKIEFILE:
1091     /*
1092      * Set cookie file to read and parse. Can be used multiple times.
1093      */
1094     argptr = (char *)va_arg(param, void *);
1095     if(argptr) {
1096       struct curl_slist *cl;
1097       /* append the cookie file name to the list of file names, and deal with
1098          them later */
1099       cl = curl_slist_append(data->change.cookielist, argptr);
1100       if(!cl) {
1101         curl_slist_free_all(data->change.cookielist);
1102         data->change.cookielist = NULL;
1103         return CURLE_OUT_OF_MEMORY;
1104       }
1105       data->change.cookielist = cl; /* store the list for later use */
1106     }
1107     break;
1108
1109   case CURLOPT_COOKIEJAR:
1110     /*
1111      * Set cookie file name to dump all cookies to when we're done.
1112      */
1113     result = setstropt(&data->set.str[STRING_COOKIEJAR],
1114                        va_arg(param, char *));
1115
1116     /*
1117      * Activate the cookie parser. This may or may not already
1118      * have been made.
1119      */
1120     data->cookies = Curl_cookie_init(data, NULL, data->cookies,
1121                                      data->set.cookiesession);
1122     break;
1123
1124   case CURLOPT_COOKIESESSION:
1125     /*
1126      * Set this option to TRUE to start a new "cookie session". It will
1127      * prevent the forthcoming read-cookies-from-file actions to accept
1128      * cookies that are marked as being session cookies, as they belong to a
1129      * previous session.
1130      *
1131      * In the original Netscape cookie spec, "session cookies" are cookies
1132      * with no expire date set. RFC2109 describes the same action if no
1133      * 'Max-Age' is set and RFC2965 includes the RFC2109 description and adds
1134      * a 'Discard' action that can enforce the discard even for cookies that
1135      * have a Max-Age.
1136      *
1137      * We run mostly with the original cookie spec, as hardly anyone implements
1138      * anything else.
1139      */
1140     data->set.cookiesession = (0 != va_arg(param, long))?TRUE:FALSE;
1141     break;
1142
1143   case CURLOPT_COOKIELIST:
1144     argptr = va_arg(param, char *);
1145
1146     if(argptr == NULL)
1147       break;
1148
1149     Curl_share_lock(data, CURL_LOCK_DATA_COOKIE, CURL_LOCK_ACCESS_SINGLE);
1150
1151     if(Curl_raw_equal(argptr, "ALL")) {
1152       /* clear all cookies */
1153       Curl_cookie_clearall(data->cookies);
1154     }
1155     else if(Curl_raw_equal(argptr, "SESS")) {
1156       /* clear session cookies */
1157       Curl_cookie_clearsess(data->cookies);
1158     }
1159     else if(Curl_raw_equal(argptr, "FLUSH")) {
1160       /* flush cookies to file */
1161       Curl_flush_cookies(data, 0);
1162     }
1163     else {
1164       if(!data->cookies)
1165         /* if cookie engine was not running, activate it */
1166         data->cookies = Curl_cookie_init(data, NULL, NULL, TRUE);
1167
1168       argptr = strdup(argptr);
1169       if(!argptr) {
1170         result = CURLE_OUT_OF_MEMORY;
1171       }
1172       else {
1173
1174         if(checkprefix("Set-Cookie:", argptr))
1175           /* HTTP Header format line */
1176           Curl_cookie_add(data, data->cookies, TRUE, argptr + 11, NULL, NULL);
1177
1178         else
1179           /* Netscape format line */
1180           Curl_cookie_add(data, data->cookies, FALSE, argptr, NULL, NULL);
1181
1182         free(argptr);
1183       }
1184     }
1185     Curl_share_unlock(data, CURL_LOCK_DATA_COOKIE);
1186
1187     break;
1188 #endif /* CURL_DISABLE_COOKIES */
1189
1190   case CURLOPT_HTTPGET:
1191     /*
1192      * Set to force us do HTTP GET
1193      */
1194     if(va_arg(param, long)) {
1195       data->set.httpreq = HTTPREQ_GET;
1196       data->set.upload = FALSE; /* switch off upload */
1197       data->set.opt_no_body = FALSE; /* this is implied */
1198     }
1199     break;
1200
1201   case CURLOPT_HTTP_VERSION:
1202     /*
1203      * This sets a requested HTTP version to be used. The value is one of
1204      * the listed enums in curl/curl.h.
1205      */
1206     arg = va_arg(param, long);
1207 #ifndef USE_NGHTTP2
1208     if(arg == CURL_HTTP_VERSION_2_0)
1209       return CURLE_UNSUPPORTED_PROTOCOL;
1210 #endif
1211     data->set.httpversion = arg;
1212     break;
1213
1214   case CURLOPT_HTTPAUTH:
1215     /*
1216      * Set HTTP Authentication type BITMASK.
1217      */
1218   {
1219     int bitcheck;
1220     bool authbits;
1221     unsigned long auth = va_arg(param, unsigned long);
1222
1223     if(auth == CURLAUTH_NONE) {
1224       data->set.httpauth = auth;
1225       break;
1226     }
1227
1228     /* the DIGEST_IE bit is only used to set a special marker, for all the
1229        rest we need to handle it as normal DIGEST */
1230     data->state.authhost.iestyle = (auth & CURLAUTH_DIGEST_IE)?TRUE:FALSE;
1231
1232     if(auth & CURLAUTH_DIGEST_IE) {
1233       auth |= CURLAUTH_DIGEST; /* set standard digest bit */
1234       auth &= ~CURLAUTH_DIGEST_IE; /* unset ie digest bit */
1235     }
1236
1237     /* switch off bits we can't support */
1238 #ifndef USE_NTLM
1239     auth &= ~CURLAUTH_NTLM;    /* no NTLM support */
1240     auth &= ~CURLAUTH_NTLM_WB; /* no NTLM_WB support */
1241 #elif !defined(NTLM_WB_ENABLED)
1242     auth &= ~CURLAUTH_NTLM_WB; /* no NTLM_WB support */
1243 #endif
1244 #ifndef USE_HTTP_NEGOTIATE
1245     auth &= ~CURLAUTH_GSSNEGOTIATE; /* no GSS-Negotiate without GSSAPI or
1246                                        WINDOWS_SSPI */
1247 #endif
1248
1249     /* check if any auth bit lower than CURLAUTH_ONLY is still set */
1250     bitcheck = 0;
1251     authbits = FALSE;
1252     while(bitcheck < 31) {
1253       if(auth & (1UL << bitcheck++)) {
1254         authbits = TRUE;
1255         break;
1256       }
1257     }
1258     if(!authbits)
1259       return CURLE_NOT_BUILT_IN; /* no supported types left! */
1260
1261     data->set.httpauth = auth;
1262   }
1263   break;
1264
1265 #endif   /* CURL_DISABLE_HTTP */
1266
1267   case CURLOPT_CUSTOMREQUEST:
1268     /*
1269      * Set a custom string to use as request
1270      */
1271     result = setstropt(&data->set.str[STRING_CUSTOMREQUEST],
1272                        va_arg(param, char *));
1273
1274     /* we don't set
1275        data->set.httpreq = HTTPREQ_CUSTOM;
1276        here, we continue as if we were using the already set type
1277        and this just changes the actual request keyword */
1278     break;
1279
1280 #ifndef CURL_DISABLE_PROXY
1281   case CURLOPT_HTTPPROXYTUNNEL:
1282     /*
1283      * Tunnel operations through the proxy instead of normal proxy use
1284      */
1285     data->set.tunnel_thru_httpproxy = (0 != va_arg(param, long))?TRUE:FALSE;
1286     break;
1287
1288   case CURLOPT_PROXYPORT:
1289     /*
1290      * Explicitly set HTTP proxy port number.
1291      */
1292     data->set.proxyport = va_arg(param, long);
1293     break;
1294
1295   case CURLOPT_PROXYAUTH:
1296     /*
1297      * Set HTTP Authentication type BITMASK.
1298      */
1299   {
1300     int bitcheck;
1301     bool authbits;
1302     unsigned long auth = va_arg(param, unsigned long);
1303
1304     if(auth == CURLAUTH_NONE) {
1305       data->set.proxyauth = auth;
1306       break;
1307     }
1308
1309     /* the DIGEST_IE bit is only used to set a special marker, for all the
1310        rest we need to handle it as normal DIGEST */
1311     data->state.authproxy.iestyle = (auth & CURLAUTH_DIGEST_IE)?TRUE:FALSE;
1312
1313     if(auth & CURLAUTH_DIGEST_IE) {
1314       auth |= CURLAUTH_DIGEST; /* set standard digest bit */
1315       auth &= ~CURLAUTH_DIGEST_IE; /* unset ie digest bit */
1316     }
1317     /* switch off bits we can't support */
1318 #ifndef USE_NTLM
1319     auth &= ~CURLAUTH_NTLM;    /* no NTLM support */
1320     auth &= ~CURLAUTH_NTLM_WB; /* no NTLM_WB support */
1321 #elif !defined(NTLM_WB_ENABLED)
1322     auth &= ~CURLAUTH_NTLM_WB; /* no NTLM_WB support */
1323 #endif
1324 #ifndef USE_HTTP_NEGOTIATE
1325     auth &= ~CURLAUTH_GSSNEGOTIATE; /* no GSS-Negotiate without GSSAPI or
1326                                        WINDOWS_SSPI */
1327 #endif
1328
1329     /* check if any auth bit lower than CURLAUTH_ONLY is still set */
1330     bitcheck = 0;
1331     authbits = FALSE;
1332     while(bitcheck < 31) {
1333       if(auth & (1UL << bitcheck++)) {
1334         authbits = TRUE;
1335         break;
1336       }
1337     }
1338     if(!authbits)
1339       return CURLE_NOT_BUILT_IN; /* no supported types left! */
1340
1341     data->set.proxyauth = auth;
1342   }
1343   break;
1344
1345   case CURLOPT_PROXY:
1346     /*
1347      * Set proxy server:port to use as HTTP proxy.
1348      *
1349      * If the proxy is set to "" we explicitly say that we don't want to use a
1350      * proxy (even though there might be environment variables saying so).
1351      *
1352      * Setting it to NULL, means no proxy but allows the environment variables
1353      * to decide for us.
1354      */
1355     result = setstropt(&data->set.str[STRING_PROXY],
1356                        va_arg(param, char *));
1357     break;
1358
1359   case CURLOPT_PROXYTYPE:
1360     /*
1361      * Set proxy type. HTTP/HTTP_1_0/SOCKS4/SOCKS4a/SOCKS5/SOCKS5_HOSTNAME
1362      */
1363     data->set.proxytype = (curl_proxytype)va_arg(param, long);
1364     break;
1365
1366   case CURLOPT_PROXY_TRANSFER_MODE:
1367     /*
1368      * set transfer mode (;type=<a|i>) when doing FTP via an HTTP proxy
1369      */
1370     switch (va_arg(param, long)) {
1371     case 0:
1372       data->set.proxy_transfer_mode = FALSE;
1373       break;
1374     case 1:
1375       data->set.proxy_transfer_mode = TRUE;
1376       break;
1377     default:
1378       /* reserve other values for future use */
1379       result = CURLE_UNKNOWN_OPTION;
1380       break;
1381     }
1382     break;
1383 #endif   /* CURL_DISABLE_PROXY */
1384
1385 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1386   case CURLOPT_SOCKS5_GSSAPI_SERVICE:
1387     /*
1388      * Set gssapi service name
1389      */
1390     result = setstropt(&data->set.str[STRING_SOCKS5_GSSAPI_SERVICE],
1391                        va_arg(param, char *));
1392     break;
1393
1394   case CURLOPT_SOCKS5_GSSAPI_NEC:
1395     /*
1396      * set flag for nec socks5 support
1397      */
1398     data->set.socks5_gssapi_nec = (0 != va_arg(param, long))?TRUE:FALSE;
1399     break;
1400 #endif
1401
1402   case CURLOPT_WRITEHEADER:
1403     /*
1404      * Custom pointer to pass the header write callback function
1405      */
1406     data->set.writeheader = (void *)va_arg(param, void *);
1407     break;
1408   case CURLOPT_ERRORBUFFER:
1409     /*
1410      * Error buffer provided by the caller to get the human readable
1411      * error string in.
1412      */
1413     data->set.errorbuffer = va_arg(param, char *);
1414     break;
1415   case CURLOPT_FILE:
1416     /*
1417      * FILE pointer to write to. Or possibly
1418      * used as argument to the write callback.
1419      */
1420     data->set.out = va_arg(param, void *);
1421     break;
1422   case CURLOPT_FTPPORT:
1423     /*
1424      * Use FTP PORT, this also specifies which IP address to use
1425      */
1426     result = setstropt(&data->set.str[STRING_FTPPORT],
1427                        va_arg(param, char *));
1428     data->set.ftp_use_port = (NULL != data->set.str[STRING_FTPPORT]) ?
1429                              TRUE:FALSE;
1430     break;
1431
1432   case CURLOPT_FTP_USE_EPRT:
1433     data->set.ftp_use_eprt = (0 != va_arg(param, long))?TRUE:FALSE;
1434     break;
1435
1436   case CURLOPT_FTP_USE_EPSV:
1437     data->set.ftp_use_epsv = (0 != va_arg(param, long))?TRUE:FALSE;
1438     break;
1439
1440   case CURLOPT_FTP_USE_PRET:
1441     data->set.ftp_use_pret = (0 != va_arg(param, long))?TRUE:FALSE;
1442     break;
1443
1444   case CURLOPT_FTP_SSL_CCC:
1445     data->set.ftp_ccc = (curl_ftpccc)va_arg(param, long);
1446     break;
1447
1448   case CURLOPT_FTP_SKIP_PASV_IP:
1449     /*
1450      * Enable or disable FTP_SKIP_PASV_IP, which will disable/enable the
1451      * bypass of the IP address in PASV responses.
1452      */
1453     data->set.ftp_skip_ip = (0 != va_arg(param, long))?TRUE:FALSE;
1454     break;
1455
1456   case CURLOPT_INFILE:
1457     /*
1458      * FILE pointer to read the file to be uploaded from. Or possibly
1459      * used as argument to the read callback.
1460      */
1461     data->set.in = va_arg(param, void *);
1462     break;
1463   case CURLOPT_INFILESIZE:
1464     /*
1465      * If known, this should inform curl about the file size of the
1466      * to-be-uploaded file.
1467      */
1468     data->set.infilesize = va_arg(param, long);
1469     break;
1470   case CURLOPT_INFILESIZE_LARGE:
1471     /*
1472      * If known, this should inform curl about the file size of the
1473      * to-be-uploaded file.
1474      */
1475     data->set.infilesize = va_arg(param, curl_off_t);
1476     break;
1477   case CURLOPT_LOW_SPEED_LIMIT:
1478     /*
1479      * The low speed limit that if transfers are below this for
1480      * CURLOPT_LOW_SPEED_TIME, the transfer is aborted.
1481      */
1482     data->set.low_speed_limit=va_arg(param, long);
1483     break;
1484   case CURLOPT_MAX_SEND_SPEED_LARGE:
1485     /*
1486      * When transfer uploads are faster then CURLOPT_MAX_SEND_SPEED_LARGE
1487      * bytes per second the transfer is throttled..
1488      */
1489     data->set.max_send_speed=va_arg(param, curl_off_t);
1490     break;
1491   case CURLOPT_MAX_RECV_SPEED_LARGE:
1492     /*
1493      * When receiving data faster than CURLOPT_MAX_RECV_SPEED_LARGE bytes per
1494      * second the transfer is throttled..
1495      */
1496     data->set.max_recv_speed=va_arg(param, curl_off_t);
1497     break;
1498   case CURLOPT_LOW_SPEED_TIME:
1499     /*
1500      * The low speed time that if transfers are below the set
1501      * CURLOPT_LOW_SPEED_LIMIT during this time, the transfer is aborted.
1502      */
1503     data->set.low_speed_time=va_arg(param, long);
1504     break;
1505   case CURLOPT_URL:
1506     /*
1507      * The URL to fetch.
1508      */
1509     if(data->change.url_alloc) {
1510       /* the already set URL is allocated, free it first! */
1511       Curl_safefree(data->change.url);
1512       data->change.url_alloc = FALSE;
1513     }
1514     result = setstropt(&data->set.str[STRING_SET_URL],
1515                        va_arg(param, char *));
1516     data->change.url = data->set.str[STRING_SET_URL];
1517     break;
1518   case CURLOPT_PORT:
1519     /*
1520      * The port number to use when getting the URL
1521      */
1522     data->set.use_port = va_arg(param, long);
1523     break;
1524   case CURLOPT_TIMEOUT:
1525     /*
1526      * The maximum time you allow curl to use for a single transfer
1527      * operation.
1528      */
1529     data->set.timeout = va_arg(param, long) * 1000L;
1530     break;
1531
1532   case CURLOPT_TIMEOUT_MS:
1533     data->set.timeout = va_arg(param, long);
1534     break;
1535
1536   case CURLOPT_CONNECTTIMEOUT:
1537     /*
1538      * The maximum time you allow curl to use to connect.
1539      */
1540     data->set.connecttimeout = va_arg(param, long) * 1000L;
1541     break;
1542
1543   case CURLOPT_CONNECTTIMEOUT_MS:
1544     data->set.connecttimeout = va_arg(param, long);
1545     break;
1546
1547   case CURLOPT_ACCEPTTIMEOUT_MS:
1548     /*
1549      * The maximum time you allow curl to wait for server connect
1550      */
1551     data->set.accepttimeout = va_arg(param, long);
1552     break;
1553
1554   case CURLOPT_USERPWD:
1555     /*
1556      * user:password;options to use in the operation
1557      */
1558     result = setstropt_userpwd(va_arg(param, char *),
1559                                &data->set.str[STRING_USERNAME],
1560                                &data->set.str[STRING_PASSWORD],
1561                                &data->set.str[STRING_OPTIONS]);
1562     break;
1563   case CURLOPT_USERNAME:
1564     /*
1565      * authentication user name to use in the operation
1566      */
1567     result = setstropt(&data->set.str[STRING_USERNAME],
1568                        va_arg(param, char *));
1569     break;
1570   case CURLOPT_PASSWORD:
1571     /*
1572      * authentication password to use in the operation
1573      */
1574     result = setstropt(&data->set.str[STRING_PASSWORD],
1575                        va_arg(param, char *));
1576     break;
1577   case CURLOPT_XOAUTH2_BEARER:
1578     /*
1579      * XOAUTH2 bearer token to use in the operation
1580      */
1581     result = setstropt(&data->set.str[STRING_BEARER],
1582                        va_arg(param, char *));
1583     break;
1584   case CURLOPT_POSTQUOTE:
1585     /*
1586      * List of RAW FTP commands to use after a transfer
1587      */
1588     data->set.postquote = va_arg(param, struct curl_slist *);
1589     break;
1590   case CURLOPT_PREQUOTE:
1591     /*
1592      * List of RAW FTP commands to use prior to RETR (Wesley Laxton)
1593      */
1594     data->set.prequote = va_arg(param, struct curl_slist *);
1595     break;
1596   case CURLOPT_QUOTE:
1597     /*
1598      * List of RAW FTP commands to use before a transfer
1599      */
1600     data->set.quote = va_arg(param, struct curl_slist *);
1601     break;
1602   case CURLOPT_RESOLVE:
1603     /*
1604      * List of NAME:[address] names to populate the DNS cache with
1605      * Prefix the NAME with dash (-) to _remove_ the name from the cache.
1606      *
1607      * Names added with this API will remain in the cache until explicitly
1608      * removed or the handle is cleaned up.
1609      *
1610      * This API can remove any name from the DNS cache, but only entries
1611      * that aren't actually in use right now will be pruned immediately.
1612      */
1613     data->set.resolve = va_arg(param, struct curl_slist *);
1614     data->change.resolve = data->set.resolve;
1615     break;
1616   case CURLOPT_PROGRESSFUNCTION:
1617     /*
1618      * Progress callback function
1619      */
1620     data->set.fprogress = va_arg(param, curl_progress_callback);
1621     if(data->set.fprogress)
1622       data->progress.callback = TRUE; /* no longer internal */
1623     else
1624       data->progress.callback = FALSE; /* NULL enforces internal */
1625     break;
1626
1627   case CURLOPT_XFERINFOFUNCTION:
1628     /*
1629      * Transfer info callback function
1630      */
1631     data->set.fxferinfo = va_arg(param, curl_xferinfo_callback);
1632     if(data->set.fxferinfo)
1633       data->progress.callback = TRUE; /* no longer internal */
1634     else
1635       data->progress.callback = FALSE; /* NULL enforces internal */
1636
1637     break;
1638
1639   case CURLOPT_PROGRESSDATA:
1640     /*
1641      * Custom client data to pass to the progress callback
1642      */
1643     data->set.progress_client = va_arg(param, void *);
1644     break;
1645
1646 #ifndef CURL_DISABLE_PROXY
1647   case CURLOPT_PROXYUSERPWD:
1648     /*
1649      * user:password needed to use the proxy
1650      */
1651     result = setstropt_userpwd(va_arg(param, char *),
1652                                &data->set.str[STRING_PROXYUSERNAME],
1653                                &data->set.str[STRING_PROXYPASSWORD], NULL);
1654     break;
1655   case CURLOPT_PROXYUSERNAME:
1656     /*
1657      * authentication user name to use in the operation
1658      */
1659     result = setstropt(&data->set.str[STRING_PROXYUSERNAME],
1660                        va_arg(param, char *));
1661     break;
1662   case CURLOPT_PROXYPASSWORD:
1663     /*
1664      * authentication password to use in the operation
1665      */
1666     result = setstropt(&data->set.str[STRING_PROXYPASSWORD],
1667                        va_arg(param, char *));
1668     break;
1669   case CURLOPT_NOPROXY:
1670     /*
1671      * proxy exception list
1672      */
1673     result = setstropt(&data->set.str[STRING_NOPROXY],
1674                        va_arg(param, char *));
1675     break;
1676 #endif
1677
1678   case CURLOPT_RANGE:
1679     /*
1680      * What range of the file you want to transfer
1681      */
1682     result = setstropt(&data->set.str[STRING_SET_RANGE],
1683                        va_arg(param, char *));
1684     break;
1685   case CURLOPT_RESUME_FROM:
1686     /*
1687      * Resume transfer at the give file position
1688      */
1689     data->set.set_resume_from = va_arg(param, long);
1690     break;
1691   case CURLOPT_RESUME_FROM_LARGE:
1692     /*
1693      * Resume transfer at the give file position
1694      */
1695     data->set.set_resume_from = va_arg(param, curl_off_t);
1696     break;
1697   case CURLOPT_DEBUGFUNCTION:
1698     /*
1699      * stderr write callback.
1700      */
1701     data->set.fdebug = va_arg(param, curl_debug_callback);
1702     /*
1703      * if the callback provided is NULL, it'll use the default callback
1704      */
1705     break;
1706   case CURLOPT_DEBUGDATA:
1707     /*
1708      * Set to a void * that should receive all error writes. This
1709      * defaults to CURLOPT_STDERR for normal operations.
1710      */
1711     data->set.debugdata = va_arg(param, void *);
1712     break;
1713   case CURLOPT_STDERR:
1714     /*
1715      * Set to a FILE * that should receive all error writes. This
1716      * defaults to stderr for normal operations.
1717      */
1718     data->set.err = va_arg(param, FILE *);
1719     if(!data->set.err)
1720       data->set.err = stderr;
1721     break;
1722   case CURLOPT_HEADERFUNCTION:
1723     /*
1724      * Set header write callback
1725      */
1726     data->set.fwrite_header = va_arg(param, curl_write_callback);
1727     break;
1728   case CURLOPT_WRITEFUNCTION:
1729     /*
1730      * Set data write callback
1731      */
1732     data->set.fwrite_func = va_arg(param, curl_write_callback);
1733     if(!data->set.fwrite_func) {
1734       data->set.is_fwrite_set = 0;
1735       /* When set to NULL, reset to our internal default function */
1736       data->set.fwrite_func = (curl_write_callback)fwrite;
1737     }
1738     else
1739       data->set.is_fwrite_set = 1;
1740     break;
1741   case CURLOPT_READFUNCTION:
1742     /*
1743      * Read data callback
1744      */
1745     data->set.fread_func = va_arg(param, curl_read_callback);
1746     if(!data->set.fread_func) {
1747       data->set.is_fread_set = 0;
1748       /* When set to NULL, reset to our internal default function */
1749       data->set.fread_func = (curl_read_callback)fread;
1750     }
1751     else
1752       data->set.is_fread_set = 1;
1753     break;
1754   case CURLOPT_SEEKFUNCTION:
1755     /*
1756      * Seek callback. Might be NULL.
1757      */
1758     data->set.seek_func = va_arg(param, curl_seek_callback);
1759     break;
1760   case CURLOPT_SEEKDATA:
1761     /*
1762      * Seek control callback. Might be NULL.
1763      */
1764     data->set.seek_client = va_arg(param, void *);
1765     break;
1766   case CURLOPT_CONV_FROM_NETWORK_FUNCTION:
1767     /*
1768      * "Convert from network encoding" callback
1769      */
1770     data->set.convfromnetwork = va_arg(param, curl_conv_callback);
1771     break;
1772   case CURLOPT_CONV_TO_NETWORK_FUNCTION:
1773     /*
1774      * "Convert to network encoding" callback
1775      */
1776     data->set.convtonetwork = va_arg(param, curl_conv_callback);
1777     break;
1778   case CURLOPT_CONV_FROM_UTF8_FUNCTION:
1779     /*
1780      * "Convert from UTF-8 encoding" callback
1781      */
1782     data->set.convfromutf8 = va_arg(param, curl_conv_callback);
1783     break;
1784   case CURLOPT_IOCTLFUNCTION:
1785     /*
1786      * I/O control callback. Might be NULL.
1787      */
1788     data->set.ioctl_func = va_arg(param, curl_ioctl_callback);
1789     break;
1790   case CURLOPT_IOCTLDATA:
1791     /*
1792      * I/O control data pointer. Might be NULL.
1793      */
1794     data->set.ioctl_client = va_arg(param, void *);
1795     break;
1796   case CURLOPT_SSLCERT:
1797     /*
1798      * String that holds file name of the SSL certificate to use
1799      */
1800     result = setstropt(&data->set.str[STRING_CERT],
1801                        va_arg(param, char *));
1802     break;
1803   case CURLOPT_SSLCERTTYPE:
1804     /*
1805      * String that holds file type of the SSL certificate to use
1806      */
1807     result = setstropt(&data->set.str[STRING_CERT_TYPE],
1808                        va_arg(param, char *));
1809     break;
1810   case CURLOPT_SSLKEY:
1811     /*
1812      * String that holds file name of the SSL key to use
1813      */
1814     result = setstropt(&data->set.str[STRING_KEY],
1815                        va_arg(param, char *));
1816     break;
1817   case CURLOPT_SSLKEYTYPE:
1818     /*
1819      * String that holds file type of the SSL key to use
1820      */
1821     result = setstropt(&data->set.str[STRING_KEY_TYPE],
1822                        va_arg(param, char *));
1823     break;
1824   case CURLOPT_KEYPASSWD:
1825     /*
1826      * String that holds the SSL or SSH private key password.
1827      */
1828     result = setstropt(&data->set.str[STRING_KEY_PASSWD],
1829                        va_arg(param, char *));
1830     break;
1831   case CURLOPT_SSLENGINE:
1832     /*
1833      * String that holds the SSL crypto engine.
1834      */
1835     argptr = va_arg(param, char *);
1836     if(argptr && argptr[0])
1837       result = Curl_ssl_set_engine(data, argptr);
1838     break;
1839
1840   case CURLOPT_SSLENGINE_DEFAULT:
1841     /*
1842      * flag to set engine as default.
1843      */
1844     result = Curl_ssl_set_engine_default(data);
1845     break;
1846   case CURLOPT_CRLF:
1847     /*
1848      * Kludgy option to enable CRLF conversions. Subject for removal.
1849      */
1850     data->set.crlf = (0 != va_arg(param, long))?TRUE:FALSE;
1851     break;
1852
1853   case CURLOPT_INTERFACE:
1854     /*
1855      * Set what interface or address/hostname to bind the socket to when
1856      * performing an operation and thus what from-IP your connection will use.
1857      */
1858     result = setstropt(&data->set.str[STRING_DEVICE],
1859                        va_arg(param, char *));
1860     break;
1861   case CURLOPT_LOCALPORT:
1862     /*
1863      * Set what local port to bind the socket to when performing an operation.
1864      */
1865     data->set.localport = curlx_sltous(va_arg(param, long));
1866     break;
1867   case CURLOPT_LOCALPORTRANGE:
1868     /*
1869      * Set number of local ports to try, starting with CURLOPT_LOCALPORT.
1870      */
1871     data->set.localportrange = curlx_sltosi(va_arg(param, long));
1872     break;
1873   case CURLOPT_KRBLEVEL:
1874     /*
1875      * A string that defines the kerberos security level.
1876      */
1877     result = setstropt(&data->set.str[STRING_KRB_LEVEL],
1878                        va_arg(param, char *));
1879     data->set.krb = (NULL != data->set.str[STRING_KRB_LEVEL])?TRUE:FALSE;
1880     break;
1881   case CURLOPT_GSSAPI_DELEGATION:
1882     /*
1883      * GSSAPI credential delegation
1884      */
1885     data->set.gssapi_delegation = va_arg(param, long);
1886     break;
1887   case CURLOPT_SSL_VERIFYPEER:
1888     /*
1889      * Enable peer SSL verifying.
1890      */
1891     data->set.ssl.verifypeer = (0 != va_arg(param, long))?TRUE:FALSE;
1892     break;
1893   case CURLOPT_SSL_VERIFYHOST:
1894     /*
1895      * Enable verification of the host name in the peer certificate
1896      */
1897     arg = va_arg(param, long);
1898
1899     /* Obviously people are not reading documentation and too many thought
1900        this argument took a boolean when it wasn't and misused it. We thus ban
1901        1 as a sensible input and we warn about its use. Then we only have the
1902        2 action internally stored as TRUE. */
1903
1904     if(1 == arg) {
1905       failf(data, "CURLOPT_SSL_VERIFYHOST no longer supports 1 as value!");
1906       return CURLE_BAD_FUNCTION_ARGUMENT;
1907     }
1908
1909     data->set.ssl.verifyhost = (0 != arg)?TRUE:FALSE;
1910     break;
1911 #ifdef USE_SSLEAY
1912     /* since these two options are only possible to use on an OpenSSL-
1913        powered libcurl we #ifdef them on this condition so that libcurls
1914        built against other SSL libs will return a proper error when trying
1915        to set this option! */
1916   case CURLOPT_SSL_CTX_FUNCTION:
1917     /*
1918      * Set a SSL_CTX callback
1919      */
1920     data->set.ssl.fsslctx = va_arg(param, curl_ssl_ctx_callback);
1921     break;
1922   case CURLOPT_SSL_CTX_DATA:
1923     /*
1924      * Set a SSL_CTX callback parameter pointer
1925      */
1926     data->set.ssl.fsslctxp = va_arg(param, void *);
1927     break;
1928 #endif
1929 #if defined(USE_SSLEAY) || defined(USE_QSOSSL) || defined(USE_GSKIT)
1930   case CURLOPT_CERTINFO:
1931     data->set.ssl.certinfo = (0 != va_arg(param, long))?TRUE:FALSE;
1932     break;
1933 #endif
1934   case CURLOPT_CAINFO:
1935     /*
1936      * Set CA info for SSL connection. Specify file name of the CA certificate
1937      */
1938     result = setstropt(&data->set.str[STRING_SSL_CAFILE],
1939                        va_arg(param, char *));
1940     break;
1941   case CURLOPT_CAPATH:
1942     /*
1943      * Set CA path info for SSL connection. Specify directory name of the CA
1944      * certificates which have been prepared using openssl c_rehash utility.
1945      */
1946     /* This does not work on windows. */
1947     result = setstropt(&data->set.str[STRING_SSL_CAPATH],
1948                        va_arg(param, char *));
1949     break;
1950   case CURLOPT_CRLFILE:
1951     /*
1952      * Set CRL file info for SSL connection. Specify file name of the CRL
1953      * to check certificates revocation
1954      */
1955     result = setstropt(&data->set.str[STRING_SSL_CRLFILE],
1956                        va_arg(param, char *));
1957     break;
1958   case CURLOPT_ISSUERCERT:
1959     /*
1960      * Set Issuer certificate file
1961      * to check certificates issuer
1962      */
1963     result = setstropt(&data->set.str[STRING_SSL_ISSUERCERT],
1964                        va_arg(param, char *));
1965     break;
1966   case CURLOPT_TELNETOPTIONS:
1967     /*
1968      * Set a linked list of telnet options
1969      */
1970     data->set.telnet_options = va_arg(param, struct curl_slist *);
1971     break;
1972
1973   case CURLOPT_BUFFERSIZE:
1974     /*
1975      * The application kindly asks for a differently sized receive buffer.
1976      * If it seems reasonable, we'll use it.
1977      */
1978     data->set.buffer_size = va_arg(param, long);
1979
1980     if((data->set.buffer_size> (BUFSIZE -1 )) ||
1981        (data->set.buffer_size < 1))
1982       data->set.buffer_size = 0; /* huge internal default */
1983
1984     break;
1985
1986   case CURLOPT_NOSIGNAL:
1987     /*
1988      * The application asks not to set any signal() or alarm() handlers,
1989      * even when using a timeout.
1990      */
1991     data->set.no_signal = (0 != va_arg(param, long))?TRUE:FALSE;
1992     break;
1993
1994   case CURLOPT_SHARE:
1995   {
1996     struct Curl_share *set;
1997     set = va_arg(param, struct Curl_share *);
1998
1999     /* disconnect from old share, if any */
2000     if(data->share) {
2001       Curl_share_lock(data, CURL_LOCK_DATA_SHARE, CURL_LOCK_ACCESS_SINGLE);
2002
2003       if(data->dns.hostcachetype == HCACHE_SHARED) {
2004         data->dns.hostcache = NULL;
2005         data->dns.hostcachetype = HCACHE_NONE;
2006       }
2007
2008 #if !defined(CURL_DISABLE_HTTP) && !defined(CURL_DISABLE_COOKIES)
2009       if(data->share->cookies == data->cookies)
2010         data->cookies = NULL;
2011 #endif
2012
2013       if(data->share->sslsession == data->state.session)
2014         data->state.session = NULL;
2015
2016       data->share->dirty--;
2017
2018       Curl_share_unlock(data, CURL_LOCK_DATA_SHARE);
2019       data->share = NULL;
2020     }
2021
2022     /* use new share if it set */
2023     data->share = set;
2024     if(data->share) {
2025
2026       Curl_share_lock(data, CURL_LOCK_DATA_SHARE, CURL_LOCK_ACCESS_SINGLE);
2027
2028       data->share->dirty++;
2029
2030       if(data->share->hostcache) {
2031         /* use shared host cache */
2032         data->dns.hostcache = data->share->hostcache;
2033         data->dns.hostcachetype = HCACHE_SHARED;
2034       }
2035 #if !defined(CURL_DISABLE_HTTP) && !defined(CURL_DISABLE_COOKIES)
2036       if(data->share->cookies) {
2037         /* use shared cookie list, first free own one if any */
2038         if(data->cookies)
2039           Curl_cookie_cleanup(data->cookies);
2040         /* enable cookies since we now use a share that uses cookies! */
2041         data->cookies = data->share->cookies;
2042       }
2043 #endif   /* CURL_DISABLE_HTTP */
2044       if(data->share->sslsession) {
2045         data->set.ssl.max_ssl_sessions = data->share->max_ssl_sessions;
2046         data->state.session = data->share->sslsession;
2047       }
2048       Curl_share_unlock(data, CURL_LOCK_DATA_SHARE);
2049
2050     }
2051     /* check for host cache not needed,
2052      * it will be done by curl_easy_perform */
2053   }
2054   break;
2055
2056   case CURLOPT_PRIVATE:
2057     /*
2058      * Set private data pointer.
2059      */
2060     data->set.private_data = va_arg(param, void *);
2061     break;
2062
2063   case CURLOPT_MAXFILESIZE:
2064     /*
2065      * Set the maximum size of a file to download.
2066      */
2067     data->set.max_filesize = va_arg(param, long);
2068     break;
2069
2070 #ifdef USE_SSL
2071   case CURLOPT_USE_SSL:
2072     /*
2073      * Make transfers attempt to use SSL/TLS.
2074      */
2075     data->set.use_ssl = (curl_usessl)va_arg(param, long);
2076     break;
2077
2078   case CURLOPT_SSL_OPTIONS:
2079     arg = va_arg(param, long);
2080     data->set.ssl_enable_beast = arg&CURLSSLOPT_ALLOW_BEAST?TRUE:FALSE;
2081     break;
2082
2083 #endif
2084   case CURLOPT_FTPSSLAUTH:
2085     /*
2086      * Set a specific auth for FTP-SSL transfers.
2087      */
2088     data->set.ftpsslauth = (curl_ftpauth)va_arg(param, long);
2089     break;
2090
2091   case CURLOPT_IPRESOLVE:
2092     data->set.ipver = va_arg(param, long);
2093     break;
2094
2095   case CURLOPT_MAXFILESIZE_LARGE:
2096     /*
2097      * Set the maximum size of a file to download.
2098      */
2099     data->set.max_filesize = va_arg(param, curl_off_t);
2100     break;
2101
2102   case CURLOPT_TCP_NODELAY:
2103     /*
2104      * Enable or disable TCP_NODELAY, which will disable/enable the Nagle
2105      * algorithm
2106      */
2107     data->set.tcp_nodelay = (0 != va_arg(param, long))?TRUE:FALSE;
2108     break;
2109
2110   case CURLOPT_FTP_ACCOUNT:
2111     result = setstropt(&data->set.str[STRING_FTP_ACCOUNT],
2112                        va_arg(param, char *));
2113     break;
2114
2115   case CURLOPT_IGNORE_CONTENT_LENGTH:
2116     data->set.ignorecl = (0 != va_arg(param, long))?TRUE:FALSE;
2117     break;
2118
2119   case CURLOPT_CONNECT_ONLY:
2120     /*
2121      * No data transfer, set up connection and let application use the socket
2122      */
2123     data->set.connect_only = (0 != va_arg(param, long))?TRUE:FALSE;
2124     break;
2125
2126   case CURLOPT_FTP_ALTERNATIVE_TO_USER:
2127     result = setstropt(&data->set.str[STRING_FTP_ALTERNATIVE_TO_USER],
2128                        va_arg(param, char *));
2129     break;
2130
2131   case CURLOPT_SOCKOPTFUNCTION:
2132     /*
2133      * socket callback function: called after socket() but before connect()
2134      */
2135     data->set.fsockopt = va_arg(param, curl_sockopt_callback);
2136     break;
2137
2138   case CURLOPT_SOCKOPTDATA:
2139     /*
2140      * socket callback data pointer. Might be NULL.
2141      */
2142     data->set.sockopt_client = va_arg(param, void *);
2143     break;
2144
2145   case CURLOPT_OPENSOCKETFUNCTION:
2146     /*
2147      * open/create socket callback function: called instead of socket(),
2148      * before connect()
2149      */
2150     data->set.fopensocket = va_arg(param, curl_opensocket_callback);
2151     break;
2152
2153   case CURLOPT_OPENSOCKETDATA:
2154     /*
2155      * socket callback data pointer. Might be NULL.
2156      */
2157     data->set.opensocket_client = va_arg(param, void *);
2158     break;
2159
2160   case CURLOPT_CLOSESOCKETFUNCTION:
2161     /*
2162      * close socket callback function: called instead of close()
2163      * when shutting down a connection
2164      */
2165     data->set.fclosesocket = va_arg(param, curl_closesocket_callback);
2166     break;
2167
2168   case CURLOPT_CLOSESOCKETDATA:
2169     /*
2170      * socket callback data pointer. Might be NULL.
2171      */
2172     data->set.closesocket_client = va_arg(param, void *);
2173     break;
2174
2175   case CURLOPT_SSL_SESSIONID_CACHE:
2176     data->set.ssl.sessionid = (0 != va_arg(param, long))?TRUE:FALSE;
2177     break;
2178
2179 #ifdef USE_LIBSSH2
2180     /* we only include SSH options if explicitly built to support SSH */
2181   case CURLOPT_SSH_AUTH_TYPES:
2182     data->set.ssh_auth_types = va_arg(param, long);
2183     break;
2184
2185   case CURLOPT_SSH_PUBLIC_KEYFILE:
2186     /*
2187      * Use this file instead of the $HOME/.ssh/id_dsa.pub file
2188      */
2189     result = setstropt(&data->set.str[STRING_SSH_PUBLIC_KEY],
2190                        va_arg(param, char *));
2191     break;
2192
2193   case CURLOPT_SSH_PRIVATE_KEYFILE:
2194     /*
2195      * Use this file instead of the $HOME/.ssh/id_dsa file
2196      */
2197     result = setstropt(&data->set.str[STRING_SSH_PRIVATE_KEY],
2198                        va_arg(param, char *));
2199     break;
2200   case CURLOPT_SSH_HOST_PUBLIC_KEY_MD5:
2201     /*
2202      * Option to allow for the MD5 of the host public key to be checked
2203      * for validation purposes.
2204      */
2205     result = setstropt(&data->set.str[STRING_SSH_HOST_PUBLIC_KEY_MD5],
2206                        va_arg(param, char *));
2207     break;
2208 #ifdef HAVE_LIBSSH2_KNOWNHOST_API
2209   case CURLOPT_SSH_KNOWNHOSTS:
2210     /*
2211      * Store the file name to read known hosts from.
2212      */
2213     result = setstropt(&data->set.str[STRING_SSH_KNOWNHOSTS],
2214                        va_arg(param, char *));
2215     break;
2216
2217   case CURLOPT_SSH_KEYFUNCTION:
2218     /* setting to NULL is fine since the ssh.c functions themselves will
2219        then rever to use the internal default */
2220     data->set.ssh_keyfunc = va_arg(param, curl_sshkeycallback);
2221     break;
2222
2223   case CURLOPT_SSH_KEYDATA:
2224     /*
2225      * Custom client data to pass to the SSH keyfunc callback
2226      */
2227     data->set.ssh_keyfunc_userp = va_arg(param, void *);
2228     break;
2229 #endif /* HAVE_LIBSSH2_KNOWNHOST_API */
2230
2231 #endif /* USE_LIBSSH2 */
2232
2233   case CURLOPT_HTTP_TRANSFER_DECODING:
2234     /*
2235      * disable libcurl transfer encoding is used
2236      */
2237     data->set.http_te_skip = (0 == va_arg(param, long))?TRUE:FALSE;
2238     break;
2239
2240   case CURLOPT_HTTP_CONTENT_DECODING:
2241     /*
2242      * raw data passed to the application when content encoding is used
2243      */
2244     data->set.http_ce_skip = (0 == va_arg(param, long))?TRUE:FALSE;
2245     break;
2246
2247   case CURLOPT_NEW_FILE_PERMS:
2248     /*
2249      * Uses these permissions instead of 0644
2250      */
2251     data->set.new_file_perms = va_arg(param, long);
2252     break;
2253
2254   case CURLOPT_NEW_DIRECTORY_PERMS:
2255     /*
2256      * Uses these permissions instead of 0755
2257      */
2258     data->set.new_directory_perms = va_arg(param, long);
2259     break;
2260
2261   case CURLOPT_ADDRESS_SCOPE:
2262     /*
2263      * We always get longs when passed plain numericals, but for this value we
2264      * know that an unsigned int will always hold the value so we blindly
2265      * typecast to this type
2266      */
2267     data->set.scope = curlx_sltoui(va_arg(param, long));
2268     break;
2269
2270   case CURLOPT_PROTOCOLS:
2271     /* set the bitmask for the protocols that are allowed to be used for the
2272        transfer, which thus helps the app which takes URLs from users or other
2273        external inputs and want to restrict what protocol(s) to deal
2274        with. Defaults to CURLPROTO_ALL. */
2275     data->set.allowed_protocols = va_arg(param, long);
2276     break;
2277
2278   case CURLOPT_REDIR_PROTOCOLS:
2279     /* set the bitmask for the protocols that libcurl is allowed to follow to,
2280        as a subset of the CURLOPT_PROTOCOLS ones. That means the protocol needs
2281        to be set in both bitmasks to be allowed to get redirected to. Defaults
2282        to all protocols except FILE and SCP. */
2283     data->set.redir_protocols = va_arg(param, long);
2284     break;
2285
2286   case CURLOPT_MAIL_FROM:
2287     /* Set the SMTP mail originator */
2288     result = setstropt(&data->set.str[STRING_MAIL_FROM],
2289                        va_arg(param, char *));
2290     break;
2291
2292   case CURLOPT_MAIL_AUTH:
2293     /* Set the SMTP auth originator */
2294     result = setstropt(&data->set.str[STRING_MAIL_AUTH],
2295                        va_arg(param, char *));
2296     break;
2297
2298   case CURLOPT_MAIL_RCPT:
2299     /* Set the list of mail recipients */
2300     data->set.mail_rcpt = va_arg(param, struct curl_slist *);
2301     break;
2302
2303   case CURLOPT_SASL_IR:
2304     /* Enable/disable SASL initial response */
2305     data->set.sasl_ir = (0 != va_arg(param, long)) ? TRUE : FALSE;
2306     break;
2307
2308   case CURLOPT_RTSP_REQUEST:
2309     {
2310       /*
2311        * Set the RTSP request method (OPTIONS, SETUP, PLAY, etc...)
2312        * Would this be better if the RTSPREQ_* were just moved into here?
2313        */
2314       long curl_rtspreq = va_arg(param, long);
2315       Curl_RtspReq rtspreq = RTSPREQ_NONE;
2316       switch(curl_rtspreq) {
2317         case CURL_RTSPREQ_OPTIONS:
2318           rtspreq = RTSPREQ_OPTIONS;
2319           break;
2320
2321         case CURL_RTSPREQ_DESCRIBE:
2322           rtspreq = RTSPREQ_DESCRIBE;
2323           break;
2324
2325         case CURL_RTSPREQ_ANNOUNCE:
2326           rtspreq = RTSPREQ_ANNOUNCE;
2327           break;
2328
2329         case CURL_RTSPREQ_SETUP:
2330           rtspreq = RTSPREQ_SETUP;
2331           break;
2332
2333         case CURL_RTSPREQ_PLAY:
2334           rtspreq = RTSPREQ_PLAY;
2335           break;
2336
2337         case CURL_RTSPREQ_PAUSE:
2338           rtspreq = RTSPREQ_PAUSE;
2339           break;
2340
2341         case CURL_RTSPREQ_TEARDOWN:
2342           rtspreq = RTSPREQ_TEARDOWN;
2343           break;
2344
2345         case CURL_RTSPREQ_GET_PARAMETER:
2346           rtspreq = RTSPREQ_GET_PARAMETER;
2347           break;
2348
2349         case CURL_RTSPREQ_SET_PARAMETER:
2350           rtspreq = RTSPREQ_SET_PARAMETER;
2351           break;
2352
2353         case CURL_RTSPREQ_RECORD:
2354           rtspreq = RTSPREQ_RECORD;
2355           break;
2356
2357         case CURL_RTSPREQ_RECEIVE:
2358           rtspreq = RTSPREQ_RECEIVE;
2359           break;
2360         default:
2361           rtspreq = RTSPREQ_NONE;
2362       }
2363
2364       data->set.rtspreq = rtspreq;
2365     break;
2366     }
2367
2368
2369   case CURLOPT_RTSP_SESSION_ID:
2370     /*
2371      * Set the RTSP Session ID manually. Useful if the application is
2372      * resuming a previously established RTSP session
2373      */
2374     result = setstropt(&data->set.str[STRING_RTSP_SESSION_ID],
2375                        va_arg(param, char *));
2376     break;
2377
2378   case CURLOPT_RTSP_STREAM_URI:
2379     /*
2380      * Set the Stream URI for the RTSP request. Unless the request is
2381      * for generic server options, the application will need to set this.
2382      */
2383     result = setstropt(&data->set.str[STRING_RTSP_STREAM_URI],
2384                        va_arg(param, char *));
2385     break;
2386
2387   case CURLOPT_RTSP_TRANSPORT:
2388     /*
2389      * The content of the Transport: header for the RTSP request
2390      */
2391     result = setstropt(&data->set.str[STRING_RTSP_TRANSPORT],
2392                        va_arg(param, char *));
2393     break;
2394
2395   case CURLOPT_RTSP_CLIENT_CSEQ:
2396     /*
2397      * Set the CSEQ number to issue for the next RTSP request. Useful if the
2398      * application is resuming a previously broken connection. The CSEQ
2399      * will increment from this new number henceforth.
2400      */
2401     data->state.rtsp_next_client_CSeq = va_arg(param, long);
2402     break;
2403
2404   case CURLOPT_RTSP_SERVER_CSEQ:
2405     /* Same as the above, but for server-initiated requests */
2406     data->state.rtsp_next_client_CSeq = va_arg(param, long);
2407     break;
2408
2409   case CURLOPT_INTERLEAVEDATA:
2410     data->set.rtp_out = va_arg(param, void *);
2411     break;
2412   case CURLOPT_INTERLEAVEFUNCTION:
2413     /* Set the user defined RTP write function */
2414     data->set.fwrite_rtp = va_arg(param, curl_write_callback);
2415     break;
2416
2417   case CURLOPT_WILDCARDMATCH:
2418     data->set.wildcardmatch = (0 != va_arg(param, long))?TRUE:FALSE;
2419     break;
2420   case CURLOPT_CHUNK_BGN_FUNCTION:
2421     data->set.chunk_bgn = va_arg(param, curl_chunk_bgn_callback);
2422     break;
2423   case CURLOPT_CHUNK_END_FUNCTION:
2424     data->set.chunk_end = va_arg(param, curl_chunk_end_callback);
2425     break;
2426   case CURLOPT_FNMATCH_FUNCTION:
2427     data->set.fnmatch = va_arg(param, curl_fnmatch_callback);
2428     break;
2429   case CURLOPT_CHUNK_DATA:
2430     data->wildcard.customptr = va_arg(param, void *);
2431     break;
2432   case CURLOPT_FNMATCH_DATA:
2433     data->set.fnmatch_data = va_arg(param, void *);
2434     break;
2435 #ifdef USE_TLS_SRP
2436   case CURLOPT_TLSAUTH_USERNAME:
2437     result = setstropt(&data->set.str[STRING_TLSAUTH_USERNAME],
2438                        va_arg(param, char *));
2439     if(data->set.str[STRING_TLSAUTH_USERNAME] && !data->set.ssl.authtype)
2440       data->set.ssl.authtype = CURL_TLSAUTH_SRP; /* default to SRP */
2441     break;
2442   case CURLOPT_TLSAUTH_PASSWORD:
2443     result = setstropt(&data->set.str[STRING_TLSAUTH_PASSWORD],
2444                        va_arg(param, char *));
2445     if(data->set.str[STRING_TLSAUTH_USERNAME] && !data->set.ssl.authtype)
2446       data->set.ssl.authtype = CURL_TLSAUTH_SRP; /* default to SRP */
2447     break;
2448   case CURLOPT_TLSAUTH_TYPE:
2449     if(strnequal((char *)va_arg(param, char *), "SRP", strlen("SRP")))
2450       data->set.ssl.authtype = CURL_TLSAUTH_SRP;
2451     else
2452       data->set.ssl.authtype = CURL_TLSAUTH_NONE;
2453     break;
2454 #endif
2455   case CURLOPT_DNS_SERVERS:
2456     result = Curl_set_dns_servers(data, va_arg(param, char *));
2457     break;
2458
2459   case CURLOPT_TCP_KEEPALIVE:
2460     data->set.tcp_keepalive = (0 != va_arg(param, long))?TRUE:FALSE;
2461     break;
2462   case CURLOPT_TCP_KEEPIDLE:
2463     data->set.tcp_keepidle = va_arg(param, long);
2464     break;
2465   case CURLOPT_TCP_KEEPINTVL:
2466     data->set.tcp_keepintvl = va_arg(param, long);
2467     break;
2468
2469   default:
2470     /* unknown tag and its companion, just ignore: */
2471     result = CURLE_UNKNOWN_OPTION;
2472     break;
2473   }
2474
2475   return result;
2476 }
2477
2478 static void conn_free(struct connectdata *conn)
2479 {
2480   if(!conn)
2481     return;
2482
2483   /* possible left-overs from the async name resolvers */
2484   Curl_resolver_cancel(conn);
2485
2486   /* close the SSL stuff before we close any sockets since they will/may
2487      write to the sockets */
2488   Curl_ssl_close(conn, FIRSTSOCKET);
2489   Curl_ssl_close(conn, SECONDARYSOCKET);
2490
2491   /* close possibly still open sockets */
2492   if(CURL_SOCKET_BAD != conn->sock[SECONDARYSOCKET])
2493     Curl_closesocket(conn, conn->sock[SECONDARYSOCKET]);
2494   if(CURL_SOCKET_BAD != conn->sock[FIRSTSOCKET])
2495     Curl_closesocket(conn, conn->sock[FIRSTSOCKET]);
2496
2497 #if defined(USE_NTLM) && defined(NTLM_WB_ENABLED)
2498   Curl_ntlm_wb_cleanup(conn);
2499 #endif
2500
2501   Curl_safefree(conn->user);
2502   Curl_safefree(conn->passwd);
2503   Curl_safefree(conn->xoauth2_bearer);
2504   Curl_safefree(conn->options);
2505   Curl_safefree(conn->proxyuser);
2506   Curl_safefree(conn->proxypasswd);
2507   Curl_safefree(conn->allocptr.proxyuserpwd);
2508   Curl_safefree(conn->allocptr.uagent);
2509   Curl_safefree(conn->allocptr.userpwd);
2510   Curl_safefree(conn->allocptr.accept_encoding);
2511   Curl_safefree(conn->allocptr.te);
2512   Curl_safefree(conn->allocptr.rangeline);
2513   Curl_safefree(conn->allocptr.ref);
2514   Curl_safefree(conn->allocptr.host);
2515   Curl_safefree(conn->allocptr.cookiehost);
2516   Curl_safefree(conn->allocptr.rtsp_transport);
2517   Curl_safefree(conn->trailer);
2518   Curl_safefree(conn->host.rawalloc); /* host name buffer */
2519   Curl_safefree(conn->proxy.rawalloc); /* proxy name buffer */
2520   Curl_safefree(conn->master_buffer);
2521
2522   Curl_llist_destroy(conn->send_pipe, NULL);
2523   Curl_llist_destroy(conn->recv_pipe, NULL);
2524
2525   conn->send_pipe = NULL;
2526   conn->recv_pipe = NULL;
2527
2528   Curl_safefree(conn->localdev);
2529   Curl_free_ssl_config(&conn->ssl_config);
2530
2531   free(conn); /* free all the connection oriented data */
2532 }
2533
2534 CURLcode Curl_disconnect(struct connectdata *conn, bool dead_connection)
2535 {
2536   struct SessionHandle *data;
2537   if(!conn)
2538     return CURLE_OK; /* this is closed and fine already */
2539   data = conn->data;
2540
2541   if(!data) {
2542     DEBUGF(fprintf(stderr, "DISCONNECT without easy handle, ignoring\n"));
2543     return CURLE_OK;
2544   }
2545
2546   if(conn->dns_entry != NULL) {
2547     Curl_resolv_unlock(data, conn->dns_entry);
2548     conn->dns_entry = NULL;
2549   }
2550
2551   Curl_hostcache_prune(data); /* kill old DNS cache entries */
2552
2553   {
2554     int has_host_ntlm = (conn->ntlm.state != NTLMSTATE_NONE);
2555     int has_proxy_ntlm = (conn->proxyntlm.state != NTLMSTATE_NONE);
2556
2557     /* Authentication data is a mix of connection-related and sessionhandle-
2558        related stuff. NTLM is connection-related so when we close the shop
2559        we shall forget. */
2560
2561     if(has_host_ntlm) {
2562       data->state.authhost.done = FALSE;
2563       data->state.authhost.picked =
2564         data->state.authhost.want;
2565     }
2566
2567     if(has_proxy_ntlm) {
2568       data->state.authproxy.done = FALSE;
2569       data->state.authproxy.picked =
2570         data->state.authproxy.want;
2571     }
2572
2573     if(has_host_ntlm || has_proxy_ntlm)
2574       data->state.authproblem = FALSE;
2575   }
2576
2577   /* Cleanup NTLM connection-related data */
2578   Curl_http_ntlm_cleanup(conn);
2579
2580   /* Cleanup possible redirect junk */
2581   if(data->req.newurl) {
2582     free(data->req.newurl);
2583     data->req.newurl = NULL;
2584   }
2585
2586   if(conn->handler->disconnect)
2587     /* This is set if protocol-specific cleanups should be made */
2588     conn->handler->disconnect(conn, dead_connection);
2589
2590     /* unlink ourselves! */
2591   infof(data, "Closing connection %ld\n", conn->connection_id);
2592   Curl_conncache_remove_conn(data->state.conn_cache, conn);
2593
2594 #if defined(USE_LIBIDN)
2595   if(conn->host.encalloc)
2596     idn_free(conn->host.encalloc); /* encoded host name buffer, must be freed
2597                                       with idn_free() since this was allocated
2598                                       by libidn */
2599   if(conn->proxy.encalloc)
2600     idn_free(conn->proxy.encalloc); /* encoded proxy name buffer, must be
2601                                        freed with idn_free() since this was
2602                                        allocated by libidn */
2603 #elif defined(USE_WIN32_IDN)
2604   free(conn->host.encalloc); /* encoded host name buffer, must be freed with
2605                                 idn_free() since this was allocated by
2606                                 curl_win32_idn_to_ascii */
2607   if(conn->proxy.encalloc)
2608     free(conn->proxy.encalloc); /* encoded proxy name buffer, must be freed
2609                                    with idn_free() since this was allocated by
2610                                    curl_win32_idn_to_ascii */
2611 #endif
2612
2613   Curl_ssl_close(conn, FIRSTSOCKET);
2614
2615   /* Indicate to all handles on the pipe that we're dead */
2616   if(Curl_multi_pipeline_enabled(data->multi)) {
2617     signalPipeClose(conn->send_pipe, TRUE);
2618     signalPipeClose(conn->recv_pipe, TRUE);
2619   }
2620
2621   conn_free(conn);
2622
2623   Curl_speedinit(data);
2624
2625   return CURLE_OK;
2626 }
2627
2628 /*
2629  * This function should return TRUE if the socket is to be assumed to
2630  * be dead. Most commonly this happens when the server has closed the
2631  * connection due to inactivity.
2632  */
2633 static bool SocketIsDead(curl_socket_t sock)
2634 {
2635   int sval;
2636   bool ret_val = TRUE;
2637
2638   sval = Curl_socket_ready(sock, CURL_SOCKET_BAD, 0);
2639   if(sval == 0)
2640     /* timeout */
2641     ret_val = FALSE;
2642
2643   return ret_val;
2644 }
2645
2646 static bool IsPipeliningPossible(const struct SessionHandle *handle,
2647                                  const struct connectdata *conn)
2648 {
2649   if((conn->handler->protocol & CURLPROTO_HTTP) &&
2650      Curl_multi_pipeline_enabled(handle->multi) &&
2651      (handle->set.httpreq == HTTPREQ_GET ||
2652       handle->set.httpreq == HTTPREQ_HEAD) &&
2653      handle->set.httpversion != CURL_HTTP_VERSION_1_0)
2654     return TRUE;
2655
2656   return FALSE;
2657 }
2658
2659 bool Curl_isPipeliningEnabled(const struct SessionHandle *handle)
2660 {
2661   return Curl_multi_pipeline_enabled(handle->multi);
2662 }
2663
2664 CURLcode Curl_addHandleToPipeline(struct SessionHandle *data,
2665                                   struct curl_llist *pipeline)
2666 {
2667   if(!Curl_llist_insert_next(pipeline, pipeline->tail, data))
2668     return CURLE_OUT_OF_MEMORY;
2669   infof(data, "Curl_addHandleToPipeline: length: %d\n", pipeline->size);
2670   return CURLE_OK;
2671 }
2672
2673 int Curl_removeHandleFromPipeline(struct SessionHandle *handle,
2674                                   struct curl_llist *pipeline)
2675 {
2676   struct curl_llist_element *curr;
2677
2678   curr = pipeline->head;
2679   while(curr) {
2680     if(curr->ptr == handle) {
2681       Curl_llist_remove(pipeline, curr, NULL);
2682       return 1; /* we removed a handle */
2683     }
2684     curr = curr->next;
2685   }
2686
2687   return 0;
2688 }
2689
2690 #if 0 /* this code is saved here as it is useful for debugging purposes */
2691 static void Curl_printPipeline(struct curl_llist *pipeline)
2692 {
2693   struct curl_llist_element *curr;
2694
2695   curr = pipeline->head;
2696   while(curr) {
2697     struct SessionHandle *data = (struct SessionHandle *) curr->ptr;
2698     infof(data, "Handle in pipeline: %s\n", data->state.path);
2699     curr = curr->next;
2700   }
2701 }
2702 #endif
2703
2704 static struct SessionHandle* gethandleathead(struct curl_llist *pipeline)
2705 {
2706   struct curl_llist_element *curr = pipeline->head;
2707   if(curr) {
2708     return (struct SessionHandle *) curr->ptr;
2709   }
2710
2711   return NULL;
2712 }
2713
2714 /* remove the specified connection from all (possible) pipelines and related
2715    queues */
2716 void Curl_getoff_all_pipelines(struct SessionHandle *data,
2717                                struct connectdata *conn)
2718 {
2719   bool recv_head = (conn->readchannel_inuse &&
2720     (gethandleathead(conn->recv_pipe) == data)) ? TRUE : FALSE;
2721
2722   bool send_head = (conn->writechannel_inuse &&
2723     (gethandleathead(conn->send_pipe) == data)) ? TRUE : FALSE;
2724
2725   if(Curl_removeHandleFromPipeline(data, conn->recv_pipe) && recv_head)
2726     conn->readchannel_inuse = FALSE;
2727   if(Curl_removeHandleFromPipeline(data, conn->send_pipe) && send_head)
2728     conn->writechannel_inuse = FALSE;
2729 }
2730
2731 static void signalPipeClose(struct curl_llist *pipeline, bool pipe_broke)
2732 {
2733   struct curl_llist_element *curr;
2734
2735   if(!pipeline)
2736     return;
2737
2738   curr = pipeline->head;
2739   while(curr) {
2740     struct curl_llist_element *next = curr->next;
2741     struct SessionHandle *data = (struct SessionHandle *) curr->ptr;
2742
2743 #ifdef DEBUGBUILD /* debug-only code */
2744     if(data->magic != CURLEASY_MAGIC_NUMBER) {
2745       /* MAJOR BADNESS */
2746       infof(data, "signalPipeClose() found BAAD easy handle\n");
2747     }
2748 #endif
2749
2750     if(pipe_broke)
2751       data->state.pipe_broke = TRUE;
2752     Curl_multi_handlePipeBreak(data);
2753     Curl_llist_remove(pipeline, curr, NULL);
2754     curr = next;
2755   }
2756 }
2757
2758 /*
2759  * This function finds the connection in the connection
2760  * cache that has been unused for the longest time.
2761  *
2762  * Returns the pointer to the oldest idle connection, or NULL if none was
2763  * found.
2764  */
2765 static struct connectdata *
2766 find_oldest_idle_connection(struct SessionHandle *data)
2767 {
2768   struct conncache *bc = data->state.conn_cache;
2769   struct curl_hash_iterator iter;
2770   struct curl_llist_element *curr;
2771   struct curl_hash_element *he;
2772   long highscore=-1;
2773   long score;
2774   struct timeval now;
2775   struct connectdata *conn_candidate = NULL;
2776   struct connectbundle *bundle;
2777
2778   now = Curl_tvnow();
2779
2780   Curl_hash_start_iterate(bc->hash, &iter);
2781
2782   he = Curl_hash_next_element(&iter);
2783   while(he) {
2784     struct connectdata *conn;
2785
2786     bundle = he->ptr;
2787
2788     curr = bundle->conn_list->head;
2789     while(curr) {
2790       conn = curr->ptr;
2791
2792       if(!conn->inuse) {
2793         /* Set higher score for the age passed since the connection was used */
2794         score = Curl_tvdiff(now, conn->now);
2795
2796         if(score > highscore) {
2797           highscore = score;
2798           conn_candidate = conn;
2799         }
2800       }
2801       curr = curr->next;
2802     }
2803
2804     he = Curl_hash_next_element(&iter);
2805   }
2806
2807   return conn_candidate;
2808 }
2809
2810 /*
2811  * This function finds the connection in the connection
2812  * bundle that has been unused for the longest time.
2813  *
2814  * Returns the pointer to the oldest idle connection, or NULL if none was
2815  * found.
2816  */
2817 static struct connectdata *
2818 find_oldest_idle_connection_in_bundle(struct SessionHandle *data,
2819                                       struct connectbundle *bundle)
2820 {
2821   struct curl_llist_element *curr;
2822   long highscore=-1;
2823   long score;
2824   struct timeval now;
2825   struct connectdata *conn_candidate = NULL;
2826   struct connectdata *conn;
2827
2828   (void)data;
2829
2830   now = Curl_tvnow();
2831
2832   curr = bundle->conn_list->head;
2833   while(curr) {
2834     conn = curr->ptr;
2835
2836     if(!conn->inuse) {
2837       /* Set higher score for the age passed since the connection was used */
2838       score = Curl_tvdiff(now, conn->now);
2839
2840       if(score > highscore) {
2841         highscore = score;
2842         conn_candidate = conn;
2843       }
2844     }
2845     curr = curr->next;
2846   }
2847
2848   return conn_candidate;
2849 }
2850
2851 /*
2852  * Given one filled in connection struct (named needle), this function should
2853  * detect if there already is one that has all the significant details
2854  * exactly the same and thus should be used instead.
2855  *
2856  * If there is a match, this function returns TRUE - and has marked the
2857  * connection as 'in-use'. It must later be called with ConnectionDone() to
2858  * return back to 'idle' (unused) state.
2859  *
2860  * The force_reuse flag is set if the connection must be used, even if
2861  * the pipelining strategy wants to open a new connection instead of reusing.
2862  */
2863 static bool
2864 ConnectionExists(struct SessionHandle *data,
2865                  struct connectdata *needle,
2866                  struct connectdata **usethis,
2867                  bool *force_reuse)
2868 {
2869   struct connectdata *check;
2870   struct connectdata *chosen = 0;
2871   bool canPipeline = IsPipeliningPossible(data, needle);
2872   bool wantNTLM = (data->state.authhost.want==CURLAUTH_NTLM) ||
2873                   (data->state.authhost.want==CURLAUTH_NTLM_WB) ? TRUE : FALSE;
2874   struct connectbundle *bundle;
2875
2876   *force_reuse = FALSE;
2877
2878   /* We can't pipe if the site is blacklisted */
2879   if(canPipeline && Curl_pipeline_site_blacklisted(data, needle)) {
2880     canPipeline = FALSE;
2881   }
2882
2883   /* Look up the bundle with all the connections to this
2884      particular host */
2885   bundle = Curl_conncache_find_bundle(data->state.conn_cache,
2886                                       needle->host.name);
2887   if(bundle) {
2888     size_t max_pipe_len = Curl_multi_max_pipeline_length(data->multi);
2889     size_t best_pipe_len = max_pipe_len;
2890     struct curl_llist_element *curr;
2891
2892     infof(data, "Found bundle for host %s: %p\n",
2893           needle->host.name, (void *)bundle);
2894
2895     /* We can't pipe if we don't know anything about the server */
2896     if(canPipeline && !bundle->server_supports_pipelining) {
2897       infof(data, "Server doesn't support pipelining\n");
2898       canPipeline = FALSE;
2899     }
2900
2901     curr = bundle->conn_list->head;
2902     while(curr) {
2903       bool match = FALSE;
2904       bool credentialsMatch = FALSE;
2905       size_t pipeLen;
2906
2907       /*
2908        * Note that if we use a HTTP proxy, we check connections to that
2909        * proxy and not to the actual remote server.
2910        */
2911       check = curr->ptr;
2912       curr = curr->next;
2913
2914       pipeLen = check->send_pipe->size + check->recv_pipe->size;
2915
2916       if(!pipeLen && !check->inuse) {
2917         /* The check for a dead socket makes sense only if there are no
2918            handles in pipeline and the connection isn't already marked in
2919            use */
2920         bool dead;
2921         if(check->handler->protocol & CURLPROTO_RTSP)
2922           /* RTSP is a special case due to RTP interleaving */
2923           dead = Curl_rtsp_connisdead(check);
2924         else
2925           dead = SocketIsDead(check->sock[FIRSTSOCKET]);
2926
2927         if(dead) {
2928           check->data = data;
2929           infof(data, "Connection %ld seems to be dead!\n",
2930                 check->connection_id);
2931
2932           /* disconnect resources */
2933           Curl_disconnect(check, /* dead_connection */ TRUE);
2934           continue;
2935         }
2936       }
2937
2938       if(canPipeline) {
2939         /* Make sure the pipe has only GET requests */
2940         struct SessionHandle* sh = gethandleathead(check->send_pipe);
2941         struct SessionHandle* rh = gethandleathead(check->recv_pipe);
2942         if(sh) {
2943           if(!IsPipeliningPossible(sh, check))
2944             continue;
2945         }
2946         else if(rh) {
2947           if(!IsPipeliningPossible(rh, check))
2948             continue;
2949         }
2950       }
2951       else {
2952         if(pipeLen > 0) {
2953           /* can only happen within multi handles, and means that another easy
2954              handle is using this connection */
2955           continue;
2956         }
2957
2958         if(Curl_resolver_asynch()) {
2959           /* ip_addr_str[0] is NUL only if the resolving of the name hasn't
2960              completed yet and until then we don't re-use this connection */
2961           if(!check->ip_addr_str[0]) {
2962             infof(data,
2963                   "Connection #%ld is still name resolving, can't reuse\n",
2964                   check->connection_id);
2965             continue;
2966           }
2967         }
2968
2969         if((check->sock[FIRSTSOCKET] == CURL_SOCKET_BAD) ||
2970            check->bits.close) {
2971           /* Don't pick a connection that hasn't connected yet or that is going
2972              to get closed. */
2973           infof(data, "Connection #%ld isn't open enough, can't reuse\n",
2974                 check->connection_id);
2975 #ifdef DEBUGBUILD
2976           if(check->recv_pipe->size > 0) {
2977             infof(data,
2978                   "BAD! Unconnected #%ld has a non-empty recv pipeline!\n",
2979                   check->connection_id);
2980           }
2981 #endif
2982           continue;
2983         }
2984       }
2985
2986       if((needle->handler->flags&PROTOPT_SSL) !=
2987          (check->handler->flags&PROTOPT_SSL))
2988         /* don't do mixed SSL and non-SSL connections */
2989         if(!(needle->handler->protocol & check->handler->protocol))
2990           /* except protocols that have been upgraded via TLS */
2991           continue;
2992
2993       if(needle->handler->flags&PROTOPT_SSL) {
2994         if((data->set.ssl.verifypeer != check->verifypeer) ||
2995            (data->set.ssl.verifyhost != check->verifyhost))
2996           continue;
2997       }
2998
2999       if(needle->bits.proxy != check->bits.proxy)
3000         /* don't do mixed proxy and non-proxy connections */
3001         continue;
3002
3003       if(!canPipeline && check->inuse)
3004         /* this request can't be pipelined but the checked connection is
3005            already in use so we skip it */
3006         continue;
3007
3008       if(needle->localdev || needle->localport) {
3009         /* If we are bound to a specific local end (IP+port), we must not
3010            re-use a random other one, although if we didn't ask for a
3011            particular one we can reuse one that was bound.
3012
3013            This comparison is a bit rough and too strict. Since the input
3014            parameters can be specified in numerous ways and still end up the
3015            same it would take a lot of processing to make it really accurate.
3016            Instead, this matching will assume that re-uses of bound connections
3017            will most likely also re-use the exact same binding parameters and
3018            missing out a few edge cases shouldn't hurt anyone very much.
3019         */
3020         if((check->localport != needle->localport) ||
3021            (check->localportrange != needle->localportrange) ||
3022            !check->localdev ||
3023            !needle->localdev ||
3024            strcmp(check->localdev, needle->localdev))
3025           continue;
3026       }
3027
3028       if((needle->handler->protocol & CURLPROTO_FTP) ||
3029          ((needle->handler->protocol & CURLPROTO_HTTP) && wantNTLM)) {
3030          /* This is FTP or HTTP+NTLM, verify that we're using the same name
3031             and password as well */
3032          if(!strequal(needle->user, check->user) ||
3033             !strequal(needle->passwd, check->passwd)) {
3034             /* one of them was different */
3035             continue;
3036          }
3037          credentialsMatch = TRUE;
3038       }
3039
3040       if(!needle->bits.httpproxy || needle->handler->flags&PROTOPT_SSL ||
3041          (needle->bits.httpproxy && check->bits.httpproxy &&
3042           needle->bits.tunnel_proxy && check->bits.tunnel_proxy &&
3043           Curl_raw_equal(needle->proxy.name, check->proxy.name) &&
3044           (needle->port == check->port))) {
3045         /* The requested connection does not use a HTTP proxy or it uses SSL or
3046            it is a non-SSL protocol tunneled over the same http proxy name and
3047            port number or it is a non-SSL protocol which is allowed to be
3048            upgraded via TLS */
3049
3050         if((Curl_raw_equal(needle->handler->scheme, check->handler->scheme) ||
3051             needle->handler->protocol & check->handler->protocol) &&
3052            Curl_raw_equal(needle->host.name, check->host.name) &&
3053            needle->remote_port == check->remote_port) {
3054           if(needle->handler->flags & PROTOPT_SSL) {
3055             /* This is a SSL connection so verify that we're using the same
3056                SSL options as well */
3057             if(!Curl_ssl_config_matches(&needle->ssl_config,
3058                                         &check->ssl_config)) {
3059               DEBUGF(infof(data,
3060                            "Connection #%ld has different SSL parameters, "
3061                            "can't reuse\n",
3062                            check->connection_id));
3063               continue;
3064             }
3065             else if(check->ssl[FIRSTSOCKET].state != ssl_connection_complete) {
3066               DEBUGF(infof(data,
3067                            "Connection #%ld has not started SSL connect, "
3068                            "can't reuse\n",
3069                            check->connection_id));
3070               continue;
3071             }
3072           }
3073           match = TRUE;
3074         }
3075       }
3076       else { /* The requested needle connection is using a proxy,
3077                 is the checked one using the same host, port and type? */
3078         if(check->bits.proxy &&
3079            (needle->proxytype == check->proxytype) &&
3080            (needle->bits.tunnel_proxy == check->bits.tunnel_proxy) &&
3081            Curl_raw_equal(needle->proxy.name, check->proxy.name) &&
3082            needle->port == check->port) {
3083           /* This is the same proxy connection, use it! */
3084           match = TRUE;
3085         }
3086       }
3087
3088       if(match) {
3089         /* If we are looking for an NTLM connection, check if this is already
3090            authenticating with the right credentials. If not, keep looking so
3091            that we can reuse NTLM connections if possible. (Especially we
3092            must not reuse the same connection if partway through
3093            a handshake!) */
3094         if(wantNTLM) {
3095           if(credentialsMatch && check->ntlm.state != NTLMSTATE_NONE) {
3096             chosen = check;
3097
3098             /* We must use this connection, no other */
3099             *force_reuse = TRUE;
3100             break;
3101           }
3102           else
3103             continue;
3104         }
3105
3106         if(canPipeline) {
3107           /* We can pipeline if we want to. Let's continue looking for
3108              the optimal connection to use, i.e the shortest pipe that is not
3109              blacklisted. */
3110
3111           if(pipeLen == 0) {
3112             /* We have the optimal connection. Let's stop looking. */
3113             chosen = check;
3114             break;
3115           }
3116
3117           /* We can't use the connection if the pipe is full */
3118           if(pipeLen >= max_pipe_len)
3119             continue;
3120
3121           /* We can't use the connection if the pipe is penalized */
3122           if(Curl_pipeline_penalized(data, check))
3123             continue;
3124
3125           if(pipeLen < best_pipe_len) {
3126             /* This connection has a shorter pipe so far. We'll pick this
3127                and continue searching */
3128             chosen = check;
3129             best_pipe_len = pipeLen;
3130             continue;
3131           }
3132         }
3133         else {
3134           /* We have found a connection. Let's stop searching. */
3135           chosen = check;
3136           break;
3137         }
3138       }
3139     }
3140   }
3141
3142   if(chosen) {
3143     *usethis = chosen;
3144     return TRUE; /* yes, we found one to use! */
3145   }
3146
3147   return FALSE; /* no matching connecting exists */
3148 }
3149
3150 /* Mark the connection as 'idle', or close it if the cache is full.
3151    Returns TRUE if the connection is kept, or FALSE if it was closed. */
3152 static bool
3153 ConnectionDone(struct SessionHandle *data, struct connectdata *conn)
3154 {
3155   /* data->multi->maxconnects can be negative, deal with it. */
3156   size_t maxconnects =
3157     (data->multi->maxconnects < 0) ? 0 : data->multi->maxconnects;
3158   struct connectdata *conn_candidate = NULL;
3159
3160   /* Mark the current connection as 'unused' */
3161   conn->inuse = FALSE;
3162
3163   if(maxconnects > 0 &&
3164      data->state.conn_cache->num_connections > maxconnects) {
3165     infof(data, "Connection cache is full, closing the oldest one.\n");
3166
3167     conn_candidate = find_oldest_idle_connection(data);
3168
3169     if(conn_candidate) {
3170       /* Set the connection's owner correctly */
3171       conn_candidate->data = data;
3172
3173       /* the winner gets the honour of being disconnected */
3174       (void)Curl_disconnect(conn_candidate, /* dead_connection */ FALSE);
3175     }
3176   }
3177
3178   return (conn_candidate == conn) ? FALSE : TRUE;
3179 }
3180
3181 /*
3182  * The given input connection struct pointer is to be stored in the connection
3183  * cache. If the cache is already full, least interesting existing connection
3184  * (if any) gets closed.
3185  *
3186  * The given connection should be unique. That must've been checked prior to
3187  * this call.
3188  */
3189 static CURLcode ConnectionStore(struct SessionHandle *data,
3190                                 struct connectdata *conn)
3191 {
3192   static int connection_id_counter = 0;
3193
3194   CURLcode result;
3195
3196   /* Assign a number to the connection for easier tracking in the log
3197      output */
3198   conn->connection_id = connection_id_counter++;
3199
3200   result = Curl_conncache_add_conn(data->state.conn_cache, conn);
3201   if(result != CURLE_OK)
3202     conn->connection_id = -1;
3203
3204   return result;
3205 }
3206
3207 /* after a TCP connection to the proxy has been verified, this function does
3208    the next magic step.
3209
3210    Note: this function's sub-functions call failf()
3211
3212 */
3213 CURLcode Curl_connected_proxy(struct connectdata *conn)
3214 {
3215   if(!conn->bits.proxy)
3216     return CURLE_OK;
3217
3218   switch(conn->proxytype) {
3219 #ifndef CURL_DISABLE_PROXY
3220   case CURLPROXY_SOCKS5:
3221   case CURLPROXY_SOCKS5_HOSTNAME:
3222     return Curl_SOCKS5(conn->proxyuser, conn->proxypasswd,
3223                        conn->host.name, conn->remote_port,
3224                        FIRSTSOCKET, conn);
3225
3226   case CURLPROXY_SOCKS4:
3227     return Curl_SOCKS4(conn->proxyuser, conn->host.name,
3228                        conn->remote_port, FIRSTSOCKET, conn, FALSE);
3229
3230   case CURLPROXY_SOCKS4A:
3231     return Curl_SOCKS4(conn->proxyuser, conn->host.name,
3232                        conn->remote_port, FIRSTSOCKET, conn, TRUE);
3233
3234 #endif /* CURL_DISABLE_PROXY */
3235   case CURLPROXY_HTTP:
3236   case CURLPROXY_HTTP_1_0:
3237     /* do nothing here. handled later. */
3238     break;
3239   default:
3240     break;
3241   } /* switch proxytype */
3242
3243   return CURLE_OK;
3244 }
3245
3246 static CURLcode ConnectPlease(struct SessionHandle *data,
3247                               struct connectdata *conn,
3248                               bool *connected)
3249 {
3250   CURLcode result;
3251   Curl_addrinfo *addr;
3252 #ifndef CURL_DISABLE_VERBOSE_STRINGS
3253   char *hostname = conn->bits.proxy?conn->proxy.name:conn->host.name;
3254
3255   infof(data, "About to connect() to %s%s port %ld (#%ld)\n",
3256         conn->bits.proxy?"proxy ":"",
3257         hostname, conn->port, conn->connection_id);
3258 #else
3259   (void)data;
3260 #endif
3261
3262   /*************************************************************
3263    * Connect to server/proxy
3264    *************************************************************/
3265   result= Curl_connecthost(conn,
3266                            conn->dns_entry,
3267                            &conn->sock[FIRSTSOCKET],
3268                            &addr,
3269                            connected);
3270   if(CURLE_OK == result) {
3271     /* All is cool, we store the current information */
3272     conn->ip_addr = addr;
3273
3274     if(*connected) {
3275       result = Curl_connected_proxy(conn);
3276       if(!result) {
3277         conn->bits.tcpconnect[FIRSTSOCKET] = TRUE;
3278         Curl_pgrsTime(data, TIMER_CONNECT); /* connect done */
3279       }
3280     }
3281   }
3282
3283   if(result)
3284     *connected = FALSE; /* mark it as not connected */
3285
3286   return result;
3287 }
3288
3289 /*
3290  * verboseconnect() displays verbose information after a connect
3291  */
3292 #ifndef CURL_DISABLE_VERBOSE_STRINGS
3293 void Curl_verboseconnect(struct connectdata *conn)
3294 {
3295   if(conn->data->set.verbose)
3296     infof(conn->data, "Connected to %s (%s) port %ld (#%ld)\n",
3297           conn->bits.proxy ? conn->proxy.dispname : conn->host.dispname,
3298           conn->ip_addr_str, conn->port, conn->connection_id);
3299 }
3300 #endif
3301
3302 int Curl_protocol_getsock(struct connectdata *conn,
3303                           curl_socket_t *socks,
3304                           int numsocks)
3305 {
3306   if(conn->handler->proto_getsock)
3307     return conn->handler->proto_getsock(conn, socks, numsocks);
3308   return GETSOCK_BLANK;
3309 }
3310
3311 int Curl_doing_getsock(struct connectdata *conn,
3312                        curl_socket_t *socks,
3313                        int numsocks)
3314 {
3315   if(conn && conn->handler->doing_getsock)
3316     return conn->handler->doing_getsock(conn, socks, numsocks);
3317   return GETSOCK_BLANK;
3318 }
3319
3320 /*
3321  * We are doing protocol-specific connecting and this is being called over and
3322  * over from the multi interface until the connection phase is done on
3323  * protocol layer.
3324  */
3325
3326 CURLcode Curl_protocol_connecting(struct connectdata *conn,
3327                                   bool *done)
3328 {
3329   CURLcode result=CURLE_OK;
3330
3331   if(conn && conn->handler->connecting) {
3332     *done = FALSE;
3333     result = conn->handler->connecting(conn, done);
3334   }
3335   else
3336     *done = TRUE;
3337
3338   return result;
3339 }
3340
3341 /*
3342  * We are DOING this is being called over and over from the multi interface
3343  * until the DOING phase is done on protocol layer.
3344  */
3345
3346 CURLcode Curl_protocol_doing(struct connectdata *conn, bool *done)
3347 {
3348   CURLcode result=CURLE_OK;
3349
3350   if(conn && conn->handler->doing) {
3351     *done = FALSE;
3352     result = conn->handler->doing(conn, done);
3353   }
3354   else
3355     *done = TRUE;
3356
3357   return result;
3358 }
3359
3360 /*
3361  * We have discovered that the TCP connection has been successful, we can now
3362  * proceed with some action.
3363  *
3364  */
3365 CURLcode Curl_protocol_connect(struct connectdata *conn,
3366                                bool *protocol_done)
3367 {
3368   CURLcode result=CURLE_OK;
3369
3370   *protocol_done = FALSE;
3371
3372   if(conn->bits.tcpconnect[FIRSTSOCKET] && conn->bits.protoconnstart) {
3373     /* We already are connected, get back. This may happen when the connect
3374        worked fine in the first call, like when we connect to a local server
3375        or proxy. Note that we don't know if the protocol is actually done.
3376
3377        Unless this protocol doesn't have any protocol-connect callback, as
3378        then we know we're done. */
3379     if(!conn->handler->connecting)
3380       *protocol_done = TRUE;
3381
3382     return CURLE_OK;
3383   }
3384
3385   if(!conn->bits.protoconnstart) {
3386
3387     result = Curl_proxy_connect(conn);
3388     if(result)
3389       return result;
3390
3391     if(conn->bits.tunnel_proxy && conn->bits.httpproxy &&
3392        (conn->tunnel_state[FIRSTSOCKET] != TUNNEL_COMPLETE))
3393       /* when using an HTTP tunnel proxy, await complete tunnel establishment
3394          before proceeding further. Return CURLE_OK so we'll be called again */
3395       return CURLE_OK;
3396
3397     if(conn->handler->connect_it) {
3398       /* is there a protocol-specific connect() procedure? */
3399
3400       /* Call the protocol-specific connect function */
3401       result = conn->handler->connect_it(conn, protocol_done);
3402     }
3403     else
3404       *protocol_done = TRUE;
3405
3406     /* it has started, possibly even completed but that knowledge isn't stored
3407        in this bit! */
3408     if(!result)
3409       conn->bits.protoconnstart = TRUE;
3410   }
3411
3412   return result; /* pass back status */
3413 }
3414
3415 /*
3416  * Helpers for IDNA convertions.
3417  */
3418 static bool is_ASCII_name(const char *hostname)
3419 {
3420   const unsigned char *ch = (const unsigned char*)hostname;
3421
3422   while(*ch) {
3423     if(*ch++ & 0x80)
3424       return FALSE;
3425   }
3426   return TRUE;
3427 }
3428
3429 #ifdef USE_LIBIDN
3430 /*
3431  * Check if characters in hostname is allowed in Top Level Domain.
3432  */
3433 static bool tld_check_name(struct SessionHandle *data,
3434                            const char *ace_hostname)
3435 {
3436   size_t err_pos;
3437   char *uc_name = NULL;
3438   int rc;
3439 #ifndef CURL_DISABLE_VERBOSE_STRINGS
3440   const char *tld_errmsg = "<no msg>";
3441 #else
3442   (void)data;
3443 #endif
3444
3445   /* Convert (and downcase) ACE-name back into locale's character set */
3446   rc = idna_to_unicode_lzlz(ace_hostname, &uc_name, 0);
3447   if(rc != IDNA_SUCCESS)
3448     return FALSE;
3449
3450   rc = tld_check_lz(uc_name, &err_pos, NULL);
3451 #ifndef CURL_DISABLE_VERBOSE_STRINGS
3452 #ifdef HAVE_TLD_STRERROR
3453   if(rc != TLD_SUCCESS)
3454     tld_errmsg = tld_strerror((Tld_rc)rc);
3455 #endif
3456   if(rc == TLD_INVALID)
3457     infof(data, "WARNING: %s; pos %u = `%c'/0x%02X\n",
3458           tld_errmsg, err_pos, uc_name[err_pos],
3459           uc_name[err_pos] & 255);
3460   else if(rc != TLD_SUCCESS)
3461     infof(data, "WARNING: TLD check for %s failed; %s\n",
3462           uc_name, tld_errmsg);
3463 #endif /* CURL_DISABLE_VERBOSE_STRINGS */
3464   if(uc_name)
3465      idn_free(uc_name);
3466   if(rc != TLD_SUCCESS)
3467     return FALSE;
3468
3469   return TRUE;
3470 }
3471 #endif
3472
3473 /*
3474  * Perform any necessary IDN conversion of hostname
3475  */
3476 static void fix_hostname(struct SessionHandle *data,
3477                          struct connectdata *conn, struct hostname *host)
3478 {
3479 #ifndef USE_LIBIDN
3480   (void)data;
3481   (void)conn;
3482 #elif defined(CURL_DISABLE_VERBOSE_STRINGS)
3483   (void)conn;
3484 #endif
3485
3486   /* set the name we use to display the host name */
3487   host->dispname = host->name;
3488   if(!is_ASCII_name(host->name)) {
3489 #ifdef USE_LIBIDN
3490   /*************************************************************
3491    * Check name for non-ASCII and convert hostname to ACE form.
3492    *************************************************************/
3493   if(stringprep_check_version(LIBIDN_REQUIRED_VERSION)) {
3494     char *ace_hostname = NULL;
3495     int rc = idna_to_ascii_lz(host->name, &ace_hostname, 0);
3496     infof (data, "Input domain encoded as `%s'\n",
3497            stringprep_locale_charset ());
3498     if(rc != IDNA_SUCCESS)
3499       infof(data, "Failed to convert %s to ACE; %s\n",
3500             host->name, Curl_idn_strerror(conn,rc));
3501     else {
3502       /* tld_check_name() displays a warning if the host name contains
3503          "illegal" characters for this TLD */
3504       (void)tld_check_name(data, ace_hostname);
3505
3506       host->encalloc = ace_hostname;
3507       /* change the name pointer to point to the encoded hostname */
3508       host->name = host->encalloc;
3509     }
3510   }
3511 #elif defined(USE_WIN32_IDN)
3512   /*************************************************************
3513    * Check name for non-ASCII and convert hostname to ACE form.
3514    *************************************************************/
3515     char *ace_hostname = NULL;
3516     int rc = curl_win32_idn_to_ascii(host->name, &ace_hostname);
3517     if(rc == 0)
3518       infof(data, "Failed to convert %s to ACE;\n",
3519             host->name);
3520     else {
3521       host->encalloc = ace_hostname;
3522       /* change the name pointer to point to the encoded hostname */
3523       host->name = host->encalloc;
3524     }
3525 #else
3526     infof(data, "IDN support not present, can't parse Unicode domains\n");
3527 #endif
3528   }
3529 }
3530
3531 static void llist_dtor(void *user, void *element)
3532 {
3533   (void)user;
3534   (void)element;
3535   /* Do nothing */
3536 }
3537
3538 /*
3539  * Allocate and initialize a new connectdata object.
3540  */
3541 static struct connectdata *allocate_conn(struct SessionHandle *data)
3542 {
3543   struct connectdata *conn = calloc(1, sizeof(struct connectdata));
3544   if(!conn)
3545     return NULL;
3546
3547   conn->handler = &Curl_handler_dummy;  /* Be sure we have a handler defined
3548                                            already from start to avoid NULL
3549                                            situations and checks */
3550
3551   /* and we setup a few fields in case we end up actually using this struct */
3552
3553   conn->sock[FIRSTSOCKET] = CURL_SOCKET_BAD;     /* no file descriptor */
3554   conn->sock[SECONDARYSOCKET] = CURL_SOCKET_BAD; /* no file descriptor */
3555   conn->connection_id = -1;    /* no ID */
3556   conn->port = -1; /* unknown at this point */
3557
3558   /* Default protocol-independent behavior doesn't support persistent
3559      connections, so we set this to force-close. Protocols that support
3560      this need to set this to FALSE in their "curl_do" functions. */
3561   conn->bits.close = TRUE;
3562
3563   /* Store creation time to help future close decision making */
3564   conn->created = Curl_tvnow();
3565
3566   conn->data = data; /* Setup the association between this connection
3567                         and the SessionHandle */
3568
3569   conn->proxytype = data->set.proxytype; /* type */
3570
3571 #ifdef CURL_DISABLE_PROXY
3572
3573   conn->bits.proxy = FALSE;
3574   conn->bits.httpproxy = FALSE;
3575   conn->bits.proxy_user_passwd = FALSE;
3576   conn->bits.tunnel_proxy = FALSE;
3577
3578 #else /* CURL_DISABLE_PROXY */
3579
3580   /* note that these two proxy bits are now just on what looks to be
3581      requested, they may be altered down the road */
3582   conn->bits.proxy = (data->set.str[STRING_PROXY] &&
3583                       *data->set.str[STRING_PROXY])?TRUE:FALSE;
3584   conn->bits.httpproxy = (conn->bits.proxy &&
3585                           (conn->proxytype == CURLPROXY_HTTP ||
3586                            conn->proxytype == CURLPROXY_HTTP_1_0))?TRUE:FALSE;
3587   conn->bits.proxy_user_passwd =
3588     (NULL != data->set.str[STRING_PROXYUSERNAME])?TRUE:FALSE;
3589   conn->bits.tunnel_proxy = data->set.tunnel_thru_httpproxy;
3590
3591 #endif /* CURL_DISABLE_PROXY */
3592
3593   conn->bits.user_passwd = (NULL != data->set.str[STRING_USERNAME])?TRUE:FALSE;
3594   conn->bits.ftp_use_epsv = data->set.ftp_use_epsv;
3595   conn->bits.ftp_use_eprt = data->set.ftp_use_eprt;
3596
3597   conn->verifypeer = data->set.ssl.verifypeer;
3598   conn->verifyhost = data->set.ssl.verifyhost;
3599
3600   conn->ip_version = data->set.ipver;
3601
3602 #if defined(USE_NTLM) && defined(NTLM_WB_ENABLED)
3603   conn->ntlm_auth_hlpr_socket = CURL_SOCKET_BAD;
3604   conn->ntlm_auth_hlpr_pid = 0;
3605   conn->challenge_header = NULL;
3606   conn->response_header = NULL;
3607 #endif
3608
3609   if(Curl_multi_pipeline_enabled(data->multi) &&
3610       !conn->master_buffer) {
3611     /* Allocate master_buffer to be used for pipelining */
3612     conn->master_buffer = calloc(BUFSIZE, sizeof (char));
3613     if(!conn->master_buffer)
3614       goto error;
3615   }
3616
3617   /* Initialize the pipeline lists */
3618   conn->send_pipe = Curl_llist_alloc((curl_llist_dtor) llist_dtor);
3619   conn->recv_pipe = Curl_llist_alloc((curl_llist_dtor) llist_dtor);
3620   if(!conn->send_pipe || !conn->recv_pipe)
3621     goto error;
3622
3623 #ifdef HAVE_GSSAPI
3624   conn->data_prot = PROT_CLEAR;
3625 #endif
3626
3627   /* Store the local bind parameters that will be used for this connection */
3628   if(data->set.str[STRING_DEVICE]) {
3629     conn->localdev = strdup(data->set.str[STRING_DEVICE]);
3630     if(!conn->localdev)
3631       goto error;
3632   }
3633   conn->localportrange = data->set.localportrange;
3634   conn->localport = data->set.localport;
3635
3636   /* the close socket stuff needs to be copied to the connection struct as
3637      it may live on without (this specific) SessionHandle */
3638   conn->fclosesocket = data->set.fclosesocket;
3639   conn->closesocket_client = data->set.closesocket_client;
3640
3641   return conn;
3642   error:
3643
3644   Curl_llist_destroy(conn->send_pipe, NULL);
3645   Curl_llist_destroy(conn->recv_pipe, NULL);
3646
3647   conn->send_pipe = NULL;
3648   conn->recv_pipe = NULL;
3649
3650   Curl_safefree(conn->master_buffer);
3651   Curl_safefree(conn->localdev);
3652   Curl_safefree(conn);
3653   return NULL;
3654 }
3655
3656 static CURLcode findprotocol(struct SessionHandle *data,
3657                              struct connectdata *conn,
3658                              const char *protostr)
3659 {
3660   const struct Curl_handler * const *pp;
3661   const struct Curl_handler *p;
3662
3663   /* Scan protocol handler table and match against 'protostr' to set a few
3664      variables based on the URL. Now that the handler may be changed later
3665      when the protocol specific setup function is called. */
3666   for(pp = protocols; (p = *pp) != NULL; pp++) {
3667     if(Curl_raw_equal(p->scheme, protostr)) {
3668       /* Protocol found in table. Check if allowed */
3669       if(!(data->set.allowed_protocols & p->protocol))
3670         /* nope, get out */
3671         break;
3672
3673       /* it is allowed for "normal" request, now do an extra check if this is
3674          the result of a redirect */
3675       if(data->state.this_is_a_follow &&
3676          !(data->set.redir_protocols & p->protocol))
3677         /* nope, get out */
3678         break;
3679
3680       /* Perform setup complement if some. */
3681       conn->handler = conn->given = p;
3682
3683       /* 'port' and 'remote_port' are set in setup_connection_internals() */
3684       return CURLE_OK;
3685     }
3686   }
3687
3688
3689   /* The protocol was not found in the table, but we don't have to assign it
3690      to anything since it is already assigned to a dummy-struct in the
3691      create_conn() function when the connectdata struct is allocated. */
3692   failf(data, "Protocol %s not supported or disabled in " LIBCURL_NAME,
3693         protostr);
3694
3695   return CURLE_UNSUPPORTED_PROTOCOL;
3696 }
3697
3698 /*
3699  * Parse URL and fill in the relevant members of the connection struct.
3700  */
3701 static CURLcode parseurlandfillconn(struct SessionHandle *data,
3702                                     struct connectdata *conn,
3703                                     bool *prot_missing,
3704                                     char **userp, char **passwdp,
3705                                     char **optionsp)
3706 {
3707   char *at;
3708   char *fragment;
3709   char *path = data->state.path;
3710   char *query;
3711   int rc;
3712   char protobuf[16];
3713   const char *protop;
3714   CURLcode result;
3715   bool rebuild_url = FALSE;
3716
3717   *prot_missing = FALSE;
3718
3719   /*************************************************************
3720    * Parse the URL.
3721    *
3722    * We need to parse the url even when using the proxy, because we will need
3723    * the hostname and port in case we are trying to SSL connect through the
3724    * proxy -- and we don't know if we will need to use SSL until we parse the
3725    * url ...
3726    ************************************************************/
3727   if((2 == sscanf(data->change.url, "%15[^:]:%[^\n]",
3728                   protobuf, path)) &&
3729      Curl_raw_equal(protobuf, "file")) {
3730     if(path[0] == '/' && path[1] == '/') {
3731       /* Allow omitted hostname (e.g. file:/<path>).  This is not strictly
3732        * speaking a valid file: URL by RFC 1738, but treating file:/<path> as
3733        * file://localhost/<path> is similar to how other schemes treat missing
3734        * hostnames.  See RFC 1808. */
3735
3736       /* This cannot be done with strcpy() in a portable manner, since the
3737          memory areas overlap! */
3738       memmove(path, path + 2, strlen(path + 2)+1);
3739     }
3740     /*
3741      * we deal with file://<host>/<path> differently since it supports no
3742      * hostname other than "localhost" and "127.0.0.1", which is unique among
3743      * the URL protocols specified in RFC 1738
3744      */
3745     if(path[0] != '/') {
3746       /* the URL included a host name, we ignore host names in file:// URLs
3747          as the standards don't define what to do with them */
3748       char *ptr=strchr(path, '/');
3749       if(ptr) {
3750         /* there was a slash present
3751
3752            RFC1738 (section 3.1, page 5) says:
3753
3754            The rest of the locator consists of data specific to the scheme,
3755            and is known as the "url-path". It supplies the details of how the
3756            specified resource can be accessed. Note that the "/" between the
3757            host (or port) and the url-path is NOT part of the url-path.
3758
3759            As most agents use file://localhost/foo to get '/foo' although the
3760            slash preceding foo is a separator and not a slash for the path,
3761            a URL as file://localhost//foo must be valid as well, to refer to
3762            the same file with an absolute path.
3763         */
3764
3765         if(ptr[1] && ('/' == ptr[1]))
3766           /* if there was two slashes, we skip the first one as that is then
3767              used truly as a separator */
3768           ptr++;
3769
3770         /* This cannot be made with strcpy, as the memory chunks overlap! */
3771         memmove(path, ptr, strlen(ptr)+1);
3772       }
3773     }
3774
3775     protop = "file"; /* protocol string */
3776   }
3777   else {
3778     /* clear path */
3779     path[0]=0;
3780
3781     if(2 > sscanf(data->change.url,
3782                    "%15[^\n:]://%[^\n/?]%[^\n]",
3783                    protobuf,
3784                    conn->host.name, path)) {
3785
3786       /*
3787        * The URL was badly formatted, let's try the browser-style _without_
3788        * protocol specified like 'http://'.
3789        */
3790       rc = sscanf(data->change.url, "%[^\n/?]%[^\n]", conn->host.name, path);
3791       if(1 > rc) {
3792         /*
3793          * We couldn't even get this format.
3794          * djgpp 2.04 has a sscanf() bug where 'conn->host.name' is
3795          * assigned, but the return value is EOF!
3796          */
3797 #if defined(__DJGPP__) && (DJGPP_MINOR == 4)
3798         if(!(rc == -1 && *conn->host.name))
3799 #endif
3800         {
3801           failf(data, "<url> malformed");
3802           return CURLE_URL_MALFORMAT;
3803         }
3804       }
3805
3806       /*
3807        * Since there was no protocol part specified, we guess what protocol it
3808        * is based on the first letters of the server name.
3809        */
3810
3811       /* Note: if you add a new protocol, please update the list in
3812        * lib/version.c too! */
3813
3814       if(checkprefix("FTP.", conn->host.name))
3815         protop = "ftp";
3816       else if(checkprefix("DICT.", conn->host.name))
3817         protop = "DICT";
3818       else if(checkprefix("LDAP.", conn->host.name))
3819         protop = "LDAP";
3820       else if(checkprefix("IMAP.", conn->host.name))
3821         protop = "IMAP";
3822       else if(checkprefix("SMTP.", conn->host.name))
3823         protop = "smtp";
3824       else if(checkprefix("POP3.", conn->host.name))
3825         protop = "pop3";
3826       else {
3827         protop = "http";
3828       }
3829
3830       *prot_missing = TRUE; /* not given in URL */
3831     }
3832     else
3833       protop = protobuf;
3834   }
3835
3836   /* We search for '?' in the host name (but only on the right side of a
3837    * @-letter to allow ?-letters in username and password) to handle things
3838    * like http://example.com?param= (notice the missing '/').
3839    */
3840   at = strchr(conn->host.name, '@');
3841   if(at)
3842     query = strchr(at+1, '?');
3843   else
3844     query = strchr(conn->host.name, '?');
3845
3846   if(query) {
3847     /* We must insert a slash before the '?'-letter in the URL. If the URL had
3848        a slash after the '?', that is where the path currently begins and the
3849        '?string' is still part of the host name.
3850
3851        We must move the trailing part from the host name and put it first in
3852        the path. And have it all prefixed with a slash.
3853     */
3854
3855     size_t hostlen = strlen(query);
3856     size_t pathlen = strlen(path);
3857
3858     /* move the existing path plus the zero byte forward, to make room for
3859        the host-name part */
3860     memmove(path+hostlen+1, path, pathlen+1);
3861
3862      /* now copy the trailing host part in front of the existing path */
3863     memcpy(path+1, query, hostlen);
3864
3865     path[0]='/'; /* prepend the missing slash */
3866     rebuild_url = TRUE;
3867
3868     *query=0; /* now cut off the hostname at the ? */
3869   }
3870   else if(!path[0]) {
3871     /* if there's no path set, use a single slash */
3872     strcpy(path, "/");
3873     rebuild_url = TRUE;
3874   }
3875
3876   /* If the URL is malformatted (missing a '/' after hostname before path) we
3877    * insert a slash here. The only letter except '/' we accept to start a path
3878    * is '?'.
3879    */
3880   if(path[0] == '?') {
3881     /* We need this function to deal with overlapping memory areas. We know
3882        that the memory area 'path' points to is 'urllen' bytes big and that
3883        is bigger than the path. Use +1 to move the zero byte too. */
3884     memmove(&path[1], path, strlen(path)+1);
3885     path[0] = '/';
3886     rebuild_url = TRUE;
3887   }
3888   else {
3889     /* sanitise paths and remove ../ and ./ sequences according to RFC3986 */
3890     char *newp = Curl_dedotdotify(path);
3891     if(!newp)
3892       return CURLE_OUT_OF_MEMORY;
3893
3894     if(strcmp(newp, path)) {
3895       rebuild_url = TRUE;
3896       free(data->state.pathbuffer);
3897       data->state.pathbuffer = newp;
3898       data->state.path = newp;
3899       path = newp;
3900     }
3901     else
3902       free(newp);
3903   }
3904
3905   /*
3906    * "rebuild_url" means that one or more URL components have been modified so
3907    * we need to generate an updated full version.  We need the corrected URL
3908    * when communicating over HTTP proxy and we don't know at this point if
3909    * we're using a proxy or not.
3910    */
3911   if(rebuild_url) {
3912     char *reurl;
3913
3914     size_t plen = strlen(path); /* new path, should be 1 byte longer than
3915                                    the original */
3916     size_t urllen = strlen(data->change.url); /* original URL length */
3917
3918     size_t prefixlen = strlen(conn->host.name);
3919
3920     if(!*prot_missing)
3921       prefixlen += strlen(protop) + strlen("://");
3922
3923     reurl = malloc(urllen + 2); /* 2 for zerobyte + slash */
3924     if(!reurl)
3925       return CURLE_OUT_OF_MEMORY;
3926
3927     /* copy the prefix */
3928     memcpy(reurl, data->change.url, prefixlen);
3929
3930     /* append the trailing piece + zerobyte */
3931     memcpy(&reurl[prefixlen], path, plen + 1);
3932
3933     /* possible free the old one */
3934     if(data->change.url_alloc) {
3935       Curl_safefree(data->change.url);
3936       data->change.url_alloc = FALSE;
3937     }
3938
3939     infof(data, "Rebuilt URL to: %s\n", reurl);
3940
3941     data->change.url = reurl;
3942     data->change.url_alloc = TRUE; /* free this later */
3943   }
3944
3945   /*
3946    * Parse the login details from the URL and strip them out of
3947    * the host name
3948    */
3949   result = parse_url_login(data, conn, userp, passwdp, optionsp);
3950   if(result != CURLE_OK)
3951     return result;
3952
3953   if(conn->host.name[0] == '[') {
3954     /* This looks like an IPv6 address literal.  See if there is an address
3955        scope.  */
3956     char *percent = strstr (conn->host.name, "%25");
3957     if(percent) {
3958       char *endp;
3959       unsigned long scope = strtoul (percent + 3, &endp, 10);
3960       if(*endp == ']') {
3961         /* The address scope was well formed.  Knock it out of the
3962            hostname. */
3963         memmove(percent, endp, strlen(endp)+1);
3964         if(!data->state.this_is_a_follow)
3965           /* Don't honour a scope given in a Location: header */
3966           conn->scope = (unsigned int)scope;
3967       }
3968       else
3969         infof(data, "Invalid IPv6 address format\n");
3970     }
3971   }
3972
3973   if(data->set.scope)
3974     /* Override any scope that was set above.  */
3975     conn->scope = data->set.scope;
3976
3977   /* Remove the fragment part of the path. Per RFC 2396, this is always the
3978      last part of the URI. We are looking for the first '#' so that we deal
3979      gracefully with non conformant URI such as http://example.com#foo#bar. */
3980   fragment = strchr(path, '#');
3981   if(fragment) {
3982     *fragment = 0;
3983
3984     /* we know the path part ended with a fragment, so we know the full URL
3985        string does too and we need to cut it off from there so it isn't used
3986        over proxy */
3987     fragment = strchr(data->change.url, '#');
3988     if(fragment)
3989       *fragment = 0;
3990   }
3991
3992   /*
3993    * So if the URL was A://B/C#D,
3994    *   protop is A
3995    *   conn->host.name is B
3996    *   data->state.path is /C
3997    */
3998
3999   return findprotocol(data, conn, protop);
4000 }
4001
4002 /*
4003  * If we're doing a resumed transfer, we need to setup our stuff
4004  * properly.
4005  */
4006 static CURLcode setup_range(struct SessionHandle *data)
4007 {
4008   struct UrlState *s = &data->state;
4009   s->resume_from = data->set.set_resume_from;
4010   if(s->resume_from || data->set.str[STRING_SET_RANGE]) {
4011     if(s->rangestringalloc)
4012       free(s->range);
4013
4014     if(s->resume_from)
4015       s->range = aprintf("%" FORMAT_OFF_TU "-", s->resume_from);
4016     else
4017       s->range = strdup(data->set.str[STRING_SET_RANGE]);
4018
4019     s->rangestringalloc = (s->range)?TRUE:FALSE;
4020
4021     if(!s->range)
4022       return CURLE_OUT_OF_MEMORY;
4023
4024     /* tell ourselves to fetch this range */
4025     s->use_range = TRUE;        /* enable range download */
4026   }
4027   else
4028     s->use_range = FALSE; /* disable range download */
4029
4030   return CURLE_OK;
4031 }
4032
4033
4034 /*
4035  * setup_connection_internals() -
4036  *
4037  * Setup connection internals specific to the requested protocol in the
4038  * SessionHandle. This is inited and setup before the connection is made but
4039  * is about the particular protocol that is to be used.
4040  *
4041  * This MUST get called after proxy magic has been figured out.
4042  */
4043 static CURLcode setup_connection_internals(struct connectdata *conn)
4044 {
4045   const struct Curl_handler * p;
4046   CURLcode result;
4047
4048   /* in some case in the multi state-machine, we go back to the CONNECT state
4049      and then a second (or third or...) call to this function will be made
4050      without doing a DISCONNECT or DONE in between (since the connection is
4051      yet in place) and therefore this function needs to first make sure
4052      there's no lingering previous data allocated. */
4053   Curl_free_request_state(conn->data);
4054
4055   memset(&conn->data->req, 0, sizeof(struct SingleRequest));
4056   conn->data->req.maxdownload = -1;
4057
4058   conn->socktype = SOCK_STREAM; /* most of them are TCP streams */
4059
4060   /* Perform setup complement if some. */
4061   p = conn->handler;
4062
4063   if(p->setup_connection) {
4064     result = (*p->setup_connection)(conn);
4065
4066     if(result != CURLE_OK)
4067       return result;
4068
4069     p = conn->handler;              /* May have changed. */
4070   }
4071
4072   if(conn->port < 0)
4073     /* we check for -1 here since if proxy was detected already, this
4074        was very likely already set to the proxy port */
4075     conn->port = p->defport;
4076
4077   /* only if remote_port was not already parsed off the URL we use the
4078      default port number */
4079   if(!conn->remote_port)
4080     conn->remote_port = (unsigned short)conn->given->defport;
4081
4082   return CURLE_OK;
4083 }
4084
4085 /*
4086  * Curl_free_request_state() should free temp data that was allocated in the
4087  * SessionHandle for this single request.
4088  */
4089
4090 void Curl_free_request_state(struct SessionHandle *data)
4091 {
4092   Curl_safefree(data->req.protop);
4093 }
4094
4095
4096 #ifndef CURL_DISABLE_PROXY
4097 /****************************************************************
4098 * Checks if the host is in the noproxy list. returns true if it matches
4099 * and therefore the proxy should NOT be used.
4100 ****************************************************************/
4101 static bool check_noproxy(const char* name, const char* no_proxy)
4102 {
4103   /* no_proxy=domain1.dom,host.domain2.dom
4104    *   (a comma-separated list of hosts which should
4105    *   not be proxied, or an asterisk to override
4106    *   all proxy variables)
4107    */
4108   size_t tok_start;
4109   size_t tok_end;
4110   const char* separator = ", ";
4111   size_t no_proxy_len;
4112   size_t namelen;
4113   char *endptr;
4114
4115   if(no_proxy && no_proxy[0]) {
4116     if(Curl_raw_equal("*", no_proxy)) {
4117       return TRUE;
4118     }
4119
4120     /* NO_PROXY was specified and it wasn't just an asterisk */
4121
4122     no_proxy_len = strlen(no_proxy);
4123     endptr = strchr(name, ':');
4124     if(endptr)
4125       namelen = endptr - name;
4126     else
4127       namelen = strlen(name);
4128
4129     for(tok_start = 0; tok_start < no_proxy_len; tok_start = tok_end + 1) {
4130       while(tok_start < no_proxy_len &&
4131             strchr(separator, no_proxy[tok_start]) != NULL) {
4132         /* Look for the beginning of the token. */
4133         ++tok_start;
4134       }
4135
4136       if(tok_start == no_proxy_len)
4137         break; /* It was all trailing separator chars, no more tokens. */
4138
4139       for(tok_end = tok_start; tok_end < no_proxy_len &&
4140             strchr(separator, no_proxy[tok_end]) == NULL; ++tok_end)
4141         /* Look for the end of the token. */
4142         ;
4143
4144       /* To match previous behaviour, where it was necessary to specify
4145        * ".local.com" to prevent matching "notlocal.com", we will leave
4146        * the '.' off.
4147        */
4148       if(no_proxy[tok_start] == '.')
4149         ++tok_start;
4150
4151       if((tok_end - tok_start) <= namelen) {
4152         /* Match the last part of the name to the domain we are checking. */
4153         const char *checkn = name + namelen - (tok_end - tok_start);
4154         if(Curl_raw_nequal(no_proxy + tok_start, checkn,
4155                            tok_end - tok_start)) {
4156           if((tok_end - tok_start) == namelen || *(checkn - 1) == '.') {
4157             /* We either have an exact match, or the previous character is a .
4158              * so it is within the same domain, so no proxy for this host.
4159              */
4160             return TRUE;
4161           }
4162         }
4163       } /* if((tok_end - tok_start) <= namelen) */
4164     } /* for(tok_start = 0; tok_start < no_proxy_len;
4165          tok_start = tok_end + 1) */
4166   } /* NO_PROXY was specified and it wasn't just an asterisk */
4167
4168   return FALSE;
4169 }
4170
4171 /****************************************************************
4172 * Detect what (if any) proxy to use. Remember that this selects a host
4173 * name and is not limited to HTTP proxies only.
4174 * The returned pointer must be freed by the caller (unless NULL)
4175 ****************************************************************/
4176 static char *detect_proxy(struct connectdata *conn)
4177 {
4178   char *proxy = NULL;
4179
4180 #ifndef CURL_DISABLE_HTTP
4181   /* If proxy was not specified, we check for default proxy environment
4182    * variables, to enable i.e Lynx compliance:
4183    *
4184    * http_proxy=http://some.server.dom:port/
4185    * https_proxy=http://some.server.dom:port/
4186    * ftp_proxy=http://some.server.dom:port/
4187    * no_proxy=domain1.dom,host.domain2.dom
4188    *   (a comma-separated list of hosts which should
4189    *   not be proxied, or an asterisk to override
4190    *   all proxy variables)
4191    * all_proxy=http://some.server.dom:port/
4192    *   (seems to exist for the CERN www lib. Probably
4193    *   the first to check for.)
4194    *
4195    * For compatibility, the all-uppercase versions of these variables are
4196    * checked if the lowercase versions don't exist.
4197    */
4198   char *no_proxy=NULL;
4199   char proxy_env[128];
4200
4201   no_proxy=curl_getenv("no_proxy");
4202   if(!no_proxy)
4203     no_proxy=curl_getenv("NO_PROXY");
4204
4205   if(!check_noproxy(conn->host.name, no_proxy)) {
4206     /* It was not listed as without proxy */
4207     const char *protop = conn->handler->scheme;
4208     char *envp = proxy_env;
4209     char *prox;
4210
4211     /* Now, build <protocol>_proxy and check for such a one to use */
4212     while(*protop)
4213       *envp++ = (char)tolower((int)*protop++);
4214
4215     /* append _proxy */
4216     strcpy(envp, "_proxy");
4217
4218     /* read the protocol proxy: */
4219     prox=curl_getenv(proxy_env);
4220
4221     /*
4222      * We don't try the uppercase version of HTTP_PROXY because of
4223      * security reasons:
4224      *
4225      * When curl is used in a webserver application
4226      * environment (cgi or php), this environment variable can
4227      * be controlled by the web server user by setting the
4228      * http header 'Proxy:' to some value.
4229      *
4230      * This can cause 'internal' http/ftp requests to be
4231      * arbitrarily redirected by any external attacker.
4232      */
4233     if(!prox && !Curl_raw_equal("http_proxy", proxy_env)) {
4234       /* There was no lowercase variable, try the uppercase version: */
4235       Curl_strntoupper(proxy_env, proxy_env, sizeof(proxy_env));
4236       prox=curl_getenv(proxy_env);
4237     }
4238
4239     if(prox && *prox) { /* don't count "" strings */
4240       proxy = prox; /* use this */
4241     }
4242     else {
4243       proxy = curl_getenv("all_proxy"); /* default proxy to use */
4244       if(!proxy)
4245         proxy=curl_getenv("ALL_PROXY");
4246     }
4247   } /* if(!check_noproxy(conn->host.name, no_proxy)) - it wasn't specified
4248        non-proxy */
4249   if(no_proxy)
4250     free(no_proxy);
4251
4252 #else /* !CURL_DISABLE_HTTP */
4253
4254   (void)conn;
4255 #endif /* CURL_DISABLE_HTTP */
4256
4257   return proxy;
4258 }
4259
4260 /*
4261  * If this is supposed to use a proxy, we need to figure out the proxy
4262  * host name, so that we can re-use an existing connection
4263  * that may exist registered to the same proxy host.
4264  * proxy will be freed before this function returns.
4265  */
4266 static CURLcode parse_proxy(struct SessionHandle *data,
4267                             struct connectdata *conn, char *proxy)
4268 {
4269   char *prox_portno;
4270   char *endofprot;
4271
4272   /* We use 'proxyptr' to point to the proxy name from now on... */
4273   char *proxyptr;
4274   char *portptr;
4275   char *atsign;
4276
4277   /* We do the proxy host string parsing here. We want the host name and the
4278    * port name. Accept a protocol:// prefix
4279    */
4280
4281   /* Parse the protocol part if present */
4282   endofprot = strstr(proxy, "://");
4283   if(endofprot) {
4284     proxyptr = endofprot+3;
4285     if(checkprefix("socks5h", proxy))
4286       conn->proxytype = CURLPROXY_SOCKS5_HOSTNAME;
4287     else if(checkprefix("socks5", proxy))
4288       conn->proxytype = CURLPROXY_SOCKS5;
4289     else if(checkprefix("socks4a", proxy))
4290       conn->proxytype = CURLPROXY_SOCKS4A;
4291     else if(checkprefix("socks4", proxy) || checkprefix("socks", proxy))
4292       conn->proxytype = CURLPROXY_SOCKS4;
4293     /* Any other xxx:// : change to http proxy */
4294   }
4295   else
4296     proxyptr = proxy; /* No xxx:// head: It's a HTTP proxy */
4297
4298   /* Is there a username and password given in this proxy url? */
4299   atsign = strchr(proxyptr, '@');
4300   if(atsign) {
4301     CURLcode res = CURLE_OK;
4302     char *proxyuser = NULL;
4303     char *proxypasswd = NULL;
4304
4305     res = parse_login_details(proxyptr, atsign - proxyptr,
4306                               &proxyuser, &proxypasswd, NULL);
4307     if(!res) {
4308       /* found user and password, rip them out.  note that we are
4309          unescaping them, as there is otherwise no way to have a
4310          username or password with reserved characters like ':' in
4311          them. */
4312       Curl_safefree(conn->proxyuser);
4313       if(proxyuser && strlen(proxyuser) < MAX_CURL_USER_LENGTH)
4314         conn->proxyuser = curl_easy_unescape(data, proxyuser, 0, NULL);
4315       else
4316         conn->proxyuser = strdup("");
4317
4318       if(!conn->proxyuser)
4319         res = CURLE_OUT_OF_MEMORY;
4320       else {
4321         Curl_safefree(conn->proxypasswd);
4322         if(proxypasswd && strlen(proxypasswd) < MAX_CURL_PASSWORD_LENGTH)
4323           conn->proxypasswd = curl_easy_unescape(data, proxypasswd, 0, NULL);
4324         else
4325           conn->proxypasswd = strdup("");
4326
4327         if(!conn->proxypasswd)
4328           res = CURLE_OUT_OF_MEMORY;
4329       }
4330
4331       if(!res) {
4332         conn->bits.proxy_user_passwd = TRUE; /* enable it */
4333         atsign++; /* the right side of the @-letter */
4334
4335         if(atsign)
4336           proxyptr = atsign; /* now use this instead */
4337         else
4338           res = CURLE_OUT_OF_MEMORY;
4339       }
4340     }
4341
4342     Curl_safefree(proxyuser);
4343     Curl_safefree(proxypasswd);
4344
4345     if(res)
4346       return res;
4347   }
4348
4349   /* start scanning for port number at this point */
4350   portptr = proxyptr;
4351
4352   /* detect and extract RFC2732-style IPv6-addresses */
4353   if(*proxyptr == '[') {
4354     char *ptr = ++proxyptr; /* advance beyond the initial bracket */
4355     while(*ptr && (ISXDIGIT(*ptr) || (*ptr == ':') || (*ptr == '%') ||
4356                    (*ptr == '.')))
4357       ptr++;
4358     if(*ptr == ']')
4359       /* yeps, it ended nicely with a bracket as well */
4360       *ptr++ = 0;
4361     else
4362       infof(data, "Invalid IPv6 address format\n");
4363     portptr = ptr;
4364     /* Note that if this didn't end with a bracket, we still advanced the
4365      * proxyptr first, but I can't see anything wrong with that as no host
4366      * name nor a numeric can legally start with a bracket.
4367      */
4368   }
4369
4370   /* Get port number off proxy.server.com:1080 */
4371   prox_portno = strchr(portptr, ':');
4372   if(prox_portno) {
4373     *prox_portno = 0x0; /* cut off number from host name */
4374     prox_portno ++;
4375     /* now set the local port number */
4376     conn->port = strtol(prox_portno, NULL, 10);
4377   }
4378   else {
4379     if(proxyptr[0]=='/')
4380       /* If the first character in the proxy string is a slash, fail
4381          immediately. The following code will otherwise clear the string which
4382          will lead to code running as if no proxy was set! */
4383       return CURLE_COULDNT_RESOLVE_PROXY;
4384
4385     /* without a port number after the host name, some people seem to use
4386        a slash so we strip everything from the first slash */
4387     atsign = strchr(proxyptr, '/');
4388     if(atsign)
4389       *atsign = 0x0; /* cut off path part from host name */
4390
4391     if(data->set.proxyport)
4392       /* None given in the proxy string, then get the default one if it is
4393          given */
4394       conn->port = data->set.proxyport;
4395   }
4396
4397   /* now, clone the cleaned proxy host name */
4398   conn->proxy.rawalloc = strdup(proxyptr);
4399   conn->proxy.name = conn->proxy.rawalloc;
4400
4401   if(!conn->proxy.rawalloc)
4402     return CURLE_OUT_OF_MEMORY;
4403
4404   return CURLE_OK;
4405 }
4406
4407 /*
4408  * Extract the user and password from the authentication string
4409  */
4410 static CURLcode parse_proxy_auth(struct SessionHandle *data,
4411                                  struct connectdata *conn)
4412 {
4413   char proxyuser[MAX_CURL_USER_LENGTH]="";
4414   char proxypasswd[MAX_CURL_PASSWORD_LENGTH]="";
4415
4416   if(data->set.str[STRING_PROXYUSERNAME] != NULL) {
4417     strncpy(proxyuser, data->set.str[STRING_PROXYUSERNAME],
4418             MAX_CURL_USER_LENGTH);
4419     proxyuser[MAX_CURL_USER_LENGTH-1] = '\0';   /*To be on safe side*/
4420   }
4421   if(data->set.str[STRING_PROXYPASSWORD] != NULL) {
4422     strncpy(proxypasswd, data->set.str[STRING_PROXYPASSWORD],
4423             MAX_CURL_PASSWORD_LENGTH);
4424     proxypasswd[MAX_CURL_PASSWORD_LENGTH-1] = '\0'; /*To be on safe side*/
4425   }
4426
4427   conn->proxyuser = curl_easy_unescape(data, proxyuser, 0, NULL);
4428   if(!conn->proxyuser)
4429     return CURLE_OUT_OF_MEMORY;
4430
4431   conn->proxypasswd = curl_easy_unescape(data, proxypasswd, 0, NULL);
4432   if(!conn->proxypasswd)
4433     return CURLE_OUT_OF_MEMORY;
4434
4435   return CURLE_OK;
4436 }
4437 #endif /* CURL_DISABLE_PROXY */
4438
4439 /*
4440  * parse_url_login()
4441  *
4442  * Parse the login details (user name, password and options) from the URL and
4443  * strip them out of the host name
4444  *
4445  * Inputs: data->set.use_netrc (CURLOPT_NETRC)
4446  *         conn->host.name
4447  *
4448  * Outputs: (almost :- all currently undefined)
4449  *          conn->bits.user_passwd  - non-zero if non-default passwords exist
4450  *          user                    - non-zero length if defined
4451  *          passwd                  - non-zero length if defined
4452  *          options                 - non-zero length if defined
4453  *          conn->host.name         - remove user name and password
4454  */
4455 static CURLcode parse_url_login(struct SessionHandle *data,
4456                                 struct connectdata *conn,
4457                                 char **user, char **passwd, char **options)
4458 {
4459   CURLcode result = CURLE_OK;
4460   char *userp = NULL;
4461   char *passwdp = NULL;
4462   char *optionsp = NULL;
4463
4464   /* At this point, we're hoping all the other special cases have
4465    * been taken care of, so conn->host.name is at most
4466    *    [user[:password][;options]]@]hostname
4467    *
4468    * We need somewhere to put the embedded details, so do that first.
4469    */
4470
4471   char *ptr = strchr(conn->host.name, '@');
4472   char *login = conn->host.name;
4473
4474   DEBUGASSERT(!**user);
4475   DEBUGASSERT(!**passwd);
4476   DEBUGASSERT(!**options);
4477
4478   if(!ptr)
4479     goto out;
4480
4481   /* We will now try to extract the
4482    * possible login information in a string like:
4483    * ftp://user:password@ftp.my.site:8021/README */
4484   conn->host.name = ++ptr;
4485
4486   /* So the hostname is sane.  Only bother interpreting the
4487    * results if we could care.  It could still be wasted
4488    * work because it might be overtaken by the programmatically
4489    * set user/passwd, but doing that first adds more cases here :-(
4490    */
4491
4492   if(data->set.use_netrc == CURL_NETRC_REQUIRED)
4493     goto out;
4494
4495   /* We could use the login information in the URL so extract it */
4496   result = parse_login_details(login, ptr - login - 1,
4497                                &userp, &passwdp, &optionsp);
4498   if(result != CURLE_OK)
4499     goto out;
4500
4501   if(userp) {
4502     char *newname;
4503
4504     /* We have a user in the URL */
4505     conn->bits.userpwd_in_url = TRUE;
4506     conn->bits.user_passwd = TRUE; /* enable user+password */
4507
4508     /* Decode the user */
4509     newname = curl_easy_unescape(data, userp, 0, NULL);
4510     if(!newname) {
4511       result = CURLE_OUT_OF_MEMORY;
4512       goto out;
4513     }
4514
4515     free(*user);
4516     *user = newname;
4517   }
4518
4519   if(passwdp) {
4520     /* We have a password in the URL so decode it */
4521     char *newpasswd = curl_easy_unescape(data, passwdp, 0, NULL);
4522     if(!newpasswd) {
4523       result = CURLE_OUT_OF_MEMORY;
4524       goto out;
4525     }
4526
4527     free(*passwd);
4528     *passwd = newpasswd;
4529   }
4530
4531   if(optionsp) {
4532     /* We have an options list in the URL so decode it */
4533     char *newoptions = curl_easy_unescape(data, optionsp, 0, NULL);
4534     if(!newoptions) {
4535       result = CURLE_OUT_OF_MEMORY;
4536       goto out;
4537     }
4538
4539     free(*options);
4540     *options = newoptions;
4541   }
4542
4543
4544   out:
4545
4546   Curl_safefree(userp);
4547   Curl_safefree(passwdp);
4548   Curl_safefree(optionsp);
4549
4550   return result;
4551 }
4552
4553 /*
4554  * parse_login_details()
4555  *
4556  * This is used to parse a login string for user name, password and options in
4557  * the following formats:
4558  *
4559  *   user
4560  *   user:password
4561  *   user:password;options
4562  *   user;options
4563  *   user;options:password
4564  *   :password
4565  *   :password;options
4566  *   ;options
4567  *   ;options:password
4568  *
4569  * Parameters:
4570  *
4571  * login    [in]     - The login string.
4572  * len      [in]     - The length of the login string.
4573  * userp    [in/out] - The address where a pointer to newly allocated memory
4574  *                     holding the user will be stored upon completion.
4575  * passdwp  [in/out] - The address where a pointer to newly allocated memory
4576  *                     holding the password will be stored upon completion.
4577  * optionsp [in/out] - The address where a pointer to newly allocated memory
4578  *                     holding the options will be stored upon completion.
4579  *
4580  * Returns CURLE_OK on success.
4581  */
4582 static CURLcode parse_login_details(const char *login, const size_t len,
4583                                     char **userp, char **passwdp,
4584                                     char **optionsp)
4585 {
4586   CURLcode result = CURLE_OK;
4587   char *ubuf = NULL;
4588   char *pbuf = NULL;
4589   char *obuf = NULL;
4590   const char *psep = NULL;
4591   const char *osep = NULL;
4592   size_t ulen;
4593   size_t plen;
4594   size_t olen;
4595
4596   /* Attempt to find the password separator */
4597   if(passwdp) {
4598     psep = strchr(login, ':');
4599
4600     /* Within the constraint of the login string */
4601     if(psep >= login + len)
4602       psep = NULL;
4603   }
4604
4605   /* Attempt to find the options separator */
4606   if(optionsp) {
4607     osep = strchr(login, ';');
4608
4609     /* Within the constraint of the login string */
4610     if(osep >= login + len)
4611       osep = NULL;
4612   }
4613
4614   /* Calculate the portion lengths */
4615   ulen = (psep ?
4616           (size_t)(osep && psep > osep ? osep - login : psep - login) :
4617           (osep ? (size_t)(osep - login) : len));
4618   plen = (psep ?
4619           (osep && osep > psep ? (size_t)(osep - psep) :
4620                                  (size_t)(login + len - psep)) - 1 : 0);
4621   olen = (osep ?
4622           (psep && psep > osep ? (size_t)(psep - osep) :
4623                                  (size_t)(login + len - osep)) - 1 : 0);
4624
4625   /* Allocate the user portion buffer */
4626   if(userp && ulen) {
4627     ubuf = malloc(ulen + 1);
4628     if(!ubuf)
4629       result = CURLE_OUT_OF_MEMORY;
4630   }
4631
4632   /* Allocate the password portion buffer */
4633   if(!result && passwdp && plen) {
4634     pbuf = malloc(plen + 1);
4635     if(!pbuf) {
4636       Curl_safefree(ubuf);
4637       result = CURLE_OUT_OF_MEMORY;
4638     }
4639   }
4640
4641   /* Allocate the options portion buffer */
4642   if(!result && optionsp && olen) {
4643     obuf = malloc(olen + 1);
4644     if(!obuf) {
4645       Curl_safefree(pbuf);
4646       Curl_safefree(ubuf);
4647       result = CURLE_OUT_OF_MEMORY;
4648     }
4649   }
4650
4651   if(!result) {
4652     /* Store the user portion if necessary */
4653     if(ubuf) {
4654       memcpy(ubuf, login, ulen);
4655       ubuf[ulen] = '\0';
4656       Curl_safefree(*userp);
4657       *userp = ubuf;
4658     }
4659
4660     /* Store the password portion if necessary */
4661     if(pbuf) {
4662       memcpy(pbuf, psep + 1, plen);
4663       pbuf[plen] = '\0';
4664       Curl_safefree(*passwdp);
4665       *passwdp = pbuf;
4666     }
4667
4668     /* Store the options portion if necessary */
4669     if(obuf) {
4670       memcpy(obuf, osep + 1, olen);
4671       obuf[olen] = '\0';
4672       Curl_safefree(*optionsp);
4673       *optionsp = obuf;
4674     }
4675   }
4676
4677   return result;
4678 }
4679
4680 /*************************************************************
4681  * Figure out the remote port number and fix it in the URL
4682  *
4683  * No matter if we use a proxy or not, we have to figure out the remote
4684  * port number of various reasons.
4685  *
4686  * To be able to detect port number flawlessly, we must not confuse them
4687  * IPv6-specified addresses in the [0::1] style. (RFC2732)
4688  *
4689  * The conn->host.name is currently [user:passwd@]host[:port] where host
4690  * could be a hostname, IPv4 address or IPv6 address.
4691  *
4692  * The port number embedded in the URL is replaced, if necessary.
4693  *************************************************************/
4694 static CURLcode parse_remote_port(struct SessionHandle *data,
4695                                   struct connectdata *conn)
4696 {
4697   char *portptr;
4698   char endbracket;
4699
4700   /* Note that at this point, the IPv6 address cannot contain any scope
4701      suffix as that has already been removed in the parseurlandfillconn()
4702      function */
4703   if((1 == sscanf(conn->host.name, "[%*45[0123456789abcdefABCDEF:.]%c",
4704                   &endbracket)) &&
4705      (']' == endbracket)) {
4706     /* this is a RFC2732-style specified IP-address */
4707     conn->bits.ipv6_ip = TRUE;
4708
4709     conn->host.name++; /* skip over the starting bracket */
4710     portptr = strchr(conn->host.name, ']');
4711     if(portptr) {
4712       *portptr++ = '\0'; /* zero terminate, killing the bracket */
4713       if(':' != *portptr)
4714         portptr = NULL; /* no port number available */
4715     }
4716   }
4717   else {
4718 #ifdef ENABLE_IPV6
4719     struct in6_addr in6;
4720     if(Curl_inet_pton(AF_INET6, conn->host.name, &in6) > 0) {
4721       /* This is a numerical IPv6 address, meaning this is a wrongly formatted
4722          URL */
4723       failf(data, "IPv6 numerical address used in URL without brackets");
4724       return CURLE_URL_MALFORMAT;
4725     }
4726 #endif
4727
4728     portptr = strrchr(conn->host.name, ':');
4729   }
4730
4731   if(data->set.use_port && data->state.allow_port) {
4732     /* if set, we use this and ignore the port possibly given in the URL */
4733     conn->remote_port = (unsigned short)data->set.use_port;
4734     if(portptr)
4735       *portptr = '\0'; /* cut off the name there anyway - if there was a port
4736                       number - since the port number is to be ignored! */
4737     if(conn->bits.httpproxy) {
4738       /* we need to create new URL with the new port number */
4739       char *url;
4740       char type[12]="";
4741
4742       if(conn->bits.type_set)
4743         snprintf(type, sizeof(type), ";type=%c",
4744                  data->set.prefer_ascii?'A':
4745                  (data->set.ftp_list_only?'D':'I'));
4746
4747       /*
4748        * This synthesized URL isn't always right--suffixes like ;type=A are
4749        * stripped off. It would be better to work directly from the original
4750        * URL and simply replace the port part of it.
4751        */
4752       url = aprintf("%s://%s%s%s:%hu%s%s%s", conn->given->scheme,
4753                     conn->bits.ipv6_ip?"[":"", conn->host.name,
4754                     conn->bits.ipv6_ip?"]":"", conn->remote_port,
4755                     data->state.slash_removed?"/":"", data->state.path,
4756                     type);
4757       if(!url)
4758         return CURLE_OUT_OF_MEMORY;
4759
4760       if(data->change.url_alloc) {
4761         Curl_safefree(data->change.url);
4762         data->change.url_alloc = FALSE;
4763       }
4764
4765       data->change.url = url;
4766       data->change.url_alloc = TRUE;
4767     }
4768   }
4769   else if(portptr) {
4770     /* no CURLOPT_PORT given, extract the one from the URL */
4771
4772     char *rest;
4773     unsigned long port;
4774
4775     port=strtoul(portptr+1, &rest, 10);  /* Port number must be decimal */
4776
4777     if(rest != (portptr+1) && *rest == '\0') {
4778       /* The colon really did have only digits after it,
4779        * so it is either a port number or a mistake */
4780
4781       if(port > 0xffff) {   /* Single unix standard says port numbers are
4782                               * 16 bits long */
4783         failf(data, "Port number too large: %lu", port);
4784         return CURLE_URL_MALFORMAT;
4785       }
4786
4787       *portptr = '\0'; /* cut off the name there */
4788       conn->remote_port = curlx_ultous(port);
4789     }
4790     else if(!port)
4791       /* Browser behavior adaptation. If there's a colon with no digits after,
4792          just cut off the name there which makes us ignore the colon and just
4793          use the default port. Firefox and Chrome both do that. */
4794       *portptr = '\0';
4795   }
4796   return CURLE_OK;
4797 }
4798
4799 /*
4800  * Override the login details from the URL with that in the CURLOPT_USERPWD
4801  * option or a .netrc file, if applicable.
4802  */
4803 static CURLcode override_login(struct SessionHandle *data,
4804                                struct connectdata *conn,
4805                                char **userp, char **passwdp, char **optionsp)
4806 {
4807   if(data->set.str[STRING_USERNAME]) {
4808     free(*userp);
4809     *userp = strdup(data->set.str[STRING_USERNAME]);
4810     if(!*userp)
4811       return CURLE_OUT_OF_MEMORY;
4812   }
4813
4814   if(data->set.str[STRING_PASSWORD]) {
4815     free(*passwdp);
4816     *passwdp = strdup(data->set.str[STRING_PASSWORD]);
4817     if(!*passwdp)
4818       return CURLE_OUT_OF_MEMORY;
4819   }
4820
4821   if(data->set.str[STRING_OPTIONS]) {
4822     free(*optionsp);
4823     *optionsp = strdup(data->set.str[STRING_OPTIONS]);
4824     if(!*optionsp)
4825       return CURLE_OUT_OF_MEMORY;
4826   }
4827
4828   conn->bits.netrc = FALSE;
4829   if(data->set.use_netrc != CURL_NETRC_IGNORED) {
4830     if(Curl_parsenetrc(conn->host.name,
4831                        userp, passwdp,
4832                        data->set.str[STRING_NETRC_FILE])) {
4833       infof(data, "Couldn't find host %s in the "
4834             DOT_CHAR "netrc file; using defaults\n",
4835             conn->host.name);
4836     }
4837     else {
4838       /* set bits.netrc TRUE to remember that we got the name from a .netrc
4839          file, so that it is safe to use even if we followed a Location: to a
4840          different host or similar. */
4841       conn->bits.netrc = TRUE;
4842
4843       conn->bits.user_passwd = TRUE; /* enable user+password */
4844     }
4845   }
4846
4847   return CURLE_OK;
4848 }
4849
4850 /*
4851  * Set password so it's available in the connection.
4852  */
4853 static CURLcode set_login(struct connectdata *conn,
4854                           const char *user, const char *passwd,
4855                           const char *options)
4856 {
4857   CURLcode result = CURLE_OK;
4858
4859   /* If our protocol needs a password and we have none, use the defaults */
4860   if((conn->handler->flags & PROTOPT_NEEDSPWD) && !conn->bits.user_passwd) {
4861     /* Store the default user */
4862     conn->user = strdup(CURL_DEFAULT_USER);
4863
4864     /* Store the default password */
4865     if(conn->user)
4866       conn->passwd = strdup(CURL_DEFAULT_PASSWORD);
4867     else
4868       conn->passwd = NULL;
4869
4870     /* This is the default password, so DON'T set conn->bits.user_passwd */
4871   }
4872   else {
4873     /* Store the user, zero-length if not set */
4874     conn->user = strdup(user);
4875
4876     /* Store the password (only if user is present), zero-length if not set */
4877     if(conn->user)
4878       conn->passwd = strdup(passwd);
4879     else
4880       conn->passwd = NULL;
4881   }
4882
4883   if(!conn->user || !conn->passwd)
4884     result = CURLE_OUT_OF_MEMORY;
4885
4886   /* Store the options, null if not set */
4887   if(!result && options[0]) {
4888     conn->options = strdup(options);
4889
4890     if(!conn->options)
4891       result = CURLE_OUT_OF_MEMORY;
4892   }
4893
4894   return result;
4895 }
4896
4897 /*************************************************************
4898  * Resolve the address of the server or proxy
4899  *************************************************************/
4900 static CURLcode resolve_server(struct SessionHandle *data,
4901                                struct connectdata *conn,
4902                                bool *async)
4903 {
4904   CURLcode result=CURLE_OK;
4905   long timeout_ms = Curl_timeleft(data, NULL, TRUE);
4906
4907   /*************************************************************
4908    * Resolve the name of the server or proxy
4909    *************************************************************/
4910   if(conn->bits.reuse)
4911     /* We're reusing the connection - no need to resolve anything, and
4912        fix_hostname() was called already in create_conn() for the re-use
4913        case. */
4914     *async = FALSE;
4915
4916   else {
4917     /* this is a fresh connect */
4918     int rc;
4919     struct Curl_dns_entry *hostaddr;
4920
4921     /* set a pointer to the hostname we display */
4922     fix_hostname(data, conn, &conn->host);
4923
4924     if(!conn->proxy.name || !*conn->proxy.name) {
4925       /* If not connecting via a proxy, extract the port from the URL, if it is
4926        * there, thus overriding any defaults that might have been set above. */
4927       conn->port =  conn->remote_port; /* it is the same port */
4928
4929       /* Resolve target host right on */
4930       rc = Curl_resolv_timeout(conn, conn->host.name, (int)conn->port,
4931                                &hostaddr, timeout_ms);
4932       if(rc == CURLRESOLV_PENDING)
4933         *async = TRUE;
4934
4935       else if(rc == CURLRESOLV_TIMEDOUT)
4936         result = CURLE_OPERATION_TIMEDOUT;
4937
4938       else if(!hostaddr) {
4939         failf(data, "Couldn't resolve host '%s'", conn->host.dispname);
4940         result =  CURLE_COULDNT_RESOLVE_HOST;
4941         /* don't return yet, we need to clean up the timeout first */
4942       }
4943     }
4944     else {
4945       /* This is a proxy that hasn't been resolved yet. */
4946
4947       /* IDN-fix the proxy name */
4948       fix_hostname(data, conn, &conn->proxy);
4949
4950       /* resolve proxy */
4951       rc = Curl_resolv_timeout(conn, conn->proxy.name, (int)conn->port,
4952                                &hostaddr, timeout_ms);
4953
4954       if(rc == CURLRESOLV_PENDING)
4955         *async = TRUE;
4956
4957       else if(rc == CURLRESOLV_TIMEDOUT)
4958         result = CURLE_OPERATION_TIMEDOUT;
4959
4960       else if(!hostaddr) {
4961         failf(data, "Couldn't resolve proxy '%s'", conn->proxy.dispname);
4962         result = CURLE_COULDNT_RESOLVE_PROXY;
4963         /* don't return yet, we need to clean up the timeout first */
4964       }
4965     }
4966     DEBUGASSERT(conn->dns_entry == NULL);
4967     conn->dns_entry = hostaddr;
4968   }
4969
4970   return result;
4971 }
4972
4973 /*
4974  * Cleanup the connection just allocated before we can move along and use the
4975  * previously existing one.  All relevant data is copied over and old_conn is
4976  * ready for freeing once this function returns.
4977  */
4978 static void reuse_conn(struct connectdata *old_conn,
4979                        struct connectdata *conn)
4980 {
4981   if(old_conn->proxy.rawalloc)
4982     free(old_conn->proxy.rawalloc);
4983
4984   /* free the SSL config struct from this connection struct as this was
4985      allocated in vain and is targeted for destruction */
4986   Curl_free_ssl_config(&old_conn->ssl_config);
4987
4988   conn->data = old_conn->data;
4989
4990   /* get the user+password information from the old_conn struct since it may
4991    * be new for this request even when we re-use an existing connection */
4992   conn->bits.user_passwd = old_conn->bits.user_passwd;
4993   if(conn->bits.user_passwd) {
4994     /* use the new user name and password though */
4995     Curl_safefree(conn->user);
4996     Curl_safefree(conn->passwd);
4997     conn->user = old_conn->user;
4998     conn->passwd = old_conn->passwd;
4999     old_conn->user = NULL;
5000     old_conn->passwd = NULL;
5001   }
5002
5003   conn->bits.proxy_user_passwd = old_conn->bits.proxy_user_passwd;
5004   if(conn->bits.proxy_user_passwd) {
5005     /* use the new proxy user name and proxy password though */
5006     Curl_safefree(conn->proxyuser);
5007     Curl_safefree(conn->proxypasswd);
5008     conn->proxyuser = old_conn->proxyuser;
5009     conn->proxypasswd = old_conn->proxypasswd;
5010     old_conn->proxyuser = NULL;
5011     old_conn->proxypasswd = NULL;
5012   }
5013
5014   /* host can change, when doing keepalive with a proxy or if the case is
5015      different this time etc */
5016   Curl_safefree(conn->host.rawalloc);
5017   conn->host=old_conn->host;
5018
5019   /* persist connection info in session handle */
5020   Curl_persistconninfo(conn);
5021
5022   /* re-use init */
5023   conn->bits.reuse = TRUE; /* yes, we're re-using here */
5024
5025   Curl_safefree(old_conn->user);
5026   Curl_safefree(old_conn->passwd);
5027   Curl_safefree(old_conn->proxyuser);
5028   Curl_safefree(old_conn->proxypasswd);
5029   Curl_safefree(old_conn->localdev);
5030
5031   Curl_llist_destroy(old_conn->send_pipe, NULL);
5032   Curl_llist_destroy(old_conn->recv_pipe, NULL);
5033
5034   old_conn->send_pipe = NULL;
5035   old_conn->recv_pipe = NULL;
5036
5037   Curl_safefree(old_conn->master_buffer);
5038 }
5039
5040 /**
5041  * create_conn() sets up a new connectdata struct, or re-uses an already
5042  * existing one, and resolves host name.
5043  *
5044  * if this function returns CURLE_OK and *async is set to TRUE, the resolve
5045  * response will be coming asynchronously. If *async is FALSE, the name is
5046  * already resolved.
5047  *
5048  * @param data The sessionhandle pointer
5049  * @param in_connect is set to the next connection data pointer
5050  * @param async is set TRUE when an async DNS resolution is pending
5051  * @see Curl_setup_conn()
5052  *
5053  * *NOTE* this function assigns the conn->data pointer!
5054  */
5055
5056 static CURLcode create_conn(struct SessionHandle *data,
5057                             struct connectdata **in_connect,
5058                             bool *async)
5059 {
5060   CURLcode result = CURLE_OK;
5061   struct connectdata *conn;
5062   struct connectdata *conn_temp = NULL;
5063   size_t urllen;
5064   char *user = NULL;
5065   char *passwd = NULL;
5066   char *options = NULL;
5067   bool reuse;
5068   char *proxy = NULL;
5069   bool prot_missing = FALSE;
5070   bool no_connections_available = FALSE;
5071   bool force_reuse;
5072   size_t max_host_connections = Curl_multi_max_host_connections(data->multi);
5073   size_t max_total_connections = Curl_multi_max_total_connections(data->multi);
5074
5075   *async = FALSE;
5076
5077   /*************************************************************
5078    * Check input data
5079    *************************************************************/
5080
5081   if(!data->change.url) {
5082     result = CURLE_URL_MALFORMAT;
5083     goto out;
5084   }
5085
5086   /* First, split up the current URL in parts so that we can use the
5087      parts for checking against the already present connections. In order
5088      to not have to modify everything at once, we allocate a temporary
5089      connection data struct and fill in for comparison purposes. */
5090   conn = allocate_conn(data);
5091
5092   if(!conn) {
5093     result = CURLE_OUT_OF_MEMORY;
5094     goto out;
5095   }
5096
5097   /* We must set the return variable as soon as possible, so that our
5098      parent can cleanup any possible allocs we may have done before
5099      any failure */
5100   *in_connect = conn;
5101
5102   /* This initing continues below, see the comment "Continue connectdata
5103    * initialization here" */
5104
5105   /***********************************************************
5106    * We need to allocate memory to store the path in. We get the size of the
5107    * full URL to be sure, and we need to make it at least 256 bytes since
5108    * other parts of the code will rely on this fact
5109    ***********************************************************/
5110 #define LEAST_PATH_ALLOC 256
5111   urllen=strlen(data->change.url);
5112   if(urllen < LEAST_PATH_ALLOC)
5113     urllen=LEAST_PATH_ALLOC;
5114
5115   /*
5116    * We malloc() the buffers below urllen+2 to make room for 2 possibilities:
5117    * 1 - an extra terminating zero
5118    * 2 - an extra slash (in case a syntax like "www.host.com?moo" is used)
5119    */
5120
5121   Curl_safefree(data->state.pathbuffer);
5122   data->state.path = NULL;
5123
5124   data->state.pathbuffer = malloc(urllen+2);
5125   if(NULL == data->state.pathbuffer) {
5126     result = CURLE_OUT_OF_MEMORY; /* really bad error */
5127     goto out;
5128   }
5129   data->state.path = data->state.pathbuffer;
5130
5131   conn->host.rawalloc = malloc(urllen+2);
5132   if(NULL == conn->host.rawalloc) {
5133     Curl_safefree(data->state.pathbuffer);
5134     data->state.path = NULL;
5135     result = CURLE_OUT_OF_MEMORY;
5136     goto out;
5137   }
5138
5139   conn->host.name = conn->host.rawalloc;
5140   conn->host.name[0] = 0;
5141
5142   user = strdup("");
5143   passwd = strdup("");
5144   options = strdup("");
5145   if(!user || !passwd || !options) {
5146     result = CURLE_OUT_OF_MEMORY;
5147     goto out;
5148   }
5149
5150   result = parseurlandfillconn(data, conn, &prot_missing, &user, &passwd,
5151                                &options);
5152   if(result != CURLE_OK)
5153     goto out;
5154
5155   /*************************************************************
5156    * No protocol part in URL was used, add it!
5157    *************************************************************/
5158   if(prot_missing) {
5159     /* We're guessing prefixes here and if we're told to use a proxy or if
5160        we're gonna follow a Location: later or... then we need the protocol
5161        part added so that we have a valid URL. */
5162     char *reurl;
5163
5164     reurl = aprintf("%s://%s", conn->handler->scheme, data->change.url);
5165
5166     if(!reurl) {
5167       result = CURLE_OUT_OF_MEMORY;
5168       goto out;
5169     }
5170
5171     if(data->change.url_alloc) {
5172       Curl_safefree(data->change.url);
5173       data->change.url_alloc = FALSE;
5174     }
5175
5176     data->change.url = reurl;
5177     data->change.url_alloc = TRUE; /* free this later */
5178   }
5179
5180   /*************************************************************
5181    * If the protocol can't handle url query strings, then cut
5182    * of the unhandable part
5183    *************************************************************/
5184   if((conn->given->flags&PROTOPT_NOURLQUERY)) {
5185     char *path_q_sep = strchr(conn->data->state.path, '?');
5186     if(path_q_sep) {
5187       /* according to rfc3986, allow the query (?foo=bar)
5188          also on protocols that can't handle it.
5189
5190          cut the string-part after '?'
5191       */
5192
5193       /* terminate the string */
5194       path_q_sep[0] = 0;
5195     }
5196   }
5197
5198   if(data->set.str[STRING_BEARER]) {
5199     conn->xoauth2_bearer = strdup(data->set.str[STRING_BEARER]);
5200     if(!conn->xoauth2_bearer) {
5201       return CURLE_OUT_OF_MEMORY;
5202     }
5203   }
5204
5205 #ifndef CURL_DISABLE_PROXY
5206   /*************************************************************
5207    * Extract the user and password from the authentication string
5208    *************************************************************/
5209   if(conn->bits.proxy_user_passwd) {
5210     result = parse_proxy_auth(data, conn);
5211     if(result != CURLE_OK)
5212       goto out;
5213   }
5214
5215   /*************************************************************
5216    * Detect what (if any) proxy to use
5217    *************************************************************/
5218   if(data->set.str[STRING_PROXY]) {
5219     proxy = strdup(data->set.str[STRING_PROXY]);
5220     /* if global proxy is set, this is it */
5221     if(NULL == proxy) {
5222       failf(data, "memory shortage");
5223       result = CURLE_OUT_OF_MEMORY;
5224       goto out;
5225     }
5226   }
5227
5228   if(data->set.str[STRING_NOPROXY] &&
5229      check_noproxy(conn->host.name, data->set.str[STRING_NOPROXY])) {
5230     if(proxy) {
5231       free(proxy);  /* proxy is in exception list */
5232       proxy = NULL;
5233     }
5234   }
5235   else if(!proxy)
5236     proxy = detect_proxy(conn);
5237
5238   if(proxy && (!*proxy || (conn->handler->flags & PROTOPT_NONETWORK))) {
5239     free(proxy);  /* Don't bother with an empty proxy string or if the
5240                      protocol doesn't work with network */
5241     proxy = NULL;
5242   }
5243
5244   /***********************************************************************
5245    * If this is supposed to use a proxy, we need to figure out the proxy host
5246    * name, proxy type and port number, so that we can re-use an existing
5247    * connection that may exist registered to the same proxy host.
5248    ***********************************************************************/
5249   if(proxy) {
5250     result = parse_proxy(data, conn, proxy);
5251
5252     Curl_safefree(proxy); /* parse_proxy copies the proxy string */
5253
5254     if(result)
5255       goto out;
5256
5257     if((conn->proxytype == CURLPROXY_HTTP) ||
5258        (conn->proxytype == CURLPROXY_HTTP_1_0)) {
5259 #ifdef CURL_DISABLE_HTTP
5260       /* asking for a HTTP proxy is a bit funny when HTTP is disabled... */
5261       result = CURLE_UNSUPPORTED_PROTOCOL;
5262       goto out;
5263 #else
5264       /* force this connection's protocol to become HTTP if not already
5265          compatible - if it isn't tunneling through */
5266       if(!(conn->handler->protocol & CURLPROTO_HTTP) &&
5267          !conn->bits.tunnel_proxy)
5268         conn->handler = &Curl_handler_http;
5269
5270       conn->bits.httpproxy = TRUE;
5271 #endif
5272     }
5273     else
5274       conn->bits.httpproxy = FALSE; /* not a HTTP proxy */
5275     conn->bits.proxy = TRUE;
5276   }
5277   else {
5278     /* we aren't using the proxy after all... */
5279     conn->bits.proxy = FALSE;
5280     conn->bits.httpproxy = FALSE;
5281     conn->bits.proxy_user_passwd = FALSE;
5282     conn->bits.tunnel_proxy = FALSE;
5283   }
5284
5285 #endif /* CURL_DISABLE_PROXY */
5286
5287   /*************************************************************
5288    * If the protocol is using SSL and HTTP proxy is used, we set
5289    * the tunnel_proxy bit.
5290    *************************************************************/
5291   if((conn->given->flags&PROTOPT_SSL) && conn->bits.httpproxy)
5292     conn->bits.tunnel_proxy = TRUE;
5293
5294   /*************************************************************
5295    * Figure out the remote port number and fix it in the URL
5296    *************************************************************/
5297   result = parse_remote_port(data, conn);
5298   if(result != CURLE_OK)
5299     goto out;
5300
5301   /* Check for overridden login details and set them accordingly so they
5302      they are known when protocol->setup_connection is called! */
5303   result = override_login(data, conn, &user, &passwd, &options);
5304   if(result != CURLE_OK)
5305     goto out;
5306   result = set_login(conn, user, passwd, options);
5307   if(result != CURLE_OK)
5308     goto out;
5309
5310   /*************************************************************
5311    * Setup internals depending on protocol. Needs to be done after
5312    * we figured out what/if proxy to use.
5313    *************************************************************/
5314   result = setup_connection_internals(conn);
5315   if(result != CURLE_OK)
5316     goto out;
5317
5318   conn->recv[FIRSTSOCKET] = Curl_recv_plain;
5319   conn->send[FIRSTSOCKET] = Curl_send_plain;
5320   conn->recv[SECONDARYSOCKET] = Curl_recv_plain;
5321   conn->send[SECONDARYSOCKET] = Curl_send_plain;
5322
5323   /***********************************************************************
5324    * file: is a special case in that it doesn't need a network connection
5325    ***********************************************************************/
5326 #ifndef CURL_DISABLE_FILE
5327   if(conn->handler->flags & PROTOPT_NONETWORK) {
5328     bool done;
5329     /* this is supposed to be the connect function so we better at least check
5330        that the file is present here! */
5331     DEBUGASSERT(conn->handler->connect_it);
5332     result = conn->handler->connect_it(conn, &done);
5333
5334     /* Setup a "faked" transfer that'll do nothing */
5335     if(CURLE_OK == result) {
5336       conn->data = data;
5337       conn->bits.tcpconnect[FIRSTSOCKET] = TRUE; /* we are "connected */
5338
5339       ConnectionStore(data, conn);
5340
5341       /*
5342        * Setup whatever necessary for a resumed transfer
5343        */
5344       result = setup_range(data);
5345       if(result) {
5346         DEBUGASSERT(conn->handler->done);
5347         /* we ignore the return code for the protocol-specific DONE */
5348         (void)conn->handler->done(conn, result, FALSE);
5349         goto out;
5350       }
5351
5352       Curl_setup_transfer(conn, -1, -1, FALSE, NULL, /* no download */
5353                           -1, NULL); /* no upload */
5354     }
5355
5356     /* since we skip do_init() */
5357     do_init(conn);
5358
5359     goto out;
5360   }
5361 #endif
5362
5363   /* Get a cloned copy of the SSL config situation stored in the
5364      connection struct. But to get this going nicely, we must first make
5365      sure that the strings in the master copy are pointing to the correct
5366      strings in the session handle strings array!
5367
5368      Keep in mind that the pointers in the master copy are pointing to strings
5369      that will be freed as part of the SessionHandle struct, but all cloned
5370      copies will be separately allocated.
5371   */
5372   data->set.ssl.CApath = data->set.str[STRING_SSL_CAPATH];
5373   data->set.ssl.CAfile = data->set.str[STRING_SSL_CAFILE];
5374   data->set.ssl.CRLfile = data->set.str[STRING_SSL_CRLFILE];
5375   data->set.ssl.issuercert = data->set.str[STRING_SSL_ISSUERCERT];
5376   data->set.ssl.random_file = data->set.str[STRING_SSL_RANDOM_FILE];
5377   data->set.ssl.egdsocket = data->set.str[STRING_SSL_EGDSOCKET];
5378   data->set.ssl.cipher_list = data->set.str[STRING_SSL_CIPHER_LIST];
5379 #ifdef USE_TLS_SRP
5380   data->set.ssl.username = data->set.str[STRING_TLSAUTH_USERNAME];
5381   data->set.ssl.password = data->set.str[STRING_TLSAUTH_PASSWORD];
5382 #endif
5383
5384   if(!Curl_clone_ssl_config(&data->set.ssl, &conn->ssl_config)) {
5385     result = CURLE_OUT_OF_MEMORY;
5386     goto out;
5387   }
5388
5389   /*************************************************************
5390    * Check the current list of connections to see if we can
5391    * re-use an already existing one or if we have to create a
5392    * new one.
5393    *************************************************************/
5394
5395   /* reuse_fresh is TRUE if we are told to use a new connection by force, but
5396      we only acknowledge this option if this is not a re-used connection
5397      already (which happens due to follow-location or during a HTTP
5398      authentication phase). */
5399   if(data->set.reuse_fresh && !data->state.this_is_a_follow)
5400     reuse = FALSE;
5401   else
5402     reuse = ConnectionExists(data, conn, &conn_temp, &force_reuse);
5403
5404   /* If we found a reusable connection, we may still want to
5405      open a new connection if we are pipelining. */
5406   if(reuse && !force_reuse && IsPipeliningPossible(data, conn_temp)) {
5407     size_t pipelen = conn_temp->send_pipe->size + conn_temp->recv_pipe->size;
5408     if(pipelen > 0) {
5409       infof(data, "Found connection %ld, with requests in the pipe (%zu)\n",
5410             conn_temp->connection_id, pipelen);
5411
5412       if(conn_temp->bundle->num_connections < max_host_connections &&
5413          data->state.conn_cache->num_connections < max_total_connections) {
5414         /* We want a new connection anyway */
5415         reuse = FALSE;
5416
5417         infof(data, "We can reuse, but we want a new connection anyway\n");
5418       }
5419     }
5420   }
5421
5422   if(reuse) {
5423     /*
5424      * We already have a connection for this, we got the former connection
5425      * in the conn_temp variable and thus we need to cleanup the one we
5426      * just allocated before we can move along and use the previously
5427      * existing one.
5428      */
5429     conn_temp->inuse = TRUE; /* mark this as being in use so that no other
5430                                 handle in a multi stack may nick it */
5431     reuse_conn(conn, conn_temp);
5432     free(conn);          /* we don't need this anymore */
5433     conn = conn_temp;
5434     *in_connect = conn;
5435
5436     /* set a pointer to the hostname we display */
5437     fix_hostname(data, conn, &conn->host);
5438
5439     infof(data, "Re-using existing connection! (#%ld) with host %s\n",
5440           conn->connection_id,
5441           conn->proxy.name?conn->proxy.dispname:conn->host.dispname);
5442   }
5443   else {
5444     /* We have decided that we want a new connection. However, we may not
5445        be able to do that if we have reached the limit of how many
5446        connections we are allowed to open. */
5447     struct connectbundle *bundle;
5448
5449     bundle = Curl_conncache_find_bundle(data->state.conn_cache,
5450                                         conn->host.name);
5451     if(max_host_connections > 0 && bundle &&
5452        (bundle->num_connections >= max_host_connections)) {
5453       struct connectdata *conn_candidate;
5454
5455       /* The bundle is full. Let's see if we can kill a connection. */
5456       conn_candidate = find_oldest_idle_connection_in_bundle(data, bundle);
5457
5458       if(conn_candidate) {
5459         /* Set the connection's owner correctly, then kill it */
5460         conn_candidate->data = data;
5461         (void)Curl_disconnect(conn_candidate, /* dead_connection */ FALSE);
5462       }
5463       else
5464         no_connections_available = TRUE;
5465     }
5466
5467     if(max_total_connections > 0 &&
5468        (data->state.conn_cache->num_connections >= max_total_connections)) {
5469       struct connectdata *conn_candidate;
5470
5471       /* The cache is full. Let's see if we can kill a connection. */
5472       conn_candidate = find_oldest_idle_connection(data);
5473
5474       if(conn_candidate) {
5475         /* Set the connection's owner correctly, then kill it */
5476         conn_candidate->data = data;
5477         (void)Curl_disconnect(conn_candidate, /* dead_connection */ FALSE);
5478       }
5479       else
5480         no_connections_available = TRUE;
5481     }
5482
5483
5484     if(no_connections_available) {
5485       infof(data, "No connections available.\n");
5486
5487       conn_free(conn);
5488       *in_connect = NULL;
5489
5490       result = CURLE_NO_CONNECTION_AVAILABLE;
5491       goto out;
5492     }
5493     else {
5494       /*
5495        * This is a brand new connection, so let's store it in the connection
5496        * cache of ours!
5497        */
5498       ConnectionStore(data, conn);
5499     }
5500   }
5501
5502   /* Mark the connection as used */
5503   conn->inuse = TRUE;
5504
5505   /* Setup and init stuff before DO starts, in preparing for the transfer. */
5506   do_init(conn);
5507
5508   /*
5509    * Setup whatever necessary for a resumed transfer
5510    */
5511   result = setup_range(data);
5512   if(result)
5513     goto out;
5514
5515   /* Continue connectdata initialization here. */
5516
5517   /*
5518    * Inherit the proper values from the urldata struct AFTER we have arranged
5519    * the persistent connection stuff
5520    */
5521   conn->fread_func = data->set.fread_func;
5522   conn->fread_in = data->set.in;
5523   conn->seek_func = data->set.seek_func;
5524   conn->seek_client = data->set.seek_client;
5525
5526   /*************************************************************
5527    * Resolve the address of the server or proxy
5528    *************************************************************/
5529   result = resolve_server(data, conn, async);
5530
5531   out:
5532
5533   Curl_safefree(options);
5534   Curl_safefree(passwd);
5535   Curl_safefree(user);
5536   Curl_safefree(proxy);
5537   return result;
5538 }
5539
5540 /* Curl_setup_conn() is called after the name resolve initiated in
5541  * create_conn() is all done.
5542  *
5543  * Curl_setup_conn() also handles reused connections
5544  *
5545  * conn->data MUST already have been setup fine (in create_conn)
5546  */
5547
5548 CURLcode Curl_setup_conn(struct connectdata *conn,
5549                          bool *protocol_done)
5550 {
5551   CURLcode result = CURLE_OK;
5552   struct SessionHandle *data = conn->data;
5553
5554   Curl_pgrsTime(data, TIMER_NAMELOOKUP);
5555
5556   if(conn->handler->flags & PROTOPT_NONETWORK) {
5557     /* nothing to setup when not using a network */
5558     *protocol_done = TRUE;
5559     return result;
5560   }
5561   *protocol_done = FALSE; /* default to not done */
5562
5563   /* set proxy_connect_closed to false unconditionally already here since it
5564      is used strictly to provide extra information to a parent function in the
5565      case of proxy CONNECT failures and we must make sure we don't have it
5566      lingering set from a previous invoke */
5567   conn->bits.proxy_connect_closed = FALSE;
5568
5569   /*
5570    * Set user-agent. Used for HTTP, but since we can attempt to tunnel
5571    * basically anything through a http proxy we can't limit this based on
5572    * protocol.
5573    */
5574   if(data->set.str[STRING_USERAGENT]) {
5575     Curl_safefree(conn->allocptr.uagent);
5576     conn->allocptr.uagent =
5577       aprintf("User-Agent: %s\r\n", data->set.str[STRING_USERAGENT]);
5578     if(!conn->allocptr.uagent)
5579       return CURLE_OUT_OF_MEMORY;
5580   }
5581
5582   data->req.headerbytecount = 0;
5583
5584 #ifdef CURL_DO_LINEEND_CONV
5585   data->state.crlf_conversions = 0; /* reset CRLF conversion counter */
5586 #endif /* CURL_DO_LINEEND_CONV */
5587
5588   /* set start time here for timeout purposes in the connect procedure, it
5589      is later set again for the progress meter purpose */
5590   conn->now = Curl_tvnow();
5591
5592   for(;;) {
5593     /* loop for CURL_SERVER_CLOSED_CONNECTION */
5594
5595     if(CURL_SOCKET_BAD == conn->sock[FIRSTSOCKET]) {
5596       /* Try to connect only if not already connected */
5597       bool connected = FALSE;
5598
5599       result = ConnectPlease(data, conn, &connected);
5600
5601       if(result && !conn->ip_addr) {
5602         /* transport connection failure not related with authentication */
5603         conn->bits.tcpconnect[FIRSTSOCKET] = FALSE;
5604         return result;
5605       }
5606
5607       if(connected) {
5608         result = Curl_protocol_connect(conn, protocol_done);
5609         if(CURLE_OK == result)
5610           conn->bits.tcpconnect[FIRSTSOCKET] = TRUE;
5611       }
5612       else
5613         conn->bits.tcpconnect[FIRSTSOCKET] = FALSE;
5614
5615       /* if the connection was closed by the server while exchanging
5616          authentication informations, retry with the new set
5617          authentication information */
5618       if(conn->bits.proxy_connect_closed) {
5619         /* reset the error buffer */
5620         if(data->set.errorbuffer)
5621           data->set.errorbuffer[0] = '\0';
5622         data->state.errorbuf = FALSE;
5623         continue;
5624       }
5625
5626       if(CURLE_OK != result)
5627         return result;
5628     }
5629     else {
5630       Curl_pgrsTime(data, TIMER_CONNECT); /* we're connected already */
5631       Curl_pgrsTime(data, TIMER_APPCONNECT); /* we're connected already */
5632       conn->bits.tcpconnect[FIRSTSOCKET] = TRUE;
5633       *protocol_done = TRUE;
5634       Curl_verboseconnect(conn);
5635       Curl_updateconninfo(conn, conn->sock[FIRSTSOCKET]);
5636     }
5637     /* Stop the loop now */
5638     break;
5639   }
5640
5641   conn->now = Curl_tvnow(); /* time this *after* the connect is done, we
5642                                set this here perhaps a second time */
5643
5644 #ifdef __EMX__
5645   /*
5646    * This check is quite a hack. We're calling _fsetmode to fix the problem
5647    * with fwrite converting newline characters (you get mangled text files,
5648    * and corrupted binary files when you download to stdout and redirect it to
5649    * a file).
5650    */
5651
5652   if((data->set.out)->_handle == NULL) {
5653     _fsetmode(stdout, "b");
5654   }
5655 #endif
5656
5657   return result;
5658 }
5659
5660 CURLcode Curl_connect(struct SessionHandle *data,
5661                       struct connectdata **in_connect,
5662                       bool *asyncp,
5663                       bool *protocol_done)
5664 {
5665   CURLcode code;
5666
5667   *asyncp = FALSE; /* assume synchronous resolves by default */
5668
5669   /* call the stuff that needs to be called */
5670   code = create_conn(data, in_connect, asyncp);
5671
5672   if(CURLE_OK == code) {
5673     /* no error */
5674     if((*in_connect)->send_pipe->size || (*in_connect)->recv_pipe->size)
5675       /* pipelining */
5676       *protocol_done = TRUE;
5677     else if(!*asyncp) {
5678       /* DNS resolution is done: that's either because this is a reused
5679          connection, in which case DNS was unnecessary, or because DNS
5680          really did finish already (synch resolver/fast async resolve) */
5681       code = Curl_setup_conn(*in_connect, protocol_done);
5682     }
5683   }
5684
5685   if(code == CURLE_NO_CONNECTION_AVAILABLE) {
5686     *in_connect = NULL;
5687     return code;
5688   }
5689
5690   if(code && *in_connect) {
5691     /* We're not allowed to return failure with memory left allocated
5692        in the connectdata struct, free those here */
5693     Curl_disconnect(*in_connect, FALSE); /* close the connection */
5694     *in_connect = NULL;           /* return a NULL */
5695   }
5696
5697   return code;
5698 }
5699
5700 CURLcode Curl_done(struct connectdata **connp,
5701                    CURLcode status,  /* an error if this is called after an
5702                                         error was detected */
5703                    bool premature)
5704 {
5705   CURLcode result;
5706   struct connectdata *conn;
5707   struct SessionHandle *data;
5708
5709   DEBUGASSERT(*connp);
5710
5711   conn = *connp;
5712   data = conn->data;
5713
5714   if(conn->bits.done)
5715     /* Stop if Curl_done() has already been called */
5716     return CURLE_OK;
5717
5718   Curl_getoff_all_pipelines(data, conn);
5719
5720   if((conn->send_pipe->size + conn->recv_pipe->size != 0 &&
5721       !data->set.reuse_forbid &&
5722       !conn->bits.close))
5723     /* Stop if pipeline is not empty and we do not have to close
5724        connection. */
5725     return CURLE_OK;
5726
5727   conn->bits.done = TRUE; /* called just now! */
5728
5729   /* Cleanup possible redirect junk */
5730   if(data->req.newurl) {
5731     free(data->req.newurl);
5732     data->req.newurl = NULL;
5733   }
5734   if(data->req.location) {
5735     free(data->req.location);
5736     data->req.location = NULL;
5737   }
5738
5739   Curl_resolver_cancel(conn);
5740
5741   if(conn->dns_entry) {
5742     Curl_resolv_unlock(data, conn->dns_entry); /* done with this */
5743     conn->dns_entry = NULL;
5744   }
5745
5746   switch(status) {
5747   case CURLE_ABORTED_BY_CALLBACK:
5748   case CURLE_READ_ERROR:
5749   case CURLE_WRITE_ERROR:
5750     /* When we're aborted due to a callback return code it basically have to
5751        be counted as premature as there is trouble ahead if we don't. We have
5752        many callbacks and protocols work differently, we could potentially do
5753        this more fine-grained in the future. */
5754     premature = TRUE;
5755   default:
5756     break;
5757   }
5758
5759   /* this calls the protocol-specific function pointer previously set */
5760   if(conn->handler->done)
5761     result = conn->handler->done(conn, status, premature);
5762   else
5763     result = CURLE_OK;
5764
5765   if(Curl_pgrsDone(conn) && !result)
5766     result = CURLE_ABORTED_BY_CALLBACK;
5767
5768   /* if the transfer was completed in a paused state there can be buffered
5769      data left to write and then kill */
5770   if(data->state.tempwrite) {
5771     free(data->state.tempwrite);
5772     data->state.tempwrite = NULL;
5773   }
5774
5775   /* if data->set.reuse_forbid is TRUE, it means the libcurl client has
5776      forced us to close this no matter what we think.
5777
5778      if conn->bits.close is TRUE, it means that the connection should be
5779      closed in spite of all our efforts to be nice, due to protocol
5780      restrictions in our or the server's end
5781
5782      if premature is TRUE, it means this connection was said to be DONE before
5783      the entire request operation is complete and thus we can't know in what
5784      state it is for re-using, so we're forced to close it. In a perfect world
5785      we can add code that keep track of if we really must close it here or not,
5786      but currently we have no such detail knowledge.
5787   */
5788   if(data->set.reuse_forbid || conn->bits.close || premature) {
5789     CURLcode res2 = Curl_disconnect(conn, premature); /* close connection */
5790
5791     /* If we had an error already, make sure we return that one. But
5792        if we got a new error, return that. */
5793     if(!result && res2)
5794       result = res2;
5795   }
5796   else {
5797     /* the connection is no longer in use */
5798     if(ConnectionDone(data, conn)) {
5799       /* remember the most recently used connection */
5800       data->state.lastconnect = conn;
5801
5802       infof(data, "Connection #%ld to host %s left intact\n",
5803             conn->connection_id,
5804             conn->bits.httpproxy?conn->proxy.dispname:conn->host.dispname);
5805     }
5806     else
5807       data->state.lastconnect = NULL;
5808   }
5809
5810   *connp = NULL; /* to make the caller of this function better detect that
5811                     this was either closed or handed over to the connection
5812                     cache here, and therefore cannot be used from this point on
5813                  */
5814   Curl_free_request_state(data);
5815
5816   return result;
5817 }
5818
5819 /*
5820  * do_init() inits the readwrite session. This is inited each time (in the DO
5821  * function before the protocol-specific DO functions are invoked) for a
5822  * transfer, sometimes multiple times on the same SessionHandle. Make sure
5823  * nothing in here depends on stuff that are setup dynamically for the
5824  * transfer.
5825  */
5826
5827 static CURLcode do_init(struct connectdata *conn)
5828 {
5829   struct SessionHandle *data = conn->data;
5830   struct SingleRequest *k = &data->req;
5831
5832   conn->bits.done = FALSE; /* Curl_done() is not called yet */
5833   conn->bits.do_more = FALSE; /* by default there's no curl_do_more() to use */
5834   data->state.expect100header = FALSE;
5835
5836   if(data->set.opt_no_body)
5837     /* in HTTP lingo, no body means using the HEAD request... */
5838     data->set.httpreq = HTTPREQ_HEAD;
5839   else if(HTTPREQ_HEAD == data->set.httpreq)
5840     /* ... but if unset there really is no perfect method that is the
5841        "opposite" of HEAD but in reality most people probably think GET
5842        then. The important thing is that we can't let it remain HEAD if the
5843        opt_no_body is set FALSE since then we'll behave wrong when getting
5844        HTTP. */
5845     data->set.httpreq = HTTPREQ_GET;
5846
5847   k->start = Curl_tvnow(); /* start time */
5848   k->now = k->start;   /* current time is now */
5849   k->header = TRUE; /* assume header */
5850
5851   k->bytecount = 0;
5852
5853   k->buf = data->state.buffer;
5854   k->uploadbuf = data->state.uploadbuffer;
5855   k->hbufp = data->state.headerbuff;
5856   k->ignorebody=FALSE;
5857
5858   Curl_speedinit(data);
5859
5860   Curl_pgrsSetUploadCounter(data, 0);
5861   Curl_pgrsSetDownloadCounter(data, 0);
5862
5863   return CURLE_OK;
5864 }
5865
5866 /*
5867  * do_complete is called when the DO actions are complete.
5868  *
5869  * We init chunking and trailer bits to their default values here immediately
5870  * before receiving any header data for the current request in the pipeline.
5871  */
5872 static void do_complete(struct connectdata *conn)
5873 {
5874   conn->data->req.chunk=FALSE;
5875   conn->data->req.maxfd = (conn->sockfd>conn->writesockfd?
5876                            conn->sockfd:conn->writesockfd)+1;
5877   Curl_pgrsTime(conn->data, TIMER_PRETRANSFER);
5878 }
5879
5880 CURLcode Curl_do(struct connectdata **connp, bool *done)
5881 {
5882   CURLcode result=CURLE_OK;
5883   struct connectdata *conn = *connp;
5884   struct SessionHandle *data = conn->data;
5885
5886   if(conn->handler->do_it) {
5887     /* generic protocol-specific function pointer set in curl_connect() */
5888     result = conn->handler->do_it(conn, done);
5889
5890     /* This was formerly done in transfer.c, but we better do it here */
5891     if((CURLE_SEND_ERROR == result) && conn->bits.reuse) {
5892       /*
5893        * If the connection is using an easy handle, call reconnect
5894        * to re-establish the connection.  Otherwise, let the multi logic
5895        * figure out how to re-establish the connection.
5896        */
5897       if(!data->multi) {
5898         result = Curl_reconnect_request(connp);
5899
5900         if(result == CURLE_OK) {
5901           /* ... finally back to actually retry the DO phase */
5902           conn = *connp; /* re-assign conn since Curl_reconnect_request
5903                             creates a new connection */
5904           result = conn->handler->do_it(conn, done);
5905         }
5906       }
5907       else
5908         return result;
5909     }
5910
5911     if((result == CURLE_OK) && *done)
5912       /* do_complete must be called after the protocol-specific DO function */
5913       do_complete(conn);
5914   }
5915   return result;
5916 }
5917
5918 /*
5919  * Curl_do_more() is called during the DO_MORE multi state. It is basically a
5920  * second stage DO state which (wrongly) was introduced to support FTP's
5921  * second connection.
5922  *
5923  * TODO: A future libcurl should be able to work away this state.
5924  *
5925  * 'complete' can return 0 for incomplete, 1 for done and -1 for go back to
5926  * DOING state there's more work to do!
5927  */
5928
5929 CURLcode Curl_do_more(struct connectdata *conn, int *complete)
5930 {
5931   CURLcode result=CURLE_OK;
5932
5933   *complete = 0;
5934
5935   if(conn->handler->do_more)
5936     result = conn->handler->do_more(conn, complete);
5937
5938   if(!result && (*complete == 1))
5939     /* do_complete must be called after the protocol-specific DO function */
5940     do_complete(conn);
5941
5942   return result;
5943 }
5944