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_ALG: Long = 3

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

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_D_RSA

const val COSE_KEY_PARAM_D_RSA: Long

The COSE Key type parameter for RSA private exponent d (bstr).

COSE_KEY_PARAM_DP

const val COSE_KEY_PARAM_DP: Long

The COSE Key type parameter for RSA dP (bstr).

COSE_KEY_PARAM_DQ

const val COSE_KEY_PARAM_DQ: Long

The COSE Key type parameter for RSA dQ (bstr).

COSE_KEY_PARAM_E

const val COSE_KEY_PARAM_E: Long

The COSE Key type parameter for RSA public exponent e (bstr).

COSE_KEY_PARAM_N

const val COSE_KEY_PARAM_N: Long

The COSE Key type parameter for RSA modulus n (bstr).

COSE_KEY_PARAM_P

const val COSE_KEY_PARAM_P: Long

The COSE Key type parameter for RSA prime factor p (bstr).

COSE_KEY_PARAM_PRIV_KEY

const val COSE_KEY_PARAM_PRIV_KEY: Long

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

COSE_KEY_PARAM_PUB_KEY

const val COSE_KEY_PARAM_PUB_KEY: Long

The COSE Key type parameter for AKP public key (bstr).

COSE_KEY_PARAM_Q

const val COSE_KEY_PARAM_Q: Long

The COSE Key type parameter for RSA prime factor q (bstr).

COSE_KEY_PARAM_QINV

const val COSE_KEY_PARAM_QINV: Long

The COSE Key type parameter for RSA qInv (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_AKP

const val COSE_KEY_TYPE_AKP: Long = 7

The COSE Key Type for Algorithm Key Pair (AKP).

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.

COSE_KEY_TYPE_RSA

const val COSE_KEY_TYPE_RSA: Long = 3

The COSE Key Type for RSA.

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: SecretKey, message: ByteArray, includeMessageInPayload: Boolean, protectedHeaders: Map<CoseLabel, DataItem>, unprotectedHeaders: Map<CoseLabel, DataItem>): CoseMac0

Creates a COSE_Mac0 message authentication code.

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

Checks a COSE_Sign1 signature.

suspend fun coseSign1Sign(signingKey: AsymmetricKey, message: ByteArray, includeMessageInPayload: Boolean, protectedHeaders: Map<CoseLabel, DataItem> = mapOf(), unprotectedHeaders: Map<CoseLabel, DataItem> = mapOf()): 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.