Class HmacUtils
Mac tasks. This class is immutable and thread-safe.
However the Mac may not be.
Note: Not all JCE implementations support all algorithms. If not supported, an IllegalArgumentException is thrown.
Sample usage:
import static HmacAlgorithms.*;
byte[] key = {1,2,3,4}; // don't use this actual key!
String valueToDigest = "The quick brown fox jumps over the lazy dog";
byte[] hmac = new HmacUtils(HMAC_SHA_224, key).hmac(valueToDigest);
// Mac re-use
HmacUtils hm1 = new HmacUtils("HmacAlgoName", key); // use a valid name here!
String hexPom = hm1.hmacHex(new File("pom.xml"));
String hexNot = hm1.hmacHex(new File("NOTICE.txt"));
- Since:
- 1.10
-
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.since 1.11; only useful to preserve binary compatibilityCreates an instance using the provided algorithm type.Creates an instance using the provided algorithm type.HmacUtils(HmacAlgorithms algorithm, byte[] key) Creates an instance using the provided algorithm type.HmacUtils(HmacAlgorithms algorithm, String key) Creates an instance using the provided algorithm type. -
Method Summary
Modifier and TypeMethodDescriptionstatic MacgetHmacMd5(byte[] key) Deprecated.(1.11) UsegetInitializedMac(HmacAlgorithms.HMAC_MD5, byte[])static MacgetHmacSha1(byte[] key) Deprecated.(1.11) UsegetInitializedMac(HmacAlgorithms.HMAC_SHA_1, byte[])static MacgetHmacSha256(byte[] key) Deprecated.(1.11) UsegetInitializedMac(HmacAlgorithms.HMAC_SHA_256, byte[])static MacgetHmacSha384(byte[] key) Deprecated.(1.11) UsegetInitializedMac(HmacAlgorithms.HMAC_SHA_384, byte[])static MacgetHmacSha512(byte[] key) Deprecated.(1.11) UsegetInitializedMac(HmacAlgorithms.HMAC_SHA_512, byte[])static MacgetInitializedMac(String algorithm, byte[] key) Returns an initializedMacfor the givenalgorithm.static MacgetInitializedMac(HmacAlgorithms algorithm, byte[] key) Returns an initializedMacfor the givenalgorithm.byte[]hmac(byte[] valueToDigest) Returns the digest for the input data.byte[]Returns the digest for the file.byte[]hmac(InputStream valueToDigest) Returns the digest for the stream.byte[]Returns the digest for the input data.byte[]hmac(ByteBuffer valueToDigest) Returns the digest for the input data.hmacHex(byte[] valueToDigest) Returns the digest for the input data.Returns the digest for the file.hmacHex(InputStream valueToDigest) Returns the digest for the stream.Returns the digest for the input data.hmacHex(ByteBuffer valueToDigest) Returns the digest for the input data.static byte[]hmacMd5(byte[] key, byte[] valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_MD5, byte[]).hmac(byte[])static byte[]hmacMd5(byte[] key, InputStream valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_MD5, byte[]).hmac(InputStream)static byte[]Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_MD5, String).hmac(String)static StringhmacMd5Hex(byte[] key, byte[] valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_MD5, byte[]).hmacHex(byte[])static StringhmacMd5Hex(byte[] key, InputStream valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_MD5, byte[]).hmacHex(InputStream)static StringhmacMd5Hex(String key, String valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_MD5, String).hmacHex(String)static byte[]hmacSha1(byte[] key, byte[] valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_1, byte[]).hmac(byte[])static byte[]hmacSha1(byte[] key, InputStream valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_1, byte[]).hmac(InputStream)static byte[]Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_1, String).hmac(String)static StringhmacSha1Hex(byte[] key, byte[] valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_1, byte[]).hmacHex(byte[])static StringhmacSha1Hex(byte[] key, InputStream valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_1, byte[]).hmacHex(InputStream)static StringhmacSha1Hex(String key, String valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_1, String).hmacHex(String)static byte[]hmacSha256(byte[] key, byte[] valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_256, byte[]).hmac(byte[])static byte[]hmacSha256(byte[] key, InputStream valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_256, byte[]).hmac(InputStream)static byte[]hmacSha256(String key, String valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_256, String).hmac(String)static StringhmacSha256Hex(byte[] key, byte[] valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_256, byte[]).hmacHex(byte[])static StringhmacSha256Hex(byte[] key, InputStream valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_256, byte[]).hmacHex(InputStream)static StringhmacSha256Hex(String key, String valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_256, String).hmacHex(String)static byte[]hmacSha384(byte[] key, byte[] valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_384, byte[]).hmac(byte[])static byte[]hmacSha384(byte[] key, InputStream valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_384, byte[]).hmac(InputStream)static byte[]hmacSha384(String key, String valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_384, String).hmac(String)static StringhmacSha384Hex(byte[] key, byte[] valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_384, byte[]).hmacHex(byte[])static StringhmacSha384Hex(byte[] key, InputStream valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_384, byte[]).hmacHex(InputStream)static StringhmacSha384Hex(String key, String valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_384, String).hmacHex(String)static byte[]hmacSha512(byte[] key, byte[] valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_512, byte[]).hmac(byte[])static byte[]hmacSha512(byte[] key, InputStream valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_512, byte[]).hmac(InputStream)static byte[]hmacSha512(String key, String valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_512, String).hmac(String)static StringhmacSha512Hex(byte[] key, byte[] valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_512, byte[]).hmacHex(byte[])static StringhmacSha512Hex(byte[] key, InputStream valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_512, byte[]).hmacHex(InputStream)static StringhmacSha512Hex(String key, String valueToDigest) Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_512, String).hmacHex(String)static booleanisAvailable(String name) Returns whether this algorithm is availablestatic booleanisAvailable(HmacAlgorithms name) Returns whether this algorithm is availablestatic MacupdateHmac(Mac mac, byte[] valueToDigest) Resets and then updates the givenMacwith the value.static MacupdateHmac(Mac mac, InputStream valueToDigest) Resets and then updates the givenMacwith the value.static MacupdateHmac(Mac mac, String valueToDigest) Resets and then updates the givenMacwith the value.
-
Constructor Details
-
HmacUtils
Deprecated.since 1.11; only useful to preserve binary compatibilityPreserves binary compatibility only. As for previous versions does not provide useful behavior -
HmacUtils
Creates an instance using the provided algorithm type.- Parameters:
algorithm- to use.key- the key to use- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.- Since:
- 1.11
-
HmacUtils
Creates an instance using the provided algorithm type.- Parameters:
algorithm- to usekey- the key to use- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.- Since:
- 1.11
-
HmacUtils
Creates an instance using the provided algorithm type.- Parameters:
algorithm- to usekey- the key to use- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.- Since:
- 1.11
-
HmacUtils
Creates an instance using the provided algorithm type.- Parameters:
algorithm- to usekey- the key to use- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.- Since:
- 1.11
-
-
Method Details
-
getHmacMd5
Deprecated.(1.11) UsegetInitializedMac(HmacAlgorithms.HMAC_MD5, byte[])Returns an initializedMacfor the HmacMD5 algorithm.Every implementation of the Java platform is required to support this standard Mac algorithm.
- Parameters:
key- The key for the keyed digest (must not be null)- Returns:
- A Mac instance initialized with the given key.
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.- See Also:
-
getHmacSha1
Deprecated.(1.11) UsegetInitializedMac(HmacAlgorithms.HMAC_SHA_1, byte[])Returns an initializedMacfor the HmacSHA1 algorithm.Every implementation of the Java platform is required to support this standard Mac algorithm.
- Parameters:
key- The key for the keyed digest (must not be null)- Returns:
- A Mac instance initialized with the given key.
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.- See Also:
-
getHmacSha256
Deprecated.(1.11) UsegetInitializedMac(HmacAlgorithms.HMAC_SHA_256, byte[])Returns an initializedMacfor the HmacSHA256 algorithm.Every implementation of the Java platform is required to support this standard Mac algorithm.
- Parameters:
key- The key for the keyed digest (must not be null)- Returns:
- A Mac instance initialized with the given key.
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.- See Also:
-
getHmacSha384
Deprecated.(1.11) UsegetInitializedMac(HmacAlgorithms.HMAC_SHA_384, byte[])Returns an initializedMacfor the HmacSHA384 algorithm.Every implementation of the Java platform is not required to support this Mac algorithm.
- Parameters:
key- The key for the keyed digest (must not be null)- Returns:
- A Mac instance initialized with the given key.
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.- See Also:
-
getHmacSha512
Deprecated.(1.11) UsegetInitializedMac(HmacAlgorithms.HMAC_SHA_512, byte[])Returns an initializedMacfor the HmacSHA512 algorithm.Every implementation of the Java platform is not required to support this Mac algorithm.
- Parameters:
key- The key for the keyed digest (must not be null)- Returns:
- A Mac instance initialized with the given key.
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.- See Also:
-
getInitializedMac
Returns an initializedMacfor the givenalgorithm.- Parameters:
algorithm- the name of the algorithm requested. See Appendix A in the Java Cryptography Architecture Reference Guide for information about standard algorithm names.key- The key for the keyed digest (must not be null)- Returns:
- A Mac instance initialized with the given key.
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.- See Also:
-
getInitializedMac
Returns an initializedMacfor the givenalgorithm.- Parameters:
algorithm- the name of the algorithm requested. See Appendix A in the Java Cryptography Architecture Reference Guide for information about standard algorithm names.key- The key for the keyed digest (must not be null)- Returns:
- A Mac instance initialized with the given key.
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.- See Also:
-
hmacMd5
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_MD5, byte[]).hmac(byte[])Returns a HmacMD5 Message Authentication Code (MAC) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacMD5 MAC for the given key and value
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacMd5
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_MD5, byte[]).hmac(InputStream)Returns a HmacMD5 Message Authentication Code (MAC) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digestThe InputStream must not be null and will not be closed
- Returns:
- HmacMD5 MAC for the given key and value
- Throws:
IOException- If an I/O error occurs.IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacMd5
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_MD5, String).hmac(String)Returns a HmacMD5 Message Authentication Code (MAC) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacMD5 MAC for the given key and value
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacMd5Hex
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_MD5, byte[]).hmacHex(byte[])Returns a HmacMD5 Message Authentication Code (MAC) as a hexadecimal string (lowercase) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacMD5 MAC for the given key and value as a hexadecimal string (lowercase)
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacMd5Hex
@Deprecated public static String hmacMd5Hex(byte[] key, InputStream valueToDigest) throws IOException Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_MD5, byte[]).hmacHex(InputStream)Returns a HmacMD5 Message Authentication Code (MAC) as a hexadecimal string (lowercase) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digestThe InputStream must not be null and will not be closed
- Returns:
- HmacMD5 MAC for the given key and value as a hexadecimal string (lowercase)
- Throws:
IOException- If an I/O error occurs.IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacMd5Hex
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_MD5, String).hmacHex(String)Returns a HmacMD5 Message Authentication Code (MAC) as a hexadecimal string (lowercase) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacMD5 MAC for the given key and value as a hexadecimal string (lowercase)
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha1
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_1, byte[]).hmac(byte[])Returns a HmacSHA1 Message Authentication Code (MAC) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacSHA1 MAC for the given key and value
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha1
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_1, byte[]).hmac(InputStream)Returns a HmacSHA1 Message Authentication Code (MAC) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digestThe InputStream must not be null and will not be closed
- Returns:
- HmacSHA1 MAC for the given key and value
- Throws:
IOException- If an I/O error occurs.IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha1
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_1, String).hmac(String)Returns a HmacSHA1 Message Authentication Code (MAC) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacSHA1 MAC for the given key and value
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha1Hex
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_1, byte[]).hmacHex(byte[])Returns a HmacSHA1 Message Authentication Code (MAC) as hexadecimal string (lowercase) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacSHA1 MAC for the given key and value as hexadecimal string (lowercase)
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha1Hex
@Deprecated public static String hmacSha1Hex(byte[] key, InputStream valueToDigest) throws IOException Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_1, byte[]).hmacHex(InputStream)Returns a HmacSHA1 Message Authentication Code (MAC) as hexadecimal string (lowercase) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digestThe InputStream must not be null and will not be closed
- Returns:
- HmacSHA1 MAC for the given key and value as hexadecimal string (lowercase)
- Throws:
IOException- If an I/O error occurs.IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha1Hex
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_1, String).hmacHex(String)Returns a HmacSHA1 Message Authentication Code (MAC) as hexadecimal string (lowercase) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacSHA1 MAC for the given key and value as hexadecimal string (lowercase)
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha256
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_256, byte[]).hmac(byte[])Returns a HmacSHA256 Message Authentication Code (MAC) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacSHA256 MAC for the given key and value
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha256
@Deprecated public static byte[] hmacSha256(byte[] key, InputStream valueToDigest) throws IOException Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_256, byte[]).hmac(InputStream)Returns a HmacSHA256 Message Authentication Code (MAC) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digestThe InputStream must not be null and will not be closed
- Returns:
- HmacSHA256 MAC for the given key and value
- Throws:
IOException- If an I/O error occurs.IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha256
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_256, String).hmac(String)Returns a HmacSHA256 Message Authentication Code (MAC) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacSHA256 MAC for the given key and value
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha256Hex
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_256, byte[]).hmacHex(byte[])Returns a HmacSHA256 Message Authentication Code (MAC) as hexadecimal string (lowercase) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacSHA256 MAC for the given key and value as hexadecimal string (lowercase)
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha256Hex
@Deprecated public static String hmacSha256Hex(byte[] key, InputStream valueToDigest) throws IOException Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_256, byte[]).hmacHex(InputStream)Returns a HmacSHA256 Message Authentication Code (MAC) as hexadecimal string (lowercase) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digestThe InputStream must not be null and will not be closed
- Returns:
- HmacSHA256 MAC for the given key and value as hexadecimal string (lowercase)
- Throws:
IOException- If an I/O error occurs.IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha256Hex
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_256, String).hmacHex(String)Returns a HmacSHA256 Message Authentication Code (MAC) as hexadecimal string (lowercase) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacSHA256 MAC for the given key and value as hexadecimal string (lowercase)
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha384
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_384, byte[]).hmac(byte[])Returns a HmacSHA384 Message Authentication Code (MAC) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacSHA384 MAC for the given key and value
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha384
@Deprecated public static byte[] hmacSha384(byte[] key, InputStream valueToDigest) throws IOException Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_384, byte[]).hmac(InputStream)Returns a HmacSHA384 Message Authentication Code (MAC) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digestThe InputStream must not be null and will not be closed
- Returns:
- HmacSHA384 MAC for the given key and value
- Throws:
IOException- If an I/O error occurs.IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha384
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_384, String).hmac(String)Returns a HmacSHA384 Message Authentication Code (MAC) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacSHA384 MAC for the given key and value
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha384Hex
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_384, byte[]).hmacHex(byte[])Returns a HmacSHA384 Message Authentication Code (MAC) as hexadecimal string (lowercase) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacSHA384 MAC for the given key and value as hexadecimal string (lowercase)
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha384Hex
@Deprecated public static String hmacSha384Hex(byte[] key, InputStream valueToDigest) throws IOException Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_384, byte[]).hmacHex(InputStream)Returns a HmacSHA384 Message Authentication Code (MAC) as hexadecimal string (lowercase) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digestThe InputStream must not be null and will not be closed
- Returns:
- HmacSHA384 MAC for the given key and value as hexadecimal string (lowercase)
- Throws:
IOException- If an I/O error occurs.IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha384Hex
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_384, String).hmacHex(String)Returns a HmacSHA384 Message Authentication Code (MAC) as hexadecimal string (lowercase) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacSHA384 MAC for the given key and value as hexadecimal string (lowercase)
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha512
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_512, byte[]).hmac(byte[])Returns a HmacSHA512 Message Authentication Code (MAC) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacSHA512 MAC for the given key and value
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha512
@Deprecated public static byte[] hmacSha512(byte[] key, InputStream valueToDigest) throws IOException Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_512, byte[]).hmac(InputStream)Returns a HmacSHA512 Message Authentication Code (MAC) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digestThe InputStream must not be null and will not be closed
- Returns:
- HmacSHA512 MAC for the given key and value
- Throws:
IOException- If an I/O error occurs.IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha512
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_512, String).hmac(String)Returns a HmacSHA512 Message Authentication Code (MAC) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacSHA512 MAC for the given key and value
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha512Hex
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_512, byte[]).hmacHex(byte[])Returns a HmacSHA512 Message Authentication Code (MAC) as hexadecimal string (lowercase) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacSHA512 MAC for the given key and value as hexadecimal string (lowercase)
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha512Hex
@Deprecated public static String hmacSha512Hex(byte[] key, InputStream valueToDigest) throws IOException Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_512, byte[]).hmacHex(InputStream)Returns a HmacSHA512 Message Authentication Code (MAC) as hexadecimal string (lowercase) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digestThe InputStream must not be null and will not be closed
- Returns:
- HmacSHA512 MAC for the given key and value as hexadecimal string (lowercase)
- Throws:
IOException- If an I/O error occurs.IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
hmacSha512Hex
Deprecated.(1.11) Usenew HmacUtils(HmacAlgorithms.HMAC_SHA_512, String).hmacHex(String)Returns a HmacSHA512 Message Authentication Code (MAC) as hexadecimal string (lowercase) for the given key and value.- Parameters:
key- The key for the keyed digest (must not be null)valueToDigest- The value (data) which should to digest (maybe empty or null)- Returns:
- HmacSHA512 MAC for the given key and value as hexadecimal string (lowercase)
- Throws:
IllegalArgumentException- when aNoSuchAlgorithmExceptionis caught or key is null or key is invalid.
-
isAvailable
Returns whether this algorithm is available- Parameters:
name- the name to check- Returns:
- whether this algorithm is available
- Since:
- 1.11
-
isAvailable
Returns whether this algorithm is available- Parameters:
name- the name to check- Returns:
- whether this algorithm is available
- Since:
- 1.11
-
updateHmac
Resets and then updates the givenMacwith the value.- Parameters:
mac- the initializedMacto updatevalueToDigest- the value to update theMacwith (maybe null or empty)- Returns:
- the updated
Mac - Throws:
IllegalStateException- if the Mac was not initialized
-
updateHmac
Resets and then updates the givenMacwith the value.- Parameters:
mac- the initializedMacto updatevalueToDigest- the value to update theMacwithThe InputStream must not be null and will not be closed
- Returns:
- the updated
Mac - Throws:
IOException- If an I/O error occurs.IllegalStateException- If the Mac was not initialized
-
updateHmac
Resets and then updates the givenMacwith the value.- Parameters:
mac- the initializedMacto updatevalueToDigest- the value to update theMacwith (maybe null or empty)- Returns:
- the updated
Mac - Throws:
IllegalStateException- if the Mac was not initialized
-
hmac
Returns the digest for the input data.- Parameters:
valueToDigest- the input to use- Returns:
- the digest as a byte[]
- Since:
- 1.11
-
hmac
Returns the digest for the input data.- Parameters:
valueToDigest- the input to use- Returns:
- the digest as a byte[]
- Since:
- 1.11
-
hmac
Returns the digest for the file.- Parameters:
valueToDigest- the file to use- Returns:
- the digest
- Throws:
IOException- If an I/O error occurs.- Since:
- 1.11
-
hmac
Returns the digest for the stream.- Parameters:
valueToDigest- the data to useThe InputStream must not be null and will not be closed
- Returns:
- the digest
- Throws:
IOException- If an I/O error occurs.- Since:
- 1.11
-
hmac
Returns the digest for the input data.- Parameters:
valueToDigest- the input to use, treated as UTF-8- Returns:
- the digest as a byte[]
- Since:
- 1.11
-
hmacHex
Returns the digest for the input data.- Parameters:
valueToDigest- the input to use- Returns:
- the digest as a hexadecimal String
- Since:
- 1.11
-
hmacHex
Returns the digest for the input data.- Parameters:
valueToDigest- the input to use- Returns:
- the digest as a hexadecimal String
- Since:
- 1.11
-
hmacHex
Returns the digest for the file.- Parameters:
valueToDigest- the file to use- Returns:
- the digest as a hexadecimal String
- Throws:
IOException- If an I/O error occurs.- Since:
- 1.11
-
hmacHex
Returns the digest for the stream.- Parameters:
valueToDigest- the data to useThe InputStream must not be null and will not be closed
- Returns:
- the digest as a hexadecimal String
- Throws:
IOException- If an I/O error occurs.- Since:
- 1.11
-
hmacHex
Returns the digest for the input data.- Parameters:
valueToDigest- the input to use, treated as UTF-8- Returns:
- the digest as a hexadecimal String
- Since:
- 1.11
-