| // Copyright 2018 Google Inc. |
| // |
| // 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_TEMPLATES_H_ |
| #define TINK_AEAD_AEAD_KEY_TEMPLATES_H_ |
| |
| #include "proto/tink.pb.h" |
| |
| namespace crypto { |
| namespace tink { |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // Pre-generated KeyTemplate for Aead key types. One can use these templates |
| // to generate new KeysetHandle object with fresh keys. |
| // To generate a new keyset that contains a single AesGcmKey, one can do: |
| // |
| // auto status = AeadConfig::Register(); |
| // if (!status.ok()) { /* fail with error */ } |
| // auto handle_result = |
| // KeysetHandle::GenerateNew(AeadKeyTemplates::Aes128Gcm()); |
| // if (!handle_result.ok()) { /* fail with error */ } |
| // auto keyset_handle = std::move(handle_result.ValueOrDie()); |
| class AeadKeyTemplates { |
| public: |
| // Returns a KeyTemplate that generates new instances of AesEaxKey |
| // with the following parameters: |
| // - key size: 16 bytes |
| // - IV size: 16 bytes |
| // - tag size: 16 bytes |
| // - OutputPrefixType: TINK |
| static const google::crypto::tink::KeyTemplate& Aes128Eax(); |
| |
| // Returns a KeyTemplate that generates new instances of AesEaxKey |
| // with the following parameters: |
| // - key size: 32 bytes |
| // - IV size: 16 bytes |
| // - tag size: 16 bytes |
| // - OutputPrefixType: TINK |
| static const google::crypto::tink::KeyTemplate& Aes256Eax(); |
| |
| // Returns a KeyTemplate that generates new instances of AesGcmKey |
| // with the following parameters: |
| // - key size: 16 bytes |
| // - IV size: 12 bytes |
| // - tag size: 16 bytes |
| // - OutputPrefixType: TINK |
| static const google::crypto::tink::KeyTemplate& Aes128Gcm(); |
| |
| // Returns a KeyTemplate that generates new instances of AesGcmKey |
| // with the following parameters: |
| // - key size: 32 bytes |
| // - IV size: 12 bytes |
| // - tag size: 16 bytes |
| // - OutputPrefixType: TINK |
| static const google::crypto::tink::KeyTemplate& Aes256Gcm(); |
| |
| // Returns a KeyTemplate that generates new instances of AesGcmSivKey |
| // with the following parameters: |
| // - key size: 16 bytes |
| // - IV size: 12 bytes |
| // - tag size: 16 bytes |
| // - OutputPrefixType: TINK |
| static const google::crypto::tink::KeyTemplate& Aes128GcmSiv(); |
| |
| // Returns a KeyTemplate that generates new instances of AesGcmSivKey |
| // with the following parameters: |
| // - key size: 32 bytes |
| // - IV size: 12 bytes |
| // - tag size: 16 bytes |
| // - OutputPrefixType: TINK |
| static const google::crypto::tink::KeyTemplate& Aes256GcmSiv(); |
| |
| // Returns a KeyTemplate that generates new instances of AesCtrHmacAeadKey |
| // with the following parameters: |
| // - AES key size: 16 bytes |
| // - AES IV size: 16 bytes |
| // - HMAC key size: 32 bytes |
| // - HMAC tag size: 16 bytes |
| // - HMAC hash function: SHA256 |
| // - OutputPrefixType: TINK |
| static const google::crypto::tink::KeyTemplate& Aes128CtrHmacSha256(); |
| |
| // Returns a KeyTemplate that generates new instances of AesCtrHmacAeadKey |
| // with the following parameters: |
| // - AES key size: 32 bytes |
| // - AES IV size: 16 bytes |
| // - HMAC key size: 32 bytes |
| // - HMAC tag size: 32 bytes |
| // - HMAC hash function: SHA256 |
| // - OutputPrefixType: TINK |
| static const google::crypto::tink::KeyTemplate& Aes256CtrHmacSha256(); |
| |
| // Returns a KeyTemplate that generates new instances of XChaCha20Poly1305Key |
| // with the following parameters: |
| // - XChacha20 key size: 32 bytes |
| // - IV size: 24 bytes |
| // - OutputPrefixType: TINK |
| static const google::crypto::tink::KeyTemplate& XChaCha20Poly1305(); |
| }; |
| |
| } // namespace tink |
| } // namespace crypto |
| |
| #endif // TINK_AEAD_AEAD_KEY_TEMPLATES_H_ |