doc/sources.list.5.xml: merge typo fixes
[ntk/apt.git] / 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 aquire method for APT.
7
8 It uses libcurl
9
10 ##################################################################### */
11 /*}}}*/
12 // Include Files /*{{{*/
13 #include <apt-pkg/fileutl.h>
14 #include <apt-pkg/acquire-method.h>
15 #include <apt-pkg/error.h>
16 #include <apt-pkg/hashes.h>
17 #include <apt-pkg/netrc.h>
18
19 #include <sys/stat.h>
20 #include <sys/time.h>
21 #include <utime.h>
22 #include <unistd.h>
23 #include <signal.h>
24 #include <stdio.h>
25 #include <errno.h>
26 #include <string.h>
27 #include <iostream>
28 #include <apti18n.h>
29 #include <sstream>
30
31 #include "config.h"
32 #include "https.h"
33
34 /*}}}*/
35 using namespace std;
36
37 size_t
38 HttpsMethod::write_data(void *buffer, size_t size, size_t nmemb, void *userp)
39 {
40 HttpsMethod *me = (HttpsMethod *)userp;
41
42 if(me->File->Write(buffer, size*nmemb) != true)
43 return false;
44
45 return size*nmemb;
46 }
47
48 int
49 HttpsMethod::progress_callback(void *clientp, double dltotal, double dlnow,
50 double ultotal, double ulnow)
51 {
52 HttpsMethod *me = (HttpsMethod *)clientp;
53 if(dltotal > 0 && me->Res.Size == 0) {
54 me->Res.Size = (unsigned long)dltotal;
55 me->URIStart(me->Res);
56 }
57 return 0;
58 }
59
60 void HttpsMethod::SetupProxy() /*{{{*/
61 {
62 URI ServerName = Queue->Uri;
63
64 // Determine the proxy setting - try https first, fallback to http and use env at last
65 string UseProxy = _config->Find("Acquire::https::Proxy::" + ServerName.Host,
66 _config->Find("Acquire::http::Proxy::" + ServerName.Host).c_str());
67
68 if (UseProxy.empty() == true)
69 UseProxy = _config->Find("Acquire::https::Proxy", _config->Find("Acquire::http::Proxy").c_str());
70
71 // User want to use NO proxy, so nothing to setup
72 if (UseProxy == "DIRECT")
73 return;
74
75 if (UseProxy.empty() == false)
76 {
77 // Parse no_proxy, a comma (,) separated list of domains we don't want to use
78 // a proxy for so we stop right here if it is in the list
79 if (getenv("no_proxy") != 0 && CheckDomainList(ServerName.Host,getenv("no_proxy")) == true)
80 return;
81 } else {
82 const char* result = getenv("http_proxy");
83 UseProxy = result == NULL ? "" : result;
84 }
85
86 // Determine what host and port to use based on the proxy settings
87 if (UseProxy.empty() == false)
88 {
89 Proxy = UseProxy;
90 if (Proxy.Port != 1)
91 curl_easy_setopt(curl, CURLOPT_PROXYPORT, Proxy.Port);
92 curl_easy_setopt(curl, CURLOPT_PROXY, Proxy.Host.c_str());
93 }
94 } /*}}}*/
95 // HttpsMethod::Fetch - Fetch an item /*{{{*/
96 // ---------------------------------------------------------------------
97 /* This adds an item to the pipeline. We keep the pipeline at a fixed
98 depth. */
99 bool HttpsMethod::Fetch(FetchItem *Itm)
100 {
101 stringstream ss;
102 struct stat SBuf;
103 struct curl_slist *headers=NULL;
104 char curl_errorstr[CURL_ERROR_SIZE];
105 long curl_responsecode;
106 URI Uri = Itm->Uri;
107 string remotehost = Uri.Host;
108
109 // TODO:
110 // - http::Pipeline-Depth
111 // - error checking/reporting
112 // - more debug options? (CURLOPT_DEBUGFUNCTION?)
113
114 curl_easy_reset(curl);
115 SetupProxy();
116
117 maybe_add_auth (Uri, _config->FindFile("Dir::Etc::netrc"));
118
119 // callbacks
120 curl_easy_setopt(curl, CURLOPT_URL, static_cast<string>(Uri).c_str());
121 curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_data);
122 curl_easy_setopt(curl, CURLOPT_WRITEDATA, this);
123 curl_easy_setopt(curl, CURLOPT_PROGRESSFUNCTION, progress_callback);
124 curl_easy_setopt(curl, CURLOPT_PROGRESSDATA, this);
125 curl_easy_setopt(curl, CURLOPT_NOPROGRESS, false);
126 curl_easy_setopt(curl, CURLOPT_FAILONERROR, true);
127 curl_easy_setopt(curl, CURLOPT_FILETIME, true);
128
129 // SSL parameters are set by default to the common (non mirror-specific) value
130 // if available (or a default one) and gets overload by mirror-specific ones.
131
132 // File containing the list of trusted CA.
133 string cainfo = _config->Find("Acquire::https::CaInfo","");
134 string knob = "Acquire::https::"+remotehost+"::CaInfo";
135 cainfo = _config->Find(knob.c_str(),cainfo.c_str());
136 if(cainfo != "")
137 curl_easy_setopt(curl, CURLOPT_CAINFO,cainfo.c_str());
138
139 // Check server certificate against previous CA list ...
140 bool peer_verify = _config->FindB("Acquire::https::Verify-Peer",true);
141 knob = "Acquire::https::" + remotehost + "::Verify-Peer";
142 peer_verify = _config->FindB(knob.c_str(), peer_verify);
143 curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, peer_verify);
144
145 // ... and hostname against cert CN or subjectAltName
146 int default_verify = 2;
147 bool verify = _config->FindB("Acquire::https::Verify-Host",true);
148 knob = "Acquire::https::"+remotehost+"::Verify-Host";
149 verify = _config->FindB(knob.c_str(),verify);
150 if (!verify)
151 default_verify = 0;
152 curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, verify);
153
154 // For client authentication, certificate file ...
155 string pem = _config->Find("Acquire::https::SslCert","");
156 knob = "Acquire::https::"+remotehost+"::SslCert";
157 pem = _config->Find(knob.c_str(),pem.c_str());
158 if(pem != "")
159 curl_easy_setopt(curl, CURLOPT_SSLCERT, pem.c_str());
160
161 // ... and associated key.
162 string key = _config->Find("Acquire::https::SslKey","");
163 knob = "Acquire::https::"+remotehost+"::SslKey";
164 key = _config->Find(knob.c_str(),key.c_str());
165 if(key != "")
166 curl_easy_setopt(curl, CURLOPT_SSLKEY, key.c_str());
167
168 // Allow forcing SSL version to SSLv3 or TLSv1 (SSLv2 is not
169 // supported by GnuTLS).
170 long final_version = CURL_SSLVERSION_DEFAULT;
171 string sslversion = _config->Find("Acquire::https::SslForceVersion","");
172 knob = "Acquire::https::"+remotehost+"::SslForceVersion";
173 sslversion = _config->Find(knob.c_str(),sslversion.c_str());
174 if(sslversion == "TLSv1")
175 final_version = CURL_SSLVERSION_TLSv1;
176 else if(sslversion == "SSLv3")
177 final_version = CURL_SSLVERSION_SSLv3;
178 curl_easy_setopt(curl, CURLOPT_SSLVERSION, final_version);
179
180 // cache-control
181 if(_config->FindB("Acquire::https::No-Cache",
182 _config->FindB("Acquire::http::No-Cache",false)) == false)
183 {
184 // cache enabled
185 if (_config->FindB("Acquire::https::No-Store",
186 _config->FindB("Acquire::http::No-Store",false)) == true)
187 headers = curl_slist_append(headers,"Cache-Control: no-store");
188 ioprintf(ss, "Cache-Control: max-age=%u", _config->FindI("Acquire::https::Max-Age",
189 _config->FindI("Acquire::http::Max-Age",0)));
190 headers = curl_slist_append(headers, ss.str().c_str());
191 } else {
192 // cache disabled by user
193 headers = curl_slist_append(headers, "Cache-Control: no-cache");
194 headers = curl_slist_append(headers, "Pragma: no-cache");
195 }
196 curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
197
198 // speed limit
199 int dlLimit = _config->FindI("Acquire::https::Dl-Limit",
200 _config->FindI("Acquire::http::Dl-Limit",0))*1024;
201 if (dlLimit > 0)
202 curl_easy_setopt(curl, CURLOPT_MAX_RECV_SPEED_LARGE, dlLimit);
203
204 // set header
205 curl_easy_setopt(curl, CURLOPT_USERAGENT,
206 _config->Find("Acquire::https::User-Agent",
207 _config->Find("Acquire::http::User-Agent",
208 "Debian APT-CURL/1.0 ("VERSION")").c_str()).c_str());
209
210 // set timeout
211 int timeout = _config->FindI("Acquire::https::Timeout",
212 _config->FindI("Acquire::http::Timeout",120));
213 curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT, timeout);
214 //set really low lowspeed timeout (see #497983)
215 curl_easy_setopt(curl, CURLOPT_LOW_SPEED_LIMIT, DL_MIN_SPEED);
216 curl_easy_setopt(curl, CURLOPT_LOW_SPEED_TIME, timeout);
217
218 // set redirect options and default to 10 redirects
219 bool AllowRedirect = _config->FindB("Acquire::https::AllowRedirect",
220 _config->FindB("Acquire::http::AllowRedirect",true));
221 curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, AllowRedirect);
222 curl_easy_setopt(curl, CURLOPT_MAXREDIRS, 10);
223
224 // debug
225 if(_config->FindB("Debug::Acquire::https", false))
226 curl_easy_setopt(curl, CURLOPT_VERBOSE, true);
227
228 // error handling
229 curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, curl_errorstr);
230
231 // if we have the file send an if-range query with a range header
232 if (stat(Itm->DestFile.c_str(),&SBuf) >= 0 && SBuf.st_size > 0)
233 {
234 char Buf[1000];
235 sprintf(Buf,"Range: bytes=%li-\r\nIf-Range: %s\r\n",
236 (long)SBuf.st_size - 1,
237 TimeRFC1123(SBuf.st_mtime).c_str());
238 headers = curl_slist_append(headers, Buf);
239 }
240 else if(Itm->LastModified > 0)
241 {
242 curl_easy_setopt(curl, CURLOPT_TIMECONDITION, CURL_TIMECOND_IFMODSINCE);
243 curl_easy_setopt(curl, CURLOPT_TIMEVALUE, Itm->LastModified);
244 }
245
246 // go for it - if the file exists, append on it
247 File = new FileFd(Itm->DestFile, FileFd::WriteAny);
248 if (File->Size() > 0)
249 File->Seek(File->Size() - 1);
250
251 // keep apt updated
252 Res.Filename = Itm->DestFile;
253
254 // get it!
255 CURLcode success = curl_easy_perform(curl);
256 curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &curl_responsecode);
257
258 long curl_servdate;
259 curl_easy_getinfo(curl, CURLINFO_FILETIME, &curl_servdate);
260
261 // cleanup
262 if(success != 0)
263 {
264 _error->Error("%s", curl_errorstr);
265 Fail();
266 return true;
267 }
268 File->Close();
269
270 // Timestamp
271 struct utimbuf UBuf;
272 if (curl_servdate != -1) {
273 UBuf.actime = curl_servdate;
274 UBuf.modtime = curl_servdate;
275 utime(File->Name().c_str(),&UBuf);
276 }
277
278 // check the downloaded result
279 struct stat Buf;
280 if (stat(File->Name().c_str(),&Buf) == 0)
281 {
282 Res.Filename = File->Name();
283 Res.LastModified = Buf.st_mtime;
284 Res.IMSHit = false;
285 if (curl_responsecode == 304)
286 {
287 unlink(File->Name().c_str());
288 Res.IMSHit = true;
289 Res.LastModified = Itm->LastModified;
290 Res.Size = 0;
291 URIDone(Res);
292 return true;
293 }
294 Res.Size = Buf.st_size;
295 }
296
297 // take hashes
298 Hashes Hash;
299 FileFd Fd(Res.Filename, FileFd::ReadOnly);
300 Hash.AddFD(Fd.Fd(), Fd.Size());
301 Res.TakeHashes(Hash);
302
303 // keep apt updated
304 URIDone(Res);
305
306 // cleanup
307 Res.Size = 0;
308 delete File;
309 curl_slist_free_all(headers);
310
311 return true;
312 };
313
314 int main()
315 {
316 setlocale(LC_ALL, "");
317
318 HttpsMethod Mth;
319 curl_global_init(CURL_GLOBAL_SSL) ;
320
321 return Mth.Run();
322 }
323
324