com.google.crypto.tink.mac

Class HmacKeyManager

java.lang.Object

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

com.google.crypto.tink.mac.HmacKeyManager

public final class HmacKeyManager
extends KeyTypeManager<HmacKey>

This key manager generates new HmacKey keys and produces new instances of PrfHmacJce.

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>

Constructor Summary

Constructors

Constructor and Description
HmacKeyManager()

Method Summary

Modifier and Type	Method and Description
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.
int	getVersion() Returns the version number of this KeyManager.
static KeyTemplate	hmacSha256HalfDigestTemplate()
static KeyTemplate	hmacSha256Template()
static KeyTemplate	hmacSha512HalfDigestTemplate()
static KeyTemplate	hmacSha512Template()
KeyTypeManager.KeyFactory<HmacKeyFormat,HmacKey>	keyFactory() Returns the KeyTypeManager.KeyFactory for this key type.
KeyData.KeyMaterialType	keyMaterialType() Returns the KeyData.KeyMaterialType for this proto.
HmacKey	parseKey(com.google.protobuf.ByteString byteString) Parses a serialized key proto.
static void	register(boolean newKeyAllowed)
void	validateKey(HmacKey key) Checks if the given keyProto is a valid key.

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

Constructor Detail

HmacKeyManager

public HmacKeyManager()

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<HmacKey>

getVersion

public int getVersion()

Description copied from class: KeyTypeManager

Returns the version number of this KeyManager.

Specified by:

getVersion in class KeyTypeManager<HmacKey>

keyMaterialType

public KeyData.KeyMaterialType keyMaterialType()

Description copied from class: KeyTypeManager

Returns the KeyData.KeyMaterialType for this proto.

Specified by:

keyMaterialType in class KeyTypeManager<HmacKey>

validateKey

public void validateKey(HmacKey key)
                 throws GeneralSecurityException

Description copied from class: KeyTypeManager

Checks if the given keyProto is a valid key.

Specified by:

validateKey in class KeyTypeManager<HmacKey>

Throws:

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

parseKey

public HmacKey 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<HmacKey>

Throws:

com.google.protobuf.InvalidProtocolBufferException

keyFactory

public KeyTypeManager.KeyFactory<HmacKeyFormat,HmacKey> 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<HmacKey>

register

public static void register(boolean newKeyAllowed)
                     throws GeneralSecurityException

Throws:

GeneralSecurityException

hmacSha256HalfDigestTemplate

public static final KeyTemplate hmacSha256HalfDigestTemplate()

Returns:

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

• Key size: 32 bytes
• Tag size: 16 bytes
• Hash function: SHA256
• Prefix type: KeyTemplate.OutputPrefixType#TINK

hmacSha256Template

public static final KeyTemplate hmacSha256Template()

Returns:

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

• Key size: 32 bytes
• Tag size: 32 bytes
• Hash function: SHA256
• Prefix type: KeyTemplate.OutputPrefixType#TINK

hmacSha512HalfDigestTemplate

public static final KeyTemplate hmacSha512HalfDigestTemplate()

Returns:

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

• Key size: 64 bytes
• Tag size: 32 bytes
• Hash function: SHA512
• Prefix type: KeyTemplate.OutputPrefixType#TINK

hmacSha512Template

public static final KeyTemplate hmacSha512Template()

Returns:

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

• Key size: 64 bytes
• Tag size: 64 bytes
• Hash function: SHA512
• Prefix type: KeyTemplate.OutputPrefixType#TINK

fipsStatus

public TinkFipsUtil.AlgorithmFipsCompatibility fipsStatus()

Description copied from class: KeyTypeManager

Returns the FIPS compatibility of this KeyTypeManager.

Overrides:

fipsStatus in class KeyTypeManager<HmacKey>