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_PROTO_KEYSET_FORMAT_H_ 18*e7b1675dSTing-Kang Chang #define TINK_PROTO_KEYSET_FORMAT_H_ 19*e7b1675dSTing-Kang Chang 20*e7b1675dSTing-Kang Chang #include <string> 21*e7b1675dSTing-Kang Chang 22*e7b1675dSTing-Kang Chang #include "absl/strings/string_view.h" 23*e7b1675dSTing-Kang Chang #include "tink/keyset_handle.h" 24*e7b1675dSTing-Kang Chang #include "tink/secret_key_access_token.h" 25*e7b1675dSTing-Kang Chang #include "tink/util/secret_data.h" 26*e7b1675dSTing-Kang Chang 27*e7b1675dSTing-Kang Chang namespace crypto { 28*e7b1675dSTing-Kang Chang namespace tink { 29*e7b1675dSTing-Kang Chang 30*e7b1675dSTing-Kang Chang // Serializes a keyset into a binary string in "ProtoKeysetFormat". 31*e7b1675dSTing-Kang Chang // This function can serialize both keyset with or without secret key material. 32*e7b1675dSTing-Kang Chang crypto::tink::util::StatusOr<util::SecretData> 33*e7b1675dSTing-Kang Chang SerializeKeysetToProtoKeysetFormat(const KeysetHandle& keyset_handle, 34*e7b1675dSTing-Kang Chang SecretKeyAccessToken token); 35*e7b1675dSTing-Kang Chang 36*e7b1675dSTing-Kang Chang // Parses a keyset from a binary string in "ProtoKeysetFormat". 37*e7b1675dSTing-Kang Chang // This function can parse both keyset with or without secret key material. 38*e7b1675dSTing-Kang Chang crypto::tink::util::StatusOr<KeysetHandle> ParseKeysetFromProtoKeysetFormat( 39*e7b1675dSTing-Kang Chang absl::string_view serialized_keyset, SecretKeyAccessToken token); 40*e7b1675dSTing-Kang Chang 41*e7b1675dSTing-Kang Chang // Serializes a keyset into a binary string in "ProtoKeysetFormat". 42*e7b1675dSTing-Kang Chang // This function will fail if the keyset contains secret key material. 43*e7b1675dSTing-Kang Chang crypto::tink::util::StatusOr<std::string> 44*e7b1675dSTing-Kang Chang SerializeKeysetWithoutSecretToProtoKeysetFormat( 45*e7b1675dSTing-Kang Chang const KeysetHandle& keyset_handle); 46*e7b1675dSTing-Kang Chang 47*e7b1675dSTing-Kang Chang // Parses a keyset from a binary string in "ProtoKeysetFormat". 48*e7b1675dSTing-Kang Chang // This function will fail if the keyset contains secret key material. 49*e7b1675dSTing-Kang Chang crypto::tink::util::StatusOr<KeysetHandle> 50*e7b1675dSTing-Kang Chang ParseKeysetWithoutSecretFromProtoKeysetFormat( 51*e7b1675dSTing-Kang Chang absl::string_view serialized_keyset); 52*e7b1675dSTing-Kang Chang 53*e7b1675dSTing-Kang Chang 54*e7b1675dSTing-Kang Chang } // namespace tink 55*e7b1675dSTing-Kang Chang } // namespace crypto 56*e7b1675dSTing-Kang Chang #endif // TINK_PROTO_KEYSET_FORMAT_H_ 57