| // Copyright 2017 Google Inc. |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| // |
| //////////////////////////////////////////////////////////////////////////////// |
| |
| #include "tink/primitive_set.h" |
| |
| #include <thread> // NOLINT(build/c++11) |
| |
| #include "gtest/gtest.h" |
| #include "tink/crypto_format.h" |
| #include "tink/mac.h" |
| #include "tink/util/test_matchers.h" |
| #include "tink/util/test_util.h" |
| #include "proto/tink.pb.h" |
| |
| using ::crypto::tink::test::DummyMac; |
| using ::google::crypto::tink::Keyset; |
| using ::google::crypto::tink::KeyStatusType; |
| using ::google::crypto::tink::OutputPrefixType; |
| using ::crypto::tink::test::IsOk; |
| |
| namespace crypto { |
| namespace tink { |
| namespace { |
| |
| class PrimitiveSetTest : public ::testing::Test { |
| }; |
| |
| void add_primitives(PrimitiveSet<Mac>* primitive_set, |
| int key_id_offset, |
| int primitives_count) { |
| for (int i = 0; i < primitives_count; i++) { |
| int key_id = key_id_offset + i; |
| Keyset::Key key; |
| key.set_output_prefix_type(OutputPrefixType::TINK); |
| key.set_key_id(key_id); |
| key.set_status(KeyStatusType::ENABLED); |
| std::unique_ptr<Mac> mac(new DummyMac("dummy MAC")); |
| auto add_result = primitive_set->AddPrimitive(std::move(mac), key); |
| EXPECT_TRUE(add_result.ok()) << add_result.status(); |
| } |
| } |
| |
| void access_primitives(PrimitiveSet<Mac>* primitive_set, |
| int key_id_offset, |
| int primitives_count) { |
| for (int i = 0; i < primitives_count; i++) { |
| int key_id = key_id_offset + i; |
| Keyset::Key key; |
| key.set_output_prefix_type(OutputPrefixType::TINK); |
| key.set_key_id(key_id); |
| key.set_status(KeyStatusType::ENABLED); |
| std::string prefix = CryptoFormat::get_output_prefix(key).ValueOrDie(); |
| auto get_result = primitive_set->get_primitives(prefix); |
| EXPECT_TRUE(get_result.ok()) << get_result.status(); |
| EXPECT_GE(get_result.ValueOrDie()->size(), 1); |
| } |
| } |
| |
| TEST_F(PrimitiveSetTest, ConcurrentOperations) { |
| PrimitiveSet<Mac> mac_set; |
| int offset_a = 100; |
| int offset_b = 150; |
| int count = 100; |
| |
| // Add some primitives. |
| std::thread add_primitives_a(add_primitives, &mac_set, offset_a, count); |
| std::thread add_primitives_b(add_primitives, &mac_set, offset_b, count); |
| add_primitives_a.join(); |
| add_primitives_b.join(); |
| |
| // Access primitives. |
| std::thread access_primitives_a(access_primitives, &mac_set, offset_a, count); |
| std::thread access_primitives_b(access_primitives, &mac_set, offset_b, count); |
| access_primitives_a.join(); |
| access_primitives_b.join(); |
| |
| // Verify the common key ids added by both threads. |
| for (int key_id = offset_a; key_id < offset_b + count; key_id++) { |
| Keyset::Key key; |
| key.set_output_prefix_type(OutputPrefixType::TINK); |
| key.set_key_id(key_id); |
| key.set_status(KeyStatusType::ENABLED); |
| std::string prefix = CryptoFormat::get_output_prefix(key).ValueOrDie(); |
| auto get_result = mac_set.get_primitives(prefix); |
| EXPECT_TRUE(get_result.ok()) << get_result.status(); |
| auto macs = get_result.ValueOrDie(); |
| if (key_id >= offset_b && key_id < offset_a + count) { |
| EXPECT_EQ(2, macs->size()); // overlapping key_id range |
| } else { |
| EXPECT_EQ(1, macs->size()); |
| } |
| } |
| } |
| |
| TEST_F(PrimitiveSetTest, Basic) { |
| std::string mac_name_1 = "MAC#1"; |
| std::unique_ptr<Mac> mac_1(new DummyMac(mac_name_1)); |
| std::string mac_name_2 = "MAC#2"; |
| std::unique_ptr<Mac> mac_2(new DummyMac(mac_name_2)); |
| std::string mac_name_3 = "MAC#3"; |
| std::unique_ptr<Mac> mac_3(new DummyMac(mac_name_3)); |
| std::string mac_name_4 = "MAC#3"; |
| std::unique_ptr<Mac> mac_4(new DummyMac(mac_name_4)); |
| std::string mac_name_5 = "MAC#3"; |
| std::unique_ptr<Mac> mac_5(new DummyMac(mac_name_5)); |
| std::string mac_name_6 = "MAC#3"; |
| std::unique_ptr<Mac> mac_6(new DummyMac(mac_name_6)); |
| |
| uint32_t key_id_1 = 1234543; |
| Keyset::Key key_1; |
| key_1.set_output_prefix_type(OutputPrefixType::TINK); |
| key_1.set_key_id(key_id_1); |
| key_1.set_status(KeyStatusType::ENABLED); |
| |
| uint32_t key_id_2 = 7213743; |
| Keyset::Key key_2; |
| key_2.set_output_prefix_type(OutputPrefixType::LEGACY); |
| key_2.set_key_id(key_id_2); |
| key_2.set_status(KeyStatusType::ENABLED); |
| |
| uint32_t key_id_3 = key_id_2; // same id as key_2 |
| Keyset::Key key_3; |
| key_3.set_output_prefix_type(OutputPrefixType::TINK); |
| key_3.set_key_id(key_id_3); |
| key_3.set_status(KeyStatusType::ENABLED); |
| |
| uint32_t key_id_4 = 947327; |
| Keyset::Key key_4; |
| key_4.set_output_prefix_type(OutputPrefixType::RAW); |
| key_4.set_key_id(key_id_4); |
| key_4.set_status(KeyStatusType::ENABLED); |
| |
| uint32_t key_id_5 = 529472; |
| Keyset::Key key_5; |
| key_5.set_output_prefix_type(OutputPrefixType::RAW); |
| key_5.set_key_id(key_id_5); |
| key_5.set_status(KeyStatusType::ENABLED); |
| |
| uint32_t key_id_6 = key_id_1; // same id as key_1 |
| Keyset::Key key_6; |
| key_6.set_output_prefix_type(OutputPrefixType::TINK); |
| key_6.set_key_id(key_id_6); |
| key_6.set_status(KeyStatusType::ENABLED); |
| |
| PrimitiveSet<Mac> primitive_set; |
| EXPECT_TRUE(primitive_set.get_primary() == nullptr); |
| EXPECT_EQ(util::error::NOT_FOUND, |
| primitive_set.get_raw_primitives().status().error_code()); |
| EXPECT_EQ(util::error::NOT_FOUND, |
| primitive_set.get_primitives("prefix").status().error_code()); |
| |
| // Add all the primitives. |
| auto add_primitive_result = |
| primitive_set.AddPrimitive(std::move(mac_1), key_1); |
| EXPECT_TRUE(add_primitive_result.ok()) << add_primitive_result.status(); |
| |
| add_primitive_result = primitive_set.AddPrimitive(std::move(mac_2), key_2); |
| EXPECT_TRUE(add_primitive_result.ok()) << add_primitive_result.status(); |
| |
| add_primitive_result = primitive_set.AddPrimitive(std::move(mac_3), key_3); |
| EXPECT_TRUE(add_primitive_result.ok()) << add_primitive_result.status(); |
| EXPECT_THAT(primitive_set.set_primary(add_primitive_result.ValueOrDie()), |
| IsOk()); |
| |
| add_primitive_result = primitive_set.AddPrimitive(std::move(mac_4), key_4); |
| EXPECT_TRUE(add_primitive_result.ok()) << add_primitive_result.status(); |
| |
| add_primitive_result = primitive_set.AddPrimitive(std::move(mac_5), key_5); |
| EXPECT_TRUE(add_primitive_result.ok()) << add_primitive_result.status(); |
| |
| add_primitive_result = primitive_set.AddPrimitive(std::move(mac_6), key_6); |
| EXPECT_TRUE(add_primitive_result.ok()) << add_primitive_result.status(); |
| |
| // Try adding a "consumed" unique_ptr as a primitive. |
| add_primitive_result = primitive_set.AddPrimitive(std::move(mac_6), key_6); |
| EXPECT_FALSE(add_primitive_result.ok()); |
| EXPECT_EQ(util::error::INVALID_ARGUMENT, |
| add_primitive_result.status().error_code()); |
| |
| |
| std::string data = "some data"; |
| |
| { // Check the primary. |
| auto primary = primitive_set.get_primary(); |
| EXPECT_FALSE(primary == nullptr); |
| EXPECT_EQ(KeyStatusType::ENABLED, primary->get_status()); |
| EXPECT_EQ(DummyMac(mac_name_3).ComputeMac(data).ValueOrDie(), |
| primary->get_primitive().ComputeMac(data).ValueOrDie()); |
| } |
| |
| { // Check raw primitives. |
| auto& primitives = *(primitive_set.get_raw_primitives().ValueOrDie()); |
| EXPECT_EQ(2, primitives.size()); |
| EXPECT_EQ(DummyMac(mac_name_4).ComputeMac(data).ValueOrDie(), |
| primitives[0]->get_primitive().ComputeMac(data).ValueOrDie()); |
| EXPECT_EQ(KeyStatusType::ENABLED, primitives[0]->get_status()); |
| EXPECT_EQ(OutputPrefixType::RAW, primitives[0]->get_output_prefix_type()); |
| EXPECT_EQ(DummyMac(mac_name_5).ComputeMac(data).ValueOrDie(), |
| primitives[1]->get_primitive().ComputeMac(data).ValueOrDie()); |
| EXPECT_EQ(KeyStatusType::ENABLED, primitives[1]->get_status()); |
| EXPECT_EQ(OutputPrefixType::RAW, primitives[1]->get_output_prefix_type()); |
| } |
| |
| { // Check Tink primitives. |
| std::string prefix = CryptoFormat::get_output_prefix(key_1).ValueOrDie(); |
| auto& primitives = *(primitive_set.get_primitives(prefix).ValueOrDie()); |
| EXPECT_EQ(2, primitives.size()); |
| EXPECT_EQ(DummyMac(mac_name_1).ComputeMac(data).ValueOrDie(), |
| primitives[0]->get_primitive().ComputeMac(data).ValueOrDie()); |
| EXPECT_EQ(KeyStatusType::ENABLED, primitives[0]->get_status()); |
| EXPECT_EQ(OutputPrefixType::TINK, primitives[0]->get_output_prefix_type()); |
| EXPECT_EQ(DummyMac(mac_name_6).ComputeMac(data).ValueOrDie(), |
| primitives[1]->get_primitive().ComputeMac(data).ValueOrDie()); |
| EXPECT_EQ(KeyStatusType::ENABLED, primitives[1]->get_status()); |
| EXPECT_EQ(OutputPrefixType::TINK, primitives[1]->get_output_prefix_type()); |
| } |
| |
| { // Check another Tink primitive. |
| std::string prefix = CryptoFormat::get_output_prefix(key_3).ValueOrDie(); |
| auto& primitives = *(primitive_set.get_primitives(prefix).ValueOrDie()); |
| EXPECT_EQ(1, primitives.size()); |
| EXPECT_EQ(DummyMac(mac_name_3).ComputeMac(data).ValueOrDie(), |
| primitives[0]->get_primitive().ComputeMac(data).ValueOrDie()); |
| EXPECT_EQ(KeyStatusType::ENABLED, primitives[0]->get_status()); |
| EXPECT_EQ(OutputPrefixType::TINK, primitives[0]->get_output_prefix_type()); |
| } |
| |
| { // Check legacy primitive. |
| std::string prefix = CryptoFormat::get_output_prefix(key_2).ValueOrDie(); |
| auto& primitives = *(primitive_set.get_primitives(prefix).ValueOrDie()); |
| EXPECT_EQ(1, primitives.size()); |
| EXPECT_EQ(DummyMac(mac_name_2).ComputeMac(data).ValueOrDie(), |
| primitives[0]->get_primitive().ComputeMac(data).ValueOrDie()); |
| EXPECT_EQ(KeyStatusType::ENABLED, primitives[0]->get_status()); |
| EXPECT_EQ(OutputPrefixType::LEGACY, |
| primitives[0]->get_output_prefix_type()); |
| } |
| } |
| |
| TEST_F(PrimitiveSetTest, PrimaryKeyWithIdCollisions) { |
| std::string mac_name_1 = "MAC#1"; |
| std::string mac_name_2 = "MAC#2"; |
| |
| uint32_t key_id_1 = 1234543; |
| Keyset::Key key_1; |
| key_1.set_key_id(key_id_1); |
| key_1.set_status(KeyStatusType::ENABLED); |
| |
| uint32_t key_id_2 = key_id_1; // same id as key_2 |
| Keyset::Key key_2; |
| key_2.set_key_id(key_id_2); |
| key_2.set_status(KeyStatusType::ENABLED); |
| |
| { // Test with RAW-keys. |
| std::unique_ptr<Mac> mac_1(new DummyMac(mac_name_1)); |
| std::unique_ptr<Mac> mac_2(new DummyMac(mac_name_2)); |
| key_1.set_output_prefix_type(OutputPrefixType::RAW); |
| key_2.set_output_prefix_type(OutputPrefixType::RAW); |
| PrimitiveSet<Mac> primitive_set; |
| EXPECT_TRUE(primitive_set.get_primary() == nullptr); |
| |
| // Add the first primitive, and set it as primary. |
| auto add_primitive_result = |
| primitive_set.AddPrimitive(std::move(mac_1), key_1); |
| EXPECT_TRUE(add_primitive_result.ok()) << add_primitive_result.status(); |
| ASSERT_THAT(primitive_set.set_primary(add_primitive_result.ValueOrDie()), |
| IsOk()); |
| |
| std::string identifier = ""; |
| const auto& primitives = |
| *(primitive_set.get_primitives(identifier).ValueOrDie()); |
| EXPECT_EQ(1, primitives.size()); |
| EXPECT_EQ(primitive_set.get_primary(), primitives[0].get()); |
| |
| // Adding another primitive should not invalidate the primary. |
| add_primitive_result = primitive_set.AddPrimitive(std::move(mac_2), key_2); |
| EXPECT_TRUE(add_primitive_result.ok()) << add_primitive_result.status(); |
| EXPECT_EQ(2, primitives.size()); |
| EXPECT_EQ(primitive_set.get_primary(), primitives[0].get()); |
| } |
| |
| { // Test with TINK-keys. |
| std::unique_ptr<Mac> mac_1(new DummyMac(mac_name_1)); |
| std::unique_ptr<Mac> mac_2(new DummyMac(mac_name_2)); |
| key_1.set_output_prefix_type(OutputPrefixType::TINK); |
| key_2.set_output_prefix_type(OutputPrefixType::TINK); |
| PrimitiveSet<Mac> primitive_set; |
| EXPECT_TRUE(primitive_set.get_primary() == nullptr); |
| |
| // Add the first primitive, and set it as primary. |
| auto add_primitive_result = |
| primitive_set.AddPrimitive(std::move(mac_1), key_1); |
| EXPECT_TRUE(add_primitive_result.ok()) << add_primitive_result.status(); |
| ASSERT_THAT(primitive_set.set_primary(add_primitive_result.ValueOrDie()), |
| IsOk()); |
| |
| std::string identifier = CryptoFormat::get_output_prefix(key_1).ValueOrDie(); |
| const auto& primitives = |
| *(primitive_set.get_primitives(identifier).ValueOrDie()); |
| EXPECT_EQ(1, primitives.size()); |
| EXPECT_EQ(primitive_set.get_primary(), primitives[0].get()); |
| |
| // Adding another primitive should not invalidate the primary. |
| add_primitive_result = primitive_set.AddPrimitive(std::move(mac_2), key_2); |
| EXPECT_TRUE(add_primitive_result.ok()) << add_primitive_result.status(); |
| EXPECT_EQ(2, primitives.size()); |
| EXPECT_EQ(primitive_set.get_primary(), primitives[0].get()); |
| } |
| |
| { // Test with LEGACY-keys. |
| std::unique_ptr<Mac> mac_1(new DummyMac(mac_name_1)); |
| std::unique_ptr<Mac> mac_2(new DummyMac(mac_name_2)); |
| key_1.set_output_prefix_type(OutputPrefixType::LEGACY); |
| key_2.set_output_prefix_type(OutputPrefixType::LEGACY); |
| PrimitiveSet<Mac> primitive_set; |
| EXPECT_TRUE(primitive_set.get_primary() == nullptr); |
| |
| // Add the first primitive, and set it as primary. |
| auto add_primitive_result = |
| primitive_set.AddPrimitive(std::move(mac_1), key_1); |
| EXPECT_TRUE(add_primitive_result.ok()) << add_primitive_result.status(); |
| ASSERT_THAT(primitive_set.set_primary(add_primitive_result.ValueOrDie()), |
| IsOk()); |
| |
| std::string identifier = CryptoFormat::get_output_prefix(key_1).ValueOrDie(); |
| const auto& primitives = |
| *(primitive_set.get_primitives(identifier).ValueOrDie()); |
| EXPECT_EQ(1, primitives.size()); |
| EXPECT_EQ(primitive_set.get_primary(), primitives[0].get()); |
| |
| // Adding another primitive should not invalidate the primary. |
| add_primitive_result = primitive_set.AddPrimitive(std::move(mac_2), key_2); |
| EXPECT_TRUE(add_primitive_result.ok()) << add_primitive_result.status(); |
| EXPECT_EQ(2, primitives.size()); |
| EXPECT_EQ(primitive_set.get_primary(), primitives[0].get()); |
| } |
| } |
| |
| TEST_F(PrimitiveSetTest, DisabledKey) { |
| std::string mac_name_1 = "MAC#1"; |
| std::unique_ptr<Mac> mac_1(new DummyMac(mac_name_1)); |
| |
| uint32_t key_id_1 = 1234543; |
| Keyset::Key key_1; |
| key_1.set_output_prefix_type(OutputPrefixType::TINK); |
| key_1.set_key_id(key_id_1); |
| key_1.set_status(KeyStatusType::DISABLED); |
| |
| PrimitiveSet<Mac> primitive_set; |
| // Add all the primitives. |
| auto add_primitive_result = |
| primitive_set.AddPrimitive(std::move(mac_1), key_1); |
| EXPECT_FALSE(add_primitive_result.ok()); |
| } |
| |
| } // namespace |
| } // namespace tink |
| } // namespace crypto |