// Copyright 2017 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.
//
////////////////////////////////////////////////////////////////////////////////

package com.google.crypto.tink.aead;

import com.google.crypto.tink.Registry;
import com.google.crypto.tink.mac.MacConfig;
import com.google.crypto.tink.proto.RegistryConfig;
import java.security.GeneralSecurityException;

Static methods and constants for registering with the Registry all instances of Aead key types supported in a particular release of Tink.

To register all Aead key types provided in the latest Tink version one can do:


AeadConfig.register();
Since:1.0.0
/** * Static methods and constants for registering with the {@link Registry} all instances of {@link * com.google.crypto.tink.Aead} key types supported in a particular release of Tink. * * <p>To register all Aead key types provided in the latest Tink version one can do: * * <pre>{@code * AeadConfig.register(); * }</pre> * * @since 1.0.0 */
public final class AeadConfig { public static final String AES_CTR_HMAC_AEAD_TYPE_URL = new AesCtrHmacAeadKeyManager().getKeyType(); public static final String AES_GCM_TYPE_URL = new AesGcmKeyManager().getKeyType(); public static final String AES_EAX_TYPE_URL = new AesEaxKeyManager().getKeyType(); public static final String KMS_AEAD_TYPE_URL = new KmsAeadKeyManager().getKeyType(); public static final String KMS_ENVELOPE_AEAD_TYPE_URL = new KmsEnvelopeAeadKeyManager().getKeyType(); public static final String CHACHA20_POLY1305_TYPE_URL = new ChaCha20Poly1305KeyManager().getKeyType(); public static final String XCHACHA20_POLY1305_TYPE_URL = new XChaCha20Poly1305KeyManager().getKeyType();
Deprecated:
/** @deprecated */
@Deprecated public static final RegistryConfig TINK_1_0_0 = RegistryConfig.getDefaultInstance();
Deprecated:
Since:1.1.0
/** * @deprecated * @since 1.1.0 */
@Deprecated public static final RegistryConfig TINK_1_1_0 = TINK_1_0_0;
* @deprecated
Since:1.2.0
/** * * @deprecated * * @since 1.2.0 */
@Deprecated public static final RegistryConfig LATEST = TINK_1_0_0; static { try { init(); } catch (GeneralSecurityException e) { throw new ExceptionInInitializerError(e); } }
Tries to register with the Registry all instances of Catalogue and KeyManager needed to handle Aead key types supported in Tink.

Because Aead key types depend on Mac key types, this method also registers all Mac catalogues and key managers.

Deprecated:use register
/** * Tries to register with the {@link Registry} all instances of {@link * com.google.crypto.tink.Catalogue} and {@link com.google.crypto.tink.KeyManager} needed to * handle Aead key types supported in Tink. * * <p>Because Aead key types depend on {@link com.google.crypto.tink.Mac} key types, this method * also registers all Mac catalogues and key managers. * * @deprecated use {@link #register} */
@Deprecated public static void init() throws GeneralSecurityException { register(); }
Tries to register with the Registry all instances of Catalogue and KeyManager needed to handle Aead key types supported in Tink.

Because Aead key types depend on Mac key types, this method also registers all Mac catalogues and key managers.

Since:1.2.0
/** * Tries to register with the {@link Registry} all instances of {@link * com.google.crypto.tink.Catalogue} and {@link com.google.crypto.tink.KeyManager} needed to * handle Aead key types supported in Tink. * * <p>Because Aead key types depend on {@link com.google.crypto.tink.Mac} key types, this method * also registers all Mac catalogues and key managers. * * @since 1.2.0 */
public static void register() throws GeneralSecurityException { MacConfig.register(); AesCtrHmacAeadKeyManager.register(/*newKeyAllowed=*/ true); AesEaxKeyManager.register(/*newKeyAllowed=*/ true); AesGcmKeyManager.register(/*newKeyAllowed=*/ true); ChaCha20Poly1305KeyManager.register(/*newKeyAllowed=*/ true); KmsAeadKeyManager.register(/*newKeyAllowed=*/ true); KmsEnvelopeAeadKeyManager.register(/*newKeyAllowed=*/ true); XChaCha20Poly1305KeyManager.register(/*newKeyAllowed=*/ true); AeadWrapper.register(); }
Registers with the Registry all Aead key types released with the latest version of Tink.

Deprecated-yet-still-supported key types are registered in so-called "no new key"-mode, which allows for usage of existing keys forbids generation of new key material.

Deprecated:use register
/** * Registers with the {@code Registry} all Aead key types released with the latest version of * Tink. * * <p>Deprecated-yet-still-supported key types are registered in so-called "no new key"-mode, * which allows for usage of existing keys forbids generation of new key material. * * @deprecated use {@link #register} */
@Deprecated public static void registerStandardKeyTypes() throws GeneralSecurityException { register(); } }