blob: adbef4f678c4659feb566f5966e15e821dc7a9b9 [file] [log] [blame]
Alex Deymoc705cc82014-02-19 11:15:00 -08001// Copyright (c) 2014 The Chromium OS Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
Alex Deymo63784a52014-05-28 10:46:14 -07005#include "update_engine/update_manager/chromeos_policy.h"
Alex Deymo0d11c602014-04-23 20:12:20 -07006
Gilad Arnolde1218812014-05-07 12:21:36 -07007#include <algorithm>
Gilad Arnold0adbc942014-05-12 10:35:43 -07008#include <set>
Alex Deymoc705cc82014-02-19 11:15:00 -08009#include <string>
10
Gilad Arnoldf62a4b82014-05-01 07:41:07 -070011#include <base/logging.h>
Gilad Arnoldb3b05442014-05-30 14:25:05 -070012#include <base/strings/string_util.h>
Gilad Arnoldf62a4b82014-05-01 07:41:07 -070013#include <base/time/time.h>
14
Gilad Arnoldb3b05442014-05-30 14:25:05 -070015#include "update_engine/error_code.h"
Alex Deymo63784a52014-05-28 10:46:14 -070016#include "update_engine/update_manager/device_policy_provider.h"
17#include "update_engine/update_manager/policy_utils.h"
18#include "update_engine/update_manager/shill_provider.h"
Gilad Arnoldb3b05442014-05-30 14:25:05 -070019#include "update_engine/utils.h"
Gilad Arnoldf62a4b82014-05-01 07:41:07 -070020
Alex Deymo0d11c602014-04-23 20:12:20 -070021using base::Time;
22using base::TimeDelta;
Gilad Arnoldb3b05442014-05-30 14:25:05 -070023using chromeos_update_engine::ErrorCode;
24using std::max;
Gilad Arnoldf62a4b82014-05-01 07:41:07 -070025using std::min;
Gilad Arnold0adbc942014-05-12 10:35:43 -070026using std::set;
Alex Deymoc705cc82014-02-19 11:15:00 -080027using std::string;
28
Gilad Arnoldb3b05442014-05-30 14:25:05 -070029namespace {
30
31// Increment |url_idx|, |url_num_failures| or none of them based on the provided
32// error code. If |url_idx| is incremented, then sets |url_num_failures| to zero
33// and returns true; otherwise, returns false.
34//
35// TODO(garnold) Adapted from PayloadState::UpdateFailed() (to be retired).
36bool HandleErrorCode(ErrorCode err_code, int* url_idx, int* url_num_failures) {
37 err_code = chromeos_update_engine::utils::GetBaseErrorCode(err_code);
38 switch (err_code) {
39 // Errors which are good indicators of a problem with a particular URL or
40 // the protocol used in the URL or entities in the communication channel
41 // (e.g. proxies). We should try the next available URL in the next update
42 // check to quickly recover from these errors.
43 case ErrorCode::kPayloadHashMismatchError:
44 case ErrorCode::kPayloadSizeMismatchError:
45 case ErrorCode::kDownloadPayloadVerificationError:
46 case ErrorCode::kDownloadPayloadPubKeyVerificationError:
47 case ErrorCode::kSignedDeltaPayloadExpectedError:
48 case ErrorCode::kDownloadInvalidMetadataMagicString:
49 case ErrorCode::kDownloadSignatureMissingInManifest:
50 case ErrorCode::kDownloadManifestParseError:
51 case ErrorCode::kDownloadMetadataSignatureError:
52 case ErrorCode::kDownloadMetadataSignatureVerificationError:
53 case ErrorCode::kDownloadMetadataSignatureMismatch:
54 case ErrorCode::kDownloadOperationHashVerificationError:
55 case ErrorCode::kDownloadOperationExecutionError:
56 case ErrorCode::kDownloadOperationHashMismatch:
57 case ErrorCode::kDownloadInvalidMetadataSize:
58 case ErrorCode::kDownloadInvalidMetadataSignature:
59 case ErrorCode::kDownloadOperationHashMissingError:
60 case ErrorCode::kDownloadMetadataSignatureMissingError:
61 case ErrorCode::kPayloadMismatchedType:
62 case ErrorCode::kUnsupportedMajorPayloadVersion:
63 case ErrorCode::kUnsupportedMinorPayloadVersion:
64 LOG(INFO) << "Advancing download URL due to error "
65 << chromeos_update_engine::utils::CodeToString(err_code)
66 << " (" << static_cast<int>(err_code) << ")";
67 *url_idx += 1;
68 *url_num_failures = 0;
69 return true;
70
71 // Errors which seem to be just transient network/communication related
72 // failures and do not indicate any inherent problem with the URL itself.
73 // So, we should keep the current URL but just increment the
74 // failure count to give it more chances. This way, while we maximize our
75 // chances of downloading from the URLs that appear earlier in the response
76 // (because download from a local server URL that appears earlier in a
77 // response is preferable than downloading from the next URL which could be
78 // a internet URL and thus could be more expensive).
79 case ErrorCode::kError:
80 case ErrorCode::kDownloadTransferError:
81 case ErrorCode::kDownloadWriteError:
82 case ErrorCode::kDownloadStateInitializationError:
Gilad Arnold684219d2014-07-07 14:54:57 -070083 case ErrorCode::kOmahaErrorInHTTPResponse: // Aggregate for HTTP errors.
Gilad Arnoldb3b05442014-05-30 14:25:05 -070084 LOG(INFO) << "Incrementing URL failure count due to error "
85 << chromeos_update_engine::utils::CodeToString(err_code)
86 << " (" << static_cast<int>(err_code) << ")";
87 *url_num_failures += 1;
88 return false;
89
90 // Errors which are not specific to a URL and hence shouldn't result in
91 // the URL being penalized. This can happen in two cases:
92 // 1. We haven't started downloading anything: These errors don't cost us
93 // anything in terms of actual payload bytes, so we should just do the
94 // regular retries at the next update check.
95 // 2. We have successfully downloaded the payload: In this case, the
96 // payload attempt number would have been incremented and would take care
97 // of the backoff at the next update check.
98 // In either case, there's no need to update URL index or failure count.
99 case ErrorCode::kOmahaRequestError:
100 case ErrorCode::kOmahaResponseHandlerError:
101 case ErrorCode::kPostinstallRunnerError:
102 case ErrorCode::kFilesystemCopierError:
103 case ErrorCode::kInstallDeviceOpenError:
104 case ErrorCode::kKernelDeviceOpenError:
105 case ErrorCode::kDownloadNewPartitionInfoError:
106 case ErrorCode::kNewRootfsVerificationError:
107 case ErrorCode::kNewKernelVerificationError:
108 case ErrorCode::kPostinstallBootedFromFirmwareB:
109 case ErrorCode::kPostinstallFirmwareRONotUpdatable:
110 case ErrorCode::kOmahaRequestEmptyResponseError:
111 case ErrorCode::kOmahaRequestXMLParseError:
112 case ErrorCode::kOmahaResponseInvalid:
113 case ErrorCode::kOmahaUpdateIgnoredPerPolicy:
114 case ErrorCode::kOmahaUpdateDeferredPerPolicy:
115 case ErrorCode::kOmahaUpdateDeferredForBackoff:
116 case ErrorCode::kPostinstallPowerwashError:
117 case ErrorCode::kUpdateCanceledByChannelChange:
118 LOG(INFO) << "Not changing URL index or failure count due to error "
119 << chromeos_update_engine::utils::CodeToString(err_code)
120 << " (" << static_cast<int>(err_code) << ")";
121 return false;
122
123 case ErrorCode::kSuccess: // success code
124 case ErrorCode::kUmaReportedMax: // not an error code
125 case ErrorCode::kOmahaRequestHTTPResponseBase: // aggregated already
126 case ErrorCode::kDevModeFlag: // not an error code
127 case ErrorCode::kResumedFlag: // not an error code
128 case ErrorCode::kTestImageFlag: // not an error code
129 case ErrorCode::kTestOmahaUrlFlag: // not an error code
130 case ErrorCode::kSpecialFlags: // not an error code
131 // These shouldn't happen. Enumerating these explicitly here so that we
132 // can let the compiler warn about new error codes that are added to
133 // action_processor.h but not added here.
134 LOG(WARNING) << "Unexpected error "
135 << chromeos_update_engine::utils::CodeToString(err_code)
136 << " (" << static_cast<int>(err_code) << ")";
137 // Note: Not adding a default here so as to let the compiler warn us of
138 // any new enums that were added in the .h but not listed in this switch.
139 }
140 return false;
141}
142
143// Checks whether |download_url| can be used under given download restrictions.
144bool DownloadUrlIsUsable(const string& download_url, bool http_allowed) {
145 return http_allowed || !StartsWithASCII(download_url, "http://", false);
146}
147
148} // namespace
149
Alex Deymo63784a52014-05-28 10:46:14 -0700150namespace chromeos_update_manager {
Alex Deymoc705cc82014-02-19 11:15:00 -0800151
Alex Deymo0d11c602014-04-23 20:12:20 -0700152EvalStatus ChromeOSPolicy::UpdateCheckAllowed(
153 EvaluationContext* ec, State* state, string* error,
154 UpdateCheckParams* result) const {
Gilad Arnold42f253b2014-06-25 12:39:17 -0700155 // Set the default return values.
156 result->updates_enabled = true;
157 result->target_channel.clear();
158
Gilad Arnoldfe12a0f2014-07-09 14:26:57 -0700159 // Unofficial builds should not perform any automatic update checks.
160 const bool* is_official_build_p = ec->GetValue(
161 state->system_provider()->var_is_official_build());
162 if (is_official_build_p && !(*is_official_build_p)) {
163 result->updates_enabled = false;
164 return EvalStatus::kSucceeded;
165 }
166
Gilad Arnoldbfc44f72014-07-09 14:41:39 -0700167 // Do not perform any automatic update checks if booted from removable device.
168 const bool* is_boot_device_removable_p = ec->GetValue(
169 state->system_provider()->var_is_boot_device_removable());
170 if (is_boot_device_removable_p && *is_boot_device_removable_p) {
171 result->updates_enabled = false;
172 return EvalStatus::kSucceeded;
173 }
174
Gilad Arnold42f253b2014-06-25 12:39:17 -0700175 DevicePolicyProvider* const dp_provider = state->device_policy_provider();
176
177 const bool* device_policy_is_loaded_p = ec->GetValue(
178 dp_provider->var_device_policy_is_loaded());
179 if (device_policy_is_loaded_p && *device_policy_is_loaded_p) {
180 // Check whether updates are disabled by policy.
181 const bool* update_disabled_p = ec->GetValue(
182 dp_provider->var_update_disabled());
183 if (update_disabled_p && *update_disabled_p) {
184 result->updates_enabled = false;
185 return EvalStatus::kAskMeAgainLater;
186 }
187
188 // Determine whether a target channel is dictated by policy.
189 const bool* release_channel_delegated_p = ec->GetValue(
190 dp_provider->var_release_channel_delegated());
191 if (release_channel_delegated_p && !(*release_channel_delegated_p)) {
192 const string* release_channel_p = ec->GetValue(
193 dp_provider->var_release_channel());
194 if (release_channel_p)
195 result->target_channel = *release_channel_p;
196 }
197 }
198
199 // Ensure that update checks are timed properly.
Alex Deymo0d11c602014-04-23 20:12:20 -0700200 Time next_update_check;
201 if (NextUpdateCheckTime(ec, state, error, &next_update_check) !=
202 EvalStatus::kSucceeded) {
203 return EvalStatus::kFailed;
204 }
Alex Deymo0d11c602014-04-23 20:12:20 -0700205 if (!ec->IsTimeGreaterThan(next_update_check))
206 return EvalStatus::kAskMeAgainLater;
207
208 // It is time to check for an update.
Alex Deymoe636c3c2014-03-11 19:02:08 -0700209 return EvalStatus::kSucceeded;
Alex Deymoc705cc82014-02-19 11:15:00 -0800210}
211
Gilad Arnoldf62a4b82014-05-01 07:41:07 -0700212EvalStatus ChromeOSPolicy::UpdateCanStart(
213 EvaluationContext* ec,
214 State* state,
215 string* error,
Gilad Arnold42f253b2014-06-25 12:39:17 -0700216 UpdateDownloadParams* result,
Gilad Arnoldf62a4b82014-05-01 07:41:07 -0700217 const bool interactive,
218 const UpdateState& update_state) const {
219 // Set the default return values.
220 result->update_can_start = true;
Gilad Arnoldf62a4b82014-05-01 07:41:07 -0700221 result->p2p_allowed = false;
Gilad Arnoldf62a4b82014-05-01 07:41:07 -0700222 result->cannot_start_reason = UpdateCannotStartReason::kUndefined;
223 result->scatter_wait_period = kZeroInterval;
224 result->scatter_check_threshold = 0;
Gilad Arnoldb3b05442014-05-30 14:25:05 -0700225 result->download_url_idx = -1;
226 result->download_url_num_failures = 0;
Gilad Arnoldf62a4b82014-05-01 07:41:07 -0700227
228 // Make sure that we're not due for an update check.
229 UpdateCheckParams check_result;
230 EvalStatus check_status = UpdateCheckAllowed(ec, state, error, &check_result);
231 if (check_status == EvalStatus::kFailed)
232 return EvalStatus::kFailed;
233 if (check_status == EvalStatus::kSucceeded &&
234 check_result.updates_enabled == true) {
235 result->update_can_start = false;
236 result->cannot_start_reason = UpdateCannotStartReason::kCheckDue;
237 return EvalStatus::kSucceeded;
238 }
239
240 DevicePolicyProvider* const dp_provider = state->device_policy_provider();
241
242 const bool* device_policy_is_loaded_p = ec->GetValue(
243 dp_provider->var_device_policy_is_loaded());
244 if (device_policy_is_loaded_p && *device_policy_is_loaded_p) {
Gilad Arnold76a11f62014-05-20 09:02:12 -0700245 // Check whether scattering applies to this update attempt. We should not be
246 // scattering if this is an interactive update check, or if OOBE is enabled
247 // but not completed.
248 //
249 // Note: current code further suppresses scattering if a "deadline"
Gilad Arnoldf62a4b82014-05-01 07:41:07 -0700250 // attribute is found in the Omaha response. However, it appears that the
Gilad Arnold76a11f62014-05-20 09:02:12 -0700251 // presence of this attribute is merely indicative of an OOBE update, during
252 // which we suppress scattering anyway.
253 bool scattering_applies = false;
Gilad Arnoldf62a4b82014-05-01 07:41:07 -0700254 if (!interactive) {
Gilad Arnold76a11f62014-05-20 09:02:12 -0700255 const bool* is_oobe_enabled_p = ec->GetValue(
256 state->config_provider()->var_is_oobe_enabled());
257 if (is_oobe_enabled_p && !(*is_oobe_enabled_p)) {
258 scattering_applies = true;
259 } else {
260 const bool* is_oobe_complete_p = ec->GetValue(
Gilad Arnoldb3b05442014-05-30 14:25:05 -0700261 state->system_provider()->var_is_oobe_complete());
Gilad Arnold76a11f62014-05-20 09:02:12 -0700262 scattering_applies = (is_oobe_complete_p && *is_oobe_complete_p);
263 }
264 }
265
266 // Compute scattering values.
267 if (scattering_applies) {
Gilad Arnoldf62a4b82014-05-01 07:41:07 -0700268 UpdateScatteringResult scatter_result;
269 EvalStatus scattering_status = UpdateScattering(
270 ec, state, error, &scatter_result, update_state);
271 if (scattering_status != EvalStatus::kSucceeded ||
272 scatter_result.is_scattering) {
273 if (scattering_status != EvalStatus::kFailed) {
274 result->update_can_start = false;
275 result->cannot_start_reason = UpdateCannotStartReason::kScattering;
276 result->scatter_wait_period = scatter_result.wait_period;
277 result->scatter_check_threshold = scatter_result.check_threshold;
278 }
279 return scattering_status;
280 }
281 }
282
Gilad Arnoldf62a4b82014-05-01 07:41:07 -0700283 // Determine whether use of P2P is allowed by policy.
284 const bool* policy_au_p2p_enabled_p = ec->GetValue(
285 dp_provider->var_au_p2p_enabled());
286 result->p2p_allowed = policy_au_p2p_enabled_p && *policy_au_p2p_enabled_p;
Gilad Arnoldf62a4b82014-05-01 07:41:07 -0700287 }
288
289 // Enable P2P, if so mandated by the updater configuration.
290 if (!result->p2p_allowed) {
291 const bool* updater_p2p_enabled_p = ec->GetValue(
292 state->updater_provider()->var_p2p_enabled());
293 result->p2p_allowed = updater_p2p_enabled_p && *updater_p2p_enabled_p;
294 }
295
Gilad Arnoldb3b05442014-05-30 14:25:05 -0700296 // Determine the URL to download the update from. Note that a failure to find
297 // a download URL will only fail this policy iff no other means of download
298 // (such as P2P) are enabled.
299 UpdateDownloadUrlResult download_url_result;
300 EvalStatus download_url_status = UpdateDownloadUrl(
301 ec, state, error, &download_url_result, update_state);
302 if (download_url_status == EvalStatus::kSucceeded) {
303 result->download_url_idx = download_url_result.url_idx;
304 result->download_url_num_failures = download_url_result.url_num_failures;
305 } else if (!result->p2p_allowed) {
306 if (download_url_status != EvalStatus::kFailed) {
307 result->update_can_start = false;
308 result->cannot_start_reason = UpdateCannotStartReason::kCannotDownload;
309 }
310 return download_url_status;
311 }
312
Gilad Arnoldaf2f6ae2014-04-28 14:14:52 -0700313 return EvalStatus::kSucceeded;
314}
315
Gilad Arnolda8262e22014-06-02 13:54:27 -0700316// TODO(garnold) Logic in this method is based on
317// ConnectionManager::IsUpdateAllowedOver(); be sure to deprecate the latter.
318//
319// TODO(garnold) The current logic generally treats the list of allowed
320// connections coming from the device policy as a whitelist, meaning that it
321// can only be used for enabling connections, but not disable them. Further,
322// certain connection types (like Bluetooth) cannot be enabled even by policy.
323// In effect, the only thing that device policy can change is to enable
324// updates over a cellular network (disabled by default). We may want to
325// revisit this semantics, allowing greater flexibility in defining specific
326// permissions over all types of networks.
Gilad Arnold684219d2014-07-07 14:54:57 -0700327EvalStatus ChromeOSPolicy::UpdateDownloadAllowed(
Gilad Arnolda8262e22014-06-02 13:54:27 -0700328 EvaluationContext* ec,
329 State* state,
330 string* error,
331 bool* result) const {
332 // Get the current connection type.
333 ShillProvider* const shill_provider = state->shill_provider();
334 const ConnectionType* conn_type_p = ec->GetValue(
335 shill_provider->var_conn_type());
336 POLICY_CHECK_VALUE_AND_FAIL(conn_type_p, error);
337 ConnectionType conn_type = *conn_type_p;
338
339 // If we're tethering, treat it as a cellular connection.
340 if (conn_type != ConnectionType::kCellular) {
341 const ConnectionTethering* conn_tethering_p = ec->GetValue(
342 shill_provider->var_conn_tethering());
343 POLICY_CHECK_VALUE_AND_FAIL(conn_tethering_p, error);
344 if (*conn_tethering_p == ConnectionTethering::kConfirmed)
345 conn_type = ConnectionType::kCellular;
346 }
347
348 // By default, we allow updates for all connection types, with exceptions as
349 // noted below. This also determines whether a device policy can override the
350 // default.
351 *result = true;
352 bool device_policy_can_override = false;
353 switch (conn_type) {
354 case ConnectionType::kBluetooth:
355 *result = false;
356 break;
357
358 case ConnectionType::kCellular:
359 *result = false;
360 device_policy_can_override = true;
361 break;
362
363 case ConnectionType::kUnknown:
364 if (error)
365 *error = "Unknown connection type";
366 return EvalStatus::kFailed;
367
368 default:
369 break; // Nothing to do.
370 }
371
372 // If update is allowed, we're done.
373 if (*result)
374 return EvalStatus::kSucceeded;
375
376 // Check whether the device policy specifically allows this connection.
Gilad Arnolda8262e22014-06-02 13:54:27 -0700377 if (device_policy_can_override) {
378 DevicePolicyProvider* const dp_provider = state->device_policy_provider();
379 const bool* device_policy_is_loaded_p = ec->GetValue(
380 dp_provider->var_device_policy_is_loaded());
381 if (device_policy_is_loaded_p && *device_policy_is_loaded_p) {
382 const set<ConnectionType>* allowed_conn_types_p = ec->GetValue(
383 dp_provider->var_allowed_connection_types_for_update());
384 if (allowed_conn_types_p) {
385 if (allowed_conn_types_p->count(conn_type)) {
386 *result = true;
387 return EvalStatus::kSucceeded;
388 }
Gilad Arnold28d6be62014-06-30 14:04:04 -0700389 } else if (conn_type == ConnectionType::kCellular) {
390 // Local user settings can allow updates over cellular iff a policy was
391 // loaded but no allowed connections were specified in it.
392 const bool* update_over_cellular_allowed_p = ec->GetValue(
393 state->updater_provider()->var_cellular_enabled());
394 if (update_over_cellular_allowed_p && *update_over_cellular_allowed_p)
395 *result = true;
Gilad Arnolda8262e22014-06-02 13:54:27 -0700396 }
397 }
398 }
399
Gilad Arnold28d6be62014-06-30 14:04:04 -0700400 return (*result ? EvalStatus::kSucceeded : EvalStatus::kAskMeAgainLater);
Gilad Arnolda8262e22014-06-02 13:54:27 -0700401}
402
Alex Deymo0d11c602014-04-23 20:12:20 -0700403EvalStatus ChromeOSPolicy::NextUpdateCheckTime(EvaluationContext* ec,
404 State* state, string* error,
405 Time* next_update_check) const {
406 // Don't check for updates too often. We limit the update checks to once every
407 // some interval. The interval is kTimeoutInitialInterval the first time and
408 // kTimeoutPeriodicInterval for the subsequent update checks. If the update
409 // check fails, we increase the interval between the update checks
410 // exponentially until kTimeoutMaxBackoffInterval. Finally, to avoid having
411 // many chromebooks running update checks at the exact same time, we add some
412 // fuzz to the interval.
413 const Time* updater_started_time =
414 ec->GetValue(state->updater_provider()->var_updater_started_time());
415 POLICY_CHECK_VALUE_AND_FAIL(updater_started_time, error);
416
417 const base::Time* last_checked_time =
418 ec->GetValue(state->updater_provider()->var_last_checked_time());
419
420 const uint64_t* seed = ec->GetValue(state->random_provider()->var_seed());
421 POLICY_CHECK_VALUE_AND_FAIL(seed, error);
422
423 PRNG prng(*seed);
424
Gilad Arnold38b14022014-07-09 12:45:56 -0700425 // If this is the first attempt, compute and return an initial value.
Alex Deymo0d11c602014-04-23 20:12:20 -0700426 if (!last_checked_time || *last_checked_time < *updater_started_time) {
Alex Deymo0d11c602014-04-23 20:12:20 -0700427 *next_update_check = *updater_started_time + FuzzedInterval(
428 &prng, kTimeoutInitialInterval, kTimeoutRegularFuzz);
429 return EvalStatus::kSucceeded;
430 }
Gilad Arnold38b14022014-07-09 12:45:56 -0700431
432 // Check for previous failed attempts to implement an exponential backoff.
Alex Deymo0d11c602014-04-23 20:12:20 -0700433 const unsigned int* consecutive_failed_update_checks = ec->GetValue(
434 state->updater_provider()->var_consecutive_failed_update_checks());
435 POLICY_CHECK_VALUE_AND_FAIL(consecutive_failed_update_checks, error);
436
Gilad Arnold38b14022014-07-09 12:45:56 -0700437 int interval = kTimeoutPeriodicInterval;
438 int fuzz = kTimeoutRegularFuzz;
Alex Deymo0d11c602014-04-23 20:12:20 -0700439 for (unsigned int i = 0; i < *consecutive_failed_update_checks; ++i) {
440 interval *= 2;
Gilad Arnold38b14022014-07-09 12:45:56 -0700441 fuzz = 0; // In case of backoff, fuzz is different (see below).
Alex Deymo0d11c602014-04-23 20:12:20 -0700442 if (interval > kTimeoutMaxBackoffInterval) {
443 interval = kTimeoutMaxBackoffInterval;
444 break;
445 }
446 }
447
Gilad Arnold38b14022014-07-09 12:45:56 -0700448 // Defer to a fuzz of +/-(interval / 2) in case of backoff.
449 if (fuzz == 0)
450 fuzz = interval;
451
Alex Deymo0d11c602014-04-23 20:12:20 -0700452 *next_update_check = *last_checked_time + FuzzedInterval(
Gilad Arnold38b14022014-07-09 12:45:56 -0700453 &prng, interval, fuzz);
Alex Deymo0d11c602014-04-23 20:12:20 -0700454 return EvalStatus::kSucceeded;
455}
456
457TimeDelta ChromeOSPolicy::FuzzedInterval(PRNG* prng, int interval, int fuzz) {
Gilad Arnolde1218812014-05-07 12:21:36 -0700458 DCHECK_GE(interval, 0);
459 DCHECK_GE(fuzz, 0);
Alex Deymo0d11c602014-04-23 20:12:20 -0700460 int half_fuzz = fuzz / 2;
Alex Deymo0d11c602014-04-23 20:12:20 -0700461 // This guarantees the output interval is non negative.
Gilad Arnoldb3b05442014-05-30 14:25:05 -0700462 int interval_min = max(interval - half_fuzz, 0);
Gilad Arnolde1218812014-05-07 12:21:36 -0700463 int interval_max = interval + half_fuzz;
464 return TimeDelta::FromSeconds(prng->RandMinMax(interval_min, interval_max));
Alex Deymo0d11c602014-04-23 20:12:20 -0700465}
466
Gilad Arnoldb3b05442014-05-30 14:25:05 -0700467EvalStatus ChromeOSPolicy::UpdateDownloadUrl(
468 EvaluationContext* ec, State* state, std::string* error,
469 UpdateDownloadUrlResult* result, const UpdateState& update_state) const {
470 int url_idx = 0;
471 int url_num_failures = 0;
472 if (update_state.num_checks > 1) {
473 // Ignore negative URL indexes, which indicate that no previous suitable
474 // download URL was found.
475 url_idx = max(0, update_state.download_url_idx);
476 url_num_failures = update_state.download_url_num_failures;
477 }
478
479 // Preconditions / sanity checks.
480 DCHECK_GE(update_state.download_failures_max, 0);
481 DCHECK_LT(url_idx, static_cast<int>(update_state.download_urls.size()));
482 DCHECK_LE(url_num_failures, update_state.download_failures_max);
483
484 // Determine whether HTTP downloads are forbidden by policy. This only
485 // applies to official system builds; otherwise, HTTP is always enabled.
486 bool http_allowed = true;
487 const bool* is_official_build_p = ec->GetValue(
488 state->system_provider()->var_is_official_build());
489 if (is_official_build_p && *is_official_build_p) {
490 DevicePolicyProvider* const dp_provider = state->device_policy_provider();
491 const bool* device_policy_is_loaded_p = ec->GetValue(
492 dp_provider->var_device_policy_is_loaded());
493 if (device_policy_is_loaded_p && *device_policy_is_loaded_p) {
494 const bool* policy_http_downloads_enabled_p = ec->GetValue(
495 dp_provider->var_http_downloads_enabled());
496 http_allowed = (!policy_http_downloads_enabled_p ||
497 *policy_http_downloads_enabled_p);
498 }
499 }
500
501 // Process recent failures, stop if the URL index advances.
502 for (auto& err_code : update_state.download_url_error_codes) {
503 if (HandleErrorCode(err_code, &url_idx, &url_num_failures))
504 break;
505 if (url_num_failures > update_state.download_failures_max) {
506 url_idx++;
507 url_num_failures = 0;
508 break;
509 }
510 }
511 url_idx %= update_state.download_urls.size();
512
513 // Scan through URLs until a usable one is found.
514 const int start_url_idx = url_idx;
515 while (!DownloadUrlIsUsable(update_state.download_urls[url_idx],
516 http_allowed)) {
517 url_idx = (url_idx + 1) % update_state.download_urls.size();
518 url_num_failures = 0;
519 if (url_idx == start_url_idx)
520 return EvalStatus::kFailed; // No usable URLs.
521 }
522
523 result->url_idx = url_idx;
524 result->url_num_failures = url_num_failures;
525 return EvalStatus::kSucceeded;
526}
527
Gilad Arnoldf62a4b82014-05-01 07:41:07 -0700528EvalStatus ChromeOSPolicy::UpdateScattering(
529 EvaluationContext* ec,
530 State* state,
531 string* error,
532 UpdateScatteringResult* result,
533 const UpdateState& update_state) const {
534 // Preconditions. These stem from the postconditions and usage contract.
535 DCHECK(update_state.scatter_wait_period >= kZeroInterval);
536 DCHECK_GE(update_state.scatter_check_threshold, 0);
537
538 // Set default result values.
539 result->is_scattering = false;
540 result->wait_period = kZeroInterval;
541 result->check_threshold = 0;
542
543 DevicePolicyProvider* const dp_provider = state->device_policy_provider();
544
545 // Ensure that a device policy is loaded.
546 const bool* device_policy_is_loaded_p = ec->GetValue(
547 dp_provider->var_device_policy_is_loaded());
548 if (!(device_policy_is_loaded_p && *device_policy_is_loaded_p))
549 return EvalStatus::kSucceeded;
550
551 // Is scattering enabled by policy?
552 const TimeDelta* scatter_factor_p = ec->GetValue(
553 dp_provider->var_scatter_factor());
554 if (!scatter_factor_p || *scatter_factor_p == kZeroInterval)
555 return EvalStatus::kSucceeded;
556
557 // Obtain a pseudo-random number generator.
558 const uint64_t* seed = ec->GetValue(state->random_provider()->var_seed());
559 POLICY_CHECK_VALUE_AND_FAIL(seed, error);
560 PRNG prng(*seed);
561
562 // Step 1: Maintain the scattering wait period.
563 //
564 // If no wait period was previously determined, or it no longer fits in the
565 // scatter factor, then generate a new one. Otherwise, keep the one we have.
Gilad Arnoldf62a4b82014-05-01 07:41:07 -0700566 TimeDelta wait_period = update_state.scatter_wait_period;
567 if (wait_period == kZeroInterval || wait_period > *scatter_factor_p) {
568 wait_period = TimeDelta::FromSeconds(
569 prng.RandMinMax(1, scatter_factor_p->InSeconds()));
570 }
571
572 // If we surpass the wait period or the max scatter period associated with
573 // the update, then no wait is needed.
574 Time wait_expires = (update_state.first_seen +
575 min(wait_period, update_state.scatter_wait_period_max));
576 if (ec->IsTimeGreaterThan(wait_expires))
577 wait_period = kZeroInterval;
578
579 // Step 2: Maintain the update check threshold count.
580 //
581 // If an update check threshold is not specified then generate a new
582 // one.
583 int check_threshold = update_state.scatter_check_threshold;
584 if (check_threshold == 0) {
585 check_threshold = prng.RandMinMax(
586 update_state.scatter_check_threshold_min,
587 update_state.scatter_check_threshold_max);
588 }
589
590 // If the update check threshold is not within allowed range then nullify it.
591 // TODO(garnold) This is compliant with current logic found in
592 // OmahaRequestAction::IsUpdateCheckCountBasedWaitingSatisfied(). We may want
593 // to change it so that it behaves similarly to the wait period case, namely
594 // if the current value exceeds the maximum, we set a new one within range.
595 if (check_threshold > update_state.scatter_check_threshold_max)
596 check_threshold = 0;
597
598 // If the update check threshold is non-zero and satisfied, then nullify it.
599 if (check_threshold > 0 && update_state.num_checks >= check_threshold)
600 check_threshold = 0;
601
602 bool is_scattering = (wait_period != kZeroInterval || check_threshold);
603 EvalStatus ret = EvalStatus::kSucceeded;
604 if (is_scattering && wait_period == update_state.scatter_wait_period &&
605 check_threshold == update_state.scatter_check_threshold)
606 ret = EvalStatus::kAskMeAgainLater;
607 result->is_scattering = is_scattering;
608 result->wait_period = wait_period;
609 result->check_threshold = check_threshold;
610 return ret;
611}
612
Alex Deymo63784a52014-05-28 10:46:14 -0700613} // namespace chromeos_update_manager