io.minio

Class ServerSideEncryption

java.lang.Object

io.minio.ServerSideEncryption

All Implemented Interfaces:

Destroyable

public abstract class ServerSideEncryption
extends Object
implements Destroyable

ServerSideEncryption represents a form of server-side encryption.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServerSideEncryption.Type The types of server-side encryption.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	destroyed

Constructor Summary

Constructors

Constructor and Description
ServerSideEncryption()

Method Summary

Modifier and Type	Method and Description
static ServerSideEncryption	atRest() Create a new server-side-encryption object for encryption at rest (a.k.a.
static ServerSideEncryption	copyWithCustomerKey(SecretKey key) Create a new server-side-encryption object for encryption with customer provided keys (a.k.a.
abstract ServerSideEncryption.Type	getType() Returns the type of server-side encryption.
boolean	isDestroyed()
abstract void	marshal(Map<String,String> headers) Set the server-side-encryption headers of this specific encryption.
static ServerSideEncryption	withCustomerKey(SecretKey key) Create a new server-side-encryption object for encryption with customer provided keys (a.k.a.
static ServerSideEncryption	withManagedKeys(String keyId, Map<String,String> context) Create a new server-side-encryption object for encryption using a KMS (a.k.a.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.security.auth.Destroyable

destroy

Field Detail

destroyed

protected boolean destroyed

Constructor Detail

ServerSideEncryption

public ServerSideEncryption()

Method Detail

getType

public abstract ServerSideEncryption.Type getType()

Returns the type of server-side encryption.

Returns:

the type of server-side encryption.

marshal

public abstract void marshal(Map<String,String> headers)

Set the server-side-encryption headers of this specific encryption.

Parameters:

headers - The metadata key-value map.

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface Destroyable

withCustomerKey

public static ServerSideEncryption withCustomerKey(SecretKey key)
                                            throws InvalidKeyException,
                                                   NoSuchAlgorithmException

Create a new server-side-encryption object for encryption with customer provided keys (a.k.a. SSE-C).

Parameters:

key - The secret AES-256 key.

Returns:

An instance of ServerSideEncryption implementing SSE-C.

Throws:

InvalidKeyException - if the provided secret key is not a 256 bit AES key.

NoSuchAlgorithmException - if the crypto provider does not implement MD5.

copyWithCustomerKey

public static ServerSideEncryption copyWithCustomerKey(SecretKey key)
                                                throws InvalidKeyException,
                                                       NoSuchAlgorithmException

Create a new server-side-encryption object for encryption with customer provided keys (a.k.a. SSE-C).

Parameters:

key - The secret AES-256 key.

Returns:

An instance of ServerSideEncryption implementing SSE-C.

Throws:

InvalidKeyException - if the provided secret key is not a 256 bit AES key.

NoSuchAlgorithmException - if the crypto provider does not implement MD5.

atRest

public static ServerSideEncryption atRest()

Create a new server-side-encryption object for encryption at rest (a.k.a. SSE-S3).

Returns:

an instance of ServerSideEncryption implementing SSE-S3

withManagedKeys

public static ServerSideEncryption withManagedKeys(String keyId,
                                                   Map<String,String> context)
                                            throws InvalidArgumentException,
                                                   UnsupportedEncodingException

Create a new server-side-encryption object for encryption using a KMS (a.k.a. SSE-KMS).

Parameters:

keyId - specifies the customer-master-key (CMK) and must not be null.

context - is the encryption context. If the context is null no context is used.

Returns:

an instance of ServerSideEncryption implementing SSE-KMS.

Throws:

InvalidArgumentException

UnsupportedEncodingException