xref: /aosp_15_r20/external/tink/cc/internal/key_status_util.h (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1 // Copyright 2022 Google LLC
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 //      http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 //
15 ////////////////////////////////////////////////////////////////////////////////
16 
17 #ifndef TINK_INTERNAL_KEY_STATUS_UTIL_H_
18 #define TINK_INTERNAL_KEY_STATUS_UTIL_H_
19 
20 #include <string>
21 
22 #include "tink/key_status.h"
23 #include "tink/util/statusor.h"
24 #include "proto/tink.pb.h"
25 
26 namespace crypto {
27 namespace tink {
28 namespace internal {
29 
30 // Returns `KeyStatus` C++ enum for a given `KeyStatusType` proto enum. If
31 // `status_type` is unrecognized (i.e., not handled), then an error is returned.
32 util::StatusOr<KeyStatus> FromKeyStatusType(
33     google::crypto::tink::KeyStatusType status_type);
34 
35 // Returns `KeyStatusType` proto enum for a given `KeyStatus` C++ enum. If
36 // `status` is unrecognized (i.e., not handled), then an error is returned.
37 util::StatusOr<google::crypto::tink::KeyStatusType> ToKeyStatusType(
38     KeyStatus status);
39 
40 // Returns a canonical name for a `KeyStatus` based on the corresponding
41 // `KeyStatusType` proto enum.
42 std::string ToKeyStatusName(KeyStatus status);
43 
44 }  // namespace internal
45 }  // namespace tink
46 }  // namespace crypto
47 
48 #endif  // TINK_INTERNAL_KEY_STATUS_UTIL_H_
49