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