Package software.amazon.encryption.s3.materials

Class EncryptionMaterials

java.lang.Object

software.amazon.encryption.s3.materials.EncryptionMaterials

All Implemented Interfaces:

CryptographicMaterials

public final class EncryptionMaterials
extends Object
implements CryptographicMaterials

Contains the cryptographic materials needed for an encryption operation.

See Also:

CryptographicMaterialsManager.getEncryptionMaterials(EncryptionMaterialsRequest)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EncryptionMaterials.Builder

Method Summary

Modifier and Type	Method	Description
AlgorithmSuite	algorithmSuite()
static EncryptionMaterials.Builder	builder()
CipherMode	cipherMode()
Provider	cryptoProvider()
SecretKey	dataKey()
List<EncryptedDataKey>	encryptedDataKeys()	Note that the underlying implementation uses a Collections.unmodifiableList which is immutable.
Map<String,String>	encryptionContext()	Note that the underlying implementation uses a Collections.unmodifiableMap which is immutable.
Cipher	getCipher(byte[] iv)
long	getCiphertextLength()
byte[]	getKeyCommitment()
long	getPlaintextLength()
byte[]	iv()
MaterialsDescription	materialsDescription()
byte[]	messageId()
byte[]	plaintextDataKey()
software.amazon.awssdk.services.s3.model.S3Request	s3Request()
void	setIvAndMessageId(byte[] iv, byte[] messageId)
void	setKeyCommitment(byte[] keyCommitment)
EncryptionMaterials.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static EncryptionMaterials.Builder builder()

s3Request

public software.amazon.awssdk.services.s3.model.S3Request s3Request()

Specified by:

s3Request in interface CryptographicMaterials

algorithmSuite

public AlgorithmSuite algorithmSuite()

Specified by:

algorithmSuite in interface CryptographicMaterials

encryptionContext

public Map<String,String> encryptionContext()

Note that the underlying implementation uses a Collections.unmodifiableMap which is immutable.

Specified by:

encryptionContext in interface CryptographicMaterials

encryptedDataKeys

public List<EncryptedDataKey> encryptedDataKeys()

Note that the underlying implementation uses a Collections.unmodifiableList which is immutable.

plaintextDataKey

public byte[] plaintextDataKey()

getPlaintextLength

public long getPlaintextLength()

getCiphertextLength

public long getCiphertextLength()

dataKey

public SecretKey dataKey()

Specified by:

dataKey in interface CryptographicMaterials

cryptoProvider

public Provider cryptoProvider()

Specified by:

cryptoProvider in interface CryptographicMaterials

materialsDescription

public MaterialsDescription materialsDescription()

cipherMode

public CipherMode cipherMode()

Specified by:

cipherMode in interface CryptographicMaterials

getCipher

public Cipher getCipher(byte[] iv)

Specified by:

getCipher in interface CryptographicMaterials

getKeyCommitment

public byte[] getKeyCommitment()

Specified by:

getKeyCommitment in interface CryptographicMaterials

setKeyCommitment

public void setKeyCommitment(byte[] keyCommitment)

messageId

public byte[] messageId()

Specified by:

messageId in interface CryptographicMaterials

iv

public byte[] iv()

Specified by:

iv in interface CryptographicMaterials

setIvAndMessageId

public void setIvAndMessageId(byte[] iv,
                              byte[] messageId)

toBuilder

public EncryptionMaterials.Builder toBuilder()