ktor-server-core/io.ktor.sessions/SessionTransportTransformerEncrypt

SessionTransportTransformerEncrypt

class SessionTransportTransformerEncrypt(encryptionKeySpec: SecretKeySpec, signKeySpec: SecretKeySpec, ivGenerator: (size: Int) -> ByteArray, encryptAlgorithm: String, signAlgorithm: String) : SessionTransportTransformer

Session transformer that encrypts/decrypts the input.

Where the input is either a session contents or a previous transformation.

It encrypts/decrypts the input with an encryptAlgorithm and an encryptionKeySpec and includes an authenticated MAC (Message Authentication Code) hash with signAlgorithm and a signKeySpec and includes an IV (Initialization Vector) that is generated by an ivGenerator by default secure random bytes.

By default it uses AES for encryption and HmacSHA256 for authenticating.

You have to provide keys of compatible sizes: 16, 24 and 32 for AES encryption. For HmacSHA256 it is recommended a key of 32 bytes.

Constructors

SessionTransportTransformerEncrypt

fun SessionTransportTransformerEncrypt(encryptionKey: ByteArray, signKey: ByteArray, ivGenerator: (size: Int) -> ByteArray = { size -> ByteArray(size).apply { SecureRandom().nextBytes(this) } }, encryptAlgorithm: String = "AES", signAlgorithm: String = "HmacSHA256")

SessionTransportTransformerEncrypt

fun SessionTransportTransformerEncrypt(encryptionKeySpec: SecretKeySpec, signKeySpec: SecretKeySpec, ivGenerator: (size: Int) -> ByteArray = { size -> ByteArray(size).apply { SecureRandom().nextBytes(this) } }, encryptAlgorithm: String = encryptionKeySpec.algorithm, signAlgorithm: String = signKeySpec.algorithm)