Class COSEOKPKey

java.lang.Object

com.authlete.cbor.CBORItem

com.authlete.cbor.CBORPairList

com.authlete.cose.COSEKey

com.authlete.cose.COSEOKPKey

public class COSEOKPKey
extends COSEKey

OKP Key

Since:

1.1

See Also:

• RFC 9052, 7. Key Objects
• RFC 9053, 2.2. Edwards-Curve Digital Signature Algorithm (EdDSA)
• IANA: COSE Key Common Parameters
• IANA: COSE Key Type Parameters
• IANA: COSE Key Types
• IANA: COSE Elliptic Curves

Constructor Summary

Constructors

Constructor	Description
COSEOKPKey(List<? extends CBORPair> pairs)	A constructor with key parameters.

Method Summary

Modifier and Type	Method	Description
protected void	addJwkProperties(Map<String,Object> map)	Add JWK properties to the given map.
Object	getCrv()	Get the curve (the value of the crv parameter).
byte[]	getD()	Get the private key (the value of the d parameter).
byte[]	getX()	Get the public key (the value of the x parameter).
boolean	isPrivate()	Get the flag indicating whether this key contains private parameters.

Methods inherited from class com.authlete.cose.COSEKey

build, build, copy, createPrivateKey, createPublicKey, fromJwk, getAlg, getBaseIv, getKeyOps, getKid, getKty, getParameters, toJwk, toPublic

Methods inherited from class com.authlete.cbor.CBORPairList

encode, findByKey, getPairs, parse, prettify, toString

Methods inherited from class com.authlete.cbor.CBORItem

encode, encodeMajorWithNumber, encodeToBase64, encodeToBase64Url, encodeToHex, getComment, prettify, setComment, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

COSEOKPKey

public COSEOKPKey(List<? extends CBORPair> pairs)

A constructor with key parameters.

Parameters:

pairs - Key parameters.

Method Details

isPrivate

public boolean isPrivate()

Description copied from class: COSEKey

Get the flag indicating whether this key contains private parameters.

Subclasses of the COSEKey class are expected to override this method.

Overrides:

isPrivate in class COSEKey

Returns:

true if this key contains private parameters.

addJwkProperties

protected void addJwkProperties(Map<String,Object> map)

Description copied from class: COSEKey

Add JWK properties to the given map.

This method is called from within the COSEKey.toJwk() method. Subclasses of the COSEKey class should override this method.

Overrides:

addJwkProperties in class COSEKey

Parameters:

map - A map to which JWK properties should be added.

getCrv

public Object getCrv()

Get the curve (the value of the crv parameter).

The type of the value is an integer (int, long or BigInteger) or a string (String).

Returns:

The curve.

See Also:

• IANA: COSE Elliptic Curves

getX

public byte[] getX()

Get the public key (the value of the x parameter).

Returns:

The public key.

getD

public byte[] getD()

Get the private key (the value of the d parameter).

Returns:

The private key.