Package org.apache.hadoop.crypto

Class OpensslSm4CtrCryptoCodec

java.lang.Object

org.apache.hadoop.crypto.CryptoCodec

org.apache.hadoop.crypto.OpensslCtrCryptoCodec

org.apache.hadoop.crypto.OpensslSm4CtrCryptoCodec

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Configurable

@Private
public class OpensslSm4CtrCryptoCodec
extends OpensslCtrCryptoCodec

Implement the SM4-CTR crypto codec using JNI into OpenSSL.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.crypto.OpensslCtrCryptoCodec

OpensslCtrCryptoCodec.OpensslCtrCipher

Constructor Summary

Constructors

Constructor	Description
OpensslSm4CtrCryptoCodec()

Method Summary

Modifier and Type	Method	Description
void	calculateIV(byte[] initIV, long counter, byte[] iv)	This interface is only for Counter (CTR) mode.
Decryptor	createDecryptor()	Create a Decryptor.
Encryptor	createEncryptor()	Create a Encryptor.
CipherSuite	getCipherSuite()
org.slf4j.Logger	getLogger()
void	setConf(Configuration conf)	Set the configuration to be used by this object.

Methods inherited from class org.apache.hadoop.crypto.OpensslCtrCryptoCodec

calculateIV, close, generateSecureRandom, getConf, getEngineId, getRandom, setEngineId, setRandom

Methods inherited from class org.apache.hadoop.crypto.CryptoCodec

getInstance, getInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

OpensslSm4CtrCryptoCodec

public OpensslSm4CtrCryptoCodec()

Method Detail

getLogger

public org.slf4j.Logger getLogger()

Specified by:

getLogger in class OpensslCtrCryptoCodec

setConf

public void setConf(Configuration conf)

Description copied from interface: Configurable

Set the configuration to be used by this object.

Specified by:

setConf in interface Configurable

Overrides:

setConf in class OpensslCtrCryptoCodec

Parameters:

conf - configuration to be used

getCipherSuite

public CipherSuite getCipherSuite()

Specified by:

getCipherSuite in class CryptoCodec

Returns:

the CipherSuite for this codec.

calculateIV

public void calculateIV(byte[] initIV,
                        long counter,
                        byte[] iv)

Description copied from class: CryptoCodec

This interface is only for Counter (CTR) mode. Generally the Encryptor or Decryptor calculates the IV and maintain encryption context internally. For example a Cipher will maintain its encryption context internally when we do encryption/decryption using the Cipher#update interface.

Encryption/Decryption is not always on the entire file. For example, in Hadoop, a node may only decrypt a portion of a file (i.e. a split). In these situations, the counter is derived from the file position.

The IV can be calculated by combining the initial IV and the counter with a lossless operation (concatenation, addition, or XOR). See http://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Counter_ .28CTR.29

Specified by:

calculateIV in class CryptoCodec

Parameters:

initIV - initial IV

counter - counter for input stream position

iv - the IV for input stream position

createEncryptor

public Encryptor createEncryptor()
                          throws java.security.GeneralSecurityException

Description copied from class: CryptoCodec

Create a Encryptor.

Specified by:

createEncryptor in class CryptoCodec

Returns:

Encryptor the encryptor.

Throws:

java.security.GeneralSecurityException - thrown if create encryptor error.

createDecryptor

public Decryptor createDecryptor()
                          throws java.security.GeneralSecurityException

Description copied from class: CryptoCodec

Create a Decryptor.

Specified by:

createDecryptor in class CryptoCodec

Returns:

Decryptor the decryptor

Throws:

java.security.GeneralSecurityException - thrown if create decryptor error.