com.google.crypto.tink.jwt

Class JwtHmacKeyManager

java.lang.Object

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

com.google.crypto.tink.jwt.JwtHmacKeyManager

public final class JwtHmacKeyManager
extends KeyTypeManager<JwtHmacKey>

This key manager generates new JwtHmacKey keys and produces new instances of JwtHmac.

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
JwtHmacKeyManager()

Method Summary

Modifier and Type	Method and Description
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	hs256Template() Returns a KeyTemplate that generates new instances of HS256 256-bit keys.
static KeyTemplate	hs384Template() Returns a KeyTemplate that generates new instances of HS384 384-bit keys.
static KeyTemplate	hs512Template() Returns a KeyTemplate that generates new instances of HS512 384-bit keys.
KeyTypeManager.KeyFactory<JwtHmacKeyFormat,JwtHmacKey>	keyFactory() Returns the KeyTypeManager.KeyFactory for this key type.
KeyData.KeyMaterialType	keyMaterialType() Returns the KeyData.KeyMaterialType for this proto.
JwtHmacKey	parseKey(com.google.protobuf.ByteString byteString) Parses a serialized key proto.
static void	register(boolean newKeyAllowed)
void	validateKey(JwtHmacKey key) Checks if the given keyProto is a valid key.

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

fipsStatus, firstSupportedPrimitiveClass, getKeyClass, getPrimitive, supportedPrimitives

Methods inherited from class java.lang.Object

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

Constructor Detail

JwtHmacKeyManager

public JwtHmacKeyManager()

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

getVersion

public int getVersion()

Description copied from class: KeyTypeManager

Returns the version number of this KeyManager.

Specified by:

getVersion in class KeyTypeManager<JwtHmacKey>

keyMaterialType

public KeyData.KeyMaterialType keyMaterialType()

Description copied from class: KeyTypeManager

Returns the KeyData.KeyMaterialType for this proto.

Specified by:

keyMaterialType in class KeyTypeManager<JwtHmacKey>

validateKey

public void validateKey(JwtHmacKey key)
                 throws GeneralSecurityException

Description copied from class: KeyTypeManager

Checks if the given keyProto is a valid key.

Specified by:

validateKey in class KeyTypeManager<JwtHmacKey>

Throws:

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

parseKey

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

keyFactory

public KeyTypeManager.KeyFactory<JwtHmacKeyFormat,JwtHmacKey> 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<JwtHmacKey>

register

public static void register(boolean newKeyAllowed)
                     throws GeneralSecurityException

Throws:

GeneralSecurityException

hs256Template

public static final KeyTemplate hs256Template()

Returns a KeyTemplate that generates new instances of HS256 256-bit keys.

hs384Template

public static final KeyTemplate hs384Template()

Returns a KeyTemplate that generates new instances of HS384 384-bit keys.

hs512Template

public static final KeyTemplate hs512Template()

Returns a KeyTemplate that generates new instances of HS512 384-bit keys.