cloud.opencode.base.crypto.mac.JcaHmac

All Implemented Interfaces:: Mac

public final class JcaHmac extends Object implements Mac

Generic JCA HMAC wrapper for any algorithm name supported by the JDK provider. Covers legacy / infrequent variants (HmacMD5, HmacSHA1, HmacSHA384) not served by the algorithm-specific classes HmacSha256 / HmacSha512. 通用 JCA HMAC 包装器，委托 JDK 提供的任意 HMAC 算法名。用于覆盖 HmacSha256 / HmacSha512 未覆盖的遗留/次要变体（HmacMD5、HmacSHA1、HmacSHA384 等）。

Features | 主要功能:

Arbitrary JCA HMAC algorithm - 任意 JCA HMAC 算法
Constant-time verification - 常量时间验证

Usage Examples | 使用示例:

Mac mac = JcaHmac.of("HmacSHA1", key);
String hex = mac.computeHex("payload".getBytes());

Security | 安全性:

Thread-safe: No (reuse creates shared state) - 线程安全: 否（实例有共享状态）
Null-safe: Yes - 空值安全: 是

Since:

JDK 25, opencode-base-crypto V1.0.4

Author:

Leon Soo www.LeonSoo.com

See Also:

Method Summary

Modifier and Type

Method

Description

byte[]

compute(byte[] data)

Computes MAC for the given byte array 计算给定字节数组的 MAC 值

byte[]

compute(String data)

Computes MAC for the given string (UTF-8 encoded) 计算给定字符串的 MAC 值（UTF-8 编码）

String

computeBase64(byte[] data)

Computes MAC and returns as Base64 string 计算 MAC 值并返回 Base64 字符串

String

computeHex(byte[] data)

Computes MAC and returns as hexadecimal string 计算 MAC 值并返回十六进制字符串

byte[]

doFinal()

Completes the MAC computation and returns the result 完成 MAC 计算并返回结果

String

doFinalBase64()

Completes the MAC computation and returns as Base64 string 完成 MAC 计算并返回 Base64 字符串

String

doFinalHex()

Completes the MAC computation and returns as hexadecimal string 完成 MAC 计算并返回十六进制字符串

String

getAlgorithm()

Returns the algorithm name 返回算法名称

int

getMacLength()

Returns the MAC length in bytes 返回 MAC 长度（字节数）

static JcaHmac

of(String algorithm, byte[] key)

Creates a new HMAC instance with the given algorithm name and raw key.

static JcaHmac

of(String algorithm, SecretKey key)

Creates a new HMAC instance with the given algorithm name and SecretKey.

Mac

reset()

Resets the MAC to its initial state 将 MAC 重置为初始状态

Mac

update(byte[] data)

Updates the MAC with a chunk of data (for incremental computation) 使用数据块更新 MAC（用于增量计算）

Mac

update(String data)

Updates the MAC with a string (UTF-8 encoded) 使用字符串更新 MAC（UTF-8 编码）

boolean

verify(byte[] data, byte[] macValue)

Verifies MAC for the given data using constant-time comparison 使用常量时间比较验证给定数据的 MAC 值

boolean

verifyBase64(byte[] data, String macBase64)

Verifies MAC from Base64 string using constant-time comparison 使用常量时间比较验证 Base64 字符串的 MAC 值

boolean

verifyHex(byte[] data, String macHex)

Verifies MAC from hexadecimal string using constant-time comparison 使用常量时间比较验证十六进制字符串的 MAC 值

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- of
  
  public static JcaHmac of(String algorithm, byte[] key)
  
  Creates a new HMAC instance with the given algorithm name and raw key. 使用指定算法名和原始密钥字节创建 HMAC 实例。
  
  Parameters:
  
  algorithm - JCA HMAC algorithm name (e.g. "HmacMD5", "HmacSHA1") | JCA HMAC 算法名
  
  key - secret key bytes | 密钥字节
  
  Returns:
  
  new JcaHmac instance | 新实例
  
  Throws:
  
  NullPointerException - if algorithm or key is null
- of
  
  public static JcaHmac of(String algorithm, SecretKey key)
  
  Creates a new HMAC instance with the given algorithm name and SecretKey. 使用指定算法名和 SecretKey 创建 HMAC 实例。
  
  Parameters:
  
  algorithm - JCA HMAC algorithm name | JCA HMAC 算法名
  
  key - the secret key | 密钥
  
  Returns:
  
  new JcaHmac instance | 新实例
  
  Throws:
  
  NullPointerException - if algorithm or key is null
- compute
  
  public byte[] compute(byte[] data)
  
  Description copied from interface: Mac
  
  Computes MAC for the given byte array 计算给定字节数组的 MAC 值
  
  Specified by:
  
  compute in interface Mac
  
  Parameters:
  
  data - the data to authenticate
  
  Returns:
  
  the MAC value
