io.ktor.util

Class StatelessHmacNonceManager

io.ktor.util.StatelessHmacNonceManager

All Implemented Interfaces:

NonceManager

public class StatelessHmacNonceManager
implements NonceManager

Stateless nonce manager implementation with HMAC verification and timeout. Every nonce provided by this manager consist of a random part, timestamp and HMAC.

Constructor Summary

Constructors

Constructor and Description
StatelessHmacNonceManager(javax.crypto.spec.SecretKeySpec keySpec, java.lang.String algorithm, long timeoutMillis, kotlin.jvm.functions.Function0<java.lang.String> nonceGenerator) Stateless nonce manager implementation with HMAC verification and timeout. Every nonce provided by this manager consist of a random part, timestamp and HMAC.
StatelessHmacNonceManager(byte[] key, java.lang.String algorithm, long timeoutMillis, kotlin.jvm.functions.Function0<java.lang.String> nonceGenerator) Helper constructor that makes a secret key from key ByteArray

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlgorithm() HMAC algorithm name,
javax.crypto.spec.SecretKeySpec	getKeySpec() secret key spec for HMAC
kotlin.jvm.functions.Function0<java.lang.String>	getNonceGenerator() function that produces random values
long	getTimeoutMillis() specifies the amount of time for a nonce to be considered valid
java.lang.Object	newNonce(kotlin.coroutines.experimental.Continuation<? super java.lang.String> p) Generate new nonce instance
java.lang.Object	verifyNonce(java.lang.String nonce, kotlin.coroutines.experimental.Continuation<? super java.lang.Boolean> p) Verify nonce value

Methods inherited from interface io.ktor.util.NonceManager

newNonce, verifyNonce

Constructor Detail

StatelessHmacNonceManager

public StatelessHmacNonceManager(javax.crypto.spec.SecretKeySpec keySpec,
                                 java.lang.String algorithm,
                                 long timeoutMillis,
                                 kotlin.jvm.functions.Function0<java.lang.String> nonceGenerator)

Stateless nonce manager implementation with HMAC verification and timeout. Every nonce provided by this manager consist of a random part, timestamp and HMAC.

Parameters:

keySpec - secret key spec for HMAC

algorithm - HMAC algorithm name, HmacSHA256 by default

timeoutMillis - specifies the amount of time for a nonce to be considered valid

nonceGenerator - function that produces random values

StatelessHmacNonceManager

public StatelessHmacNonceManager(byte[] key,
                                 java.lang.String algorithm,
                                 long timeoutMillis,
                                 kotlin.jvm.functions.Function0<java.lang.String> nonceGenerator)

Helper constructor that makes a secret key from key ByteArray

Method Detail

newNonce

public java.lang.Object newNonce(kotlin.coroutines.experimental.Continuation<? super java.lang.String> p)

Generate new nonce instance

verifyNonce

public java.lang.Object verifyNonce(java.lang.String nonce,
                                    kotlin.coroutines.experimental.Continuation<? super java.lang.Boolean> p)

Verify nonce value

Returns:

true if nonce is valid

getKeySpec

public javax.crypto.spec.SecretKeySpec getKeySpec()

secret key spec for HMAC

getAlgorithm

public java.lang.String getAlgorithm()

HMAC algorithm name,

HmacSHA256 by default

getTimeoutMillis

public long getTimeoutMillis()

specifies the amount of time for a nonce to be considered valid

getNonceGenerator

public kotlin.jvm.functions.Function0<java.lang.String> getNonceGenerator()

function that produces random values