com.google.crypto.tink.mac

Class MacKeyTemplates

java.lang.Object

com.google.crypto.tink.mac.MacKeyTemplates

public final class MacKeyTemplates
extends Object

Pre-generated KeyTemplate for Mac.

We recommend to avoid this class in order to keep dependencies small.

• Using this class adds a dependency on protobuf. We hope that eventually it is possible to use Tink without a dependency on protobuf.
• Using this class adds a dependency on classes for all involved key types.

These dependencies all come from static class member variables, which are initialized when the class is loaded. This implies that static analysis and code minimization tools (such as proguard) cannot remove the usages either.

Instead, we recommend to use KeysetHandle.generateEntryFromParametersName or KeysetHandle.generateEntryFromParameters.

One can use these templates to generate new Keyset with KeysetHandle. To generate a new keyset that contains a single HmacKey, one can do:

 Config.register(Mac.TINK_1_0_0);
 KeysetHandle handle = KeysetHandle.generateNew(MacKeyTemplates.HMAC_SHA256_128BITTAG);
 Mac mac = handle.getPrimitive(Mac.class);
 

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static KeyTemplate	AES_CMAC A KeyTemplate that generates new instances of com.google.crypto.tink.proto.CmacKey with the following parameters: Key size: 32 bytes Tag size: 16 bytes OutputPrefixType: TINK
static KeyTemplate	HMAC_SHA256_128BITTAG A KeyTemplate that generates new instances of HmacKey with the following parameters: Key size: 32 bytes Tag size: 16 bytes Hash function: SHA256 OutputPrefixType: TINK
static KeyTemplate	HMAC_SHA256_256BITTAG A KeyTemplate that generates new instances of HmacKey with the following parameters: Key size: 32 bytes Tag size: 32 bytes Hash function: SHA256 OutputPrefixType: TINK
static KeyTemplate	HMAC_SHA512_256BITTAG A KeyTemplate that generates new instances of HmacKey with the following parameters: Key size: 64 bytes Tag size: 32 bytes Hash function: SHA512 OutputPrefixType: TINK
static KeyTemplate	HMAC_SHA512_512BITTAG A KeyTemplate that generates new instances of HmacKey with the following parameters: Key size: 64 bytes Tag size: 64 bytes Hash function: SHA512 OutputPrefixType: TINK

Method Summary

Modifier and Type	Method and Description
static KeyTemplate	createHmacKeyTemplate(int keySize, int tagSize, HashType hashType)

Methods inherited from class java.lang.Object

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

Field Detail

HMAC_SHA256_128BITTAG

public static final KeyTemplate HMAC_SHA256_128BITTAG

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

• Key size: 32 bytes
• Tag size: 16 bytes
• Hash function: SHA256
• OutputPrefixType: TINK

HMAC_SHA256_256BITTAG

public static final KeyTemplate HMAC_SHA256_256BITTAG

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

• Key size: 32 bytes
• Tag size: 32 bytes
• Hash function: SHA256
• OutputPrefixType: TINK

HMAC_SHA512_256BITTAG

public static final KeyTemplate HMAC_SHA512_256BITTAG

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

• Key size: 64 bytes
• Tag size: 32 bytes
• Hash function: SHA512
• OutputPrefixType: TINK

HMAC_SHA512_512BITTAG

public static final KeyTemplate HMAC_SHA512_512BITTAG

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

• Key size: 64 bytes
• Tag size: 64 bytes
• Hash function: SHA512
• OutputPrefixType: TINK

AES_CMAC

public static final KeyTemplate AES_CMAC

A KeyTemplate that generates new instances of com.google.crypto.tink.proto.CmacKey with the following parameters:

• Key size: 32 bytes
• Tag size: 16 bytes
• OutputPrefixType: TINK

Method Detail

createHmacKeyTemplate

public static KeyTemplate createHmacKeyTemplate(int keySize,
                                                int tagSize,
                                                HashType hashType)

Returns:

a KeyTemplate containing a HmacKeyFormat with some specified parameters.