1 // Copyright 2017 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/hybrid/hybrid_encrypt_wrapper.h"
18
19 #include <memory>
20 #include <string>
21 #include <utility>
22
23 #include "gmock/gmock.h"
24 #include "gtest/gtest.h"
25 #include "absl/status/status.h"
26 #include "tink/hybrid/failing_hybrid.h"
27 #include "tink/hybrid_encrypt.h"
28 #include "tink/internal/registry_impl.h"
29 #include "tink/monitoring/monitoring.h"
30 #include "tink/monitoring/monitoring_client_mocks.h"
31 #include "tink/primitive_set.h"
32 #include "tink/util/status.h"
33 #include "tink/util/test_matchers.h"
34 #include "tink/util/test_util.h"
35 #include "proto/tink.pb.h"
36
37 using ::crypto::tink::test::DummyHybridEncrypt;
38 using ::crypto::tink::test::IsOk;
39 using ::crypto::tink::test::IsOkAndHolds;
40 using ::crypto::tink::test::StatusIs;
41 using ::google::crypto::tink::KeysetInfo;
42 using ::google::crypto::tink::KeyStatusType;
43 using ::google::crypto::tink::OutputPrefixType;
44 using ::testing::_;
45 using ::testing::ByMove;
46 using ::testing::IsNull;
47 using ::testing::NiceMock;
48 using ::testing::Not;
49 using ::testing::NotNull;
50 using ::testing::Return;
51 using ::testing::Test;
52
53 namespace crypto {
54 namespace tink {
55 namespace {
56
57 class HybridEncryptSetWrapperTest : public ::testing::Test {
58 protected:
SetUp()59 void SetUp() override {
60 }
TearDown()61 void TearDown() override {
62 }
63 };
64
TEST_F(HybridEncryptSetWrapperTest,testBasic)65 TEST_F(HybridEncryptSetWrapperTest, testBasic) {
66 { // hybrid_encrypt_set is nullptr.
67 auto hybrid_encrypt_result =
68 HybridEncryptWrapper().Wrap(nullptr);
69 EXPECT_FALSE(hybrid_encrypt_result.ok());
70 EXPECT_EQ(absl::StatusCode::kInternal,
71 hybrid_encrypt_result.status().code());
72 EXPECT_PRED_FORMAT2(testing::IsSubstring, "non-NULL",
73 std::string(hybrid_encrypt_result.status().message()));
74 }
75
76 { // hybrid_encrypt_set has no primary primitive.
77 std::unique_ptr<PrimitiveSet<HybridEncrypt>>
78 hybrid_encrypt_set(new PrimitiveSet<HybridEncrypt>());
79 auto hybrid_encrypt_result = HybridEncryptWrapper().Wrap(
80 std::move(hybrid_encrypt_set));
81 EXPECT_FALSE(hybrid_encrypt_result.ok());
82 EXPECT_EQ(absl::StatusCode::kInvalidArgument,
83 hybrid_encrypt_result.status().code());
84 EXPECT_PRED_FORMAT2(testing::IsSubstring, "no primary",
85 std::string(hybrid_encrypt_result.status().message()));
86 }
87
88 { // Correct hybrid_encrypt_set;
89 KeysetInfo::KeyInfo* key_info;
90 KeysetInfo keyset_info;
91
92 uint32_t key_id_0 = 1234543;
93 key_info = keyset_info.add_key_info();
94 key_info->set_output_prefix_type(OutputPrefixType::TINK);
95 key_info->set_key_id(key_id_0);
96 key_info->set_status(KeyStatusType::ENABLED);
97
98 uint32_t key_id_1 = 726329;
99 key_info = keyset_info.add_key_info();
100 key_info->set_output_prefix_type(OutputPrefixType::LEGACY);
101 key_info->set_key_id(key_id_1);
102 key_info->set_status(KeyStatusType::ENABLED);
103
104 uint32_t key_id_2 = 7213743;
105 key_info = keyset_info.add_key_info();
106 key_info->set_output_prefix_type(OutputPrefixType::TINK);
107 key_info->set_key_id(key_id_2);
108 key_info->set_status(KeyStatusType::ENABLED);
109
110 std::string hybrid_name_0 = "hybrid_0";
111 std::string hybrid_name_1 = "hybrid_1";
112 std::string hybrid_name_2 = "hybrid_2";
113 std::unique_ptr<PrimitiveSet<HybridEncrypt>> hybrid_encrypt_set(
114 new PrimitiveSet<HybridEncrypt>());
115 std::unique_ptr<HybridEncrypt> hybrid_encrypt(
116 new DummyHybridEncrypt(hybrid_name_0));
117 auto entry_result = hybrid_encrypt_set->AddPrimitive(
118 std::move(hybrid_encrypt), keyset_info.key_info(0));
119 ASSERT_TRUE(entry_result.ok());
120 hybrid_encrypt.reset(new DummyHybridEncrypt(hybrid_name_1));
121 entry_result = hybrid_encrypt_set->AddPrimitive(std::move(hybrid_encrypt),
122 keyset_info.key_info(1));
123 ASSERT_TRUE(entry_result.ok());
124 hybrid_encrypt.reset(new DummyHybridEncrypt(hybrid_name_2));
125 entry_result = hybrid_encrypt_set->AddPrimitive(std::move(hybrid_encrypt),
126 keyset_info.key_info(2));
127 ASSERT_TRUE(entry_result.ok());
128 // The last key is the primary.
129 ASSERT_THAT(hybrid_encrypt_set->set_primary(entry_result.value()), IsOk());
130
131 // Wrap hybrid_encrypt_set and test the resulting HybridEncrypt.
132 auto hybrid_encrypt_result = HybridEncryptWrapper().Wrap(
133 std::move(hybrid_encrypt_set));
134 EXPECT_TRUE(hybrid_encrypt_result.ok()) << hybrid_encrypt_result.status();
135 hybrid_encrypt = std::move(hybrid_encrypt_result.value());
136 std::string plaintext = "some_plaintext";
137 std::string context_info = "some_context";
138
139 auto encrypt_result = hybrid_encrypt->Encrypt(plaintext, context_info);
140 EXPECT_TRUE(encrypt_result.ok()) << encrypt_result.status();
141 std::string ciphertext = encrypt_result.value();
142 EXPECT_PRED_FORMAT2(testing::IsSubstring,
143 hybrid_name_2, ciphertext);
144 }
145 }
146
PopulateKeyInfo(uint32_t key_id,OutputPrefixType out_prefix_type,KeyStatusType status)147 KeysetInfo::KeyInfo PopulateKeyInfo(uint32_t key_id,
148 OutputPrefixType out_prefix_type,
149 KeyStatusType status) {
150 KeysetInfo::KeyInfo key_info;
151 key_info.set_output_prefix_type(out_prefix_type);
152 key_info.set_key_id(key_id);
153 key_info.set_status(status);
154 return key_info;
155 }
156
157 // Creates a test keyset info object.
CreateTestKeysetInfo()158 KeysetInfo CreateTestKeysetInfo() {
159 KeysetInfo keyset_info;
160 *keyset_info.add_key_info() =
161 PopulateKeyInfo(/*key_id=*/1234543, OutputPrefixType::TINK,
162 /*status=*/KeyStatusType::ENABLED);
163 *keyset_info.add_key_info() =
164 PopulateKeyInfo(/*key_id=*/726329, OutputPrefixType::LEGACY,
165 /*status=*/KeyStatusType::ENABLED);
166 *keyset_info.add_key_info() =
167 PopulateKeyInfo(/*key_id=*/7213743, OutputPrefixType::TINK,
168 /*status=*/KeyStatusType::ENABLED);
169 return keyset_info;
170 }
171
172 // Tests for the monitoring behavior.
173 class HybridEncryptSetWrapperWithMonitoringTest : public Test {
174 protected:
175 // Perform some common initialization: reset the global registry, set expected
176 // calls for the mock monitoring factory and the returned clients.
SetUp()177 void SetUp() override {
178 Registry::Reset();
179
180 // Setup mocks for catching Monitoring calls.
181 auto monitoring_client_factory =
182 absl::make_unique<MockMonitoringClientFactory>();
183 auto encryption_monitoring_client =
184 absl::make_unique<NiceMock<MockMonitoringClient>>();
185 encryption_monitoring_client_ = encryption_monitoring_client.get();
186
187 // Monitoring tests expect that the client factory will create the
188 // corresponding MockMonitoringClients.
189 EXPECT_CALL(*monitoring_client_factory, New(_))
190 .WillOnce(
191 Return(ByMove(util::StatusOr<std::unique_ptr<MonitoringClient>>(
192 std::move(encryption_monitoring_client)))));
193
194 ASSERT_THAT(internal::RegistryImpl::GlobalInstance()
195 .RegisterMonitoringClientFactory(
196 std::move(monitoring_client_factory)),
197 IsOk());
198 ASSERT_THAT(
199 internal::RegistryImpl::GlobalInstance().GetMonitoringClientFactory(),
200 Not(IsNull()));
201 }
202
203 // Cleanup the registry to avoid mock leaks.
~HybridEncryptSetWrapperWithMonitoringTest()204 ~HybridEncryptSetWrapperWithMonitoringTest() override { Registry::Reset(); }
205
206 MockMonitoringClient* encryption_monitoring_client_;
207 };
208
209 // Test that successful encrypt operations are logged.
TEST_F(HybridEncryptSetWrapperWithMonitoringTest,WrapKeysetWithMonitoringEncryptSuccess)210 TEST_F(HybridEncryptSetWrapperWithMonitoringTest,
211 WrapKeysetWithMonitoringEncryptSuccess) {
212 // Create a primitive set and fill it with some entries
213 KeysetInfo keyset_info = CreateTestKeysetInfo();
214 const absl::flat_hash_map<std::string, std::string> annotations = {
215 {"key1", "value1"}, {"key2", "value2"}, {"key3", "value3"}};
216 auto hybrid_encrypt_primitive_set =
217 absl::make_unique<PrimitiveSet<HybridEncrypt>>(annotations);
218 ASSERT_THAT(
219 hybrid_encrypt_primitive_set
220 ->AddPrimitive(absl::make_unique<DummyHybridEncrypt>("hybrid0"),
221 keyset_info.key_info(0))
222 , IsOk());
223 ASSERT_THAT(
224 hybrid_encrypt_primitive_set
225 ->AddPrimitive(absl::make_unique<DummyHybridEncrypt>("hybrid1"),
226 keyset_info.key_info(1))
227 , IsOk());
228 // Set the last as primary.
229 util::StatusOr<PrimitiveSet<HybridEncrypt>::Entry<HybridEncrypt>*>
230 last = hybrid_encrypt_primitive_set->AddPrimitive(
231 absl::make_unique<DummyHybridEncrypt>("hybrid2"),
232 keyset_info.key_info(2));
233 ASSERT_THAT(last, IsOk());
234 ASSERT_THAT(hybrid_encrypt_primitive_set->set_primary(*last), IsOk());
235 // Record the ID of the primary key.
236 const uint32_t primary_key_id = keyset_info.key_info(2).key_id();
237
238 // Create a Hybrid Encrypt and encrypt some data.
239 util::StatusOr<std::unique_ptr<HybridEncrypt>> hybrid_encrypt =
240 HybridEncryptWrapper().Wrap(std::move(hybrid_encrypt_primitive_set));
241 ASSERT_THAT(hybrid_encrypt, IsOkAndHolds(NotNull()));
242
243 constexpr absl::string_view plaintext = "This is some plaintext!";
244 constexpr absl::string_view context = "Some context!";
245
246 // Check that calling Encrypt triggers a Log() call.
247 EXPECT_CALL(*encryption_monitoring_client_,
248 Log(primary_key_id, plaintext.size()));
249 util::StatusOr<std::string> ciphertext =
250 (*hybrid_encrypt)->Encrypt(plaintext, context);
251 EXPECT_THAT(ciphertext, IsOk());
252 }
253
TEST_F(HybridEncryptSetWrapperWithMonitoringTest,WrapKeysetWithMonitoringEncryptFailures)254 TEST_F(HybridEncryptSetWrapperWithMonitoringTest,
255 WrapKeysetWithMonitoringEncryptFailures) {
256 // Create a primitive set and fill it with some entries
257 KeysetInfo keyset_info = CreateTestKeysetInfo();
258 const absl::flat_hash_map<std::string, std::string> annotations = {
259 {"key1", "value1"}, {"key2", "value2"}, {"key3", "value3"}};
260 auto hybrid_encrypt_primitive_set =
261 absl::make_unique<PrimitiveSet<HybridEncrypt>>(annotations);
262 ASSERT_THAT(hybrid_encrypt_primitive_set
263 ->AddPrimitive(CreateAlwaysFailingHybridEncrypt("hybrid0"),
264 keyset_info.key_info(0))
265 .status(),
266 IsOk());
267 ASSERT_THAT(hybrid_encrypt_primitive_set
268 ->AddPrimitive(CreateAlwaysFailingHybridEncrypt("hybrid1"),
269 keyset_info.key_info(1))
270 .status(),
271 IsOk());
272 // Set the last as primary.
273 util::StatusOr<PrimitiveSet<HybridEncrypt>::Entry<HybridEncrypt>*> last =
274 hybrid_encrypt_primitive_set->AddPrimitive(
275 CreateAlwaysFailingHybridEncrypt("hybrid2"), keyset_info.key_info(2));
276 ASSERT_THAT(last, IsOkAndHolds(NotNull()));
277 ASSERT_THAT(hybrid_encrypt_primitive_set->set_primary(*last), IsOk());
278
279
280 // Create a Hybrid Encrypt and encrypt some data.
281 util::StatusOr<std::unique_ptr<HybridEncrypt>> hybrid_encrypt =
282 HybridEncryptWrapper().Wrap(std::move(hybrid_encrypt_primitive_set));
283 ASSERT_THAT(hybrid_encrypt, IsOk());
284
285 constexpr absl::string_view plaintext = "This is some plaintext!";
286 constexpr absl::string_view context = "Some context!";
287
288 // Check that calling Encrypt triggers a LogFailure() call.
289 EXPECT_CALL(*encryption_monitoring_client_, LogFailure());
290 util::StatusOr<std::string> ciphertext =
291 (*hybrid_encrypt)->Encrypt(plaintext, context);
292 EXPECT_THAT(ciphertext.status(),
293 StatusIs(absl::StatusCode::kInternal));
294 }
295
296 } // namespace
297 } // namespace tink
298 } // namespace crypto
299