1 // Copyright 2023 Google LLC
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/signature/ed25519_private_key.h"
18
19 #include "gmock/gmock.h"
20 #include "gtest/gtest.h"
21 #include "tink/insecure_secret_key_access.h"
22 #include "tink/internal/ec_util.h"
23 #include "tink/partial_key_access.h"
24 #include "tink/signature/ed25519_public_key.h"
25 #include "tink/subtle/random.h"
26 #include "tink/util/statusor.h"
27 #include "tink/util/test_matchers.h"
28
29 namespace crypto {
30 namespace tink {
31 namespace {
32
33 using ::crypto::tink::test::IsOk;
34 using ::crypto::tink::test::StatusIs;
35 using ::testing::Eq;
36 using ::testing::TestWithParam;
37 using ::testing::Values;
38
39 struct TestCase {
40 Ed25519Parameters::Variant variant;
41 absl::optional<int> id_requirement;
42 std::string output_prefix;
43 };
44
45 using Ed25519PrivateKeyTest = TestWithParam<TestCase>;
46
47 INSTANTIATE_TEST_SUITE_P(
48 Ed25519PrivateKeyTestSuite, Ed25519PrivateKeyTest,
49 Values(TestCase{Ed25519Parameters::Variant::kTink, 0x02030400,
50 std::string("\x01\x02\x03\x04\x00", 5)},
51 TestCase{Ed25519Parameters::Variant::kCrunchy, 0x01030005,
52 std::string("\x00\x01\x03\x00\x05", 5)},
53 TestCase{Ed25519Parameters::Variant::kLegacy, 0x07080910,
54 std::string("\x00\x07\x08\x09\x10", 5)},
55 TestCase{Ed25519Parameters::Variant::kNoPrefix, absl::nullopt, ""}));
56
TEST_P(Ed25519PrivateKeyTest,CreateSucceeds)57 TEST_P(Ed25519PrivateKeyTest, CreateSucceeds) {
58 TestCase test_case = GetParam();
59
60 util::StatusOr<Ed25519Parameters> params =
61 Ed25519Parameters::Create(test_case.variant);
62 ASSERT_THAT(params, IsOk());
63
64 util::StatusOr<std::unique_ptr<internal::Ed25519Key>> key_pair =
65 internal::NewEd25519Key();
66 ASSERT_THAT(key_pair, IsOk());
67
68 util::StatusOr<Ed25519PublicKey> public_key =
69 Ed25519PublicKey::Create(*params, (*key_pair)->public_key,
70 test_case.id_requirement, GetPartialKeyAccess());
71 ASSERT_THAT(public_key, IsOk());
72
73 RestrictedData private_key_bytes =
74 RestrictedData((*key_pair)->private_key, InsecureSecretKeyAccess::Get());
75
76 util::StatusOr<Ed25519PrivateKey> private_key = Ed25519PrivateKey::Create(
77 *public_key, private_key_bytes, GetPartialKeyAccess());
78 ASSERT_THAT(private_key, IsOk());
79
80 EXPECT_THAT(private_key->GetParameters(), Eq(*params));
81 EXPECT_THAT(private_key->GetIdRequirement(), Eq(test_case.id_requirement));
82 EXPECT_THAT(private_key->GetPublicKey(), Eq(*public_key));
83 EXPECT_THAT(private_key->GetOutputPrefix(), Eq(test_case.output_prefix));
84 EXPECT_THAT(private_key->GetPrivateKeyBytes(GetPartialKeyAccess()),
85 Eq(private_key_bytes));
86 }
87
TEST(Ed25519PrivateKeyTest,CreateWithMismatchedPublicKeyFails)88 TEST(Ed25519PrivateKeyTest, CreateWithMismatchedPublicKeyFails) {
89 util::StatusOr<Ed25519Parameters> params =
90 Ed25519Parameters::Create(Ed25519Parameters::Variant::kTink);
91 ASSERT_THAT(params, IsOk());
92
93 util::StatusOr<std::unique_ptr<internal::Ed25519Key>> key_pair =
94 internal::NewEd25519Key();
95 ASSERT_THAT(key_pair, IsOk());
96
97 std::string public_key_bytes = subtle::Random::GetRandomBytes(32);
98 util::StatusOr<Ed25519PublicKey> public_key =
99 Ed25519PublicKey::Create(*params, public_key_bytes,
100 /*id_requirement=*/123, GetPartialKeyAccess());
101 ASSERT_THAT(public_key, IsOk());
102
103 RestrictedData private_key_bytes =
104 RestrictedData((*key_pair)->private_key, InsecureSecretKeyAccess::Get());
105
106 EXPECT_THAT(Ed25519PrivateKey::Create(*public_key, private_key_bytes,
107 GetPartialKeyAccess())
108 .status(),
109 StatusIs(absl::StatusCode::kInvalidArgument));
110 }
111
TEST(Ed25519PrivateKeyTest,CreateWithInvalidPrivateKeyLengthFails)112 TEST(Ed25519PrivateKeyTest, CreateWithInvalidPrivateKeyLengthFails) {
113 util::StatusOr<Ed25519Parameters> params =
114 Ed25519Parameters::Create(Ed25519Parameters::Variant::kTink);
115 ASSERT_THAT(params, IsOk());
116
117 util::StatusOr<std::unique_ptr<internal::Ed25519Key>> key_pair =
118 internal::NewEd25519Key();
119 ASSERT_THAT(key_pair, IsOk());
120
121 util::StatusOr<Ed25519PublicKey> public_key =
122 Ed25519PublicKey::Create(*params, (*key_pair)->public_key,
123 /*id_requirement=*/123, GetPartialKeyAccess());
124 ASSERT_THAT(public_key, IsOk());
125
126 RestrictedData private_key_bytes = RestrictedData(
127 (*key_pair)->private_key.substr(0, 31), InsecureSecretKeyAccess::Get());
128
129 EXPECT_THAT(Ed25519PrivateKey::Create(*public_key, private_key_bytes,
130 GetPartialKeyAccess())
131 .status(),
132 StatusIs(absl::StatusCode::kInvalidArgument));
133 }
134
TEST_P(Ed25519PrivateKeyTest,KeyEquals)135 TEST_P(Ed25519PrivateKeyTest, KeyEquals) {
136 TestCase test_case = GetParam();
137
138 util::StatusOr<Ed25519Parameters> params =
139 Ed25519Parameters::Create(test_case.variant);
140 ASSERT_THAT(params, IsOk());
141
142 util::StatusOr<std::unique_ptr<internal::Ed25519Key>> key_pair =
143 internal::NewEd25519Key();
144 ASSERT_THAT(key_pair, IsOk());
145
146 util::StatusOr<Ed25519PublicKey> public_key =
147 Ed25519PublicKey::Create(*params, (*key_pair)->public_key,
148 test_case.id_requirement, GetPartialKeyAccess());
149 ASSERT_THAT(public_key, IsOk());
150
151 RestrictedData private_key_bytes =
152 RestrictedData((*key_pair)->private_key, InsecureSecretKeyAccess::Get());
153
154 util::StatusOr<Ed25519PrivateKey> private_key = Ed25519PrivateKey::Create(
155 *public_key, private_key_bytes, GetPartialKeyAccess());
156 ASSERT_THAT(private_key, IsOk());
157
158 util::StatusOr<Ed25519PrivateKey> other_private_key =
159 Ed25519PrivateKey::Create(*public_key, private_key_bytes,
160 GetPartialKeyAccess());
161 ASSERT_THAT(other_private_key, IsOk());
162
163 EXPECT_TRUE(*private_key == *other_private_key);
164 EXPECT_TRUE(*other_private_key == *private_key);
165 EXPECT_FALSE(*private_key != *other_private_key);
166 EXPECT_FALSE(*other_private_key != *private_key);
167 }
168
TEST(Ed25519PrivateKeyTest,DifferentPublicKeyNotEqual)169 TEST(Ed25519PrivateKeyTest, DifferentPublicKeyNotEqual) {
170 util::StatusOr<Ed25519Parameters> params =
171 Ed25519Parameters::Create(Ed25519Parameters::Variant::kTink);
172 ASSERT_THAT(params, IsOk());
173
174 util::StatusOr<std::unique_ptr<internal::Ed25519Key>> key_pair =
175 internal::NewEd25519Key();
176 ASSERT_THAT(key_pair, IsOk());
177
178 util::StatusOr<Ed25519PublicKey> public_key123 =
179 Ed25519PublicKey::Create(*params, (*key_pair)->public_key,
180 /*id_requirement=*/123, GetPartialKeyAccess());
181 ASSERT_THAT(public_key123, IsOk());
182
183 util::StatusOr<Ed25519PublicKey> public_key456 =
184 Ed25519PublicKey::Create(*params, (*key_pair)->public_key,
185 /*id_requirement=*/456, GetPartialKeyAccess());
186 ASSERT_THAT(public_key456, IsOk());
187
188 RestrictedData private_key_bytes =
189 RestrictedData((*key_pair)->private_key, InsecureSecretKeyAccess::Get());
190
191 util::StatusOr<Ed25519PrivateKey> private_key = Ed25519PrivateKey::Create(
192 *public_key123, private_key_bytes, GetPartialKeyAccess());
193 ASSERT_THAT(private_key, IsOk());
194
195 util::StatusOr<Ed25519PrivateKey> other_private_key =
196 Ed25519PrivateKey::Create(*public_key456, private_key_bytes,
197 GetPartialKeyAccess());
198 ASSERT_THAT(other_private_key, IsOk());
199
200 EXPECT_TRUE(*private_key != *other_private_key);
201 EXPECT_TRUE(*other_private_key != *private_key);
202 EXPECT_FALSE(*private_key == *other_private_key);
203 EXPECT_FALSE(*other_private_key == *private_key);
204 }
205
206 } // namespace
207 } // namespace tink
208 } // namespace crypto
209