This repository has been archived by the owner on Apr 17, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Extract primitive wrapper storage out of RegistryImpl and into its ow…
…n class. PiperOrigin-RevId: 533275266
- Loading branch information
1 parent
4066a2f
commit e75ea13
Showing
6 changed files
with
694 additions
and
145 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,206 @@ | ||
| // Copyright 2018 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. | ||
| // | ||
| /////////////////////////////////////////////////////////////////////////////// | ||
|
|
||
| #ifndef TINK_INTERNAL_KEYSET_WRAPPER_STORE_H_ | ||
| #define TINK_INTERNAL_KEYSET_WRAPPER_STORE_H_ | ||
|
|
||
| #include <memory> | ||
| #include <typeindex> | ||
|
|
||
| #include "tink/internal/keyset_wrapper.h" | ||
| #include "tink/internal/keyset_wrapper_impl.h" | ||
| #include "tink/primitive_wrapper.h" | ||
| #include "tink/util/status.h" | ||
| #include "tink/util/statusor.h" | ||
|
|
||
| namespace crypto { | ||
| namespace tink { | ||
| namespace internal { | ||
|
|
||
| // Stores KeysetWrappers constructed from their PrimitiveWrapper. This is used | ||
| // by the Configuration and Registry classes. | ||
| // | ||
| // Once inserted, elements in Info, which include the PrimitiveWrapper, must not | ||
| // be replaced. | ||
| // | ||
| // Example: | ||
| // KeysetWrapperStore store; | ||
| // crypto::tink::util::Status status = store.Add<Aead, Aead>( | ||
| // absl::make_unique<AeadWrapper>(), primitive_getter); | ||
| // crypto::tink::util::StatusOr<const KeysetWrapper<Aead>*> wrapper = | ||
| // store.Get<Aead>(); | ||
| class KeysetWrapperStore { | ||
| public: | ||
| KeysetWrapperStore() = default; | ||
|
|
||
| // Movable, but not copyable. | ||
| KeysetWrapperStore(KeysetWrapperStore&& other) = default; | ||
| KeysetWrapperStore& operator=(KeysetWrapperStore&& other) = default; | ||
|
|
||
| // Adds a crypto::tink::PrimitiveWrapper and `primitive_getter` function to | ||
| // KeysetWrapperStore. | ||
| template <class P, class Q> | ||
| crypto::tink::util::Status Add( | ||
| std::unique_ptr<PrimitiveWrapper<P, Q>> wrapper, | ||
| std::function<crypto::tink::util::StatusOr<std::unique_ptr<P>>( | ||
| const google::crypto::tink::KeyData& key_data)> | ||
| primitive_getter); | ||
|
|
||
| // Gets the PrimitiveWrapper that produces primitive P. This is a legacy | ||
| // function. | ||
| template <class P> | ||
| crypto::tink::util::StatusOr<const PrimitiveWrapper<P, P>*> | ||
| GetPrimitiveWrapper() const; | ||
|
|
||
| // Gets the KeysetWrapper that produces primitive Q. | ||
| template <class Q> | ||
| crypto::tink::util::StatusOr<const KeysetWrapper<Q>*> Get() const; | ||
|
|
||
| private: | ||
| class Info { | ||
| public: | ||
| template <typename P, typename Q> | ||
| explicit Info( | ||
| std::unique_ptr<PrimitiveWrapper<P, Q>> wrapper, | ||
| std::function<crypto::tink::util::StatusOr<std::unique_ptr<P>>( | ||
| const google::crypto::tink::KeyData& key_data)> | ||
| primitive_getter) | ||
| : is_same_primitive_wrapping_(std::is_same<P, Q>::value), | ||
| wrapper_type_index_(std::type_index(typeid(*wrapper))), | ||
| q_type_index_(std::type_index(typeid(Q))) { | ||
| keyset_wrapper_ = absl::make_unique<KeysetWrapperImpl<P, Q>>( | ||
| wrapper.get(), primitive_getter); | ||
| original_wrapper_ = std::move(wrapper); | ||
| } | ||
|
|
||
| template <typename Q> | ||
| crypto::tink::util::StatusOr<const KeysetWrapper<Q>*> Get() const { | ||
| if (q_type_index_ != std::type_index(typeid(Q))) { | ||
| return crypto::tink::util::Status( | ||
| absl::StatusCode::kInternal, | ||
| "RegistryImpl::KeysetWrapper() called with wrong type"); | ||
| } | ||
| return static_cast<KeysetWrapper<Q>*>(keyset_wrapper_.get()); | ||
| } | ||
|
|
||
| // TODO(b/171021679): Deprecate this and upstream functions. | ||
| template <typename P> | ||
| crypto::tink::util::StatusOr<const PrimitiveWrapper<P, P>*> | ||
| GetPrimitiveWrapper() const { | ||
| if (!is_same_primitive_wrapping_) { | ||
| // This happens if a user uses a legacy method (like Registry::Wrap) | ||
| // directly or has a custom key manager for a primitive which has a | ||
| // PrimitiveWrapper<P,Q> with P != Q. | ||
| return crypto::tink::util::Status( | ||
| absl::StatusCode::kFailedPrecondition, | ||
| absl::StrCat("Cannot use primitive type ", typeid(P).name(), | ||
| " with a custom key manager.")); | ||
| } | ||
| if (q_type_index_ != std::type_index(typeid(P))) { | ||
| return crypto::tink::util::Status( | ||
| absl::StatusCode::kInternal, | ||
| "RegistryImpl::LegacyWrapper() called with wrong type"); | ||
| } | ||
| return static_cast<const PrimitiveWrapper<P, P>*>( | ||
| original_wrapper_.get()); | ||
| } | ||
|
|
||
| // Returns true if the PrimitiveWrapper is the same class as the one used | ||
| // to construct this Info. | ||
| template <typename P, typename Q> | ||
| bool HasSameType(const PrimitiveWrapper<P, Q>& wrapper) { | ||
| return wrapper_type_index_ == std::type_index(typeid(wrapper)); | ||
| } | ||
|
|
||
| private: | ||
| bool is_same_primitive_wrapping_; | ||
| // dynamic std::type_index of the actual PrimitiveWrapper<P,Q> class for | ||
| // which this key was inserted. | ||
| std::type_index wrapper_type_index_; | ||
| // dynamic std::type_index of Q, when PrimitiveWrapper<P,Q> was inserted. | ||
| std::type_index q_type_index_; | ||
| // The primitive_wrapper passed in. We use a shared_ptr because | ||
| // unique_ptr<void> is invalid. | ||
| std::shared_ptr<void> original_wrapper_; | ||
| // The keyset_wrapper_. We use a shared_ptr because unique_ptr<void> is | ||
| // invalid. | ||
| std::shared_ptr<void> keyset_wrapper_; | ||
| }; | ||
|
|
||
| // Map from primitive type_index to Info. | ||
| absl::flat_hash_map<std::type_index, Info> primitive_to_info_; | ||
| }; | ||
|
|
||
| template <class P, class Q> | ||
| crypto::tink::util::Status KeysetWrapperStore::Add( | ||
| std::unique_ptr<PrimitiveWrapper<P, Q>> wrapper, | ||
| std::function<crypto::tink::util::StatusOr<std::unique_ptr<P>>( | ||
| const google::crypto::tink::KeyData& key_data)> | ||
| primitive_getter) { | ||
| if (wrapper == nullptr) { | ||
| return crypto::tink::util::Status(absl::StatusCode::kInvalidArgument, | ||
| "Parameter 'wrapper' must be non-null."); | ||
| } | ||
| if (primitive_getter == nullptr) { | ||
| return crypto::tink::util::Status( | ||
| absl::StatusCode::kInvalidArgument, | ||
| "Parameter 'primitive_getter' must be non-null."); | ||
| } | ||
|
|
||
| auto it = primitive_to_info_.find(std::type_index(typeid(Q))); | ||
| if (it != primitive_to_info_.end()) { | ||
| if (!it->second.HasSameType(*wrapper)) { | ||
| return util::Status(absl::StatusCode::kAlreadyExists, | ||
| "A wrapper named for this primitive already exists."); | ||
| } | ||
| return crypto::tink::util::OkStatus(); | ||
| } | ||
|
|
||
| primitive_to_info_.insert( | ||
| {std::type_index(typeid(Q)), Info(std::move(wrapper), primitive_getter)}); | ||
|
|
||
| return crypto::tink::util::OkStatus(); | ||
| } | ||
|
|
||
| template <class P> | ||
| crypto::tink::util::StatusOr<const PrimitiveWrapper<P, P>*> | ||
| KeysetWrapperStore::GetPrimitiveWrapper() const { | ||
| auto it = primitive_to_info_.find(std::type_index(typeid(P))); | ||
| if (it == primitive_to_info_.end()) { | ||
| return util::Status( | ||
| absl::StatusCode::kNotFound, | ||
| absl::StrCat("No wrapper registered for type ", typeid(P).name())); | ||
| } | ||
| return it->second.GetPrimitiveWrapper<P>(); | ||
| } | ||
|
|
||
| template <class P> | ||
| crypto::tink::util::StatusOr<const KeysetWrapper<P>*> KeysetWrapperStore::Get() | ||
| const { | ||
| auto it = primitive_to_info_.find(std::type_index(typeid(P))); | ||
| if (it == primitive_to_info_.end()) { | ||
| return util::Status( | ||
| absl::StatusCode::kNotFound, | ||
| absl::StrCat("No wrapper registered for type ", typeid(P).name())); | ||
| } | ||
| return it->second.Get<P>(); | ||
| } | ||
|
|
||
| } // namespace internal | ||
| } // namespace tink | ||
| } // namespace crypto | ||
|
|
||
| #endif // TINK_INTERNAL_KEYSET_WRAPPER_STORE_H_ |
Oops, something went wrong.