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 #pragma once 18 19 #include <stddef.h> 20 21 #include <map> 22 #include <string> 23 #include <vector> 24 25 #include <ziparchive/zip_archive.h> 26 27 #include "otautil/package.h" 28 #include "recovery_ui/device.h" 29 #include "recovery_ui/ui.h" 30 31 enum InstallResult { 32 INSTALL_SUCCESS, 33 INSTALL_ERROR, 34 INSTALL_CORRUPT, 35 INSTALL_NONE, 36 INSTALL_SKIPPED, 37 INSTALL_RETRY, 38 INSTALL_KEY_INTERRUPTED, 39 INSTALL_REBOOT, 40 }; 41 42 enum class OtaType { 43 AB, 44 BLOCK, 45 BRICK, 46 }; 47 48 // Installs the given update package. The package_id is a string provided by the caller (e.g. the 49 // package path) to identify the package and log to last_install. This function should also wipe the 50 // cache partition after a successful installation if |should_wipe_cache| is true or an updater 51 // command asks to wipe the cache. 52 InstallResult InstallPackage(Package* package, const std::string_view package_id, 53 bool should_wipe_cache, int retry_count, 54 Device* ui); 55 56 // Verifies the package by ota keys. Returns true if the package is verified successfully, 57 // otherwise returns false. 58 bool verify_package(Package* package, RecoveryUI* ui); 59 60 // Reads meta data file of the package; parses each line in the format "key=value"; and writes the 61 // result to |metadata|. Return true if succeed, otherwise return false. 62 bool ReadMetadataFromPackage(ZipArchiveHandle zip, std::map<std::string, std::string>* metadata); 63 64 // Checks if the metadata in the OTA package has expected values. Mandatory checks: ota-type, 65 // pre-device and serial number (if presents). A/B OTA specific checks: pre-build version, 66 // fingerprint, timestamp. 67 bool CheckPackageMetadata(const std::map<std::string, std::string>& metadata, OtaType ota_type); 68 69 // Ensures the path to the update package is mounted. Also set the |should_use_fuse| to true if the 70 // package stays on a removable media. 71 bool SetupPackageMount(const std::string& package_path, bool* should_use_fuse); 72