com.google.crypto.tink.signature

Class EcdsaSignKeyManager

java.lang.Object

com.google.crypto.tink.internal.KeyTypeManager<KeyProtoT>

com.google.crypto.tink.internal.PrivateKeyTypeManager<EcdsaPrivateKey,EcdsaPublicKey>

com.google.crypto.tink.signature.EcdsaSignKeyManager

public final class EcdsaSignKeyManager
extends PrivateKeyTypeManager<EcdsaPrivateKey,EcdsaPublicKey>

This key manager generates new EcdsaPrivateKey keys and produces new instances of EcdsaSignJce.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.crypto.tink.internal.KeyTypeManager

KeyTypeManager.KeyFactory<KeyFormatProtoT extends com.google.protobuf.MessageLite,KeyProtoT extends com.google.protobuf.MessageLite>

Method Summary

Modifier and Type	Method and Description
static KeyTemplate	createKeyTemplate(HashType hashType, EllipticCurveType curve, EcdsaSignatureEncoding encoding, KeyTemplate.OutputPrefixType prefixType)
static KeyTemplate	ecdsaP256Template()
TinkFipsUtil.AlgorithmFipsCompatibility	fipsStatus() Returns the FIPS compatibility of this KeyTypeManager.
String	getKeyType() Returns the type URL that identifies the key type of keys managed by this KeyManager.
EcdsaPublicKey	getPublicKey(EcdsaPrivateKey key) Creates a public key from the given private key.
int	getVersion() Returns the version number of this KeyManager.
KeyTypeManager.KeyFactory<EcdsaKeyFormat,EcdsaPrivateKey>	keyFactory() Returns the KeyTypeManager.KeyFactory for this key type.
KeyData.KeyMaterialType	keyMaterialType() Returns the KeyData.KeyMaterialType for this proto.
EcdsaPrivateKey	parseKey(com.google.protobuf.ByteString byteString) Parses a serialized key proto.
static KeyTemplate	rawEcdsaP256Template()
static void	registerPair(boolean newKeyAllowed) Registers the EcdsaSignKeyManager and the EcdsaVerifyKeyManager with the registry, so that the the Ecdsa-Keys can be used with Tink.
void	validateKey(EcdsaPrivateKey privKey) Checks if the given keyProto is a valid key.

Methods inherited from class com.google.crypto.tink.internal.PrivateKeyTypeManager

getPublicKeyClass

Methods inherited from class com.google.crypto.tink.internal.KeyTypeManager

firstSupportedPrimitiveClass, getKeyClass, getPrimitive, supportedPrimitives

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getKeyType

public String getKeyType()

Description copied from class: KeyTypeManager

Returns the type URL that identifies the key type of keys managed by this KeyManager.

Specified by:

getKeyType in class KeyTypeManager<EcdsaPrivateKey>

getVersion

public int getVersion()

Description copied from class: KeyTypeManager

Returns the version number of this KeyManager.

Specified by:

getVersion in class KeyTypeManager<EcdsaPrivateKey>

getPublicKey

public EcdsaPublicKey getPublicKey(EcdsaPrivateKey key)
                            throws GeneralSecurityException

Description copied from class: PrivateKeyTypeManager

Creates a public key from the given private key.

Specified by:

getPublicKey in class PrivateKeyTypeManager<EcdsaPrivateKey,EcdsaPublicKey>

Throws:

GeneralSecurityException

keyMaterialType

public KeyData.KeyMaterialType keyMaterialType()

Description copied from class: KeyTypeManager

Returns the KeyData.KeyMaterialType for this proto.

Specified by:

keyMaterialType in class KeyTypeManager<EcdsaPrivateKey>

parseKey

public EcdsaPrivateKey parseKey(com.google.protobuf.ByteString byteString)
                         throws com.google.protobuf.InvalidProtocolBufferException

Description copied from class: KeyTypeManager

Parses a serialized key proto.

Implement as return KeyProtoT.parseFrom(byteString);.

Specified by:

parseKey in class KeyTypeManager<EcdsaPrivateKey>

Throws:

com.google.protobuf.InvalidProtocolBufferException

validateKey

public void validateKey(EcdsaPrivateKey privKey)
                 throws GeneralSecurityException

Description copied from class: KeyTypeManager

Checks if the given keyProto is a valid key.

Specified by:

validateKey in class KeyTypeManager<EcdsaPrivateKey>

Throws:

GeneralSecurityException - if the passed keyProto is not valid in any way.

keyFactory

public KeyTypeManager.KeyFactory<EcdsaKeyFormat,EcdsaPrivateKey> keyFactory()

Description copied from class: KeyTypeManager

Returns the KeyTypeManager.KeyFactory for this key type.

By default, this throws an UnsupportedOperationException. Hence, if an implementation does not support creating primitives, no implementation is required.

Overrides:

keyFactory in class KeyTypeManager<EcdsaPrivateKey>

fipsStatus

public TinkFipsUtil.AlgorithmFipsCompatibility fipsStatus()

Description copied from class: KeyTypeManager

Returns the FIPS compatibility of this KeyTypeManager.

Overrides:

fipsStatus in class KeyTypeManager<EcdsaPrivateKey>

registerPair

public static void registerPair(boolean newKeyAllowed)
                         throws GeneralSecurityException

Registers the EcdsaSignKeyManager and the EcdsaVerifyKeyManager with the registry, so that the the Ecdsa-Keys can be used with Tink.

Throws:

GeneralSecurityException

ecdsaP256Template

public static final KeyTemplate ecdsaP256Template()

Returns:

A KeyTemplate that generates new instances of ECDSA keys with the following parameters:

• Hash function: SHA256
• Curve: NIST P-256
• Signature encoding: DER (this is the encoding that Java uses).
• Prefix type: KeyTemplate.OutputPrefixType#TINK.

rawEcdsaP256Template

public static final KeyTemplate rawEcdsaP256Template()

Returns:

A KeyTemplate that generates new instances of ECDSA keys with the following parameters:

• Hash function: SHA256
• Curve: NIST P-256
• Signature encoding: DER (this is the encoding that Java uses).
• Prefix type: RAW (no prefix).

Keys generated from this template create raw signatures of exactly 64 bytes. It is compatible with JWS and most other libraries.

createKeyTemplate

public static KeyTemplate createKeyTemplate(HashType hashType,
                                            EllipticCurveType curve,
                                            EcdsaSignatureEncoding encoding,
                                            KeyTemplate.OutputPrefixType prefixType)

Returns:

a KeyTemplate containing a EcdsaKeyFormat with some specified parameters.