org.apache.hadoop.hbase.security

Class EncryptionUtil

java.lang.Object

org.apache.hadoop.hbase.security.EncryptionUtil

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public class EncryptionUtil
extends java.lang.Object

Some static utility methods for encryption uses in hbase-client.

Constructor Summary

Constructors

Constructor and Description
EncryptionUtil()

Method Summary

Modifier and Type	Method and Description
static java.security.Key	unwrapKey(Configuration conf, java.lang.String subject, byte[] value) Unwrap a key by decrypting it with the secret key of the given subject.
static java.security.Key	unwrapWALKey(Configuration conf, java.lang.String subject, byte[] value) Unwrap a wal key by decrypting it with the secret key of the given subject.
static byte[]	wrapKey(Configuration conf, byte[] key, java.lang.String algorithm) Protect a key by encrypting it with the secret key of the given subject.
static byte[]	wrapKey(Configuration conf, java.lang.String subject, java.security.Key key) Protect a key by encrypting it with the secret key of the given subject.

Methods inherited from class java.lang.Object

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

Constructor Detail

EncryptionUtil

public EncryptionUtil()

Method Detail

wrapKey

public static byte[] wrapKey(Configuration conf,
                             byte[] key,
                             java.lang.String algorithm)
                      throws java.io.IOException

Protect a key by encrypting it with the secret key of the given subject. The configuration must be set up correctly for key alias resolution.

Parameters:

conf - configuration

key - the raw key bytes

algorithm - the algorithm to use with this key material

Returns:

the encrypted key bytes

Throws:

java.io.IOException

wrapKey

public static byte[] wrapKey(Configuration conf,
                             java.lang.String subject,
                             java.security.Key key)
                      throws java.io.IOException

Protect a key by encrypting it with the secret key of the given subject. The configuration must be set up correctly for key alias resolution.

Parameters:

conf - configuration

subject - subject key alias

key - the key

Returns:

the encrypted key bytes

Throws:

java.io.IOException

unwrapKey

public static java.security.Key unwrapKey(Configuration conf,
                                          java.lang.String subject,
                                          byte[] value)
                                   throws java.io.IOException,
                                          java.security.KeyException

Unwrap a key by decrypting it with the secret key of the given subject. The configuration must be set up correctly for key alias resolution.

Parameters:

conf - configuration

subject - subject key alias

value - the encrypted key bytes

Returns:

the raw key bytes

Throws:

java.io.IOException

java.security.KeyException

unwrapWALKey

public static java.security.Key unwrapWALKey(Configuration conf,
                                             java.lang.String subject,
                                             byte[] value)
                                      throws java.io.IOException,
                                             java.security.KeyException

Unwrap a wal key by decrypting it with the secret key of the given subject. The configuration must be set up correctly for key alias resolution.

Parameters:

conf - configuration

subject - subject key alias

value - the encrypted key bytes

Returns:

the raw key bytes

Throws:

java.io.IOException - if key is not found for the subject, or if some I/O error occurs

java.security.KeyException - if fail to unwrap the key