kjwt-core/co.touchlab.kjwt.model.algorithm/EncryptionAlgorithm

EncryptionAlgorithm

@Serializable(with = EncryptionAlgorithmSerializer::class)

sealed class EncryptionAlgorithm : Jwa(source)

Sealed class representing the JWE key management algorithms defined in RFC 7518.

The key management algorithm determines how the Content Encryption Key (CEK) is protected in the JWE compact serialization. The supported algorithms are:

RsaOaep — RSA-OAEP with SHA-1 key wrapping.
RsaOaep256 — RSA-OAEP with SHA-256 key wrapping.
Dir — direct use of a shared symmetric key as the CEK; no key wrapping is performed.

Use fromId to look up an instance by its JWA identifier string.

See also

EncryptionContentAlgorithm

JwtBuilder.encryptWith

Inheritors

Types

object Companion

data object Dir : EncryptionAlgorithm

Direct use of a shared symmetric CEK — no key wrapping.

sealed class OAEPBased : EncryptionAlgorithm, Jwa.UsesHashingAlgorithm

Base class for RSA OAEP key encryption variants (RsaOaep and RsaOaep256).

data object RsaOaep : EncryptionAlgorithm.OAEPBased

RSA-OAEP with SHA-1. Key must be created with RSA.OAEP.keyPairGenerator(SHA1) or equivalent.

data object RsaOaep256 : EncryptionAlgorithm.OAEPBased

RSA-OAEP with SHA-256. Key must be created with RSA.OAEP.keyPairGenerator(SHA256) or equivalent.

Properties

open override val id: String

The JWA algorithm identifier string (e.g. "HS256", "RS256").

Functions

open override fun toString(): String