com.google.crypto.tink.KeyManager Maven / Gradle / Ivy
// 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;
import com.google.crypto.tink.proto.KeyData;
import com.google.protobuf.ByteString;
import com.google.protobuf.MessageLite;
import java.security.GeneralSecurityException;
/**
* A KeyManager "understands" keys of a specific key type: it can generate keys of the supported
* type and create primitives for supported keys.
*
* A key type is identified by the global name of the protocol buffer that holds the
* corresponding key material, and is given by {@code typeUrl}-field of {@link KeyData}-protocol
* buffer.
*
*
The template parameter {@code P} denotes the primitive corresponding to the keys handled by
* this manager.
*
* @since 1.0.0
*/
public interface KeyManager
{
/**
* Constructs an instance of P for the key given in {@code serializedKey}, which must be a
* serialized key protocol buffer handled by this manager.
*
*
For primitives of type {@code Mac}, {@code Aead}, {@code PublicKeySign}, {@code
* PublicKeyVerify}, {@code DeterministicAead}, {@code HybridEncrypt}, and {@code HybridDecrypt}
* this should be a primitive which ignores the output prefix and assumes "RAW".
*
* @return the new constructed P
* @throws GeneralSecurityException if the key given in {@code serializedKey} is corrupted or not
* supported
*/
P getPrimitive(ByteString serializedKey) throws GeneralSecurityException;
/**
* Constructs an instance of P for the key given in {@code key}.
*
*
For primitives of type {@code Mac}, {@code Aead}, {@code PublicKeySign}, {@code
* PublicKeyVerify}, {@code DeterministicAead}, {@code HybridEncrypt}, and {@code HybridDecrypt}
* this should be a primitive which ignores the output prefix and assumes "RAW".
*
*
This method is not used by Tink. It does not need to be implemented.
*
* @return the new constructed P
* @throws GeneralSecurityException if the key given in {@code key} is corrupted or not supported
* @deprecated Use {@code getPrimitive(serializedKey)} instead.
*/
@Deprecated // Unused Interface Method. Will be removed.
default P getPrimitive(MessageLite key) throws GeneralSecurityException {
throw new UnsupportedOperationException();
}
/**
* Generates a new key according to specification in {@code serializedKeyFormat}, which must be a
* serialized key format protocol buffer handled by this manager.
*
*
This method is not used by Tink anymore. It does not need to be implemented.
*
* @return the new generated key
* @throws GeneralSecurityException if the specified format is wrong or not supported
* @deprecated Use {@code newKeyData(serializedKeyFormat)} instead.
*/
@Deprecated // Unused Interface Method. Will be removed.
default MessageLite newKey(ByteString serializedKeyFormat) throws GeneralSecurityException {
throw new UnsupportedOperationException();
}
/**
* Generates a new key according to specification in {@code keyFormat}.
*
*
This method is only used by {@link Registry.newKey} which is deprecated and not used by Tink
* anymore. This method does not need to be implemented.
*
* @return the new generated key
* @throws GeneralSecurityException if the specified format is wrong or not supported
* @deprecated Use {@code newKeyData(serializedKeyFormat)} instead.
*/
@Deprecated // Unused Interface Method. Will be removed.
default MessageLite newKey(MessageLite keyFormat) throws GeneralSecurityException {
throw new UnsupportedOperationException();
}
/**
* Returns true iff this KeyManager supports key type identified by {@code typeUrl}.
*
*
This method is not used by Tink anymore. It does not need to be implemented.
*
* @deprecated Use {@code getKeyType()} instead.
*/
@Deprecated // Unused Interface Method. Will be removed.
default boolean doesSupport(String typeUrl) {
throw new UnsupportedOperationException();
}
/** Returns the type URL that identifies the key type of keys managed by this KeyManager. */
String getKeyType();
/**
* Returns the version number of this KeyManager.
*
*
This method is not used by Tink anymore. It does not need to be implemented.
* @deprecated Do not use it.
*/
@Deprecated // Unused Interface Method. Will be removed.
default int getVersion() {
throw new UnsupportedOperationException();
}
/**
* Returns the primitive class object of the P. Should be implemented as {@code return P.class;}
* when implementing a key manager for primitive {$code P}.
*
* @return {@code P.class}
*/
Class
getPrimitiveClass();
/**
* Generates a new {@code KeyData} according to specification in {@code serializedKeyFormat}.
*
* @return the new generated key
* @throws GeneralSecurityException if the specified format is wrong or not supported
*/
KeyData newKeyData(ByteString serializedKeyFormat) throws GeneralSecurityException;
}