methods/https.cc

   1 //-*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: http.cc,v 1.59 2004/05/08 19:42:35 mdz Exp $
   4 /* ######################################################################
   5
   6    HTTPS Acquire Method - This is the HTTPS acquire method for APT.
   7
   8    It uses libcurl
   9
  10    ##################################################################### */
  11                                                                         /*}}}*/
  12 // Include Files                                                        /*{{{*/
  13 #include <config.h>
  14
  15 #include <apt-pkg/fileutl.h>
  16 #include <apt-pkg/acquire-method.h>
  17 #include <apt-pkg/error.h>
  18 #include <apt-pkg/hashes.h>
  19 #include <apt-pkg/netrc.h>
  20 #include <apt-pkg/configuration.h>
  21 #include <apt-pkg/macros.h>
  22 #include <apt-pkg/strutl.h>
  23 #include <apt-pkg/proxy.h>
  24
  25 #include <sys/stat.h>
  26 #include <sys/time.h>
  27 #include <unistd.h>
  28 #include <stdio.h>
  29 #include <iostream>
  30 #include <sstream>
  31 #include <ctype.h>
  32 #include <stdlib.h>
  33
  34 #include "https.h"
  35
  36 #include <apti18n.h>
  37                                                                         /*}}}*/
  38 using namespace std;
  39
  40 bool HttpsMethod::Configuration(std::string Message)
  41 {
  42    if (pkgAcqMethod::Configuration(Message) == false)
  43       return false;
  44
  45    DropPrivsOrDie();
  46
  47    return true;
  48 }
  49
  50 size_t
  51 HttpsMethod::parse_header(void *buffer, size_t size, size_t nmemb, void *userp)
  52 {
  53    size_t len = size * nmemb;
  54    HttpsMethod *me = (HttpsMethod *)userp;
  55    std::string line((char*) buffer, len);
  56    for (--len; len > 0; --len)
  57       if (isspace(line[len]) == 0)
  58       {
  59          ++len;
  60          break;
  61       }
  62    line.erase(len);
  63
  64    if (line.empty() == true)
  65    {
  66       if (me->Server->Result != 416 && me->Server->StartPos != 0)
  67          ;
  68       else if (me->Server->Result == 416 && me->Server->Size == me->File->FileSize())
  69       {
  70          me->Server->Result = 200;
  71          me->Server->StartPos = me->Server->Size;
  72       }
  73       else
  74          me->Server->StartPos = 0;
  75
  76       me->File->Truncate(me->Server->StartPos);
  77       me->File->Seek(me->Server->StartPos);
  78    }
  79    else if (me->Server->HeaderLine(line) == false)
  80       return 0;
  81
  82    return size*nmemb;
  83 }
  84
  85 size_t
  86 HttpsMethod::write_data(void *buffer, size_t size, size_t nmemb, void *userp)
  87 {
  88    HttpsMethod *me = (HttpsMethod *)userp;
  89
  90    if (me->Res.Size == 0)
  91       me->URIStart(me->Res);
  92    if(me->File->Write(buffer, size*nmemb) != true)
  93       return false;
  94
  95    if(me->Queue->MaximumSize > 0 && me->File->Tell() > me->Queue->MaximumSize)
  96    {
  97       me->SetFailReason("MaximumSizeExceeded");
  98       return _error->Error("Writing more data than expected (%llu > %llu)",
  99                            me->TotalWritten, me->Queue->MaximumSize);
 100    }
 101    return size*nmemb;
 102 }
 103
 104 int
 105 HttpsMethod::progress_callback(void *clientp, double dltotal, double /*dlnow*/,
 106                               double /*ultotal*/, double /*ulnow*/)
 107 {
 108    HttpsMethod *me = (HttpsMethod *)clientp;
 109    if(dltotal > 0 && me->Res.Size == 0) {
 110       me->Res.Size = (unsigned long long)dltotal;
 111    }
 112    return 0;
 113 }
 114
 115 // HttpsServerState::HttpsServerState - Constructor                     /*{{{*/
 116 HttpsServerState::HttpsServerState(URI Srv,HttpsMethod * /*Owner*/) : ServerState(Srv, NULL)
 117 {
 118    TimeOut = _config->FindI("Acquire::https::Timeout",TimeOut);
 119    Reset();
 120 }
 121                                                                         /*}}}*/
 122
 123 void HttpsMethod::SetupProxy()                                          /*{{{*/
 124 {
 125    URI ServerName = Queue->Uri;
 126
 127    // Determine the proxy setting
 128    AutoDetectProxy(ServerName);
 129
 130    // Curl should never read proxy settings from the environment, as
 131    // we determine which proxy to use.  Do this for consistency among
 132    // methods and prevent an environment variable overriding a
 133    // no-proxy ("DIRECT") setting in apt.conf.
 134    curl_easy_setopt(curl, CURLOPT_PROXY, "");
 135
 136    // Determine the proxy setting - try https first, fallback to http and use env at last
 137    string UseProxy = _config->Find("Acquire::https::Proxy::" + ServerName.Host,
 138                                    _config->Find("Acquire::http::Proxy::" + ServerName.Host).c_str());
 139
 140    if (UseProxy.empty() == true)
 141       UseProxy = _config->Find("Acquire::https::Proxy", _config->Find("Acquire::http::Proxy").c_str());
 142
 143    // User want to use NO proxy, so nothing to setup
 144    if (UseProxy == "DIRECT")
 145       return;
 146
 147    if (UseProxy.empty() == false)
 148    {
 149       // Parse no_proxy, a comma (,) separated list of domains we don't want to use
 150       // a proxy for so we stop right here if it is in the list
 151       if (getenv("no_proxy") != 0 && CheckDomainList(ServerName.Host,getenv("no_proxy")) == true)
 152          return;
 153    } else {
 154       const char* result = getenv("https_proxy");
 155       // FIXME: Fall back to http_proxy is to remain compatible with
 156       // existing setups and behaviour of apt.conf.  This should be
 157       // deprecated in the future (including apt.conf).  Most other
 158       // programs do not fall back to http proxy settings and neither
 159       // should Apt.
 160       if (result == NULL)
 161          result = getenv("http_proxy");
 162       UseProxy = result == NULL ? "" : result;
 163    }
 164
 165    // Determine what host and port to use based on the proxy settings
 166    if (UseProxy.empty() == false)
 167    {
 168       Proxy = UseProxy;
 169       if (Proxy.Port != 1)
 170          curl_easy_setopt(curl, CURLOPT_PROXYPORT, Proxy.Port);
 171       curl_easy_setopt(curl, CURLOPT_PROXY, Proxy.Host.c_str());
 172       if (Proxy.User.empty() == false || Proxy.Password.empty() == false)
 173       {
 174          curl_easy_setopt(curl, CURLOPT_PROXYUSERNAME, Proxy.User.c_str());
 175          curl_easy_setopt(curl, CURLOPT_PROXYPASSWORD, Proxy.Password.c_str());
 176       }
 177    }
 178 }                                                                       /*}}}*/
 179 // HttpsMethod::Fetch - Fetch an item                                   /*{{{*/
 180 // ---------------------------------------------------------------------
 181 /* This adds an item to the pipeline. We keep the pipeline at a fixed
 182    depth. */
 183 bool HttpsMethod::Fetch(FetchItem *Itm)
 184 {
 185    struct stat SBuf;
 186    struct curl_slist *headers=NULL;
 187    char curl_errorstr[CURL_ERROR_SIZE];
 188    URI Uri = Itm->Uri;
 189    string remotehost = Uri.Host;
 190
 191    // TODO:
 192    //       - http::Pipeline-Depth
 193    //       - error checking/reporting
 194    //       - more debug options? (CURLOPT_DEBUGFUNCTION?)
 195
 196    curl_easy_reset(curl);
 197    SetupProxy();
 198
 199    maybe_add_auth (Uri, _config->FindFile("Dir::Etc::netrc"));
 200
 201    // callbacks
 202    curl_easy_setopt(curl, CURLOPT_URL, static_cast<string>(Uri).c_str());
 203    curl_easy_setopt(curl, CURLOPT_HEADERFUNCTION, parse_header);
 204    curl_easy_setopt(curl, CURLOPT_WRITEHEADER, this);
 205    curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_data);
 206    curl_easy_setopt(curl, CURLOPT_WRITEDATA, this);
 207    curl_easy_setopt(curl, CURLOPT_PROGRESSFUNCTION, progress_callback);
 208    curl_easy_setopt(curl, CURLOPT_PROGRESSDATA, this);
 209    // options
 210    curl_easy_setopt(curl, CURLOPT_NOPROGRESS, false);
 211    curl_easy_setopt(curl, CURLOPT_FILETIME, true);
 212    // only allow curl to handle https, not the other stuff it supports
 213    curl_easy_setopt(curl, CURLOPT_PROTOCOLS, CURLPROTO_HTTPS);
 214    curl_easy_setopt(curl, CURLOPT_REDIR_PROTOCOLS, CURLPROTO_HTTPS);
 215
 216    // SSL parameters are set by default to the common (non mirror-specific) value
 217    // if available (or a default one) and gets overload by mirror-specific ones.
 218
 219    // File containing the list of trusted CA.
 220    string cainfo = _config->Find("Acquire::https::CaInfo","");
 221    string knob = "Acquire::https::"+remotehost+"::CaInfo";
 222    cainfo = _config->Find(knob.c_str(),cainfo.c_str());
 223    if(cainfo.empty() == false)
 224       curl_easy_setopt(curl, CURLOPT_CAINFO,cainfo.c_str());
 225
 226    // Check server certificate against previous CA list ...
 227    bool peer_verify = _config->FindB("Acquire::https::Verify-Peer",true);
 228    knob = "Acquire::https::" + remotehost + "::Verify-Peer";
 229    peer_verify = _config->FindB(knob.c_str(), peer_verify);
 230    curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, peer_verify);
 231
 232    // ... and hostname against cert CN or subjectAltName
 233    bool verify = _config->FindB("Acquire::https::Verify-Host",true);
 234    knob = "Acquire::https::"+remotehost+"::Verify-Host";
 235    verify = _config->FindB(knob.c_str(),verify);
 236    int const default_verify = (verify == true) ? 2 : 0;
 237    curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, default_verify);
 238
 239    // Also enforce issuer of server certificate using its cert
 240    string issuercert = _config->Find("Acquire::https::IssuerCert","");
 241    knob = "Acquire::https::"+remotehost+"::IssuerCert";
 242    issuercert = _config->Find(knob.c_str(),issuercert.c_str());
 243    if(issuercert.empty() == false)
 244       curl_easy_setopt(curl, CURLOPT_ISSUERCERT,issuercert.c_str());
 245
 246    // For client authentication, certificate file ...
 247    string pem = _config->Find("Acquire::https::SslCert","");
 248    knob = "Acquire::https::"+remotehost+"::SslCert";
 249    pem = _config->Find(knob.c_str(),pem.c_str());
 250    if(pem.empty() == false)
 251       curl_easy_setopt(curl, CURLOPT_SSLCERT, pem.c_str());
 252
 253    // ... and associated key.
 254    string key = _config->Find("Acquire::https::SslKey","");
 255    knob = "Acquire::https::"+remotehost+"::SslKey";
 256    key = _config->Find(knob.c_str(),key.c_str());
 257    if(key.empty() == false)
 258       curl_easy_setopt(curl, CURLOPT_SSLKEY, key.c_str());
 259
 260    // Allow forcing SSL version to SSLv3 or TLSv1 (SSLv2 is not
 261    // supported by GnuTLS).
 262    long final_version = CURL_SSLVERSION_DEFAULT;
 263    string sslversion = _config->Find("Acquire::https::SslForceVersion","");
 264    knob = "Acquire::https::"+remotehost+"::SslForceVersion";
 265    sslversion = _config->Find(knob.c_str(),sslversion.c_str());
 266    if(sslversion == "TLSv1")
 267      final_version = CURL_SSLVERSION_TLSv1;
 268    else if(sslversion == "SSLv3")
 269      final_version = CURL_SSLVERSION_SSLv3;
 270    curl_easy_setopt(curl, CURLOPT_SSLVERSION, final_version);
 271
 272    // CRL file
 273    string crlfile = _config->Find("Acquire::https::CrlFile","");
 274    knob = "Acquire::https::"+remotehost+"::CrlFile";
 275    crlfile = _config->Find(knob.c_str(),crlfile.c_str());
 276    if(crlfile.empty() == false)
 277       curl_easy_setopt(curl, CURLOPT_CRLFILE, crlfile.c_str());
 278
 279    // cache-control
 280    if(_config->FindB("Acquire::https::No-Cache",
 281         _config->FindB("Acquire::http::No-Cache",false)) == false)
 282    {
 283       // cache enabled
 284       if (_config->FindB("Acquire::https::No-Store",
 285                 _config->FindB("Acquire::http::No-Store",false)) == true)
 286          headers = curl_slist_append(headers,"Cache-Control: no-store");
 287       stringstream ss;
 288       ioprintf(ss, "Cache-Control: max-age=%u", _config->FindI("Acquire::https::Max-Age",
 289                 _config->FindI("Acquire::http::Max-Age",0)));
 290       headers = curl_slist_append(headers, ss.str().c_str());
 291    } else {
 292       // cache disabled by user
 293       headers = curl_slist_append(headers, "Cache-Control: no-cache");
 294       headers = curl_slist_append(headers, "Pragma: no-cache");
 295    }
 296    curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
 297
 298    // speed limit
 299    int const dlLimit = _config->FindI("Acquire::https::Dl-Limit",
 300                 _config->FindI("Acquire::http::Dl-Limit",0))*1024;
 301    if (dlLimit > 0)
 302       curl_easy_setopt(curl, CURLOPT_MAX_RECV_SPEED_LARGE, dlLimit);
 303
 304    // set header
 305    curl_easy_setopt(curl, CURLOPT_USERAGENT,
 306         _config->Find("Acquire::https::User-Agent",
 307                 _config->Find("Acquire::http::User-Agent",
 308                         "Debian APT-CURL/1.0 (" PACKAGE_VERSION ")").c_str()).c_str());
 309
 310    // set timeout
 311    int const timeout = _config->FindI("Acquire::https::Timeout",
 312                 _config->FindI("Acquire::http::Timeout",120));
 313    curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT, timeout);
 314    //set really low lowspeed timeout (see #497983)
 315    curl_easy_setopt(curl, CURLOPT_LOW_SPEED_LIMIT, DL_MIN_SPEED);
 316    curl_easy_setopt(curl, CURLOPT_LOW_SPEED_TIME, timeout);
 317
 318    // set redirect options and default to 10 redirects
 319    bool const AllowRedirect = _config->FindB("Acquire::https::AllowRedirect",
 320         _config->FindB("Acquire::http::AllowRedirect",true));
 321    curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, AllowRedirect);
 322    curl_easy_setopt(curl, CURLOPT_MAXREDIRS, 10);
 323
 324    // debug
 325    if(_config->FindB("Debug::Acquire::https", false))
 326       curl_easy_setopt(curl, CURLOPT_VERBOSE, true);
 327
 328    // error handling
 329    curl_errorstr[0] = '\0';
 330    curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, curl_errorstr);
 331
 332    // If we ask for uncompressed files servers might respond with content-
 333    // negotiation which lets us end up with compressed files we do not support,
 334    // see 657029, 657560 and co, so if we have no extension on the request
 335    // ask for text only. As a sidenote: If there is nothing to negotate servers
 336    // seem to be nice and ignore it.
 337    if (_config->FindB("Acquire::https::SendAccept", _config->FindB("Acquire::http::SendAccept", true)) == true)
 338    {
 339       size_t const filepos = Itm->Uri.find_last_of('/');
 340       string const file = Itm->Uri.substr(filepos + 1);
 341       if (flExtension(file) == file)
 342          headers = curl_slist_append(headers, "Accept: text/*");
 343    }
 344
 345    // if we have the file send an if-range query with a range header
 346    if (stat(Itm->DestFile.c_str(),&SBuf) >= 0 && SBuf.st_size > 0)
 347    {
 348       std::string Buf;
 349       strprintf(Buf, "Range: bytes=%lli-", (long long) SBuf.st_size);
 350       headers = curl_slist_append(headers, Buf.c_str());
 351       strprintf(Buf, "If-Range: %s", TimeRFC1123(SBuf.st_mtime).c_str());
 352       headers = curl_slist_append(headers, Buf.c_str());
 353    }
 354    else if(Itm->LastModified > 0)
 355    {
 356       curl_easy_setopt(curl, CURLOPT_TIMECONDITION, CURL_TIMECOND_IFMODSINCE);
 357       curl_easy_setopt(curl, CURLOPT_TIMEVALUE, Itm->LastModified);
 358    }
 359
 360    // go for it - if the file exists, append on it
 361    File = new FileFd(Itm->DestFile, FileFd::WriteAny);
 362    Server = new HttpsServerState(Itm->Uri, this);
 363
 364    // keep apt updated
 365    Res.Filename = Itm->DestFile;
 366
 367    // get it!
 368    CURLcode success = curl_easy_perform(curl);
 369
 370    // If the server returns 200 OK but the If-Modified-Since condition is not
 371    // met, CURLINFO_CONDITION_UNMET will be set to 1
 372    long curl_condition_unmet = 0;
 373    curl_easy_getinfo(curl, CURLINFO_CONDITION_UNMET, &curl_condition_unmet);
 374
 375    File->Close();
 376    curl_slist_free_all(headers);
 377
 378    // cleanup
 379    if (success != 0)
 380    {
 381       _error->Error("%s", curl_errorstr);
 382       unlink(File->Name().c_str());
 383       return false;
 384    }
 385
 386    // server says file not modified
 387    if (Server->Result == 304 || curl_condition_unmet == 1)
 388    {
 389       unlink(File->Name().c_str());
 390       Res.IMSHit = true;
 391       Res.LastModified = Itm->LastModified;
 392       Res.Size = 0;
 393       URIDone(Res);
 394       return true;
 395    }
 396    Res.IMSHit = false;
 397
 398    if (Server->Result != 200 && // OK
 399          Server->Result != 206 && // Partial
 400          Server->Result != 416) // invalid Range
 401    {
 402       char err[255];
 403       snprintf(err, sizeof(err) - 1, "HttpError%i", Server->Result);
 404       SetFailReason(err);
 405       _error->Error("%s", err);
 406       // unlink, no need keep 401/404 page content in partial/
 407       unlink(File->Name().c_str());
 408       return false;
 409    }
 410
 411    struct stat resultStat;
 412    if (unlikely(stat(File->Name().c_str(), &resultStat) != 0))
 413    {
 414       _error->Errno("stat", "Unable to access file %s", File->Name().c_str());
 415       return false;
 416    }
 417    Res.Size = resultStat.st_size;
 418
 419    // invalid range-request
 420    if (Server->Result == 416)
 421    {
 422       unlink(File->Name().c_str());
 423       Res.Size = 0;
 424       delete File;
 425       Redirect(Itm->Uri);
 426       return true;
 427    }
 428
 429    // Timestamp
 430    curl_easy_getinfo(curl, CURLINFO_FILETIME, &Res.LastModified);
 431    if (Res.LastModified != -1)
 432    {
 433       struct timeval times[2];
 434       times[0].tv_sec = Res.LastModified;
 435       times[1].tv_sec = Res.LastModified;
 436       times[0].tv_usec = times[1].tv_usec = 0;
 437       utimes(File->Name().c_str(), times);
 438    }
 439    else
 440       Res.LastModified = resultStat.st_mtime;
 441
 442    // take hashes
 443    Hashes Hash;
 444    FileFd Fd(Res.Filename, FileFd::ReadOnly);
 445    Hash.AddFD(Fd);
 446    Res.TakeHashes(Hash);
 447
 448    // keep apt updated
 449    URIDone(Res);
 450
 451    // cleanup
 452    Res.Size = 0;
 453    delete File;
 454
 455    return true;
 456 }
 457
 458 int main()
 459 {
 460    setlocale(LC_ALL, "");
 461
 462    HttpsMethod Mth;
 463    curl_global_init(CURL_GLOBAL_SSL) ;
 464
 465    return Mth.Run();
 466 }
 467