com.google.crypto.tink.internal.RegistryConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tink Show documentation

Tink is a small cryptographic library that provides a safe, simple, agile and fast way to accomplish some common cryptographic tasks.

There is a newer version: 1.16.0

Show newest version

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

package com.google.crypto.tink.internal;

import com.google.crypto.tink.Key;
import com.google.crypto.tink.PrimitiveSet;
import com.google.crypto.tink.Registry;
import com.google.crypto.tink.proto.KeyData;
import com.google.errorprone.annotations.DoNotCall;
import java.security.GeneralSecurityException;
import javax.annotation.Nullable;

/**
 * Represents the configuration as currently specified by the registry. That is, this configuration
 * is just a thin layer forwarding calls to the global {@link com.google.crypto.tink.Registry}.
 *
 * Because the global {@link com.google.crypto.tink.Registry} changes when user code adds to it,
 * using this class is not recommended.
 */
public final class RegistryConfiguration extends InternalConfiguration {
  // Returns the singleton instance of RegistryConfiguration.
  public static RegistryConfiguration get() {
    return CONFIG;
  }

  private static final RegistryConfiguration CONFIG = new RegistryConfiguration();

  private RegistryConfiguration() {}

  @Override
  public 
 P getLegacyPrimitive(KeyData keyData, Class
 primitiveClass)
      throws GeneralSecurityException {
    return Registry.getPrimitive(keyData, primitiveClass);
  }

  @Override
  public 
 P getPrimitive(Key key, Class
 primitiveClass) throws GeneralSecurityException {
    /* Here we call {@link MutablePrimitiveRegistry} directly and not through the global
     * {@link com.google.crypto.tink.Registry} because the corresponding method
     * {@link com.google.crypto.tink.Registry#getFullPrimitive} is package-private.
     */
    return MutablePrimitiveRegistry.globalInstance().getPrimitive(key, primitiveClass);
  }

  @Override
  public  P wrap(PrimitiveSet primitiveSet, Class
 clazz)
      throws GeneralSecurityException {
    return Registry.wrap(primitiveSet, clazz);
  }

  @Override
  @Nullable
  public Class getInputPrimitiveClass(Class wrapperClassObject) {
    return Registry.getInputPrimitive(wrapperClassObject);
  }

  /**
   * Do not call.
   *
   * We shadow the function {@code createFromPrimitiveRegistry} here so that one cannot invoke
   * the static function in the superclass by writing {@code
   * RegistryConfiguration.createFromPrimitiveRegistry}.
   */
  @DoNotCall
  public static InternalConfiguration createFromPrimitiveRegistry(PrimitiveRegistry registry) {
    throw new UnsupportedOperationException(
        "Cannot create RegistryConfiguration from a PrimitiveRegistry");
  }
}