Class SigStructureBuilder

java.lang.Object

com.authlete.cose.SigStructureBuilder

public class SigStructureBuilder
extends Object

A utility to build a SigStructure instance.

The SigStructure class represents Sig_structure which is defined in 4.4. Signing and Verification Process of RFC 9052 as follows.

 Sig_structure = [
     context : "Signature" / "Signature1",
     body_protected : empty_or_serialized_map,
     ? sign_protected : empty_or_serialized_map,
     external_aad : bstr,
     payload : bstr
 ]
 

Since:

1.1

See Also:

• RFC 9052, 4.4. Signing and Verification Process
• SigStructure

Constructor Summary

Constructors

Constructor	Description
SigStructureBuilder()

Method Summary

Modifier and Type	Method	Description
SigStructureBuilder	bodyAttributes(COSEProtectedHeader attributes)	Set the attributes to Sig_structure.body_protected.
SigStructure	build()	Build a SigStructure instance that represents Sig_structure.
SigStructureBuilder	externalData(byte[] data)	Set the data to Sig_structure.external_add.
SigStructureBuilder	externalData(CBORByteArray data)	Set the data to Sig_structure.external_add.
SigStructureBuilder	payload(byte[] payload)	Set the payload to Sig_structure.payload.
SigStructureBuilder	payload(CBORByteArray payload)	Set the payload to Sig_structure.payload.
SigStructureBuilder	payload(String payload)	Set the payload to Sig_structure.payload.
SigStructureBuilder	sign(COSESign sign)	Set some fields of Sig_structure based on the given COSESign object that represents COSE_Sign which is defined in 4.1.
SigStructureBuilder	sign1(COSESign1 sign1)	Set some fields of Sig_structure based on the given COSESign1 object that represents COSE_Sign1 which is defined in 4.2.
SigStructureBuilder	signature()	Set "Signature" to Sig_structure.context.
SigStructureBuilder	signature(COSESignature signature)	Set the protected header of the given COSESignature object to Sig_structure.sign_protected.
SigStructureBuilder	signature1()	Set "Signature1" to Sig_structure.context.
SigStructureBuilder	signerAttributes(COSEProtectedHeader attributes)	Set the attributes to Sig_structure.sign_protected.

Methods inherited from class java.lang.Object

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

Constructor Details

SigStructureBuilder

public SigStructureBuilder()

Method Details

signature

public SigStructureBuilder signature()

Set "Signature" to Sig_structure.context.

Returns:

this object.

signature1

public SigStructureBuilder signature1()

Set "Signature1" to Sig_structure.context.

Returns:

this object.

bodyAttributes

public SigStructureBuilder bodyAttributes(COSEProtectedHeader attributes)

Set the attributes to Sig_structure.body_protected.

Parameters:

attributes - The protected header of the body information (COSE_Sign or COSE_Sign1).

Returns:

this object.

signerAttributes

public SigStructureBuilder signerAttributes(COSEProtectedHeader attributes)

Set the attributes to Sig_structure.sign_protected.

Parameters:

attributes - The protected header of a COSE_Signature.

Returns:

this object.

externalData

public SigStructureBuilder externalData(CBORByteArray data)

Set the data to Sig_structure.external_add.

Parameters:

data - The externally supplied data.

Returns:

this object.

externalData

public SigStructureBuilder externalData(byte[] data)

Set the data to Sig_structure.external_add.

Parameters:

data - The externally supplied data.

Returns:

this object.

payload

public SigStructureBuilder payload(CBORByteArray payload)

Set the payload to Sig_structure.payload.

Parameters:

payload - The payload to be signed.

Returns:

this object.

payload

public SigStructureBuilder payload(byte[] payload)

Set the payload to Sig_structure.payload.

Parameters:

payload - The payload to be signed.

Returns:

this object.

payload

public SigStructureBuilder payload(String payload)

Set the payload to Sig_structure.payload.

Parameters:

payload - The payload to be signed. Its UTF-8 byte sequence is used.

Returns:

this object.

sign

public SigStructureBuilder sign(COSESign sign)

Set some fields of Sig_structure based on the given COSESign object that represents COSE_Sign which is defined in 4.1. Signing with One or More Signers of RFC 9052.

The implementation of this method does the following.

1. Set "Signature" to Sig_structure.context.
2. Set sign.getProtectedeHeader() to Sig_structure.body_protected.
3. Set sign.getPayload() to Sig_sructure.payload if the payload is not null and not a CBORNull instance.

Parameters:

sign - A COSESign object that represents COSE_Sign.

Returns:

this object.

See Also:

• RFC 9052, 4.1. Signing with One or More Signers

signature

public SigStructureBuilder signature(COSESignature signature)

Set the protected header of the given COSESignature object to Sig_structure.sign_protected.

The COSESignature class represents COSE_Signature which is defined in 4.1. Signing with One or More Signers of RFC 9052.

Parameters:

signature - A COSESignature object that represents COSE_Signature.

Returns:

this object.

sign1

public SigStructureBuilder sign1(COSESign1 sign1)

Set some fields of Sig_structure based on the given COSESign1 object that represents COSE_Sign1 which is defined in 4.2. Signing with One Signer of RFC 9052.

The implementation of this method does the following.

1. Set "Signature1" to Sig_structure.context.
2. Set sign1.getProtectedeHeader() to Sig_structure.body_protected.
3. Set sign1.getPayload() to Sig_sructure.payload if the payload is not null and not a CBORNull instance.

Parameters:

sign1 - A COSESign1 object that represents COSE_Sign1.

Returns:

this object.

See Also:

• RFC 9052, 4.2. Signing with One Signer

build

public SigStructure build()
                   throws IllegalStateException

Build a SigStructure instance that represents Sig_structure.

For this method to return a SigStructure instance successfully, the following must be satisfied.

1. signature(), signature1(), sign(COSESign), or sign1(COSESign1) must have been called to set Sig_structure.context.
2. payload(CBORByteArray), sign(COSESign) or sign1(COSESign1) must have been called to set Sig_structure.payload.

Returns:

A newly created SigStructure instance.

Throws:

IllegalStateException