cryptography-core/dev.whyoleg.cryptography.operations/IvAuthenticatedCipher

IvAuthenticatedCipher

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

interface IvAuthenticatedCipher : IvCipher, AuthenticatedCipher, IvAuthenticatedEncryptor, IvAuthenticatedDecryptor(source)

Combines the ability to set explicit initialization vector (IV) and authenticated encryption (AEAD) capabilities.

Inherited encrypt/decrypt methods generate a random IV and prepend it to the output. The authentication tag is appended to the ciphertext: encrypt returns IV || ciphertext || tag, and decrypt expects the same format.

The WithIv variants use a caller-provided IV and do not include it in the output: encrypt returns ciphertext || tag, and decrypt expects ciphertext || tag.

Functions

open suspend fun decrypt(ciphertext: ByteArray, associatedData: ByteArray?): ByteArray

Decrypts the given ciphertext with optional associatedData and returns the resulting plaintext as a ByteArray.

open suspend fun decrypt(ciphertext: ByteString, associatedData: ByteString?): ByteString

Decrypts the given ciphertext with optional associatedData and returns the resulting plaintext as a ByteString.

open suspend fun decrypt(ciphertext: ByteArray): ByteArray

Decrypts the given ciphertext and returns the resulting plaintext as a ByteArray.

open suspend fun decrypt(ciphertext: ByteString): ByteString

Decrypts the given ciphertext and returns the resulting plaintext as a ByteString.

decryptBlocking

abstract fun decryptBlocking(ciphertext: ByteArray, associatedData: ByteArray?): ByteArray

Decrypts the given ciphertext with optional associatedData and returns the resulting plaintext as a ByteArray.

open fun decryptBlocking(ciphertext: ByteString, associatedData: ByteString?): ByteString

Decrypts the given ciphertext with optional associatedData and returns the resulting plaintext as a ByteString.

open fun decryptBlocking(ciphertext: ByteArray): ByteArray

Decrypts the given ciphertext and returns the resulting plaintext as a ByteArray.

open fun decryptBlocking(ciphertext: ByteString): ByteString

Decrypts the given ciphertext and returns the resulting plaintext as a ByteString.

abstract fun decryptingSink(plaintext: RawSink, associatedData: ByteArray?): RawSink

open fun decryptingSink(plaintext: RawSink, associatedData: ByteString?): RawSink

Returns a RawSink that decrypts data as it is written, sending the resulting plaintext to plaintext, with optional associatedData.

open fun decryptingSink(plaintext: RawSink): RawSink

Returns a RawSink that decrypts data as it is written, sending the resulting plaintext to plaintext. Write ciphertext to the returned sink, and plaintext will be forwarded to plaintext.

decryptingSinkWithIv

@DelicateCryptographyApi

abstract fun decryptingSinkWithIv(iv: ByteArray, plaintext: RawSink, associatedData: ByteArray?): RawSink

@DelicateCryptographyApi

open fun decryptingSinkWithIv(iv: ByteString, plaintext: RawSink, associatedData: ByteString?): RawSink

Returns a RawSink that decrypts data as it is written, sending the resulting plaintext to plaintext, using the specified iv with optional associatedData.

@DelicateCryptographyApi

open fun decryptingSinkWithIv(iv: ByteArray, plaintext: RawSink): RawSink

@DelicateCryptographyApi

open fun decryptingSinkWithIv(iv: ByteString, plaintext: RawSink): RawSink

Returns a RawSink that decrypts data as it is written, sending the resulting plaintext to plaintext, using the specified iv.

decryptingSource

abstract fun decryptingSource(ciphertext: RawSource, associatedData: ByteArray?): RawSource

open fun decryptingSource(ciphertext: RawSource, associatedData: ByteString?): RawSource

Returns a RawSource that decrypts data as it is read from the given ciphertext source with optional associatedData.

open fun decryptingSource(ciphertext: RawSource): RawSource

Returns a RawSource that decrypts data as it is read from the given ciphertext source. The resulting source produces plaintext on reads.

decryptingSourceWithIv

@DelicateCryptographyApi

abstract fun decryptingSourceWithIv(iv: ByteArray, ciphertext: RawSource, associatedData: ByteArray?): RawSource

@DelicateCryptographyApi

open fun decryptingSourceWithIv(iv: ByteString, ciphertext: RawSource, associatedData: ByteString?): RawSource

