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. The package_id is a string provided by the caller (e.g. the
48 // package path) to identify the package and log to last_install. This function should also wipe the
49 // cache partition after a successful installation if |should_wipe_cache| is true or an updater
50 // command asks to wipe the cache.
51 InstallResult InstallPackage(Package* package, const std::string_view package_id,
52                              bool should_wipe_cache, int retry_count, RecoveryUI* ui);
53 
54 // Verifies the package by ota keys. Returns true if the package is verified successfully,
55 // otherwise returns false.
56 bool verify_package(Package* package, RecoveryUI* ui);
57 
58 // Reads meta data file of the package; parses each line in the format "key=value"; and writes the
59 // result to |metadata|. Return true if succeed, otherwise return false.
60 bool ReadMetadataFromPackage(ZipArchiveHandle zip, std::map<std::string, std::string>* metadata);
61 
62 // Checks if the metadata in the OTA package has expected values. Mandatory checks: ota-type,
63 // pre-device and serial number (if presents). A/B OTA specific checks: pre-build version,
64 // fingerprint, timestamp.
65 bool CheckPackageMetadata(const std::map<std::string, std::string>& metadata, OtaType ota_type);
66 
67 // Ensures the path to the update package is mounted. Also set the |should_use_fuse| to true if the
68 // package stays on a removable media.
69 bool SetupPackageMount(const std::string& package_path, bool* should_use_fuse);
70