java/src/main/java/com/google/crypto/tink/streamingaead/StreamingAeadConfig.java

// 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.streamingaead;

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

/**
 * Static methods and constants for registering with the {@link Registry} all instances of {@link
 * com.google.crypto.tink.StreamingAead} key types supported in a particular release of Tink.
 *
 * <p>To register all StreamingAead key types provided in the latest Tink version one can do:
 *
 * <pre>{@code
 * StreamingAeadConfig.init();
 * }</pre>
 *
 * <p>For more information on how to obtain and use instances of StreamingAead, see {@link
 * StreamingAeadFactory}.
 *
 * @since 1.1.0
 */
public final class StreamingAeadConfig {
  public static final String AES_CTR_HMAC_STREAMINGAEAD_TYPE_URL =
      AesCtrHmacStreamingKeyManager.TYPE_URL;
  public static final String AES_GCM_HKDF_STREAMINGAEAD_TYPE_URL =
      AesGcmHkdfStreamingKeyManager.TYPE_URL;

  private static final String CATALOGUE_NAME = "TinkStreamingAead";
  private static final String PRIMITIVE_NAME = "StreamingAead";

  /** @deprecated */
  @Deprecated
  public static final RegistryConfig TINK_1_1_0 =
      RegistryConfig.newBuilder()
          .addEntry(
              Config.getTinkKeyTypeEntry(
                  CATALOGUE_NAME, PRIMITIVE_NAME, "AesCtrHmacStreamingKey", 0, true))
          .addEntry(
              Config.getTinkKeyTypeEntry(
                  CATALOGUE_NAME, PRIMITIVE_NAME, "AesGcmHkdfStreamingKey", 0, true))
          .setConfigName("TINK_STREAMINGAEAD_1_1_0")
          .build();

  /** @since 1.2.0 */
  public static final RegistryConfig LATEST =
      RegistryConfig.newBuilder()
          .addEntry(
              Config.getTinkKeyTypeEntry(
                  CATALOGUE_NAME, PRIMITIVE_NAME, "AesCtrHmacStreamingKey", 0, true))
          .addEntry(
              Config.getTinkKeyTypeEntry(
                  CATALOGUE_NAME, PRIMITIVE_NAME, "AesGcmHkdfStreamingKey", 0, true))
          .setConfigName("TINK_STREAMINGAEAD")
          .build();

  static {
    try {
      init();
    } catch (GeneralSecurityException e) {
      throw new ExceptionInInitializerError(e);
    }
  }

  /**
   * Tries to register with the {@link Registry} all instances of {@link
   * com.google.crypto.tink.Catalogue} needed to handle StreamingAead key types supported in Tink.
   *
   * @deprecated use {@link #register}
   */
  @Deprecated
  public static void init() throws GeneralSecurityException {
    register();
  }

  /**
   * Tries to register with the {@link Registry} all instances of {@link
   * com.google.crypto.tink.Catalogue} needed to handle StreamingAead key types supported in Tink.
   *
   * @since 1.2.0
   */
  public static void register() throws GeneralSecurityException {
    Registry.addCatalogue(CATALOGUE_NAME, new StreamingAeadCatalogue());
    Config.register(LATEST);
  }
}