Package software.amazon.encryption.s3.materials

Class DecryptionMaterials

java.lang.Object

software.amazon.encryption.s3.materials.DecryptionMaterials

All Implemented Interfaces:

CryptographicMaterials

public final class DecryptionMaterials
extends Object
implements CryptographicMaterials

Contains the cryptographic materials needed for a decryption operation.

See Also:

CryptographicMaterialsManager.decryptMaterials(DecryptMaterialsRequest)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DecryptionMaterials.Builder

Method Summary

Modifier and Type	Method	Description
AlgorithmSuite	algorithmSuite()
static DecryptionMaterials.Builder	builder()
CipherMode	cipherMode()
long	ciphertextLength()
Provider	cryptoProvider()
SecretKey	dataKey()
Map<String,String>	encryptionContext()	Note that the underlying implementation uses a Collections.unmodifiableMap which is immutable.
Cipher	getCipher(byte[] iv)
String	getContentRange()
byte[]	getKeyCommitment()
byte[]	iv()
MaterialsDescription	materialsDescription()	Returns the materials description used for RSA and AES keyrings.
byte[]	messageId()
byte[]	plaintextDataKey()
software.amazon.awssdk.services.s3.model.GetObjectRequest	s3Request()
void	setIvAndMessageId(byte[] iv, byte[] messageId)
DecryptionMaterials.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 DecryptionMaterials.Builder builder()

s3Request

public software.amazon.awssdk.services.s3.model.GetObjectRequest 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

materialsDescription

public MaterialsDescription materialsDescription()

Returns the materials description used for RSA and AES keyrings.

Returns:

the materials description

plaintextDataKey

public byte[] plaintextDataKey()

dataKey

public SecretKey dataKey()

Specified by:

dataKey in interface CryptographicMaterials

cryptoProvider

public Provider cryptoProvider()

Specified by:

cryptoProvider in interface CryptographicMaterials

ciphertextLength

public long ciphertextLength()

cipherMode

public CipherMode cipherMode()

Specified by:

cipherMode in interface CryptographicMaterials

getCipher

public Cipher getCipher(byte[] iv)

Specified by:

getCipher in interface CryptographicMaterials

getContentRange

public String getContentRange()

getKeyCommitment

public byte[] getKeyCommitment()

Specified by:

getKeyCommitment in interface CryptographicMaterials

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 DecryptionMaterials.Builder toBuilder()