xref: /aosp_15_r20/system/update_engine/payload_generator/payload_signer_unittest.cc (revision 5a9231315b4521097b8dc3750bc806fcafe0c72f)
1 //
2 // Copyright (C) 2010 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 #include "update_engine/payload_generator/payload_signer.h"
18 
19 #include <string>
20 #include <vector>
21 
22 #include <base/logging.h>
23 #include <gtest/gtest.h>
24 
25 #include "update_engine/common/hash_calculator.h"
26 #include "update_engine/common/test_utils.h"
27 #include "update_engine/common/testing_constants.h"
28 #include "update_engine/common/utils.h"
29 #include "update_engine/payload_consumer/payload_constants.h"
30 #include "update_engine/payload_consumer/payload_verifier.h"
31 #include "update_engine/payload_generator/payload_file.h"
32 #include "update_engine/update_metadata.pb.h"
33 
34 using chromeos_update_engine::test_utils::GetBuildArtifactsPath;
35 using std::string;
36 using std::vector;
37 
38 // Note: the test key was generated with the following command:
39 // openssl genrsa -out unittest_key.pem 2048
40 // The public-key version is created by the build system.
41 
42 namespace chromeos_update_engine {
43 
44 // Some data and its corresponding hash and signature:
45 const char kDataToSign[] = "This is some data to sign.";
46 
47 // Generated by:
48 // echo -n 'This is some data to sign.' | openssl dgst -sha256 -binary |
49 //   hexdump -v -e '" " 8/1 "0x%02x, " "\n"'
50 const uint8_t kDataHash[] = {0x7a, 0x07, 0xa6, 0x44, 0x08, 0x86, 0x20, 0xa6,
51                              0xc1, 0xf8, 0xd9, 0x02, 0x05, 0x63, 0x0d, 0xb7,
52                              0xfc, 0x2b, 0xa0, 0xa9, 0x7c, 0x9d, 0x1d, 0x8c,
53                              0x01, 0xf5, 0x78, 0x6d, 0xc5, 0x11, 0xb4, 0x06};
54 
55 // Generated with openssl 1.0, which at the time of this writing, you need
56 // to download and install yourself. Here's my command:
57 // echo -n 'This is some data to sign.' | openssl dgst -sha256 -binary |
58 //    ~/local/bin/openssl pkeyutl -sign -inkey unittest_key.pem -pkeyopt
59 //    digest:sha256 | hexdump -v -e '" " 8/1 "0x%02x, " "\n"'
60 const uint8_t kDataSignature[] = {
61     0x9f, 0x86, 0x25, 0x8b, 0xf3, 0xcc, 0xe3, 0x95, 0x5f, 0x45, 0x83, 0xb2,
62     0x66, 0xf0, 0x2a, 0xcf, 0xb7, 0xaa, 0x52, 0x25, 0x7a, 0xdd, 0x9d, 0x65,
63     0xe5, 0xd6, 0x02, 0x4b, 0x37, 0x99, 0x53, 0x06, 0xc2, 0xc9, 0x37, 0x36,
64     0x25, 0x62, 0x09, 0x4f, 0x6b, 0x22, 0xf8, 0xb3, 0x89, 0x14, 0x98, 0x1a,
65     0xbc, 0x30, 0x90, 0x4a, 0x43, 0xf5, 0xea, 0x2e, 0xf0, 0xa4, 0xba, 0xc3,
66     0xa7, 0xa3, 0x44, 0x70, 0xd6, 0xc4, 0x89, 0xd8, 0x45, 0x71, 0xbb, 0xee,
67     0x59, 0x87, 0x3d, 0xd5, 0xe5, 0x40, 0x22, 0x3d, 0x73, 0x7e, 0x2a, 0x58,
68     0x93, 0x8e, 0xcb, 0x9c, 0xf2, 0xbb, 0x4a, 0xc9, 0xd2, 0x2c, 0x52, 0x42,
69     0xb0, 0xd1, 0x13, 0x22, 0xa4, 0x78, 0xc7, 0xc6, 0x3e, 0xf1, 0xdc, 0x4c,
70     0x7b, 0x2d, 0x40, 0xda, 0x58, 0xac, 0x4a, 0x11, 0x96, 0x3d, 0xa0, 0x01,
71     0xf6, 0x96, 0x74, 0xf6, 0x6c, 0x0c, 0x49, 0x69, 0x4e, 0xc1, 0x7e, 0x9f,
72     0x2a, 0x42, 0xdd, 0x15, 0x6b, 0x37, 0x2e, 0x3a, 0xa7, 0xa7, 0x6d, 0x91,
73     0x13, 0xe8, 0x59, 0xde, 0xfe, 0x99, 0x07, 0xd9, 0x34, 0x0f, 0x17, 0xb3,
74     0x05, 0x4c, 0xd2, 0xc6, 0x82, 0xb7, 0x38, 0x36, 0x63, 0x1d, 0x9e, 0x21,
75     0xa6, 0x32, 0xef, 0xf1, 0x65, 0xe6, 0xed, 0x95, 0x25, 0x9b, 0x61, 0xe0,
76     0xba, 0x86, 0xa1, 0x7f, 0xf8, 0xa5, 0x4a, 0x32, 0x1f, 0x15, 0x20, 0x8a,
77     0x41, 0xc5, 0xb0, 0xd9, 0x4a, 0xda, 0x85, 0xf3, 0xdc, 0xa0, 0x98, 0x5d,
78     0x1d, 0x18, 0x9d, 0x2e, 0x42, 0xea, 0x69, 0x13, 0x74, 0x3c, 0x74, 0xf7,
79     0x6d, 0x43, 0xb0, 0x63, 0x90, 0xdb, 0x04, 0xd5, 0x05, 0xc9, 0x73, 0x1f,
80     0x6c, 0xd6, 0xfa, 0x46, 0x4e, 0x0f, 0x33, 0x58, 0x5b, 0x0d, 0x1b, 0x55,
81     0x39, 0xb9, 0x0f, 0x43, 0x37, 0xc0, 0x06, 0x0c, 0x29, 0x93, 0x43, 0xc7,
82     0x43, 0xb9, 0xab, 0x7d};
83 
84 namespace {
SignSampleData(string * out_signature,const vector<string> & private_keys)85 void SignSampleData(string* out_signature, const vector<string>& private_keys) {
86   uint64_t length = 0;
87   EXPECT_TRUE(PayloadSigner::SignatureBlobLength(private_keys, &length));
88   EXPECT_GT(length, 0U);
89   brillo::Blob hash_blob;
90   EXPECT_TRUE(HashCalculator::RawHashOfBytes(
91       kDataToSign, strlen(kDataToSign), &hash_blob));
92   EXPECT_TRUE(
93       PayloadSigner::SignHashWithKeys(hash_blob, private_keys, out_signature));
94   EXPECT_EQ(length, out_signature->size());
95 }
96 }  // namespace
97 
98 class PayloadSignerTest : public ::testing::Test {
99  protected:
100   brillo::Blob hash_data_{std::begin(kDataHash), std::end(kDataHash)};
101 };
102 
TEST_F(PayloadSignerTest,SignSimpleTextTest)103 TEST_F(PayloadSignerTest, SignSimpleTextTest) {
104   string signature;
105   SignSampleData(&signature, {GetBuildArtifactsPath(kUnittestPrivateKeyPath)});
106 
107   // Check the signature itself
108   Signatures signatures;
109   EXPECT_TRUE(signatures.ParseFromString(signature));
110   EXPECT_EQ(1, signatures.signatures_size());
111   const Signatures::Signature& sig = signatures.signatures(0);
112   const string& sig_data = sig.data();
113   ASSERT_EQ(std::size(kDataSignature), sig_data.size());
114   for (size_t i = 0; i < std::size(kDataSignature); i++) {
115     EXPECT_EQ(kDataSignature[i], static_cast<uint8_t>(sig_data[i]));
116   }
117 }
118 
TEST_F(PayloadSignerTest,VerifyAllSignatureTest)119 TEST_F(PayloadSignerTest, VerifyAllSignatureTest) {
120   string signature;
121   SignSampleData(&signature,
122                  {GetBuildArtifactsPath(kUnittestPrivateKeyPath),
123                   GetBuildArtifactsPath(kUnittestPrivateKey2Path),
124                   GetBuildArtifactsPath(kUnittestPrivateKeyRSA4096Path),
125                   GetBuildArtifactsPath(kUnittestPrivateKeyECPath)});
126 
127   // Either public key should pass the verification.
128   for (const auto& path : {kUnittestPublicKeyPath,
129                            kUnittestPublicKey2Path,
130                            kUnittestPublicKeyRSA4096Path,
131                            kUnittestPublicKeyECPath}) {
132     string public_key;
133     EXPECT_TRUE(utils::ReadFile(GetBuildArtifactsPath(path), &public_key));
134     auto payload_verifier = PayloadVerifier::CreateInstance(public_key);
135     EXPECT_TRUE(payload_verifier != nullptr);
136     EXPECT_TRUE(payload_verifier->VerifySignature(signature, hash_data_));
137   }
138 }
139 
TEST_F(PayloadSignerTest,VerifySignatureTest)140 TEST_F(PayloadSignerTest, VerifySignatureTest) {
141   string signature;
142   SignSampleData(&signature, {GetBuildArtifactsPath(kUnittestPrivateKeyPath)});
143 
144   string public_key;
145   EXPECT_TRUE(utils::ReadFile(GetBuildArtifactsPath(kUnittestPublicKeyPath),
146                               &public_key));
147   auto payload_verifier = PayloadVerifier::CreateInstance(public_key);
148   EXPECT_TRUE(payload_verifier != nullptr);
149   EXPECT_TRUE(payload_verifier->VerifySignature(signature, hash_data_));
150 
151   // Passing the invalid key should fail the verification.
152   public_key.clear();
153   EXPECT_TRUE(utils::ReadFile(GetBuildArtifactsPath(kUnittestPublicKey2Path),
154                               &public_key));
155   payload_verifier = PayloadVerifier::CreateInstance(public_key);
156   EXPECT_TRUE(payload_verifier != nullptr);
157   EXPECT_FALSE(payload_verifier->VerifySignature(signature, hash_data_));
158 }
159 
TEST_F(PayloadSignerTest,VerifySignedPayloadTest)160 TEST_F(PayloadSignerTest, VerifySignedPayloadTest) {
161   ScopedTempFile payload_file("payload.XXXXXX");
162   PayloadGenerationConfig config;
163   config.version.major = kBrilloMajorPayloadVersion;
164   PayloadFile payload;
165   EXPECT_TRUE(payload.Init(config));
166   uint64_t metadata_size;
167   EXPECT_TRUE(
168       payload.WritePayload(payload_file.path(),
169                            "/dev/null",
170                            GetBuildArtifactsPath(kUnittestPrivateKeyPath),
171                            &metadata_size));
172   EXPECT_TRUE(PayloadSigner::VerifySignedPayload(
173       payload_file.path(), GetBuildArtifactsPath(kUnittestPublicKeyPath)));
174 }
175 
176 }  // namespace chromeos_update_engine
177