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