vclib/at.asitplus.wallet.lib.jws

Package-level declarations

Types

ByteArrayBase64Serializer

object ByteArrayBase64Serializer : KSerializer<ByteArray>

ByteArrayBase64UrlSerializer

object ByteArrayBase64UrlSerializer : KSerializer<ByteArray>

DefaultJwsService

class DefaultJwsService(cryptoService: CryptoService) : JwsService

DefaultVerifierJwsService

class DefaultVerifierJwsService(cryptoService: VerifierCryptoService = DefaultVerifierCryptoService()) : VerifierJwsService

EcCurve

@Serializable(with = EcCurveSerializer::class)

enum EcCurve : Enum<EcCurve>

EcCurveSerializer

object EcCurveSerializer : KSerializer<EcCurve?>

JsonWebKey

@Serializable

data class JsonWebKey(val curve: EcCurve? = null, val type: JwkType? = null, val keyId: String? = null, val x: ByteArray? = null, val y: ByteArray? = null)

JsonWebToken

@Serializable

data class JsonWebToken(val issuer: String? = null, val subject: String? = null, val audience: String? = null, val nonce: String? = null, val notBefore: Instant? = null, val issuedAt: Instant? = null, val expiration: Instant? = null, val jwtId: String? = null)

Content of a JWT (JsonWebToken), with many optional keys, since no claim is strongly required.

JweAlgorithm

@Serializable(with = JweAlgorithmSerializer::class)

enum JweAlgorithm : Enum<JweAlgorithm>

JweAlgorithmSerializer

object JweAlgorithmSerializer : KSerializer<JweAlgorithm?>

JweDecrypted

data class JweDecrypted(val header: JweHeader, val payload: ByteArray)

Representation of a decrypted JSON Web Encryption object, i.e. header and payload.

JweEncrypted

data class JweEncrypted(val headerAsParsed: ByteArray, val encryptedKey: ByteArray? = null, val iv: ByteArray, val ciphertext: ByteArray, val authTag: ByteArray)

Representation of an encrypted JSON Web Encryption object, consisting of its 5 parts: Header, encrypted key, IV, ciphertext, authentication tag.

JweEncryption

@Serializable(with = JweEncryptionSerializer::class)

enum JweEncryption : Enum<JweEncryption>

JweEncryptionSerializer

object JweEncryptionSerializer : KSerializer<JweEncryption?>

JweHeader

@Serializable

data class JweHeader(val algorithm: JweAlgorithm?, val encryption: JweEncryption?, val keyId: String? = null, val type: String?, val contentType: String? = null, val jsonWebKey: JsonWebKey? = null, val ephemeralKeyPair: JsonWebKey? = null, val agreementPartyUInfo: ByteArray? = null, val agreementPartyVInfo: ByteArray? = null)

Header of a JweEncrypted or JweDecrypted.

JwkType

@Serializable(with = JwkTypeSerializer::class)

enum JwkType : Enum<JwkType>

JwkTypeSerializer

object JwkTypeSerializer : KSerializer<JwkType?>

JwsAlgorithm

@Serializable(with = JwsAlgorithmSerializer::class)

enum JwsAlgorithm : Enum<JwsAlgorithm>

JwsAlgorithmSerializer

object JwsAlgorithmSerializer : KSerializer<JwsAlgorithm>

JwsContentTypeConstants

object JwsContentTypeConstants

JwsExtensions

object JwsExtensions

JwsHeader

@Serializable

data class JwsHeader(val algorithm: JwsAlgorithm, val keyId: String? = null, val type: String? = null, val contentType: String? = null, val certificateChain: Array<ByteArray>? = null, val notBefore: Instant? = null, val issuedAt: Instant? = null, val expiration: Instant? = null, val jsonWebKey: JsonWebKey? = null)

Header of a JwsSigned.

JwsService

interface JwsService

Creates and parses JWS and JWE objects.

JwsSigned

data class JwsSigned(val header: JwsHeader, val payload: ByteArray, val signature: ByteArray, val plainSignatureInput: String)

Representation of a signed JSON Web Signature object, i.e. consisting of header, payload and signature.

MultibaseHelper

object MultibaseHelper

SdJwtSigned

data class SdJwtSigned(val jws: JwsSigned, val disclosures: Map<String, SelectiveDisclosureItem?>, val keyBindingJws: JwsSigned? = null)

Representation of a signed SD-JWT (payload is VerifiableCredentialSdJwt), i.e. consisting of an JWS (with header, payload and signature) and several disclosures (SelectiveDisclosureItem) separated by a ~, possibly ending with a JWS with payload KeyBindingJws

SelectiveDisclosureItemSerializer

object SelectiveDisclosureItemSerializer : KSerializer<SelectiveDisclosureItem>

Encodes SelectiveDisclosureItem as needed by SD-JWT spec, that is a JSON array with the values for salt, name, and the value itself, which in turn can be anything, e.g. number, boolean or string. We solve this challenge by serializing a list of JsonPrimitive, see implementation.

TbsCertificate

data class TbsCertificate(val version: Int = 2, val serialNumber: Long, val signatureAlgorithm: JwsAlgorithm, val issuerCommonName: String, val validFrom: Instant, val validUntil: Instant, val subjectCommonName: String, val publicKey: CryptoPublicKey)

Very simple implementation of the meat of an X.509 Certificate: The structure that gets signed

VerifierJwsService

interface VerifierJwsService

X509Certificate

data class X509Certificate(val tbsCertificate: TbsCertificate, val signatureAlgorithm: JwsAlgorithm, val signature: ByteArray)

Very simple implementation of an X.509 Certificate