1*e7b1675dSTing-Kang Chang // Copyright 2022 Google LLC 2*e7b1675dSTing-Kang Chang // 3*e7b1675dSTing-Kang Chang // Licensed under the Apache License, Version 2.0 (the "License"); 4*e7b1675dSTing-Kang Chang // you may not use this file except in compliance with the License. 5*e7b1675dSTing-Kang Chang // You may obtain a copy of the License at 6*e7b1675dSTing-Kang Chang // 7*e7b1675dSTing-Kang Chang // http://www.apache.org/licenses/LICENSE-2.0 8*e7b1675dSTing-Kang Chang // 9*e7b1675dSTing-Kang Chang // Unless required by applicable law or agreed to in writing, software 10*e7b1675dSTing-Kang Chang // distributed under the License is distributed on an "AS IS" BASIS, 11*e7b1675dSTing-Kang Chang // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12*e7b1675dSTing-Kang Chang // See the License for the specific language governing permissions and 13*e7b1675dSTing-Kang Chang // limitations under the License. 14*e7b1675dSTing-Kang Chang // 15*e7b1675dSTing-Kang Chang //////////////////////////////////////////////////////////////////////////////// 16*e7b1675dSTing-Kang Chang 17*e7b1675dSTing-Kang Chang #ifndef TINK_MAC_AES_CMAC_KEY_H_ 18*e7b1675dSTing-Kang Chang #define TINK_MAC_AES_CMAC_KEY_H_ 19*e7b1675dSTing-Kang Chang 20*e7b1675dSTing-Kang Chang #include <string> 21*e7b1675dSTing-Kang Chang #include <utility> 22*e7b1675dSTing-Kang Chang 23*e7b1675dSTing-Kang Chang #include "absl/types/optional.h" 24*e7b1675dSTing-Kang Chang #include "tink/mac/aes_cmac_parameters.h" 25*e7b1675dSTing-Kang Chang #include "tink/mac/mac_key.h" 26*e7b1675dSTing-Kang Chang #include "tink/partial_key_access_token.h" 27*e7b1675dSTing-Kang Chang #include "tink/restricted_data.h" 28*e7b1675dSTing-Kang Chang #include "tink/util/statusor.h" 29*e7b1675dSTing-Kang Chang 30*e7b1675dSTing-Kang Chang namespace crypto { 31*e7b1675dSTing-Kang Chang namespace tink { 32*e7b1675dSTing-Kang Chang 33*e7b1675dSTing-Kang Chang class AesCmacKey : public MacKey { 34*e7b1675dSTing-Kang Chang public: 35*e7b1675dSTing-Kang Chang // Copyable and movable. 36*e7b1675dSTing-Kang Chang AesCmacKey(const AesCmacKey& other) = default; 37*e7b1675dSTing-Kang Chang AesCmacKey& operator=(const AesCmacKey& other) = default; 38*e7b1675dSTing-Kang Chang AesCmacKey(AesCmacKey&& other) = default; 39*e7b1675dSTing-Kang Chang AesCmacKey& operator=(AesCmacKey&& other) = default; 40*e7b1675dSTing-Kang Chang 41*e7b1675dSTing-Kang Chang // Creates a new AES-CMAC key. If the parameters specify a variant that uses 42*e7b1675dSTing-Kang Chang // a prefix, then the id is used to compute this prefix. 43*e7b1675dSTing-Kang Chang static util::StatusOr<AesCmacKey> Create(const AesCmacParameters& parameters, 44*e7b1675dSTing-Kang Chang const RestrictedData& key_bytes, 45*e7b1675dSTing-Kang Chang absl::optional<int> id_requirement, 46*e7b1675dSTing-Kang Chang PartialKeyAccessToken token); 47*e7b1675dSTing-Kang Chang 48*e7b1675dSTing-Kang Chang // Returns the underlying AES key. GetKeyBytes(PartialKeyAccessToken token)49*e7b1675dSTing-Kang Chang const RestrictedData& GetKeyBytes(PartialKeyAccessToken token) const { 50*e7b1675dSTing-Kang Chang return key_bytes_; 51*e7b1675dSTing-Kang Chang } 52*e7b1675dSTing-Kang Chang GetOutputPrefix()53*e7b1675dSTing-Kang Chang absl::string_view GetOutputPrefix() const override { return output_prefix_; } 54*e7b1675dSTing-Kang Chang GetParameters()55*e7b1675dSTing-Kang Chang const AesCmacParameters& GetParameters() const override { 56*e7b1675dSTing-Kang Chang return parameters_; 57*e7b1675dSTing-Kang Chang } 58*e7b1675dSTing-Kang Chang GetIdRequirement()59*e7b1675dSTing-Kang Chang absl::optional<int> GetIdRequirement() const override { 60*e7b1675dSTing-Kang Chang return id_requirement_; 61*e7b1675dSTing-Kang Chang } 62*e7b1675dSTing-Kang Chang 63*e7b1675dSTing-Kang Chang bool operator==(const Key& other) const override; 64*e7b1675dSTing-Kang Chang 65*e7b1675dSTing-Kang Chang private: AesCmacKey(const AesCmacParameters & parameters,const RestrictedData & key_bytes,absl::optional<int> id_requirement,std::string output_prefix)66*e7b1675dSTing-Kang Chang AesCmacKey(const AesCmacParameters& parameters, 67*e7b1675dSTing-Kang Chang const RestrictedData& key_bytes, 68*e7b1675dSTing-Kang Chang absl::optional<int> id_requirement, std::string output_prefix) 69*e7b1675dSTing-Kang Chang : parameters_(parameters), 70*e7b1675dSTing-Kang Chang key_bytes_(key_bytes), 71*e7b1675dSTing-Kang Chang id_requirement_(id_requirement), 72*e7b1675dSTing-Kang Chang output_prefix_(std::move(output_prefix)) {} 73*e7b1675dSTing-Kang Chang 74*e7b1675dSTing-Kang Chang static util::StatusOr<std::string> ComputeOutputPrefix( 75*e7b1675dSTing-Kang Chang const AesCmacParameters& parameters, absl::optional<int> id_requirement); 76*e7b1675dSTing-Kang Chang 77*e7b1675dSTing-Kang Chang AesCmacParameters parameters_; 78*e7b1675dSTing-Kang Chang RestrictedData key_bytes_; 79*e7b1675dSTing-Kang Chang absl::optional<int> id_requirement_; 80*e7b1675dSTing-Kang Chang std::string output_prefix_; 81*e7b1675dSTing-Kang Chang }; 82*e7b1675dSTing-Kang Chang 83*e7b1675dSTing-Kang Chang } // namespace tink 84*e7b1675dSTing-Kang Chang } // namespace crypto 85*e7b1675dSTing-Kang Chang 86*e7b1675dSTing-Kang Chang #endif // TINK_MAC_AES_CMAC_KEY_H_ 87