Class COSEMessage

java.lang.Object

com.authlete.cbor.CBORItem

com.authlete.cbor.CBORItemList

com.authlete.cose.COSEObject

com.authlete.cose.COSEMessage

Direct Known Subclasses:

COSEEncrypt, COSEEncrypt0, COSEMac, COSEMac0, COSESign, COSESign1

public abstract class COSEMessage
extends COSEObject

COSE Message

This class represents COSE_Untagged_Message which is defined in 2. Basic COSE Structure of RFC 9052.

Since:

1.1

See Also:

• RFC 9052, 2. Basic COSE Structure

Constructor Summary

Constructors

Constructor	Description
COSEMessage(COSEMessageType type, COSEProtectedHeader protectedHeader, COSEUnprotectedHeader unprotectedHeader, CBORItem content, CBORItem... additionalItems)	A constructor.

Method Summary

Modifier and Type	Method	Description
CBORTaggedItem	getTagged()	Wrap this COSE message with a CBOR tag.
int	getTagNumber()	Get the tag number of this COSE message.
COSEMessageType	getType()	Get the type of this COSE message.

Methods inherited from class com.authlete.cose.COSEObject

getProtectedHeader, getUnprotectedHeader

Methods inherited from class com.authlete.cbor.CBORItemList

encode, getItems, 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

COSEMessage

public COSEMessage(COSEMessageType type,
 COSEProtectedHeader protectedHeader,
 COSEUnprotectedHeader unprotectedHeader,
 CBORItem content,
 CBORItem... additionalItems)
            throws IllegalArgumentException

A constructor.

Parameters:

type - The type of this COSE message.

protectedHeader - The protected header. Must not be null.

unprotectedHeader - The unprotected header. Must not be null.

content - The content. Must be either CBORByteArray or CBORNull.

additionalItems - Additional items.

Throws:

IllegalArgumentException - type is null, protectedHeader is null, unprotectedHeader is null, or content is neither a CBORByteArray instance nor a CBORNull instance.

Method Details

getType

public COSEMessageType getType()

Get the type of this COSE message.

Returns:

The type of this COSE message.

Since:

1.4

getTagNumber

public int getTagNumber()

Get the tag number of this COSE message.

CBOR Tag	Data Item	Java Class
16	COSE_Encrypt0	COSEEncrypt0
17	COSE_Mac0	COSEMac0
18	COSE_Sign1	COSESign1
96	COSE_Encrypt	COSEEncrypt
97	COSE_Mac	COSEMac
98	COSE_Sign	COSESign

Returns:

The tag number.

See Also:

• RFC 9052, 2. Basic COSE Structure

getTagged

public CBORTaggedItem getTagged()

Wrap this COSE message with a CBOR tag.

This method is equivalent to "new CBORTaggedItem(getTagNumber(), this)".

Returns:

A tagged COSE message.