indispensable-josef/at.asitplus.signum.indispensable.josef/JwsFlattened

JwsFlattened

@Serializable

data class JwsFlattened : JWS(source)

Flattened JSON JWS serialization.

A flattened JWS carries one payload and one signature. The protected header is stored as encoded bytes in plainProtectedHeader; the optional unprotected header is represented as JwsHeader.Part. The effective jwsHeader is reconstructed by merging both fragments with JwsHeader.fromParts.

Either header fragment may be partial. Only the combination of protected and unprotected parameters must constitute a valid JwsHeader.

plainPayload stores the plain payload bytes. JSON serialization base64url-encodes those bytes for the payload member, so callers should not pre-encode them.

If plainPayload data structure is defined as part of the contact consider JwsFlattenedTyped

Types

object Companion

Properties

@Transient

val jwsHeader: JwsHeader

@Serializable(with = ByteArrayBase64UrlNoPaddingSerializer::class)

@SerialName(value = "payload")

open override val plainPayload: ByteArray

Raw payload bytes.

plainProtectedHeader

@Serializable(with = ByteArrayBase64UrlNoPaddingSerializer::class)

@SerialName(value = "protected")

val plainProtectedHeader: ByteArray?

@Serializable(with = ByteArrayBase64UrlNoPaddingSerializer::class)

@SerialName(value = "signature")

val plainSignature: ByteArray

protectedHeader

val JwsFlattened.protectedHeader: JwsHeader.Part?

@Transient

val signature: CryptoSignature.RawByteEncodable

@Transient

val signatureInput: ByteArray

unprotectedHeader

@SerialName(value = "header")

val unprotectedHeader: JwsHeader.Part?

Functions

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

inline fun <P> getPayload(serialFormat: SerialFormat = joseCompliantSerializer): KmmResult<P>

Find correct serializer at compile time

fun <P> getPayload(serializer: KSerializer<P>, serialFormat: SerialFormat = joseCompliantSerializer): KmmResult<P>

open override fun hashCode(): Int

fun JwsFlattened.toJwsCompact(): JwsCompact

Converts flattened JSON serialization to compact serialization.