blob: deb294a1e82af178722b81d33ab19259413ab806 [file] [log] [blame]
Alex Deymoaea4c1c2015-08-19 20:24:43 -07001//
2// Copyright (C) 2012 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
Darin Petkov6a5b3222010-07-13 14:55:28 -070017#include "update_engine/omaha_request_action.h"
Darin Petkov85ced132010-09-01 10:20:56 -070018
Andrew de los Reyes08c4e272010-04-15 14:02:17 -070019#include <inttypes.h>
Darin Petkov85ced132010-09-01 10:20:56 -070020
Zentaro Kavanagh0ff621c2018-07-13 13:06:56 -070021#include <limits>
David Zeuthene8ed8632014-07-24 13:38:10 -040022#include <map>
rspangler@google.com49fdf182009-10-10 00:57:34 +000023#include <sstream>
Jay Srinivasan480ddfa2012-06-01 19:15:26 -070024#include <string>
Sen Jiang8cd42342018-01-31 12:06:59 -080025#include <utility>
David Zeuthene8ed8632014-07-24 13:38:10 -040026#include <vector>
rspangler@google.com49fdf182009-10-10 00:57:34 +000027
David Zeuthen8f191b22013-08-06 12:27:50 -070028#include <base/bind.h>
Jay Srinivasan480ddfa2012-06-01 19:15:26 -070029#include <base/logging.h>
30#include <base/rand_util.h>
Alex Vakulenko75039d72014-03-25 12:36:28 -070031#include <base/strings/string_number_conversions.h>
Sen Jiang0affc2c2017-02-10 15:55:05 -080032#include <base/strings/string_split.h>
Alex Vakulenko75039d72014-03-25 12:36:28 -070033#include <base/strings/string_util.h>
34#include <base/strings/stringprintf.h>
35#include <base/time/time.h>
Sen Jiang684c9cd2017-10-17 16:26:45 -070036#include <brillo/key_value_store.h>
David Zeuthene8ed8632014-07-24 13:38:10 -040037#include <expat.h>
Alex Deymoa2591792015-11-17 00:39:40 -030038#include <metrics/metrics_library.h>
Zentaro Kavanagh1f899d52018-02-27 15:02:47 -080039#include <policy/libpolicy.h>
rspangler@google.com49fdf182009-10-10 00:57:34 +000040
Alex Deymo39910dc2015-11-09 17:04:30 -080041#include "update_engine/common/action_pipe.h"
42#include "update_engine/common/constants.h"
43#include "update_engine/common/hardware_interface.h"
44#include "update_engine/common/hash_calculator.h"
45#include "update_engine/common/platform_constants.h"
46#include "update_engine/common/prefs_interface.h"
47#include "update_engine/common/utils.h"
Sen Jiang255e22b2016-05-20 16:15:29 -070048#include "update_engine/connection_manager_interface.h"
Tianjie Xu282aa1f2017-09-05 13:42:45 -070049#include "update_engine/metrics_reporter_interface.h"
Alex Deymo38429cf2015-11-11 18:27:22 -080050#include "update_engine/metrics_utils.h"
Darin Petkova4a8a8c2010-07-15 22:21:12 -070051#include "update_engine/omaha_request_params.h"
David Zeuthen8f191b22013-08-06 12:27:50 -070052#include "update_engine/p2p_manager.h"
Jay Srinivasan55f50c22013-01-10 19:24:35 -080053#include "update_engine/payload_state_interface.h"
rspangler@google.com49fdf182009-10-10 00:57:34 +000054
Darin Petkov1cbd78f2010-07-29 12:38:34 -070055using base::Time;
56using base::TimeDelta;
Zentaro Kavanagh1f899d52018-02-27 15:02:47 -080057using chromeos_update_manager::kRollforwardInfinity;
David Zeuthene8ed8632014-07-24 13:38:10 -040058using std::map;
Zentaro Kavanagh0ff621c2018-07-13 13:06:56 -070059using std::numeric_limits;
rspangler@google.com49fdf182009-10-10 00:57:34 +000060using std::string;
David Zeuthene8ed8632014-07-24 13:38:10 -040061using std::vector;
rspangler@google.com49fdf182009-10-10 00:57:34 +000062
63namespace chromeos_update_engine {
64
Amin Hassani6600a562018-09-24 15:17:19 -070065// List of custom attributes that we interpret in the Omaha response:
66constexpr char kAttrDeadline[] = "deadline";
67constexpr char kAttrDisableP2PForDownloading[] = "DisableP2PForDownloading";
68constexpr char kAttrDisableP2PForSharing[] = "DisableP2PForSharing";
69constexpr char kAttrDisablePayloadBackoff[] = "DisablePayloadBackoff";
70constexpr char kAttrVersion[] = "version";
Jay Srinivasand671e972013-01-11 17:17:19 -080071// Deprecated: "IsDelta"
Amin Hassani6600a562018-09-24 15:17:19 -070072constexpr char kAttrIsDeltaPayload[] = "IsDeltaPayload";
73constexpr char kAttrMaxFailureCountPerUrl[] = "MaxFailureCountPerUrl";
74constexpr char kAttrMaxDaysToScatter[] = "MaxDaysToScatter";
Jay Srinivasan2b5a0f02012-12-19 17:25:56 -080075// Deprecated: "ManifestSignatureRsa"
76// Deprecated: "ManifestSize"
Amin Hassani6600a562018-09-24 15:17:19 -070077constexpr char kAttrMetadataSignatureRsa[] = "MetadataSignatureRsa";
78constexpr char kAttrMetadataSize[] = "MetadataSize";
79constexpr char kAttrMoreInfo[] = "MoreInfo";
80constexpr char kAttrNoUpdate[] = "noupdate";
Don Garrett42bd3aa2013-04-10 18:14:56 -070081// Deprecated: "NeedsAdmin"
Amin Hassani6600a562018-09-24 15:17:19 -070082constexpr char kAttrPollInterval[] = "PollInterval";
83constexpr char kAttrPowerwash[] = "Powerwash";
84constexpr char kAttrPrompt[] = "Prompt";
85constexpr char kAttrPublicKeyRsa[] = "PublicKeyRsa";
Jay Srinivasan2b5a0f02012-12-19 17:25:56 -080086
Amin Hassani6600a562018-09-24 15:17:19 -070087// List of attributes that we interpret in the Omaha response:
88constexpr char kAttrAppId[] = "appid";
89constexpr char kAttrCodeBase[] = "codebase";
90constexpr char kAttrCohort[] = "cohort";
91constexpr char kAttrCohortHint[] = "cohorthint";
92constexpr char kAttrCohortName[] = "cohortname";
93constexpr char kAttrElapsedDays[] = "elapsed_days";
94constexpr char kAttrElapsedSeconds[] = "elapsed_seconds";
95constexpr char kAttrEvent[] = "event";
96constexpr char kAttrHashSha256[] = "hash_sha256";
97// Deprecated: "hash"; Although we still need to pass it from the server for
98// backward compatibility.
99constexpr char kAttrName[] = "name";
100// Deprecated: "sha256"; Although we still need to pass it from the server for
101// backward compatibility.
102constexpr char kAttrSize[] = "size";
103constexpr char kAttrStatus[] = "status";
104
105// List of values that we interpret in the Omaha response:
106constexpr char kValPostInstall[] = "postinstall";
107constexpr char kValNoUpdate[] = "noupdate";
108
109constexpr char kOmahaUpdaterVersion[] = "0.1.0.0";
rspangler@google.com49fdf182009-10-10 00:57:34 +0000110
Sen Jiang42fa45e2018-03-12 11:02:14 -0700111// X-Goog-Update headers.
Amin Hassani6600a562018-09-24 15:17:19 -0700112constexpr char kXGoogleUpdateInteractivity[] = "X-Goog-Update-Interactivity";
113constexpr char kXGoogleUpdateAppId[] = "X-Goog-Update-AppId";
114constexpr char kXGoogleUpdateUpdater[] = "X-Goog-Update-Updater";
Alex Deymo14ad88e2016-06-29 12:30:14 -0700115
Alex Deymob3fa53b2016-04-18 19:57:58 -0700116// updatecheck attributes (without the underscore prefix).
Amin Hassani6600a562018-09-24 15:17:19 -0700117constexpr char kAttrEol[] = "eol";
118constexpr char kAttrRollback[] = "rollback";
119constexpr char kAttrFirmwareVersion[] = "firmware_version";
120constexpr char kAttrKernelVersion[] = "kernel_version";
Alex Deymob3fa53b2016-04-18 19:57:58 -0700121
Alex Deymoac41a822015-09-15 20:52:53 -0700122namespace {
rspangler@google.com49fdf182009-10-10 00:57:34 +0000123
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700124// Returns an XML ping element attribute assignment with attribute
125// |name| and value |ping_days| if |ping_days| has a value that needs
126// to be sent, or an empty string otherwise.
127string GetPingAttribute(const string& name, int ping_days) {
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700128 if (ping_days > 0 || ping_days == OmahaRequestAction::kNeverPinged)
Alex Vakulenko75039d72014-03-25 12:36:28 -0700129 return base::StringPrintf(" %s=\"%d\"", name.c_str(), ping_days);
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700130 return "";
131}
132
133// Returns an XML ping element if any of the elapsed days need to be
134// sent, or an empty string otherwise.
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700135string GetPingXml(int ping_active_days, int ping_roll_call_days) {
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700136 string ping_active = GetPingAttribute("a", ping_active_days);
137 string ping_roll_call = GetPingAttribute("r", ping_roll_call_days);
138 if (!ping_active.empty() || !ping_roll_call.empty()) {
Alex Vakulenko75039d72014-03-25 12:36:28 -0700139 return base::StringPrintf(" <ping active=\"1\"%s%s></ping>\n",
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700140 ping_active.c_str(),
141 ping_roll_call.c_str());
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700142 }
143 return "";
144}
145
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700146// Returns an XML that goes into the body of the <app> element of the Omaha
147// request based on the given parameters.
148string GetAppBody(const OmahaEvent* event,
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700149 OmahaRequestParams* params,
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700150 bool ping_only,
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700151 bool include_ping,
Xiaochu Liu6310be62018-10-11 15:09:03 -0700152 bool skip_updatecheck,
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700153 int ping_active_days,
154 int ping_roll_call_days,
155 PrefsInterface* prefs) {
156 string app_body;
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700157 if (event == nullptr) {
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700158 if (include_ping)
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800159 app_body = GetPingXml(ping_active_days, ping_roll_call_days);
Darin Petkov265f2902011-05-09 15:17:40 -0700160 if (!ping_only) {
Xiaochu Liu6310be62018-10-11 15:09:03 -0700161 if (!skip_updatecheck) {
162 app_body += " <updatecheck";
163 if (!params->target_version_prefix().empty()) {
164 app_body += base::StringPrintf(
165 " targetversionprefix=\"%s\"",
166 XmlEncodeWithDefault(params->target_version_prefix(), "")
167 .c_str());
168 // Rollback requires target_version_prefix set.
169 if (params->rollback_allowed()) {
170 app_body += " rollback_allowed=\"true\"";
171 }
Marton Hunyadyba51c3f2018-04-25 15:18:10 +0200172 }
Xiaochu Liu6310be62018-10-11 15:09:03 -0700173 app_body += "></updatecheck>\n";
Marton Hunyadyba51c3f2018-04-25 15:18:10 +0200174 }
Jay Srinivasan0a708742012-03-20 11:26:12 -0700175
Darin Petkov265f2902011-05-09 15:17:40 -0700176 // If this is the first update check after a reboot following a previous
177 // update, generate an event containing the previous version number. If
178 // the previous version preference file doesn't exist the event is still
179 // generated with a previous version of 0.0.0.0 -- this is relevant for
180 // older clients or new installs. The previous version event is not sent
181 // for ping-only requests because they come before the client has
Alex Deymo87c08862015-10-30 21:56:55 -0700182 // rebooted. The previous version event is also not sent if it was already
183 // sent for this new version with a previous updatecheck.
Darin Petkov265f2902011-05-09 15:17:40 -0700184 string prev_version;
185 if (!prefs->GetString(kPrefsPreviousVersion, &prev_version)) {
186 prev_version = "0.0.0.0";
187 }
Alex Deymo87c08862015-10-30 21:56:55 -0700188 // We only store a non-empty previous version value after a successful
189 // update in the previous boot. After reporting it back to the server,
190 // we clear the previous version value so it doesn't get reported again.
191 if (!prev_version.empty()) {
192 app_body += base::StringPrintf(
193 " <event eventtype=\"%d\" eventresult=\"%d\" "
194 "previousversion=\"%s\"></event>\n",
Alex Deymo9fded1e2015-11-05 12:31:19 -0800195 OmahaEvent::kTypeRebootedAfterUpdate,
196 OmahaEvent::kResultSuccess,
Alex Deymo87c08862015-10-30 21:56:55 -0700197 XmlEncodeWithDefault(prev_version, "0.0.0.0").c_str());
198 LOG_IF(WARNING, !prefs->SetString(kPrefsPreviousVersion, ""))
199 << "Unable to reset the previous version.";
200 }
Darin Petkov95508da2011-01-05 12:42:29 -0800201 }
Darin Petkov0dc8e9a2010-07-14 14:51:57 -0700202 } else {
Darin Petkovc91dd6b2011-01-10 12:31:34 -0800203 // The error code is an optional attribute so append it only if the result
204 // is not success.
Darin Petkove17f86b2010-07-20 09:12:01 -0700205 string error_code;
206 if (event->result != OmahaEvent::kResultSuccess) {
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700207 error_code = base::StringPrintf(" errorcode=\"%d\"",
208 static_cast<int>(event->error_code));
Darin Petkove17f86b2010-07-20 09:12:01 -0700209 }
Alex Vakulenko75039d72014-03-25 12:36:28 -0700210 app_body = base::StringPrintf(
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700211 " <event eventtype=\"%d\" eventresult=\"%d\"%s></event>\n",
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800212 event->type,
213 event->result,
214 error_code.c_str());
Darin Petkov0dc8e9a2010-07-14 14:51:57 -0700215 }
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700216
217 return app_body;
218}
219
Alex Deymo8e18f932015-03-27 16:16:59 -0700220// Returns the cohort* argument to include in the <app> tag for the passed
221// |arg_name| and |prefs_key|, if any. The return value is suitable to
222// concatenate to the list of arguments and includes a space at the end.
223string GetCohortArgXml(PrefsInterface* prefs,
Alex Deymob0d74eb2015-03-30 17:59:17 -0700224 const string arg_name,
225 const string prefs_key) {
Alex Deymo8e18f932015-03-27 16:16:59 -0700226 // There's nothing wrong with not having a given cohort setting, so we check
Sen Jiang771f6482018-04-04 17:59:10 -0700227 // existence first to avoid the warning log message.
Alex Deymo8e18f932015-03-27 16:16:59 -0700228 if (!prefs->Exists(prefs_key))
229 return "";
230 string cohort_value;
231 if (!prefs->GetString(prefs_key, &cohort_value) || cohort_value.empty())
232 return "";
233 // This is a sanity check to avoid sending a huge XML file back to Ohama due
234 // to a compromised stateful partition making the update check fail in low
235 // network environments envent after a reboot.
236 if (cohort_value.size() > 1024) {
237 LOG(WARNING) << "The omaha cohort setting " << arg_name
238 << " has a too big value, which must be an error or an "
239 "attacker trying to inhibit updates.";
240 return "";
241 }
242
Alex Deymob0d74eb2015-03-30 17:59:17 -0700243 string escaped_xml_value;
244 if (!XmlEncode(cohort_value, &escaped_xml_value)) {
245 LOG(WARNING) << "The omaha cohort setting " << arg_name
246 << " is ASCII-7 invalid, ignoring it.";
247 return "";
248 }
249
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800250 return base::StringPrintf(
251 "%s=\"%s\" ", arg_name.c_str(), escaped_xml_value.c_str());
Alex Deymo8e18f932015-03-27 16:16:59 -0700252}
253
Sen Jiang94a4dec2017-03-28 18:23:35 -0700254struct OmahaAppData {
255 string id;
256 string version;
Sen Jiang684c9cd2017-10-17 16:26:45 -0700257 string product_components;
Sen Jiang94a4dec2017-03-28 18:23:35 -0700258};
259
Sen Jiang684c9cd2017-10-17 16:26:45 -0700260bool IsValidComponentID(const string& id) {
261 for (char c : id) {
262 if (!isalnum(c) && c != '-' && c != '_' && c != '.')
263 return false;
264 }
265 return true;
266}
267
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700268// Returns an XML that corresponds to the entire <app> node of the Omaha
269// request based on the given parameters.
270string GetAppXml(const OmahaEvent* event,
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700271 OmahaRequestParams* params,
Sen Jiang94a4dec2017-03-28 18:23:35 -0700272 const OmahaAppData& app_data,
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700273 bool ping_only,
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700274 bool include_ping,
Xiaochu Liu6310be62018-10-11 15:09:03 -0700275 bool skip_updatecheck,
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700276 int ping_active_days,
277 int ping_roll_call_days,
David Zeuthen639aa362014-02-03 16:23:44 -0800278 int install_date_in_days,
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700279 SystemState* system_state) {
Xiaochu Liu6310be62018-10-11 15:09:03 -0700280 string app_body = GetAppBody(event,
281 params,
282 ping_only,
283 include_ping,
284 skip_updatecheck,
285 ping_active_days,
286 ping_roll_call_days,
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700287 system_state->prefs());
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700288 string app_versions;
289
Sen Jiang8cd42342018-01-31 12:06:59 -0800290 // If we are downgrading to a more stable channel and we are allowed to do
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700291 // powerwash, then pass 0.0.0.0 as the version. This is needed to get the
292 // highest-versioned payload on the destination channel.
Sen Jiang8500d3a2018-02-08 12:04:05 -0800293 if (params->ShouldPowerwash()) {
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700294 LOG(INFO) << "Passing OS version as 0.0.0.0 as we are set to powerwash "
295 << "on downgrading to the version in the more stable channel";
296 app_versions = "version=\"0.0.0.0\" from_version=\"" +
Sen Jiang94a4dec2017-03-28 18:23:35 -0700297 XmlEncodeWithDefault(app_data.version, "0.0.0.0") + "\" ";
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700298 } else {
Alex Deymob0d74eb2015-03-30 17:59:17 -0700299 app_versions = "version=\"" +
Sen Jiang94a4dec2017-03-28 18:23:35 -0700300 XmlEncodeWithDefault(app_data.version, "0.0.0.0") + "\" ";
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700301 }
302
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700303 string download_channel = params->download_channel();
Alex Deymob0d74eb2015-03-30 17:59:17 -0700304 string app_channels =
305 "track=\"" + XmlEncodeWithDefault(download_channel, "") + "\" ";
306 if (params->current_channel() != download_channel) {
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800307 app_channels += "from_track=\"" +
308 XmlEncodeWithDefault(params->current_channel(), "") + "\" ";
Alex Deymob0d74eb2015-03-30 17:59:17 -0700309 }
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700310
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700311 string delta_okay_str = params->delta_okay() ? "true" : "false";
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700312
David Zeuthen639aa362014-02-03 16:23:44 -0800313 // If install_date_days is not set (e.g. its value is -1 ), don't
314 // include the attribute.
315 string install_date_in_days_str = "";
316 if (install_date_in_days >= 0) {
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800317 install_date_in_days_str =
318 base::StringPrintf("installdate=\"%d\" ", install_date_in_days);
David Zeuthen639aa362014-02-03 16:23:44 -0800319 }
320
Alex Deymo8e18f932015-03-27 16:16:59 -0700321 string app_cohort_args;
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800322 app_cohort_args +=
323 GetCohortArgXml(system_state->prefs(), "cohort", kPrefsOmahaCohort);
324 app_cohort_args += GetCohortArgXml(
325 system_state->prefs(), "cohorthint", kPrefsOmahaCohortHint);
326 app_cohort_args += GetCohortArgXml(
327 system_state->prefs(), "cohortname", kPrefsOmahaCohortName);
Alex Deymo8e18f932015-03-27 16:16:59 -0700328
Alex Deymoebf6e122017-03-10 16:12:01 -0800329 string fingerprint_arg;
330 if (!params->os_build_fingerprint().empty()) {
Sen Jiang8cd42342018-01-31 12:06:59 -0800331 fingerprint_arg = "fingerprint=\"" +
332 XmlEncodeWithDefault(params->os_build_fingerprint(), "") +
333 "\" ";
Alex Deymoebf6e122017-03-10 16:12:01 -0800334 }
335
Sen Jiang1d5d95f2017-05-19 11:33:10 -0700336 string buildtype_arg;
337 if (!params->os_build_type().empty()) {
338 buildtype_arg = "os_build_type=\"" +
339 XmlEncodeWithDefault(params->os_build_type(), "") + "\" ";
340 }
341
Sen Jiang684c9cd2017-10-17 16:26:45 -0700342 string product_components_args;
Sen Jiang8500d3a2018-02-08 12:04:05 -0800343 if (!params->ShouldPowerwash() && !app_data.product_components.empty()) {
Sen Jiang684c9cd2017-10-17 16:26:45 -0700344 brillo::KeyValueStore store;
345 if (store.LoadFromString(app_data.product_components)) {
346 for (const string& key : store.GetKeys()) {
347 if (!IsValidComponentID(key)) {
348 LOG(ERROR) << "Invalid component id: " << key;
349 continue;
350 }
351 string version;
352 if (!store.GetString(key, &version)) {
353 LOG(ERROR) << "Failed to get version for " << key
354 << " in product_components.";
355 continue;
356 }
357 product_components_args +=
358 base::StringPrintf("_%s.version=\"%s\" ",
359 key.c_str(),
360 XmlEncodeWithDefault(version, "").c_str());
361 }
362 } else {
363 LOG(ERROR) << "Failed to parse product_components:\n"
364 << app_data.product_components;
365 }
366 }
367
368 // clang-format off
Alex Deymob0d74eb2015-03-30 17:59:17 -0700369 string app_xml = " <app "
Sen Jiang94a4dec2017-03-28 18:23:35 -0700370 "appid=\"" + XmlEncodeWithDefault(app_data.id, "") + "\" " +
Alex Deymob0d74eb2015-03-30 17:59:17 -0700371 app_cohort_args +
372 app_versions +
373 app_channels +
Sen Jiang684c9cd2017-10-17 16:26:45 -0700374 product_components_args +
Alex Deymoebf6e122017-03-10 16:12:01 -0800375 fingerprint_arg +
Sen Jiang1d5d95f2017-05-19 11:33:10 -0700376 buildtype_arg +
Alex Deymob0d74eb2015-03-30 17:59:17 -0700377 "lang=\"" + XmlEncodeWithDefault(params->app_lang(), "en-US") + "\" " +
378 "board=\"" + XmlEncodeWithDefault(params->os_board(), "") + "\" " +
379 "hardware_class=\"" + XmlEncodeWithDefault(params->hwid(), "") + "\" " +
380 "delta_okay=\"" + delta_okay_str + "\" "
381 "fw_version=\"" + XmlEncodeWithDefault(params->fw_version(), "") + "\" " +
382 "ec_version=\"" + XmlEncodeWithDefault(params->ec_version(), "") + "\" " +
383 install_date_in_days_str +
384 ">\n" +
385 app_body +
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700386 " </app>\n";
Sen Jiang684c9cd2017-10-17 16:26:45 -0700387 // clang-format on
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700388 return app_xml;
389}
390
391// Returns an XML that corresponds to the entire <os> node of the Omaha
392// request based on the given parameters.
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700393string GetOsXml(OmahaRequestParams* params) {
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800394 string os_xml =
395 " <os "
396 "version=\"" +
397 XmlEncodeWithDefault(params->os_version(), "") + "\" " + "platform=\"" +
398 XmlEncodeWithDefault(params->os_platform(), "") + "\" " + "sp=\"" +
399 XmlEncodeWithDefault(params->os_sp(), "") +
400 "\">"
Alex Deymob0d74eb2015-03-30 17:59:17 -0700401 "</os>\n";
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700402 return os_xml;
403}
404
405// Returns an XML that corresponds to the entire Omaha request based on the
406// given parameters.
407string GetRequestXml(const OmahaEvent* event,
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700408 OmahaRequestParams* params,
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700409 bool ping_only,
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700410 bool include_ping,
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700411 int ping_active_days,
412 int ping_roll_call_days,
David Zeuthen639aa362014-02-03 16:23:44 -0800413 int install_date_in_days,
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700414 SystemState* system_state) {
415 string os_xml = GetOsXml(params);
Sen Jiang684c9cd2017-10-17 16:26:45 -0700416 OmahaAppData product_app = {
417 .id = params->GetAppId(),
418 .version = params->app_version(),
419 .product_components = params->product_components()};
Xiaochu Liu6310be62018-10-11 15:09:03 -0700420 // Skips updatecheck for platform app in case of an install operation.
Sen Jiang94a4dec2017-03-28 18:23:35 -0700421 string app_xml = GetAppXml(event,
422 params,
423 product_app,
424 ping_only,
425 include_ping,
Xiaochu Liu6310be62018-10-11 15:09:03 -0700426 params->is_install(), /* skip_updatecheck */
Sen Jiang94a4dec2017-03-28 18:23:35 -0700427 ping_active_days,
428 ping_roll_call_days,
429 install_date_in_days,
430 system_state);
431 if (!params->system_app_id().empty()) {
432 OmahaAppData system_app = {.id = params->system_app_id(),
433 .version = params->system_version()};
434 app_xml += GetAppXml(event,
435 params,
436 system_app,
437 ping_only,
438 include_ping,
Xiaochu Liu6310be62018-10-11 15:09:03 -0700439 false, /* skip_updatecheck */
Sen Jiang94a4dec2017-03-28 18:23:35 -0700440 ping_active_days,
441 ping_roll_call_days,
442 install_date_in_days,
443 system_state);
444 }
Xiaochu Liuf53a5d32018-11-26 13:48:59 -0800445 // Create APP ID according to |dlc_module_id| (sticking the current AppID to
446 // the DLC module ID with an underscode).
447 for (const auto& dlc_module_id : params->dlc_module_ids()) {
448 OmahaAppData dlc_module_app = {
449 .id = params->GetAppId() + "_" + dlc_module_id,
450 .version = params->app_version()};
Xiaochu Liu88d90382018-08-29 16:09:11 -0700451 app_xml += GetAppXml(event,
452 params,
Xiaochu Liuf53a5d32018-11-26 13:48:59 -0800453 dlc_module_app,
Xiaochu Liu88d90382018-08-29 16:09:11 -0700454 ping_only,
455 include_ping,
Xiaochu Liu6310be62018-10-11 15:09:03 -0700456 false, /* skip_updatecheck */
Xiaochu Liu88d90382018-08-29 16:09:11 -0700457 ping_active_days,
458 ping_roll_call_days,
459 install_date_in_days,
460 system_state);
461 }
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700462
Amin Hassani7c41bbf2019-02-13 10:50:31 -0800463 string request_xml = base::StringPrintf(
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700464 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
Amin Hassani7c41bbf2019-02-13 10:50:31 -0800465 "<request protocol=\"3.0\" updater=\"%s\" updaterversion=\"%s\""
466 " installsource=\"%s\" ismachine=\"1\">\n%s%s</request>\n",
467 constants::kOmahaUpdaterID,
468 kOmahaUpdaterVersion,
469 params->interactive() ? "ondemandupdate" : "scheduler",
470 os_xml.c_str(),
471 app_xml.c_str());
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700472
473 return request_xml;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000474}
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700475
Alex Vakulenkod2779df2014-06-16 13:19:00 -0700476} // namespace
rspangler@google.com49fdf182009-10-10 00:57:34 +0000477
David Zeuthene8ed8632014-07-24 13:38:10 -0400478// Struct used for holding data obtained when parsing the XML.
479struct OmahaParserData {
David Zeuthenf3e28012014-08-26 18:23:52 -0400480 explicit OmahaParserData(XML_Parser _xml_parser) : xml_parser(_xml_parser) {}
481
482 // Pointer to the expat XML_Parser object.
483 XML_Parser xml_parser;
484
David Zeuthene8ed8632014-07-24 13:38:10 -0400485 // This is the state of the parser as it's processing the XML.
486 bool failed = false;
David Zeuthenf3e28012014-08-26 18:23:52 -0400487 bool entity_decl = false;
David Zeuthene8ed8632014-07-24 13:38:10 -0400488 string current_path;
489
490 // These are the values extracted from the XML.
David Zeuthene8ed8632014-07-24 13:38:10 -0400491 string updatecheck_poll_interval;
Alex Deymob3fa53b2016-04-18 19:57:58 -0700492 map<string, string> updatecheck_attrs;
David Zeuthene8ed8632014-07-24 13:38:10 -0400493 string daystart_elapsed_days;
494 string daystart_elapsed_seconds;
Sen Jiang0affc2c2017-02-10 15:55:05 -0800495
Sen Jiang81259682017-03-30 15:11:30 -0700496 struct App {
Aaron Wood7dcdedf2017-09-06 17:17:41 -0700497 string id;
Sen Jiang81259682017-03-30 15:11:30 -0700498 vector<string> url_codebase;
499 string manifest_version;
500 map<string, string> action_postinstall_attrs;
501 string updatecheck_status;
Sen Jiangb1e063a2017-09-15 17:44:31 -0700502 string cohort;
503 string cohorthint;
504 string cohortname;
505 bool cohort_set = false;
506 bool cohorthint_set = false;
507 bool cohortname_set = false;
Sen Jiang81259682017-03-30 15:11:30 -0700508
509 struct Package {
510 string name;
511 string size;
512 string hash;
513 };
514 vector<Package> packages;
Sen Jiang0affc2c2017-02-10 15:55:05 -0800515 };
Sen Jiang81259682017-03-30 15:11:30 -0700516 vector<App> apps;
David Zeuthene8ed8632014-07-24 13:38:10 -0400517};
518
519namespace {
520
521// Callback function invoked by expat.
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800522void ParserHandlerStart(void* user_data,
523 const XML_Char* element,
David Zeuthene8ed8632014-07-24 13:38:10 -0400524 const XML_Char** attr) {
525 OmahaParserData* data = reinterpret_cast<OmahaParserData*>(user_data);
526
527 if (data->failed)
528 return;
529
530 data->current_path += string("/") + element;
531
532 map<string, string> attrs;
533 if (attr != nullptr) {
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800534 for (int n = 0; attr[n] != nullptr && attr[n + 1] != nullptr; n += 2) {
David Zeuthene8ed8632014-07-24 13:38:10 -0400535 string key = attr[n];
536 string value = attr[n + 1];
537 attrs[key] = value;
538 }
539 }
540
Alex Deymo8e18f932015-03-27 16:16:59 -0700541 if (data->current_path == "/response/app") {
Sen Jiangb1e063a2017-09-15 17:44:31 -0700542 OmahaParserData::App app;
Amin Hassani6600a562018-09-24 15:17:19 -0700543 if (attrs.find(kAttrAppId) != attrs.end()) {
544 app.id = attrs[kAttrAppId];
Aaron Wood7dcdedf2017-09-06 17:17:41 -0700545 }
Amin Hassani6600a562018-09-24 15:17:19 -0700546 if (attrs.find(kAttrCohort) != attrs.end()) {
Sen Jiangb1e063a2017-09-15 17:44:31 -0700547 app.cohort_set = true;
Amin Hassani6600a562018-09-24 15:17:19 -0700548 app.cohort = attrs[kAttrCohort];
Alex Deymo8e18f932015-03-27 16:16:59 -0700549 }
Amin Hassani6600a562018-09-24 15:17:19 -0700550 if (attrs.find(kAttrCohortHint) != attrs.end()) {
Sen Jiangb1e063a2017-09-15 17:44:31 -0700551 app.cohorthint_set = true;
Amin Hassani6600a562018-09-24 15:17:19 -0700552 app.cohorthint = attrs[kAttrCohortHint];
Alex Deymo8e18f932015-03-27 16:16:59 -0700553 }
Amin Hassani6600a562018-09-24 15:17:19 -0700554 if (attrs.find(kAttrCohortName) != attrs.end()) {
Sen Jiangb1e063a2017-09-15 17:44:31 -0700555 app.cohortname_set = true;
Amin Hassani6600a562018-09-24 15:17:19 -0700556 app.cohortname = attrs[kAttrCohortName];
Alex Deymo8e18f932015-03-27 16:16:59 -0700557 }
Sen Jiangb1e063a2017-09-15 17:44:31 -0700558 data->apps.push_back(std::move(app));
Alex Deymo8e18f932015-03-27 16:16:59 -0700559 } else if (data->current_path == "/response/app/updatecheck") {
Sen Jiang81259682017-03-30 15:11:30 -0700560 if (!data->apps.empty())
Amin Hassani6600a562018-09-24 15:17:19 -0700561 data->apps.back().updatecheck_status = attrs[kAttrStatus];
Sen Jiang81259682017-03-30 15:11:30 -0700562 if (data->updatecheck_poll_interval.empty())
Amin Hassani6600a562018-09-24 15:17:19 -0700563 data->updatecheck_poll_interval = attrs[kAttrPollInterval];
Alex Deymob3fa53b2016-04-18 19:57:58 -0700564 // Omaha sends arbitrary key-value pairs as extra attributes starting with
565 // an underscore.
566 for (const auto& attr : attrs) {
567 if (!attr.first.empty() && attr.first[0] == '_')
568 data->updatecheck_attrs[attr.first.substr(1)] = attr.second;
569 }
David Zeuthene8ed8632014-07-24 13:38:10 -0400570 } else if (data->current_path == "/response/daystart") {
571 // Get the install-date.
Amin Hassani6600a562018-09-24 15:17:19 -0700572 data->daystart_elapsed_days = attrs[kAttrElapsedDays];
573 data->daystart_elapsed_seconds = attrs[kAttrElapsedSeconds];
David Zeuthene8ed8632014-07-24 13:38:10 -0400574 } else if (data->current_path == "/response/app/updatecheck/urls/url") {
575 // Look at all <url> elements.
Sen Jiang81259682017-03-30 15:11:30 -0700576 if (!data->apps.empty())
Amin Hassani6600a562018-09-24 15:17:19 -0700577 data->apps.back().url_codebase.push_back(attrs[kAttrCodeBase]);
Sen Jiang0affc2c2017-02-10 15:55:05 -0800578 } else if (data->current_path ==
David Zeuthene8ed8632014-07-24 13:38:10 -0400579 "/response/app/updatecheck/manifest/packages/package") {
Sen Jiang0affc2c2017-02-10 15:55:05 -0800580 // Look at all <package> elements.
Sen Jiang81259682017-03-30 15:11:30 -0700581 if (!data->apps.empty())
Amin Hassani6600a562018-09-24 15:17:19 -0700582 data->apps.back().packages.push_back({.name = attrs[kAttrName],
583 .size = attrs[kAttrSize],
584 .hash = attrs[kAttrHashSha256]});
David Zeuthene8ed8632014-07-24 13:38:10 -0400585 } else if (data->current_path == "/response/app/updatecheck/manifest") {
586 // Get the version.
Sen Jiang81259682017-03-30 15:11:30 -0700587 if (!data->apps.empty())
Amin Hassani6600a562018-09-24 15:17:19 -0700588 data->apps.back().manifest_version = attrs[kAttrVersion];
David Zeuthene8ed8632014-07-24 13:38:10 -0400589 } else if (data->current_path ==
590 "/response/app/updatecheck/manifest/actions/action") {
591 // We only care about the postinstall action.
Amin Hassani6600a562018-09-24 15:17:19 -0700592 if (attrs[kAttrEvent] == kValPostInstall && !data->apps.empty()) {
Sen Jiang81259682017-03-30 15:11:30 -0700593 data->apps.back().action_postinstall_attrs = std::move(attrs);
David Zeuthene8ed8632014-07-24 13:38:10 -0400594 }
595 }
596}
597
598// Callback function invoked by expat.
599void ParserHandlerEnd(void* user_data, const XML_Char* element) {
600 OmahaParserData* data = reinterpret_cast<OmahaParserData*>(user_data);
601 if (data->failed)
602 return;
603
604 const string path_suffix = string("/") + element;
605
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800606 if (!base::EndsWith(
607 data->current_path, path_suffix, base::CompareCase::SENSITIVE)) {
David Zeuthene8ed8632014-07-24 13:38:10 -0400608 LOG(ERROR) << "Unexpected end element '" << element
609 << "' with current_path='" << data->current_path << "'";
610 data->failed = true;
611 return;
612 }
613 data->current_path.resize(data->current_path.size() - path_suffix.size());
614}
615
David Zeuthenf3e28012014-08-26 18:23:52 -0400616// Callback function invoked by expat.
617//
618// This is called for entity declarations. Since Omaha is guaranteed
619// to never return any XML with entities our course of action is to
620// just stop parsing. This avoids potential resource exhaustion
621// problems AKA the "billion laughs". CVE-2013-0340.
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800622void ParserHandlerEntityDecl(void* user_data,
623 const XML_Char* entity_name,
David Zeuthenf3e28012014-08-26 18:23:52 -0400624 int is_parameter_entity,
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800625 const XML_Char* value,
David Zeuthenf3e28012014-08-26 18:23:52 -0400626 int value_length,
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800627 const XML_Char* base,
628 const XML_Char* system_id,
629 const XML_Char* public_id,
630 const XML_Char* notation_name) {
David Zeuthenf3e28012014-08-26 18:23:52 -0400631 OmahaParserData* data = reinterpret_cast<OmahaParserData*>(user_data);
632
633 LOG(ERROR) << "XML entities are not supported. Aborting parsing.";
634 data->failed = true;
635 data->entity_decl = true;
636 XML_StopParser(data->xml_parser, false);
637}
638
David Zeuthene8ed8632014-07-24 13:38:10 -0400639} // namespace
640
Alex Deymob0d74eb2015-03-30 17:59:17 -0700641bool XmlEncode(const string& input, string* output) {
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800642 if (std::find_if(input.begin(), input.end(), [](const char c) {
643 return c & 0x80;
644 }) != input.end()) {
Alex Deymob0d74eb2015-03-30 17:59:17 -0700645 LOG(WARNING) << "Invalid ASCII-7 string passed to the XML encoder:";
646 utils::HexDumpString(input);
647 return false;
648 }
Alex Deymocc457852015-06-18 18:35:50 -0700649 output->clear();
650 // We need at least input.size() space in the output, but the code below will
651 // handle it if we need more.
652 output->reserve(input.size());
653 for (char c : input) {
654 switch (c) {
655 case '\"':
656 output->append("&quot;");
657 break;
658 case '\'':
659 output->append("&apos;");
660 break;
661 case '&':
662 output->append("&amp;");
663 break;
664 case '<':
665 output->append("&lt;");
666 break;
667 case '>':
668 output->append("&gt;");
669 break;
670 default:
671 output->push_back(c);
672 }
673 }
Alex Deymob0d74eb2015-03-30 17:59:17 -0700674 return true;
675}
676
677string XmlEncodeWithDefault(const string& input, const string& default_value) {
678 string output;
679 if (XmlEncode(input, &output))
680 return output;
681 return default_value;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000682}
683
Alex Deymoc1c17b42015-11-23 03:53:15 -0300684OmahaRequestAction::OmahaRequestAction(
685 SystemState* system_state,
686 OmahaEvent* event,
687 std::unique_ptr<HttpFetcher> http_fetcher,
688 bool ping_only)
Jay Srinivasan6f6ea002012-12-14 11:26:28 -0800689 : system_state_(system_state),
Zentaro Kavanagh1f899d52018-02-27 15:02:47 -0800690 params_(system_state->request_params()),
Darin Petkova4a8a8c2010-07-15 22:21:12 -0700691 event_(event),
Alex Deymoc1c17b42015-11-23 03:53:15 -0300692 http_fetcher_(std::move(http_fetcher)),
Zentaro Kavanagh1f899d52018-02-27 15:02:47 -0800693 policy_provider_(std::make_unique<policy::PolicyProvider>()),
Thieu Le116fda32011-04-19 11:01:54 -0700694 ping_only_(ping_only),
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700695 ping_active_days_(0),
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700696 ping_roll_call_days_(0) {
Zentaro Kavanagh1f899d52018-02-27 15:02:47 -0800697 policy_provider_->Reload();
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700698}
rspangler@google.com49fdf182009-10-10 00:57:34 +0000699
Darin Petkov6a5b3222010-07-13 14:55:28 -0700700OmahaRequestAction::~OmahaRequestAction() {}
rspangler@google.com49fdf182009-10-10 00:57:34 +0000701
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700702// Calculates the value to use for the ping days parameter.
703int OmahaRequestAction::CalculatePingDays(const string& key) {
704 int days = kNeverPinged;
705 int64_t last_ping = 0;
Jay Srinivasan6f6ea002012-12-14 11:26:28 -0800706 if (system_state_->prefs()->GetInt64(key, &last_ping) && last_ping >= 0) {
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700707 days = (Time::Now() - Time::FromInternalValue(last_ping)).InDays();
708 if (days < 0) {
709 // If |days| is negative, then the system clock must have jumped
710 // back in time since the ping was sent. Mark the value so that
711 // it doesn't get sent to the server but we still update the
712 // last ping daystart preference. This way the next ping time
713 // will be correct, hopefully.
714 days = kPingTimeJump;
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800715 LOG(WARNING)
716 << "System clock jumped back in time. Resetting ping daystarts.";
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700717 }
718 }
719 return days;
720}
721
722void OmahaRequestAction::InitPingDays() {
723 // We send pings only along with update checks, not with events.
724 if (IsEvent()) {
725 return;
726 }
727 // TODO(petkov): Figure a way to distinguish active use pings
728 // vs. roll call pings. Currently, the two pings are identical. A
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700729 // fix needs to change this code as well as UpdateLastPingDays and ShouldPing.
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700730 ping_active_days_ = CalculatePingDays(kPrefsLastActivePingDay);
731 ping_roll_call_days_ = CalculatePingDays(kPrefsLastRollCallPingDay);
732}
733
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700734bool OmahaRequestAction::ShouldPing() const {
735 if (ping_active_days_ == OmahaRequestAction::kNeverPinged &&
736 ping_roll_call_days_ == OmahaRequestAction::kNeverPinged) {
737 int powerwash_count = system_state_->hardware()->GetPowerwashCount();
738 if (powerwash_count > 0) {
739 LOG(INFO) << "Not sending ping with a=-1 r=-1 to omaha because "
740 << "powerwash_count is " << powerwash_count;
741 return false;
742 }
Amin Hassani1677e812017-06-21 13:36:36 -0700743 if (system_state_->hardware()->GetFirstActiveOmahaPingSent()) {
744 LOG(INFO) << "Not sending ping with a=-1 r=-1 to omaha because "
745 << "the first_active_omaha_ping_sent is true";
746 return false;
747 }
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700748 return true;
749 }
750 return ping_active_days_ > 0 || ping_roll_call_days_ > 0;
751}
752
David Zeuthen639aa362014-02-03 16:23:44 -0800753// static
754int OmahaRequestAction::GetInstallDate(SystemState* system_state) {
755 PrefsInterface* prefs = system_state->prefs();
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700756 if (prefs == nullptr)
David Zeuthen639aa362014-02-03 16:23:44 -0800757 return -1;
758
759 // If we have the value stored on disk, just return it.
760 int64_t stored_value;
761 if (prefs->GetInt64(kPrefsInstallDateDays, &stored_value)) {
762 // Convert and sanity-check.
763 int install_date_days = static_cast<int>(stored_value);
764 if (install_date_days >= 0)
765 return install_date_days;
766 LOG(ERROR) << "Dropping stored Omaha InstallData since its value num_days="
767 << install_date_days << " looks suspicious.";
768 prefs->Delete(kPrefsInstallDateDays);
769 }
770
771 // Otherwise, if OOBE is not complete then do nothing and wait for
772 // ParseResponse() to call ParseInstallDate() and then
773 // PersistInstallDate() to set the kPrefsInstallDateDays state
774 // variable. Once that is done, we'll then report back in future
775 // Omaha requests. This works exactly because OOBE triggers an
776 // update check.
777 //
778 // However, if OOBE is complete and the kPrefsInstallDateDays state
779 // variable is not set, there are two possibilities
780 //
781 // 1. The update check in OOBE failed so we never got a response
782 // from Omaha (no network etc.); or
783 //
784 // 2. OOBE was done on an older version that didn't write to the
785 // kPrefsInstallDateDays state variable.
786 //
787 // In both cases, we approximate the install date by simply
788 // inspecting the timestamp of when OOBE happened.
789
790 Time time_of_oobe;
Alex Deymo46a9aae2016-05-04 20:20:11 -0700791 if (!system_state->hardware()->IsOOBEEnabled() ||
792 !system_state->hardware()->IsOOBEComplete(&time_of_oobe)) {
David Zeuthen639aa362014-02-03 16:23:44 -0800793 LOG(INFO) << "Not generating Omaha InstallData as we have "
Alex Deymo46a9aae2016-05-04 20:20:11 -0700794 << "no prefs file and OOBE is not complete or not enabled.";
David Zeuthen639aa362014-02-03 16:23:44 -0800795 return -1;
796 }
797
798 int num_days;
799 if (!utils::ConvertToOmahaInstallDate(time_of_oobe, &num_days)) {
800 LOG(ERROR) << "Not generating Omaha InstallData from time of OOBE "
801 << "as its value '" << utils::ToString(time_of_oobe)
802 << "' looks suspicious.";
803 return -1;
804 }
805
806 // Persist this to disk, for future use.
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800807 if (!OmahaRequestAction::PersistInstallDate(
808 system_state, num_days, kProvisionedFromOOBEMarker))
David Zeuthen639aa362014-02-03 16:23:44 -0800809 return -1;
810
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800811 LOG(INFO) << "Set the Omaha InstallDate from OOBE time-stamp to " << num_days
812 << " days";
David Zeuthen639aa362014-02-03 16:23:44 -0800813
814 return num_days;
815}
816
Darin Petkov6a5b3222010-07-13 14:55:28 -0700817void OmahaRequestAction::PerformAction() {
rspangler@google.com49fdf182009-10-10 00:57:34 +0000818 http_fetcher_->set_delegate(this);
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700819 InitPingDays();
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700820 if (ping_only_ && !ShouldPing()) {
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700821 processor_->ActionComplete(this, ErrorCode::kSuccess);
Thieu Leb44e9e82011-06-06 14:34:04 -0700822 return;
823 }
David Zeuthen639aa362014-02-03 16:23:44 -0800824
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700825 string request_post(GetRequestXml(event_.get(),
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700826 params_,
Thieu Le116fda32011-04-19 11:01:54 -0700827 ping_only_,
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700828 ShouldPing(), // include_ping
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700829 ping_active_days_,
Darin Petkov95508da2011-01-05 12:42:29 -0800830 ping_roll_call_days_,
David Zeuthen639aa362014-02-03 16:23:44 -0800831 GetInstallDate(system_state_),
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700832 system_state_));
Jay Srinivasan0a708742012-03-20 11:26:12 -0700833
Sen Jiang42fa45e2018-03-12 11:02:14 -0700834 // Set X-Goog-Update headers.
Alex Deymo14ad88e2016-06-29 12:30:14 -0700835 http_fetcher_->SetHeader(kXGoogleUpdateInteractivity,
836 params_->interactive() ? "fg" : "bg");
837 http_fetcher_->SetHeader(kXGoogleUpdateAppId, params_->GetAppId());
838 http_fetcher_->SetHeader(
839 kXGoogleUpdateUpdater,
840 base::StringPrintf(
841 "%s-%s", constants::kOmahaUpdaterID, kOmahaUpdaterVersion));
842
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800843 http_fetcher_->SetPostData(
844 request_post.data(), request_post.size(), kHttpContentTypeTextXml);
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700845 LOG(INFO) << "Posting an Omaha request to " << params_->update_url();
Andrew de los Reyesf98bff82010-05-06 13:33:25 -0700846 LOG(INFO) << "Request: " << request_post;
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700847 http_fetcher_->BeginTransfer(params_->update_url());
rspangler@google.com49fdf182009-10-10 00:57:34 +0000848}
849
Darin Petkov6a5b3222010-07-13 14:55:28 -0700850void OmahaRequestAction::TerminateProcessing() {
rspangler@google.com49fdf182009-10-10 00:57:34 +0000851 http_fetcher_->TerminateTransfer();
852}
853
854// We just store the response in the buffer. Once we've received all bytes,
855// we'll look in the buffer and decide what to do.
Amin Hassani0cd9d772018-07-31 23:55:43 -0700856bool OmahaRequestAction::ReceivedBytes(HttpFetcher* fetcher,
Alex Vakulenkof68bbbc2015-02-09 12:53:18 -0800857 const void* bytes,
858 size_t length) {
859 const uint8_t* byte_ptr = reinterpret_cast<const uint8_t*>(bytes);
860 response_buffer_.insert(response_buffer_.end(), byte_ptr, byte_ptr + length);
Amin Hassani0cd9d772018-07-31 23:55:43 -0700861 return true;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000862}
863
864namespace {
rspangler@google.com49fdf182009-10-10 00:57:34 +0000865
866// Parses a 64 bit base-10 int from a string and returns it. Returns 0
867// on error. If the string contains "0", that's indistinguishable from
868// error.
869off_t ParseInt(const string& str) {
870 off_t ret = 0;
Gilad Arnoldec7f9162014-07-15 13:24:46 -0700871 int rc = sscanf(str.c_str(), "%" PRIi64, &ret); // NOLINT(runtime/printf)
rspangler@google.com49fdf182009-10-10 00:57:34 +0000872 if (rc < 1) {
873 // failure
874 return 0;
875 }
876 return ret;
877}
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700878
David Zeuthene8ed8632014-07-24 13:38:10 -0400879// Parses |str| and returns |true| if, and only if, its value is "true".
880bool ParseBool(const string& str) {
881 return str == "true";
882}
883
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700884// Update the last ping day preferences based on the server daystart
885// response. Returns true on success, false otherwise.
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800886bool UpdateLastPingDays(OmahaParserData* parser_data, PrefsInterface* prefs) {
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700887 int64_t elapsed_seconds = 0;
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800888 TEST_AND_RETURN_FALSE(base::StringToInt64(
889 parser_data->daystart_elapsed_seconds, &elapsed_seconds));
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700890 TEST_AND_RETURN_FALSE(elapsed_seconds >= 0);
891
892 // Remember the local time that matches the server's last midnight
893 // time.
894 Time daystart = Time::Now() - TimeDelta::FromSeconds(elapsed_seconds);
895 prefs->SetInt64(kPrefsLastActivePingDay, daystart.ToInternalValue());
896 prefs->SetInt64(kPrefsLastRollCallPingDay, daystart.ToInternalValue());
897 return true;
898}
Sen Jiang81259682017-03-30 15:11:30 -0700899
900// Parses the package node in the given XML document and populates
901// |output_object| if valid. Returns true if we should continue the parsing.
902// False otherwise, in which case it sets any error code using |completer|.
903bool ParsePackage(OmahaParserData::App* app,
904 OmahaResponse* output_object,
905 ScopedActionCompleter* completer) {
Xiaochu Liu6310be62018-10-11 15:09:03 -0700906 if (app->updatecheck_status.empty() ||
907 app->updatecheck_status == kValNoUpdate) {
Sen Jiang81259682017-03-30 15:11:30 -0700908 if (!app->packages.empty()) {
909 LOG(ERROR) << "No update in this <app> but <package> is not empty.";
910 completer->set_code(ErrorCode::kOmahaResponseInvalid);
911 return false;
912 }
913 return true;
914 }
915 if (app->packages.empty()) {
916 LOG(ERROR) << "Omaha Response has no packages";
917 completer->set_code(ErrorCode::kOmahaResponseInvalid);
918 return false;
919 }
920 if (app->url_codebase.empty()) {
921 LOG(ERROR) << "No Omaha Response URLs";
922 completer->set_code(ErrorCode::kOmahaResponseInvalid);
923 return false;
924 }
925 LOG(INFO) << "Found " << app->url_codebase.size() << " url(s)";
926 vector<string> metadata_sizes =
Amin Hassani6600a562018-09-24 15:17:19 -0700927 base::SplitString(app->action_postinstall_attrs[kAttrMetadataSize],
Sen Jiang81259682017-03-30 15:11:30 -0700928 ":",
929 base::TRIM_WHITESPACE,
930 base::SPLIT_WANT_ALL);
Amin Hassani6600a562018-09-24 15:17:19 -0700931 vector<string> metadata_signatures = base::SplitString(
932 app->action_postinstall_attrs[kAttrMetadataSignatureRsa],
933 ":",
934 base::TRIM_WHITESPACE,
935 base::SPLIT_WANT_ALL);
Sen Jiangcdd52062017-05-18 15:33:10 -0700936 vector<string> is_delta_payloads =
Amin Hassani6600a562018-09-24 15:17:19 -0700937 base::SplitString(app->action_postinstall_attrs[kAttrIsDeltaPayload],
Sen Jiangcdd52062017-05-18 15:33:10 -0700938 ":",
939 base::TRIM_WHITESPACE,
940 base::SPLIT_WANT_ALL);
Sen Jiang81259682017-03-30 15:11:30 -0700941 for (size_t i = 0; i < app->packages.size(); i++) {
942 const auto& package = app->packages[i];
943 if (package.name.empty()) {
944 LOG(ERROR) << "Omaha Response has empty package name";
945 completer->set_code(ErrorCode::kOmahaResponseInvalid);
946 return false;
947 }
948 LOG(INFO) << "Found package " << package.name;
949
950 OmahaResponse::Package out_package;
951 for (const string& codebase : app->url_codebase) {
952 if (codebase.empty()) {
953 LOG(ERROR) << "Omaha Response URL has empty codebase";
954 completer->set_code(ErrorCode::kOmahaResponseInvalid);
955 return false;
956 }
957 out_package.payload_urls.push_back(codebase + package.name);
958 }
959 // Parse the payload size.
960 base::StringToUint64(package.size, &out_package.size);
961 if (out_package.size <= 0) {
962 LOG(ERROR) << "Omaha Response has invalid payload size: " << package.size;
963 completer->set_code(ErrorCode::kOmahaResponseInvalid);
964 return false;
965 }
966 LOG(INFO) << "Payload size = " << out_package.size << " bytes";
967
968 if (i < metadata_sizes.size())
969 base::StringToUint64(metadata_sizes[i], &out_package.metadata_size);
970 LOG(INFO) << "Payload metadata size = " << out_package.metadata_size
971 << " bytes";
972
973 if (i < metadata_signatures.size())
974 out_package.metadata_signature = metadata_signatures[i];
975 LOG(INFO) << "Payload metadata signature = "
976 << out_package.metadata_signature;
977
978 out_package.hash = package.hash;
979 if (out_package.hash.empty()) {
980 LOG(ERROR) << "Omaha Response has empty hash_sha256 value";
981 completer->set_code(ErrorCode::kOmahaResponseInvalid);
982 return false;
983 }
984 LOG(INFO) << "Payload hash = " << out_package.hash;
Sen Jiangcdd52062017-05-18 15:33:10 -0700985
986 if (i < is_delta_payloads.size())
987 out_package.is_delta = ParseBool(is_delta_payloads[i]);
988 LOG(INFO) << "Payload is delta = " << utils::ToString(out_package.is_delta);
989
Sen Jiang81259682017-03-30 15:11:30 -0700990 output_object->packages.push_back(std::move(out_package));
991 }
992
993 return true;
994}
995
Zentaro Kavanagh0ff621c2018-07-13 13:06:56 -0700996// Parses the 2 key version strings kernel_version and firmware_version. If the
997// field is not present, or cannot be parsed the values default to 0xffff.
Zentaro Kavanagh0ef9a2f2018-07-02 12:05:07 -0700998void ParseRollbackVersions(int allowed_milestones,
999 OmahaParserData* parser_data,
Zentaro Kavanagh0ff621c2018-07-13 13:06:56 -07001000 OmahaResponse* output_object) {
1001 utils::ParseRollbackKeyVersion(
Amin Hassani6600a562018-09-24 15:17:19 -07001002 parser_data->updatecheck_attrs[kAttrFirmwareVersion],
Zentaro Kavanagh0ff621c2018-07-13 13:06:56 -07001003 &output_object->rollback_key_version.firmware_key,
1004 &output_object->rollback_key_version.firmware);
1005 utils::ParseRollbackKeyVersion(
Amin Hassani6600a562018-09-24 15:17:19 -07001006 parser_data->updatecheck_attrs[kAttrKernelVersion],
Zentaro Kavanagh0ff621c2018-07-13 13:06:56 -07001007 &output_object->rollback_key_version.kernel_key,
1008 &output_object->rollback_key_version.kernel);
Zentaro Kavanagh0ef9a2f2018-07-02 12:05:07 -07001009
1010 // Create the attribute name strings for milestone N - allowed_milestones.
1011 const string firmware_max_rollforward_attr =
1012 base::StringPrintf("%s_%i", kAttrFirmwareVersion, allowed_milestones);
1013 const string kernel_max_rollforward_attr =
1014 base::StringPrintf("%s_%i", kAttrKernelVersion, allowed_milestones);
1015
1016 const bool max_firmware_and_kernel_exist =
1017 parser_data->updatecheck_attrs.count(firmware_max_rollforward_attr) > 0 &&
1018 parser_data->updatecheck_attrs.count(kernel_max_rollforward_attr) > 0;
1019
1020 string firmware_version;
1021 string kernel_version;
1022 if (max_firmware_and_kernel_exist) {
1023 firmware_version =
1024 parser_data->updatecheck_attrs[firmware_max_rollforward_attr];
1025 kernel_version =
1026 parser_data->updatecheck_attrs[kernel_max_rollforward_attr];
1027 }
1028
1029 LOG(INFO) << "For milestone N-" << allowed_milestones
1030 << " firmware_key_version=" << firmware_version
1031 << " kernel_key_version=" << kernel_version;
1032
1033 OmahaResponse::RollbackKeyVersion version;
1034 utils::ParseRollbackKeyVersion(
1035 firmware_version, &version.firmware_key, &version.firmware);
1036 utils::ParseRollbackKeyVersion(
1037 kernel_version, &version.kernel_key, &version.kernel);
1038
1039 output_object->past_rollback_key_version = std::move(version);
Zentaro Kavanagh0ff621c2018-07-13 13:06:56 -07001040}
1041
Alex Vakulenkod2779df2014-06-16 13:19:00 -07001042} // namespace
rspangler@google.com49fdf182009-10-10 00:57:34 +00001043
David Zeuthene8ed8632014-07-24 13:38:10 -04001044bool OmahaRequestAction::ParseResponse(OmahaParserData* parser_data,
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001045 OmahaResponse* output_object,
1046 ScopedActionCompleter* completer) {
Sen Jiang81259682017-03-30 15:11:30 -07001047 if (parser_data->apps.empty()) {
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -07001048 completer->set_code(ErrorCode::kOmahaResponseInvalid);
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001049 return false;
1050 }
Sen Jiang81259682017-03-30 15:11:30 -07001051 LOG(INFO) << "Found " << parser_data->apps.size() << " <app>.";
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001052
Jay Srinivasan6f6ea002012-12-14 11:26:28 -08001053 // chromium-os:37289: The PollInterval is not supported by Omaha server
1054 // currently. But still keeping this existing code in case we ever decide to
Gilad Arnoldec7f9162014-07-15 13:24:46 -07001055 // slow down the request rate from the server-side. Note that the PollInterval
1056 // is not persisted, so it has to be sent by the server on every response to
1057 // guarantee that the scheduler uses this value (otherwise, if the device got
1058 // rebooted after the last server-indicated value, it'll revert to the default
1059 // value). Also kDefaultMaxUpdateChecks value for the scattering logic is
1060 // based on the assumption that we perform an update check every hour so that
1061 // the max value of 8 will roughly be equivalent to one work day. If we decide
1062 // to use PollInterval permanently, we should update the
1063 // max_update_checks_allowed to take PollInterval into account. Note: The
1064 // parsing for PollInterval happens even before parsing of the status because
1065 // we may want to specify the PollInterval even when there's no update.
David Zeuthene8ed8632014-07-24 13:38:10 -04001066 base::StringToInt(parser_data->updatecheck_poll_interval,
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001067 &output_object->poll_interval);
1068
David Zeuthen639aa362014-02-03 16:23:44 -08001069 // Check for the "elapsed_days" attribute in the "daystart"
1070 // element. This is the number of days since Jan 1 2007, 0:00
1071 // PST. If we don't have a persisted value of the Omaha InstallDate,
1072 // we'll use it to calculate it and then persist it.
David Zeuthene8ed8632014-07-24 13:38:10 -04001073 if (ParseInstallDate(parser_data, output_object) &&
1074 !HasInstallDate(system_state_)) {
David Zeuthen639aa362014-02-03 16:23:44 -08001075 // Since output_object->install_date_days is never negative, the
1076 // elapsed_days -> install-date calculation is reduced to simply
1077 // rounding down to the nearest number divisible by 7.
1078 int remainder = output_object->install_date_days % 7;
1079 int install_date_days_rounded =
1080 output_object->install_date_days - remainder;
1081 if (PersistInstallDate(system_state_,
1082 install_date_days_rounded,
1083 kProvisionedFromOmahaResponse)) {
1084 LOG(INFO) << "Set the Omaha InstallDate from Omaha Response to "
1085 << install_date_days_rounded << " days";
1086 }
1087 }
1088
Alex Deymo00d79ac2015-06-29 15:41:49 -07001089 // We persist the cohorts sent by omaha even if the status is "noupdate".
Sen Jiangb1e063a2017-09-15 17:44:31 -07001090 for (const auto& app : parser_data->apps) {
1091 if (app.id == params_->GetAppId()) {
1092 if (app.cohort_set)
1093 PersistCohortData(kPrefsOmahaCohort, app.cohort);
1094 if (app.cohorthint_set)
1095 PersistCohortData(kPrefsOmahaCohortHint, app.cohorthint);
1096 if (app.cohortname_set)
1097 PersistCohortData(kPrefsOmahaCohortName, app.cohortname);
1098 break;
1099 }
1100 }
Alex Deymo00d79ac2015-06-29 15:41:49 -07001101
Alex Deymob3fa53b2016-04-18 19:57:58 -07001102 // Parse the updatecheck attributes.
1103 PersistEolStatus(parser_data->updatecheck_attrs);
Marton Hunyady199152d2018-05-07 19:08:48 +02001104 // Rollback-related updatecheck attributes.
1105 // Defaults to false if attribute is not present.
1106 output_object->is_rollback =
Amin Hassani6600a562018-09-24 15:17:19 -07001107 ParseBool(parser_data->updatecheck_attrs[kAttrRollback]);
Zentaro Kavanagh0ff621c2018-07-13 13:06:56 -07001108
1109 // Parses the rollback versions of the current image. If the fields do not
1110 // exist they default to 0xffff for the 4 key versions.
Zentaro Kavanagh0ef9a2f2018-07-02 12:05:07 -07001111 ParseRollbackVersions(
1112 params_->rollback_allowed_milestones(), parser_data, output_object);
Alex Deymob3fa53b2016-04-18 19:57:58 -07001113
David Zeuthene8ed8632014-07-24 13:38:10 -04001114 if (!ParseStatus(parser_data, output_object, completer))
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001115 return false;
1116
David Zeuthene8ed8632014-07-24 13:38:10 -04001117 if (!ParseParams(parser_data, output_object, completer))
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001118 return false;
1119
Sen Jiang0affc2c2017-02-10 15:55:05 -08001120 // Package has to be parsed after Params now because ParseParams need to make
1121 // sure that postinstall action exists.
Sen Jiang81259682017-03-30 15:11:30 -07001122 for (auto& app : parser_data->apps)
1123 if (!ParsePackage(&app, output_object, completer))
1124 return false;
Sen Jiang0affc2c2017-02-10 15:55:05 -08001125
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001126 return true;
1127}
1128
David Zeuthene8ed8632014-07-24 13:38:10 -04001129bool OmahaRequestAction::ParseStatus(OmahaParserData* parser_data,
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001130 OmahaResponse* output_object,
1131 ScopedActionCompleter* completer) {
Sen Jiang81259682017-03-30 15:11:30 -07001132 output_object->update_exists = false;
Xiaochu Liu6310be62018-10-11 15:09:03 -07001133 for (const auto& app : parser_data->apps) {
1134 const string& status = app.updatecheck_status;
Amin Hassani6600a562018-09-24 15:17:19 -07001135 if (status == kValNoUpdate) {
Sen Jiang00adf7b2017-06-26 15:57:29 -07001136 // Don't update if any app has status="noupdate".
Xiaochu Liu6310be62018-10-11 15:09:03 -07001137 LOG(INFO) << "No update for <app> " << app.id;
Sen Jiang00adf7b2017-06-26 15:57:29 -07001138 output_object->update_exists = false;
1139 break;
Sen Jiang81259682017-03-30 15:11:30 -07001140 } else if (status == "ok") {
Xiaochu Liu6310be62018-10-11 15:09:03 -07001141 auto const& attr_no_update =
1142 app.action_postinstall_attrs.find(kAttrNoUpdate);
1143 if (attr_no_update != app.action_postinstall_attrs.end() &&
1144 attr_no_update->second == "true") {
Sen Jiang00adf7b2017-06-26 15:57:29 -07001145 // noupdate="true" in postinstall attributes means it's an update to
1146 // self, only update if there's at least one app really have update.
Xiaochu Liu6310be62018-10-11 15:09:03 -07001147 LOG(INFO) << "Update to self for <app> " << app.id;
Sen Jiang00adf7b2017-06-26 15:57:29 -07001148 } else {
Xiaochu Liu6310be62018-10-11 15:09:03 -07001149 LOG(INFO) << "Update for <app> " << app.id;
Sen Jiang00adf7b2017-06-26 15:57:29 -07001150 output_object->update_exists = true;
1151 }
Xiaochu Liu6310be62018-10-11 15:09:03 -07001152 } else if (status.empty() && params_->is_install() &&
1153 params_->GetAppId() == app.id) {
1154 // Skips the platform app for install operation.
1155 LOG(INFO) << "No payload (and ignore) for <app> " << app.id;
Sen Jiang81259682017-03-30 15:11:30 -07001156 } else {
1157 LOG(ERROR) << "Unknown Omaha response status: " << status;
1158 completer->set_code(ErrorCode::kOmahaResponseInvalid);
1159 return false;
1160 }
1161 }
1162 if (!output_object->update_exists) {
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001163 SetOutputObject(*output_object);
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -07001164 completer->set_code(ErrorCode::kSuccess);
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001165 }
1166
Sen Jiang81259682017-03-30 15:11:30 -07001167 return output_object->update_exists;
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001168}
1169
David Zeuthene8ed8632014-07-24 13:38:10 -04001170bool OmahaRequestAction::ParseParams(OmahaParserData* parser_data,
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001171 OmahaResponse* output_object,
1172 ScopedActionCompleter* completer) {
Sen Jiang81259682017-03-30 15:11:30 -07001173 map<string, string> attrs;
1174 for (auto& app : parser_data->apps) {
Aaron Wood7dcdedf2017-09-06 17:17:41 -07001175 if (app.id == params_->GetAppId()) {
1176 // this is the app (potentially the only app)
Sen Jiang81259682017-03-30 15:11:30 -07001177 output_object->version = app.manifest_version;
Aaron Wood7dcdedf2017-09-06 17:17:41 -07001178 } else if (!params_->system_app_id().empty() &&
1179 app.id == params_->system_app_id()) {
1180 // this is the system app (this check is intentionally skipped if there is
1181 // no system_app_id set)
1182 output_object->system_version = app.manifest_version;
Xiaochu Liu6310be62018-10-11 15:09:03 -07001183 } else if (params_->is_install() &&
1184 app.manifest_version != params_->app_version()) {
1185 LOG(WARNING) << "An app has a different version (" << app.manifest_version
1186 << ") that is different than platform app version ("
1187 << params_->app_version() << ")";
Aaron Wood7dcdedf2017-09-06 17:17:41 -07001188 }
1189 if (!app.action_postinstall_attrs.empty() && attrs.empty()) {
Sen Jiang81259682017-03-30 15:11:30 -07001190 attrs = app.action_postinstall_attrs;
Aaron Wood7dcdedf2017-09-06 17:17:41 -07001191 }
Sen Jiang81259682017-03-30 15:11:30 -07001192 }
Xiaochu Liu6310be62018-10-11 15:09:03 -07001193 if (params_->is_install()) {
1194 LOG(INFO) << "Use request version for Install operation.";
1195 output_object->version = params_->app_version();
1196 }
Chris Sosa3b748432013-06-20 16:42:59 -07001197 if (output_object->version.empty()) {
Chris Sosaaa18e162013-06-20 13:20:30 -07001198 LOG(ERROR) << "Omaha Response does not have version in manifest!";
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -07001199 completer->set_code(ErrorCode::kOmahaResponseInvalid);
Chris Sosa3b748432013-06-20 16:42:59 -07001200 return false;
1201 }
1202
1203 LOG(INFO) << "Received omaha response to update to version "
1204 << output_object->version;
1205
David Zeuthene8ed8632014-07-24 13:38:10 -04001206 if (attrs.empty()) {
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001207 LOG(ERROR) << "Omaha Response has no postinstall event action";
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -07001208 completer->set_code(ErrorCode::kOmahaResponseInvalid);
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001209 return false;
1210 }
1211
Jay Srinivasan6f6ea002012-12-14 11:26:28 -08001212 // Get the optional properties one by one.
Amin Hassani6600a562018-09-24 15:17:19 -07001213 output_object->more_info_url = attrs[kAttrMoreInfo];
1214 output_object->prompt = ParseBool(attrs[kAttrPrompt]);
1215 output_object->deadline = attrs[kAttrDeadline];
1216 output_object->max_days_to_scatter = ParseInt(attrs[kAttrMaxDaysToScatter]);
David Zeuthen8f191b22013-08-06 12:27:50 -07001217 output_object->disable_p2p_for_downloading =
Amin Hassani6600a562018-09-24 15:17:19 -07001218 ParseBool(attrs[kAttrDisableP2PForDownloading]);
David Zeuthen8f191b22013-08-06 12:27:50 -07001219 output_object->disable_p2p_for_sharing =
Amin Hassani6600a562018-09-24 15:17:19 -07001220 ParseBool(attrs[kAttrDisableP2PForSharing]);
1221 output_object->public_key_rsa = attrs[kAttrPublicKeyRsa];
Jay Srinivasan2b5a0f02012-12-19 17:25:56 -08001222
Amin Hassani6600a562018-09-24 15:17:19 -07001223 string max = attrs[kAttrMaxFailureCountPerUrl];
Jay Srinivasan08262882012-12-28 19:29:43 -08001224 if (!base::StringToUint(max, &output_object->max_failure_count_per_url))
Jay Srinivasan2b5a0f02012-12-19 17:25:56 -08001225 output_object->max_failure_count_per_url = kDefaultMaxFailureCountPerUrl;
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001226
Jay Srinivasan08262882012-12-28 19:29:43 -08001227 output_object->disable_payload_backoff =
Amin Hassani6600a562018-09-24 15:17:19 -07001228 ParseBool(attrs[kAttrDisablePayloadBackoff]);
1229 output_object->powerwash_required = ParseBool(attrs[kAttrPowerwash]);
Jay Srinivasan08262882012-12-28 19:29:43 -08001230
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001231 return true;
1232}
1233
David Zeuthene8ed8632014-07-24 13:38:10 -04001234// If the transfer was successful, this uses expat to parse the response
rspangler@google.com49fdf182009-10-10 00:57:34 +00001235// and fill in the appropriate fields of the output object. Also, notifies
1236// the processor that we're done.
Amin Hassani7cc8bb02019-01-14 16:29:47 -08001237void OmahaRequestAction::TransferComplete(HttpFetcher* fetcher,
Darin Petkov6a5b3222010-07-13 14:55:28 -07001238 bool successful) {
rspangler@google.com49fdf182009-10-10 00:57:34 +00001239 ScopedActionCompleter completer(processor_, this);
Jay Srinivasan6f6ea002012-12-14 11:26:28 -08001240 string current_response(response_buffer_.begin(), response_buffer_.end());
1241 LOG(INFO) << "Omaha request response: " << current_response;
Darin Petkov0dc8e9a2010-07-14 14:51:57 -07001242
Gilad Arnold74b5f552014-10-07 08:17:16 -07001243 PayloadStateInterface* const payload_state = system_state_->payload_state();
1244
Zentaro Kavanagh76af2662018-05-15 10:54:53 -07001245 // Set the max kernel key version based on whether rollback is allowed.
1246 SetMaxKernelKeyVersionForRollback();
1247
Darin Petkov0dc8e9a2010-07-14 14:51:57 -07001248 // Events are best effort transactions -- assume they always succeed.
1249 if (IsEvent()) {
1250 CHECK(!HasOutputPipe()) << "No output pipe allowed for event requests.";
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -07001251 completer.set_code(ErrorCode::kSuccess);
Darin Petkov0dc8e9a2010-07-14 14:51:57 -07001252 return;
1253 }
1254
Andrew de los Reyesf98bff82010-05-06 13:33:25 -07001255 if (!successful) {
Darin Petkov0dc8e9a2010-07-14 14:51:57 -07001256 LOG(ERROR) << "Omaha request network transfer failed.";
Darin Petkovedc522e2010-11-05 09:35:17 -07001257 int code = GetHTTPResponseCode();
1258 // Makes sure we send sane error values.
1259 if (code < 0 || code >= 1000) {
1260 code = 999;
1261 }
David Zeuthena99981f2013-04-29 13:42:47 -07001262 completer.set_code(static_cast<ErrorCode>(
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -07001263 static_cast<int>(ErrorCode::kOmahaRequestHTTPResponseBase) + code));
rspangler@google.com49fdf182009-10-10 00:57:34 +00001264 return;
Andrew de los Reyesf98bff82010-05-06 13:33:25 -07001265 }
rspangler@google.com49fdf182009-10-10 00:57:34 +00001266
David Zeuthene8ed8632014-07-24 13:38:10 -04001267 XML_Parser parser = XML_ParserCreate(nullptr);
David Zeuthenf3e28012014-08-26 18:23:52 -04001268 OmahaParserData parser_data(parser);
David Zeuthene8ed8632014-07-24 13:38:10 -04001269 XML_SetUserData(parser, &parser_data);
1270 XML_SetElementHandler(parser, ParserHandlerStart, ParserHandlerEnd);
David Zeuthenf3e28012014-08-26 18:23:52 -04001271 XML_SetEntityDeclHandler(parser, ParserHandlerEntityDecl);
Amin Hassani7cc8bb02019-01-14 16:29:47 -08001272 XML_Status res =
1273 XML_Parse(parser,
1274 reinterpret_cast<const char*>(response_buffer_.data()),
1275 response_buffer_.size(),
1276 XML_TRUE);
David Zeuthene8ed8632014-07-24 13:38:10 -04001277
1278 if (res != XML_STATUS_OK || parser_data.failed) {
Alex Deymoa9bb7dc2015-06-19 09:50:23 -07001279 LOG(ERROR) << "Omaha response not valid XML: "
Amin Hassani7cc8bb02019-01-14 16:29:47 -08001280 << XML_ErrorString(XML_GetErrorCode(parser)) << " at line "
1281 << XML_GetCurrentLineNumber(parser) << " col "
1282 << XML_GetCurrentColumnNumber(parser);
Amin Hassani91f48b42018-08-06 17:47:14 -07001283 XML_ParserFree(parser);
David Zeuthenf3e28012014-08-26 18:23:52 -04001284 ErrorCode error_code = ErrorCode::kOmahaRequestXMLParseError;
1285 if (response_buffer_.empty()) {
1286 error_code = ErrorCode::kOmahaRequestEmptyResponseError;
1287 } else if (parser_data.entity_decl) {
1288 error_code = ErrorCode::kOmahaRequestXMLHasEntityDecl;
1289 }
1290 completer.set_code(error_code);
rspangler@google.com49fdf182009-10-10 00:57:34 +00001291 return;
1292 }
Amin Hassani91f48b42018-08-06 17:47:14 -07001293 XML_ParserFree(parser);
rspangler@google.com49fdf182009-10-10 00:57:34 +00001294
Alex Deymoebbe7ef2014-10-30 13:02:49 -07001295 // Update the last ping day preferences based on the server daystart response
1296 // even if we didn't send a ping. Omaha always includes the daystart in the
1297 // response, but log the error if it didn't.
1298 LOG_IF(ERROR, !UpdateLastPingDays(&parser_data, system_state_->prefs()))
1299 << "Failed to update the last ping day preferences!";
Darin Petkov1cbd78f2010-07-29 12:38:34 -07001300
Amin Hassani1677e812017-06-21 13:36:36 -07001301 // Sets first_active_omaha_ping_sent to true (vpd in CrOS). We only do this if
1302 // we have got a response from omaha and if its value has never been set to
1303 // true before. Failure of this function should be ignored. There should be no
1304 // need to check if a=-1 has been sent because older devices have already sent
1305 // their a=-1 in the past and we have to set first_active_omaha_ping_sent for
1306 // future checks.
1307 if (!system_state_->hardware()->GetFirstActiveOmahaPingSent()) {
Amin Hassani80f4d4c2018-05-16 13:34:00 -07001308 if (!system_state_->hardware()->SetFirstActiveOmahaPingSent()) {
1309 system_state_->metrics_reporter()->ReportInternalErrorCode(
1310 ErrorCode::kFirstActiveOmahaPingSentPersistenceError);
1311 }
Amin Hassani1677e812017-06-21 13:36:36 -07001312 }
1313
Thieu Le116fda32011-04-19 11:01:54 -07001314 if (!HasOutputPipe()) {
1315 // Just set success to whether or not the http transfer succeeded,
1316 // which must be true at this point in the code.
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -07001317 completer.set_code(ErrorCode::kSuccess);
Thieu Le116fda32011-04-19 11:01:54 -07001318 return;
1319 }
1320
Darin Petkov6a5b3222010-07-13 14:55:28 -07001321 OmahaResponse output_object;
David Zeuthene8ed8632014-07-24 13:38:10 -04001322 if (!ParseResponse(&parser_data, &output_object, &completer))
rspangler@google.com49fdf182009-10-10 00:57:34 +00001323 return;
David Zeuthen8f191b22013-08-06 12:27:50 -07001324 output_object.update_exists = true;
1325 SetOutputObject(output_object);
rspangler@google.com49fdf182009-10-10 00:57:34 +00001326
Toni Barzic61544e62018-10-11 14:37:30 -07001327 LoadOrPersistUpdateFirstSeenAtPref();
1328
Weidong Guo421ff332017-04-17 10:08:38 -07001329 ErrorCode error = ErrorCode::kSuccess;
Toni Barzic61544e62018-10-11 14:37:30 -07001330 if (ShouldIgnoreUpdate(output_object, &error)) {
Weidong Guo421ff332017-04-17 10:08:38 -07001331 // No need to change output_object.update_exists here, since the value
1332 // has been output to the pipe.
1333 completer.set_code(error);
Jay Srinivasan0a708742012-03-20 11:26:12 -07001334 return;
1335 }
1336
David Zeuthen8f191b22013-08-06 12:27:50 -07001337 // If Omaha says to disable p2p, respect that
1338 if (output_object.disable_p2p_for_downloading) {
1339 LOG(INFO) << "Forcibly disabling use of p2p for downloading as "
1340 << "requested by Omaha.";
Gilad Arnold74b5f552014-10-07 08:17:16 -07001341 payload_state->SetUsingP2PForDownloading(false);
David Zeuthen8f191b22013-08-06 12:27:50 -07001342 }
1343 if (output_object.disable_p2p_for_sharing) {
1344 LOG(INFO) << "Forcibly disabling use of p2p for sharing as "
1345 << "requested by Omaha.";
Gilad Arnold74b5f552014-10-07 08:17:16 -07001346 payload_state->SetUsingP2PForSharing(false);
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001347 }
Jay Srinivasan6f6ea002012-12-14 11:26:28 -08001348
1349 // Update the payload state with the current response. The payload state
1350 // will automatically reset all stale state if this response is different
Jay Srinivasan08262882012-12-28 19:29:43 -08001351 // from what's stored already. We are updating the payload state as late
1352 // as possible in this method so that if a new release gets pushed and then
1353 // got pulled back due to some issues, we don't want to clear our internal
1354 // state unnecessarily.
Jay Srinivasan6f6ea002012-12-14 11:26:28 -08001355 payload_state->SetResponse(output_object);
Jay Srinivasan08262882012-12-28 19:29:43 -08001356
David Zeuthen8f191b22013-08-06 12:27:50 -07001357 // It could be we've already exceeded the deadline for when p2p is
1358 // allowed or that we've tried too many times with p2p. Check that.
Gilad Arnold74b5f552014-10-07 08:17:16 -07001359 if (payload_state->GetUsingP2PForDownloading()) {
David Zeuthen8f191b22013-08-06 12:27:50 -07001360 payload_state->P2PNewAttempt();
1361 if (!payload_state->P2PAttemptAllowed()) {
1362 LOG(INFO) << "Forcibly disabling use of p2p for downloading because "
1363 << "of previous failures when using p2p.";
Gilad Arnold74b5f552014-10-07 08:17:16 -07001364 payload_state->SetUsingP2PForDownloading(false);
David Zeuthen8f191b22013-08-06 12:27:50 -07001365 }
1366 }
1367
1368 // From here on, we'll complete stuff in CompleteProcessing() so
1369 // disable |completer| since we'll create a new one in that
1370 // function.
1371 completer.set_should_complete(false);
1372
1373 // If we're allowed to use p2p for downloading we do not pay
1374 // attention to wall-clock-based waiting if the URL is indeed
1375 // available via p2p. Therefore, check if the file is available via
1376 // p2p before deferring...
Gilad Arnold74b5f552014-10-07 08:17:16 -07001377 if (payload_state->GetUsingP2PForDownloading()) {
David Zeuthen8f191b22013-08-06 12:27:50 -07001378 LookupPayloadViaP2P(output_object);
1379 } else {
1380 CompleteProcessing();
1381 }
1382}
1383
1384void OmahaRequestAction::CompleteProcessing() {
1385 ScopedActionCompleter completer(processor_, this);
1386 OmahaResponse& output_object = const_cast<OmahaResponse&>(GetOutputObject());
1387 PayloadStateInterface* payload_state = system_state_->payload_state();
1388
1389 if (ShouldDeferDownload(&output_object)) {
Jay Srinivasan08262882012-12-28 19:29:43 -08001390 output_object.update_exists = false;
David Zeuthen8f191b22013-08-06 12:27:50 -07001391 LOG(INFO) << "Ignoring Omaha updates as updates are deferred by policy.";
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -07001392 completer.set_code(ErrorCode::kOmahaUpdateDeferredPerPolicy);
Jay Srinivasan08262882012-12-28 19:29:43 -08001393 return;
1394 }
David Zeuthen8f191b22013-08-06 12:27:50 -07001395
Chris Sosa20f005c2013-09-05 13:53:08 -07001396 if (payload_state->ShouldBackoffDownload()) {
1397 output_object.update_exists = false;
1398 LOG(INFO) << "Ignoring Omaha updates in order to backoff our retry "
1399 << "attempts";
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -07001400 completer.set_code(ErrorCode::kOmahaUpdateDeferredForBackoff);
Chris Sosa20f005c2013-09-05 13:53:08 -07001401 return;
David Zeuthen8f191b22013-08-06 12:27:50 -07001402 }
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -07001403 completer.set_code(ErrorCode::kSuccess);
David Zeuthen8f191b22013-08-06 12:27:50 -07001404}
1405
1406void OmahaRequestAction::OnLookupPayloadViaP2PCompleted(const string& url) {
1407 LOG(INFO) << "Lookup complete, p2p-client returned URL '" << url << "'";
1408 if (!url.empty()) {
Gilad Arnold74b5f552014-10-07 08:17:16 -07001409 system_state_->payload_state()->SetP2PUrl(url);
David Zeuthen8f191b22013-08-06 12:27:50 -07001410 } else {
1411 LOG(INFO) << "Forcibly disabling use of p2p for downloading "
1412 << "because no suitable peer could be found.";
Gilad Arnold74b5f552014-10-07 08:17:16 -07001413 system_state_->payload_state()->SetUsingP2PForDownloading(false);
David Zeuthen8f191b22013-08-06 12:27:50 -07001414 }
1415 CompleteProcessing();
1416}
1417
1418void OmahaRequestAction::LookupPayloadViaP2P(const OmahaResponse& response) {
David Zeuthen41996ad2013-09-24 15:43:24 -07001419 // If the device is in the middle of an update, the state variables
1420 // kPrefsUpdateStateNextDataOffset, kPrefsUpdateStateNextDataLength
1421 // tracks the offset and length of the operation currently in
1422 // progress. The offset is based from the end of the manifest which
1423 // is kPrefsManifestMetadataSize bytes long.
1424 //
1425 // To make forward progress and avoid deadlocks, we need to find a
1426 // peer that has at least the entire operation we're currently
1427 // working on. Otherwise we may end up in a situation where two
1428 // devices bounce back and forth downloading from each other,
1429 // neither making any forward progress until one of them decides to
1430 // stop using p2p (via kMaxP2PAttempts and kMaxP2PAttemptTimeSeconds
1431 // safe-guards). See http://crbug.com/297170 for an example)
David Zeuthen8f191b22013-08-06 12:27:50 -07001432 size_t minimum_size = 0;
David Zeuthen41996ad2013-09-24 15:43:24 -07001433 int64_t manifest_metadata_size = 0;
Alex Deymof25eb492016-02-26 00:20:08 -08001434 int64_t manifest_signature_size = 0;
David Zeuthen41996ad2013-09-24 15:43:24 -07001435 int64_t next_data_offset = 0;
1436 int64_t next_data_length = 0;
Alex Vakulenko88b591f2014-08-28 16:48:57 -07001437 if (system_state_ &&
David Zeuthen41996ad2013-09-24 15:43:24 -07001438 system_state_->prefs()->GetInt64(kPrefsManifestMetadataSize,
1439 &manifest_metadata_size) &&
1440 manifest_metadata_size != -1 &&
Alex Deymof25eb492016-02-26 00:20:08 -08001441 system_state_->prefs()->GetInt64(kPrefsManifestSignatureSize,
1442 &manifest_signature_size) &&
1443 manifest_signature_size != -1 &&
David Zeuthen8f191b22013-08-06 12:27:50 -07001444 system_state_->prefs()->GetInt64(kPrefsUpdateStateNextDataOffset,
David Zeuthen41996ad2013-09-24 15:43:24 -07001445 &next_data_offset) &&
1446 next_data_offset != -1 &&
1447 system_state_->prefs()->GetInt64(kPrefsUpdateStateNextDataLength,
1448 &next_data_length)) {
Alex Deymof25eb492016-02-26 00:20:08 -08001449 minimum_size = manifest_metadata_size + manifest_signature_size +
1450 next_data_offset + next_data_length;
David Zeuthen8f191b22013-08-06 12:27:50 -07001451 }
1452
Sen Jiang0affc2c2017-02-10 15:55:05 -08001453 // TODO(senj): Fix P2P for multiple package.
Sen Jiang2703ef42017-03-16 13:36:21 -07001454 brillo::Blob raw_hash;
Sen Jiang0affc2c2017-02-10 15:55:05 -08001455 if (!base::HexStringToBytes(response.packages[0].hash, &raw_hash))
Sen Jiang2703ef42017-03-16 13:36:21 -07001456 return;
Sen Jiang0affc2c2017-02-10 15:55:05 -08001457 string file_id =
1458 utils::CalculateP2PFileId(raw_hash, response.packages[0].size);
Alex Vakulenko88b591f2014-08-28 16:48:57 -07001459 if (system_state_->p2p_manager()) {
Sen Jiang2703ef42017-03-16 13:36:21 -07001460 LOG(INFO) << "Checking if payload is available via p2p, file_id=" << file_id
1461 << " minimum_size=" << minimum_size;
David Zeuthen8f191b22013-08-06 12:27:50 -07001462 system_state_->p2p_manager()->LookupUrlForFile(
1463 file_id,
1464 minimum_size,
David Zeuthen4cc5ed22014-01-15 12:35:03 -08001465 TimeDelta::FromSeconds(kMaxP2PNetworkWaitTimeSeconds),
David Zeuthen8f191b22013-08-06 12:27:50 -07001466 base::Bind(&OmahaRequestAction::OnLookupPayloadViaP2PCompleted,
1467 base::Unretained(this)));
1468 }
rspangler@google.com49fdf182009-10-10 00:57:34 +00001469}
1470
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001471bool OmahaRequestAction::ShouldDeferDownload(OmahaResponse* output_object) {
Chris Sosa968d0572013-08-23 14:46:02 -07001472 if (params_->interactive()) {
1473 LOG(INFO) << "Not deferring download because update is interactive.";
1474 return false;
1475 }
1476
David Zeuthen8f191b22013-08-06 12:27:50 -07001477 // If we're using p2p to download _and_ we have a p2p URL, we never
1478 // defer the download. This is because the download will always
1479 // happen from a peer on the LAN and we've been waiting in line for
1480 // our turn.
Gilad Arnold74b5f552014-10-07 08:17:16 -07001481 const PayloadStateInterface* payload_state = system_state_->payload_state();
1482 if (payload_state->GetUsingP2PForDownloading() &&
1483 !payload_state->GetP2PUrl().empty()) {
David Zeuthen8f191b22013-08-06 12:27:50 -07001484 LOG(INFO) << "Download not deferred because download "
1485 << "will happen from a local peer (via p2p).";
1486 return false;
1487 }
1488
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001489 // We should defer the downloads only if we've first satisfied the
1490 // wall-clock-based-waiting period and then the update-check-based waiting
1491 // period, if required.
Jay Srinivasanae4697c2013-03-18 17:08:08 -07001492 if (!params_->wall_clock_based_wait_enabled()) {
Chris Sosa968d0572013-08-23 14:46:02 -07001493 LOG(INFO) << "Wall-clock-based waiting period is not enabled,"
1494 << " so no deferring needed.";
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001495 return false;
1496 }
1497
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001498 switch (IsWallClockBasedWaitingSatisfied(output_object)) {
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001499 case kWallClockWaitNotSatisfied:
1500 // We haven't even satisfied the first condition, passing the
1501 // wall-clock-based waiting period, so we should defer the downloads
1502 // until that happens.
1503 LOG(INFO) << "wall-clock-based-wait not satisfied.";
1504 return true;
1505
1506 case kWallClockWaitDoneButUpdateCheckWaitRequired:
1507 LOG(INFO) << "wall-clock-based-wait satisfied and "
1508 << "update-check-based-wait required.";
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001509 return !IsUpdateCheckCountBasedWaitingSatisfied();
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001510
1511 case kWallClockWaitDoneAndUpdateCheckWaitNotRequired:
1512 // Wall-clock-based waiting period is satisfied, and it's determined
1513 // that we do not need the update-check-based wait. so no need to
1514 // defer downloads.
1515 LOG(INFO) << "wall-clock-based-wait satisfied and "
1516 << "update-check-based-wait is not required.";
1517 return false;
1518
1519 default:
1520 // Returning false for this default case so we err on the
1521 // side of downloading updates than deferring in case of any bugs.
1522 NOTREACHED();
1523 return false;
1524 }
1525}
1526
1527OmahaRequestAction::WallClockWaitResult
1528OmahaRequestAction::IsWallClockBasedWaitingSatisfied(
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001529 OmahaResponse* output_object) {
May Lippert60aa3ca2018-08-15 16:55:29 -07001530 Time update_first_seen_at = LoadOrPersistUpdateFirstSeenAtPref();
1531 if (update_first_seen_at == base::Time()) {
1532 LOG(INFO) << "Not scattering as UpdateFirstSeenAt value cannot be read or "
1533 "persisted";
1534 return kWallClockWaitDoneAndUpdateCheckWaitNotRequired;
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001535 }
1536
Sen Jiang7c1171e2016-06-23 11:35:40 -07001537 TimeDelta elapsed_time =
1538 system_state_->clock()->GetWallclockTime() - update_first_seen_at;
1539 TimeDelta max_scatter_period =
1540 TimeDelta::FromDays(output_object->max_days_to_scatter);
Adolfo Victoria497044c2018-07-18 07:51:42 -07001541 int64_t staging_wait_time_in_days = 0;
1542 // Use staging and its default max value if staging is on.
1543 if (system_state_->prefs()->GetInt64(kPrefsWallClockStagingWaitPeriod,
1544 &staging_wait_time_in_days) &&
1545 staging_wait_time_in_days > 0)
1546 max_scatter_period = TimeDelta::FromDays(kMaxWaitTimeStagingInDays);
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001547
Jay Srinivasan34b5d862012-07-23 11:43:22 -07001548 LOG(INFO) << "Waiting Period = "
Jay Srinivasanae4697c2013-03-18 17:08:08 -07001549 << utils::FormatSecs(params_->waiting_period().InSeconds())
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001550 << ", Time Elapsed = "
1551 << utils::FormatSecs(elapsed_time.InSeconds())
Adolfo Victoria497044c2018-07-18 07:51:42 -07001552 << ", MaxDaysToScatter = " << max_scatter_period.InDays();
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001553
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001554 if (!output_object->deadline.empty()) {
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001555 // The deadline is set for all rules which serve a delta update from a
1556 // previous FSI, which means this update will be applied mostly in OOBE
1557 // cases. For these cases, we shouldn't scatter so as to finish the OOBE
1558 // quickly.
1559 LOG(INFO) << "Not scattering as deadline flag is set";
1560 return kWallClockWaitDoneAndUpdateCheckWaitNotRequired;
1561 }
1562
1563 if (max_scatter_period.InDays() == 0) {
1564 // This means the Omaha rule creator decides that this rule
1565 // should not be scattered irrespective of the policy.
1566 LOG(INFO) << "Not scattering as MaxDaysToScatter in rule is 0.";
1567 return kWallClockWaitDoneAndUpdateCheckWaitNotRequired;
1568 }
1569
1570 if (elapsed_time > max_scatter_period) {
Jay Srinivasan34b5d862012-07-23 11:43:22 -07001571 // This means we've waited more than the upperbound wait in the rule
1572 // from the time we first saw a valid update available to us.
1573 // This will prevent update starvation.
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001574 LOG(INFO) << "Not scattering as we're past the MaxDaysToScatter limit.";
1575 return kWallClockWaitDoneAndUpdateCheckWaitNotRequired;
1576 }
1577
1578 // This means we are required to participate in scattering.
1579 // See if our turn has arrived now.
Jay Srinivasanae4697c2013-03-18 17:08:08 -07001580 TimeDelta remaining_wait_time = params_->waiting_period() - elapsed_time;
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001581 if (remaining_wait_time.InSeconds() <= 0) {
1582 // Yes, it's our turn now.
1583 LOG(INFO) << "Successfully passed the wall-clock-based-wait.";
1584
1585 // But we can't download until the update-check-count-based wait is also
1586 // satisfied, so mark it as required now if update checks are enabled.
Amin Hassani7cc8bb02019-01-14 16:29:47 -08001587 return params_->update_check_count_wait_enabled()
1588 ? kWallClockWaitDoneButUpdateCheckWaitRequired
1589 : kWallClockWaitDoneAndUpdateCheckWaitNotRequired;
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001590 }
1591
1592 // Not our turn yet, so we have to wait until our turn to
1593 // help scatter the downloads across all clients of the enterprise.
1594 LOG(INFO) << "Update deferred for another "
1595 << utils::FormatSecs(remaining_wait_time.InSeconds())
1596 << " per policy.";
1597 return kWallClockWaitNotSatisfied;
1598}
1599
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001600bool OmahaRequestAction::IsUpdateCheckCountBasedWaitingSatisfied() {
Ben Chan9abb7632014-08-07 00:10:53 -07001601 int64_t update_check_count_value;
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001602
Jay Srinivasan6f6ea002012-12-14 11:26:28 -08001603 if (system_state_->prefs()->Exists(kPrefsUpdateCheckCount)) {
1604 if (!system_state_->prefs()->GetInt64(kPrefsUpdateCheckCount,
1605 &update_check_count_value)) {
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001606 // We are unable to read the update check count from file for some reason.
1607 // So let's proceed anyway so as to not stall the update.
1608 LOG(ERROR) << "Unable to read update check count. "
1609 << "Skipping update-check-count-based-wait.";
1610 return true;
1611 }
1612 } else {
1613 // This file does not exist. This means we haven't started our update
1614 // check count down yet, so this is the right time to start the count down.
Amin Hassani7cc8bb02019-01-14 16:29:47 -08001615 update_check_count_value =
1616 base::RandInt(params_->min_update_checks_needed(),
1617 params_->max_update_checks_allowed());
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001618
1619 LOG(INFO) << "Randomly picked update check count value = "
1620 << update_check_count_value;
1621
1622 // Write out the initial value of update_check_count_value.
Jay Srinivasan6f6ea002012-12-14 11:26:28 -08001623 if (!system_state_->prefs()->SetInt64(kPrefsUpdateCheckCount,
1624 update_check_count_value)) {
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001625 // We weren't able to write the update check count file for some reason.
1626 // So let's proceed anyway so as to not stall the update.
1627 LOG(ERROR) << "Unable to write update check count. "
1628 << "Skipping update-check-count-based-wait.";
1629 return true;
1630 }
1631 }
1632
1633 if (update_check_count_value == 0) {
1634 LOG(INFO) << "Successfully passed the update-check-based-wait.";
1635 return true;
1636 }
1637
1638 if (update_check_count_value < 0 ||
Jay Srinivasanae4697c2013-03-18 17:08:08 -07001639 update_check_count_value > params_->max_update_checks_allowed()) {
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001640 // We err on the side of skipping scattering logic instead of stalling
1641 // a machine from receiving any updates in case of any unexpected state.
1642 LOG(ERROR) << "Invalid value for update check count detected. "
1643 << "Skipping update-check-count-based-wait.";
1644 return true;
1645 }
1646
1647 // Legal value, we need to wait for more update checks to happen
1648 // until this becomes 0.
1649 LOG(INFO) << "Deferring Omaha updates for another "
Amin Hassani7cc8bb02019-01-14 16:29:47 -08001650 << update_check_count_value << " update checks per policy";
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001651 return false;
1652}
1653
David Zeuthen639aa362014-02-03 16:23:44 -08001654// static
David Zeuthene8ed8632014-07-24 13:38:10 -04001655bool OmahaRequestAction::ParseInstallDate(OmahaParserData* parser_data,
David Zeuthen639aa362014-02-03 16:23:44 -08001656 OmahaResponse* output_object) {
David Zeuthen639aa362014-02-03 16:23:44 -08001657 int64_t elapsed_days = 0;
Amin Hassani7cc8bb02019-01-14 16:29:47 -08001658 if (!base::StringToInt64(parser_data->daystart_elapsed_days, &elapsed_days))
David Zeuthen639aa362014-02-03 16:23:44 -08001659 return false;
1660
1661 if (elapsed_days < 0)
1662 return false;
1663
1664 output_object->install_date_days = elapsed_days;
1665 return true;
1666}
1667
1668// static
Amin Hassani7cc8bb02019-01-14 16:29:47 -08001669bool OmahaRequestAction::HasInstallDate(SystemState* system_state) {
David Zeuthen639aa362014-02-03 16:23:44 -08001670 PrefsInterface* prefs = system_state->prefs();
Alex Vakulenko88b591f2014-08-28 16:48:57 -07001671 if (prefs == nullptr)
David Zeuthen639aa362014-02-03 16:23:44 -08001672 return false;
1673
1674 return prefs->Exists(kPrefsInstallDateDays);
1675}
1676
1677// static
1678bool OmahaRequestAction::PersistInstallDate(
Amin Hassani7cc8bb02019-01-14 16:29:47 -08001679 SystemState* system_state,
David Zeuthen639aa362014-02-03 16:23:44 -08001680 int install_date_days,
1681 InstallDateProvisioningSource source) {
1682 TEST_AND_RETURN_FALSE(install_date_days >= 0);
1683
1684 PrefsInterface* prefs = system_state->prefs();
Alex Vakulenko88b591f2014-08-28 16:48:57 -07001685 if (prefs == nullptr)
David Zeuthen639aa362014-02-03 16:23:44 -08001686 return false;
1687
1688 if (!prefs->SetInt64(kPrefsInstallDateDays, install_date_days))
1689 return false;
1690
Tianjie Xu282aa1f2017-09-05 13:42:45 -07001691 system_state->metrics_reporter()->ReportInstallDateProvisioningSource(
David Zeuthen33bae492014-02-25 16:16:18 -08001692 static_cast<int>(source), // Sample.
1693 kProvisionedMax); // Maximum.
David Zeuthen639aa362014-02-03 16:23:44 -08001694 return true;
1695}
1696
Amin Hassani7cc8bb02019-01-14 16:29:47 -08001697bool OmahaRequestAction::PersistCohortData(const string& prefs_key,
1698 const string& new_value) {
Alex Deymo8e18f932015-03-27 16:16:59 -07001699 if (new_value.empty() && system_state_->prefs()->Exists(prefs_key)) {
1700 LOG(INFO) << "Removing stored " << prefs_key << " value.";
1701 return system_state_->prefs()->Delete(prefs_key);
1702 } else if (!new_value.empty()) {
1703 LOG(INFO) << "Storing new setting " << prefs_key << " as " << new_value;
1704 return system_state_->prefs()->SetString(prefs_key, new_value);
1705 }
1706 return true;
1707}
1708
Alex Deymob3fa53b2016-04-18 19:57:58 -07001709bool OmahaRequestAction::PersistEolStatus(const map<string, string>& attrs) {
Amin Hassani6600a562018-09-24 15:17:19 -07001710 auto eol_attr = attrs.find(kAttrEol);
Alex Deymob3fa53b2016-04-18 19:57:58 -07001711 if (eol_attr != attrs.end()) {
1712 return system_state_->prefs()->SetString(kPrefsOmahaEolStatus,
1713 eol_attr->second);
1714 } else if (system_state_->prefs()->Exists(kPrefsOmahaEolStatus)) {
1715 return system_state_->prefs()->Delete(kPrefsOmahaEolStatus);
1716 }
1717 return true;
1718}
1719
David Zeuthen33bae492014-02-25 16:16:18 -08001720void OmahaRequestAction::ActionCompleted(ErrorCode code) {
1721 // We only want to report this on "update check".
1722 if (ping_only_ || event_ != nullptr)
1723 return;
1724
1725 metrics::CheckResult result = metrics::CheckResult::kUnset;
1726 metrics::CheckReaction reaction = metrics::CheckReaction::kUnset;
1727 metrics::DownloadErrorCode download_error_code =
1728 metrics::DownloadErrorCode::kUnset;
1729
1730 // Regular update attempt.
1731 switch (code) {
Amin Hassani7cc8bb02019-01-14 16:29:47 -08001732 case ErrorCode::kSuccess:
1733 // OK, we parsed the response successfully but that does
1734 // necessarily mean that an update is available.
1735 if (HasOutputPipe()) {
1736 const OmahaResponse& response = GetOutputObject();
1737 if (response.update_exists) {
1738 result = metrics::CheckResult::kUpdateAvailable;
1739 reaction = metrics::CheckReaction::kUpdating;
1740 } else {
1741 result = metrics::CheckResult::kNoUpdateAvailable;
1742 }
David Zeuthen33bae492014-02-25 16:16:18 -08001743 } else {
1744 result = metrics::CheckResult::kNoUpdateAvailable;
1745 }
Amin Hassani7cc8bb02019-01-14 16:29:47 -08001746 break;
David Zeuthen33bae492014-02-25 16:16:18 -08001747
Amin Hassani7cc8bb02019-01-14 16:29:47 -08001748 case ErrorCode::kOmahaUpdateIgnoredPerPolicy:
1749 case ErrorCode::kOmahaUpdateIgnoredOverCellular:
1750 result = metrics::CheckResult::kUpdateAvailable;
1751 reaction = metrics::CheckReaction::kIgnored;
1752 break;
David Zeuthen33bae492014-02-25 16:16:18 -08001753
Amin Hassani7cc8bb02019-01-14 16:29:47 -08001754 case ErrorCode::kOmahaUpdateDeferredPerPolicy:
1755 result = metrics::CheckResult::kUpdateAvailable;
1756 reaction = metrics::CheckReaction::kDeferring;
1757 break;
David Zeuthen33bae492014-02-25 16:16:18 -08001758
Amin Hassani7cc8bb02019-01-14 16:29:47 -08001759 case ErrorCode::kOmahaUpdateDeferredForBackoff:
1760 result = metrics::CheckResult::kUpdateAvailable;
1761 reaction = metrics::CheckReaction::kBackingOff;
1762 break;
David Zeuthen33bae492014-02-25 16:16:18 -08001763
Amin Hassani7cc8bb02019-01-14 16:29:47 -08001764 default:
1765 // We report two flavors of errors, "Download errors" and "Parsing
1766 // error". Try to convert to the former and if that doesn't work
1767 // we know it's the latter.
1768 metrics::DownloadErrorCode tmp_error =
1769 metrics_utils::GetDownloadErrorCode(code);
1770 if (tmp_error != metrics::DownloadErrorCode::kInputMalformed) {
1771 result = metrics::CheckResult::kDownloadError;
1772 download_error_code = tmp_error;
1773 } else {
1774 result = metrics::CheckResult::kParsingError;
1775 }
1776 break;
David Zeuthen33bae492014-02-25 16:16:18 -08001777 }
1778
Tianjie Xu282aa1f2017-09-05 13:42:45 -07001779 system_state_->metrics_reporter()->ReportUpdateCheckMetrics(
1780 system_state_, result, reaction, download_error_code);
David Zeuthen33bae492014-02-25 16:16:18 -08001781}
1782
Toni Barzic61544e62018-10-11 14:37:30 -07001783bool OmahaRequestAction::ShouldIgnoreUpdate(const OmahaResponse& response,
1784 ErrorCode* error) const {
Chris Sosa77f79e82014-06-02 18:16:24 -07001785 // Note: policy decision to not update to a version we rolled back from.
1786 string rollback_version =
1787 system_state_->payload_state()->GetRollbackVersion();
Alex Vakulenkod2779df2014-06-16 13:19:00 -07001788 if (!rollback_version.empty()) {
Chris Sosa77f79e82014-06-02 18:16:24 -07001789 LOG(INFO) << "Detected previous rollback from version " << rollback_version;
Alex Vakulenkod2779df2014-06-16 13:19:00 -07001790 if (rollback_version == response.version) {
Chris Sosa77f79e82014-06-02 18:16:24 -07001791 LOG(INFO) << "Received version that we rolled back from. Ignoring.";
Weidong Guo421ff332017-04-17 10:08:38 -07001792 *error = ErrorCode::kOmahaUpdateIgnoredPerPolicy;
Chris Sosa77f79e82014-06-02 18:16:24 -07001793 return true;
1794 }
1795 }
1796
Toni Barzic61544e62018-10-11 14:37:30 -07001797 if (system_state_->hardware()->IsOOBEEnabled() &&
1798 !system_state_->hardware()->IsOOBEComplete(nullptr) &&
1799 (response.deadline.empty() ||
1800 system_state_->payload_state()->GetRollbackHappened()) &&
1801 params_->app_version() != "ForcedUpdate") {
1802 LOG(INFO) << "Ignoring a non-critical Omaha update before OOBE completion.";
1803 *error = ErrorCode::kNonCriticalUpdateInOOBE;
1804 return true;
1805 }
1806
Weidong Guo421ff332017-04-17 10:08:38 -07001807 if (!IsUpdateAllowedOverCurrentConnection(error, response)) {
Chris Sosa77f79e82014-06-02 18:16:24 -07001808 LOG(INFO) << "Update is not allowed over current connection.";
1809 return true;
1810 }
1811
1812 // Note: We could technically delete the UpdateFirstSeenAt state when we
1813 // return true. If we do, it'll mean a device has to restart the
1814 // UpdateFirstSeenAt and thus help scattering take effect when the AU is
1815 // turned on again. On the other hand, it also increases the chance of update
1816 // starvation if an admin turns AU on/off more frequently. We choose to err on
1817 // the side of preventing starvation at the cost of not applying scattering in
1818 // those cases.
1819 return false;
1820}
1821
Weidong Guo421ff332017-04-17 10:08:38 -07001822bool OmahaRequestAction::IsUpdateAllowedOverCellularByPrefs(
1823 const OmahaResponse& response) const {
1824 PrefsInterface* prefs = system_state_->prefs();
1825
1826 if (!prefs) {
1827 LOG(INFO) << "Disabling updates over cellular as the preferences are "
1828 "not available.";
1829 return false;
1830 }
1831
1832 bool is_allowed;
1833
1834 if (prefs->Exists(kPrefsUpdateOverCellularPermission) &&
1835 prefs->GetBoolean(kPrefsUpdateOverCellularPermission, &is_allowed) &&
1836 is_allowed) {
1837 LOG(INFO) << "Allowing updates over cellular as permission preference is "
1838 "set to true.";
1839 return true;
1840 }
1841
1842 if (!prefs->Exists(kPrefsUpdateOverCellularTargetVersion) ||
1843 !prefs->Exists(kPrefsUpdateOverCellularTargetSize)) {
1844 LOG(INFO) << "Disabling updates over cellular as permission preference is "
1845 "set to false or does not exist while target does not exist.";
1846 return false;
1847 }
1848
1849 std::string target_version;
1850 int64_t target_size;
1851
1852 if (!prefs->GetString(kPrefsUpdateOverCellularTargetVersion,
1853 &target_version) ||
1854 !prefs->GetInt64(kPrefsUpdateOverCellularTargetSize, &target_size)) {
1855 LOG(INFO) << "Disabling updates over cellular as the target version or "
1856 "size is not accessible.";
1857 return false;
1858 }
1859
1860 uint64_t total_packages_size = 0;
1861 for (const auto& package : response.packages) {
1862 total_packages_size += package.size;
1863 }
1864 if (target_version == response.version &&
1865 static_cast<uint64_t>(target_size) == total_packages_size) {
1866 LOG(INFO) << "Allowing updates over cellular as the target matches the"
1867 "omaha response.";
1868 return true;
1869 } else {
1870 LOG(INFO) << "Disabling updates over cellular as the target does not"
1871 "match the omaha response.";
1872 return false;
1873 }
1874}
1875
1876bool OmahaRequestAction::IsUpdateAllowedOverCurrentConnection(
1877 ErrorCode* error, const OmahaResponse& response) const {
Sen Jiang255e22b2016-05-20 16:15:29 -07001878 ConnectionType type;
1879 ConnectionTethering tethering;
Alex Deymof6ee0162015-07-31 12:35:22 -07001880 ConnectionManagerInterface* connection_manager =
1881 system_state_->connection_manager();
Alex Deymo30534502015-07-20 15:06:33 -07001882 if (!connection_manager->GetConnectionProperties(&type, &tethering)) {
Chris Sosa77f79e82014-06-02 18:16:24 -07001883 LOG(INFO) << "We could not determine our connection type. "
1884 << "Defaulting to allow updates.";
1885 return true;
1886 }
Weidong Guo421ff332017-04-17 10:08:38 -07001887
Chris Sosa77f79e82014-06-02 18:16:24 -07001888 bool is_allowed = connection_manager->IsUpdateAllowedOver(type, tethering);
Weidong Guo421ff332017-04-17 10:08:38 -07001889 bool is_device_policy_set =
1890 connection_manager->IsAllowedConnectionTypesForUpdateSet();
1891 // Treats tethered connection as if it is cellular connection.
1892 bool is_over_cellular = type == ConnectionType::kCellular ||
1893 tethering == ConnectionTethering::kConfirmed;
1894
1895 if (!is_over_cellular) {
1896 // There's no need to further check user preferences as we are not over
1897 // cellular connection.
1898 if (!is_allowed)
1899 *error = ErrorCode::kOmahaUpdateIgnoredPerPolicy;
1900 } else if (is_device_policy_set) {
1901 // There's no need to further check user preferences as the device policy
1902 // is set regarding updates over cellular.
1903 if (!is_allowed)
1904 *error = ErrorCode::kOmahaUpdateIgnoredPerPolicy;
1905 } else {
1906 // Deivce policy is not set, so user preferences overwrite whether to
1907 // allow updates over cellular.
1908 is_allowed = IsUpdateAllowedOverCellularByPrefs(response);
1909 if (!is_allowed)
1910 *error = ErrorCode::kOmahaUpdateIgnoredOverCellular;
1911 }
1912
Chris Sosa77f79e82014-06-02 18:16:24 -07001913 LOG(INFO) << "We are connected via "
Sen Jiang255e22b2016-05-20 16:15:29 -07001914 << connection_utils::StringForConnectionType(type)
Chris Sosa77f79e82014-06-02 18:16:24 -07001915 << ", Updates allowed: " << (is_allowed ? "Yes" : "No");
1916 return is_allowed;
1917}
1918
Zentaro Kavanagh1f899d52018-02-27 15:02:47 -08001919bool OmahaRequestAction::IsRollbackEnabled() const {
1920 if (policy_provider_->IsConsumerDevice()) {
1921 LOG(INFO) << "Rollback is not enabled for consumer devices.";
1922 return false;
1923 }
1924
1925 if (!policy_provider_->device_policy_is_loaded()) {
1926 LOG(INFO) << "No device policy is loaded. Assuming rollback enabled.";
1927 return true;
1928 }
1929
1930 int allowed_milestones;
1931 if (!policy_provider_->GetDevicePolicy().GetRollbackAllowedMilestones(
1932 &allowed_milestones)) {
1933 LOG(INFO) << "RollbackAllowedMilestones policy can't be read. "
1934 "Defaulting to rollback enabled.";
1935 return true;
1936 }
1937
1938 LOG(INFO) << "Rollback allows " << allowed_milestones << " milestones.";
1939 return allowed_milestones > 0;
1940}
1941
1942void OmahaRequestAction::SetMaxKernelKeyVersionForRollback() const {
Marton Hunyadyffbfdfb2018-05-30 13:03:29 +02001943 int max_kernel_rollforward;
1944 int min_kernel_version = system_state_->hardware()->GetMinKernelKeyVersion();
Zentaro Kavanagh1f899d52018-02-27 15:02:47 -08001945 if (IsRollbackEnabled()) {
1946 // If rollback is enabled, set the max kernel key version to the current
1947 // kernel key version. This has the effect of freezing kernel key roll
1948 // forwards.
1949 //
1950 // TODO(zentaro): This behavior is temporary, and ensures that no kernel
1951 // key roll forward happens until the server side components of rollback
1952 // are implemented. Future changes will allow the Omaha server to return
1953 // the kernel key version from max_rollback_versions in the past. At that
1954 // point the max kernel key version will be set to that value, creating a
1955 // sliding window of versions that can be rolled back to.
Zentaro Kavanagh5d956152018-05-15 09:40:33 -07001956 LOG(INFO) << "Rollback is enabled. Setting kernel_max_rollforward to "
Zentaro Kavanagh1f899d52018-02-27 15:02:47 -08001957 << min_kernel_version;
Marton Hunyadyffbfdfb2018-05-30 13:03:29 +02001958 max_kernel_rollforward = min_kernel_version;
Zentaro Kavanagh1f899d52018-02-27 15:02:47 -08001959 } else {
1960 // For devices that are not rollback enabled (ie. consumer devices), the
1961 // max kernel key version is set to 0xfffffffe, which is logically
1962 // infinity. This maintains the previous behavior that that kernel key
1963 // versions roll forward each time they are incremented.
Zentaro Kavanagh5d956152018-05-15 09:40:33 -07001964 LOG(INFO) << "Rollback is disabled. Setting kernel_max_rollforward to "
Zentaro Kavanagh1f899d52018-02-27 15:02:47 -08001965 << kRollforwardInfinity;
Marton Hunyadyffbfdfb2018-05-30 13:03:29 +02001966 max_kernel_rollforward = kRollforwardInfinity;
Zentaro Kavanagh1f899d52018-02-27 15:02:47 -08001967 }
1968
Marton Hunyadyffbfdfb2018-05-30 13:03:29 +02001969 bool max_rollforward_set =
1970 system_state_->hardware()->SetMaxKernelKeyRollforward(
1971 max_kernel_rollforward);
Zentaro Kavanagh1f899d52018-02-27 15:02:47 -08001972 if (!max_rollforward_set) {
Zentaro Kavanagh5d956152018-05-15 09:40:33 -07001973 LOG(ERROR) << "Failed to set kernel_max_rollforward";
Zentaro Kavanagh1f899d52018-02-27 15:02:47 -08001974 }
Marton Hunyadyffbfdfb2018-05-30 13:03:29 +02001975 // Report metrics
1976 system_state_->metrics_reporter()->ReportKeyVersionMetrics(
1977 min_kernel_version, max_kernel_rollforward, max_rollforward_set);
Zentaro Kavanagh1f899d52018-02-27 15:02:47 -08001978}
1979
May Lippert60aa3ca2018-08-15 16:55:29 -07001980base::Time OmahaRequestAction::LoadOrPersistUpdateFirstSeenAtPref() const {
1981 Time update_first_seen_at;
1982 int64_t update_first_seen_at_int;
1983 if (system_state_->prefs()->Exists(kPrefsUpdateFirstSeenAt)) {
1984 if (system_state_->prefs()->GetInt64(kPrefsUpdateFirstSeenAt,
1985 &update_first_seen_at_int)) {
1986 // Note: This timestamp could be that of ANY update we saw in the past
1987 // (not necessarily this particular update we're considering to apply)
1988 // but never got to apply because of some reason (e.g. stop AU policy,
1989 // updates being pulled out from Omaha, changes in target version prefix,
1990 // new update being rolled out, etc.). But for the purposes of scattering
1991 // it doesn't matter which update the timestamp corresponds to. i.e.
1992 // the clock starts ticking the first time we see an update and we're
1993 // ready to apply when the random wait period is satisfied relative to
1994 // that first seen timestamp.
1995 update_first_seen_at = Time::FromInternalValue(update_first_seen_at_int);
1996 LOG(INFO) << "Using persisted value of UpdateFirstSeenAt: "
1997 << utils::ToString(update_first_seen_at);
1998 } else {
1999 // This seems like an unexpected error where the persisted value exists
2000 // but it's not readable for some reason.
2001 LOG(INFO) << "UpdateFirstSeenAt value cannot be read";
2002 return base::Time();
2003 }
2004 } else {
2005 update_first_seen_at = system_state_->clock()->GetWallclockTime();
2006 update_first_seen_at_int = update_first_seen_at.ToInternalValue();
2007 if (system_state_->prefs()->SetInt64(kPrefsUpdateFirstSeenAt,
2008 update_first_seen_at_int)) {
2009 LOG(INFO) << "Persisted the new value for UpdateFirstSeenAt: "
2010 << utils::ToString(update_first_seen_at);
2011 } else {
2012 // This seems like an unexpected error where the value cannot be
2013 // persisted for some reason.
2014 LOG(INFO) << "UpdateFirstSeenAt value "
2015 << utils::ToString(update_first_seen_at)
2016 << " cannot be persisted";
2017 return base::Time();
2018 }
2019 }
2020 return update_first_seen_at;
2021}
2022
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07002023} // namespace chromeos_update_engine