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 "package.h" 28 #include "recovery_ui/ui.h" 29 30 enum InstallResult { 31 INSTALL_SUCCESS, 32 INSTALL_ERROR, 33 INSTALL_CORRUPT, 34 INSTALL_NONE, 35 INSTALL_SKIPPED, 36 INSTALL_RETRY, 37 INSTALL_KEY_INTERRUPTED, 38 INSTALL_REBOOT, 39 }; 40 41 enum class OtaType { 42 AB, 43 BLOCK, 44 BRICK, 45 }; 46 47 // Installs the given update package. This function should also wipe the cache partition after a 48 // successful installation if |should_wipe_cache| is true or an updater command asks to wipe the 49 // cache. 50 int install_package(const std::string& package, bool should_wipe_cache, bool needs_mount, 51 int retry_count, RecoveryUI* ui); 52 53 // Verifies the package by ota keys. Returns true if the package is verified successfully, 54 // otherwise returns false. 55 bool verify_package(Package* package, RecoveryUI* ui); 56 57 // Reads meta data file of the package; parses each line in the format "key=value"; and writes the 58 // result to |metadata|. Return true if succeed, otherwise return false. 59 bool ReadMetadataFromPackage(ZipArchiveHandle zip, std::map<std::string, std::string>* metadata); 60 61 // Reads the "recovery.wipe" entry in the zip archive returns a list of partitions to wipe. 62 std::vector<std::string> GetWipePartitionList(Package* wipe_package); 63 64 // Verifies the compatibility info in a Treble-compatible package. Returns true directly if the 65 // entry doesn't exist. 66 bool verify_package_compatibility(ZipArchiveHandle package_zip); 67 68 // Checks if the the metadata in the OTA package has expected values. Returns 0 on success. 69 // Mandatory checks: ota-type, pre-device and serial number(if presents) 70 // AB OTA specific checks: pre-build version, fingerprint, timestamp. 71 int CheckPackageMetadata(const std::map<std::string, std::string>& metadata, OtaType ota_type); 72
