blob: 56c1e68ded2bcbcab2dce7a942f19c121c49ebc2 [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>
Tao Bao5e535012017-03-16 17:37:38 -070033#include <functional>
Alex Deymo4344d632016-08-03 21:03:53 -070034#include <limits>
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070035#include <mutex>
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070036#include <thread>
Tao Bao71e3e092016-02-02 14:02:27 -080037#include <vector>
38
Tianjie Xue16e7992016-09-09 10:55:44 -070039#include <android-base/file.h>
40#include <android-base/logging.h>
Tao Bao20c581e2016-12-28 20:55:51 -080041#include <android-base/parsedouble.h>
Tianjie Xub0ddae52016-06-08 14:30:04 -070042#include <android-base/parseint.h>
Tao Baoefc35592017-01-08 22:45:47 -080043#include <android-base/properties.h>
Tianjie Xu16255832016-04-30 11:49:59 -070044#include <android-base/stringprintf.h>
45#include <android-base/strings.h>
Tao Baocf60a442018-06-18 14:56:20 -070046#include <android-base/unique_fd.h>
Tianjie Xu16255832016-04-30 11:49:59 -070047
xunchang24788852019-03-22 16:08:52 -070048#include "install/package.h"
49#include "install/verifier.h"
xunchang316e9712019-04-12 16:22:15 -070050#include "install/wipe_data.h"
Tao Bao1fc5bf32017-10-06 07:43:41 -070051#include "otautil/error_code.h"
Tao Bao641fa972018-04-25 18:59:40 -070052#include "otautil/paths.h"
Tao Bao17054c02018-05-03 22:41:23 -070053#include "otautil/sysutil.h"
xunchang24788852019-03-22 16:08:52 -070054#include "private/setup_commands.h"
Tianjie Xu8f397302018-08-20 13:40:47 -070055#include "recovery_ui/ui.h"
Tao Baoe3f09a72019-10-01 11:55:36 -070056#include "recovery_utils/roots.h"
57#include "recovery_utils/thermalutil.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080058
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070059using namespace std::chrono_literals;
60
xunchang24788852019-03-22 16:08:52 -070061static constexpr int kRecoveryApiVersion = 3;
Tianjie Xu164c60a2019-05-15 13:59:39 -070062// We define RECOVERY_API_VERSION in Android.mk, which will be picked up by build system and packed
63// into target_files.zip. Assert the version defined in code and in Android.mk are consistent.
xunchang24788852019-03-22 16:08:52 -070064static_assert(kRecoveryApiVersion == RECOVERY_API_VERSION, "Mismatching recovery API versions.");
65
Doug Zongker74406302011-10-28 15:13:10 -070066// Default allocation of progress bar segments to operations
Tao Bao20c581e2016-12-28 20:55:51 -080067static constexpr int VERIFICATION_PROGRESS_TIME = 60;
68static constexpr float VERIFICATION_PROGRESS_FRACTION = 0.25;
Doug Zongker74406302011-10-28 15:13:10 -070069
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070070static std::condition_variable finish_log_temperature;
71
Tianjie Xu93b5bf22018-10-25 10:39:01 -070072bool ReadMetadataFromPackage(ZipArchiveHandle zip, std::map<std::string, std::string>* metadata) {
Tao Bao8a7afcc2017-04-18 22:05:50 -070073 CHECK(metadata != nullptr);
Tianjie Xub0ddae52016-06-08 14:30:04 -070074
Tao Bao8a7afcc2017-04-18 22:05:50 -070075 static constexpr const char* METADATA_PATH = "META-INF/com/android/metadata";
Tao Bao8a7afcc2017-04-18 22:05:50 -070076 ZipEntry entry;
Elliott Hughesa86dddb2019-05-03 22:52:37 -070077 if (FindEntry(zip, METADATA_PATH, &entry) != 0) {
Tao Bao8a7afcc2017-04-18 22:05:50 -070078 LOG(ERROR) << "Failed to find " << METADATA_PATH;
79 return false;
80 }
81
82 uint32_t length = entry.uncompressed_length;
Tianjie Xu93b5bf22018-10-25 10:39:01 -070083 std::string metadata_string(length, '\0');
84 int32_t err =
85 ExtractToMemory(zip, &entry, reinterpret_cast<uint8_t*>(&metadata_string[0]), length);
Tao Bao8a7afcc2017-04-18 22:05:50 -070086 if (err != 0) {
87 LOG(ERROR) << "Failed to extract " << METADATA_PATH << ": " << ErrorCodeString(err);
88 return false;
89 }
Tianjie Xu93b5bf22018-10-25 10:39:01 -070090
91 for (const std::string& line : android::base::Split(metadata_string, "\n")) {
92 size_t eq = line.find('=');
93 if (eq != std::string::npos) {
94 metadata->emplace(android::base::Trim(line.substr(0, eq)),
95 android::base::Trim(line.substr(eq + 1)));
96 }
97 }
98
Tao Bao8a7afcc2017-04-18 22:05:50 -070099 return true;
Yabin Cui6faf0262016-06-09 14:09:39 -0700100}
101
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700102// Gets the value for the given key in |metadata|. Returns an emtpy string if the key isn't
103// present.
104static std::string get_value(const std::map<std::string, std::string>& metadata,
105 const std::string& key) {
106 const auto& it = metadata.find(key);
107 return (it == metadata.end()) ? "" : it->second;
108}
109
110static std::string OtaTypeToString(OtaType type) {
111 switch (type) {
112 case OtaType::AB:
113 return "AB";
114 case OtaType::BLOCK:
115 return "BLOCK";
116 case OtaType::BRICK:
117 return "BRICK";
Tao Bao8a7afcc2017-04-18 22:05:50 -0700118 }
Tianjie Xub0ddae52016-06-08 14:30:04 -0700119}
120
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700121// Read the build.version.incremental of src/tgt from the metadata and log it to last_install.
122static void ReadSourceTargetBuild(const std::map<std::string, std::string>& metadata,
123 std::vector<std::string>* log_buffer) {
124 // Examples of the pre-build and post-build strings in metadata:
125 // pre-build-incremental=2943039
126 // post-build-incremental=2951741
127 auto source_build = get_value(metadata, "pre-build-incremental");
128 if (!source_build.empty()) {
129 log_buffer->push_back("source_build: " + source_build);
130 }
131
132 auto target_build = get_value(metadata, "post-build-incremental");
133 if (!target_build.empty()) {
134 log_buffer->push_back("target_build: " + target_build);
135 }
136}
137
138// Checks the build version, fingerprint and timestamp in the metadata of the A/B package.
139// Downgrading is not allowed unless explicitly enabled in the package and only for
Tao Baocf60a442018-06-18 14:56:20 -0700140// incremental packages.
Tao Bao36c72762019-04-30 00:25:41 -0700141static bool CheckAbSpecificMetadata(const std::map<std::string, std::string>& metadata) {
Tao Baoefc35592017-01-08 22:45:47 -0800142 // Incremental updates should match the current build.
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700143 auto device_pre_build = android::base::GetProperty("ro.build.version.incremental", "");
144 auto pkg_pre_build = get_value(metadata, "pre-build-incremental");
145 if (!pkg_pre_build.empty() && pkg_pre_build != device_pre_build) {
146 LOG(ERROR) << "Package is for source build " << pkg_pre_build << " but expected "
147 << device_pre_build;
Tao Bao36c72762019-04-30 00:25:41 -0700148 return false;
Tao Baoefc35592017-01-08 22:45:47 -0800149 }
Alex Deymo4344d632016-08-03 21:03:53 -0700150
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700151 auto device_fingerprint = android::base::GetProperty("ro.build.fingerprint", "");
152 auto pkg_pre_build_fingerprint = get_value(metadata, "pre-build");
153 if (!pkg_pre_build_fingerprint.empty() && pkg_pre_build_fingerprint != device_fingerprint) {
Tao Baoefc35592017-01-08 22:45:47 -0800154 LOG(ERROR) << "Package is for source build " << pkg_pre_build_fingerprint << " but expected "
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700155 << device_fingerprint;
Tao Bao36c72762019-04-30 00:25:41 -0700156 return false;
Tao Baoefc35592017-01-08 22:45:47 -0800157 }
Alex Deymo4344d632016-08-03 21:03:53 -0700158
Tao Baoefc35592017-01-08 22:45:47 -0800159 // Check for downgrade version.
160 int64_t build_timestamp =
161 android::base::GetIntProperty("ro.build.date.utc", std::numeric_limits<int64_t>::max());
162 int64_t pkg_post_timestamp = 0;
163 // We allow to full update to the same version we are running, in case there
164 // is a problem with the current copy of that version.
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700165 auto pkg_post_timestamp_string = get_value(metadata, "post-timestamp");
166 if (pkg_post_timestamp_string.empty() ||
167 !android::base::ParseInt(pkg_post_timestamp_string, &pkg_post_timestamp) ||
Tao Baoefc35592017-01-08 22:45:47 -0800168 pkg_post_timestamp < build_timestamp) {
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700169 if (get_value(metadata, "ota-downgrade") != "yes") {
Tao Baoefc35592017-01-08 22:45:47 -0800170 LOG(ERROR) << "Update package is older than the current build, expected a build "
171 "newer than timestamp "
172 << build_timestamp << " but package has timestamp " << pkg_post_timestamp
173 << " and downgrade not allowed.";
Tao Bao36c72762019-04-30 00:25:41 -0700174 return false;
Tao Baoefc35592017-01-08 22:45:47 -0800175 }
176 if (pkg_pre_build_fingerprint.empty()) {
177 LOG(ERROR) << "Downgrade package must have a pre-build version set, not allowed.";
Tao Bao36c72762019-04-30 00:25:41 -0700178 return false;
Tao Baoefc35592017-01-08 22:45:47 -0800179 }
180 }
181
Tao Bao36c72762019-04-30 00:25:41 -0700182 return true;
Alex Deymo4344d632016-08-03 21:03:53 -0700183}
184
Tao Bao36c72762019-04-30 00:25:41 -0700185bool CheckPackageMetadata(const std::map<std::string, std::string>& metadata, OtaType ota_type) {
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700186 auto package_ota_type = get_value(metadata, "ota-type");
187 auto expected_ota_type = OtaTypeToString(ota_type);
188 if (ota_type != OtaType::AB && ota_type != OtaType::BRICK) {
189 LOG(INFO) << "Skip package metadata check for ota type " << expected_ota_type;
Tao Bao36c72762019-04-30 00:25:41 -0700190 return true;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700191 }
192
193 if (package_ota_type != expected_ota_type) {
194 LOG(ERROR) << "Unexpected ota package type, expects " << expected_ota_type << ", actual "
195 << package_ota_type;
Tao Bao36c72762019-04-30 00:25:41 -0700196 return false;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700197 }
198
199 auto device = android::base::GetProperty("ro.product.device", "");
200 auto pkg_device = get_value(metadata, "pre-device");
201 if (pkg_device != device || pkg_device.empty()) {
202 LOG(ERROR) << "Package is for product " << pkg_device << " but expected " << device;
Tao Bao36c72762019-04-30 00:25:41 -0700203 return false;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700204 }
205
206 // We allow the package to not have any serialno; and we also allow it to carry multiple serial
207 // numbers split by "|"; e.g. serialno=serialno1|serialno2|serialno3 ... We will fail the
208 // verification if the device's serialno doesn't match any of these carried numbers.
209 auto pkg_serial_no = get_value(metadata, "serialno");
210 if (!pkg_serial_no.empty()) {
211 auto device_serial_no = android::base::GetProperty("ro.serialno", "");
212 bool serial_number_match = false;
213 for (const auto& number : android::base::Split(pkg_serial_no, "|")) {
214 if (device_serial_no == android::base::Trim(number)) {
215 serial_number_match = true;
216 }
217 }
218 if (!serial_number_match) {
219 LOG(ERROR) << "Package is for serial " << pkg_serial_no;
Tao Bao36c72762019-04-30 00:25:41 -0700220 return false;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700221 }
222 }
223
224 if (ota_type == OtaType::AB) {
225 return CheckAbSpecificMetadata(metadata);
226 }
227
Tao Bao36c72762019-04-30 00:25:41 -0700228 return true;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700229}
230
Tao Bao36c72762019-04-30 00:25:41 -0700231bool SetUpAbUpdateCommands(const std::string& package, ZipArchiveHandle zip, int status_fd,
232 std::vector<std::string>* cmd) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700233 CHECK(cmd != nullptr);
Alex Deymo4344d632016-08-03 21:03:53 -0700234
Tao Baobc4b1fe2017-04-17 16:46:05 -0700235 // For A/B updates we extract the payload properties to a buffer and obtain the RAW payload offset
236 // in the zip file.
237 static constexpr const char* AB_OTA_PAYLOAD_PROPERTIES = "payload_properties.txt";
Tao Baobc4b1fe2017-04-17 16:46:05 -0700238 ZipEntry properties_entry;
Elliott Hughesa86dddb2019-05-03 22:52:37 -0700239 if (FindEntry(zip, AB_OTA_PAYLOAD_PROPERTIES, &properties_entry) != 0) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700240 LOG(ERROR) << "Failed to find " << AB_OTA_PAYLOAD_PROPERTIES;
Tao Bao36c72762019-04-30 00:25:41 -0700241 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700242 }
243 uint32_t properties_entry_length = properties_entry.uncompressed_length;
244 std::vector<uint8_t> payload_properties(properties_entry_length);
245 int32_t err =
246 ExtractToMemory(zip, &properties_entry, payload_properties.data(), properties_entry_length);
247 if (err != 0) {
248 LOG(ERROR) << "Failed to extract " << AB_OTA_PAYLOAD_PROPERTIES << ": " << ErrorCodeString(err);
Tao Bao36c72762019-04-30 00:25:41 -0700249 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700250 }
Alex Deymo4344d632016-08-03 21:03:53 -0700251
Tao Baobc4b1fe2017-04-17 16:46:05 -0700252 static constexpr const char* AB_OTA_PAYLOAD = "payload.bin";
Tao Baobc4b1fe2017-04-17 16:46:05 -0700253 ZipEntry payload_entry;
Elliott Hughesa86dddb2019-05-03 22:52:37 -0700254 if (FindEntry(zip, AB_OTA_PAYLOAD, &payload_entry) != 0) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700255 LOG(ERROR) << "Failed to find " << AB_OTA_PAYLOAD;
Tao Bao36c72762019-04-30 00:25:41 -0700256 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700257 }
258 long payload_offset = payload_entry.offset;
259 *cmd = {
Tao Bao2cc9bbb2018-08-14 12:34:46 -0700260 "/system/bin/update_engine_sideload",
Tao Bao00d57572017-05-02 15:48:54 -0700261 "--payload=file://" + package,
Tao Baobc4b1fe2017-04-17 16:46:05 -0700262 android::base::StringPrintf("--offset=%ld", payload_offset),
263 "--headers=" + std::string(payload_properties.begin(), payload_properties.end()),
264 android::base::StringPrintf("--status_fd=%d", status_fd),
265 };
Tao Bao36c72762019-04-30 00:25:41 -0700266 return true;
Alex Deymo4344d632016-08-03 21:03:53 -0700267}
268
Tao Bao36c72762019-04-30 00:25:41 -0700269bool SetUpNonAbUpdateCommands(const std::string& package, ZipArchiveHandle zip, int retry_count,
270 int status_fd, std::vector<std::string>* cmd) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700271 CHECK(cmd != nullptr);
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700272
Tao Baocf60a442018-06-18 14:56:20 -0700273 // In non-A/B updates we extract the update binary from the package.
Tao Baobc4b1fe2017-04-17 16:46:05 -0700274 static constexpr const char* UPDATE_BINARY_NAME = "META-INF/com/google/android/update-binary";
Tao Baobc4b1fe2017-04-17 16:46:05 -0700275 ZipEntry binary_entry;
Elliott Hughesa86dddb2019-05-03 22:52:37 -0700276 if (FindEntry(zip, UPDATE_BINARY_NAME, &binary_entry) != 0) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700277 LOG(ERROR) << "Failed to find update binary " << UPDATE_BINARY_NAME;
Tao Bao36c72762019-04-30 00:25:41 -0700278 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700279 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700280
Tao Baocf60a442018-06-18 14:56:20 -0700281 const std::string binary_path = Paths::Get().temporary_update_binary();
Tao Bao00d57572017-05-02 15:48:54 -0700282 unlink(binary_path.c_str());
Tao Baocf60a442018-06-18 14:56:20 -0700283 android::base::unique_fd fd(
284 open(binary_path.c_str(), O_CREAT | O_WRONLY | O_TRUNC | O_CLOEXEC, 0755));
Tao Baobc4b1fe2017-04-17 16:46:05 -0700285 if (fd == -1) {
Tao Bao00d57572017-05-02 15:48:54 -0700286 PLOG(ERROR) << "Failed to create " << binary_path;
Tao Bao36c72762019-04-30 00:25:41 -0700287 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700288 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700289
Tao Bao36c72762019-04-30 00:25:41 -0700290 if (auto error = ExtractEntryToFile(zip, &binary_entry, fd); error != 0) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700291 LOG(ERROR) << "Failed to extract " << UPDATE_BINARY_NAME << ": " << ErrorCodeString(error);
Tao Bao36c72762019-04-30 00:25:41 -0700292 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700293 }
294
Tao Bao6fcd2082019-01-16 09:29:17 -0800295 // When executing the update binary contained in the package, the arguments passed are:
296 // - the version number for this interface
297 // - an FD to which the program can write in order to update the progress bar.
298 // - the name of the package zip file.
299 // - an optional argument "retry" if this update is a retry of a failed update attempt.
Tao Baobc4b1fe2017-04-17 16:46:05 -0700300 *cmd = {
Tao Bao00d57572017-05-02 15:48:54 -0700301 binary_path,
Tao Baobd0ddcd2017-05-04 13:03:18 -0700302 std::to_string(kRecoveryApiVersion),
Tao Baobc4b1fe2017-04-17 16:46:05 -0700303 std::to_string(status_fd),
Tao Bao00d57572017-05-02 15:48:54 -0700304 package,
Tao Baobc4b1fe2017-04-17 16:46:05 -0700305 };
306 if (retry_count > 0) {
307 cmd->push_back("retry");
308 }
Tao Bao36c72762019-04-30 00:25:41 -0700309 return true;
Alex Deymo4344d632016-08-03 21:03:53 -0700310}
Alex Deymo4344d632016-08-03 21:03:53 -0700311
Tianjie Xu37957102017-06-07 17:59:55 -0700312static void log_max_temperature(int* max_temperature, const std::atomic<bool>& logger_finished) {
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700313 CHECK(max_temperature != nullptr);
314 std::mutex mtx;
315 std::unique_lock<std::mutex> lck(mtx);
Tianjie Xu37957102017-06-07 17:59:55 -0700316 while (!logger_finished.load() &&
317 finish_log_temperature.wait_for(lck, 20s) == std::cv_status::timeout) {
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700318 *max_temperature = std::max(*max_temperature, GetMaxValueFromThermalZone());
319 }
320}
321
Alex Deymo4344d632016-08-03 21:03:53 -0700322// If the package contains an update binary, extract it and run it.
Tianjie Xu980f92e2019-06-11 15:43:43 -0700323static InstallResult TryUpdateBinary(Package* package, bool* wipe_cache,
324 std::vector<std::string>* log_buffer, int retry_count,
325 int* max_temperature, RecoveryUI* ui) {
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700326 std::map<std::string, std::string> metadata;
Tianjie Xu980f92e2019-06-11 15:43:43 -0700327 auto zip = package->GetZipArchiveHandle();
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700328 if (!ReadMetadataFromPackage(zip, &metadata)) {
329 LOG(ERROR) << "Failed to parse metadata in the zip file";
330 return INSTALL_CORRUPT;
331 }
332
Yifan Hongf2af5622020-04-27 20:16:18 -0700333 bool package_is_ab = get_value(metadata, "ota-type") == OtaTypeToString(OtaType::AB);
334 bool device_supports_ab = android::base::GetBoolProperty("ro.build.ab_update", false);
335 bool ab_device_supports_nonab =
336 android::base::GetBoolProperty("ro.virtual_ab.allow_non_ab", false);
337 bool device_only_supports_ab = device_supports_ab && !ab_device_supports_nonab;
338
339 if (package_is_ab) {
Tianjie Xu980f92e2019-06-11 15:43:43 -0700340 CHECK(package->GetType() == PackageType::kFile);
341 }
342
Yifan Hongf2af5622020-04-27 20:16:18 -0700343 // Verify against the metadata in the package first. Expects A/B metadata if:
344 // Package declares itself as an A/B package
345 // Package does not declare itself as an A/B package, but device only supports A/B;
346 // still calls CheckPackageMetadata to get a meaningful error message.
347 if (package_is_ab || device_only_supports_ab) {
348 if (!CheckPackageMetadata(metadata, OtaType::AB)) {
349 log_buffer->push_back(android::base::StringPrintf("error: %d", kUpdateBinaryCommandFailure));
350 return INSTALL_ERROR;
351 }
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700352 }
353
354 ReadSourceTargetBuild(metadata, log_buffer);
Alex Deymo4344d632016-08-03 21:03:53 -0700355
Tao Bao6fcd2082019-01-16 09:29:17 -0800356 // The updater in child process writes to the pipe to communicate with recovery.
357 android::base::unique_fd pipe_read, pipe_write;
Bill Peckham08ba1ad2019-03-28 18:42:13 -0700358 // Explicitly disable O_CLOEXEC using 0 as the flags (last) parameter to Pipe
359 // so that the child updater process will recieve a non-closed fd.
360 if (!android::base::Pipe(&pipe_read, &pipe_write, 0)) {
Tao Bao6fcd2082019-01-16 09:29:17 -0800361 PLOG(ERROR) << "Failed to create pipe for updater-recovery communication";
362 return INSTALL_CORRUPT;
363 }
364
365 // The updater-recovery communication protocol.
366 //
367 // progress <frac> <secs>
368 // fill up the next <frac> part of of the progress bar over <secs> seconds. If <secs> is
369 // zero, use `set_progress` commands to manually control the progress of this segment of the
370 // bar.
371 //
372 // set_progress <frac>
373 // <frac> should be between 0.0 and 1.0; sets the progress bar within the segment defined by
374 // the most recent progress command.
375 //
376 // ui_print <string>
377 // display <string> on the screen.
378 //
379 // wipe_cache
380 // a wipe of cache will be performed following a successful installation.
381 //
382 // clear_display
383 // turn off the text display.
384 //
385 // enable_reboot
386 // packages can explicitly request that they want the user to be able to reboot during
387 // installation (useful for debugging packages that don't exit).
388 //
389 // retry_update
390 // updater encounters some issue during the update. It requests a reboot to retry the same
391 // package automatically.
392 //
393 // log <string>
394 // updater requests logging the string (e.g. cause of the failure).
395 //
396
Tianjie Xu980f92e2019-06-11 15:43:43 -0700397 std::string package_path = package->GetPath();
398
Tao Bao20c581e2016-12-28 20:55:51 -0800399 std::vector<std::string> args;
Tao Bao36c72762019-04-30 00:25:41 -0700400 if (auto setup_result =
Yifan Hongf2af5622020-04-27 20:16:18 -0700401 package_is_ab
402 ? SetUpAbUpdateCommands(package_path, zip, pipe_write.get(), &args)
403 : SetUpNonAbUpdateCommands(package_path, zip, retry_count, pipe_write.get(), &args);
Tao Bao36c72762019-04-30 00:25:41 -0700404 !setup_result) {
Tianjie Xu3fec8c62017-08-23 00:18:07 -0700405 log_buffer->push_back(android::base::StringPrintf("error: %d", kUpdateBinaryCommandFailure));
Tao Bao36c72762019-04-30 00:25:41 -0700406 return INSTALL_CORRUPT;
Tao Bao20c581e2016-12-28 20:55:51 -0800407 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700408
Tao Bao20c581e2016-12-28 20:55:51 -0800409 pid_t pid = fork();
Tao Bao20c581e2016-12-28 20:55:51 -0800410 if (pid == -1) {
Tao Bao20c581e2016-12-28 20:55:51 -0800411 PLOG(ERROR) << "Failed to fork update binary";
Tianjie Xu3fec8c62017-08-23 00:18:07 -0700412 log_buffer->push_back(android::base::StringPrintf("error: %d", kForkUpdateBinaryFailure));
Tao Bao20c581e2016-12-28 20:55:51 -0800413 return INSTALL_ERROR;
414 }
415
416 if (pid == 0) {
417 umask(022);
Tao Bao6fcd2082019-01-16 09:29:17 -0800418 pipe_read.reset();
419
420 // Convert the std::string vector to a NULL-terminated char* vector suitable for execv.
421 auto chr_args = StringVectorToNullTerminatedArray(args);
Tao Bao3d69f0d2018-12-20 09:44:06 -0800422 execv(chr_args[0], chr_args.data());
Tao Bao6fcd2082019-01-16 09:29:17 -0800423 // We shouldn't use LOG/PLOG in the forked process, since they may cause the child process to
424 // hang. This deadlock results from an improperly copied mutex in the ui functions.
425 // (Bug: 34769056)
Tianjie Xuab1abae2017-01-30 16:48:52 -0800426 fprintf(stdout, "E:Can't run %s (%s)\n", chr_args[0], strerror(errno));
Tao Bao3da88012017-02-03 13:09:23 -0800427 _exit(EXIT_FAILURE);
Tao Bao20c581e2016-12-28 20:55:51 -0800428 }
Tao Bao6fcd2082019-01-16 09:29:17 -0800429 pipe_write.reset();
Tao Bao20c581e2016-12-28 20:55:51 -0800430
Tianjie Xu37957102017-06-07 17:59:55 -0700431 std::atomic<bool> logger_finished(false);
432 std::thread temperature_logger(log_max_temperature, max_temperature, std::ref(logger_finished));
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700433
Tao Bao20c581e2016-12-28 20:55:51 -0800434 *wipe_cache = false;
435 bool retry_update = false;
436
437 char buffer[1024];
Tao Bao6fcd2082019-01-16 09:29:17 -0800438 FILE* from_child = android::base::Fdopen(std::move(pipe_read), "r");
Tao Bao20c581e2016-12-28 20:55:51 -0800439 while (fgets(buffer, sizeof(buffer), from_child) != nullptr) {
440 std::string line(buffer);
441 size_t space = line.find_first_of(" \n");
442 std::string command(line.substr(0, space));
443 if (command.empty()) continue;
444
445 // Get rid of the leading and trailing space and/or newline.
446 std::string args = space == std::string::npos ? "" : android::base::Trim(line.substr(space));
447
448 if (command == "progress") {
449 std::vector<std::string> tokens = android::base::Split(args, " ");
450 double fraction;
451 int seconds;
452 if (tokens.size() == 2 && android::base::ParseDouble(tokens[0].c_str(), &fraction) &&
453 android::base::ParseInt(tokens[1], &seconds)) {
454 ui->ShowProgress(fraction * (1 - VERIFICATION_PROGRESS_FRACTION), seconds);
455 } else {
456 LOG(ERROR) << "invalid \"progress\" parameters: " << line;
457 }
458 } else if (command == "set_progress") {
459 std::vector<std::string> tokens = android::base::Split(args, " ");
460 double fraction;
461 if (tokens.size() == 1 && android::base::ParseDouble(tokens[0].c_str(), &fraction)) {
462 ui->SetProgress(fraction);
463 } else {
464 LOG(ERROR) << "invalid \"set_progress\" parameters: " << line;
465 }
466 } else if (command == "ui_print") {
Tao Baof0136422017-01-21 13:03:25 -0800467 ui->PrintOnScreenOnly("%s\n", args.c_str());
Tao Bao20c581e2016-12-28 20:55:51 -0800468 fflush(stdout);
469 } else if (command == "wipe_cache") {
470 *wipe_cache = true;
471 } else if (command == "clear_display") {
472 ui->SetBackground(RecoveryUI::NONE);
473 } else if (command == "enable_reboot") {
474 // packages can explicitly request that they want the user
475 // to be able to reboot during installation (useful for
476 // debugging packages that don't exit).
477 ui->SetEnableReboot(true);
478 } else if (command == "retry_update") {
479 retry_update = true;
480 } else if (command == "log") {
481 if (!args.empty()) {
482 // Save the logging request from updater and write to last_install later.
Tao Bao29ee69b2017-05-01 12:23:17 -0700483 log_buffer->push_back(args);
Tao Bao20c581e2016-12-28 20:55:51 -0800484 } else {
485 LOG(ERROR) << "invalid \"log\" parameters: " << line;
486 }
487 } else {
488 LOG(ERROR) << "unknown command [" << command << "]";
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700489 }
Tao Bao20c581e2016-12-28 20:55:51 -0800490 }
491 fclose(from_child);
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700492
Tao Bao20c581e2016-12-28 20:55:51 -0800493 int status;
494 waitpid(pid, &status, 0);
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700495
Tianjie Xu37957102017-06-07 17:59:55 -0700496 logger_finished.store(true);
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700497 finish_log_temperature.notify_one();
498 temperature_logger.join();
499
Tao Bao20c581e2016-12-28 20:55:51 -0800500 if (retry_update) {
501 return INSTALL_RETRY;
502 }
Tao Baoe7b775c2018-11-07 15:13:30 -0800503 if (WIFEXITED(status)) {
504 if (WEXITSTATUS(status) != EXIT_SUCCESS) {
Tianjie Xu980f92e2019-06-11 15:43:43 -0700505 LOG(ERROR) << "Error in " << package_path << " (status " << WEXITSTATUS(status) << ")";
Tao Baoe7b775c2018-11-07 15:13:30 -0800506 return INSTALL_ERROR;
507 }
508 } else if (WIFSIGNALED(status)) {
Tianjie Xu980f92e2019-06-11 15:43:43 -0700509 LOG(ERROR) << "Error in " << package_path << " (killed by signal " << WTERMSIG(status) << ")";
Tao Bao20c581e2016-12-28 20:55:51 -0800510 return INSTALL_ERROR;
Tao Baoe7b775c2018-11-07 15:13:30 -0800511 } else {
512 LOG(FATAL) << "Invalid status code " << status;
Tao Bao20c581e2016-12-28 20:55:51 -0800513 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700514
Tao Bao20c581e2016-12-28 20:55:51 -0800515 return INSTALL_SUCCESS;
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700516}
517
Tianjie Xu980f92e2019-06-11 15:43:43 -0700518static InstallResult VerifyAndInstallPackage(Package* package, bool* wipe_cache,
519 std::vector<std::string>* log_buffer, int retry_count,
520 int* max_temperature, RecoveryUI* ui) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700521 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
Tao Bao29ee69b2017-05-01 12:23:17 -0700522 // Give verification half the progress bar...
523 ui->SetProgressType(RecoveryUI::DETERMINATE);
524 ui->ShowProgress(VERIFICATION_PROGRESS_FRACTION, VERIFICATION_PROGRESS_TIME);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800525
Tao Bao29ee69b2017-05-01 12:23:17 -0700526 // Verify package.
Tianjie Xu980f92e2019-06-11 15:43:43 -0700527 if (!verify_package(package, ui)) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700528 log_buffer->push_back(android::base::StringPrintf("error: %d", kZipVerificationFailure));
Tao Bao29ee69b2017-05-01 12:23:17 -0700529 return INSTALL_CORRUPT;
530 }
Doug Zongker60151a22009-08-12 18:30:03 -0700531
Tao Bao29ee69b2017-05-01 12:23:17 -0700532 // Verify and install the contents of the package.
533 ui->Print("Installing update...\n");
534 if (retry_count > 0) {
535 ui->Print("Retry attempt: %d\n", retry_count);
536 }
537 ui->SetEnableReboot(false);
Tianjie Xu980f92e2019-06-11 15:43:43 -0700538 auto result = TryUpdateBinary(package, wipe_cache, log_buffer, retry_count, max_temperature, ui);
Tao Bao29ee69b2017-05-01 12:23:17 -0700539 ui->SetEnableReboot(true);
540 ui->Print("\n");
541
Tao Bao29ee69b2017-05-01 12:23:17 -0700542 return result;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800543}
Doug Zongker469243e2011-04-12 09:28:10 -0700544
Tianjie Xu980f92e2019-06-11 15:43:43 -0700545InstallResult InstallPackage(Package* package, const std::string_view package_id,
546 bool should_wipe_cache, int retry_count, RecoveryUI* ui) {
Tao Baof8119fb2017-04-18 21:35:12 -0700547 auto start = std::chrono::system_clock::now();
Tao Bao682c34b2015-04-07 17:16:35 -0700548
Tao Baof8119fb2017-04-18 21:35:12 -0700549 int start_temperature = GetMaxValueFromThermalZone();
550 int max_temperature = start_temperature;
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700551
Tao Baoadc99ef2019-04-29 23:48:02 -0700552 InstallResult result;
Tao Baof8119fb2017-04-18 21:35:12 -0700553 std::vector<std::string> log_buffer;
Tianjie Xu980f92e2019-06-11 15:43:43 -0700554
Tianjie Xu164c60a2019-05-15 13:59:39 -0700555 ui->Print("Supported API: %d\n", kRecoveryApiVersion);
556
Tianjie Xu980f92e2019-06-11 15:43:43 -0700557 ui->Print("Finding update package...\n");
558 LOG(INFO) << "Update package id: " << package_id;
559 if (!package) {
560 log_buffer.push_back(android::base::StringPrintf("error: %d", kMapFileFailure));
561 result = INSTALL_CORRUPT;
562 } else if (setup_install_mounts() != 0) {
Tao Baof8119fb2017-04-18 21:35:12 -0700563 LOG(ERROR) << "failed to set up expected mounts for install; aborting";
564 result = INSTALL_ERROR;
565 } else {
xunchang316e9712019-04-12 16:22:15 -0700566 bool updater_wipe_cache = false;
Tianjie Xu980f92e2019-06-11 15:43:43 -0700567 result = VerifyAndInstallPackage(package, &updater_wipe_cache, &log_buffer, retry_count,
568 &max_temperature, ui);
xunchang316e9712019-04-12 16:22:15 -0700569 should_wipe_cache = should_wipe_cache || updater_wipe_cache;
Tao Baof8119fb2017-04-18 21:35:12 -0700570 }
571
572 // Measure the time spent to apply OTA update in seconds.
573 std::chrono::duration<double> duration = std::chrono::system_clock::now() - start;
574 int time_total = static_cast<int>(duration.count());
575
Tao Bao3e18f2b2017-09-29 17:11:13 -0700576 bool has_cache = volume_for_mount_point("/cache") != nullptr;
Tao Baof8119fb2017-04-18 21:35:12 -0700577 // Skip logging the uncrypt_status on devices without /cache.
578 if (has_cache) {
579 static constexpr const char* UNCRYPT_STATUS = "/cache/recovery/uncrypt_status";
580 if (ensure_path_mounted(UNCRYPT_STATUS) != 0) {
581 LOG(WARNING) << "Can't mount " << UNCRYPT_STATUS;
Doug Zongker239ac6a2013-08-20 16:03:25 -0700582 } else {
Tao Baof8119fb2017-04-18 21:35:12 -0700583 std::string uncrypt_status;
584 if (!android::base::ReadFileToString(UNCRYPT_STATUS, &uncrypt_status)) {
585 PLOG(WARNING) << "failed to read uncrypt status";
586 } else if (!android::base::StartsWith(uncrypt_status, "uncrypt_")) {
587 LOG(WARNING) << "corrupted uncrypt_status: " << uncrypt_status;
Tianjie Xua2867782017-03-24 14:13:56 -0700588 } else {
Tao Baof8119fb2017-04-18 21:35:12 -0700589 log_buffer.push_back(android::base::Trim(uncrypt_status));
Tianjie Xua2867782017-03-24 14:13:56 -0700590 }
Doug Zongker469243e2011-04-12 09:28:10 -0700591 }
Tao Baof8119fb2017-04-18 21:35:12 -0700592 }
Tao Baobadaac42016-09-26 11:39:14 -0700593
Tao Baof8119fb2017-04-18 21:35:12 -0700594 // The first two lines need to be the package name and install result.
595 std::vector<std::string> log_header = {
Tianjie Xu980f92e2019-06-11 15:43:43 -0700596 std::string(package_id),
Tao Baof8119fb2017-04-18 21:35:12 -0700597 result == INSTALL_SUCCESS ? "1" : "0",
598 "time_total: " + std::to_string(time_total),
599 "retry: " + std::to_string(retry_count),
600 };
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700601
Tao Baof8119fb2017-04-18 21:35:12 -0700602 int end_temperature = GetMaxValueFromThermalZone();
603 max_temperature = std::max(end_temperature, max_temperature);
604 if (start_temperature > 0) {
605 log_buffer.push_back("temperature_start: " + std::to_string(start_temperature));
606 }
607 if (end_temperature > 0) {
608 log_buffer.push_back("temperature_end: " + std::to_string(end_temperature));
609 }
610 if (max_temperature > 0) {
611 log_buffer.push_back("temperature_max: " + std::to_string(max_temperature));
612 }
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700613
Tao Baof8119fb2017-04-18 21:35:12 -0700614 std::string log_content =
615 android::base::Join(log_header, "\n") + "\n" + android::base::Join(log_buffer, "\n") + "\n";
Tao Bao641fa972018-04-25 18:59:40 -0700616 const std::string& install_file = Paths::Get().temporary_install_file();
Tao Baof8119fb2017-04-18 21:35:12 -0700617 if (!android::base::WriteStringToFile(log_content, install_file)) {
618 PLOG(ERROR) << "failed to write " << install_file;
619 }
Tao Baobadaac42016-09-26 11:39:14 -0700620
Tao Baof8119fb2017-04-18 21:35:12 -0700621 // Write a copy into last_log.
622 LOG(INFO) << log_content;
Tao Baobadaac42016-09-26 11:39:14 -0700623
xunchang316e9712019-04-12 16:22:15 -0700624 if (result == INSTALL_SUCCESS && should_wipe_cache) {
625 if (!WipeCache(ui, nullptr)) {
626 result = INSTALL_ERROR;
627 }
628 }
629
Tao Baof8119fb2017-04-18 21:35:12 -0700630 return result;
Doug Zongker469243e2011-04-12 09:28:10 -0700631}
Yabin Cui6faf0262016-06-09 14:09:39 -0700632
xunchang24788852019-03-22 16:08:52 -0700633bool verify_package(Package* package, RecoveryUI* ui) {
Tianjie Xue1d02fb2018-10-19 15:52:17 -0700634 static constexpr const char* CERTIFICATE_ZIP_FILE = "/system/etc/security/otacerts.zip";
635 std::vector<Certificate> loaded_keys = LoadKeysFromZipfile(CERTIFICATE_ZIP_FILE);
636 if (loaded_keys.empty()) {
Tao Bao5e535012017-03-16 17:37:38 -0700637 LOG(ERROR) << "Failed to load keys";
638 return false;
639 }
Tianjie Xue1d02fb2018-10-19 15:52:17 -0700640 LOG(INFO) << loaded_keys.size() << " key(s) loaded from " << CERTIFICATE_ZIP_FILE;
Yabin Cui6faf0262016-06-09 14:09:39 -0700641
Tao Bao5e535012017-03-16 17:37:38 -0700642 // Verify package.
643 ui->Print("Verifying update package...\n");
644 auto t0 = std::chrono::system_clock::now();
xunchangf07ed2e2019-02-25 14:14:01 -0800645 int err = verify_file(package, loaded_keys);
Tao Bao5e535012017-03-16 17:37:38 -0700646 std::chrono::duration<double> duration = std::chrono::system_clock::now() - t0;
647 ui->Print("Update package verification took %.1f s (result %d).\n", duration.count(), err);
648 if (err != VERIFY_SUCCESS) {
649 LOG(ERROR) << "Signature verification failed";
650 LOG(ERROR) << "error: " << kZipVerificationFailure;
651 return false;
652 }
653 return true;
Yabin Cui6faf0262016-06-09 14:09:39 -0700654}