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

SessionTransportTransformerEncrypt

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

A transformer used to sign and encrypt/decrypt session data. This transformer works as follows:

encrypts/decrypts data using encryptAlgorithm and encryptionKeySpec
includes an authenticated MAC (Message Authentication Code) hash with signAlgorithm and signKeySpec
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 authentication.

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

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

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