1 // Copyright 2019 Google Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 //
15 ////////////////////////////////////////////////////////////////////////////////
16
17 #include "tink/subtle/ed25519_verify_boringssl.h"
18
19 #include <iostream>
20 #include <memory>
21 #include <string>
22 #include <utility>
23 #include <vector>
24
25 #include "gtest/gtest.h"
26 #include "absl/status/status.h"
27 #include "absl/strings/escaping.h"
28 #include "absl/strings/str_cat.h"
29 #include "tink/config/tink_fips.h"
30 #include "tink/internal/ec_util.h"
31 #include "tink/public_key_verify.h"
32 #include "tink/subtle/wycheproof_util.h"
33 #include "tink/util/secret_data.h"
34 #include "tink/util/status.h"
35 #include "tink/util/statusor.h"
36 #include "tink/util/test_matchers.h"
37
38 namespace crypto {
39 namespace tink {
40 namespace subtle {
41 namespace {
42
43 using ::crypto::tink::test::IsOk;
44 using ::crypto::tink::test::StatusIs;
45 using ::testing::Not;
46 using ::testing::Test;
47 using ::testing::TestWithParam;
48 using ::testing::ValuesIn;
49
50 // Non-FIPS tests.
51 class Ed25519VerifyBoringSslTest : public Test {
52 private:
SetUp()53 void SetUp() override {
54 if (IsFipsModeEnabled()) {
55 GTEST_SKIP() << "Test assumes kOnlyUseFips is false.";
56 }
57 }
58 };
59
60 // Test vector taken from
61 // https://tools.ietf.org/html/draft-josefsson-eddsa-ed25519-02#section-6.
62 struct TestVector {
63 int id;
64 std::string public_key;
65 std::string private_key;
66 std::string signature;
67 std::string message;
68 };
69
GetTestVectors()70 std::vector<TestVector> GetTestVectors() {
71 return {
72 {
73 /*id=*/1,
74 /*public_key=*/
75 absl::HexStringToBytes(
76 "d75a980182b10ab7d54bfed3c964073a0ee172f3daa62325af021a68f707511"
77 "a"),
78 /*private_key=*/
79 absl::HexStringToBytes("9d61b19deffd5a60ba844af492ec2cc44449c5697b326"
80 "919703bac031cae7f60"),
81 /*signature=*/
82 absl::HexStringToBytes("e5564300c360ac729086e2cc806e828a84877f1eb8e5d"
83 "974d873e065224901555fb8821590a33bacc61e39701c"
84 "f9b46bd25bf5f0595bbe24655141438e7a100b"),
85 /*message=*/"",
86 },
87 {
88 /*id=*/2,
89 /*public_key=*/
90 absl::HexStringToBytes(
91 "3d4017c3e843895a92b70aa74d1b7ebc9c982ccf2ec4968cc0cd55f12af4660"
92 "c"),
93 /*private_key=*/
94 absl::HexStringToBytes("4ccd089b28ff96da9db6c346ec114e0f5b8a319f35aba"
95 "624da8cf6ed4fb8a6fb"),
96 /*signature=*/
97 absl::HexStringToBytes("92a009a9f0d4cab8720e820b5f642540a2b27b5416503"
98 "f8fb3762223ebdb69da085ac1e43e15996e458f3613d0"
99 "f11d8c387b2eaeb4302aeeb00d291612bb0c00"),
100 /*message=*/"\x72",
101 },
102 {
103 /*id=*/3,
104 /*public_key=*/
105 absl::HexStringToBytes(
106 "fc51cd8e6218a1a38da47ed00230f0580816ed13ba3303ac5deb91154890802"
107 "5"),
108 /*private_key=*/
109 absl::HexStringToBytes("c5aa8df43f9f837bedb7442f31dcb7b166d38535076f0"
110 "94b85ce3a2e0b4458f7"),
111 /*signature=*/
112 absl::HexStringToBytes("6291d657deec24024827e69c3abe01a30ce548a284743"
113 "a445e3680d7db5ac3ac18ff9b538d16f290ae67f76098"
114 "4dc6594a7c15e9716ed28dc027beceea1ec40a"),
115 /*message=*/"\xaf\x82",
116 },
117 {
118 /*id=*/1024,
119 /*public_key=*/
120 absl::HexStringToBytes(
121 "278117fc144c72340f67d0f2316e8386ceffbf2b2428c9c51fef7c597f1d426"
122 "e"),
123 /*private_key=*/
124 absl::HexStringToBytes("f5e5767cf153319517630f226876b86c8160cc583bc01"
125 "3744c6bf255f5cc0ee5"),
126 /*signature=*/
127 absl::HexStringToBytes("0aab4c900501b3e24d7cdf4663326a3a87df5e4843b2c"
128 "bdb67cbf6e460fec350aa5371b1508f9f4528ecea23c4"
129 "36d94b5e8fcd4f681e30a6ac00a9704a188a03"),
130 /*message=*/
131 absl::HexStringToBytes(
132 "08b8b2b733424243760fe426a4b54908632110a66c2f6591eabd3345e3e4eb98"
133 "fa6e264bf09efe12ee50f8f54e9f77b1e355f6c50544e23fb1433ddf73be84d8"
134 "79de7c0046dc4996d9e773f4bc9efe5738829adb26c81b37c93a1b270b20329d"
135 "658675fc6ea534e0810a4432826bf58c941efb65d57a338bbd2e26640f89ffbc"
136 "1a858efcb8550ee3a5e1998bd177e93a7363c344fe6b199ee5d02e82d522c4fe"
137 "ba15452f80288a821a579116ec6dad2b3b310da903401aa62100ab5d1a36553e"
138 "06203b33890cc9b832f79ef80560ccb9a39ce767967ed628c6ad573cb116dbef"
139 "efd75499da96bd68a8a97b928a8bbc103b6621fcde2beca1231d206be6cd9ec7"
140 "aff6f6c94fcd7204ed3455c68c83f4a41da4af2b74ef5c53f1d8ac70bdcb7ed1"
141 "85ce81bd84359d44254d95629e9855a94a7c1958d1f8ada5d0532ed8a5aa3fb2"
142 "d17ba70eb6248e594e1a2297acbbb39d502f1a8c6eb6f1ce22b3de1a1f40cc24"
143 "554119a831a9aad6079cad88425de6bde1a9187ebb6092cf67bf2b13fd65f270"
144 "88d78b7e883c8759d2c4f5c65adb7553878ad575f9fad878e80a0c9ba63bcbcc"
145 "2732e69485bbc9c90bfbd62481d9089beccf80cfe2df16a2cf65bd92dd597b07"
146 "07e0917af48bbb75fed413d238f5555a7a569d80c3414a8d0859dc65a46128ba"
147 "b27af87a71314f318c782b23ebfe808b82b0ce26401d2e22f04d83d1255dc51a"
148 "ddd3b75a2b1ae0784504df543af8969be3ea7082ff7fc9888c144da2af58429e"
149 "c96031dbcad3dad9af0dcbaaaf268cb8fcffead94f3c7ca495e056a9b47acdb7"
150 "51fb73e666c6c655ade8297297d07ad1ba5e43f1bca32301651339e22904cc8c"
151 "42f58c30c04aafdb038dda0847dd988dcda6f3bfd15c4b4c4525004aa06eeff8"
152 "ca61783aacec57fb3d1f92b0fe2fd1a85f6724517b65e614ad6808d6f6ee34df"
153 "f7310fdc82aebfd904b01e1dc54b2927094b2db68d6f903b68401adebf5a7e08"
154 "d78ff4ef5d63653a65040cf9bfd4aca7984a74d37145986780fc0b16ac451649"
155 "de6188a7dbdf191f64b5fc5e2ab47b57f7f7276cd419c17a3ca8e1b939ae49e4"
156 "88acba6b965610b5480109c8b17b80e1b7b750dfc7598d5d5011fd2dcc5600a3"
157 "2ef5b52a1ecc820e308aa342721aac0943bf6686b64b2579376504ccc493d97e"
158 "6aed3fb0f9cd71a43dd497f01f17c0e2cb3797aa2a2f256656168e6c496afc5f"
159 "b93246f6b1116398a346f1a641f3b041e989f7914f90cc2c7fff357876e506b5"
160 "0d334ba77c225bc307ba537152f3f1610e4eafe595f6d9d90d11faa933a15ef1"
161 "369546868a7f3a45a96768d40fd9d03412c091c6315cf4fde7cb68606937380d"
162 "b2eaaa707b4c4185c32eddcdd306705e4dc1ffc872eeee475a64dfac86aba41c"
163 "0618983f8741c5ef68d3a101e8a3b8cac60c905c15fc910840b94c00a0b9d0"),
164 },
165 };
166 }
167
TEST_F(Ed25519VerifyBoringSslTest,InvalidPublicKey)168 TEST_F(Ed25519VerifyBoringSslTest, InvalidPublicKey) {
169 // Null public key.
170 const absl::string_view null_public_key;
171 EXPECT_THAT(Ed25519VerifyBoringSsl::New(null_public_key).status(),
172 Not(IsOk()));
173
174 for (int keysize = 0; keysize < 128; keysize++) {
175 if (keysize == internal::Ed25519KeyPubKeySize()) {
176 // Valid key size.
177 continue;
178 }
179 std::string key(keysize, 'x');
180 EXPECT_THAT(Ed25519VerifyBoringSsl::New(key), Not(IsOk()));
181 }
182 }
183
184 // Using the test vector with id=1, this makes sure verification succeeds
185 // passing an empty string_view, an empty string and a default-constructed
186 // string_view.
TEST_F(Ed25519VerifyBoringSslTest,MessageEmptyVersusNullStringView)187 TEST_F(Ed25519VerifyBoringSslTest, MessageEmptyVersusNullStringView) {
188 TestVector empty_message_test_vector = GetTestVectors()[0];
189 util::StatusOr<std::unique_ptr<PublicKeyVerify>> verifier =
190 Ed25519VerifyBoringSsl::New(empty_message_test_vector.public_key);
191 ASSERT_THAT(verifier, IsOk());
192
193 // Message is a null string_view.
194 const absl::string_view kEmptyStringView;
195 EXPECT_THAT((*verifier)->Verify(empty_message_test_vector.signature,
196 kEmptyStringView),
197 IsOk());
198
199 // Message is an empty string.
200 const std::string kEmptyStr = "";
201 EXPECT_THAT(
202 (*verifier)->Verify(empty_message_test_vector.signature, kEmptyStr),
203 IsOk());
204
205 // Message is a default constructed string_view.
206 EXPECT_THAT((*verifier)->Verify(empty_message_test_vector.signature,
207 absl::string_view()),
208 IsOk());
209 }
210
211 using Ed25519VerifyBoringSslParamsTest = TestWithParam<TestVector>;
212
TEST_P(Ed25519VerifyBoringSslParamsTest,VerifiesCorrectly)213 TEST_P(Ed25519VerifyBoringSslParamsTest, VerifiesCorrectly) {
214 if (IsFipsModeEnabled()) {
215 GTEST_SKIP() << "Test assumes kOnlyUseFips is false.";
216 }
217 TestVector test_vector = GetParam();
218
219 util::StatusOr<std::unique_ptr<PublicKeyVerify>> verifier =
220 Ed25519VerifyBoringSsl::New(test_vector.public_key);
221 ASSERT_THAT(verifier, IsOk());
222 EXPECT_THAT((*verifier)->Verify(test_vector.signature, test_vector.message),
223 IsOk());
224 }
225
226 INSTANTIATE_TEST_SUITE_P(Ed25519VerifyBoringSslParamsTests,
227 Ed25519VerifyBoringSslParamsTest,
228 ValuesIn(GetTestVectors()));
229
GetVerifier(const rapidjson::Value & test_group)230 static util::StatusOr<std::unique_ptr<PublicKeyVerify>> GetVerifier(
231 const rapidjson::Value& test_group) {
232 std::string public_key = WycheproofUtil::GetBytes(test_group["key"]["pk"]);
233 auto result = Ed25519VerifyBoringSsl::New(public_key);
234 if (!result.ok()) {
235 std::cout << "Failed: " << result.status() << "\n";
236 }
237 return result;
238 }
239
240 // Tests signature verification using the test vectors in the specified file.
241 // allow_skipping determines whether it is OK to skip a test because
242 // a verfier cannot be constructed. This option can be used for
243 // if a file contains test vectors that are not necessarily supported
244 // by tink.
TestSignatures(const std::string & filename,bool allow_skipping)245 bool TestSignatures(const std::string& filename, bool allow_skipping) {
246 std::unique_ptr<rapidjson::Document> root =
247 WycheproofUtil::ReadTestVectors(filename);
248 std::cout << (*root)["algorithm"].GetString();
249 std::cout << "generator version " << (*root)["generatorVersion"].GetString();
250 int passed_tests = 0;
251 int failed_tests = 0;
252 for (const rapidjson::Value& test_group : (*root)["testGroups"].GetArray()) {
253 auto verifier_result = GetVerifier(test_group);
254 if (!verifier_result.ok()) {
255 std::string curve = test_group["key"]["curve"].GetString();
256 if (allow_skipping) {
257 std::cout << "Could not construct verifier for curve " << curve
258 << verifier_result.status();
259 } else {
260 ADD_FAILURE() << "Could not construct verifier for curve " << curve
261 << verifier_result.status();
262 failed_tests += test_group["tests"].GetArray().Size();
263 }
264 continue;
265 }
266
267 auto verifier = std::move(verifier_result.value());
268 for (const rapidjson::Value& test : test_group["tests"].GetArray()) {
269 std::string expected = test["result"].GetString();
270 std::string msg = WycheproofUtil::GetBytes(test["msg"]);
271 std::string sig = WycheproofUtil::GetBytes(test["sig"]);
272 std::string id =
273 absl::StrCat(test["tcId"].GetInt(), " ", test["comment"].GetString());
274 auto status = verifier->Verify(sig, msg);
275 if (expected == "valid") {
276 if (status.ok()) {
277 ++passed_tests;
278 } else {
279 ++failed_tests;
280 ADD_FAILURE() << "Valid signature not verified:" << id
281 << " status:" << status;
282 }
283 } else if (expected == "invalid") {
284 if (!status.ok()) {
285 ++passed_tests;
286 } else {
287 ++failed_tests;
288 ADD_FAILURE() << "Invalid signature verified:" << id;
289 }
290 } else if (expected == "acceptable") {
291 // The validity of the signature is undefined. Hence the test passes
292 // but we log the result since we might still want to know if the
293 // library is strict or forgiving.
294 ++passed_tests;
295 std::cout << "Acceptable signature:" << id << ":" << status;
296 } else {
297 ++failed_tests;
298 ADD_FAILURE() << "Invalid field result:" << expected;
299 }
300 }
301 }
302 int num_tests = (*root)["numberOfTests"].GetInt();
303 std::cout << "total number of tests: " << num_tests;
304 std::cout << "number of tests passed:" << passed_tests;
305 std::cout << "number of tests failed:" << failed_tests;
306 return failed_tests == 0;
307 }
308
TEST_F(Ed25519VerifyBoringSslTest,WycheproofCurve25519)309 TEST_F(Ed25519VerifyBoringSslTest, WycheproofCurve25519) {
310 ASSERT_TRUE(TestSignatures("eddsa_test.json", false));
311 }
312
TEST(Ed25519VerifyBoringSslFipsTest,testFipsMode)313 TEST(Ed25519VerifyBoringSslFipsTest, testFipsMode) {
314 if (!IsFipsModeEnabled()) {
315 GTEST_SKIP() << "Test assumes kOnlyUseFips.";
316 }
317
318 constexpr absl::string_view kPublicKey =
319 "fc51cd8e6218a1a38da47ed00230f0580816ed13ba3303ac5deb911548908025";
320 // Create a new signer.
321 EXPECT_THAT(
322 Ed25519VerifyBoringSsl::New(absl::HexStringToBytes(kPublicKey)).status(),
323 StatusIs(absl::StatusCode::kInternal));
324 }
325
326 } // namespace
327 } // namespace subtle
328 } // namespace tink
329 } // namespace crypto
330