cryptography-core/dev.whyoleg.cryptography.algorithms/HMAC

HMAC

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface HMAC : CryptographyAlgorithm(source)

Hash-based Message Authentication Code (HMAC) as defined in RFC 2104.

HMAC computes and verifies message authentication codes using a secret key and a Digest algorithm.

val key = provider.get(HMAC).keyGenerator(SHA256).generateKey()
val signature = key.signatureGenerator().generateSignature(data)
key.signatureVerifier().verifySignature(data, signature)

Types

Companion

object Companion : CryptographyAlgorithmId<HMAC>

Key

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface Key : Encodable<HMAC.Key.Format>

An HMAC key that provides MAC computation via signatureGenerator and verification via signatureVerifier.

Properties

open override val id: CryptographyAlgorithmId<HMAC>

The typed identifier that uniquely distinguishes this algorithm and is used to look it up from a CryptographyProvider.

Functions

keyDecoder

abstract fun keyDecoder(digest: CryptographyAlgorithmId<Digest>): Decoder<HMAC.Key.Format, HMAC.Key>

Returns a Decoder that decodes HMAC keys for the given digest from the specified Key.Format.

keyGenerator

abstract fun keyGenerator(digest: CryptographyAlgorithmId<Digest> = SHA512): KeyGenerator<HMAC.Key>

Returns a KeyGenerator that generates HMAC keys for the given digest.