MultipazProject

multipaz/org.multipaz.cose/Cose

Cose

object Cose

COSE support routines.

This package includes support for COSE as specified in RFC 9052.

Properties

const val COSE_KEY_KID: Long = 2

The COSE Key common parameter for the key id (bstr).

const val COSE_KEY_KTY: Long = 1

The COSE Key common parameter for the key type (tstr / int).

COSE_KEY_PARAM_CRV

const val COSE_KEY_PARAM_CRV: Long

The COSE Key type parameter for the EC curve (int / tstr).

COSE_KEY_PARAM_D

const val COSE_KEY_PARAM_D: Long

The COSE Key type parameter for the private key (bstr).

COSE_KEY_PARAM_X

const val COSE_KEY_PARAM_X: Long

The COSE Key type parameter for the X coordinate (bstr).

COSE_KEY_PARAM_Y

const val COSE_KEY_PARAM_Y: Long

The COSE Key type parameter for the Y coordinate (bstr / bool).

COSE_KEY_TYPE_EC2

const val COSE_KEY_TYPE_EC2: Long = 2

The COSE Key Type for EC2.

COSE_KEY_TYPE_OKP

const val COSE_KEY_TYPE_OKP: Long = 1

The COSE Key Type for OKP.

const val COSE_LABEL_ALG: Long = 1

The COSE label for conveying an algorithm.

const val COSE_LABEL_KID: Long = 4

The COSE label for conveying the key id (bstr) in the COSE header.

const val COSE_LABEL_TYP: Long = 16

The COSE label for conveying the token type (tstr or uint) similar to JWT typ.

COSE_LABEL_X5CHAIN

const val COSE_LABEL_X5CHAIN: Long = 33

The COSE label for conveying an X.509 certificate chain.

Functions

suspend fun coseMac0(algorithm: Algorithm, key: ByteArray, message: ByteArray, includeMessageInPayload: Boolean, protectedHeaders: Map<CoseLabel, DataItem>, unprotectedHeaders: Map<CoseLabel, DataItem>): CoseMac0

Creates a COSE_Mac0 message authentication code.

suspend fun coseSign1Check(publicKey: EcPublicKey, detachedData: ByteArray?, signature: CoseSign1, signatureAlgorithm: Algorithm)

Checks a COSE_Sign1 signature.

suspend fun coseSign1Sign(signingKey: AsymmetricKey, message: ByteArray, includeMessageInPayload: Boolean, protectedHeaders: Map<CoseLabel, DataItem>, unprotectedHeaders: Map<CoseLabel, DataItem>): CoseSign1

suspend fun ~~coseSign1Sign~~(key: EcPrivateKey, dataToSign: ByteArray, includeDataInPayload: Boolean, signatureAlgorithm: Algorithm, protectedHeaders: Map<CoseLabel, DataItem>, unprotectedHeaders: Map<CoseLabel, DataItem>): CoseSign1

suspend fun ~~coseSign1Sign~~(secureArea: SecureArea, alias: String, message: ByteArray, includeMessageInPayload: Boolean, protectedHeaders: Map<CoseLabel, DataItem>, unprotectedHeaders: Map<CoseLabel, DataItem>, unlockReason: Reason = Reason.Unspecified): CoseSign1

Creates a COSE_Sign1 signature.