org.waarp.common.crypto

Class HmacSha1

java.lang.Object

org.waarp.common.crypto.KeyObject

org.waarp.common.crypto.HmacSha1

public class HmacSha1
extends KeyObject

This class handles methods to crypt (not decrypt) messages with HmacSha1 algorithm (very efficient: 136000/s).

Usage:

• Create a HmacSha1 object: HmacSha1 key = new HmacSha1();
• Create a key:
  • Generate: key.generateKey();
    The method key.getSecretKeyInBytes() allow getting the key in Bytes.
  • From an external source: key.setSecretKey(arrayOfBytes);
• To crypt a String in a Base64 format: String myStringCrypt = key.cryptToString(myString);

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTENSION

Constructor Summary

Constructors

Constructor and Description
HmacSha1()

Method Summary

Modifier and Type	Method and Description
byte[]	crypt(byte[] plaintext) Crypt one array of bytes and returns the crypted array of bytes
byte[]	decrypt(byte[] ciphertext) Decrypt an array of bytes and returns the uncrypted array of bytes
String	getAlgorithm()
String	getFileExtension()
String	getInstance()
int	getKeySize()
Cipher	toCrypt() Returns a cipher for encryption associated with the key
Cipher	toDecrypt() Returns a cipher for decryption associated with the key

Methods inherited from class org.waarp.common.crypto.KeyObject

crypt, cryptToHex, cryptToHex, decodeHex, decryptHexFile, decryptHexInBytes, decryptHexInBytes, decryptHexInString, decryptHexInString, decryptInString, encodeHex, generateKey, getSecretKey, getSecretKeyInBytes, keyReady, saveSecretKey, setSecretKey, setSecretKey, setSecretKey

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION

public static final String EXTENSION

See Also:

Constant Field Values

Constructor Detail

HmacSha1

public HmacSha1()

Method Detail

getAlgorithm

public final String getAlgorithm()

Specified by:

getAlgorithm in class KeyObject

Returns:

the algorithm used (Java name)

getInstance

public final String getInstance()

Specified by:

getInstance in class KeyObject

Returns:

the instance used (Java name)

getKeySize

public final int getKeySize()

Specified by:

getKeySize in class KeyObject

Returns:

the size for the algorithm key

getFileExtension

public final String getFileExtension()

Specified by:

getFileExtension in class KeyObject

Returns:

the filename extension to use for this kind of key

toCrypt

public final Cipher toCrypt()

Description copied from class: KeyObject

Returns a cipher for encryption associated with the key

Overrides:

toCrypt in class KeyObject

Returns:

the cipher for encryption or null if it fails in case Encryption method or key is incorrect

crypt

public final byte[] crypt(byte[] plaintext)
                   throws Exception

Description copied from class: KeyObject

Crypt one array of bytes and returns the crypted array of bytes

Overrides:

crypt in class KeyObject

Returns:

the crypted array of bytes

Throws:

Exception

toDecrypt

public final Cipher toDecrypt()

Description copied from class: KeyObject

Returns a cipher for decryption associated with the key

Overrides:

toDecrypt in class KeyObject

Returns:

the cipher for decryption or null if it fails in case Encryption method or key is incorrect

decrypt

public final byte[] decrypt(byte[] ciphertext)
                     throws Exception

Description copied from class: KeyObject

Decrypt an array of bytes and returns the uncrypted array of bytes

Overrides:

decrypt in class KeyObject

Returns:

the uncrypted array of bytes

Throws:

Exception