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