xref: /aosp_15_r20/external/tink/cc/key_status.h (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
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_KEY_STATUS_H_
18*e7b1675dSTing-Kang Chang #define TINK_KEY_STATUS_H_
19*e7b1675dSTing-Kang Chang 
20*e7b1675dSTing-Kang Chang namespace crypto {
21*e7b1675dSTing-Kang Chang namespace tink {
22*e7b1675dSTing-Kang Chang 
23*e7b1675dSTing-Kang Chang // Enum representation of KeyStatusType in tink/proto/tink.proto. Using an
24*e7b1675dSTing-Kang Chang // enum class prevents unintentional implicit conversions.
25*e7b1675dSTing-Kang Chang enum class KeyStatus : int {
26*e7b1675dSTing-Kang Chang   kEnabled = 1,    // Can be used for cryptographic operations.
27*e7b1675dSTing-Kang Chang   kDisabled = 2,   // Cannot be used (but can become kEnabled again).
28*e7b1675dSTing-Kang Chang   kDestroyed = 3,  // Key data does not exist in this Keyset any more.
29*e7b1675dSTing-Kang Chang   // Added to guard from failures that may be caused by future expansions.
30*e7b1675dSTing-Kang Chang   kDoNotUseInsteadUseDefaultWhenWritingSwitchStatements = 20,
31*e7b1675dSTing-Kang Chang };
32*e7b1675dSTing-Kang Chang 
33*e7b1675dSTing-Kang Chang }  // namespace tink
34*e7b1675dSTing-Kang Chang }  // namespace crypto
35*e7b1675dSTing-Kang Chang 
36*e7b1675dSTing-Kang Chang #endif  // TINK_KEY_STATUS_H_
37