Returns a RawSource that decrypts data as it is read from the given ciphertext source using the specified iv with optional associatedData.

@DelicateCryptographyApi

open fun decryptingSourceWithIv(iv: ByteArray, ciphertext: RawSource): RawSource

@DelicateCryptographyApi

open fun decryptingSourceWithIv(iv: ByteString, ciphertext: RawSource): RawSource

Returns a RawSource that decrypts data as it is read from the given ciphertext source using the specified iv.

@DelicateCryptographyApi

open suspend fun decryptWithIv(iv: ByteArray, ciphertext: ByteArray, associatedData: ByteArray?): ByteArray

Decrypts the given ciphertext using the specified iv with optional associatedData and returns the resulting plaintext as a ByteArray.

@DelicateCryptographyApi

open suspend fun decryptWithIv(iv: ByteString, ciphertext: ByteString, associatedData: ByteString?): ByteString

Decrypts the given ciphertext using the specified iv with optional associatedData and returns the resulting plaintext as a ByteString.

@DelicateCryptographyApi

open suspend fun decryptWithIv(iv: ByteArray, ciphertext: ByteArray): ByteArray

Decrypts the given ciphertext using the specified iv and returns the resulting plaintext as a ByteArray.

@DelicateCryptographyApi

open suspend fun decryptWithIv(iv: ByteString, ciphertext: ByteString): ByteString

Decrypts the given ciphertext using the specified iv and returns the resulting plaintext as a ByteString.

decryptWithIvBlocking

@DelicateCryptographyApi

abstract fun decryptWithIvBlocking(iv: ByteArray, ciphertext: ByteArray, associatedData: ByteArray?): ByteArray

Decrypts the given ciphertext using the specified iv with optional associatedData and returns the resulting plaintext as a ByteArray.

@DelicateCryptographyApi

open fun decryptWithIvBlocking(iv: ByteString, ciphertext: ByteString, associatedData: ByteString?): ByteString

Decrypts the given ciphertext using the specified iv with optional associatedData and returns the resulting plaintext as a ByteString.

@DelicateCryptographyApi

open fun decryptWithIvBlocking(iv: ByteArray, ciphertext: ByteArray): ByteArray

Decrypts the given ciphertext using the specified iv and returns the resulting plaintext as a ByteArray.

@DelicateCryptographyApi

open fun decryptWithIvBlocking(iv: ByteString, ciphertext: ByteString): ByteString

Decrypts the given ciphertext using the specified iv and returns the resulting plaintext as a ByteString.

open suspend fun encrypt(plaintext: ByteArray, associatedData: ByteArray?): ByteArray

Encrypts the given plaintext with optional associatedData and returns the resulting ciphertext as a ByteArray.

open suspend fun encrypt(plaintext: ByteString, associatedData: ByteString?): ByteString

Encrypts the given plaintext with optional associatedData and returns the resulting ciphertext as a ByteString.

open suspend fun encrypt(plaintext: ByteArray): ByteArray

Encrypts the given plaintext and returns the resulting ciphertext as a ByteArray.

open suspend fun encrypt(plaintext: ByteString): ByteString

Encrypts the given plaintext and returns the resulting ciphertext as a ByteString.

encryptBlocking

abstract fun encryptBlocking(plaintext: ByteArray, associatedData: ByteArray?): ByteArray

Encrypts the given plaintext with optional associatedData and returns the resulting ciphertext as a ByteArray.

open fun encryptBlocking(plaintext: ByteString, associatedData: ByteString?): ByteString

Encrypts the given plaintext with optional associatedData and returns the resulting ciphertext as a ByteString.

open fun encryptBlocking(plaintext: ByteArray): ByteArray

Encrypts the given plaintext and returns the resulting ciphertext as a ByteArray.

open fun encryptBlocking(plaintext: ByteString): ByteString

Encrypts the given plaintext and returns the resulting ciphertext as a ByteString.

abstract fun encryptingSink(ciphertext: RawSink, associatedData: ByteArray?): RawSink

open fun encryptingSink(ciphertext: RawSink, associatedData: ByteString?): RawSink

Returns a RawSink that encrypts data as it is written, sending the resulting ciphertext to ciphertext, with optional associatedData.

open fun encryptingSink(ciphertext: RawSink): RawSink

