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

IvAuthenticatedEncryptor

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

interface IvAuthenticatedEncryptor : IvEncryptor, AuthenticatedEncryptor(source)

Encrypts plaintext with an explicit initialization vector (IV) and optional associated data. The WithIv methods return ciphertext || tag without the IV. All WithIv methods are marked DelicateCryptographyApi because using a custom IV requires careful handling to avoid security issues such as IV reuse. When associated data is provided, it is authenticated but not encrypted. When associated data is null, only the plaintext is authenticated and encrypted.

For the decryption counterpart, see IvAuthenticatedDecryptor.

Inheritors

IvAuthenticatedCipher

Functions

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

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

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

@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: 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

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

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

@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: 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 override fun encryptWithIv(iv: ByteArray, plaintext: ByteArray): ByteArray

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

@DelicateCryptographyApi

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

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

@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.

encryptWithIvBlocking

@DelicateCryptographyApi

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

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

@DelicateCryptographyApi

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

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

@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.