xref: /aosp_15_r20/external/tink/cc/keyderivation/keyset_deriver.h (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1 // Copyright 2019 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_KEYDERIVATION_KEYSET_DERIVER_H_
18 #define TINK_KEYDERIVATION_KEYSET_DERIVER_H_
19 
20 #include <memory>
21 
22 #include "absl/strings/string_view.h"
23 #include "tink/keyset_handle.h"
24 #include "tink/util/statusor.h"
25 
26 namespace crypto {
27 namespace tink {
28 
29 // KeysetDeriver is the interface used to derive new keysets based on an
30 // additional input, the salt.
31 //
32 // The salt is used to create the keyset using a pseudorandom function.
33 // Implementations must be indistinguishable from ideal KeysetDerivers, which,
34 // for every salt, generates a new random keyset and caches it.
35 class KeysetDeriver {
36  public:
37   virtual crypto::tink::util::StatusOr<std::unique_ptr<KeysetHandle>>
38   DeriveKeyset(absl::string_view salt) const = 0;
39 
40   virtual ~KeysetDeriver() = default;
41 };
42 
43 }  // namespace tink
44 }  // namespace crypto
45 
46 #endif  // TINK_KEYDERIVATION_KEYSET_DERIVER_H_
47