• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
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 
17 #include "install/install.h"
18 
19 #include <ctype.h>
20 #include <errno.h>
21 #include <fcntl.h>
22 #include <inttypes.h>
23 #include <limits.h>
24 #include <string.h>
25 #include <sys/stat.h>
26 #include <sys/wait.h>
27 #include <unistd.h>
28 
29 #include <algorithm>
30 #include <atomic>
31 #include <chrono>
32 #include <condition_variable>
33 #include <filesystem>
34 #include <functional>
35 #include <limits>
36 #include <mutex>
37 #include <thread>
38 #include <vector>
39 
40 #include <android-base/file.h>
41 #include <android-base/logging.h>
42 #include <android-base/parsedouble.h>
43 #include <android-base/parseint.h>
44 #include <android-base/properties.h>
45 #include <android-base/stringprintf.h>
46 #include <android-base/strings.h>
47 #include <android-base/unique_fd.h>
48 
49 #include "install/package.h"
50 #include "install/verifier.h"
51 #include "install/wipe_data.h"
52 #include "otautil/error_code.h"
53 #include "otautil/paths.h"
54 #include "otautil/sysutil.h"
55 #include "private/setup_commands.h"
56 #include "recovery_ui/ui.h"
57 #include "recovery_utils/roots.h"
58 #include "recovery_utils/thermalutil.h"
59 
60 using namespace std::chrono_literals;
61 
62 static constexpr int kRecoveryApiVersion = 3;
63 // 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.
65 static_assert(kRecoveryApiVersion == RECOVERY_API_VERSION, "Mismatching recovery API versions.");
66 
67 // Default allocation of progress bar segments to operations
68 static constexpr int VERIFICATION_PROGRESS_TIME = 60;
69 static constexpr float VERIFICATION_PROGRESS_FRACTION = 0.25;
70 
71 static std::condition_variable finish_log_temperature;
72 
ReadMetadataFromPackage(ZipArchiveHandle zip,std::map<std::string,std::string> * metadata)73 bool ReadMetadataFromPackage(ZipArchiveHandle zip, std::map<std::string, std::string>* metadata) {
74   CHECK(metadata != nullptr);
75 
76   static constexpr const char* METADATA_PATH = "META-INF/com/android/metadata";
77   ZipEntry entry;
78   if (FindEntry(zip, METADATA_PATH, &entry) != 0) {
79     LOG(ERROR) << "Failed to find " << METADATA_PATH;
80     return false;
81   }
82 
83   uint32_t length = entry.uncompressed_length;
84   std::string metadata_string(length, '\0');
85   int32_t err =
86       ExtractToMemory(zip, &entry, reinterpret_cast<uint8_t*>(&metadata_string[0]), length);
87   if (err != 0) {
88     LOG(ERROR) << "Failed to extract " << METADATA_PATH << ": " << ErrorCodeString(err);
89     return false;
90   }
91 
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 
100   return true;
101 }
102 
103 // Gets the value for the given key in |metadata|. Returns an emtpy string if the key isn't
104 // present.
get_value(const std::map<std::string,std::string> & metadata,const std::string & key)105 static 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 
OtaTypeToString(OtaType type)111 static 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";
119   }
120 }
121 
122 // Read the build.version.incremental of src/tgt from the metadata and log it to last_install.
ReadSourceTargetBuild(const std::map<std::string,std::string> & metadata,std::vector<std::string> * log_buffer)123 static 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
141 // incremental packages.
CheckAbSpecificMetadata(const std::map<std::string,std::string> & metadata)142 static bool CheckAbSpecificMetadata(const std::map<std::string, std::string>& metadata) {
143   // Incremental updates should match the current build.
144   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;
149     return false;
150   }
151 
152   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) {
155     LOG(ERROR) << "Package is for source build " << pkg_pre_build_fingerprint << " but expected "
156                << device_fingerprint;
157     return false;
158   }
159 
160   // 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.
166   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) ||
169       pkg_post_timestamp < build_timestamp) {
170     if (get_value(metadata, "ota-downgrade") != "yes") {
171       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.";
175       return false;
176     }
177     if (pkg_pre_build_fingerprint.empty()) {
178       LOG(ERROR) << "Downgrade package must have a pre-build version set, not allowed.";
179       return false;
180     }
181   }
182 
183   return true;
184 }
185 
CheckPackageMetadata(const std::map<std::string,std::string> & metadata,OtaType ota_type)186 bool CheckPackageMetadata(const std::map<std::string, std::string>& metadata, OtaType ota_type) {
187   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;
191     return true;
192   }
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;
197     return false;
198   }
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;
204     return false;
205   }
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;
221       return false;
222     }
223   }
224 
225   if (ota_type == OtaType::AB) {
226     return CheckAbSpecificMetadata(metadata);
227   }
228 
229   return true;
230 }
231 
SetUpAbUpdateCommands(const std::string & package,ZipArchiveHandle zip,int status_fd,std::vector<std::string> * cmd)232 bool SetUpAbUpdateCommands(const std::string& package, ZipArchiveHandle zip, int status_fd,
233                            std::vector<std::string>* cmd) {
234   CHECK(cmd != nullptr);
235 
236   // 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";
239   ZipEntry properties_entry;
240   if (FindEntry(zip, AB_OTA_PAYLOAD_PROPERTIES, &properties_entry) != 0) {
241     LOG(ERROR) << "Failed to find " << AB_OTA_PAYLOAD_PROPERTIES;
242     return false;
243   }
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);
250     return false;
251   }
252 
253   static constexpr const char* AB_OTA_PAYLOAD = "payload.bin";
254   ZipEntry payload_entry;
255   if (FindEntry(zip, AB_OTA_PAYLOAD, &payload_entry) != 0) {
256     LOG(ERROR) << "Failed to find " << AB_OTA_PAYLOAD;
257     return false;
258   }
259   long payload_offset = payload_entry.offset;
260   *cmd = {
261     "/system/bin/update_engine_sideload",
262     "--payload=file://" + package,
263     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   };
267   return true;
268 }
269 
SetUpNonAbUpdateCommands(const std::string & package,ZipArchiveHandle zip,int retry_count,int status_fd,std::vector<std::string> * cmd)270 bool SetUpNonAbUpdateCommands(const std::string& package, ZipArchiveHandle zip, int retry_count,
271                               int status_fd, std::vector<std::string>* cmd) {
272   CHECK(cmd != nullptr);
273 
274   // In non-A/B updates we extract the update binary from the package.
275   static constexpr const char* UPDATE_BINARY_NAME = "META-INF/com/google/android/update-binary";
276   ZipEntry binary_entry;
277   if (FindEntry(zip, UPDATE_BINARY_NAME, &binary_entry) != 0) {
278     LOG(ERROR) << "Failed to find update binary " << UPDATE_BINARY_NAME;
279     return false;
280   }
281 
282   const std::string binary_path = Paths::Get().temporary_update_binary();
283   unlink(binary_path.c_str());
284   android::base::unique_fd fd(
285       open(binary_path.c_str(), O_CREAT | O_WRONLY | O_TRUNC | O_CLOEXEC, 0755));
286   if (fd == -1) {
287     PLOG(ERROR) << "Failed to create " << binary_path;
288     return false;
289   }
290 
291   if (auto error = ExtractEntryToFile(zip, &binary_entry, fd); error != 0) {
292     LOG(ERROR) << "Failed to extract " << UPDATE_BINARY_NAME << ": " << ErrorCodeString(error);
293     return false;
294   }
295 
296   // 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.
301   *cmd = {
302     binary_path,
303     std::to_string(kRecoveryApiVersion),
304     std::to_string(status_fd),
305     package,
306   };
307   if (retry_count > 0) {
308     cmd->push_back("retry");
309   }
310   return true;
311 }
312 
log_max_temperature(int * max_temperature,const std::atomic<bool> & logger_finished)313 static void log_max_temperature(int* max_temperature, const std::atomic<bool>& logger_finished) {
314   CHECK(max_temperature != nullptr);
315   std::mutex mtx;
316   std::unique_lock<std::mutex> lck(mtx);
317   while (!logger_finished.load() &&
318          finish_log_temperature.wait_for(lck, 20s) == std::cv_status::timeout) {
319     *max_temperature = std::max(*max_temperature, GetMaxValueFromThermalZone());
320   }
321 }
322 
323 // If the package contains an update binary, extract it and run it.
TryUpdateBinary(Package * package,bool * wipe_cache,std::vector<std::string> * log_buffer,int retry_count,int * max_temperature,RecoveryUI * ui)324 static InstallResult TryUpdateBinary(Package* package, bool* wipe_cache,
325                                      std::vector<std::string>* log_buffer, int retry_count,
326                                      int* max_temperature, RecoveryUI* ui) {
327   std::map<std::string, std::string> metadata;
328   auto zip = package->GetZipArchiveHandle();
329   if (!ReadMetadataFromPackage(zip, &metadata)) {
330     LOG(ERROR) << "Failed to parse metadata in the zip file";
331     return INSTALL_CORRUPT;
332   }
333 
334   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) {
341     CHECK(package->GetType() == PackageType::kFile);
342   }
343 
344   // 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     }
353   }
354 
355   ReadSourceTargetBuild(metadata, log_buffer);
356 
357   // The updater in child process writes to the pipe to communicate with recovery.
358   android::base::unique_fd pipe_read, pipe_write;
359   // 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)) {
362     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 
398   std::string package_path = package->GetPath();
399 
400   std::vector<std::string> args;
401   if (auto setup_result =
402           package_is_ab
403               ? SetUpAbUpdateCommands(package_path, zip, pipe_write.get(), &args)
404               : SetUpNonAbUpdateCommands(package_path, zip, retry_count, pipe_write.get(), &args);
405       !setup_result) {
406     log_buffer->push_back(android::base::StringPrintf("error: %d", kUpdateBinaryCommandFailure));
407     return INSTALL_CORRUPT;
408   }
409 
410   pid_t pid = fork();
411   if (pid == -1) {
412     PLOG(ERROR) << "Failed to fork update binary";
413     log_buffer->push_back(android::base::StringPrintf("error: %d", kForkUpdateBinaryFailure));
414     return INSTALL_ERROR;
415   }
416 
417   if (pid == 0) {
418     umask(022);
419     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);
423     execv(chr_args[0], chr_args.data());
424     // 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)
427     fprintf(stdout, "E:Can't run %s (%s)\n", chr_args[0], strerror(errno));
428     _exit(EXIT_FAILURE);
429   }
430   pipe_write.reset();
431 
432   std::atomic<bool> logger_finished(false);
433   std::thread temperature_logger(log_max_temperature, max_temperature, std::ref(logger_finished));
434 
435   *wipe_cache = false;
436   bool retry_update = false;
437 
438   char buffer[1024];
439   FILE* from_child = android::base::Fdopen(std::move(pipe_read), "r");
440   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") {
468       ui->PrintOnScreenOnly("%s\n", args.c_str());
469       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.
484         log_buffer->push_back(args);
485       } else {
486         LOG(ERROR) << "invalid \"log\" parameters: " << line;
487       }
488     } else {
489       LOG(ERROR) << "unknown command [" << command << "]";
490     }
491   }
492   fclose(from_child);
493 
494   int status;
495   waitpid(pid, &status, 0);
496 
497   logger_finished.store(true);
498   finish_log_temperature.notify_one();
499   temperature_logger.join();
500 
501   if (retry_update) {
502     return INSTALL_RETRY;
503   }
504   if (WIFEXITED(status)) {
505     if (WEXITSTATUS(status) != EXIT_SUCCESS) {
506       LOG(ERROR) << "Error in " << package_path << " (status " << WEXITSTATUS(status) << ")";
507       return INSTALL_ERROR;
508     }
509   } else if (WIFSIGNALED(status)) {
510     LOG(ERROR) << "Error in " << package_path << " (killed by signal " << WTERMSIG(status) << ")";
511     return INSTALL_ERROR;
512   } else {
513     LOG(FATAL) << "Invalid status code " << status;
514   }
515 
516   return INSTALL_SUCCESS;
517 }
518 
VerifyAndInstallPackage(Package * package,bool * wipe_cache,std::vector<std::string> * log_buffer,int retry_count,int * max_temperature,RecoveryUI * ui)519 static InstallResult VerifyAndInstallPackage(Package* package, bool* wipe_cache,
520                                              std::vector<std::string>* log_buffer, int retry_count,
521                                              int* max_temperature, RecoveryUI* ui) {
522   ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
523   // Give verification half the progress bar...
524   ui->SetProgressType(RecoveryUI::DETERMINATE);
525   ui->ShowProgress(VERIFICATION_PROGRESS_FRACTION, VERIFICATION_PROGRESS_TIME);
526 
527   // Verify package.
528   if (!verify_package(package, ui)) {
529     log_buffer->push_back(android::base::StringPrintf("error: %d", kZipVerificationFailure));
530     return INSTALL_CORRUPT;
531   }
532 
533   // 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);
539   auto result = TryUpdateBinary(package, wipe_cache, log_buffer, retry_count, max_temperature, ui);
540   ui->SetEnableReboot(true);
541   ui->Print("\n");
542 
543   return result;
544 }
545 
InstallPackage(Package * package,const std::string_view package_id,bool should_wipe_cache,int retry_count,RecoveryUI * ui)546 InstallResult InstallPackage(Package* package, const std::string_view package_id,
547                              bool should_wipe_cache, int retry_count, RecoveryUI* ui) {
548   auto start = std::chrono::system_clock::now();
549 
550   int start_temperature = GetMaxValueFromThermalZone();
551   int max_temperature = start_temperature;
552 
553   InstallResult result;
554   std::vector<std::string> log_buffer;
555 
556   ui->Print("Supported API: %d\n", kRecoveryApiVersion);
557 
558   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) {
564     LOG(ERROR) << "failed to set up expected mounts for install; aborting";
565     result = INSTALL_ERROR;
566   } else {
567     bool updater_wipe_cache = false;
568     result = VerifyAndInstallPackage(package, &updater_wipe_cache, &log_buffer, retry_count,
569                                      &max_temperature, ui);
570     should_wipe_cache = should_wipe_cache || updater_wipe_cache;
571   }
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 
577   bool has_cache = volume_for_mount_point("/cache") != nullptr;
578   // 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;
583     } else {
584       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;
589       } else {
590         log_buffer.push_back(android::base::Trim(uncrypt_status));
591       }
592     }
593   }
594 
595   // The first two lines need to be the package name and install result.
596   std::vector<std::string> log_header = {
597     std::string(package_id),
598     result == INSTALL_SUCCESS ? "1" : "0",
599     "time_total: " + std::to_string(time_total),
600     "retry: " + std::to_string(retry_count),
601   };
602 
603   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   }
614 
615   std::string log_content =
616       android::base::Join(log_header, "\n") + "\n" + android::base::Join(log_buffer, "\n") + "\n";
617   const std::string& install_file = Paths::Get().temporary_install_file();
618   if (!android::base::WriteStringToFile(log_content, install_file)) {
619     PLOG(ERROR) << "failed to write " << install_file;
620   }
621 
622   // Write a copy into last_log.
623   LOG(INFO) << log_content;
624 
625   if (result == INSTALL_SUCCESS && should_wipe_cache) {
626     if (!WipeCache(ui, nullptr)) {
627       result = INSTALL_ERROR;
628     }
629   }
630 
631   return result;
632 }
633 
verify_package(Package * package,RecoveryUI * ui)634 bool verify_package(Package* package, RecoveryUI* ui) {
635   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()) {
638     LOG(ERROR) << "Failed to load keys";
639     return false;
640   }
641   LOG(INFO) << loaded_keys.size() << " key(s) loaded from " << CERTIFICATE_ZIP_FILE;
642 
643   // Verify package.
644   ui->Print("Verifying update package...\n");
645   auto t0 = std::chrono::system_clock::now();
646   int err = verify_file(package, loaded_keys);
647   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;
655 }
656 
SetupPackageMount(const std::string & package_path,bool * should_use_fuse)657 bool 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 }
702