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

SigningAlgorithm

@Serializable(with = SigningAlgorithmSerializer::class)

sealed class SigningAlgorithm : Jwa(source)

Sealed class representing the JWS signing algorithms defined in RFC 7518.

The supported algorithms are grouped by their cryptographic family:

MACBased — HMAC-based algorithms (HS256, HS384, HS512).
PKCS1Based — RSA PKCS#1 v1.5 algorithms (RS256, RS384, RS512).
PSSBased — RSA PSS algorithms (PS256, PS384, PS512).
ECDSABased — Elliptic Curve DSA algorithms (ES256, ES384, ES512).
None — the unsecured algorithm (alg=none); rejected by the parser unless allowUnsecured(true) is set.

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

See also

JwtBuilder.signWith

JwtParserBuilder.verifyWith

Inheritors

Types

object Companion

sealed class ECDSABased : SigningAlgorithm, Jwa.UsesHashingAlgorithm

Groups the ECDSA signing algorithms (ES256, ES384, ES512).

data object ES256 : SigningAlgorithm.ECDSABased

ECDSA with SHA-256 (ES256) signing algorithm using elliptic-curve key pairs.

data object ES384 : SigningAlgorithm.ECDSABased

ECDSA with SHA-384 (ES384) signing algorithm using elliptic-curve key pairs.

data object ES512 : SigningAlgorithm.ECDSABased

ECDSA with SHA-512 (ES512) signing algorithm using elliptic-curve key pairs.

data object HS256 : SigningAlgorithm.MACBased

HMAC with SHA-256 (HS256) signing algorithm using a symmetric HMAC Key.

data object HS384 : SigningAlgorithm.MACBased

HMAC with SHA-384 (HS384) signing algorithm using a symmetric HMAC Key.

data object HS512 : SigningAlgorithm.MACBased

HMAC with SHA-512 (HS512) signing algorithm using a symmetric HMAC Key.

sealed class MACBased : SigningAlgorithm, Jwa.UsesHashingAlgorithm

Groups the HMAC-based signing algorithms (HS256, HS384, HS512).

data object None : SigningAlgorithm

Unsecured JWT — opt-in only. Rejected by parser unless allowUnsecured(true).

sealed class PKCS1Based : SigningAlgorithm, Jwa.UsesHashingAlgorithm

Groups the RSA PKCS#1 v1.5 signing algorithms (RS256, RS384, RS512).

data object PS256 : SigningAlgorithm.PSSBased

RSA PSS with SHA-256 (PS256) signing algorithm using RSA key pairs.

data object PS384 : SigningAlgorithm.PSSBased

RSA PSS with SHA-384 (PS384) signing algorithm using RSA key pairs.

data object PS512 : SigningAlgorithm.PSSBased

RSA PSS with SHA-512 (PS512) signing algorithm using RSA key pairs.

sealed class PSSBased : SigningAlgorithm, Jwa.UsesHashingAlgorithm

Groups the RSA PSS signing algorithms (PS256, PS384, PS512).

data object RS256 : SigningAlgorithm.PKCS1Based

RSA PKCS#1 v1.5 with SHA-256 (RS256) signing algorithm using RSA key pairs.

data object RS384 : SigningAlgorithm.PKCS1Based

RSA PKCS#1 v1.5 with SHA-384 (RS384) signing algorithm using RSA key pairs.

data object RS512 : SigningAlgorithm.PKCS1Based

RSA PKCS#1 v1.5 with SHA-512 (RS512) signing algorithm using RSA key pairs.

Properties

open override val id: String

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

Functions

open override fun toString(): String