xref: /aosp_15_r20/external/tink/cc/kms_client.h (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1 // Copyright 2018 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_KMS_CLIENT_H_
18 #define TINK_KMS_CLIENT_H_
19 
20 #include <memory>
21 
22 #include "absl/strings/string_view.h"
23 #include "tink/aead.h"
24 #include "tink/util/statusor.h"
25 
26 namespace crypto {
27 namespace tink {
28 
29 // KmsClient knows how to produce primitives backed by keys stored
30 // in remote KMS services.
31 class KmsClient {
32  public:
33   // Returns true iff this client does support KMS key specified by 'key_uri'.
34   virtual bool DoesSupport(absl::string_view key_uri) const = 0;
35 
36   // Returns an Aead-primitive backed by KMS key specified by 'key_uri',
37   // provided that this KmsClient does support 'key_uri'.
38   virtual crypto::tink::util::StatusOr<std::unique_ptr<Aead>>
39   GetAead(absl::string_view key_uri) const = 0;
40 
41   virtual ~KmsClient() = default;
42 };
43 
44 }  // namespace tink
45 }  // namespace crypto
46 
47 #endif  // TINK_KMS_CLIENT_H_
48