- compute
  
  public byte[] compute(String data)
  
  Description copied from interface: Mac
  
  Computes MAC for the given string (UTF-8 encoded) 计算给定字符串的 MAC 值（UTF-8 编码）
  
  Specified by:
  
  compute in interface Mac
  
  Parameters:
  
  data - the string to authenticate
  
  Returns:
  
  the MAC value
- computeHex
  
  public String computeHex(byte[] data)
  
  Description copied from interface: Mac
  
  Computes MAC and returns as hexadecimal string 计算 MAC 值并返回十六进制字符串
  
  Specified by:
  
  computeHex in interface Mac
  
  Parameters:
  
  data - the data to authenticate
  
  Returns:
  
  the MAC value as hex string
- computeBase64
  
  public String computeBase64(byte[] data)
  
  Description copied from interface: Mac
  
  Computes MAC and returns as Base64 string 计算 MAC 值并返回 Base64 字符串
  
  Specified by:
  
  computeBase64 in interface Mac
  
  Parameters:
  
  data - the data to authenticate
  
  Returns:
  
  the MAC value as Base64 string
- verify
  
  public boolean verify(byte[] data, byte[] macValue)
  
  Description copied from interface: Mac
  
  Verifies MAC for the given data using constant-time comparison 使用常量时间比较验证给定数据的 MAC 值
  
  Specified by:
  
  verify in interface Mac
  
  Parameters:
  
  data - the data to verify
  
  macValue - the expected MAC value
  
  Returns:
  
  true if MAC is valid, false otherwise
- verifyHex
  
  public boolean verifyHex(byte[] data, String macHex)
  
  Description copied from interface: Mac
  
  Verifies MAC from hexadecimal string using constant-time comparison 使用常量时间比较验证十六进制字符串的 MAC 值
  
  Specified by:
  
  verifyHex in interface Mac
  
  Parameters:
  
  data - the data to verify
  
  macHex - the expected MAC value in hex format
  
  Returns:
  
  true if MAC is valid, false otherwise
- verifyBase64
  
  public boolean verifyBase64(byte[] data, String macBase64)
  
  Description copied from interface: Mac
  
  Verifies MAC from Base64 string using constant-time comparison 使用常量时间比较验证 Base64 字符串的 MAC 值
  
  Specified by:
  
  verifyBase64 in interface Mac
  
  Parameters:
  
  data - the data to verify
  
  macBase64 - the expected MAC value in Base64 format
  
  Returns:
  
  true if MAC is valid, false otherwise
- update
  
  public Mac update(byte[] data)
  
  Description copied from interface: Mac
  
  Updates the MAC with a chunk of data (for incremental computation) 使用数据块更新 MAC（用于增量计算）
  
  Specified by:
  
  update in interface Mac
  
  Parameters:
  
  data - the data chunk to add
  
  Returns:
  
  this MAC instance for chaining
- update
  
  public Mac update(String data)
  
  Description copied from interface: Mac
  
  Updates the MAC with a string (UTF-8 encoded) 使用字符串更新 MAC（UTF-8 编码）
  
  Specified by:
  
  update in interface Mac
  
  Parameters:
  
  data - the string to add
  
  Returns:
  
  this MAC instance for chaining
- doFinal
  
  public byte[] doFinal()
  
  Description copied from interface: Mac
  
  Completes the MAC computation and returns the result 完成 MAC 计算并返回结果
  
  Specified by:
  
  doFinal in interface Mac
  
  Returns:
  
  the final MAC value
- doFinalHex
  
  public String doFinalHex()
  
  Description copied from interface: Mac
  
  Completes the MAC computation and returns as hexadecimal string 完成 MAC 计算并返回十六进制字符串
  
  Specified by:
  
  doFinalHex in interface Mac
  
  Returns:
  
  the final MAC value as hex string
- doFinalBase64
  
  public String doFinalBase64()
  
  Description copied from interface: Mac
  
  Completes the MAC computation and returns as Base64 string 完成 MAC 计算并返回 Base64 字符串
  
  Specified by:
  
  doFinalBase64 in interface Mac
  
  Returns:
  
  the final MAC value as Base64 string
- reset
  
  public Mac reset()
  
  Description copied from interface: Mac
  
  Resets the MAC to its initial state 将 MAC 重置为初始状态
  
  Specified by:
  
  reset in interface Mac
  
  Returns:
  
  this MAC instance for chaining
- getAlgorithm
  
  public String getAlgorithm()
  
  Description copied from interface: Mac
  
  Returns the algorithm name 返回算法名称
  
  Specified by:
  
  getAlgorithm in interface Mac
  
  Returns:
  
  the algorithm name
- getMacLength
  
  public int getMacLength()
  
  Description copied from interface: Mac
  
  Returns the MAC length in bytes 返回 MAC 长度（字节数）
  
  Specified by:
  
  getMacLength in interface Mac
  
  Returns:
  
  the MAC length

Class JcaHmac

Method Summary

Methods inherited from class Object

Method Details

of

of

compute

compute

computeHex

computeBase64

verify

verifyHex

verifyBase64

update

update

doFinal

doFinalHex

doFinalBase64

reset

getAlgorithm

getMacLength