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