Returns a RawSink that encrypts data as it is written, sending the resulting ciphertext to ciphertext. Write plaintext to the returned sink, and ciphertext will be forwarded to ciphertext.

encryptingSinkWithIv

@DelicateCryptographyApi

abstract fun encryptingSinkWithIv(iv: ByteArray, ciphertext: RawSink, associatedData: ByteArray?): RawSink

@DelicateCryptographyApi

open fun encryptingSinkWithIv(iv: ByteString, ciphertext: RawSink, associatedData: ByteString?): RawSink

Returns a RawSink that encrypts data as it is written, sending the resulting ciphertext to ciphertext, using the specified iv with optional associatedData.

@DelicateCryptographyApi

open fun encryptingSinkWithIv(iv: ByteArray, ciphertext: RawSink): RawSink

@DelicateCryptographyApi

open fun encryptingSinkWithIv(iv: ByteString, ciphertext: RawSink): RawSink

Returns a RawSink that encrypts data as it is written, sending the resulting ciphertext to ciphertext, using the specified iv.

encryptingSource

abstract fun encryptingSource(plaintext: RawSource, associatedData: ByteArray?): RawSource

open fun encryptingSource(plaintext: RawSource, associatedData: ByteString?): RawSource

Returns a RawSource that encrypts data as it is read from the given plaintext source with optional associatedData.

open fun encryptingSource(plaintext: RawSource): RawSource

Returns a RawSource that encrypts data as it is read from the given plaintext source. The resulting source produces ciphertext on reads.

encryptingSourceWithIv

@DelicateCryptographyApi

abstract fun encryptingSourceWithIv(iv: ByteArray, plaintext: RawSource, associatedData: ByteArray?): RawSource

@DelicateCryptographyApi

open fun encryptingSourceWithIv(iv: ByteString, plaintext: RawSource, associatedData: ByteString?): RawSource

Returns a RawSource that encrypts data as it is read from the given plaintext source using the specified iv with optional associatedData.

@DelicateCryptographyApi

open fun encryptingSourceWithIv(iv: ByteArray, plaintext: RawSource): RawSource

@DelicateCryptographyApi

open fun encryptingSourceWithIv(iv: ByteString, plaintext: RawSource): RawSource

Returns a RawSource that encrypts data as it is read from the given plaintext source using the specified iv.

@DelicateCryptographyApi

open suspend fun encryptWithIv(iv: ByteArray, plaintext: ByteArray, associatedData: ByteArray?): ByteArray

Encrypts the given plaintext using the specified iv with optional associatedData and returns the resulting ciphertext as a ByteArray.

@DelicateCryptographyApi

open suspend fun encryptWithIv(iv: ByteString, plaintext: ByteString, associatedData: ByteString?): ByteString

Encrypts the given plaintext using the specified iv with optional associatedData and returns the resulting ciphertext as a ByteString.

@DelicateCryptographyApi

open suspend fun encryptWithIv(iv: ByteArray, plaintext: ByteArray): ByteArray

Encrypts the given plaintext using the specified iv and returns the resulting ciphertext as a ByteArray.

@DelicateCryptographyApi

open suspend fun encryptWithIv(iv: ByteString, plaintext: ByteString): ByteString

Encrypts the given plaintext using the specified iv and returns the resulting ciphertext as a ByteString.

encryptWithIvBlocking

@DelicateCryptographyApi

abstract fun encryptWithIvBlocking(iv: ByteArray, plaintext: ByteArray, associatedData: ByteArray?): ByteArray

Encrypts the given plaintext using the specified iv with optional associatedData and returns the resulting ciphertext as a ByteArray.

@DelicateCryptographyApi

open fun encryptWithIvBlocking(iv: ByteString, plaintext: ByteString, associatedData: ByteString?): ByteString

Encrypts the given plaintext using the specified iv with optional associatedData and returns the resulting ciphertext as a ByteString.

@DelicateCryptographyApi

open fun encryptWithIvBlocking(iv: ByteArray, plaintext: ByteArray): ByteArray

Encrypts the given plaintext using the specified iv and returns the resulting ciphertext as a ByteArray.

@DelicateCryptographyApi

open fun encryptWithIvBlocking(iv: ByteString, plaintext: ByteString): ByteString

Encrypts the given plaintext using the specified iv and returns the resulting ciphertext as a ByteString.