xref: /aosp_15_r20/external/tink/cc/streamingaead/streaming_aead_wrapper.h (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1*e7b1675dSTing-Kang Chang // Copyright 2019 Google Inc.
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_STREAMINGAEAD_STREAMING_AEAD_WRAPPER_H_
18*e7b1675dSTing-Kang Chang #define TINK_STREAMINGAEAD_STREAMING_AEAD_WRAPPER_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/primitive_set.h"
24*e7b1675dSTing-Kang Chang #include "tink/primitive_wrapper.h"
25*e7b1675dSTing-Kang Chang #include "tink/streaming_aead.h"
26*e7b1675dSTing-Kang Chang #include "tink/util/statusor.h"
27*e7b1675dSTing-Kang Chang #include "proto/tink.pb.h"
28*e7b1675dSTing-Kang Chang 
29*e7b1675dSTing-Kang Chang namespace crypto {
30*e7b1675dSTing-Kang Chang namespace tink {
31*e7b1675dSTing-Kang Chang 
32*e7b1675dSTing-Kang Chang // Wraps a set of StreamingAead-instances that correspond to a keyset,
33*e7b1675dSTing-Kang Chang // and combines them into a single StreamingAead-primitive, that uses
34*e7b1675dSTing-Kang Chang // the provided instances, depending on the context:
35*e7b1675dSTing-Kang Chang //   * StreamingAead::NewEncryptingStream(...) uses the primary instance
36*e7b1675dSTing-Kang Chang //     from the set
37*e7b1675dSTing-Kang Chang //   * StreamingAead::NewDecryptingStream(...) uses the instance that matches
38*e7b1675dSTing-Kang Chang //     the ciphertext prefix.
39*e7b1675dSTing-Kang Chang class StreamingAeadWrapper
40*e7b1675dSTing-Kang Chang     : public PrimitiveWrapper<StreamingAead, StreamingAead> {
41*e7b1675dSTing-Kang Chang  public:
42*e7b1675dSTing-Kang Chang   // Returns a StreamingAead-primitive that uses StreamingAead-instances
43*e7b1675dSTing-Kang Chang   // provided in 'streaming_aead_set', which must be non-NULL and must contain
44*e7b1675dSTing-Kang Chang   // a primary instance.
45*e7b1675dSTing-Kang Chang   util::StatusOr<std::unique_ptr<StreamingAead>> Wrap(
46*e7b1675dSTing-Kang Chang       std::unique_ptr<PrimitiveSet<StreamingAead>> streaming_aead_set)
47*e7b1675dSTing-Kang Chang       const override;
48*e7b1675dSTing-Kang Chang };
49*e7b1675dSTing-Kang Chang 
50*e7b1675dSTing-Kang Chang }  // namespace tink
51*e7b1675dSTing-Kang Chang }  // namespace crypto
52*e7b1675dSTing-Kang Chang 
53*e7b1675dSTing-Kang Chang #endif  // TINK_STREAMINGAEAD_STREAMING_AEAD_WRAPPER_H_
54