kjwt-core/co.touchlab.kjwt.ext

Package-level declarations

Properties

audience

val JwtPayload.audience: Set<String>

Returns the aud (audience) claim value as a set of strings.

audienceOrNull

val JwtPayload.audienceOrNull: Set<String>?

Returns the aud (audience) claim value as a set of strings, or null if the claim is absent.

contentType

val JwtHeader.contentType: String

Returns the cty (content type) header value.

contentTypeOrNull

val JwtHeader.contentTypeOrNull: String?

Returns the cty (content type) header value, or null if the header is absent.

encryption

val JwtHeader.encryption: String

Returns the enc (encryption algorithm) header value.

encryptionOrNull

val JwtHeader.encryptionOrNull: String?

Returns the enc (encryption algorithm) header value, or null if the header is absent.

expiration

val JwtPayload.expiration: Instant

Returns the exp (expiration time) claim value as an Instant.

expirationOrNull

val JwtPayload.expirationOrNull: Instant?

Returns the exp (expiration time) claim value as an Instant, or null if the claim is absent.

issuedAt

val JwtPayload.issuedAt: Instant

Returns the iat (issued at) claim value as an Instant.

issuedAtOrNull

val JwtPayload.issuedAtOrNull: Instant?

Returns the iat (issued at) claim value as an Instant, or null if the claim is absent.

issuer

val JwtPayload.issuer: String

Returns the iss (issuer) claim value.

issuerOrNull

val JwtPayload.issuerOrNull: String?

Returns the iss (issuer) claim value, or null if the claim is absent.

jwtId

val JwtPayload.jwtId: String

Returns the jti (JWT ID) claim value.

jwtIdOrNull

val JwtPayload.jwtIdOrNull: String?

Returns the jti (JWT ID) claim value, or null if the claim is absent.

keyId

val JwtHeader.keyId: String

Returns the kid (key ID) header value.

keyIdOrNull

val JwtHeader.keyIdOrNull: String?

Returns the kid (key ID) header value, or null if the header is absent.

notBefore

val JwtPayload.notBefore: Instant

Returns the nbf (not before) claim value as an Instant.

notBeforeOrNull

val JwtPayload.notBeforeOrNull: Instant?

Returns the nbf (not before) claim value as an Instant, or null if the claim is absent.

subject

val JwtPayload.subject: String

Returns the sub (subject) claim value.

subjectOrNull

val JwtPayload.subjectOrNull: String?

Returns the sub (subject) claim value, or null if the claim is absent.

type

val JwtHeader.type: String

Returns the typ (token type) header value.

typeOrNull

val JwtHeader.typeOrNull: String?

Returns the typ (token type) header value, or null if the header is absent.

Functions

getClaim

inline fun <T> JwtPayload.getClaim(name: String, jsonInstance: Json = Jwt.defaultJsonParser): T

Returns the value of the named claim, deserializing it to type T using a reified serializer.

getClaimOrNull

inline fun <T> JwtPayload.getClaimOrNull(name: String, jsonInstance: Json = Jwt.defaultJsonParser): T?

Returns the value of the named claim deserialized to type T, or null if the claim is absent.

getHeader

inline fun <T> JwtHeader.getHeader(name: String, jsonInstance: Json = Jwt.defaultJsonParser): T

Returns the value of the named header, deserializing it to type T using a reified serializer.

getHeaderOrNull

inline fun <T> JwtHeader.getHeaderOrNull(name: String, jsonInstance: Json = Jwt.defaultJsonParser): T?

Returns the value of the named header deserialized to type T, or null if the header is absent.

mergeWith

fun BaseJweProcessor.mergeWith(other: BaseJweProcessor?): BaseJweProcessor

Merges this BaseJweProcessor with other, producing a combined JweProcessor that supports both encryption and decryption.

fun BaseJwsProcessor.mergeWith(other: BaseJwsProcessor?): BaseJwsProcessor

Merges this BaseJwsProcessor with other, producing a combined JwsProcessor that supports both signing and verification.