Package com.linecorp.centraldogma.server.storage.encryption

Enum Class NoopEncryptionStorageManager

java.lang.Object

java.lang.Enum<NoopEncryptionStorageManager>

com.linecorp.centraldogma.server.storage.encryption.NoopEncryptionStorageManager

All Implemented Interfaces:

SafeCloseable, EncryptionStorageManager, Serializable, AutoCloseable, Comparable<NoopEncryptionStorageManager>, java.lang.constant.Constable

public enum NoopEncryptionStorageManager
extends Enum<NoopEncryptionStorageManager>
implements EncryptionStorageManager

A no-operation implementation of EncryptionStorageManager that does not perform any encryption.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE	Singleton instance of NoopEncryptionStorageManager.

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	containsMetadata(byte[] key)	Returns true if the specified key exists.
void	deleteObjectId(byte[] metadataKey, byte[] key)	Deletes the specified keys.
void	deleteRepositoryData(String projectName, String repoName)	Deletes all data related to the specified project and repository.
boolean	enabled()	Returns true if the encryption at rest is enabled.
boolean	encryptSessionCookie()	Returns true if the session cookie should be encrypted.
CompletableFuture<SessionMasterKey>	generateSessionMasterKey()	Generates a new session master key.
CompletableFuture<byte[]>	generateWdek()	Generates a new data encryption key (DEK) and wraps it.
Map<String,Map<String,byte[]>>	getAllData()	Returns all data stored in the encryption storage manager.
SecretKeyWithVersion	getCurrentDek(String projectName, String repoName)	Returns the current wrapped data encryption key (WDEK) for the specified project and repository.
CompletableFuture<SessionKey>	getCurrentSessionKey()	Returns the current session master key.
SecretKey	getDek(String projectName, String repoName, int i)	Returns the data encryption key (DEK) for the specified project and repository.
byte[]	getMetadata(byte[] metadataKey)	Returns the value of the specified metadata key.
byte[]	getObject(byte[] key, byte[] metadataKey)	Returns the object associated with the specified key.
byte[]	getObjectId(byte[] key, byte[] metadataKey)	Returns the object ID bytes associated with the specified key.
void	putObject(byte[] metadataKey, byte[] metadataValue, byte[] key, byte[] value)	Stores the specified key-value object with metadata.
void	putObjectId(byte[] metadataKey, byte[] metadataValue, byte[] key, byte[] value, byte[] previousKeyToRemove)	Stores the specified key-value pair with metadata.
void	removeWdek(String projectName, String repoName)	Removes the wrapped data encryption key (WDEK) for the specified project and repository.
void	storeSessionMasterKey(SessionMasterKey sessionMasterKey)	Stores the session master key.
void	storeWdek(String projectName, String repoName, byte[] wdek)	Stores the wrapped data encryption key (WDEK) for the specified project and repository.
static NoopEncryptionStorageManager	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NoopEncryptionStorageManager[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final NoopEncryptionStorageManager INSTANCE

Singleton instance of NoopEncryptionStorageManager.

Method Details

values

public static NoopEncryptionStorageManager[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static NoopEncryptionStorageManager valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

enabled

public boolean enabled()

Description copied from interface: EncryptionStorageManager

Returns true if the encryption at rest is enabled.

Specified by:

enabled in interface EncryptionStorageManager

encryptSessionCookie

public boolean encryptSessionCookie()

Description copied from interface: EncryptionStorageManager

Returns true if the session cookie should be encrypted.

Specified by:

encryptSessionCookie in interface EncryptionStorageManager

generateWdek

public CompletableFuture<byte[]> generateWdek()

Description copied from interface: EncryptionStorageManager

Generates a new data encryption key (DEK) and wraps it.

Specified by:

generateWdek in interface EncryptionStorageManager

generateSessionMasterKey

public CompletableFuture<SessionMasterKey> generateSessionMasterKey()

Description copied from interface: EncryptionStorageManager

Generates a new session master key.

Specified by:

generateSessionMasterKey in interface EncryptionStorageManager

storeSessionMasterKey

public void storeSessionMasterKey(SessionMasterKey sessionMasterKey)

Description copied from interface: EncryptionStorageManager

Stores the session master key.

Specified by:

storeSessionMasterKey in interface EncryptionStorageManager

getCurrentSessionKey

public CompletableFuture<SessionKey> getCurrentSessionKey()

Description copied from interface: EncryptionStorageManager

Returns the current session master key.

Specified by:

getCurrentSessionKey in interface EncryptionStorageManager

getDek

@Nullable
public SecretKey getDek(String projectName,
 String repoName,
 int i)

Description copied from interface: EncryptionStorageManager

Returns the data encryption key (DEK) for the specified project and repository.

Specified by:

getDek in interface EncryptionStorageManager

getCurrentDek

@Nullable
public SecretKeyWithVersion getCurrentDek(String projectName,
 String repoName)

Description copied from interface: EncryptionStorageManager

Returns the current wrapped data encryption key (WDEK) for the specified project and repository.

Specified by:

getCurrentDek in interface EncryptionStorageManager

storeWdek

public void storeWdek(String projectName,
 String repoName,
 byte[] wdek)

Description copied from interface: EncryptionStorageManager

Stores the wrapped data encryption key (WDEK) for the specified project and repository. This raises an exception if the WDEK already exists.

Specified by:

storeWdek in interface EncryptionStorageManager

removeWdek

public void removeWdek(String projectName,
 String repoName)

Description copied from interface: EncryptionStorageManager

Removes the wrapped data encryption key (WDEK) for the specified project and repository.

Specified by:

removeWdek in interface EncryptionStorageManager

getObject

public byte[] getObject(byte[] key,
 byte[] metadataKey)

Description copied from interface: EncryptionStorageManager

Returns the object associated with the specified key.

Specified by:

getObject in interface EncryptionStorageManager

getObjectId

public byte[] getObjectId(byte[] key,
 byte[] metadataKey)

Description copied from interface: EncryptionStorageManager

Returns the object ID bytes associated with the specified key.

Specified by:

getObjectId in interface EncryptionStorageManager

getMetadata

public byte[] getMetadata(byte[] metadataKey)

Description copied from interface: EncryptionStorageManager

Returns the value of the specified metadata key.

Specified by:

getMetadata in interface EncryptionStorageManager

putObject

public void putObject(byte[] metadataKey,
 byte[] metadataValue,
 byte[] key,
 byte[] value)

Description copied from interface: EncryptionStorageManager

Stores the specified key-value object with metadata.

Specified by:

putObject in interface EncryptionStorageManager

putObjectId

public void putObjectId(byte[] metadataKey,
 byte[] metadataValue,
 byte[] key,
 byte[] value,
 @Nullable
 byte[] previousKeyToRemove)

Description copied from interface: EncryptionStorageManager

Stores the specified key-value pair with metadata. The previousKeyToRemove will be removed.

Specified by:

putObjectId in interface EncryptionStorageManager

containsMetadata

public boolean containsMetadata(byte[] key)

Description copied from interface: EncryptionStorageManager

Returns true if the specified key exists.

Specified by:

containsMetadata in interface EncryptionStorageManager

deleteObjectId

public void deleteObjectId(byte[] metadataKey,
 byte[] key)

Description copied from interface: EncryptionStorageManager

Deletes the specified keys.

Specified by:

deleteObjectId in interface EncryptionStorageManager

deleteRepositoryData

public void deleteRepositoryData(String projectName,
 String repoName)

Description copied from interface: EncryptionStorageManager

Deletes all data related to the specified project and repository.

Specified by:

deleteRepositoryData in interface EncryptionStorageManager

getAllData

public Map<String,Map<String,byte[]>> getAllData()

Description copied from interface: EncryptionStorageManager

Returns all data stored in the encryption storage manager.

Specified by:

getAllData in interface EncryptionStorageManager

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SafeCloseable