supreme/at.asitplus.signum.supreme.symmetric

Package-level declarations

Properties

iosOptions

val SymmetricEncryptionAlgorithm.AES<*, KeyType.Integrated, *>.iosOptions: UInt

Functions

decrypt

@JvmName(name = "decryptGeneric")

suspend fun SealedBox<*, *, *>.decrypt(key: SpecializedSymmetricKey): KmmResult<ByteArray>

@JvmName(name = "decryptGeneric")

suspend fun SealedBox<*, *, *>.decrypt(key: SymmetricKey<*, *, *>): KmmResult<ByteArray>

Attempts to decrypt this ciphertext (which may also hold an IV/nonce, and in case of an authenticated ciphertext, authenticated data and auth tag) using the provided key. This is the generic, untyped decryption function for convenience. Compared to its narrower-typed cousins is possible to mismatch the characteristics of key and SealedBox.

suspend fun <I : NonceTrait> SealedBox<AuthCapability.Unauthenticated, I, KeyType.Integrated>.decrypt( key: SymmetricKey<AuthCapability.Unauthenticated, I, KeyType.Integrated>): KmmResult<ByteArray>

Attempts to decrypt this ciphertext (which may also hold an IV/nonce) using the provided key. This constrains the key's characteristics to the characteristics of the SealedBox to decrypt. It does not, however, prevent mixing up different encryption algorithms with the same characteristics. I.e., it is possible to feed a AES.ECB key into a AES.CBC. In such cases, this function will immediately return a KmmResult.failure.

@JvmName(name = "decryptRawUnauthedNoNonce")

suspend fun SymmetricKey<AuthCapability.Unauthenticated, NonceTrait.Without, KeyType.Integrated>.decrypt( encryptedData: ByteArray): KmmResult<ByteArray>

Directly decrypts raw encryptedData.

@JvmName(name = "decryptAuthenticatedGeneric")

suspend fun <A : AuthCapability.Authenticated<out K>, I : NonceTrait, K : KeyType> SealedBox<A, I, out K>.decrypt( key: SymmetricKey<A, I, out K>, authenticatedData: ByteArray = byteArrayOf()): KmmResult<ByteArray>

@JvmName(name = "decryptAuthenticatedIntegrated")

suspend fun <I : NonceTrait> SealedBox<AuthCapability.Authenticated.WithDedicatedMac, I, KeyType.WithDedicatedMacKey>.decrypt( key: SymmetricKey.WithDedicatedMac<*>, authenticatedData: ByteArray = byteArrayOf()): KmmResult<ByteArray>

Attempts to decrypt this ciphertext (which may also hold an IV/nonce) using the provided key. Do provide authenticatedData if required, or else decryption will fail! This is the generic, untyped decryption function for convenience. Compared to its narrower-typed cousins is possible to mismatch the characteristics of key and SealedBox.

@JvmName(name = "decryptRawUnauthedWithNonce")

suspend fun SymmetricKey<AuthCapability.Unauthenticated, NonceTrait.Required, KeyType.Integrated>.decrypt( nonce: ByteArray, encryptedData: ByteArray): KmmResult<ByteArray>

Directly decrypts raw encryptedData, feeding nonce into the decryption process.

@JvmName(name = "decryptRawAuthedNoNonce")

suspend fun <A : AuthCapability.Authenticated<*>> SymmetricKey<A, NonceTrait.Without, *>.decrypt( encryptedData: ByteArray, authTag: ByteArray, authenticatedData: ByteArray = byteArrayOf()): KmmResult<ByteArray>

Directly decrypts raw encryptedData, feeding authTag, and authenticatedData into the decryption process.

@JvmName(name = "decryptRawAuthedWithNonce")

suspend fun <A : AuthCapability.Authenticated<*>> SymmetricKey<A, NonceTrait.Required, *>.decrypt( nonce: ByteArray, encryptedData: ByteArray, authTag: ByteArray, authenticatedData: ByteArray = byteArrayOf()): KmmResult<ByteArray>

Directly decrypts raw encryptedData, feeding nonce, authTag, and authenticatedData into the decryption process.

encrypt

@JvmName(name = "encryptWithAutoGenIV")

suspend fun <K : KeyType, A : AuthCapability<out K>, I : NonceTrait> SymmetricKey<A, I, out K>.encrypt( data: ByteArray): KmmResult<SealedBox<A, I, out K>>

@JvmName(name = "encryptAuthenticated")

suspend fun <K : KeyType, A : AuthCapability.Authenticated<out K>, I : NonceTrait> SymmetricKey<A, I, out K>.encrypt( data: ByteArray, authenticatedData: ByteArray? = null): KmmResult<SealedBox<A, I, out K>>

Encrypts data and automagically generates a fresh nonce/IV if required by the cipher.