blob: d404997dce55a37b3f2ebe033112f6f48686ba00 [file] [log] [blame]
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001/*
2 * Copyright (C) 2007 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 */
16
xunchang24788852019-03-22 16:08:52 -070017#include "install/install.h"
Tao Bao20c581e2016-12-28 20:55:51 -080018
Doug Zongkerb2ee9202009-06-04 10:24:53 -070019#include <ctype.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080020#include <errno.h>
21#include <fcntl.h>
Alex Deymo4e29ce02016-08-12 13:43:04 -070022#include <inttypes.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080023#include <limits.h>
Elliott Hughes26dbad22015-01-28 12:09:05 -080024#include <string.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080025#include <sys/stat.h>
Doug Zongkerb2ee9202009-06-04 10:24:53 -070026#include <sys/wait.h>
27#include <unistd.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080028
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070029#include <algorithm>
Tianjie Xu37957102017-06-07 17:59:55 -070030#include <atomic>
Elliott Hughes8febafa2016-04-13 16:39:56 -070031#include <chrono>
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070032#include <condition_variable>
Tianjie Xucd8faf72019-08-06 12:32:05 -070033#include <filesystem>
Tao Bao5e535012017-03-16 17:37:38 -070034#include <functional>
Alex Deymo4344d632016-08-03 21:03:53 -070035#include <limits>
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070036#include <mutex>
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070037#include <thread>
Tao Bao71e3e092016-02-02 14:02:27 -080038#include <vector>
39
Tianjie Xue16e7992016-09-09 10:55:44 -070040#include <android-base/file.h>
41#include <android-base/logging.h>
Tao Bao20c581e2016-12-28 20:55:51 -080042#include <android-base/parsedouble.h>
Tianjie Xub0ddae52016-06-08 14:30:04 -070043#include <android-base/parseint.h>
Tao Baoefc35592017-01-08 22:45:47 -080044#include <android-base/properties.h>
Tianjie Xu16255832016-04-30 11:49:59 -070045#include <android-base/stringprintf.h>
46#include <android-base/strings.h>
Tao Baocf60a442018-06-18 14:56:20 -070047#include <android-base/unique_fd.h>
Tianjie Xu16255832016-04-30 11:49:59 -070048
xunchang24788852019-03-22 16:08:52 -070049#include "install/package.h"
50#include "install/verifier.h"
xunchang316e9712019-04-12 16:22:15 -070051#include "install/wipe_data.h"
Tao Bao1fc5bf32017-10-06 07:43:41 -070052#include "otautil/error_code.h"
Tao Bao641fa972018-04-25 18:59:40 -070053#include "otautil/paths.h"
Tao Bao17054c02018-05-03 22:41:23 -070054#include "otautil/sysutil.h"
xunchang24788852019-03-22 16:08:52 -070055#include "private/setup_commands.h"
Tianjie Xu8f397302018-08-20 13:40:47 -070056#include "recovery_ui/ui.h"
Tao Baoe3f09a72019-10-01 11:55:36 -070057#include "recovery_utils/roots.h"
58#include "recovery_utils/thermalutil.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080059
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070060using namespace std::chrono_literals;
61
xunchang24788852019-03-22 16:08:52 -070062static constexpr int kRecoveryApiVersion = 3;
Tianjie Xu164c60a2019-05-15 13:59:39 -070063// We define RECOVERY_API_VERSION in Android.mk, which will be picked up by build system and packed
64// into target_files.zip. Assert the version defined in code and in Android.mk are consistent.
xunchang24788852019-03-22 16:08:52 -070065static_assert(kRecoveryApiVersion == RECOVERY_API_VERSION, "Mismatching recovery API versions.");
66
Doug Zongker74406302011-10-28 15:13:10 -070067// Default allocation of progress bar segments to operations
Tao Bao20c581e2016-12-28 20:55:51 -080068static constexpr int VERIFICATION_PROGRESS_TIME = 60;
69static constexpr float VERIFICATION_PROGRESS_FRACTION = 0.25;
Doug Zongker74406302011-10-28 15:13:10 -070070
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070071static std::condition_variable finish_log_temperature;
72
Tianjie Xu93b5bf22018-10-25 10:39:01 -070073bool ReadMetadataFromPackage(ZipArchiveHandle zip, std::map<std::string, std::string>* metadata) {
Tao Bao8a7afcc2017-04-18 22:05:50 -070074 CHECK(metadata != nullptr);
Tianjie Xub0ddae52016-06-08 14:30:04 -070075
Tao Bao8a7afcc2017-04-18 22:05:50 -070076 static constexpr const char* METADATA_PATH = "META-INF/com/android/metadata";
Tao Bao8a7afcc2017-04-18 22:05:50 -070077 ZipEntry entry;
Elliott Hughesa86dddb2019-05-03 22:52:37 -070078 if (FindEntry(zip, METADATA_PATH, &entry) != 0) {
Tao Bao8a7afcc2017-04-18 22:05:50 -070079 LOG(ERROR) << "Failed to find " << METADATA_PATH;
80 return false;
81 }
82
83 uint32_t length = entry.uncompressed_length;
Tianjie Xu93b5bf22018-10-25 10:39:01 -070084 std::string metadata_string(length, '\0');
85 int32_t err =
86 ExtractToMemory(zip, &entry, reinterpret_cast<uint8_t*>(&metadata_string[0]), length);
Tao Bao8a7afcc2017-04-18 22:05:50 -070087 if (err != 0) {
88 LOG(ERROR) << "Failed to extract " << METADATA_PATH << ": " << ErrorCodeString(err);
89 return false;
90 }
Tianjie Xu93b5bf22018-10-25 10:39:01 -070091
92 for (const std::string& line : android::base::Split(metadata_string, "\n")) {
93 size_t eq = line.find('=');
94 if (eq != std::string::npos) {
95 metadata->emplace(android::base::Trim(line.substr(0, eq)),
96 android::base::Trim(line.substr(eq + 1)));
97 }
98 }
99
Tao Bao8a7afcc2017-04-18 22:05:50 -0700100 return true;
Yabin Cui6faf0262016-06-09 14:09:39 -0700101}
102
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700103// Gets the value for the given key in |metadata|. Returns an emtpy string if the key isn't
104// present.
105static std::string get_value(const std::map<std::string, std::string>& metadata,
106 const std::string& key) {
107 const auto& it = metadata.find(key);
108 return (it == metadata.end()) ? "" : it->second;
109}
110
111static std::string OtaTypeToString(OtaType type) {
112 switch (type) {
113 case OtaType::AB:
114 return "AB";
115 case OtaType::BLOCK:
116 return "BLOCK";
117 case OtaType::BRICK:
118 return "BRICK";
Tao Bao8a7afcc2017-04-18 22:05:50 -0700119 }
Tianjie Xub0ddae52016-06-08 14:30:04 -0700120}
121
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700122// Read the build.version.incremental of src/tgt from the metadata and log it to last_install.
123static void ReadSourceTargetBuild(const std::map<std::string, std::string>& metadata,
124 std::vector<std::string>* log_buffer) {
125 // Examples of the pre-build and post-build strings in metadata:
126 // pre-build-incremental=2943039
127 // post-build-incremental=2951741
128 auto source_build = get_value(metadata, "pre-build-incremental");
129 if (!source_build.empty()) {
130 log_buffer->push_back("source_build: " + source_build);
131 }
132
133 auto target_build = get_value(metadata, "post-build-incremental");
134 if (!target_build.empty()) {
135 log_buffer->push_back("target_build: " + target_build);
136 }
137}
138
139// Checks the build version, fingerprint and timestamp in the metadata of the A/B package.
140// Downgrading is not allowed unless explicitly enabled in the package and only for
Tao Baocf60a442018-06-18 14:56:20 -0700141// incremental packages.
Tao Bao36c72762019-04-30 00:25:41 -0700142static bool CheckAbSpecificMetadata(const std::map<std::string, std::string>& metadata) {
Tao Baoefc35592017-01-08 22:45:47 -0800143 // Incremental updates should match the current build.
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700144 auto device_pre_build = android::base::GetProperty("ro.build.version.incremental", "");
145 auto pkg_pre_build = get_value(metadata, "pre-build-incremental");
146 if (!pkg_pre_build.empty() && pkg_pre_build != device_pre_build) {
147 LOG(ERROR) << "Package is for source build " << pkg_pre_build << " but expected "
148 << device_pre_build;
Tao Bao36c72762019-04-30 00:25:41 -0700149 return false;
Tao Baoefc35592017-01-08 22:45:47 -0800150 }
Alex Deymo4344d632016-08-03 21:03:53 -0700151
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700152 auto device_fingerprint = android::base::GetProperty("ro.build.fingerprint", "");
153 auto pkg_pre_build_fingerprint = get_value(metadata, "pre-build");
154 if (!pkg_pre_build_fingerprint.empty() && pkg_pre_build_fingerprint != device_fingerprint) {
Tao Baoefc35592017-01-08 22:45:47 -0800155 LOG(ERROR) << "Package is for source build " << pkg_pre_build_fingerprint << " but expected "
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700156 << device_fingerprint;
Tao Bao36c72762019-04-30 00:25:41 -0700157 return false;
Tao Baoefc35592017-01-08 22:45:47 -0800158 }
Alex Deymo4344d632016-08-03 21:03:53 -0700159
Tao Baoefc35592017-01-08 22:45:47 -0800160 // Check for downgrade version.
161 int64_t build_timestamp =
162 android::base::GetIntProperty("ro.build.date.utc", std::numeric_limits<int64_t>::max());
163 int64_t pkg_post_timestamp = 0;
164 // We allow to full update to the same version we are running, in case there
165 // is a problem with the current copy of that version.
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700166 auto pkg_post_timestamp_string = get_value(metadata, "post-timestamp");
167 if (pkg_post_timestamp_string.empty() ||
168 !android::base::ParseInt(pkg_post_timestamp_string, &pkg_post_timestamp) ||
Tao Baoefc35592017-01-08 22:45:47 -0800169 pkg_post_timestamp < build_timestamp) {
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700170 if (get_value(metadata, "ota-downgrade") != "yes") {
Tao Baoefc35592017-01-08 22:45:47 -0800171 LOG(ERROR) << "Update package is older than the current build, expected a build "
172 "newer than timestamp "
173 << build_timestamp << " but package has timestamp " << pkg_post_timestamp
174 << " and downgrade not allowed.";
Tao Bao36c72762019-04-30 00:25:41 -0700175 return false;
Tao Baoefc35592017-01-08 22:45:47 -0800176 }
177 if (pkg_pre_build_fingerprint.empty()) {
178 LOG(ERROR) << "Downgrade package must have a pre-build version set, not allowed.";
Tao Bao36c72762019-04-30 00:25:41 -0700179 return false;
Tao Baoefc35592017-01-08 22:45:47 -0800180 }
181 }
182
Tao Bao36c72762019-04-30 00:25:41 -0700183 return true;
Alex Deymo4344d632016-08-03 21:03:53 -0700184}
185
Tao Bao36c72762019-04-30 00:25:41 -0700186bool CheckPackageMetadata(const std::map<std::string, std::string>& metadata, OtaType ota_type) {
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700187 auto package_ota_type = get_value(metadata, "ota-type");
188 auto expected_ota_type = OtaTypeToString(ota_type);
189 if (ota_type != OtaType::AB && ota_type != OtaType::BRICK) {
190 LOG(INFO) << "Skip package metadata check for ota type " << expected_ota_type;
Tao Bao36c72762019-04-30 00:25:41 -0700191 return true;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700192 }
193
194 if (package_ota_type != expected_ota_type) {
195 LOG(ERROR) << "Unexpected ota package type, expects " << expected_ota_type << ", actual "
196 << package_ota_type;
Tao Bao36c72762019-04-30 00:25:41 -0700197 return false;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700198 }
199
200 auto device = android::base::GetProperty("ro.product.device", "");
201 auto pkg_device = get_value(metadata, "pre-device");
202 if (pkg_device != device || pkg_device.empty()) {
203 LOG(ERROR) << "Package is for product " << pkg_device << " but expected " << device;
Tao Bao36c72762019-04-30 00:25:41 -0700204 return false;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700205 }
206
207 // We allow the package to not have any serialno; and we also allow it to carry multiple serial
208 // numbers split by "|"; e.g. serialno=serialno1|serialno2|serialno3 ... We will fail the
209 // verification if the device's serialno doesn't match any of these carried numbers.
210 auto pkg_serial_no = get_value(metadata, "serialno");
211 if (!pkg_serial_no.empty()) {
212 auto device_serial_no = android::base::GetProperty("ro.serialno", "");
213 bool serial_number_match = false;
214 for (const auto& number : android::base::Split(pkg_serial_no, "|")) {
215 if (device_serial_no == android::base::Trim(number)) {
216 serial_number_match = true;
217 }
218 }
219 if (!serial_number_match) {
220 LOG(ERROR) << "Package is for serial " << pkg_serial_no;
Tao Bao36c72762019-04-30 00:25:41 -0700221 return false;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700222 }
223 }
224
225 if (ota_type == OtaType::AB) {
226 return CheckAbSpecificMetadata(metadata);
227 }
228
Tao Bao36c72762019-04-30 00:25:41 -0700229 return true;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700230}
231
Tao Bao36c72762019-04-30 00:25:41 -0700232bool SetUpAbUpdateCommands(const std::string& package, ZipArchiveHandle zip, int status_fd,
233 std::vector<std::string>* cmd) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700234 CHECK(cmd != nullptr);
Alex Deymo4344d632016-08-03 21:03:53 -0700235
Tao Baobc4b1fe2017-04-17 16:46:05 -0700236 // For A/B updates we extract the payload properties to a buffer and obtain the RAW payload offset
237 // in the zip file.
238 static constexpr const char* AB_OTA_PAYLOAD_PROPERTIES = "payload_properties.txt";
Tao Baobc4b1fe2017-04-17 16:46:05 -0700239 ZipEntry properties_entry;
Elliott Hughesa86dddb2019-05-03 22:52:37 -0700240 if (FindEntry(zip, AB_OTA_PAYLOAD_PROPERTIES, &properties_entry) != 0) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700241 LOG(ERROR) << "Failed to find " << AB_OTA_PAYLOAD_PROPERTIES;
Tao Bao36c72762019-04-30 00:25:41 -0700242 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700243 }
244 uint32_t properties_entry_length = properties_entry.uncompressed_length;
245 std::vector<uint8_t> payload_properties(properties_entry_length);
246 int32_t err =
247 ExtractToMemory(zip, &properties_entry, payload_properties.data(), properties_entry_length);
248 if (err != 0) {
249 LOG(ERROR) << "Failed to extract " << AB_OTA_PAYLOAD_PROPERTIES << ": " << ErrorCodeString(err);
Tao Bao36c72762019-04-30 00:25:41 -0700250 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700251 }
Alex Deymo4344d632016-08-03 21:03:53 -0700252
Tao Baobc4b1fe2017-04-17 16:46:05 -0700253 static constexpr const char* AB_OTA_PAYLOAD = "payload.bin";
Tao Baobc4b1fe2017-04-17 16:46:05 -0700254 ZipEntry payload_entry;
Elliott Hughesa86dddb2019-05-03 22:52:37 -0700255 if (FindEntry(zip, AB_OTA_PAYLOAD, &payload_entry) != 0) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700256 LOG(ERROR) << "Failed to find " << AB_OTA_PAYLOAD;
Tao Bao36c72762019-04-30 00:25:41 -0700257 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700258 }
259 long payload_offset = payload_entry.offset;
260 *cmd = {
Tao Bao2cc9bbb2018-08-14 12:34:46 -0700261 "/system/bin/update_engine_sideload",
Tao Bao00d57572017-05-02 15:48:54 -0700262 "--payload=file://" + package,
Tao Baobc4b1fe2017-04-17 16:46:05 -0700263 android::base::StringPrintf("--offset=%ld", payload_offset),
264 "--headers=" + std::string(payload_properties.begin(), payload_properties.end()),
265 android::base::StringPrintf("--status_fd=%d", status_fd),
266 };
Tao Bao36c72762019-04-30 00:25:41 -0700267 return true;
Alex Deymo4344d632016-08-03 21:03:53 -0700268}
269
Tao Bao36c72762019-04-30 00:25:41 -0700270bool SetUpNonAbUpdateCommands(const std::string& package, ZipArchiveHandle zip, int retry_count,
271 int status_fd, std::vector<std::string>* cmd) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700272 CHECK(cmd != nullptr);
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700273
Tao Baocf60a442018-06-18 14:56:20 -0700274 // In non-A/B updates we extract the update binary from the package.
Tao Baobc4b1fe2017-04-17 16:46:05 -0700275 static constexpr const char* UPDATE_BINARY_NAME = "META-INF/com/google/android/update-binary";
Tao Baobc4b1fe2017-04-17 16:46:05 -0700276 ZipEntry binary_entry;
Elliott Hughesa86dddb2019-05-03 22:52:37 -0700277 if (FindEntry(zip, UPDATE_BINARY_NAME, &binary_entry) != 0) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700278 LOG(ERROR) << "Failed to find update binary " << UPDATE_BINARY_NAME;
Tao Bao36c72762019-04-30 00:25:41 -0700279 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700280 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700281
Tao Baocf60a442018-06-18 14:56:20 -0700282 const std::string binary_path = Paths::Get().temporary_update_binary();
Tao Bao00d57572017-05-02 15:48:54 -0700283 unlink(binary_path.c_str());
Tao Baocf60a442018-06-18 14:56:20 -0700284 android::base::unique_fd fd(
285 open(binary_path.c_str(), O_CREAT | O_WRONLY | O_TRUNC | O_CLOEXEC, 0755));
Tao Baobc4b1fe2017-04-17 16:46:05 -0700286 if (fd == -1) {
Tao Bao00d57572017-05-02 15:48:54 -0700287 PLOG(ERROR) << "Failed to create " << binary_path;
Tao Bao36c72762019-04-30 00:25:41 -0700288 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700289 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700290
Tao Bao36c72762019-04-30 00:25:41 -0700291 if (auto error = ExtractEntryToFile(zip, &binary_entry, fd); error != 0) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700292 LOG(ERROR) << "Failed to extract " << UPDATE_BINARY_NAME << ": " << ErrorCodeString(error);
Tao Bao36c72762019-04-30 00:25:41 -0700293 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700294 }
295
Tao Bao6fcd2082019-01-16 09:29:17 -0800296 // When executing the update binary contained in the package, the arguments passed are:
297 // - the version number for this interface
298 // - an FD to which the program can write in order to update the progress bar.
299 // - the name of the package zip file.
300 // - an optional argument "retry" if this update is a retry of a failed update attempt.
Tao Baobc4b1fe2017-04-17 16:46:05 -0700301 *cmd = {
Tao Bao00d57572017-05-02 15:48:54 -0700302 binary_path,
Tao Baobd0ddcd2017-05-04 13:03:18 -0700303 std::to_string(kRecoveryApiVersion),
Tao Baobc4b1fe2017-04-17 16:46:05 -0700304 std::to_string(status_fd),
Tao Bao00d57572017-05-02 15:48:54 -0700305 package,
Tao Baobc4b1fe2017-04-17 16:46:05 -0700306 };
307 if (retry_count > 0) {
308 cmd->push_back("retry");
309 }
Tao Bao36c72762019-04-30 00:25:41 -0700310 return true;
Alex Deymo4344d632016-08-03 21:03:53 -0700311}
Alex Deymo4344d632016-08-03 21:03:53 -0700312
Tianjie Xu37957102017-06-07 17:59:55 -0700313static void log_max_temperature(int* max_temperature, const std::atomic<bool>& logger_finished) {
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700314 CHECK(max_temperature != nullptr);
315 std::mutex mtx;
316 std::unique_lock<std::mutex> lck(mtx);
Tianjie Xu37957102017-06-07 17:59:55 -0700317 while (!logger_finished.load() &&
318 finish_log_temperature.wait_for(lck, 20s) == std::cv_status::timeout) {
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700319 *max_temperature = std::max(*max_temperature, GetMaxValueFromThermalZone());
320 }
321}
322
Alex Deymo4344d632016-08-03 21:03:53 -0700323// If the package contains an update binary, extract it and run it.
Tianjie Xu980f92e2019-06-11 15:43:43 -0700324static InstallResult TryUpdateBinary(Package* package, bool* wipe_cache,
325 std::vector<std::string>* log_buffer, int retry_count,
326 int* max_temperature, RecoveryUI* ui) {
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700327 std::map<std::string, std::string> metadata;
Tianjie Xu980f92e2019-06-11 15:43:43 -0700328 auto zip = package->GetZipArchiveHandle();
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700329 if (!ReadMetadataFromPackage(zip, &metadata)) {
330 LOG(ERROR) << "Failed to parse metadata in the zip file";
331 return INSTALL_CORRUPT;
332 }
333
Yifan Hongf2af5622020-04-27 20:16:18 -0700334 bool package_is_ab = get_value(metadata, "ota-type") == OtaTypeToString(OtaType::AB);
335 bool device_supports_ab = android::base::GetBoolProperty("ro.build.ab_update", false);
336 bool ab_device_supports_nonab =
337 android::base::GetBoolProperty("ro.virtual_ab.allow_non_ab", false);
338 bool device_only_supports_ab = device_supports_ab && !ab_device_supports_nonab;
339
340 if (package_is_ab) {
Tianjie Xu980f92e2019-06-11 15:43:43 -0700341 CHECK(package->GetType() == PackageType::kFile);
342 }
343
Yifan Hongf2af5622020-04-27 20:16:18 -0700344 // Verify against the metadata in the package first. Expects A/B metadata if:
345 // Package declares itself as an A/B package
346 // Package does not declare itself as an A/B package, but device only supports A/B;
347 // still calls CheckPackageMetadata to get a meaningful error message.
348 if (package_is_ab || device_only_supports_ab) {
349 if (!CheckPackageMetadata(metadata, OtaType::AB)) {
350 log_buffer->push_back(android::base::StringPrintf("error: %d", kUpdateBinaryCommandFailure));
351 return INSTALL_ERROR;
352 }
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700353 }
354
355 ReadSourceTargetBuild(metadata, log_buffer);
Alex Deymo4344d632016-08-03 21:03:53 -0700356
Tao Bao6fcd2082019-01-16 09:29:17 -0800357 // The updater in child process writes to the pipe to communicate with recovery.
358 android::base::unique_fd pipe_read, pipe_write;
Bill Peckham08ba1ad2019-03-28 18:42:13 -0700359 // Explicitly disable O_CLOEXEC using 0 as the flags (last) parameter to Pipe
360 // so that the child updater process will recieve a non-closed fd.
361 if (!android::base::Pipe(&pipe_read, &pipe_write, 0)) {
Tao Bao6fcd2082019-01-16 09:29:17 -0800362 PLOG(ERROR) << "Failed to create pipe for updater-recovery communication";
363 return INSTALL_CORRUPT;
364 }
365
366 // The updater-recovery communication protocol.
367 //
368 // progress <frac> <secs>
369 // fill up the next <frac> part of of the progress bar over <secs> seconds. If <secs> is
370 // zero, use `set_progress` commands to manually control the progress of this segment of the
371 // bar.
372 //
373 // set_progress <frac>
374 // <frac> should be between 0.0 and 1.0; sets the progress bar within the segment defined by
375 // the most recent progress command.
376 //
377 // ui_print <string>
378 // display <string> on the screen.
379 //
380 // wipe_cache
381 // a wipe of cache will be performed following a successful installation.
382 //
383 // clear_display
384 // turn off the text display.
385 //
386 // enable_reboot
387 // packages can explicitly request that they want the user to be able to reboot during
388 // installation (useful for debugging packages that don't exit).
389 //
390 // retry_update
391 // updater encounters some issue during the update. It requests a reboot to retry the same
392 // package automatically.
393 //
394 // log <string>
395 // updater requests logging the string (e.g. cause of the failure).
396 //
397
Tianjie Xu980f92e2019-06-11 15:43:43 -0700398 std::string package_path = package->GetPath();
399
Tao Bao20c581e2016-12-28 20:55:51 -0800400 std::vector<std::string> args;
Tao Bao36c72762019-04-30 00:25:41 -0700401 if (auto setup_result =
Yifan Hongf2af5622020-04-27 20:16:18 -0700402 package_is_ab
403 ? SetUpAbUpdateCommands(package_path, zip, pipe_write.get(), &args)
404 : SetUpNonAbUpdateCommands(package_path, zip, retry_count, pipe_write.get(), &args);
Tao Bao36c72762019-04-30 00:25:41 -0700405 !setup_result) {
Tianjie Xu3fec8c62017-08-23 00:18:07 -0700406 log_buffer->push_back(android::base::StringPrintf("error: %d", kUpdateBinaryCommandFailure));
Tao Bao36c72762019-04-30 00:25:41 -0700407 return INSTALL_CORRUPT;
Tao Bao20c581e2016-12-28 20:55:51 -0800408 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700409
Tao Bao20c581e2016-12-28 20:55:51 -0800410 pid_t pid = fork();
Tao Bao20c581e2016-12-28 20:55:51 -0800411 if (pid == -1) {
Tao Bao20c581e2016-12-28 20:55:51 -0800412 PLOG(ERROR) << "Failed to fork update binary";
Tianjie Xu3fec8c62017-08-23 00:18:07 -0700413 log_buffer->push_back(android::base::StringPrintf("error: %d", kForkUpdateBinaryFailure));
Tao Bao20c581e2016-12-28 20:55:51 -0800414 return INSTALL_ERROR;
415 }
416
417 if (pid == 0) {
418 umask(022);
Tao Bao6fcd2082019-01-16 09:29:17 -0800419 pipe_read.reset();
420
421 // Convert the std::string vector to a NULL-terminated char* vector suitable for execv.
422 auto chr_args = StringVectorToNullTerminatedArray(args);
Tao Bao3d69f0d2018-12-20 09:44:06 -0800423 execv(chr_args[0], chr_args.data());
Tao Bao6fcd2082019-01-16 09:29:17 -0800424 // We shouldn't use LOG/PLOG in the forked process, since they may cause the child process to
425 // hang. This deadlock results from an improperly copied mutex in the ui functions.
426 // (Bug: 34769056)
Tianjie Xuab1abae2017-01-30 16:48:52 -0800427 fprintf(stdout, "E:Can't run %s (%s)\n", chr_args[0], strerror(errno));
Tao Bao3da88012017-02-03 13:09:23 -0800428 _exit(EXIT_FAILURE);
Tao Bao20c581e2016-12-28 20:55:51 -0800429 }
Tao Bao6fcd2082019-01-16 09:29:17 -0800430 pipe_write.reset();
Tao Bao20c581e2016-12-28 20:55:51 -0800431
Tianjie Xu37957102017-06-07 17:59:55 -0700432 std::atomic<bool> logger_finished(false);
433 std::thread temperature_logger(log_max_temperature, max_temperature, std::ref(logger_finished));
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700434
Tao Bao20c581e2016-12-28 20:55:51 -0800435 *wipe_cache = false;
436 bool retry_update = false;
437
438 char buffer[1024];
Tao Bao6fcd2082019-01-16 09:29:17 -0800439 FILE* from_child = android::base::Fdopen(std::move(pipe_read), "r");
Tao Bao20c581e2016-12-28 20:55:51 -0800440 while (fgets(buffer, sizeof(buffer), from_child) != nullptr) {
441 std::string line(buffer);
442 size_t space = line.find_first_of(" \n");
443 std::string command(line.substr(0, space));
444 if (command.empty()) continue;
445
446 // Get rid of the leading and trailing space and/or newline.
447 std::string args = space == std::string::npos ? "" : android::base::Trim(line.substr(space));
448
449 if (command == "progress") {
450 std::vector<std::string> tokens = android::base::Split(args, " ");
451 double fraction;
452 int seconds;
453 if (tokens.size() == 2 && android::base::ParseDouble(tokens[0].c_str(), &fraction) &&
454 android::base::ParseInt(tokens[1], &seconds)) {
455 ui->ShowProgress(fraction * (1 - VERIFICATION_PROGRESS_FRACTION), seconds);
456 } else {
457 LOG(ERROR) << "invalid \"progress\" parameters: " << line;
458 }
459 } else if (command == "set_progress") {
460 std::vector<std::string> tokens = android::base::Split(args, " ");
461 double fraction;
462 if (tokens.size() == 1 && android::base::ParseDouble(tokens[0].c_str(), &fraction)) {
463 ui->SetProgress(fraction);
464 } else {
465 LOG(ERROR) << "invalid \"set_progress\" parameters: " << line;
466 }
467 } else if (command == "ui_print") {
Tao Baof0136422017-01-21 13:03:25 -0800468 ui->PrintOnScreenOnly("%s\n", args.c_str());
Tao Bao20c581e2016-12-28 20:55:51 -0800469 fflush(stdout);
470 } else if (command == "wipe_cache") {
471 *wipe_cache = true;
472 } else if (command == "clear_display") {
473 ui->SetBackground(RecoveryUI::NONE);
474 } else if (command == "enable_reboot") {
475 // packages can explicitly request that they want the user
476 // to be able to reboot during installation (useful for
477 // debugging packages that don't exit).
478 ui->SetEnableReboot(true);
479 } else if (command == "retry_update") {
480 retry_update = true;
481 } else if (command == "log") {
482 if (!args.empty()) {
483 // Save the logging request from updater and write to last_install later.
Tao Bao29ee69b2017-05-01 12:23:17 -0700484 log_buffer->push_back(args);
Tao Bao20c581e2016-12-28 20:55:51 -0800485 } else {
486 LOG(ERROR) << "invalid \"log\" parameters: " << line;
487 }
488 } else {
489 LOG(ERROR) << "unknown command [" << command << "]";
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700490 }
Tao Bao20c581e2016-12-28 20:55:51 -0800491 }
492 fclose(from_child);
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700493
Tao Bao20c581e2016-12-28 20:55:51 -0800494 int status;
495 waitpid(pid, &status, 0);
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700496
Tianjie Xu37957102017-06-07 17:59:55 -0700497 logger_finished.store(true);
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700498 finish_log_temperature.notify_one();
499 temperature_logger.join();
500
Tao Bao20c581e2016-12-28 20:55:51 -0800501 if (retry_update) {
502 return INSTALL_RETRY;
503 }
Tao Baoe7b775c2018-11-07 15:13:30 -0800504 if (WIFEXITED(status)) {
505 if (WEXITSTATUS(status) != EXIT_SUCCESS) {
Tianjie Xu980f92e2019-06-11 15:43:43 -0700506 LOG(ERROR) << "Error in " << package_path << " (status " << WEXITSTATUS(status) << ")";
Tao Baoe7b775c2018-11-07 15:13:30 -0800507 return INSTALL_ERROR;
508 }
509 } else if (WIFSIGNALED(status)) {
Tianjie Xu980f92e2019-06-11 15:43:43 -0700510 LOG(ERROR) << "Error in " << package_path << " (killed by signal " << WTERMSIG(status) << ")";
Tao Bao20c581e2016-12-28 20:55:51 -0800511 return INSTALL_ERROR;
Tao Baoe7b775c2018-11-07 15:13:30 -0800512 } else {
513 LOG(FATAL) << "Invalid status code " << status;
Tao Bao20c581e2016-12-28 20:55:51 -0800514 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700515
Tao Bao20c581e2016-12-28 20:55:51 -0800516 return INSTALL_SUCCESS;
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700517}
518
Tianjie Xu980f92e2019-06-11 15:43:43 -0700519static InstallResult VerifyAndInstallPackage(Package* package, bool* wipe_cache,
520 std::vector<std::string>* log_buffer, int retry_count,
521 int* max_temperature, RecoveryUI* ui) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700522 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
Tao Bao29ee69b2017-05-01 12:23:17 -0700523 // Give verification half the progress bar...
524 ui->SetProgressType(RecoveryUI::DETERMINATE);
525 ui->ShowProgress(VERIFICATION_PROGRESS_FRACTION, VERIFICATION_PROGRESS_TIME);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800526
Tao Bao29ee69b2017-05-01 12:23:17 -0700527 // Verify package.
Tianjie Xu980f92e2019-06-11 15:43:43 -0700528 if (!verify_package(package, ui)) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700529 log_buffer->push_back(android::base::StringPrintf("error: %d", kZipVerificationFailure));
Tao Bao29ee69b2017-05-01 12:23:17 -0700530 return INSTALL_CORRUPT;
531 }
Doug Zongker60151a22009-08-12 18:30:03 -0700532
Tao Bao29ee69b2017-05-01 12:23:17 -0700533 // Verify and install the contents of the package.
534 ui->Print("Installing update...\n");
535 if (retry_count > 0) {
536 ui->Print("Retry attempt: %d\n", retry_count);
537 }
538 ui->SetEnableReboot(false);
Tianjie Xu980f92e2019-06-11 15:43:43 -0700539 auto result = TryUpdateBinary(package, wipe_cache, log_buffer, retry_count, max_temperature, ui);
Tao Bao29ee69b2017-05-01 12:23:17 -0700540 ui->SetEnableReboot(true);
541 ui->Print("\n");
542
Tao Bao29ee69b2017-05-01 12:23:17 -0700543 return result;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800544}
Doug Zongker469243e2011-04-12 09:28:10 -0700545
Tianjie Xu980f92e2019-06-11 15:43:43 -0700546InstallResult InstallPackage(Package* package, const std::string_view package_id,
547 bool should_wipe_cache, int retry_count, RecoveryUI* ui) {
Tao Baof8119fb2017-04-18 21:35:12 -0700548 auto start = std::chrono::system_clock::now();
Tao Bao682c34b2015-04-07 17:16:35 -0700549
Tao Baof8119fb2017-04-18 21:35:12 -0700550 int start_temperature = GetMaxValueFromThermalZone();
551 int max_temperature = start_temperature;
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700552
Tao Baoadc99ef2019-04-29 23:48:02 -0700553 InstallResult result;
Tao Baof8119fb2017-04-18 21:35:12 -0700554 std::vector<std::string> log_buffer;
Tianjie Xu980f92e2019-06-11 15:43:43 -0700555
Tianjie Xu164c60a2019-05-15 13:59:39 -0700556 ui->Print("Supported API: %d\n", kRecoveryApiVersion);
557
Tianjie Xu980f92e2019-06-11 15:43:43 -0700558 ui->Print("Finding update package...\n");
559 LOG(INFO) << "Update package id: " << package_id;
560 if (!package) {
561 log_buffer.push_back(android::base::StringPrintf("error: %d", kMapFileFailure));
562 result = INSTALL_CORRUPT;
563 } else if (setup_install_mounts() != 0) {
Tao Baof8119fb2017-04-18 21:35:12 -0700564 LOG(ERROR) << "failed to set up expected mounts for install; aborting";
565 result = INSTALL_ERROR;
566 } else {
xunchang316e9712019-04-12 16:22:15 -0700567 bool updater_wipe_cache = false;
Tianjie Xu980f92e2019-06-11 15:43:43 -0700568 result = VerifyAndInstallPackage(package, &updater_wipe_cache, &log_buffer, retry_count,
569 &max_temperature, ui);
xunchang316e9712019-04-12 16:22:15 -0700570 should_wipe_cache = should_wipe_cache || updater_wipe_cache;
Tao Baof8119fb2017-04-18 21:35:12 -0700571 }
572
573 // Measure the time spent to apply OTA update in seconds.
574 std::chrono::duration<double> duration = std::chrono::system_clock::now() - start;
575 int time_total = static_cast<int>(duration.count());
576
Tao Bao3e18f2b2017-09-29 17:11:13 -0700577 bool has_cache = volume_for_mount_point("/cache") != nullptr;
Tao Baof8119fb2017-04-18 21:35:12 -0700578 // Skip logging the uncrypt_status on devices without /cache.
579 if (has_cache) {
580 static constexpr const char* UNCRYPT_STATUS = "/cache/recovery/uncrypt_status";
581 if (ensure_path_mounted(UNCRYPT_STATUS) != 0) {
582 LOG(WARNING) << "Can't mount " << UNCRYPT_STATUS;
Doug Zongker239ac6a2013-08-20 16:03:25 -0700583 } else {
Tao Baof8119fb2017-04-18 21:35:12 -0700584 std::string uncrypt_status;
585 if (!android::base::ReadFileToString(UNCRYPT_STATUS, &uncrypt_status)) {
586 PLOG(WARNING) << "failed to read uncrypt status";
587 } else if (!android::base::StartsWith(uncrypt_status, "uncrypt_")) {
588 LOG(WARNING) << "corrupted uncrypt_status: " << uncrypt_status;
Tianjie Xua2867782017-03-24 14:13:56 -0700589 } else {
Tao Baof8119fb2017-04-18 21:35:12 -0700590 log_buffer.push_back(android::base::Trim(uncrypt_status));
Tianjie Xua2867782017-03-24 14:13:56 -0700591 }
Doug Zongker469243e2011-04-12 09:28:10 -0700592 }
Tao Baof8119fb2017-04-18 21:35:12 -0700593 }
Tao Baobadaac42016-09-26 11:39:14 -0700594
Tao Baof8119fb2017-04-18 21:35:12 -0700595 // The first two lines need to be the package name and install result.
596 std::vector<std::string> log_header = {
Tianjie Xu980f92e2019-06-11 15:43:43 -0700597 std::string(package_id),
Tao Baof8119fb2017-04-18 21:35:12 -0700598 result == INSTALL_SUCCESS ? "1" : "0",
599 "time_total: " + std::to_string(time_total),
600 "retry: " + std::to_string(retry_count),
601 };
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700602
Tao Baof8119fb2017-04-18 21:35:12 -0700603 int end_temperature = GetMaxValueFromThermalZone();
604 max_temperature = std::max(end_temperature, max_temperature);
605 if (start_temperature > 0) {
606 log_buffer.push_back("temperature_start: " + std::to_string(start_temperature));
607 }
608 if (end_temperature > 0) {
609 log_buffer.push_back("temperature_end: " + std::to_string(end_temperature));
610 }
611 if (max_temperature > 0) {
612 log_buffer.push_back("temperature_max: " + std::to_string(max_temperature));
613 }
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700614
Tao Baof8119fb2017-04-18 21:35:12 -0700615 std::string log_content =
616 android::base::Join(log_header, "\n") + "\n" + android::base::Join(log_buffer, "\n") + "\n";
Tao Bao641fa972018-04-25 18:59:40 -0700617 const std::string& install_file = Paths::Get().temporary_install_file();
Tao Baof8119fb2017-04-18 21:35:12 -0700618 if (!android::base::WriteStringToFile(log_content, install_file)) {
619 PLOG(ERROR) << "failed to write " << install_file;
620 }
Tao Baobadaac42016-09-26 11:39:14 -0700621
Tao Baof8119fb2017-04-18 21:35:12 -0700622 // Write a copy into last_log.
623 LOG(INFO) << log_content;
Tao Baobadaac42016-09-26 11:39:14 -0700624
xunchang316e9712019-04-12 16:22:15 -0700625 if (result == INSTALL_SUCCESS && should_wipe_cache) {
626 if (!WipeCache(ui, nullptr)) {
627 result = INSTALL_ERROR;
628 }
629 }
630
Tao Baof8119fb2017-04-18 21:35:12 -0700631 return result;
Doug Zongker469243e2011-04-12 09:28:10 -0700632}
Yabin Cui6faf0262016-06-09 14:09:39 -0700633
xunchang24788852019-03-22 16:08:52 -0700634bool verify_package(Package* package, RecoveryUI* ui) {
Tianjie Xue1d02fb2018-10-19 15:52:17 -0700635 static constexpr const char* CERTIFICATE_ZIP_FILE = "/system/etc/security/otacerts.zip";
636 std::vector<Certificate> loaded_keys = LoadKeysFromZipfile(CERTIFICATE_ZIP_FILE);
637 if (loaded_keys.empty()) {
Tao Bao5e535012017-03-16 17:37:38 -0700638 LOG(ERROR) << "Failed to load keys";
639 return false;
640 }
Tianjie Xue1d02fb2018-10-19 15:52:17 -0700641 LOG(INFO) << loaded_keys.size() << " key(s) loaded from " << CERTIFICATE_ZIP_FILE;
Yabin Cui6faf0262016-06-09 14:09:39 -0700642
Tao Bao5e535012017-03-16 17:37:38 -0700643 // Verify package.
644 ui->Print("Verifying update package...\n");
645 auto t0 = std::chrono::system_clock::now();
xunchangf07ed2e2019-02-25 14:14:01 -0800646 int err = verify_file(package, loaded_keys);
Tao Bao5e535012017-03-16 17:37:38 -0700647 std::chrono::duration<double> duration = std::chrono::system_clock::now() - t0;
648 ui->Print("Update package verification took %.1f s (result %d).\n", duration.count(), err);
649 if (err != VERIFY_SUCCESS) {
650 LOG(ERROR) << "Signature verification failed";
651 LOG(ERROR) << "error: " << kZipVerificationFailure;
652 return false;
653 }
654 return true;
Yabin Cui6faf0262016-06-09 14:09:39 -0700655}
Tianjie Xucd8faf72019-08-06 12:32:05 -0700656
657bool SetupPackageMount(const std::string& package_path, bool* should_use_fuse) {
658 CHECK(should_use_fuse != nullptr);
659
660 if (package_path.empty()) {
661 return false;
662 }
663
664 *should_use_fuse = true;
665 if (package_path[0] == '@') {
666 auto block_map_path = package_path.substr(1);
667 if (ensure_path_mounted(block_map_path) != 0) {
668 LOG(ERROR) << "Failed to mount " << block_map_path;
669 return false;
670 }
671 // uncrypt only produces block map only if the package stays on /data.
672 *should_use_fuse = false;
673 return true;
674 }
675
676 // Package is not a block map file.
677 if (ensure_path_mounted(package_path) != 0) {
678 LOG(ERROR) << "Failed to mount " << package_path;
679 return false;
680 }
681
682 // Reject the package if the input path doesn't equal the canonicalized path.
683 // e.g. /cache/../sdcard/update_package.
684 std::error_code ec;
685 auto canonical_path = std::filesystem::canonical(package_path, ec);
686 if (ec) {
687 LOG(ERROR) << "Failed to get canonical of " << package_path << ", " << ec.message();
688 return false;
689 }
690 if (canonical_path.string() != package_path) {
691 LOG(ERROR) << "Installation aborts. The canonical path " << canonical_path.string()
692 << " doesn't equal the original path " << package_path;
693 return false;
694 }
695
696 constexpr const char* CACHE_ROOT = "/cache";
697 if (android::base::StartsWith(package_path, CACHE_ROOT)) {
698 *should_use_fuse = false;
699 }
700 return true;
701}