kjwt-core/co.touchlab.kjwt.model/JwtHeader

JwtHeader

@Serializable(with = JwtHeaderSerializer::class)

Immutable representation of a JOSE header for a JWT, JWS, or JWE token.

The header is backed by a JsonObject and is also stored in its base64url-encoded form so that the compact serialization can be reproduced exactly. Standard parameters such as alg, enc, typ, cty, and kid are accessible via dedicated properties or helper functions; arbitrary custom parameters can be read with getHeader and getHeaderOrNull.

Types

Builder

class Builder

Builder for constructing a JwtHeader with standard and extra parameters.

Companion

object Companion

Properties

algorithm

val algorithm: String

The algorithm (alg) header parameter identifying the cryptographic algorithm used.

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.

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.

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

equals

open operator override fun equals(other: Any?): Boolean

getHeader

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

Returns the value of the named header parameter deserialized using the given serializer.

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

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

Returns the value of the named header parameter deserialized using the given serializer, or null if absent.

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.

hashCode

open override fun hashCode(): Int

hasHeader

fun hasHeader(name: String): Boolean

Returns true if a header parameter with the given name exists.

toString

open override fun toString(): String

JwtHeader

See also

Types

Properties

Functions