omaha_request_params.cc revision 522d36ffca22b8c218cdc6a2d1dbab40f6d9b215 
1// Copyright (c) 2011 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
5#include "update_engine/omaha_request_params.h"
6
7#include <errno.h>
8#include <fcntl.h>
9#include <sys/utsname.h>
10
11#include <map>
12#include <string>
13#include <vector>
14
15#include <base/file_util.h>
16#include <base/string_util.h>
17#include <policy/device_policy.h>
18
19#include "update_engine/constants.h"
20#include "update_engine/hardware_interface.h"
21#include "update_engine/simple_key_value_store.h"
22#include "update_engine/system_state.h"
23#include "update_engine/utils.h"
24
25#define CALL_MEMBER_FN(object, member) ((object).*(member))
26
27using std::map;
28using std::string;
29using std::vector;
30
31namespace chromeos_update_engine {
32
33const char* const OmahaRequestParams::kAppId(
34    "{87efface-864d-49a5-9bb3-4b050a7c227a}");
35const char* const OmahaRequestParams::kOsPlatform("Chrome OS");
36const char* const OmahaRequestParams::kOsVersion("Indy");
37const char* const kProductionOmahaUrl(
38    "https://tools.google.com/service/update2");
39
40const char* const OmahaRequestParams::kUpdateChannelKey(
41    "CHROMEOS_RELEASE_TRACK");
42const char* const OmahaRequestParams::kIsPowerwashAllowedKey(
43    "CHROMEOS_IS_POWERWASH_ALLOWED");
44
45const char* kChannelsByStability[] = {
46    // This list has to be sorted from least stable to most stable channel.
47    "canary-channel",
48    "dev-channel",
49    "beta-channel",
50    "stable-channel",
51};
52
53bool OmahaRequestParams::Init(const std::string& in_app_version,
54                              const std::string& in_update_url,
55                              bool in_interactive) {
56  LOG(INFO) << "Initializing parameters for this update attempt";
57  InitFromLsbValue();
58  bool stateful_override = !ShouldLockDown();
59  os_platform_ = OmahaRequestParams::kOsPlatform;
60  os_version_ = OmahaRequestParams::kOsVersion;
61  app_version_ = in_app_version.empty() ?
62      GetLsbValue("CHROMEOS_RELEASE_VERSION", "", NULL, stateful_override) :
63      in_app_version;
64  os_sp_ = app_version_ + "_" + GetMachineType();
65  os_board_ = GetLsbValue("CHROMEOS_RELEASE_BOARD",
66                          "",
67                          NULL,
68                          stateful_override);
69  string release_app_id = GetLsbValue("CHROMEOS_RELEASE_APPID",
70                                      OmahaRequestParams::kAppId,
71                                      NULL,
72                                      stateful_override);
73  board_app_id_ = GetLsbValue("CHROMEOS_BOARD_APPID",
74                              release_app_id,
75                              NULL,
76                              stateful_override);
77  canary_app_id_ = GetLsbValue("CHROMEOS_CANARY_APPID",
78                               release_app_id,
79                               NULL,
80                               stateful_override);
81  app_lang_ = "en-US";
82  hwid_ = system_state_->hardware()->GetHardwareClass();
83  if (CollectECFWVersions()) {
84    fw_version_ = system_state_->hardware()->GetFirmwareVersion();
85    ec_version_ = system_state_->hardware()->GetECVersion();
86  }
87
88  if (current_channel_ == target_channel_) {
89    // deltas are only okay if the /.nodelta file does not exist.  if we don't
90    // know (i.e. stat() returns some unexpected error), then err on the side of
91    // caution and say deltas are not okay.
92    struct stat stbuf;
93    delta_okay_ = (stat((root_ + "/.nodelta").c_str(), &stbuf) < 0) &&
94                  (errno == ENOENT);
95
96  } else {
97    LOG(INFO) << "Disabling deltas as a channel change is pending";
98    // For now, disable delta updates if the current channel is different from
99    // the channel that we're sending to the update server because such updates
100    // are destined to fail -- the current rootfs hash will be different than
101    // the expected hash due to the different channel in /etc/lsb-release.
102    delta_okay_ = false;
103  }
104
105  if (in_update_url.empty())
106    update_url_ = GetLsbValue("CHROMEOS_AUSERVER", kProductionOmahaUrl, NULL,
107                              stateful_override);
108  else
109    update_url_ = in_update_url;
110
111  // Set the interactive flag accordingly.
112  interactive_ = in_interactive;
113  return true;
114}
115
116bool OmahaRequestParams::CollectECFWVersions() const {
117  return (
118      StartsWithASCII(hwid_, string("SAMS ALEX"), true) ||
119      StartsWithASCII(hwid_, string("BUTTERFLY"), true) ||
120      StartsWithASCII(hwid_, string("LUMPY"), true) ||
121      StartsWithASCII(hwid_, string("PARROT"), true) ||
122      StartsWithASCII(hwid_, string("SPRING"), true) ||
123      StartsWithASCII(hwid_, string("SNOW"), true)
124  );
125}
126
127bool OmahaRequestParams::SetTargetChannel(const std::string& new_target_channel,
128                                          bool is_powerwash_allowed) {
129  LOG(INFO) << "SetTargetChannel called with " << new_target_channel
130            << ", Is Powerwash Allowed = "
131            << utils::ToString(is_powerwash_allowed)
132            << ". Current channel = " << current_channel_
133            << ", existing target channel = " << target_channel_
134            << ", download channel = " << download_channel_;
135  TEST_AND_RETURN_FALSE(IsValidChannel(new_target_channel));
136  FilePath kFile(root_ + kStatefulPartition + "/etc/lsb-release");
137  string file_data;
138  map<string, string> data;
139  if (file_util::ReadFileToString(kFile, &file_data)) {
140    data = simple_key_value_store::ParseString(file_data);
141  }
142  data[kUpdateChannelKey] = new_target_channel;
143  data[kIsPowerwashAllowedKey] = is_powerwash_allowed ? "true" : "false";
144  file_data = simple_key_value_store::AssembleString(data);
145  TEST_AND_RETURN_FALSE(file_util::CreateDirectory(kFile.DirName()));
146  TEST_AND_RETURN_FALSE(
147      file_util::WriteFile(kFile, file_data.data(), file_data.size()) ==
148      static_cast<int>(file_data.size()));
149  target_channel_ = new_target_channel;
150  is_powerwash_allowed_ = is_powerwash_allowed;
151  return true;
152}
153
154void OmahaRequestParams::SetTargetChannelFromLsbValue() {
155  string target_channel_new_value = GetLsbValue(
156      kUpdateChannelKey,
157      current_channel_,
158      &chromeos_update_engine::OmahaRequestParams::IsValidChannel,
159      true);  // stateful_override
160
161  if (target_channel_ != target_channel_new_value) {
162    target_channel_ = target_channel_new_value;
163    LOG(INFO) << "Target Channel set to " << target_channel_
164              << " from LSB file";
165  }
166}
167
168void OmahaRequestParams::SetCurrentChannelFromLsbValue() {
169  string current_channel_new_value = GetLsbValue(
170      kUpdateChannelKey,
171      current_channel_,
172      NULL,  // No need to validate the read-only rootfs channel.
173      false);  // stateful_override is false so we get the current channel.
174
175  if (current_channel_ != current_channel_new_value) {
176    current_channel_ = current_channel_new_value;
177    LOG(INFO) << "Current Channel set to " << current_channel_
178              << " from LSB file in rootfs";
179  }
180}
181
182void OmahaRequestParams::SetIsPowerwashAllowedFromLsbValue() {
183  string is_powerwash_allowed_str = GetLsbValue(
184      kIsPowerwashAllowedKey,
185      "false",
186      NULL, // no need to validate
187      true); // always get it from stateful, as that's the only place it'll be
188  bool is_powerwash_allowed_new_value = (is_powerwash_allowed_str == "true");
189  if (is_powerwash_allowed_ != is_powerwash_allowed_new_value) {
190    is_powerwash_allowed_ = is_powerwash_allowed_new_value;
191    LOG(INFO) << "Powerwash Allowed set to "
192              << utils::ToString(is_powerwash_allowed_)
193              << " from LSB file in stateful";
194  }
195}
196
197void OmahaRequestParams::UpdateDownloadChannel() {
198  if (download_channel_ != target_channel_) {
199    download_channel_ = target_channel_;
200    LOG(INFO) << "Download channel for this attempt = " << download_channel_;
201  }
202}
203
204void OmahaRequestParams::InitFromLsbValue() {
205  SetCurrentChannelFromLsbValue();
206  SetTargetChannelFromLsbValue();
207  SetIsPowerwashAllowedFromLsbValue();
208  UpdateDownloadChannel();
209}
210
211string OmahaRequestParams::GetLsbValue(const string& key,
212                                       const string& default_value,
213                                       ValueValidator validator,
214                                       bool stateful_override) const {
215  vector<string> files;
216  if (stateful_override) {
217    files.push_back(string(kStatefulPartition) + "/etc/lsb-release");
218  }
219  files.push_back("/etc/lsb-release");
220  for (vector<string>::const_iterator it = files.begin();
221       it != files.end(); ++it) {
222    // TODO(adlr): make sure files checked are owned as root (and all their
223    // parents are recursively, too).
224    string file_data;
225    if (!utils::ReadFile(root_ + *it, &file_data))
226      continue;
227
228    map<string, string> data = simple_key_value_store::ParseString(file_data);
229    if (utils::MapContainsKey(data, key)) {
230      const string& value = data[key];
231      if (validator && !CALL_MEMBER_FN(*this, validator)(value)) {
232        continue;
233      }
234      return value;
235    }
236  }
237  // not found
238  return default_value;
239}
240
241string OmahaRequestParams::GetMachineType() const {
242  struct utsname buf;
243  string ret;
244  if (uname(&buf) == 0)
245    ret = buf.machine;
246  return ret;
247}
248
249bool OmahaRequestParams::ShouldLockDown() const {
250  if (force_lock_down_) {
251    return forced_lock_down_;
252  }
253  return utils::IsOfficialBuild() && utils::IsNormalBootMode();
254}
255
256bool OmahaRequestParams::IsValidChannel(const std::string& channel) const {
257  return GetChannelIndex(channel) >= 0;
258}
259
260void OmahaRequestParams::set_root(const std::string& root) {
261  root_ = root;
262  InitFromLsbValue();
263}
264
265void OmahaRequestParams::SetLockDown(bool lock) {
266  force_lock_down_ = true;
267  forced_lock_down_ = lock;
268}
269
270int OmahaRequestParams::GetChannelIndex(const std::string& channel) const {
271  for (size_t t = 0; t < arraysize(kChannelsByStability); ++t)
272    if (channel == kChannelsByStability[t])
273      return t;
274
275  return -1;
276}
277
278bool OmahaRequestParams::to_more_stable_channel() const {
279  int current_channel_index = GetChannelIndex(current_channel_);
280  int download_channel_index = GetChannelIndex(download_channel_);
281
282  return download_channel_index > current_channel_index;
283}
284
285string OmahaRequestParams::GetAppId() const {
286  return download_channel_ == "canary-channel" ? canary_app_id_ : board_app_id_;
287}
288
289}  // namespace chromeos_update_engine
290