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