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

ChaCha20Poly1305

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

interface ChaCha20Poly1305 : CryptographyAlgorithm(source)

ChaCha20-Poly1305 authenticated encryption with associated data (AEAD) as defined in RFC 8439.

ChaCha20-Poly1305 combines the ChaCha20 stream cipher with the Poly1305 message authentication code to provide both confidentiality and integrity. Uses 256-bit keys, 96-bit (12-byte) nonce, and a 128-bit (16-byte) authentication tag.

A good alternative to AES.GCM on platforms without hardware AES acceleration (AES-NI), as ChaCha20 performs well in pure software implementations.

val key = provider.get(ChaCha20Poly1305).keyGenerator().generateKey()
val ciphertext = key.cipher().encrypt(plaintext)

Types

Companion

object Companion : CryptographyAlgorithmId<ChaCha20Poly1305>

Key

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

interface Key : Encodable<ChaCha20Poly1305.Key.Format>

A ChaCha20-Poly1305 key that provides authenticated encryption and decryption via cipher.

Properties

open override val id: CryptographyAlgorithmId<ChaCha20Poly1305>

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

Functions

keyDecoder

abstract fun keyDecoder(): Decoder<ChaCha20Poly1305.Key.Format, ChaCha20Poly1305.Key>

Returns a Decoder that decodes ChaCha20-Poly1305 keys from the specified Key.Format.

keyGenerator

abstract fun keyGenerator(): KeyGenerator<ChaCha20Poly1305.Key>

Returns a KeyGenerator that generates ChaCha20-Poly1305 keys.