blob: ef9feaff039185c15501fc4cd4f4de4ba43bd346 [file] [log] [blame]
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001/*
2 * Copyright (C) 2008 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_VERIFIER_H
18#define _RECOVERY_VERIFIER_H
19
Tianjie Xu82566982018-10-10 15:44:17 -070020#include <stdint.h>
21
Tao Bao5e535012017-03-16 17:37:38 -070022#include <functional>
Tao Bao71e3e092016-02-02 14:02:27 -080023#include <memory>
24#include <vector>
25
Mattias Nissler452df6d2016-04-04 16:17:01 +020026#include <openssl/ec_key.h>
27#include <openssl/rsa.h>
28#include <openssl/sha.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080029
xunchang37304f32019-03-12 12:40:14 -070030constexpr size_t MiB = 1024 * 1024;
31
xunchangf07ed2e2019-02-25 14:14:01 -080032using HasherUpdateCallback = std::function<void(const uint8_t* addr, uint64_t size)>;
33
Mattias Nissler452df6d2016-04-04 16:17:01 +020034struct RSADeleter {
Mikhail Lappob49767c2017-03-23 21:44:26 +010035 void operator()(RSA* rsa) const {
Mattias Nissler452df6d2016-04-04 16:17:01 +020036 RSA_free(rsa);
37 }
38};
39
40struct ECKEYDeleter {
Mikhail Lappob49767c2017-03-23 21:44:26 +010041 void operator()(EC_KEY* ec_key) const {
Mattias Nissler452df6d2016-04-04 16:17:01 +020042 EC_KEY_free(ec_key);
43 }
44};
Kenny Root7a4adb52013-10-09 10:14:35 -070045
Tao Bao71e3e092016-02-02 14:02:27 -080046struct Certificate {
Kenny Root7a4adb52013-10-09 10:14:35 -070047 typedef enum {
Mattias Nissler452df6d2016-04-04 16:17:01 +020048 KEY_TYPE_RSA,
49 KEY_TYPE_EC,
Kenny Root7a4adb52013-10-09 10:14:35 -070050 } KeyType;
51
Mattias Nissler452df6d2016-04-04 16:17:01 +020052 Certificate(int hash_len_,
53 KeyType key_type_,
54 std::unique_ptr<RSA, RSADeleter>&& rsa_,
55 std::unique_ptr<EC_KEY, ECKEYDeleter>&& ec_)
56 : hash_len(hash_len_),
57 key_type(key_type_),
58 rsa(std::move(rsa_)),
59 ec(std::move(ec_)) {}
Tao Bao71e3e092016-02-02 14:02:27 -080060
Mattias Nissler452df6d2016-04-04 16:17:01 +020061 // SHA_DIGEST_LENGTH (SHA-1) or SHA256_DIGEST_LENGTH (SHA-256)
62 int hash_len;
Kenny Root7a4adb52013-10-09 10:14:35 -070063 KeyType key_type;
Mattias Nissler452df6d2016-04-04 16:17:01 +020064 std::unique_ptr<RSA, RSADeleter> rsa;
65 std::unique_ptr<EC_KEY, ECKEYDeleter> ec;
Tao Bao71e3e092016-02-02 14:02:27 -080066};
Doug Zongker30362a62013-04-10 11:32:17 -070067
xunchangf07ed2e2019-02-25 14:14:01 -080068class VerifierInterface {
69 public:
70 virtual ~VerifierInterface() = default;
71
72 // Returns the package size in bytes.
73 virtual uint64_t GetPackageSize() const = 0;
74
75 // Reads |byte_count| data starting from |offset|, and puts the result in |buffer|.
76 virtual bool ReadFullyAtOffset(uint8_t* buffer, uint64_t byte_count, uint64_t offset) = 0;
77
78 // Updates the hash contexts for |length| bytes data starting from |start|.
79 virtual bool UpdateHashAtOffset(const std::vector<HasherUpdateCallback>& hashers, uint64_t start,
80 uint64_t length) = 0;
81
82 // Updates the progress in fraction during package verification.
83 virtual void SetProgress(float progress) = 0;
84};
85
86// Looks for an RSA signature embedded in the .ZIP file comment given the path to the zip.
87// Verifies that it matches one of the given public keys. Returns VERIFY_SUCCESS or
88// VERIFY_FAILURE (if any error is encountered or no key matches the signature).
89int verify_file(VerifierInterface* package, const std::vector<Certificate>& keys);
Doug Zongker60151a22009-08-12 18:30:03 -070090
xunchang908ad772019-03-26 09:54:34 -070091// Checks that the RSA key has a modulus of 2048 or 4096 bits long, and public exponent is 3 or
92// 65537.
Tianjie Xub5110de2018-10-23 23:31:43 -070093bool CheckRSAKey(const std::unique_ptr<RSA, RSADeleter>& rsa);
94
95// Checks that the field size of the curve for the EC key is 256 bits.
96bool CheckECKey(const std::unique_ptr<EC_KEY, ECKEYDeleter>& ec_key);
97
Tianjie Xu82566982018-10-10 15:44:17 -070098// Parses a PEM-encoded x509 certificate from the given buffer and saves it into |cert|. Returns
99// false if there is a parsing failure or the signature's encryption algorithm is not supported.
100bool LoadCertificateFromBuffer(const std::vector<uint8_t>& pem_content, Certificate* cert);
101
Tianjie Xu0dd96852018-10-15 11:44:14 -0700102// Iterates over the zip entries with the suffix "x509.pem" and returns a list of recognized
103// certificates. Returns an empty list if we fail to parse any of the entries.
104std::vector<Certificate> LoadKeysFromZipfile(const std::string& zip_name);
105
Doug Zongker60151a22009-08-12 18:30:03 -0700106#define VERIFY_SUCCESS 0
107#define VERIFY_FAILURE 1
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800108
109#endif /* _RECOVERY_VERIFIER_H */