COSE

Class Attribute

java.lang.Object

COSE.Attribute

Direct Known Subclasses:

Message, Signer

public class Attribute
extends Object

Author:

jimsch

Field Summary

Fields

Modifier and Type	Field and Description
static int	DontSendAttributes
protected byte[]	externalData
protected com.upokecenter.cbor.CBORObject	objDontSend
protected com.upokecenter.cbor.CBORObject	objProtected
protected com.upokecenter.cbor.CBORObject	objUnprotected
static int	ProtectedAttributes
protected byte[]	rgbProtected
static int	UnprotectedAttributes

Constructor Summary

Constructors

Constructor and Description
Attribute()

Method Summary

Modifier and Type	Method and Description
void	addAttribute(com.upokecenter.cbor.CBORObject label, com.upokecenter.cbor.CBORObject value, int where) Set an attribute in the COSE object.
void	addAttribute(HeaderKeys label, byte[] value, int where) Set an attribute in the COSE object.
void	addAttribute(HeaderKeys label, com.upokecenter.cbor.CBORObject value, int where) Set an attribute in the COSE object.
void	AddProtected(com.upokecenter.cbor.CBORObject label, com.upokecenter.cbor.CBORObject value) Deprecated. use addAttribute(com.upokecenter.cbor.CBORObject, com.upokecenter.cbor.CBORObject, int)
void	AddProtected(HeaderKeys label, byte[] value) Deprecated. use addAttribute(HeaderKeys, byte[], int) with ProtectedAttributes
void	AddProtected(HeaderKeys label, com.upokecenter.cbor.CBORObject value) Deprecated. use addAttribute(com.upokecenter.cbor.CBORObject, com.upokecenter.cbor.CBORObject, int)
void	AddUnprotected(com.upokecenter.cbor.CBORObject label, com.upokecenter.cbor.CBORObject value)
void	AddUnprotected(HeaderKeys label, byte[] value)
void	AddUnprotected(HeaderKeys label, com.upokecenter.cbor.CBORObject value)
com.upokecenter.cbor.CBORObject	findAttribute(com.upokecenter.cbor.CBORObject label) Locate an attribute in one of the attribute buckets The buckets are searched in the order protected, unprotected, unsent.
com.upokecenter.cbor.CBORObject	findAttribute(HeaderKeys key) Locate an attribute in one of the attribute buckets The buckets are searched in the order protected, unprotected, unsent.
void	setExternal(byte[] rgbData) Set the optional external data field to be authenticated

Methods inherited from class java.lang.Object

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

Field Detail

objProtected

protected com.upokecenter.cbor.CBORObject objProtected

objUnprotected

protected com.upokecenter.cbor.CBORObject objUnprotected

objDontSend

protected com.upokecenter.cbor.CBORObject objDontSend

rgbProtected

protected byte[] rgbProtected

externalData

protected byte[] externalData

ProtectedAttributes

public static final int ProtectedAttributes

See Also:

Constant Field Values

UnprotectedAttributes

public static final int UnprotectedAttributes

See Also:

Constant Field Values

DontSendAttributes

public static final int DontSendAttributes

See Also:

Constant Field Values

Constructor Detail

Attribute

public Attribute()

Method Detail

addAttribute

public void addAttribute(com.upokecenter.cbor.CBORObject label,
                         com.upokecenter.cbor.CBORObject value,
                         int where)

Set an attribute in the COSE object.

Parameters:

label - CBOR object which identifies the attribute in the map

value - CBOR object which contains the value of the attribute

where - Identifies which of the buckets to place the attribute in. ProtectedAttributes - attributes cryptographically protected UnprotectedAttributes - attributes not cryptographically protected DontSendAttributes - attributes used locally and not transmitted

addAttribute

public void addAttribute(HeaderKeys label,
                         com.upokecenter.cbor.CBORObject value,
                         int where)

Set an attribute in the COSE object.

Parameters:

label - HeaderKeys label which identifies the attribute in the map

value - CBOR object which contains the value of the attribute

where - Identifies which of the buckets to place the attribute in. ProtectedAttributes - attributes cryptographically protected UnprotectedAttributes - attributes not cryptographically protected DontSendAttributes - attributes used locally and not transmitted

addAttribute

public void addAttribute(HeaderKeys label,
                         byte[] value,
                         int where)

Set an attribute in the COSE object.

Parameters:

label - HeaderKeys label which identifies the attribute in the map

value - CBOR object which contains the value of the attribute

where - Identifies which of the buckets to place the attribute in. ProtectedAttributes - attributes cryptographically protected UnprotectedAttributes - attributes not cryptographically protected DontSendAttributes - attributes used locally and not transmitted

AddProtected

@Deprecated
public void AddProtected(com.upokecenter.cbor.CBORObject label,
                                      com.upokecenter.cbor.CBORObject value)

Deprecated. use addAttribute(com.upokecenter.cbor.CBORObject, com.upokecenter.cbor.CBORObject, int)

Set an attribute in the protect bucket of the COSE object

Parameters:

label - CBOR object which identifies the attribute in the map

value - CBOR object which contains the value of the attribute

AddProtected

@Deprecated
public void AddProtected(HeaderKeys label,
                                      com.upokecenter.cbor.CBORObject value)

Deprecated. use addAttribute(com.upokecenter.cbor.CBORObject, com.upokecenter.cbor.CBORObject, int)

Set an attribute in the protect bucket of the COSE object

Parameters:

label - HeaderKeys label which identifies the attribute in the map

value - CBOR object which contains the value of the attribute

AddProtected

@Deprecated
public void AddProtected(HeaderKeys label,
                                      byte[] value)

Deprecated. use addAttribute(HeaderKeys, byte[], int) with ProtectedAttributes

Set an attribute in the protect bucket of the COSE object

Parameters:

label - CBOR object which identifies the attribute in the map

value - byte array of value

AddUnprotected

public void AddUnprotected(com.upokecenter.cbor.CBORObject label,
                           com.upokecenter.cbor.CBORObject value)

AddUnprotected

public void AddUnprotected(HeaderKeys label,
                           com.upokecenter.cbor.CBORObject value)

AddUnprotected

public void AddUnprotected(HeaderKeys label,
                           byte[] value)

findAttribute

public com.upokecenter.cbor.CBORObject findAttribute(com.upokecenter.cbor.CBORObject label)

Locate an attribute in one of the attribute buckets The buckets are searched in the order protected, unprotected, unsent.

Parameters:

label - - Label of the value to be searched for

Returns:

- CBORObject with the value if found; otherwise null

findAttribute

public com.upokecenter.cbor.CBORObject findAttribute(HeaderKeys key)

Locate an attribute in one of the attribute buckets The buckets are searched in the order protected, unprotected, unsent.

Parameters:

key - - HeaderKey enumeration value to search for

Returns:

- CBORObject with the value if found; otherwise null

setExternal

public void setExternal(byte[] rgbData)

Set the optional external data field to be authenticated

Parameters:

rgbData - - data to be authenticated