// Copyright 2023 Google LLC // // 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/internal/configuration_impl.h" #include #include #include "gmock/gmock.h" #include "gtest/gtest.h" #include "absl/status/status.h" #include "tink/cleartext_keyset_handle.h" #include "tink/configuration.h" #include "tink/internal/keyset_wrapper_store.h" #include "tink/subtle/random.h" #include "tink/util/test_matchers.h" #include "tink/util/test_util.h" #include "proto/aes_gcm.pb.h" #include "proto/rsa_ssa_pss.pb.h" namespace crypto { namespace tink { namespace internal { namespace { using ::crypto::tink::test::IsOk; using ::crypto::tink::test::StatusIs; using ::google::crypto::tink::AesGcmKey; using ::google::crypto::tink::AesGcmKeyFormat; using ::google::crypto::tink::KeyData; using ::google::crypto::tink::Keyset; using ::google::crypto::tink::KeyStatusType; using ::google::crypto::tink::OutputPrefixType; using ::google::crypto::tink::RsaSsaPssKeyFormat; using ::google::crypto::tink::RsaSsaPssParams; using ::google::crypto::tink::RsaSsaPssPrivateKey; using ::google::crypto::tink::RsaSsaPssPublicKey; class FakePrimitive { public: explicit FakePrimitive(std::string s) : s_(s) {} std::string get() { return s_; } private: std::string s_; }; class FakePrimitive2 { public: explicit FakePrimitive2(std::string s) : s_(s) {} std::string get() { return s_ + "2"; } private: std::string s_; }; // Transforms AesGcmKey into FakePrimitive. class FakeKeyTypeManager : public KeyTypeManager> { public: class FakePrimitiveFactory : public PrimitiveFactory { public: util::StatusOr> Create( const AesGcmKey& key) const override { return absl::make_unique(key.key_value()); } }; FakeKeyTypeManager() : KeyTypeManager(absl::make_unique()) {} KeyData::KeyMaterialType key_material_type() const override { return KeyData::SYMMETRIC; } uint32_t get_version() const override { return 0; } const std::string& get_key_type() const override { return key_type_; } util::Status ValidateKey(const AesGcmKey& key) const override { return util::OkStatus(); } util::Status ValidateKeyFormat( const AesGcmKeyFormat& key_format) const override { return util::OkStatus(); } util::StatusOr CreateKey( const AesGcmKeyFormat& key_format) const override { return AesGcmKey(); } util::StatusOr DeriveKey( const AesGcmKeyFormat& key_format, InputStream* input_stream) const override { return AesGcmKey(); } private: const std::string key_type_ = "type.googleapis.com/google.crypto.tink.AesGcmKey"; }; // Transforms FakePrimitive into FakePrimitive. class FakePrimitiveWrapper : public PrimitiveWrapper { public: util::StatusOr> Wrap( std::unique_ptr> primitive_set) const override { return absl::make_unique( primitive_set->get_primary()->get_primitive().get()); } }; // Transforms FakePrimitive2 into FakePrimitive. class FakePrimitiveWrapper2 : public PrimitiveWrapper { public: util::StatusOr> Wrap( std::unique_ptr> primitive_set) const override { return absl::make_unique( primitive_set->get_primary()->get_primitive().get()); } }; std::string AddAesGcmKeyToKeyset(Keyset& keyset, uint32_t key_id, OutputPrefixType output_prefix_type, KeyStatusType key_status_type) { AesGcmKey key; key.set_version(0); key.set_key_value(subtle::Random::GetRandomBytes(16)); KeyData key_data; key_data.set_value(key.SerializeAsString()); key_data.set_type_url("type.googleapis.com/google.crypto.tink.AesGcmKey"); test::AddKeyData(key_data, key_id, output_prefix_type, key_status_type, &keyset); return key.key_value(); } TEST(ConfigurationImplTest, AddPrimitiveWrapper) { Configuration config; EXPECT_THAT((ConfigurationImpl::AddPrimitiveWrapper( absl::make_unique(), config)), IsOk()); } TEST(ConfigurationImplTest, AddKeyTypeManager) { Configuration config; EXPECT_THAT(ConfigurationImpl::AddKeyTypeManager( absl::make_unique(), config), IsOk()); } TEST(ConfigurationImplTest, GetKeyTypeInfoStore) { Configuration config; ASSERT_THAT(ConfigurationImpl::AddKeyTypeManager( absl::make_unique(), config), IsOk()); std::string type_url = FakeKeyTypeManager().get_key_type(); util::StatusOr store = ConfigurationImpl::GetKeyTypeInfoStore(config); ASSERT_THAT(store, IsOk()); util::StatusOr info = (*store)->Get(type_url); ASSERT_THAT(info, IsOk()); util::StatusOr*> key_manager = (*info)->get_key_manager(type_url); ASSERT_THAT(key_manager, IsOk()); EXPECT_EQ((*key_manager)->get_key_type(), type_url); } TEST(ConfigurationImplTest, GetKeyTypeInfoStoreMissingInfoFails) { Configuration config; util::StatusOr store = ConfigurationImpl::GetKeyTypeInfoStore(config); ASSERT_THAT(store, IsOk()); EXPECT_THAT((*store)->Get("i.do.not.exist").status(), StatusIs(absl::StatusCode::kNotFound)); } TEST(ConfigurationImplTest, GetKeysetWrapperStoreAndWrap) { Configuration config; ASSERT_THAT((ConfigurationImpl::AddPrimitiveWrapper( absl::make_unique(), config)), IsOk()); ASSERT_THAT(ConfigurationImpl::AddKeyTypeManager( absl::make_unique(), config), IsOk()); util::StatusOr store = ConfigurationImpl::GetKeysetWrapperStore(config); ASSERT_THAT(store, IsOk()); util::StatusOr*> wrapper = (*store)->Get(); ASSERT_THAT(wrapper, IsOk()); Keyset keyset; std::string raw_key = AddAesGcmKeyToKeyset( keyset, /*key_id=*/13, OutputPrefixType::TINK, KeyStatusType::ENABLED); keyset.set_primary_key_id(13); util::StatusOr> aead = (*wrapper)->Wrap(keyset, /*annotations=*/{}); ASSERT_THAT(aead, IsOk()); EXPECT_EQ((*aead)->get(), raw_key); } TEST(ConfigurationImplTest, KeysetWrapperWrapMissingKeyTypeInfoFails) { Configuration config; ASSERT_THAT(ConfigurationImpl::AddPrimitiveWrapper( absl::make_unique(), config), IsOk()); util::StatusOr store = ConfigurationImpl::GetKeysetWrapperStore(config); ASSERT_THAT(store, IsOk()); util::StatusOr*> wrapper = (*store)->Get(); ASSERT_THAT(wrapper, IsOk()); Keyset keyset; std::string raw_key = AddAesGcmKeyToKeyset( keyset, /*key_id=*/13, OutputPrefixType::TINK, KeyStatusType::ENABLED); keyset.set_primary_key_id(13); EXPECT_THAT((*wrapper)->Wrap(keyset, /*annotations=*/{}).status(), StatusIs(absl::StatusCode::kNotFound)); } TEST(ConfigurationImplTest, KeysetWrapperWrapMissingKeyManagerFails) { Configuration config; // Transforms FakePrimitive2 to FakePrimitive. ASSERT_THAT((ConfigurationImpl::AddPrimitiveWrapper( absl::make_unique(), config)), IsOk()); // Transforms KeyData to FakePrimitive. ASSERT_THAT(ConfigurationImpl::AddKeyTypeManager( absl::make_unique(), config), IsOk()); // AesGcmKey KeyData -> FakePrimitive2 -> FakePrimitive is the success path, // but the AesGcmKey KeyData -> FakePrimitive2 transformation is not // registered. util::StatusOr store = ConfigurationImpl::GetKeysetWrapperStore(config); ASSERT_THAT(store, IsOk()); util::StatusOr*> wrapper = (*store)->Get(); ASSERT_THAT(wrapper, IsOk()); Keyset keyset; std::string raw_key = AddAesGcmKeyToKeyset( keyset, /*key_id=*/13, OutputPrefixType::TINK, KeyStatusType::ENABLED); keyset.set_primary_key_id(13); // FakeKeyTypeManager cannot transform AesGcmKey KeyData -> FakePrimitive2. EXPECT_THAT((*wrapper)->Wrap(keyset, /*annotations=*/{}).status(), StatusIs(absl::StatusCode::kInvalidArgument)); } class FakeSignKeyManager : public PrivateKeyTypeManager> { public: class PublicKeySignFactory : public PrimitiveFactory { public: util::StatusOr> Create( const RsaSsaPssPrivateKey& key) const override { return {absl::make_unique("a public key sign")}; } }; explicit FakeSignKeyManager() : PrivateKeyTypeManager(absl::make_unique()) {} KeyData::KeyMaterialType key_material_type() const override { return KeyData::ASYMMETRIC_PRIVATE; } uint32_t get_version() const override { return 0; } const std::string& get_key_type() const override { return key_type_; } util::Status ValidateKey(const RsaSsaPssPrivateKey& key) const override { return util::OkStatus(); } util::Status ValidateKeyFormat( const RsaSsaPssKeyFormat& key_format) const override { return util::OkStatus(); } util::StatusOr CreateKey( const RsaSsaPssKeyFormat& key_format) const override { return RsaSsaPssPrivateKey(); } util::StatusOr DeriveKey( const RsaSsaPssKeyFormat& key_format, InputStream* input_stream) const override { return RsaSsaPssPrivateKey(); } util::StatusOr GetPublicKey( const RsaSsaPssPrivateKey& private_key) const override { return private_key.public_key(); } private: const std::string key_type_ = "some.sign.key.type"; }; class FakeVerifyKeyManager : public KeyTypeManager> { public: class PublicKeyVerifyFactory : public PrimitiveFactory { public: util::StatusOr> Create( const RsaSsaPssPublicKey& key) const override { return { absl::make_unique("a public key verify")}; } }; explicit FakeVerifyKeyManager() : KeyTypeManager(absl::make_unique()) {} KeyData::KeyMaterialType key_material_type() const override { return KeyData::ASYMMETRIC_PUBLIC; } uint32_t get_version() const override { return 0; } const std::string& get_key_type() const override { return key_type_; } util::Status ValidateKey(const RsaSsaPssPublicKey& key) const override { return util::OkStatus(); } util::Status ValidateParams(const RsaSsaPssParams& params) const { return util::OkStatus(); } private: const std::string key_type_ = "some.verify.key.type"; }; TEST(ConfigurationImplTest, AddAsymmetricKeyManagers) { Configuration config; EXPECT_THAT(ConfigurationImpl::AddAsymmetricKeyManagers( absl::make_unique(), absl::make_unique(), config), IsOk()); } TEST(ConfigurationImplTest, GetKeyTypeInfoStoreAsymmetric) { Configuration config; ASSERT_THAT(ConfigurationImpl::AddAsymmetricKeyManagers( absl::make_unique(), absl::make_unique(), config), IsOk()); { std::string type_url = FakeSignKeyManager().get_key_type(); util::StatusOr store = ConfigurationImpl::GetKeyTypeInfoStore(config); ASSERT_THAT(store, IsOk()); util::StatusOr info = (*store)->Get(type_url); ASSERT_THAT(info, IsOk()); util::StatusOr*> key_manager = (*info)->get_key_manager(type_url); ASSERT_THAT(key_manager, IsOk()); EXPECT_EQ((*key_manager)->get_key_type(), type_url); } { std::string type_url = FakeVerifyKeyManager().get_key_type(); util::StatusOr store = ConfigurationImpl::GetKeyTypeInfoStore(config); ASSERT_THAT(store, IsOk()); util::StatusOr info = (*store)->Get(type_url); ASSERT_THAT(info, IsOk()); util::StatusOr*> key_manager = (*info)->get_key_manager(type_url); ASSERT_THAT(key_manager, IsOk()); EXPECT_EQ((*key_manager)->get_key_type(), type_url); } } TEST(ConfigurationImplTest, GlobalRegistryMode) { Registry::Reset(); Configuration config; ASSERT_THAT(ConfigurationImpl::SetGlobalRegistryMode(config), IsOk()); EXPECT_TRUE(ConfigurationImpl::IsInGlobalRegistryMode(config)); // Check that ConfigurationImpl functions return kFailedPrecondition. EXPECT_THAT(ConfigurationImpl::AddPrimitiveWrapper( absl::make_unique(), config), StatusIs(absl::StatusCode::kFailedPrecondition)); EXPECT_THAT(ConfigurationImpl::AddKeyTypeManager( absl::make_unique(), config), StatusIs(absl::StatusCode::kFailedPrecondition)); EXPECT_THAT(ConfigurationImpl::AddAsymmetricKeyManagers( absl::make_unique(), absl::make_unique(), config), StatusIs(absl::StatusCode::kFailedPrecondition)); EXPECT_THAT(ConfigurationImpl::GetKeyTypeInfoStore(config).status(), StatusIs(absl::StatusCode::kFailedPrecondition)); EXPECT_THAT(ConfigurationImpl::GetKeysetWrapperStore(config).status(), StatusIs(absl::StatusCode::kFailedPrecondition)); Keyset keyset; std::string raw_key = AddAesGcmKeyToKeyset( keyset, /*key_id=*/13, OutputPrefixType::TINK, KeyStatusType::ENABLED); keyset.set_primary_key_id(13); std::unique_ptr handle = CleartextKeysetHandle::GetKeysetHandle(keyset); // TODO(b/265705174): Replace with GetPrimitive(config) once implemented. EXPECT_THAT(handle->GetPrimitive().status(), StatusIs(absl::StatusCode::kNotFound)); ASSERT_THAT(Registry::RegisterPrimitiveWrapper( absl::make_unique()), IsOk()); ASSERT_THAT( Registry::RegisterKeyTypeManager(absl::make_unique(), /*new_key_allowed=*/true), IsOk()); // TODO(b/265705174): Replace with GetPrimitive(config) once implemented. EXPECT_THAT(handle->GetPrimitive(), IsOk()); } TEST(ConfigurationImplTest, GlobalRegistryModeWithNonEmptyConfigFails) { Configuration config; ASSERT_THAT(ConfigurationImpl::AddPrimitiveWrapper( absl::make_unique(), config), IsOk()); EXPECT_THAT(ConfigurationImpl::SetGlobalRegistryMode(config), StatusIs(absl::StatusCode::kFailedPrecondition)); EXPECT_FALSE(ConfigurationImpl::IsInGlobalRegistryMode(config)); } } // namespace } // namespace internal } // namespace tink } // namespace crypto