blob: da8aa5e3986845089c3f5f86b5cd0655626ef74d [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
17#ifndef RECOVERY_INSTALL_H_
18#define RECOVERY_INSTALL_H_
19
Tao Bao641fa972018-04-25 18:59:40 -070020#include <stddef.h>
21
Tianjie Xu93b5bf22018-10-25 10:39:01 -070022#include <map>
Yabin Cuifd99a312016-06-09 14:09:39 -070023#include <string>
xunchange0d991c2019-03-05 14:50:51 -080024#include <vector>
Tao Bao641fa972018-04-25 18:59:40 -070025
Yabin Cuifd99a312016-06-09 14:09:39 -070026#include <ziparchive/zip_archive.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080027
xunchangf07ed2e2019-02-25 14:14:01 -080028#include "package.h"
29
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -070030enum InstallResult {
31 INSTALL_SUCCESS,
32 INSTALL_ERROR,
33 INSTALL_CORRUPT,
34 INSTALL_NONE,
35 INSTALL_SKIPPED,
36 INSTALL_RETRY,
37 INSTALL_KEY_INTERRUPTED
38};
Tao Baoac9d94d2016-11-03 11:37:15 -070039
Tianjie Xu93b5bf22018-10-25 10:39:01 -070040enum class OtaType {
41 AB,
42 BLOCK,
43 BRICK,
44};
45
Tao Bao29ee69b2017-05-01 12:23:17 -070046// Installs the given update package. If INSTALL_SUCCESS is returned and *wipe_cache is true on
47// exit, caller should wipe the cache partition.
Tao Bao641fa972018-04-25 18:59:40 -070048int install_package(const std::string& package, bool* wipe_cache, bool needs_mount,
49 int retry_count);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080050
xunchangf07ed2e2019-02-25 14:14:01 -080051// Verifies the package by ota keys. Returns true if the package is verified successfully,
52// otherwise returns false.
53bool verify_package(Package* package);
Yabin Cuifd99a312016-06-09 14:09:39 -070054
Tianjie Xu93b5bf22018-10-25 10:39:01 -070055// Reads meta data file of the package; parses each line in the format "key=value"; and writes the
56// result to |metadata|. Return true if succeed, otherwise return false.
57bool ReadMetadataFromPackage(ZipArchiveHandle zip, std::map<std::string, std::string>* metadata);
Doug Zongker28ce47c2011-10-28 10:33:05 -070058
xunchange0d991c2019-03-05 14:50:51 -080059// Reads the "recovery.wipe" entry in the zip archive returns a list of partitions to wipe.
xunchang55e3d222019-03-11 11:28:41 -070060std::vector<std::string> GetWipePartitionList(Package* wipe_package);
xunchange0d991c2019-03-05 14:50:51 -080061
Tao Bao29ee69b2017-05-01 12:23:17 -070062// Verifies the compatibility info in a Treble-compatible package. Returns true directly if the
Tao Bao1d866052017-04-10 16:55:57 -070063// entry doesn't exist.
64bool verify_package_compatibility(ZipArchiveHandle package_zip);
65
Tianjie Xu93b5bf22018-10-25 10:39:01 -070066// Checks if the the metadata in the OTA package has expected values. Returns 0 on success.
67// Mandatory checks: ota-type, pre-device and serial number(if presents)
68// AB OTA specific checks: pre-build version, fingerprint, timestamp.
69int CheckPackageMetadata(const std::map<std::string, std::string>& metadata, OtaType ota_type);
70
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080071#endif // RECOVERY_INSTALL_H_