blob: 1c711f6b3bc0bf016bc443337f191b628ce0e174 [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;
Kelvin Zhange1ae78c2020-06-26 11:06:00 -040070// The charater used to separate dynamic fingerprints. e.x. sargo|aosp-sargo
71static const char* FINGERPRING_SEPARATOR = "|";
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070072static std::condition_variable finish_log_temperature;
Kelvin Zhange1ae78c2020-06-26 11:06:00 -040073static bool isInStringList(const std::string& target_token, const std::string& str_list,
74 const std::string& deliminator);
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070075
Tianjie Xu93b5bf22018-10-25 10:39:01 -070076bool ReadMetadataFromPackage(ZipArchiveHandle zip, std::map<std::string, std::string>* metadata) {
Tao Bao8a7afcc2017-04-18 22:05:50 -070077 CHECK(metadata != nullptr);
Tianjie Xub0ddae52016-06-08 14:30:04 -070078
Tao Bao8a7afcc2017-04-18 22:05:50 -070079 static constexpr const char* METADATA_PATH = "META-INF/com/android/metadata";
Tao Bao8a7afcc2017-04-18 22:05:50 -070080 ZipEntry entry;
Elliott Hughesa86dddb2019-05-03 22:52:37 -070081 if (FindEntry(zip, METADATA_PATH, &entry) != 0) {
Tao Bao8a7afcc2017-04-18 22:05:50 -070082 LOG(ERROR) << "Failed to find " << METADATA_PATH;
83 return false;
84 }
85
86 uint32_t length = entry.uncompressed_length;
Tianjie Xu93b5bf22018-10-25 10:39:01 -070087 std::string metadata_string(length, '\0');
88 int32_t err =
89 ExtractToMemory(zip, &entry, reinterpret_cast<uint8_t*>(&metadata_string[0]), length);
Tao Bao8a7afcc2017-04-18 22:05:50 -070090 if (err != 0) {
91 LOG(ERROR) << "Failed to extract " << METADATA_PATH << ": " << ErrorCodeString(err);
92 return false;
93 }
Tianjie Xu93b5bf22018-10-25 10:39:01 -070094
95 for (const std::string& line : android::base::Split(metadata_string, "\n")) {
96 size_t eq = line.find('=');
97 if (eq != std::string::npos) {
98 metadata->emplace(android::base::Trim(line.substr(0, eq)),
99 android::base::Trim(line.substr(eq + 1)));
100 }
101 }
102
Tao Bao8a7afcc2017-04-18 22:05:50 -0700103 return true;
Yabin Cui6faf0262016-06-09 14:09:39 -0700104}
105
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700106// Gets the value for the given key in |metadata|. Returns an emtpy string if the key isn't
107// present.
108static std::string get_value(const std::map<std::string, std::string>& metadata,
109 const std::string& key) {
110 const auto& it = metadata.find(key);
111 return (it == metadata.end()) ? "" : it->second;
112}
113
114static std::string OtaTypeToString(OtaType type) {
115 switch (type) {
116 case OtaType::AB:
117 return "AB";
118 case OtaType::BLOCK:
119 return "BLOCK";
120 case OtaType::BRICK:
121 return "BRICK";
Tao Bao8a7afcc2017-04-18 22:05:50 -0700122 }
Tianjie Xub0ddae52016-06-08 14:30:04 -0700123}
124
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700125// Read the build.version.incremental of src/tgt from the metadata and log it to last_install.
126static void ReadSourceTargetBuild(const std::map<std::string, std::string>& metadata,
127 std::vector<std::string>* log_buffer) {
128 // Examples of the pre-build and post-build strings in metadata:
129 // pre-build-incremental=2943039
130 // post-build-incremental=2951741
131 auto source_build = get_value(metadata, "pre-build-incremental");
132 if (!source_build.empty()) {
133 log_buffer->push_back("source_build: " + source_build);
134 }
135
136 auto target_build = get_value(metadata, "post-build-incremental");
137 if (!target_build.empty()) {
138 log_buffer->push_back("target_build: " + target_build);
139 }
140}
141
142// Checks the build version, fingerprint and timestamp in the metadata of the A/B package.
143// Downgrading is not allowed unless explicitly enabled in the package and only for
Tao Baocf60a442018-06-18 14:56:20 -0700144// incremental packages.
Tao Bao36c72762019-04-30 00:25:41 -0700145static bool CheckAbSpecificMetadata(const std::map<std::string, std::string>& metadata) {
Tao Baoefc35592017-01-08 22:45:47 -0800146 // Incremental updates should match the current build.
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700147 auto device_pre_build = android::base::GetProperty("ro.build.version.incremental", "");
148 auto pkg_pre_build = get_value(metadata, "pre-build-incremental");
149 if (!pkg_pre_build.empty() && pkg_pre_build != device_pre_build) {
150 LOG(ERROR) << "Package is for source build " << pkg_pre_build << " but expected "
151 << device_pre_build;
Tao Bao36c72762019-04-30 00:25:41 -0700152 return false;
Tao Baoefc35592017-01-08 22:45:47 -0800153 }
Alex Deymo4344d632016-08-03 21:03:53 -0700154
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700155 auto device_fingerprint = android::base::GetProperty("ro.build.fingerprint", "");
156 auto pkg_pre_build_fingerprint = get_value(metadata, "pre-build");
Kelvin Zhange1ae78c2020-06-26 11:06:00 -0400157 if (!pkg_pre_build_fingerprint.empty() &&
158 !isInStringList(device_fingerprint, pkg_pre_build_fingerprint, FINGERPRING_SEPARATOR)) {
Tao Baoefc35592017-01-08 22:45:47 -0800159 LOG(ERROR) << "Package is for source build " << pkg_pre_build_fingerprint << " but expected "
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700160 << device_fingerprint;
Tao Bao36c72762019-04-30 00:25:41 -0700161 return false;
Tao Baoefc35592017-01-08 22:45:47 -0800162 }
Alex Deymo4344d632016-08-03 21:03:53 -0700163
Tao Baoefc35592017-01-08 22:45:47 -0800164 // Check for downgrade version.
165 int64_t build_timestamp =
166 android::base::GetIntProperty("ro.build.date.utc", std::numeric_limits<int64_t>::max());
167 int64_t pkg_post_timestamp = 0;
168 // We allow to full update to the same version we are running, in case there
169 // is a problem with the current copy of that version.
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700170 auto pkg_post_timestamp_string = get_value(metadata, "post-timestamp");
171 if (pkg_post_timestamp_string.empty() ||
172 !android::base::ParseInt(pkg_post_timestamp_string, &pkg_post_timestamp) ||
Tao Baoefc35592017-01-08 22:45:47 -0800173 pkg_post_timestamp < build_timestamp) {
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700174 if (get_value(metadata, "ota-downgrade") != "yes") {
Tao Baoefc35592017-01-08 22:45:47 -0800175 LOG(ERROR) << "Update package is older than the current build, expected a build "
176 "newer than timestamp "
177 << build_timestamp << " but package has timestamp " << pkg_post_timestamp
178 << " and downgrade not allowed.";
Tao Bao36c72762019-04-30 00:25:41 -0700179 return false;
Tao Baoefc35592017-01-08 22:45:47 -0800180 }
181 if (pkg_pre_build_fingerprint.empty()) {
182 LOG(ERROR) << "Downgrade package must have a pre-build version set, not allowed.";
Tao Bao36c72762019-04-30 00:25:41 -0700183 return false;
Tao Baoefc35592017-01-08 22:45:47 -0800184 }
185 }
186
Tao Bao36c72762019-04-30 00:25:41 -0700187 return true;
Alex Deymo4344d632016-08-03 21:03:53 -0700188}
189
Tao Bao36c72762019-04-30 00:25:41 -0700190bool CheckPackageMetadata(const std::map<std::string, std::string>& metadata, OtaType ota_type) {
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700191 auto package_ota_type = get_value(metadata, "ota-type");
192 auto expected_ota_type = OtaTypeToString(ota_type);
193 if (ota_type != OtaType::AB && ota_type != OtaType::BRICK) {
194 LOG(INFO) << "Skip package metadata check for ota type " << expected_ota_type;
Tao Bao36c72762019-04-30 00:25:41 -0700195 return true;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700196 }
197
198 if (package_ota_type != expected_ota_type) {
199 LOG(ERROR) << "Unexpected ota package type, expects " << expected_ota_type << ", actual "
200 << package_ota_type;
Tao Bao36c72762019-04-30 00:25:41 -0700201 return false;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700202 }
203
204 auto device = android::base::GetProperty("ro.product.device", "");
205 auto pkg_device = get_value(metadata, "pre-device");
Kelvin Zhange1ae78c2020-06-26 11:06:00 -0400206 // device name can be a | separated list, so need to check
207 if (pkg_device.empty() || !isInStringList(device, pkg_device, FINGERPRING_SEPARATOR)) {
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700208 LOG(ERROR) << "Package is for product " << pkg_device << " but expected " << device;
Tao Bao36c72762019-04-30 00:25:41 -0700209 return false;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700210 }
211
212 // We allow the package to not have any serialno; and we also allow it to carry multiple serial
213 // numbers split by "|"; e.g. serialno=serialno1|serialno2|serialno3 ... We will fail the
214 // verification if the device's serialno doesn't match any of these carried numbers.
215 auto pkg_serial_no = get_value(metadata, "serialno");
216 if (!pkg_serial_no.empty()) {
217 auto device_serial_no = android::base::GetProperty("ro.serialno", "");
218 bool serial_number_match = false;
219 for (const auto& number : android::base::Split(pkg_serial_no, "|")) {
220 if (device_serial_no == android::base::Trim(number)) {
221 serial_number_match = true;
222 }
223 }
224 if (!serial_number_match) {
225 LOG(ERROR) << "Package is for serial " << pkg_serial_no;
Tao Bao36c72762019-04-30 00:25:41 -0700226 return false;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700227 }
228 }
229
230 if (ota_type == OtaType::AB) {
231 return CheckAbSpecificMetadata(metadata);
232 }
233
Tao Bao36c72762019-04-30 00:25:41 -0700234 return true;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700235}
236
Tao Bao36c72762019-04-30 00:25:41 -0700237bool SetUpAbUpdateCommands(const std::string& package, ZipArchiveHandle zip, int status_fd,
238 std::vector<std::string>* cmd) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700239 CHECK(cmd != nullptr);
Alex Deymo4344d632016-08-03 21:03:53 -0700240
Tao Baobc4b1fe2017-04-17 16:46:05 -0700241 // For A/B updates we extract the payload properties to a buffer and obtain the RAW payload offset
242 // in the zip file.
243 static constexpr const char* AB_OTA_PAYLOAD_PROPERTIES = "payload_properties.txt";
Tao Baobc4b1fe2017-04-17 16:46:05 -0700244 ZipEntry properties_entry;
Elliott Hughesa86dddb2019-05-03 22:52:37 -0700245 if (FindEntry(zip, AB_OTA_PAYLOAD_PROPERTIES, &properties_entry) != 0) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700246 LOG(ERROR) << "Failed to find " << AB_OTA_PAYLOAD_PROPERTIES;
Tao Bao36c72762019-04-30 00:25:41 -0700247 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700248 }
249 uint32_t properties_entry_length = properties_entry.uncompressed_length;
250 std::vector<uint8_t> payload_properties(properties_entry_length);
251 int32_t err =
252 ExtractToMemory(zip, &properties_entry, payload_properties.data(), properties_entry_length);
253 if (err != 0) {
254 LOG(ERROR) << "Failed to extract " << AB_OTA_PAYLOAD_PROPERTIES << ": " << ErrorCodeString(err);
Tao Bao36c72762019-04-30 00:25:41 -0700255 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700256 }
Alex Deymo4344d632016-08-03 21:03:53 -0700257
Tao Baobc4b1fe2017-04-17 16:46:05 -0700258 static constexpr const char* AB_OTA_PAYLOAD = "payload.bin";
Tao Baobc4b1fe2017-04-17 16:46:05 -0700259 ZipEntry payload_entry;
Elliott Hughesa86dddb2019-05-03 22:52:37 -0700260 if (FindEntry(zip, AB_OTA_PAYLOAD, &payload_entry) != 0) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700261 LOG(ERROR) << "Failed to find " << AB_OTA_PAYLOAD;
Tao Bao36c72762019-04-30 00:25:41 -0700262 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700263 }
264 long payload_offset = payload_entry.offset;
265 *cmd = {
Tao Bao2cc9bbb2018-08-14 12:34:46 -0700266 "/system/bin/update_engine_sideload",
Tao Bao00d57572017-05-02 15:48:54 -0700267 "--payload=file://" + package,
Tao Baobc4b1fe2017-04-17 16:46:05 -0700268 android::base::StringPrintf("--offset=%ld", payload_offset),
269 "--headers=" + std::string(payload_properties.begin(), payload_properties.end()),
270 android::base::StringPrintf("--status_fd=%d", status_fd),
271 };
Tao Bao36c72762019-04-30 00:25:41 -0700272 return true;
Alex Deymo4344d632016-08-03 21:03:53 -0700273}
274
Tao Bao36c72762019-04-30 00:25:41 -0700275bool SetUpNonAbUpdateCommands(const std::string& package, ZipArchiveHandle zip, int retry_count,
276 int status_fd, std::vector<std::string>* cmd) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700277 CHECK(cmd != nullptr);
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700278
Tao Baocf60a442018-06-18 14:56:20 -0700279 // In non-A/B updates we extract the update binary from the package.
Tao Baobc4b1fe2017-04-17 16:46:05 -0700280 static constexpr const char* UPDATE_BINARY_NAME = "META-INF/com/google/android/update-binary";
Tao Baobc4b1fe2017-04-17 16:46:05 -0700281 ZipEntry binary_entry;
Elliott Hughesa86dddb2019-05-03 22:52:37 -0700282 if (FindEntry(zip, UPDATE_BINARY_NAME, &binary_entry) != 0) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700283 LOG(ERROR) << "Failed to find update binary " << UPDATE_BINARY_NAME;
Tao Bao36c72762019-04-30 00:25:41 -0700284 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700285 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700286
Tao Baocf60a442018-06-18 14:56:20 -0700287 const std::string binary_path = Paths::Get().temporary_update_binary();
Tao Bao00d57572017-05-02 15:48:54 -0700288 unlink(binary_path.c_str());
Tao Baocf60a442018-06-18 14:56:20 -0700289 android::base::unique_fd fd(
290 open(binary_path.c_str(), O_CREAT | O_WRONLY | O_TRUNC | O_CLOEXEC, 0755));
Tao Baobc4b1fe2017-04-17 16:46:05 -0700291 if (fd == -1) {
Tao Bao00d57572017-05-02 15:48:54 -0700292 PLOG(ERROR) << "Failed to create " << binary_path;
Tao Bao36c72762019-04-30 00:25:41 -0700293 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700294 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700295
Tao Bao36c72762019-04-30 00:25:41 -0700296 if (auto error = ExtractEntryToFile(zip, &binary_entry, fd); error != 0) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700297 LOG(ERROR) << "Failed to extract " << UPDATE_BINARY_NAME << ": " << ErrorCodeString(error);
Tao Bao36c72762019-04-30 00:25:41 -0700298 return false;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700299 }
300
Tao Bao6fcd2082019-01-16 09:29:17 -0800301 // When executing the update binary contained in the package, the arguments passed are:
302 // - the version number for this interface
303 // - an FD to which the program can write in order to update the progress bar.
304 // - the name of the package zip file.
305 // - an optional argument "retry" if this update is a retry of a failed update attempt.
Tao Baobc4b1fe2017-04-17 16:46:05 -0700306 *cmd = {
Tao Bao00d57572017-05-02 15:48:54 -0700307 binary_path,
Tao Baobd0ddcd2017-05-04 13:03:18 -0700308 std::to_string(kRecoveryApiVersion),
Tao Baobc4b1fe2017-04-17 16:46:05 -0700309 std::to_string(status_fd),
Tao Bao00d57572017-05-02 15:48:54 -0700310 package,
Tao Baobc4b1fe2017-04-17 16:46:05 -0700311 };
312 if (retry_count > 0) {
313 cmd->push_back("retry");
314 }
Tao Bao36c72762019-04-30 00:25:41 -0700315 return true;
Alex Deymo4344d632016-08-03 21:03:53 -0700316}
Alex Deymo4344d632016-08-03 21:03:53 -0700317
Tianjie Xu37957102017-06-07 17:59:55 -0700318static void log_max_temperature(int* max_temperature, const std::atomic<bool>& logger_finished) {
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700319 CHECK(max_temperature != nullptr);
320 std::mutex mtx;
321 std::unique_lock<std::mutex> lck(mtx);
Tianjie Xu37957102017-06-07 17:59:55 -0700322 while (!logger_finished.load() &&
323 finish_log_temperature.wait_for(lck, 20s) == std::cv_status::timeout) {
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700324 *max_temperature = std::max(*max_temperature, GetMaxValueFromThermalZone());
325 }
326}
327
Alex Deymo4344d632016-08-03 21:03:53 -0700328// If the package contains an update binary, extract it and run it.
Tianjie Xu980f92e2019-06-11 15:43:43 -0700329static InstallResult TryUpdateBinary(Package* package, bool* wipe_cache,
330 std::vector<std::string>* log_buffer, int retry_count,
331 int* max_temperature, RecoveryUI* ui) {
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700332 std::map<std::string, std::string> metadata;
Tianjie Xu980f92e2019-06-11 15:43:43 -0700333 auto zip = package->GetZipArchiveHandle();
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700334 if (!ReadMetadataFromPackage(zip, &metadata)) {
335 LOG(ERROR) << "Failed to parse metadata in the zip file";
336 return INSTALL_CORRUPT;
337 }
338
Yifan Hongf2af5622020-04-27 20:16:18 -0700339 bool package_is_ab = get_value(metadata, "ota-type") == OtaTypeToString(OtaType::AB);
340 bool device_supports_ab = android::base::GetBoolProperty("ro.build.ab_update", false);
341 bool ab_device_supports_nonab =
342 android::base::GetBoolProperty("ro.virtual_ab.allow_non_ab", false);
343 bool device_only_supports_ab = device_supports_ab && !ab_device_supports_nonab;
344
345 if (package_is_ab) {
Tianjie Xu980f92e2019-06-11 15:43:43 -0700346 CHECK(package->GetType() == PackageType::kFile);
347 }
348
Yifan Hongf2af5622020-04-27 20:16:18 -0700349 // Verify against the metadata in the package first. Expects A/B metadata if:
350 // Package declares itself as an A/B package
351 // Package does not declare itself as an A/B package, but device only supports A/B;
352 // still calls CheckPackageMetadata to get a meaningful error message.
353 if (package_is_ab || device_only_supports_ab) {
354 if (!CheckPackageMetadata(metadata, OtaType::AB)) {
355 log_buffer->push_back(android::base::StringPrintf("error: %d", kUpdateBinaryCommandFailure));
356 return INSTALL_ERROR;
357 }
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700358 }
359
360 ReadSourceTargetBuild(metadata, log_buffer);
Alex Deymo4344d632016-08-03 21:03:53 -0700361
Tao Bao6fcd2082019-01-16 09:29:17 -0800362 // The updater in child process writes to the pipe to communicate with recovery.
363 android::base::unique_fd pipe_read, pipe_write;
Bill Peckham08ba1ad2019-03-28 18:42:13 -0700364 // Explicitly disable O_CLOEXEC using 0 as the flags (last) parameter to Pipe
365 // so that the child updater process will recieve a non-closed fd.
366 if (!android::base::Pipe(&pipe_read, &pipe_write, 0)) {
Tao Bao6fcd2082019-01-16 09:29:17 -0800367 PLOG(ERROR) << "Failed to create pipe for updater-recovery communication";
368 return INSTALL_CORRUPT;
369 }
370
371 // The updater-recovery communication protocol.
372 //
373 // progress <frac> <secs>
374 // fill up the next <frac> part of of the progress bar over <secs> seconds. If <secs> is
375 // zero, use `set_progress` commands to manually control the progress of this segment of the
376 // bar.
377 //
378 // set_progress <frac>
379 // <frac> should be between 0.0 and 1.0; sets the progress bar within the segment defined by
380 // the most recent progress command.
381 //
382 // ui_print <string>
383 // display <string> on the screen.
384 //
385 // wipe_cache
386 // a wipe of cache will be performed following a successful installation.
387 //
388 // clear_display
389 // turn off the text display.
390 //
391 // enable_reboot
392 // packages can explicitly request that they want the user to be able to reboot during
393 // installation (useful for debugging packages that don't exit).
394 //
395 // retry_update
396 // updater encounters some issue during the update. It requests a reboot to retry the same
397 // package automatically.
398 //
399 // log <string>
400 // updater requests logging the string (e.g. cause of the failure).
401 //
402
Tianjie Xu980f92e2019-06-11 15:43:43 -0700403 std::string package_path = package->GetPath();
404
Tao Bao20c581e2016-12-28 20:55:51 -0800405 std::vector<std::string> args;
Tao Bao36c72762019-04-30 00:25:41 -0700406 if (auto setup_result =
Yifan Hongf2af5622020-04-27 20:16:18 -0700407 package_is_ab
408 ? SetUpAbUpdateCommands(package_path, zip, pipe_write.get(), &args)
409 : SetUpNonAbUpdateCommands(package_path, zip, retry_count, pipe_write.get(), &args);
Tao Bao36c72762019-04-30 00:25:41 -0700410 !setup_result) {
Tianjie Xu3fec8c62017-08-23 00:18:07 -0700411 log_buffer->push_back(android::base::StringPrintf("error: %d", kUpdateBinaryCommandFailure));
Tao Bao36c72762019-04-30 00:25:41 -0700412 return INSTALL_CORRUPT;
Tao Bao20c581e2016-12-28 20:55:51 -0800413 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700414
Tao Bao20c581e2016-12-28 20:55:51 -0800415 pid_t pid = fork();
Tao Bao20c581e2016-12-28 20:55:51 -0800416 if (pid == -1) {
Tao Bao20c581e2016-12-28 20:55:51 -0800417 PLOG(ERROR) << "Failed to fork update binary";
Tianjie Xu3fec8c62017-08-23 00:18:07 -0700418 log_buffer->push_back(android::base::StringPrintf("error: %d", kForkUpdateBinaryFailure));
Tao Bao20c581e2016-12-28 20:55:51 -0800419 return INSTALL_ERROR;
420 }
421
422 if (pid == 0) {
423 umask(022);
Tao Bao6fcd2082019-01-16 09:29:17 -0800424 pipe_read.reset();
425
426 // Convert the std::string vector to a NULL-terminated char* vector suitable for execv.
427 auto chr_args = StringVectorToNullTerminatedArray(args);
Tao Bao3d69f0d2018-12-20 09:44:06 -0800428 execv(chr_args[0], chr_args.data());
Tao Bao6fcd2082019-01-16 09:29:17 -0800429 // We shouldn't use LOG/PLOG in the forked process, since they may cause the child process to
430 // hang. This deadlock results from an improperly copied mutex in the ui functions.
431 // (Bug: 34769056)
Tianjie Xuab1abae2017-01-30 16:48:52 -0800432 fprintf(stdout, "E:Can't run %s (%s)\n", chr_args[0], strerror(errno));
Tao Bao3da88012017-02-03 13:09:23 -0800433 _exit(EXIT_FAILURE);
Tao Bao20c581e2016-12-28 20:55:51 -0800434 }
Tao Bao6fcd2082019-01-16 09:29:17 -0800435 pipe_write.reset();
Tao Bao20c581e2016-12-28 20:55:51 -0800436
Tianjie Xu37957102017-06-07 17:59:55 -0700437 std::atomic<bool> logger_finished(false);
438 std::thread temperature_logger(log_max_temperature, max_temperature, std::ref(logger_finished));
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700439
Tao Bao20c581e2016-12-28 20:55:51 -0800440 *wipe_cache = false;
441 bool retry_update = false;
442
443 char buffer[1024];
Tao Bao6fcd2082019-01-16 09:29:17 -0800444 FILE* from_child = android::base::Fdopen(std::move(pipe_read), "r");
Tao Bao20c581e2016-12-28 20:55:51 -0800445 while (fgets(buffer, sizeof(buffer), from_child) != nullptr) {
446 std::string line(buffer);
447 size_t space = line.find_first_of(" \n");
448 std::string command(line.substr(0, space));
449 if (command.empty()) continue;
450
451 // Get rid of the leading and trailing space and/or newline.
452 std::string args = space == std::string::npos ? "" : android::base::Trim(line.substr(space));
453
454 if (command == "progress") {
455 std::vector<std::string> tokens = android::base::Split(args, " ");
456 double fraction;
457 int seconds;
458 if (tokens.size() == 2 && android::base::ParseDouble(tokens[0].c_str(), &fraction) &&
459 android::base::ParseInt(tokens[1], &seconds)) {
460 ui->ShowProgress(fraction * (1 - VERIFICATION_PROGRESS_FRACTION), seconds);
461 } else {
462 LOG(ERROR) << "invalid \"progress\" parameters: " << line;
463 }
464 } else if (command == "set_progress") {
465 std::vector<std::string> tokens = android::base::Split(args, " ");
466 double fraction;
467 if (tokens.size() == 1 && android::base::ParseDouble(tokens[0].c_str(), &fraction)) {
468 ui->SetProgress(fraction);
469 } else {
470 LOG(ERROR) << "invalid \"set_progress\" parameters: " << line;
471 }
472 } else if (command == "ui_print") {
Tao Baof0136422017-01-21 13:03:25 -0800473 ui->PrintOnScreenOnly("%s\n", args.c_str());
Tao Bao20c581e2016-12-28 20:55:51 -0800474 fflush(stdout);
475 } else if (command == "wipe_cache") {
476 *wipe_cache = true;
477 } else if (command == "clear_display") {
478 ui->SetBackground(RecoveryUI::NONE);
479 } else if (command == "enable_reboot") {
480 // packages can explicitly request that they want the user
481 // to be able to reboot during installation (useful for
482 // debugging packages that don't exit).
483 ui->SetEnableReboot(true);
484 } else if (command == "retry_update") {
485 retry_update = true;
486 } else if (command == "log") {
487 if (!args.empty()) {
488 // Save the logging request from updater and write to last_install later.
Tao Bao29ee69b2017-05-01 12:23:17 -0700489 log_buffer->push_back(args);
Tao Bao20c581e2016-12-28 20:55:51 -0800490 } else {
491 LOG(ERROR) << "invalid \"log\" parameters: " << line;
492 }
493 } else {
494 LOG(ERROR) << "unknown command [" << command << "]";
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700495 }
Tao Bao20c581e2016-12-28 20:55:51 -0800496 }
497 fclose(from_child);
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700498
Tao Bao20c581e2016-12-28 20:55:51 -0800499 int status;
500 waitpid(pid, &status, 0);
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700501
Tianjie Xu37957102017-06-07 17:59:55 -0700502 logger_finished.store(true);
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700503 finish_log_temperature.notify_one();
504 temperature_logger.join();
505
Tao Bao20c581e2016-12-28 20:55:51 -0800506 if (retry_update) {
507 return INSTALL_RETRY;
508 }
Tao Baoe7b775c2018-11-07 15:13:30 -0800509 if (WIFEXITED(status)) {
510 if (WEXITSTATUS(status) != EXIT_SUCCESS) {
Tianjie Xu980f92e2019-06-11 15:43:43 -0700511 LOG(ERROR) << "Error in " << package_path << " (status " << WEXITSTATUS(status) << ")";
Tao Baoe7b775c2018-11-07 15:13:30 -0800512 return INSTALL_ERROR;
513 }
514 } else if (WIFSIGNALED(status)) {
Tianjie Xu980f92e2019-06-11 15:43:43 -0700515 LOG(ERROR) << "Error in " << package_path << " (killed by signal " << WTERMSIG(status) << ")";
Tao Bao20c581e2016-12-28 20:55:51 -0800516 return INSTALL_ERROR;
Tao Baoe7b775c2018-11-07 15:13:30 -0800517 } else {
518 LOG(FATAL) << "Invalid status code " << status;
Tao Bao20c581e2016-12-28 20:55:51 -0800519 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700520
Tao Bao20c581e2016-12-28 20:55:51 -0800521 return INSTALL_SUCCESS;
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700522}
523
Tianjie Xu980f92e2019-06-11 15:43:43 -0700524static InstallResult VerifyAndInstallPackage(Package* package, bool* wipe_cache,
525 std::vector<std::string>* log_buffer, int retry_count,
526 int* max_temperature, RecoveryUI* ui) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700527 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
Tao Bao29ee69b2017-05-01 12:23:17 -0700528 // Give verification half the progress bar...
529 ui->SetProgressType(RecoveryUI::DETERMINATE);
530 ui->ShowProgress(VERIFICATION_PROGRESS_FRACTION, VERIFICATION_PROGRESS_TIME);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800531
Tao Bao29ee69b2017-05-01 12:23:17 -0700532 // Verify package.
Tianjie Xu980f92e2019-06-11 15:43:43 -0700533 if (!verify_package(package, ui)) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700534 log_buffer->push_back(android::base::StringPrintf("error: %d", kZipVerificationFailure));
Tao Bao29ee69b2017-05-01 12:23:17 -0700535 return INSTALL_CORRUPT;
536 }
Doug Zongker60151a22009-08-12 18:30:03 -0700537
Tao Bao29ee69b2017-05-01 12:23:17 -0700538 // Verify and install the contents of the package.
539 ui->Print("Installing update...\n");
540 if (retry_count > 0) {
541 ui->Print("Retry attempt: %d\n", retry_count);
542 }
543 ui->SetEnableReboot(false);
Tianjie Xu980f92e2019-06-11 15:43:43 -0700544 auto result = TryUpdateBinary(package, wipe_cache, log_buffer, retry_count, max_temperature, ui);
Tao Bao29ee69b2017-05-01 12:23:17 -0700545 ui->SetEnableReboot(true);
546 ui->Print("\n");
547
Tao Bao29ee69b2017-05-01 12:23:17 -0700548 return result;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800549}
Doug Zongker469243e2011-04-12 09:28:10 -0700550
Tianjie Xu980f92e2019-06-11 15:43:43 -0700551InstallResult InstallPackage(Package* package, const std::string_view package_id,
552 bool should_wipe_cache, int retry_count, RecoveryUI* ui) {
Tao Baof8119fb2017-04-18 21:35:12 -0700553 auto start = std::chrono::system_clock::now();
Tao Bao682c34b2015-04-07 17:16:35 -0700554
Tao Baof8119fb2017-04-18 21:35:12 -0700555 int start_temperature = GetMaxValueFromThermalZone();
556 int max_temperature = start_temperature;
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700557
Tao Baoadc99ef2019-04-29 23:48:02 -0700558 InstallResult result;
Tao Baof8119fb2017-04-18 21:35:12 -0700559 std::vector<std::string> log_buffer;
Tianjie Xu980f92e2019-06-11 15:43:43 -0700560
Tianjie Xu164c60a2019-05-15 13:59:39 -0700561 ui->Print("Supported API: %d\n", kRecoveryApiVersion);
562
Tianjie Xu980f92e2019-06-11 15:43:43 -0700563 ui->Print("Finding update package...\n");
564 LOG(INFO) << "Update package id: " << package_id;
565 if (!package) {
566 log_buffer.push_back(android::base::StringPrintf("error: %d", kMapFileFailure));
567 result = INSTALL_CORRUPT;
568 } else if (setup_install_mounts() != 0) {
Tao Baof8119fb2017-04-18 21:35:12 -0700569 LOG(ERROR) << "failed to set up expected mounts for install; aborting";
570 result = INSTALL_ERROR;
571 } else {
xunchang316e9712019-04-12 16:22:15 -0700572 bool updater_wipe_cache = false;
Tianjie Xu980f92e2019-06-11 15:43:43 -0700573 result = VerifyAndInstallPackage(package, &updater_wipe_cache, &log_buffer, retry_count,
574 &max_temperature, ui);
xunchang316e9712019-04-12 16:22:15 -0700575 should_wipe_cache = should_wipe_cache || updater_wipe_cache;
Tao Baof8119fb2017-04-18 21:35:12 -0700576 }
577
578 // Measure the time spent to apply OTA update in seconds.
579 std::chrono::duration<double> duration = std::chrono::system_clock::now() - start;
580 int time_total = static_cast<int>(duration.count());
581
Tao Bao3e18f2b2017-09-29 17:11:13 -0700582 bool has_cache = volume_for_mount_point("/cache") != nullptr;
Tao Baof8119fb2017-04-18 21:35:12 -0700583 // Skip logging the uncrypt_status on devices without /cache.
584 if (has_cache) {
585 static constexpr const char* UNCRYPT_STATUS = "/cache/recovery/uncrypt_status";
586 if (ensure_path_mounted(UNCRYPT_STATUS) != 0) {
587 LOG(WARNING) << "Can't mount " << UNCRYPT_STATUS;
Doug Zongker239ac6a2013-08-20 16:03:25 -0700588 } else {
Tao Baof8119fb2017-04-18 21:35:12 -0700589 std::string uncrypt_status;
590 if (!android::base::ReadFileToString(UNCRYPT_STATUS, &uncrypt_status)) {
591 PLOG(WARNING) << "failed to read uncrypt status";
592 } else if (!android::base::StartsWith(uncrypt_status, "uncrypt_")) {
593 LOG(WARNING) << "corrupted uncrypt_status: " << uncrypt_status;
Tianjie Xua2867782017-03-24 14:13:56 -0700594 } else {
Tao Baof8119fb2017-04-18 21:35:12 -0700595 log_buffer.push_back(android::base::Trim(uncrypt_status));
Tianjie Xua2867782017-03-24 14:13:56 -0700596 }
Doug Zongker469243e2011-04-12 09:28:10 -0700597 }
Tao Baof8119fb2017-04-18 21:35:12 -0700598 }
Tao Baobadaac42016-09-26 11:39:14 -0700599
Tao Baof8119fb2017-04-18 21:35:12 -0700600 // The first two lines need to be the package name and install result.
601 std::vector<std::string> log_header = {
Tianjie Xu980f92e2019-06-11 15:43:43 -0700602 std::string(package_id),
Tao Baof8119fb2017-04-18 21:35:12 -0700603 result == INSTALL_SUCCESS ? "1" : "0",
604 "time_total: " + std::to_string(time_total),
605 "retry: " + std::to_string(retry_count),
606 };
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700607
Tao Baof8119fb2017-04-18 21:35:12 -0700608 int end_temperature = GetMaxValueFromThermalZone();
609 max_temperature = std::max(end_temperature, max_temperature);
610 if (start_temperature > 0) {
611 log_buffer.push_back("temperature_start: " + std::to_string(start_temperature));
612 }
613 if (end_temperature > 0) {
614 log_buffer.push_back("temperature_end: " + std::to_string(end_temperature));
615 }
616 if (max_temperature > 0) {
617 log_buffer.push_back("temperature_max: " + std::to_string(max_temperature));
618 }
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700619
Tao Baof8119fb2017-04-18 21:35:12 -0700620 std::string log_content =
621 android::base::Join(log_header, "\n") + "\n" + android::base::Join(log_buffer, "\n") + "\n";
Tao Bao641fa972018-04-25 18:59:40 -0700622 const std::string& install_file = Paths::Get().temporary_install_file();
Tao Baof8119fb2017-04-18 21:35:12 -0700623 if (!android::base::WriteStringToFile(log_content, install_file)) {
624 PLOG(ERROR) << "failed to write " << install_file;
625 }
Tao Baobadaac42016-09-26 11:39:14 -0700626
Tao Baof8119fb2017-04-18 21:35:12 -0700627 // Write a copy into last_log.
628 LOG(INFO) << log_content;
Tao Baobadaac42016-09-26 11:39:14 -0700629
xunchang316e9712019-04-12 16:22:15 -0700630 if (result == INSTALL_SUCCESS && should_wipe_cache) {
631 if (!WipeCache(ui, nullptr)) {
632 result = INSTALL_ERROR;
633 }
634 }
635
Tao Baof8119fb2017-04-18 21:35:12 -0700636 return result;
Doug Zongker469243e2011-04-12 09:28:10 -0700637}
Yabin Cui6faf0262016-06-09 14:09:39 -0700638
xunchang24788852019-03-22 16:08:52 -0700639bool verify_package(Package* package, RecoveryUI* ui) {
Tianjie Xue1d02fb2018-10-19 15:52:17 -0700640 static constexpr const char* CERTIFICATE_ZIP_FILE = "/system/etc/security/otacerts.zip";
641 std::vector<Certificate> loaded_keys = LoadKeysFromZipfile(CERTIFICATE_ZIP_FILE);
642 if (loaded_keys.empty()) {
Tao Bao5e535012017-03-16 17:37:38 -0700643 LOG(ERROR) << "Failed to load keys";
644 return false;
645 }
Tianjie Xue1d02fb2018-10-19 15:52:17 -0700646 LOG(INFO) << loaded_keys.size() << " key(s) loaded from " << CERTIFICATE_ZIP_FILE;
Yabin Cui6faf0262016-06-09 14:09:39 -0700647
Tao Bao5e535012017-03-16 17:37:38 -0700648 // Verify package.
649 ui->Print("Verifying update package...\n");
650 auto t0 = std::chrono::system_clock::now();
xunchangf07ed2e2019-02-25 14:14:01 -0800651 int err = verify_file(package, loaded_keys);
Tao Bao5e535012017-03-16 17:37:38 -0700652 std::chrono::duration<double> duration = std::chrono::system_clock::now() - t0;
653 ui->Print("Update package verification took %.1f s (result %d).\n", duration.count(), err);
654 if (err != VERIFY_SUCCESS) {
655 LOG(ERROR) << "Signature verification failed";
656 LOG(ERROR) << "error: " << kZipVerificationFailure;
657 return false;
658 }
659 return true;
Yabin Cui6faf0262016-06-09 14:09:39 -0700660}
Tianjie Xucd8faf72019-08-06 12:32:05 -0700661
662bool SetupPackageMount(const std::string& package_path, bool* should_use_fuse) {
663 CHECK(should_use_fuse != nullptr);
664
665 if (package_path.empty()) {
666 return false;
667 }
668
669 *should_use_fuse = true;
670 if (package_path[0] == '@') {
671 auto block_map_path = package_path.substr(1);
672 if (ensure_path_mounted(block_map_path) != 0) {
673 LOG(ERROR) << "Failed to mount " << block_map_path;
674 return false;
675 }
676 // uncrypt only produces block map only if the package stays on /data.
677 *should_use_fuse = false;
678 return true;
679 }
680
681 // Package is not a block map file.
682 if (ensure_path_mounted(package_path) != 0) {
683 LOG(ERROR) << "Failed to mount " << package_path;
684 return false;
685 }
686
687 // Reject the package if the input path doesn't equal the canonicalized path.
688 // e.g. /cache/../sdcard/update_package.
689 std::error_code ec;
690 auto canonical_path = std::filesystem::canonical(package_path, ec);
691 if (ec) {
692 LOG(ERROR) << "Failed to get canonical of " << package_path << ", " << ec.message();
693 return false;
694 }
695 if (canonical_path.string() != package_path) {
696 LOG(ERROR) << "Installation aborts. The canonical path " << canonical_path.string()
697 << " doesn't equal the original path " << package_path;
698 return false;
699 }
700
701 constexpr const char* CACHE_ROOT = "/cache";
702 if (android::base::StartsWith(package_path, CACHE_ROOT)) {
703 *should_use_fuse = false;
704 }
705 return true;
706}
Kelvin Zhange1ae78c2020-06-26 11:06:00 -0400707
708// Check if `target_token` is in string `str_list`, where `str_list` is expected to be a
709// list delimited by `deliminator`
710// E.X. isInStringList("a", "a|b|c|d", "|") => true
711// E.X. isInStringList("abc", "abc", "|") => true
712static bool isInStringList(const std::string& target_token, const std::string& str_list,
713 const std::string& deliminator) {
714 if (target_token.length() > str_list.length()) {
715 return false;
716 } else if (target_token.length() == str_list.length() || deliminator.length() == 0) {
717 return target_token == str_list;
718 }
719 auto&& list = android::base::Split(str_list, deliminator);
720 return std::find(list.begin(), list.end(), target_token) != list.end();
721}