COSE

Class Message

java.lang.Object

COSE.Attribute

COSE.Message

Direct Known Subclasses:

EncryptCommon, MacCommon, Recipient, SignCommon, SignMessage

public abstract class Message
extends Attribute

The Message class provides a common class that all of the COSE message classes inherit from. It provides the function used for decoding all of the known messages.

Author:

jimsch

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	emitContent Is the content emitted as part of the message?
protected boolean	emitTag Is the tag identifying the message emitted?
protected MessageTag	messageTag What message tag identifies this message?
protected byte[]	rgbContent What is the plain text content of the message.

Fields inherited from class COSE.Attribute

DO_NOT_SEND, DontSendAttributes, externalData, objDontSend, objProtected, objUnprotected, PROTECTED, ProtectedAttributes, rgbProtected, UNPROTECTED, UnprotectedAttributes

Constructor Summary

Constructors

Constructor and Description
Message()

Method Summary

Modifier and Type	Method and Description
static Message	DecodeFromBytes(byte[] rgbData) Decode a COSE message object.
static Message	DecodeFromBytes(byte[] rgbData, MessageTag defaultTag) Decode a COSE message object.
protected abstract void	DecodeFromCBORObject(com.upokecenter.cbor.CBORObject messageObject) Given a CBOR tree, parse the message.
protected abstract com.upokecenter.cbor.CBORObject	EncodeCBORObject() Encode the COSE message object to a CBORObject tree.
byte[]	EncodeToBytes() Encode the message to a byte array.
com.upokecenter.cbor.CBORObject	EncodeToCBORObject() Encode the COSE message object to a CBORObject tree.
byte[]	GetContent() Return the content bytes of the message
boolean	HasContent() Does the message current have content?
void	SetContent(byte[] rgbData) Set the content bytes of the message.
void	SetContent(String strData) Set the content bytes as a text string.

Methods inherited from class COSE.Attribute

addAttribute, addAttribute, addAttribute, AddProtected, AddProtected, AddProtected, AddUnprotected, AddUnprotected, AddUnprotected, findAttribute, findAttribute, findAttribute, findAttribute, getDoNotSendAttributes, getExternal, getProtectedAttributes, getUnprotectedAttributes, removeAttribute, removeAttribute, setExternal

Methods inherited from class java.lang.Object

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

Field Detail

emitTag

protected boolean emitTag

Is the tag identifying the message emitted?

emitContent

protected boolean emitContent

Is the content emitted as part of the message?

messageTag

protected MessageTag messageTag

What message tag identifies this message?

rgbContent

protected byte[] rgbContent

What is the plain text content of the message.

Constructor Detail

Message

public Message()

Method Detail

DecodeFromBytes

public static Message DecodeFromBytes(byte[] rgbData)
                               throws CoseException

Decode a COSE message object. This function assumes that the message has a leading CBOR tag to identify the message type. If this is not true then use {#link DecodeFromBytes(byte[], MessageTag)}.

Parameters:

rgbData - byte stream to be decoded

Returns:

the decoded message object

Throws:

CoseException - on a decode failure

DecodeFromBytes

public static Message DecodeFromBytes(byte[] rgbData,
                                      MessageTag defaultTag)
                               throws CoseException

Decode a COSE message object. Use a value of MessageTag.Unknown to decode a generic structure with tagging. Use a specific value if the tagging is absent or if a known structure is passed in.

Parameters:

rgbData - byte stream to be decoded

defaultTag - assumed message type to be decoded

Returns:

the decoded message object

Throws:

CoseException - on a decode failure.

EncodeToBytes

public byte[] EncodeToBytes()
                     throws CoseException

Encode the message to a byte array. This function will force cryptographic operations to be executed as needed.

Returns:

byte encoded object

Throws:

CoseException - Internal COSE Exception

DecodeFromCBORObject

protected abstract void DecodeFromCBORObject(com.upokecenter.cbor.CBORObject messageObject)
                                      throws CoseException

Given a CBOR tree, parse the message. This is an abstract function that is implemented for each different supported COSE message.

Parameters:

messageObject - CBORObject to be converted to a message.

Throws:

CoseException

EncodeCBORObject

protected abstract com.upokecenter.cbor.CBORObject EncodeCBORObject()
                                                             throws CoseException

Encode the COSE message object to a CBORObject tree. This function call will force cryptographic operations to be executed as needed. This is an internal function, as such it does not add the tag on the front and is implemented on a per message object.

Returns:

CBORObject representing the message.

Throws:

CoseException

EncodeToCBORObject

public com.upokecenter.cbor.CBORObject EncodeToCBORObject()
                                                   throws CoseException

Encode the COSE message object to a CBORObject tree. This function call will force cryptographic operations to be executed as needed.

Returns:

CBORObject representing the message.

Throws:

CoseException

GetContent

public byte[] GetContent()

Return the content bytes of the message

Returns:

bytes of the content

HasContent

public boolean HasContent()

Does the message current have content?

Returns:

true if it has content

SetContent

public void SetContent(byte[] rgbData)

Set the content bytes of the message. If the message was transmitted with detached content, this must be called before doing cryptographic processing on the message.

Parameters:

rgbData - bytes to set as the content

SetContent

public void SetContent(String strData)

Set the content bytes as a text string. The string will be encoded using UTF8 into a byte string.

Parameters:

strData - string to set as the content