Class DsseEnvelope

java.lang.Object

org.apache.commons.release.plugin.slsa.v1_2.DsseEnvelope

public class DsseEnvelope
extends Object

DSSE (Dead Simple Signing Envelope) that wraps a signed in-toto statement payload.

Since:

1.10.0

See Also:

• DSSE Envelope specification

Field Summary

Fields

Modifier and Type	Field	Description
private byte[]	payload	Serialized statement bytes, Base64-encoded in JSON.
static final String	PAYLOAD_TYPE	The payload type URI for in-toto attestation statements.
private String	payloadType	Content type identifying the format of payload.
private List<Signature>	signatures	One or more signatures over the PAE-encoded payload.

Constructor Summary

Constructors

Constructor	Description
DsseEnvelope()	Creates a new DsseEnvelope instance with payloadType pre-set to PAYLOAD_TYPE.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
byte[]	getPayload()	Gets the serialized payload bytes.
String	getPayloadType()	Gets the payload type URI.
List<Signature>	getSignatures()	Gets the list of signatures over the PAE-encoded payload.
int	hashCode()
DsseEnvelope	setPayload(byte[] payload)	Sets the serialized payload bytes.
DsseEnvelope	setPayloadType(String payloadType)	Sets the payload type URI.
DsseEnvelope	setSignatures(List<Signature> signatures)	Sets the list of signatures over the PAE-encoded payload.
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PAYLOAD_TYPE

public static final String PAYLOAD_TYPE

The payload type URI for in-toto attestation statements.

See Also:

• Constant Field Values

payload

private byte[] payload

Serialized statement bytes, Base64-encoded in JSON.

payloadType

private String payloadType

Content type identifying the format of payload.

signatures

private List<Signature> signatures

One or more signatures over the PAE-encoded payload.

Constructor Details

DsseEnvelope

public DsseEnvelope()

Creates a new DsseEnvelope instance with payloadType pre-set to PAYLOAD_TYPE.

Method Details

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getPayload

public byte[] getPayload()

Gets the serialized payload bytes.

When serialized to JSON, the bytes are Base64-encoded.

Returns:

The payload bytes, or null if not set.

getPayloadType

public String getPayloadType()

Gets the payload type URI.

Returns:

The payload type, never null in a valid envelope.

getSignatures

public List<Signature> getSignatures()

Gets the list of signatures over the PAE-encoded payload.

Returns:

The signatures, or null if not set.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setPayload

public DsseEnvelope setPayload(byte[] payload)

Sets the serialized payload bytes.

Parameters:

payload - The payload bytes.

Returns:

this for chaining.

setPayloadType

public DsseEnvelope setPayloadType(String payloadType)

Sets the payload type URI.

Parameters:

payloadType - The payload type URI.

Returns:

this for chaining.

setSignatures

public DsseEnvelope setSignatures(List<Signature> signatures)

Sets the list of signatures over the PAE-encoded payload.

Parameters:

signatures - The signatures.

Returns:

this for chaining.

toString

public String toString()

Overrides:

toString in class Object