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

StandardEncryption

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

Basic Encryption using basic modes.

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

StandardEncryption

constructor(@NotNull algorithm: String, @NotNull mode: String)

Properties

algorithm

val algorithm: String

defaultKeySize

open var defaultKeySize: Int?

Default key size to use for KeyGenerator.

ivLength

abstract val ivLength: Int

IV/nonce length.

mode

val mode: String

Functions

concat

fun Map<String, ByteArray>.concat(): ByteArray

Concatenate the encryption details from a Map data.

decrypt

fun decrypt(@NotNull encrypted: Map<String, ByteArray>): ByteArray

Decrypts encrypted data in a Map format.

fun decrypt(@NotNull encrypted: ByteArray, @NotNull key: ByteArray): ByteArray

Decrypts encrypted data using key.

decryptBare

fun decryptBare(@NotNull encrypted: ByteArray, @NotNull iv: ByteArray, @NotNull key: ByteArray): ByteArray

Decrypts encrypted data using key and optional iv.

encrypt

@JvmOverloads

fun encrypt(@NotNull data: ByteArray, @NotNull key: ByteArray = generateKey()): Map<String, ByteArray>

Encrypts the provided data using the provided key.

encryptBare

fun encryptBare(@NotNull data: ByteArray, @NotNull iv: ByteArray, @NotNull key: ByteArray): Map<String, ByteArray>

Encrypts the provided data using the provided key.

extract

fun ByteArray.extract(): Map<String, ByteArray>

Extracts the iv, data from a ByteArray data.

generateIv

fun generateIv(): ByteArray

Generate IV based on ivLength.

generateKey

@JvmOverloads

fun generateKey(@Nullable size: Int? = defaultKeySize): ByteArray

Generate secret key based on optional key size.