Package org.apache.hadoop.fs.azurebfs.security

Class ContextProviderEncryptionAdapter

java.lang.Object

org.apache.hadoop.fs.azurebfs.security.ContextEncryptionAdapter

org.apache.hadoop.fs.azurebfs.security.ContextProviderEncryptionAdapter

public class ContextProviderEncryptionAdapter
extends ContextEncryptionAdapter

Class manages the encryptionContext and encryptionKey that needs to be added to the headers to server request if Customer-Encryption-Context is enabled in the configuration.
For fileCreation, the object helps in creating encryptionContext through the implementation of EncryptionContextProvider.
For all operations, the object helps in converting encryptionContext to encryptionKey through the implementation of EncryptionContextProvider.

Constructor Summary

Constructors

Constructor	Description
ContextProviderEncryptionAdapter(EncryptionContextProvider provider, java.lang.String path)	Following constructor called in case of createPath.
ContextProviderEncryptionAdapter(EncryptionContextProvider provider, java.lang.String path, byte[] encryptionContext)	Following constructor called when the encryptionContext of file is known.

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroys all the encapsulated fields which are used for creating keys.
java.lang.String	getEncodedContext()
java.lang.String	getEncodedKey()
java.lang.String	getEncodedKeySHA()

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextProviderEncryptionAdapter

public ContextProviderEncryptionAdapter(EncryptionContextProvider provider,
                                        java.lang.String path,
                                        byte[] encryptionContext)
                                 throws java.io.IOException

Following constructor called when the encryptionContext of file is known. The server shall send encryptionContext as a String, the constructor shall convert the string into a byte-array. The converted byte-array would be used by the implementation of EncryptionContextProvider to create byte-array of encryptionKey.

Parameters:

provider - developer's implementation of EncryptionContextProvider

path - Path for which encryptionContext and encryptionKeys to be stored in the object

encryptionContext - encryptionContext for the path stored in the backend

Throws:

java.io.IOException - throws back the exception it receives from the computeKeys() method call.

ContextProviderEncryptionAdapter

public ContextProviderEncryptionAdapter(EncryptionContextProvider provider,
                                        java.lang.String path)
                                 throws java.io.IOException

Following constructor called in case of createPath. Since, the path is not on the server, encryptionContext is not there for the path. Implementation of the EncryptionContextProvider would be used to create encryptionContext from the path.

Parameters:

provider - developer's implementation of EncryptionContextProvider

path - file path for which encryptionContext and encryptionKeys to be created and stored

Throws:

java.io.IOException - throws back the exception it receives from the method call to EncryptionContextProvider object.

Method Detail

getEncodedKey

public java.lang.String getEncodedKey()

Specified by:

getEncodedKey in class ContextEncryptionAdapter

Returns:

computed encryptionKey from server provided encryptionContext

getEncodedKeySHA

public java.lang.String getEncodedKeySHA()

Specified by:

getEncodedKeySHA in class ContextEncryptionAdapter

Returns:

computed encryptionKeySHA from server provided encryptionContext

getEncodedContext

public java.lang.String getEncodedContext()

Specified by:

getEncodedContext in class ContextEncryptionAdapter

Returns:

encryptionContext to be supplied in createPath API

destroy

public void destroy()

Description copied from class: ContextEncryptionAdapter

Destroys all the encapsulated fields which are used for creating keys.

Specified by:

destroy in class ContextEncryptionAdapter