kipher-symmetric/io.github.jhdcruz.kipher.symmetric/AEAD

AEAD

abstract class AEAD(@NotNull val algorithm: String, @NotNull val mode: String) : SymmetricEncryption

Authenticated Encryption with Associated Data.

It incorporates tag that provides a cryptographic checksum that can be used to help validate a decryption such as additional clear text, or associated data used for validation

Parameters

algorithm

algorithm to use for KeyGenerator (e.g. AES, ChaCha20).

mode

algorithm mode to use (e.g. AES/GCM/NoPadding, ChaCha20-Poly1305).

Inheritors

Constructors

Link copied to clipboard
constructor(@NotNull algorithm: String, @NotNull mode: String)

Properties

Link copied to clipboard
Link copied to clipboard
open var defaultKeySize: Int?

Default key size to use for KeyGenerator.

Link copied to clipboard
abstract val ivLength: Int

IV/nonce length.

Link copied to clipboard
val mode: String

Functions

Link copied to clipboard
fun Map<String, ByteArray>.concat(): ByteArray

Concatenate the encryption details from a Map data.

Link copied to clipboard
fun decrypt(@NotNull encrypted: Map<String, ByteArray>): ByteArray

Decrypts encrypted data in a Map format.

@JvmOverloads
fun decrypt(@NotNull encrypted: ByteArray, @NotNull key: ByteArray, @NotNull tag: ByteArray = byteArrayOf()): ByteArray

Decrypts encrypted data using key and tag if provided.

Link copied to clipboard
@JvmOverloads
fun decryptBare(@NotNull encrypted: ByteArray, @NotNull iv: ByteArray, @NotNull key: ByteArray, @NotNull tag: ByteArray = byteArrayOf()): ByteArray

Decrypts encrypted data with optional tag verification using key nad iv.

Link copied to clipboard
@JvmOverloads
fun encrypt(@NotNull data: ByteArray, @NotNull tag: ByteArray = byteArrayOf(), @NotNull key: ByteArray = generateKey()): Map<String, ByteArray>

Encrypts the provided data along with optional tag and key.

Link copied to clipboard
@JvmOverloads
fun encryptBare(@NotNull data: ByteArray, @NotNull iv: ByteArray, @NotNull key: ByteArray, @NotNull tag: ByteArray = byteArrayOf()): Map<String, ByteArray>

Encrypts the provided data along with tag (if provided) using key.

Link copied to clipboard
fun ByteArray.extract(): Map<String, ByteArray>

Extracts the iv, data from a ByteArray data.

Link copied to clipboard
fun generateIv(): ByteArray

Generate IV based on ivLength.

Link copied to clipboard
@JvmOverloads
fun generateKey(@Nullable size: Int? = defaultKeySize): ByteArray

Generate secret key based on optional key size.