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