Class COSEMac

java.lang.Object

com.authlete.cbor.CBORItem

com.authlete.cbor.CBORItemList

com.authlete.cose.COSEObject

com.authlete.cose.COSEMessage

com.authlete.cose.COSEMac

public class COSEMac
extends COSEMessage

COSE_Mac

COSE_Mac is defined in 6.1. MACed Message with Recipients of RFC 9052 as follows.

 COSE_Mac = [
     Headers,
     payload : bstr / nil,
     tag : bstr,
     recipients : [+COSE_recipient]
 ]
 

Since:

1.1

See Also:

• RFC 9052, 6.1. MACed Message with Recipients

Constructor Summary

Constructors

Constructor	Description
COSEMac(COSEProtectedHeader protectedHeader, COSEUnprotectedHeader unprotectedHeader, CBORItem payload, CBORByteArray tag, CBORItemList recipients)	A constructor with a protected header, an unprotected header, a payload, a tag and recipients.

Method Summary

Modifier and Type	Method	Description
static COSEMac	build(CBORItem item)	Build a COSEMac instance from the given CBOR data item.
static COSEMac	build(List<Object> list)	Build a COSEMac instance from the given object list.
CBORItem	getPayload()	Get the payload.
CBORItemList	getRecipients()	Get the list of recipients.
CBORByteArray	getTag()	Get the tag.

Methods inherited from class com.authlete.cose.COSEMessage

getTagged, getTagNumber, getType

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

COSEMac

public COSEMac(COSEProtectedHeader protectedHeader,
 COSEUnprotectedHeader unprotectedHeader,
 CBORItem payload,
 CBORByteArray tag,
 CBORItemList recipients)

A constructor with a protected header, an unprotected header, a payload, a tag and recipients.

Parameters:

protectedHeader - A protected header. Must not be null.

unprotectedHeader - An unprotected header. Must not be null.

payload - A payload. Must be either CBORByteArray or CBORNull.

tag - A tag. Must not be null.

recipients - Recipients. Must not be null. Items in the list must be instances of COSERecipient. At least one element must be contained.

Method Details

getPayload

public CBORItem getPayload()

Get the payload.

The type of the value is CBORByteArray or CBORNull.

Returns:

The payload.

getTag

public CBORByteArray getTag()

Get the tag.

Returns:

The tag.

getRecipients

public CBORItemList getRecipients()

Get the list of recipients. Items in the list are COSERecipient instances.

Returns:

The list of recipients.

build

public static COSEMac build(CBORItem item)
                     throws COSEException

Build a COSEMac instance from the given CBOR data item. The data item must be a CBOR array.

Parameters:

item - A CBOR data item that represents COSE_Mac.

Returns:

A COSEMac instance built from the given CBOR data item.

Throws:

COSEException

build

public static COSEMac build(List<Object> list)
                     throws COSEException

Build a COSEMac instance from the given object list.

Parameters:

list - A object list that represents COSE_Mac.

Returns:

A COSEMac instance built from the given object list.

Throws:

COSEException