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