blob: 9dcd654999ea221475659bf611df75ff759b6b3b [file] [log] [blame]
Alex Deymoaea4c1c2015-08-19 20:24:43 -07001//
2// Copyright (C) 2009 The Android Open Source Project
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8// http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15//
rspangler@google.com49fdf182009-10-10 00:57:34 +000016
Alex Deymo14c0da82016-07-20 16:45:45 -070017#include "update_engine/libcurl_http_fetcher.h"
Andrew de los Reyesd57d1472010-10-21 13:34:08 -070018
Alex Deymo63cfcf42017-02-23 15:29:47 -080019#include <sys/types.h>
20#include <unistd.h>
21
adlr@google.comc98a7ed2009-12-04 18:54:03 +000022#include <algorithm>
Andrew de los Reyesd57d1472010-10-21 13:34:08 -070023#include <string>
24
Alex Vakulenko4906c1c2014-08-21 13:17:44 -070025#include <base/bind.h>
Alex Deymoc00c98a2015-03-17 17:38:00 -070026#include <base/format_macros.h>
Alex Deymo60ca1a72015-06-18 18:19:15 -070027#include <base/location.h>
Andrew de los Reyesd57d1472010-10-21 13:34:08 -070028#include <base/logging.h>
Alex Vakulenko75039d72014-03-25 12:36:28 -070029#include <base/strings/string_util.h>
30#include <base/strings/stringprintf.h>
Andrew de los Reyesd57d1472010-10-21 13:34:08 -070031
Alex Deymo63cfcf42017-02-23 15:29:47 -080032#ifdef __ANDROID__
33#include <cutils/qtaguid.h>
34#endif // __ANDROID__
35
Alex Deymo14c0da82016-07-20 16:45:45 -070036#include "update_engine/certificate_checker.h"
Alex Deymo39910dc2015-11-09 17:04:30 -080037#include "update_engine/common/hardware_interface.h"
38#include "update_engine/common/platform_constants.h"
adlr@google.comc98a7ed2009-12-04 18:54:03 +000039
Alex Deymo60ca1a72015-06-18 18:19:15 -070040using base::TimeDelta;
Alex Vakulenko3f39d5c2015-10-13 09:27:13 -070041using brillo::MessageLoop;
Alex Deymoc4acdf42014-05-28 21:07:10 -070042using std::max;
Andrew de los Reyesd57d1472010-10-21 13:34:08 -070043using std::string;
rspangler@google.com49fdf182009-10-10 00:57:34 +000044
45// This is a concrete implementation of HttpFetcher that uses libcurl to do the
46// http work.
47
48namespace chromeos_update_engine {
49
Andrew de los Reyes9bbd1872010-07-16 14:52:29 -070050namespace {
Alex Deymo63cfcf42017-02-23 15:29:47 -080051
Andrew de los Reyes5d0783d2010-11-29 18:14:16 -080052const int kNoNetworkRetrySeconds = 10;
Alex Deymo63cfcf42017-02-23 15:29:47 -080053
54// Socket tag used by all network sockets. See qtaguid kernel module for stats.
55const int kUpdateEngineSocketTag = 0x55417243; // "CrAU" in little-endian.
56
57// libcurl's CURLOPT_SOCKOPTFUNCTION callback function. Called after the socket
58// is created but before it is connected. This callback tags the created socket
59// so the network usage can be tracked in Android.
60int LibcurlSockoptCallback(void* /* clientp */,
61 curl_socket_t curlfd,
62 curlsocktype /* purpose */) {
63#ifdef __ANDROID__
64 qtaguid_tagSocket(curlfd, kUpdateEngineSocketTag, getuid());
65#endif // __ANDROID__
66 return CURL_SOCKOPT_OK;
67}
68
Alex Vakulenkod2779df2014-06-16 13:19:00 -070069} // namespace
Andrew de los Reyes9bbd1872010-07-16 14:52:29 -070070
Alex Deymo33e91e72015-12-01 18:26:08 -030071LibcurlHttpFetcher::LibcurlHttpFetcher(ProxyResolver* proxy_resolver,
72 HardwareInterface* hardware)
73 : HttpFetcher(proxy_resolver), hardware_(hardware) {
Alex Deymoc1c17b42015-11-23 03:53:15 -030074 // Dev users want a longer timeout (180 seconds) because they may
75 // be waiting on the dev server to build an image.
76 if (!hardware_->IsOfficialBuild())
77 low_speed_time_seconds_ = kDownloadDevModeLowSpeedTimeSeconds;
Alex Deymo46a9aae2016-05-04 20:20:11 -070078 if (hardware_->IsOOBEEnabled() && !hardware_->IsOOBEComplete(nullptr))
Alex Deymoc1c17b42015-11-23 03:53:15 -030079 max_retry_count_ = kDownloadMaxRetryCountOobeNotComplete;
80}
81
rspangler@google.com49fdf182009-10-10 00:57:34 +000082LibcurlHttpFetcher::~LibcurlHttpFetcher() {
Darin Petkov9ce452b2010-11-17 14:33:28 -080083 LOG_IF(ERROR, transfer_in_progress_)
84 << "Destroying the fetcher while a transfer is in progress.";
Alex Deymo71f67622017-02-03 21:30:24 -080085 CancelProxyResolution();
rspangler@google.com49fdf182009-10-10 00:57:34 +000086 CleanUp();
87}
88
Alex Deymof329b932014-10-30 01:37:48 -070089bool LibcurlHttpFetcher::GetProxyType(const string& proxy,
Gilad Arnold59d9e012013-07-23 16:41:43 -070090 curl_proxytype* out_type) {
Alex Deymo56ccb072016-02-05 00:50:48 -080091 if (base::StartsWith(
92 proxy, "socks5://", base::CompareCase::INSENSITIVE_ASCII) ||
93 base::StartsWith(
94 proxy, "socks://", base::CompareCase::INSENSITIVE_ASCII)) {
Gilad Arnold59d9e012013-07-23 16:41:43 -070095 *out_type = CURLPROXY_SOCKS5_HOSTNAME;
96 return true;
97 }
Alex Deymo56ccb072016-02-05 00:50:48 -080098 if (base::StartsWith(
99 proxy, "socks4://", base::CompareCase::INSENSITIVE_ASCII)) {
Gilad Arnold59d9e012013-07-23 16:41:43 -0700100 *out_type = CURLPROXY_SOCKS4A;
101 return true;
102 }
Alex Deymo56ccb072016-02-05 00:50:48 -0800103 if (base::StartsWith(
104 proxy, "http://", base::CompareCase::INSENSITIVE_ASCII) ||
105 base::StartsWith(
106 proxy, "https://", base::CompareCase::INSENSITIVE_ASCII)) {
Gilad Arnold59d9e012013-07-23 16:41:43 -0700107 *out_type = CURLPROXY_HTTP;
108 return true;
109 }
Alex Deymo56ccb072016-02-05 00:50:48 -0800110 if (base::StartsWith(proxy, kNoProxy, base::CompareCase::INSENSITIVE_ASCII)) {
Gilad Arnold59d9e012013-07-23 16:41:43 -0700111 // known failure case. don't log.
112 return false;
113 }
114 LOG(INFO) << "Unknown proxy type: " << proxy;
115 return false;
116}
117
Alex Deymof329b932014-10-30 01:37:48 -0700118void LibcurlHttpFetcher::ResumeTransfer(const string& url) {
Andrew de los Reyes3270f742010-07-15 22:28:14 -0700119 LOG(INFO) << "Starting/Resuming transfer";
rspangler@google.com49fdf182009-10-10 00:57:34 +0000120 CHECK(!transfer_in_progress_);
121 url_ = url;
122 curl_multi_handle_ = curl_multi_init();
123 CHECK(curl_multi_handle_);
124
125 curl_handle_ = curl_easy_init();
126 CHECK(curl_handle_);
Alex Deymof2858572016-02-25 11:20:13 -0800127 ignore_failure_ = false;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000128
Alex Deymo63cfcf42017-02-23 15:29:47 -0800129 // Tag the socket for network usage stats.
130 curl_easy_setopt(
131 curl_handle_, CURLOPT_SOCKOPTFUNCTION, LibcurlSockoptCallback);
132
Andrew de los Reyes45168102010-11-22 11:13:50 -0800133 CHECK(HasProxy());
Gilad Arnoldfbaee242012-04-04 15:59:43 -0700134 bool is_direct = (GetCurrentProxy() == kNoProxy);
135 LOG(INFO) << "Using proxy: " << (is_direct ? "no" : "yes");
136 if (is_direct) {
Andrew de los Reyes45168102010-11-22 11:13:50 -0800137 CHECK_EQ(curl_easy_setopt(curl_handle_,
138 CURLOPT_PROXY,
139 ""), CURLE_OK);
140 } else {
141 CHECK_EQ(curl_easy_setopt(curl_handle_,
142 CURLOPT_PROXY,
143 GetCurrentProxy().c_str()), CURLE_OK);
144 // Curl seems to require us to set the protocol
145 curl_proxytype type;
Gilad Arnold59d9e012013-07-23 16:41:43 -0700146 if (GetProxyType(GetCurrentProxy(), &type)) {
Andrew de los Reyes45168102010-11-22 11:13:50 -0800147 CHECK_EQ(curl_easy_setopt(curl_handle_,
148 CURLOPT_PROXYTYPE,
149 type), CURLE_OK);
150 }
151 }
152
rspangler@google.com49fdf182009-10-10 00:57:34 +0000153 if (post_data_set_) {
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000154 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_POST, 1), CURLE_OK);
155 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_POSTFIELDS,
Alex Vakulenkof68bbbc2015-02-09 12:53:18 -0800156 post_data_.data()),
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000157 CURLE_OK);
158 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_POSTFIELDSIZE,
159 post_data_.size()),
160 CURLE_OK);
Alex Deymofdd6dec2016-03-03 22:35:43 -0800161 }
Gilad Arnold9dd1e7c2012-02-16 12:13:36 -0800162
Alex Deymofdd6dec2016-03-03 22:35:43 -0800163 // Setup extra HTTP headers.
164 if (curl_http_headers_) {
165 curl_slist_free_all(curl_http_headers_);
166 curl_http_headers_ = nullptr;
167 }
168 for (const auto& header : extra_headers_) {
169 // curl_slist_append() copies the string.
170 curl_http_headers_ =
171 curl_slist_append(curl_http_headers_, header.second.c_str());
172 }
173 if (post_data_set_) {
Gilad Arnold9dd1e7c2012-02-16 12:13:36 -0800174 // Set the Content-Type HTTP header, if one was specifically set.
Gilad Arnold9dd1e7c2012-02-16 12:13:36 -0800175 if (post_content_type_ != kHttpContentTypeUnspecified) {
Alex Deymofdd6dec2016-03-03 22:35:43 -0800176 const string content_type_attr = base::StringPrintf(
177 "Content-Type: %s", GetHttpContentTypeString(post_content_type_));
178 curl_http_headers_ =
179 curl_slist_append(curl_http_headers_, content_type_attr.c_str());
Gilad Arnold9dd1e7c2012-02-16 12:13:36 -0800180 } else {
181 LOG(WARNING) << "no content type set, using libcurl default";
182 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000183 }
Alex Deymofdd6dec2016-03-03 22:35:43 -0800184 CHECK_EQ(
185 curl_easy_setopt(curl_handle_, CURLOPT_HTTPHEADER, curl_http_headers_),
186 CURLE_OK);
rspangler@google.com49fdf182009-10-10 00:57:34 +0000187
Gilad Arnolde4ad2502011-12-29 17:08:54 -0800188 if (bytes_downloaded_ > 0 || download_length_) {
189 // Resume from where we left off.
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000190 resume_offset_ = bytes_downloaded_;
Gilad Arnolde4ad2502011-12-29 17:08:54 -0800191 CHECK_GE(resume_offset_, 0);
192
193 // Compute end offset, if one is specified. As per HTTP specification, this
194 // is an inclusive boundary. Make sure it doesn't overflow.
195 size_t end_offset = 0;
196 if (download_length_) {
197 end_offset = static_cast<size_t>(resume_offset_) + download_length_ - 1;
198 CHECK_LE((size_t) resume_offset_, end_offset);
199 }
200
201 // Create a string representation of the desired range.
Alex Deymoc00c98a2015-03-17 17:38:00 -0700202 string range_str = base::StringPrintf(
203 "%" PRIu64 "-", static_cast<uint64_t>(resume_offset_));
204 if (end_offset)
205 range_str += std::to_string(end_offset);
Gilad Arnolde4ad2502011-12-29 17:08:54 -0800206 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_RANGE, range_str.c_str()),
207 CURLE_OK);
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000208 }
209
210 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_WRITEDATA, this), CURLE_OK);
211 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_WRITEFUNCTION,
212 StaticLibcurlWrite), CURLE_OK);
Chris Sosa77f79e82014-06-02 18:16:24 -0700213 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_URL, url_.c_str()),
Andrew de los Reyesd57d1472010-10-21 13:34:08 -0700214 CURLE_OK);
Andrew de los Reyes3270f742010-07-15 22:28:14 -0700215
David Zeuthen34135a92013-08-06 11:16:16 -0700216 // If the connection drops under |low_speed_limit_bps_| (10
217 // bytes/sec by default) for |low_speed_time_seconds_| (90 seconds,
218 // 180 on non-official builds), reconnect.
219 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_LOW_SPEED_LIMIT,
220 low_speed_limit_bps_),
Andrew de los Reyes3270f742010-07-15 22:28:14 -0700221 CURLE_OK);
David Zeuthen34135a92013-08-06 11:16:16 -0700222 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_LOW_SPEED_TIME,
223 low_speed_time_seconds_),
Andrew de los Reyes3270f742010-07-15 22:28:14 -0700224 CURLE_OK);
David Zeuthen34135a92013-08-06 11:16:16 -0700225 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_CONNECTTIMEOUT,
226 connect_timeout_seconds_),
Andrew de los Reyese72f9c02011-04-20 10:47:40 -0700227 CURLE_OK);
Andrew de los Reyes3270f742010-07-15 22:28:14 -0700228
Darin Petkov41c2fcf2010-08-25 13:14:48 -0700229 // By default, libcurl doesn't follow redirections. Allow up to
David Zeuthen34135a92013-08-06 11:16:16 -0700230 // |kDownloadMaxRedirects| redirections.
Darin Petkov3a4016a2010-09-28 13:54:17 -0700231 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_FOLLOWLOCATION, 1), CURLE_OK);
David Zeuthen34135a92013-08-06 11:16:16 -0700232 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_MAXREDIRS,
233 kDownloadMaxRedirects),
Darin Petkov41c2fcf2010-08-25 13:14:48 -0700234 CURLE_OK);
235
Nam T. Nguyen7d623eb2014-05-13 16:06:28 -0700236 // Lock down the appropriate curl options for HTTP or HTTPS depending on
237 // the url.
Alex Deymoc1c17b42015-11-23 03:53:15 -0300238 if (hardware_->IsOfficialBuild()) {
Alex Deymo56ccb072016-02-05 00:50:48 -0800239 if (base::StartsWith(
240 url_, "http://", base::CompareCase::INSENSITIVE_ASCII)) {
Jay Srinivasanb3f55402012-12-03 18:12:04 -0800241 SetCurlOptionsForHttp();
Alex Deymo56ccb072016-02-05 00:50:48 -0800242 } else if (base::StartsWith(
243 url_, "https://", base::CompareCase::INSENSITIVE_ASCII)) {
Jay Srinivasanb3f55402012-12-03 18:12:04 -0800244 SetCurlOptionsForHttps();
Alex Deymo56ccb072016-02-05 00:50:48 -0800245#if !defined(__CHROMEOS__) && !defined(__BRILLO__)
246 } else if (base::StartsWith(
247 url_, "file://", base::CompareCase::INSENSITIVE_ASCII)) {
248 SetCurlOptionsForFile();
249#endif
250 } else {
251 LOG(ERROR) << "Received invalid URI: " << url_;
252 // Lock down to no protocol supported for the transfer.
253 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_PROTOCOLS, 0), CURLE_OK);
254 }
Jay Srinivasanb3f55402012-12-03 18:12:04 -0800255 } else {
Nam T. Nguyen7d623eb2014-05-13 16:06:28 -0700256 LOG(INFO) << "Not setting http(s) curl options because we are "
257 << "running a dev/test image";
Darin Petkovfc7a0ce2010-10-25 10:38:37 -0700258 }
259
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000260 CHECK_EQ(curl_multi_add_handle(curl_multi_handle_, curl_handle_), CURLM_OK);
rspangler@google.com49fdf182009-10-10 00:57:34 +0000261 transfer_in_progress_ = true;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000262}
263
Jay Srinivasanb3f55402012-12-03 18:12:04 -0800264// Lock down only the protocol in case of HTTP.
265void LibcurlHttpFetcher::SetCurlOptionsForHttp() {
266 LOG(INFO) << "Setting up curl options for HTTP";
267 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_PROTOCOLS, CURLPROTO_HTTP),
268 CURLE_OK);
269 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_REDIR_PROTOCOLS,
270 CURLPROTO_HTTP),
271 CURLE_OK);
272}
273
274// Security lock-down in official builds: makes sure that peer certificate
275// verification is enabled, restricts the set of trusted certificates,
276// restricts protocols to HTTPS, restricts ciphers to HIGH.
277void LibcurlHttpFetcher::SetCurlOptionsForHttps() {
278 LOG(INFO) << "Setting up curl options for HTTPS";
279 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_SSL_VERIFYPEER, 1),
280 CURLE_OK);
Alex Deymo8fd98d82016-06-23 18:22:08 -0700281 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_SSL_VERIFYHOST, 2),
282 CURLE_OK);
Alex Deymo35b35842015-10-20 11:21:56 -0700283 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_CAPATH,
284 constants::kCACertificatesPath),
Jay Srinivasanb3f55402012-12-03 18:12:04 -0800285 CURLE_OK);
286 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_PROTOCOLS, CURLPROTO_HTTPS),
287 CURLE_OK);
288 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_REDIR_PROTOCOLS,
289 CURLPROTO_HTTPS),
290 CURLE_OK);
291 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_SSL_CIPHER_LIST, "HIGH:!ADH"),
292 CURLE_OK);
Alex Deymo33e91e72015-12-01 18:26:08 -0300293 if (server_to_check_ != ServerToCheck::kNone) {
294 CHECK_EQ(
295 curl_easy_setopt(curl_handle_, CURLOPT_SSL_CTX_DATA, &server_to_check_),
296 CURLE_OK);
Jay Srinivasanb3f55402012-12-03 18:12:04 -0800297 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_SSL_CTX_FUNCTION,
298 CertificateChecker::ProcessSSLContext),
299 CURLE_OK);
300 }
301}
302
Alex Deymo56ccb072016-02-05 00:50:48 -0800303// Lock down only the protocol in case of a local file.
304void LibcurlHttpFetcher::SetCurlOptionsForFile() {
305 LOG(INFO) << "Setting up curl options for FILE";
306 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_PROTOCOLS, CURLPROTO_FILE),
307 CURLE_OK);
308 CHECK_EQ(
309 curl_easy_setopt(curl_handle_, CURLOPT_REDIR_PROTOCOLS, CURLPROTO_FILE),
310 CURLE_OK);
311}
Jay Srinivasanb3f55402012-12-03 18:12:04 -0800312
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000313// Begins the transfer, which must not have already been started.
Alex Deymof329b932014-10-30 01:37:48 -0700314void LibcurlHttpFetcher::BeginTransfer(const string& url) {
Andrew de los Reyesf3ed8e72011-02-16 10:35:46 -0800315 CHECK(!transfer_in_progress_);
316 url_ = url;
Alex Vakulenko4906c1c2014-08-21 13:17:44 -0700317 auto closure = base::Bind(&LibcurlHttpFetcher::ProxiesResolved,
318 base::Unretained(this));
Alex Deymo60ca1a72015-06-18 18:19:15 -0700319 if (!ResolveProxiesForUrl(url_, closure)) {
Andrew de los Reyesf3ed8e72011-02-16 10:35:46 -0800320 LOG(ERROR) << "Couldn't resolve proxies";
321 if (delegate_)
322 delegate_->TransferComplete(this, false);
323 }
324}
325
326void LibcurlHttpFetcher::ProxiesResolved() {
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000327 transfer_size_ = -1;
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000328 resume_offset_ = 0;
Andrew de los Reyes9bbd1872010-07-16 14:52:29 -0700329 retry_count_ = 0;
Darin Petkova0929552010-11-29 14:19:06 -0800330 no_network_retry_count_ = 0;
Darin Petkovcb466212010-08-26 09:40:11 -0700331 http_response_code_ = 0;
Andrew de los Reyes819fef22010-12-17 11:33:58 -0800332 terminate_requested_ = false;
Gilad Arnolda2dee1d2012-04-12 11:50:37 -0700333 sent_byte_ = false;
Alex Deymof2858572016-02-25 11:20:13 -0800334
335 // If we are paused, we delay these two operations until Unpause is called.
336 if (transfer_paused_) {
337 restart_transfer_on_unpause_ = true;
338 return;
339 }
Andrew de los Reyesf3ed8e72011-02-16 10:35:46 -0800340 ResumeTransfer(url_);
Andrew de los Reyes9bbd1872010-07-16 14:52:29 -0700341 CurlPerformOnce();
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000342}
343
Darin Petkov9ce452b2010-11-17 14:33:28 -0800344void LibcurlHttpFetcher::ForceTransferTermination() {
Alex Deymo71f67622017-02-03 21:30:24 -0800345 CancelProxyResolution();
Darin Petkov9ce452b2010-11-17 14:33:28 -0800346 CleanUp();
347 if (delegate_) {
348 // Note that after the callback returns this object may be destroyed.
349 delegate_->TransferTerminated(this);
350 }
351}
352
rspangler@google.com49fdf182009-10-10 00:57:34 +0000353void LibcurlHttpFetcher::TerminateTransfer() {
Darin Petkov9ce452b2010-11-17 14:33:28 -0800354 if (in_write_callback_) {
Andrew de los Reyes3fd5d302010-10-07 20:07:18 -0700355 terminate_requested_ = true;
Darin Petkov9ce452b2010-11-17 14:33:28 -0800356 } else {
357 ForceTransferTermination();
358 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000359}
360
Alex Deymofdd6dec2016-03-03 22:35:43 -0800361void LibcurlHttpFetcher::SetHeader(const string& header_name,
362 const string& header_value) {
363 string header_line = header_name + ": " + header_value;
364 // Avoid the space if no data on the right side of the semicolon.
365 if (header_value.empty())
366 header_line = header_name + ":";
367 TEST_AND_RETURN(header_line.find('\n') == string::npos);
368 TEST_AND_RETURN(header_name.find(':') == string::npos);
369 extra_headers_[base::ToLowerASCII(header_name)] = header_line;
370}
371
Andrew de los Reyescb319332010-07-19 10:55:01 -0700372void LibcurlHttpFetcher::CurlPerformOnce() {
rspangler@google.com49fdf182009-10-10 00:57:34 +0000373 CHECK(transfer_in_progress_);
374 int running_handles = 0;
375 CURLMcode retcode = CURLM_CALL_MULTI_PERFORM;
376
377 // libcurl may request that we immediately call curl_multi_perform after it
378 // returns, so we do. libcurl promises that curl_multi_perform will not block.
379 while (CURLM_CALL_MULTI_PERFORM == retcode) {
380 retcode = curl_multi_perform(curl_multi_handle_, &running_handles);
Andrew de los Reyes3fd5d302010-10-07 20:07:18 -0700381 if (terminate_requested_) {
Darin Petkov9ce452b2010-11-17 14:33:28 -0800382 ForceTransferTermination();
Andrew de los Reyes3fd5d302010-10-07 20:07:18 -0700383 return;
384 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000385 }
Alex Deymof2858572016-02-25 11:20:13 -0800386
387 // If the transfer completes while paused, we should ignore the failure once
388 // the fetcher is unpaused.
389 if (running_handles == 0 && transfer_paused_ && !ignore_failure_) {
390 LOG(INFO) << "Connection closed while paused, ignoring failure.";
391 ignore_failure_ = true;
392 }
393
394 if (running_handles != 0 || transfer_paused_) {
395 // There's either more work to do or we are paused, so we just keep the
396 // file descriptors to watch up to date and exit, until we are done with the
397 // work and we are not paused.
398 SetupMessageLoopSources();
399 return;
400 }
401
402 // At this point, the transfer was completed in some way (error, connection
403 // closed or download finished).
404
405 GetHttpResponseCode();
406 if (http_response_code_) {
407 LOG(INFO) << "HTTP response code: " << http_response_code_;
408 no_network_retry_count_ = 0;
409 } else {
410 LOG(ERROR) << "Unable to get http response code.";
411 }
412
413 // we're done!
414 CleanUp();
415
416 // TODO(petkov): This temporary code tries to deal with the case where the
417 // update engine performs an update check while the network is not ready
418 // (e.g., right after resume). Longer term, we should check if the network
419 // is online/offline and return an appropriate error code.
420 if (!sent_byte_ &&
421 http_response_code_ == 0 &&
422 no_network_retry_count_ < no_network_max_retries_) {
423 no_network_retry_count_++;
Alex Deymob20de692017-02-05 07:47:37 +0000424 retry_task_id_ = MessageLoop::current()->PostDelayedTask(
Alex Deymof2858572016-02-25 11:20:13 -0800425 FROM_HERE,
426 base::Bind(&LibcurlHttpFetcher::RetryTimeoutCallback,
427 base::Unretained(this)),
428 TimeDelta::FromSeconds(kNoNetworkRetrySeconds));
429 LOG(INFO) << "No HTTP response, retry " << no_network_retry_count_;
430 } else if ((!sent_byte_ && !IsHttpResponseSuccess()) ||
431 IsHttpResponseError()) {
432 // The transfer completed w/ error and we didn't get any bytes.
433 // If we have another proxy to try, try that.
434 //
435 // TODO(garnold) in fact there are two separate cases here: one case is an
436 // other-than-success return code (including no return code) and no
437 // received bytes, which is necessary due to the way callbacks are
438 // currently processing error conditions; the second is an explicit HTTP
439 // error code, where some data may have been received (as in the case of a
440 // semi-successful multi-chunk fetch). This is a confusing behavior and
441 // should be unified into a complete, coherent interface.
442 LOG(INFO) << "Transfer resulted in an error (" << http_response_code_
443 << "), " << bytes_downloaded_ << " bytes downloaded";
444
445 PopProxy(); // Delete the proxy we just gave up on.
446
447 if (HasProxy()) {
448 // We have another proxy. Retry immediately.
449 LOG(INFO) << "Retrying with next proxy setting";
Alex Deymob20de692017-02-05 07:47:37 +0000450 retry_task_id_ = MessageLoop::current()->PostTask(
Alex Deymof2858572016-02-25 11:20:13 -0800451 FROM_HERE,
452 base::Bind(&LibcurlHttpFetcher::RetryTimeoutCallback,
453 base::Unretained(this)));
Andrew de los Reyes9bbd1872010-07-16 14:52:29 -0700454 } else {
Alex Deymof2858572016-02-25 11:20:13 -0800455 // Out of proxies. Give up.
456 LOG(INFO) << "No further proxies, indicating transfer complete";
457 if (delegate_)
458 delegate_->TransferComplete(this, false); // signal fail
Alex Deymo021a45e2016-03-15 13:12:05 -0700459 return;
Andrew de los Reyes9bbd1872010-07-16 14:52:29 -0700460 }
Alex Deymof2858572016-02-25 11:20:13 -0800461 } else if ((transfer_size_ >= 0) && (bytes_downloaded_ < transfer_size_)) {
462 if (!ignore_failure_)
463 retry_count_++;
464 LOG(INFO) << "Transfer interrupted after downloading "
465 << bytes_downloaded_ << " of " << transfer_size_ << " bytes. "
466 << transfer_size_ - bytes_downloaded_ << " bytes remaining "
467 << "after " << retry_count_ << " attempt(s)";
Darin Petkov192ced42010-07-23 16:20:24 -0700468
Alex Deymof2858572016-02-25 11:20:13 -0800469 if (retry_count_ > max_retry_count_) {
470 LOG(INFO) << "Reached max attempts (" << retry_count_ << ")";
471 if (delegate_)
472 delegate_->TransferComplete(this, false); // signal fail
Alex Deymo021a45e2016-03-15 13:12:05 -0700473 return;
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000474 }
Alex Deymo021a45e2016-03-15 13:12:05 -0700475 // Need to restart transfer
476 LOG(INFO) << "Restarting transfer to download the remaining bytes";
Alex Deymob20de692017-02-05 07:47:37 +0000477 retry_task_id_ = MessageLoop::current()->PostDelayedTask(
Alex Deymo021a45e2016-03-15 13:12:05 -0700478 FROM_HERE,
479 base::Bind(&LibcurlHttpFetcher::RetryTimeoutCallback,
480 base::Unretained(this)),
481 TimeDelta::FromSeconds(retry_seconds_));
rspangler@google.com49fdf182009-10-10 00:57:34 +0000482 } else {
Alex Deymof2858572016-02-25 11:20:13 -0800483 LOG(INFO) << "Transfer completed (" << http_response_code_
484 << "), " << bytes_downloaded_ << " bytes downloaded";
485 if (delegate_) {
486 bool success = IsHttpResponseSuccess();
487 delegate_->TransferComplete(this, success);
488 }
Alex Deymo021a45e2016-03-15 13:12:05 -0700489 return;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000490 }
Alex Deymo021a45e2016-03-15 13:12:05 -0700491 // If we reach this point is because TransferComplete() was not called in any
492 // of the previous branches. The delegate is allowed to destroy the object
493 // once TransferComplete is called so this would be illegal.
Alex Deymof2858572016-02-25 11:20:13 -0800494 ignore_failure_ = false;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000495}
496
497size_t LibcurlHttpFetcher::LibcurlWrite(void *ptr, size_t size, size_t nmemb) {
Gilad Arnold48085ba2011-11-16 09:36:08 -0800498 // Update HTTP response first.
Andrew de los Reyes3fd5d302010-10-07 20:07:18 -0700499 GetHttpResponseCode();
Gilad Arnold48085ba2011-11-16 09:36:08 -0800500 const size_t payload_size = size * nmemb;
501
502 // Do nothing if no payload or HTTP response is an error.
Gilad Arnold9bedeb52011-11-17 16:19:57 -0800503 if (payload_size == 0 || !IsHttpResponseSuccess()) {
Gilad Arnold48085ba2011-11-16 09:36:08 -0800504 LOG(INFO) << "HTTP response unsuccessful (" << http_response_code_
505 << ") or no payload (" << payload_size << "), nothing to do";
506 return 0;
507 }
508
509 sent_byte_ = true;
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000510 {
511 double transfer_size_double;
512 CHECK_EQ(curl_easy_getinfo(curl_handle_,
513 CURLINFO_CONTENT_LENGTH_DOWNLOAD,
514 &transfer_size_double), CURLE_OK);
515 off_t new_transfer_size = static_cast<off_t>(transfer_size_double);
516 if (new_transfer_size > 0) {
517 transfer_size_ = resume_offset_ + new_transfer_size;
518 }
519 }
Gilad Arnold48085ba2011-11-16 09:36:08 -0800520 bytes_downloaded_ += payload_size;
Andrew de los Reyes3fd5d302010-10-07 20:07:18 -0700521 in_write_callback_ = true;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000522 if (delegate_)
Alex Vakulenkof68bbbc2015-02-09 12:53:18 -0800523 delegate_->ReceivedBytes(this, ptr, payload_size);
Andrew de los Reyes3fd5d302010-10-07 20:07:18 -0700524 in_write_callback_ = false;
Gilad Arnold48085ba2011-11-16 09:36:08 -0800525 return payload_size;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000526}
527
528void LibcurlHttpFetcher::Pause() {
Alex Deymof2858572016-02-25 11:20:13 -0800529 if (transfer_paused_) {
530 LOG(ERROR) << "Fetcher already paused.";
531 return;
532 }
533 transfer_paused_ = true;
534 if (!transfer_in_progress_) {
535 // If pause before we started a connection, we don't need to notify curl
536 // about that, we will simply not start the connection later.
537 return;
538 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000539 CHECK(curl_handle_);
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000540 CHECK_EQ(curl_easy_pause(curl_handle_, CURLPAUSE_ALL), CURLE_OK);
rspangler@google.com49fdf182009-10-10 00:57:34 +0000541}
542
543void LibcurlHttpFetcher::Unpause() {
Alex Deymof2858572016-02-25 11:20:13 -0800544 if (!transfer_paused_) {
545 LOG(ERROR) << "Resume attempted when fetcher not paused.";
546 return;
547 }
548 transfer_paused_ = false;
549 if (restart_transfer_on_unpause_) {
550 restart_transfer_on_unpause_ = false;
551 ResumeTransfer(url_);
552 CurlPerformOnce();
553 return;
554 }
555 if (!transfer_in_progress_) {
556 // If resumed before starting the connection, there's no need to notify
557 // anybody. We will simply start the connection once it is time.
558 return;
559 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000560 CHECK(curl_handle_);
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000561 CHECK_EQ(curl_easy_pause(curl_handle_, CURLPAUSE_CONT), CURLE_OK);
Alex Deymof2858572016-02-25 11:20:13 -0800562 // Since the transfer is in progress, we need to dispatch a CurlPerformOnce()
563 // now to let the connection continue, otherwise it would be called by the
564 // TimeoutCallback but with a delay.
565 CurlPerformOnce();
rspangler@google.com49fdf182009-10-10 00:57:34 +0000566}
567
Alex Deymo29b81532015-07-09 11:51:49 -0700568// This method sets up callbacks with the MessageLoop.
569void LibcurlHttpFetcher::SetupMessageLoopSources() {
rspangler@google.com49fdf182009-10-10 00:57:34 +0000570 fd_set fd_read;
571 fd_set fd_write;
Darin Petkov60e14152010-10-27 16:57:04 -0700572 fd_set fd_exc;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000573
574 FD_ZERO(&fd_read);
575 FD_ZERO(&fd_write);
Darin Petkov60e14152010-10-27 16:57:04 -0700576 FD_ZERO(&fd_exc);
rspangler@google.com49fdf182009-10-10 00:57:34 +0000577
578 int fd_max = 0;
579
580 // Ask libcurl for the set of file descriptors we should track on its
581 // behalf.
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000582 CHECK_EQ(curl_multi_fdset(curl_multi_handle_, &fd_read, &fd_write,
Darin Petkov60e14152010-10-27 16:57:04 -0700583 &fd_exc, &fd_max), CURLM_OK);
rspangler@google.com49fdf182009-10-10 00:57:34 +0000584
585 // We should iterate through all file descriptors up to libcurl's fd_max or
Darin Petkov60e14152010-10-27 16:57:04 -0700586 // the highest one we're tracking, whichever is larger.
Alex Deymo29b81532015-07-09 11:51:49 -0700587 for (size_t t = 0; t < arraysize(fd_task_maps_); ++t) {
588 if (!fd_task_maps_[t].empty())
589 fd_max = max(fd_max, fd_task_maps_[t].rbegin()->first);
Darin Petkov60e14152010-10-27 16:57:04 -0700590 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000591
Darin Petkov60e14152010-10-27 16:57:04 -0700592 // For each fd, if we're not tracking it, track it. If we are tracking it, but
593 // libcurl doesn't care about it anymore, stop tracking it. After this loop,
Alex Deymo29b81532015-07-09 11:51:49 -0700594 // there should be exactly as many tasks scheduled in fd_task_maps_[0|1] as
Darin Petkov60e14152010-10-27 16:57:04 -0700595 // there are read/write fds that we're tracking.
596 for (int fd = 0; fd <= fd_max; ++fd) {
597 // Note that fd_exc is unused in the current version of libcurl so is_exc
598 // should always be false.
599 bool is_exc = FD_ISSET(fd, &fd_exc) != 0;
600 bool must_track[2] = {
601 is_exc || (FD_ISSET(fd, &fd_read) != 0), // track 0 -- read
602 is_exc || (FD_ISSET(fd, &fd_write) != 0) // track 1 -- write
603 };
Alex Deymo29b81532015-07-09 11:51:49 -0700604 MessageLoop::WatchMode watch_modes[2] = {
605 MessageLoop::WatchMode::kWatchRead,
606 MessageLoop::WatchMode::kWatchWrite,
607 };
Darin Petkov60e14152010-10-27 16:57:04 -0700608
Alex Deymo29b81532015-07-09 11:51:49 -0700609 for (size_t t = 0; t < arraysize(fd_task_maps_); ++t) {
610 auto fd_task_it = fd_task_maps_[t].find(fd);
611 bool tracked = fd_task_it != fd_task_maps_[t].end();
Darin Petkov60e14152010-10-27 16:57:04 -0700612
613 if (!must_track[t]) {
614 // If we have an outstanding io_channel, remove it.
615 if (tracked) {
Alex Deymo29b81532015-07-09 11:51:49 -0700616 MessageLoop::current()->CancelTask(fd_task_it->second);
617 fd_task_maps_[t].erase(fd_task_it);
Darin Petkov60e14152010-10-27 16:57:04 -0700618 }
619 continue;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000620 }
Darin Petkov60e14152010-10-27 16:57:04 -0700621
622 // If we are already tracking this fd, continue -- nothing to do.
623 if (tracked)
624 continue;
625
Darin Petkov60e14152010-10-27 16:57:04 -0700626 // Track a new fd.
Alex Deymo29b81532015-07-09 11:51:49 -0700627 fd_task_maps_[t][fd] = MessageLoop::current()->WatchFileDescriptor(
628 FROM_HERE,
629 fd,
630 watch_modes[t],
631 true, // persistent
632 base::Bind(&LibcurlHttpFetcher::CurlPerformOnce,
633 base::Unretained(this)));
Darin Petkov60e14152010-10-27 16:57:04 -0700634
Darin Petkov60e14152010-10-27 16:57:04 -0700635 static int io_counter = 0;
636 io_counter++;
637 if (io_counter % 50 == 0) {
638 LOG(INFO) << "io_counter = " << io_counter;
639 }
Andrew de los Reyes3270f742010-07-15 22:28:14 -0700640 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000641 }
642
Darin Petkovb83371f2010-08-17 09:34:49 -0700643 // Set up a timeout callback for libcurl.
Alex Deymo60ca1a72015-06-18 18:19:15 -0700644 if (timeout_id_ == MessageLoop::kTaskIdNull) {
Alex Deymof2858572016-02-25 11:20:13 -0800645 VLOG(1) << "Setting up timeout source: " << idle_seconds_ << " seconds.";
Alex Deymo60ca1a72015-06-18 18:19:15 -0700646 timeout_id_ = MessageLoop::current()->PostDelayedTask(
647 FROM_HERE,
648 base::Bind(&LibcurlHttpFetcher::TimeoutCallback,
649 base::Unretained(this)),
650 TimeDelta::FromSeconds(idle_seconds_));
rspangler@google.com49fdf182009-10-10 00:57:34 +0000651 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000652}
653
Alex Deymo60ca1a72015-06-18 18:19:15 -0700654void LibcurlHttpFetcher::RetryTimeoutCallback() {
Alex Deymob20de692017-02-05 07:47:37 +0000655 retry_task_id_ = MessageLoop::kTaskIdNull;
Alex Deymof2858572016-02-25 11:20:13 -0800656 if (transfer_paused_) {
657 restart_transfer_on_unpause_ = true;
658 return;
659 }
Andrew de los Reyes9bbd1872010-07-16 14:52:29 -0700660 ResumeTransfer(url_);
661 CurlPerformOnce();
Andrew de los Reyes9bbd1872010-07-16 14:52:29 -0700662}
663
Alex Deymo60ca1a72015-06-18 18:19:15 -0700664void LibcurlHttpFetcher::TimeoutCallback() {
Alex Deymo60ca1a72015-06-18 18:19:15 -0700665 // We always re-schedule the callback, even if we don't want to be called
666 // anymore. We will remove the event source separately if we don't want to
Andrew de los Reyescb319332010-07-19 10:55:01 -0700667 // be called back.
Alex Deymo60ca1a72015-06-18 18:19:15 -0700668 timeout_id_ = MessageLoop::current()->PostDelayedTask(
669 FROM_HERE,
670 base::Bind(&LibcurlHttpFetcher::TimeoutCallback, base::Unretained(this)),
671 TimeDelta::FromSeconds(idle_seconds_));
Alex Deymof123ae22015-09-24 14:59:43 -0700672
673 // CurlPerformOnce() may call CleanUp(), so we need to schedule our callback
674 // first, since it could be canceled by this call.
675 if (transfer_in_progress_)
676 CurlPerformOnce();
rspangler@google.com49fdf182009-10-10 00:57:34 +0000677}
678
679void LibcurlHttpFetcher::CleanUp() {
Alex Deymob20de692017-02-05 07:47:37 +0000680 MessageLoop::current()->CancelTask(retry_task_id_);
681 retry_task_id_ = MessageLoop::kTaskIdNull;
682
Alex Deymo60ca1a72015-06-18 18:19:15 -0700683 MessageLoop::current()->CancelTask(timeout_id_);
684 timeout_id_ = MessageLoop::kTaskIdNull;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000685
Alex Deymo29b81532015-07-09 11:51:49 -0700686 for (size_t t = 0; t < arraysize(fd_task_maps_); ++t) {
687 for (const auto& fd_taks_pair : fd_task_maps_[t]) {
688 if (!MessageLoop::current()->CancelTask(fd_taks_pair.second)) {
689 LOG(WARNING) << "Error canceling the watch task "
690 << fd_taks_pair.second << " for "
691 << (t ? "writing" : "reading") << " the fd "
692 << fd_taks_pair.first;
693 }
Darin Petkov60e14152010-10-27 16:57:04 -0700694 }
Alex Deymo29b81532015-07-09 11:51:49 -0700695 fd_task_maps_[t].clear();
rspangler@google.com49fdf182009-10-10 00:57:34 +0000696 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000697
Gilad Arnold9dd1e7c2012-02-16 12:13:36 -0800698 if (curl_http_headers_) {
699 curl_slist_free_all(curl_http_headers_);
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700700 curl_http_headers_ = nullptr;
Gilad Arnold9dd1e7c2012-02-16 12:13:36 -0800701 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000702 if (curl_handle_) {
703 if (curl_multi_handle_) {
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000704 CHECK_EQ(curl_multi_remove_handle(curl_multi_handle_, curl_handle_),
705 CURLM_OK);
rspangler@google.com49fdf182009-10-10 00:57:34 +0000706 }
707 curl_easy_cleanup(curl_handle_);
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700708 curl_handle_ = nullptr;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000709 }
710 if (curl_multi_handle_) {
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000711 CHECK_EQ(curl_multi_cleanup(curl_multi_handle_), CURLM_OK);
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700712 curl_multi_handle_ = nullptr;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000713 }
714 transfer_in_progress_ = false;
Alex Deymof2858572016-02-25 11:20:13 -0800715 transfer_paused_ = false;
716 restart_transfer_on_unpause_ = false;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000717}
718
Andrew de los Reyes3fd5d302010-10-07 20:07:18 -0700719void LibcurlHttpFetcher::GetHttpResponseCode() {
Alex Vakulenkod2779df2014-06-16 13:19:00 -0700720 long http_response_code = 0; // NOLINT(runtime/int) - curl needs long.
Alex Deymo56ccb072016-02-05 00:50:48 -0800721 if (base::StartsWith(url_, "file://", base::CompareCase::INSENSITIVE_ASCII)) {
722 // Fake out a valid response code for file:// URLs.
723 http_response_code_ = 299;
724 } else if (curl_easy_getinfo(curl_handle_,
725 CURLINFO_RESPONSE_CODE,
726 &http_response_code) == CURLE_OK) {
Andrew de los Reyes3fd5d302010-10-07 20:07:18 -0700727 http_response_code_ = static_cast<int>(http_response_code);
728 }
729}
730
rspangler@google.com49fdf182009-10-10 00:57:34 +0000731} // namespace chromeos_update_engine