xref: /aosp_15_r20/external/tink/cc/aead/aead_key.h (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)

// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
////////////////////////////////////////////////////////////////////////////////

#ifndef TINK_AEAD_AEAD_KEY_H_
#define TINK_AEAD_AEAD_KEY_H_

#include "absl/strings/string_view.h"
#include "tink/aead/aead_parameters.h"
#include "tink/key.h"

namespace crypto {
namespace tink {

// Represents a function to encrypt and decrypt data using authenticated
// encryption with associated data (AEAD).
class AeadKey : public Key {
 public:
  // Returns the bytes prefixed to every ciphertext generated by this key.
  //
  // In order to make key rotation more efficient, Tink allows every AEAD key to
  // have an associated ciphertext output prefix. When decrypting a ciphertext,
  // only keys with a matching prefix have to be tried.
  //
  // See https://developers.google.com/tink/wire-format#tink_output_prefix for
  // more background information on Tink output prefixes.
  virtual absl::string_view GetOutputPrefix() const = 0;

  const AeadParameters& GetParameters() const override = 0;

  bool operator==(const Key& other) const override = 0;
};

}  // namespace tink
}  // namespace crypto

#endif  // TINK_AEAD_AEAD_KEY_H_