com.biz.common.jwt.KeyUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of biz-all Show documentation

BizX 是一个灵活而高效的业务开发框架, 其中也有很多为业务开发所需要的工具类的提供。

The newest version!

package com.biz.common.jwt;

import com.biz.common.utils.Common;
import io.jsonwebtoken.SignatureAlgorithm;

import javax.crypto.spec.SecretKeySpec;
import java.security.Key;
import java.util.Base64;

/**
 * KeyUtils类提供用于生成JWT密钥Key的工具方法。
 * 该类支持根据密钥字符串、密钥对象和签名算法生成Key对象，用于JWT的签名和验证。
 *
 * 示例代码：
 * {@code
 * Key keyFromString = KeyUtils.getKeyFromSecret("your-secret-key");
 * Key keyFromAlgorithm = KeyUtils.getKeyFromSecret(SignatureAlgorithm.HS256);
 * }
 *
 * 该类依赖于 {@link JwtUtils} 和 {@link Common} 类提供的工具方法。
 *
 * @author francis
 * @version 1.0.1
 * @since 1.0.1
 */
public final class KeyUtils {

    /**
     * 根据密钥对象生成Key。
     *
     * @param secret 密钥对象。
     * @return 生成的Key对象。
     */
    public static Key getKeyFromSecret(Key secret) {
        return getKeyFromSecret(secret, null);
    }

    /**
     * 根据密钥字符串生成Key。
     *
     * @param secret 密钥字符串。
     * @return 生成的Key对象。
     */
    public static Key getKeyFromSecret(String secret) {
        return getKeyFromSecret(secret, null);
    }

    /**
     * 根据签名算法生成Key。
     *
     * @param signatureAlgorithm 签名算法。
     * @return 生成的Key对象。
     */
    public static Key getKeyFromSecret(SignatureAlgorithm signatureAlgorithm) {
        return getKeyFromSecret("", signatureAlgorithm);
    }

    /**
     * 根据密钥字符串和签名算法生成Key。
     *
     * @param secret             密钥字符串。
     * @param signatureAlgorithm 签名算法。
     * @return 生成的Key对象。
     */
    public static Key getKeyFromSecret(String secret, SignatureAlgorithm signatureAlgorithm) {
        byte[] keyBytes = Base64.getEncoder().encode(Common.isBlank(secret) ? JwtUtils.DEFAULT_SECRET.getBytes() : secret.getBytes());
        return new SecretKeySpec(keyBytes, signatureAlgorithm == null ? JwtUtils.DEFAULT_SIGNATURE_ALGORITHM.getJcaName() : signatureAlgorithm.getJcaName());
    }

    /**
     * 根据密钥对象和签名算法生成Key。
     *
     * @param secret             密钥对象。
     * @param signatureAlgorithm 签名算法。
     * @return 生成的Key对象。
     */
    public static Key getKeyFromSecret(Key secret, SignatureAlgorithm signatureAlgorithm) {
        return new SecretKeySpec(secret.getEncoded(), signatureAlgorithm == null ? JwtUtils.DEFAULT_SIGNATURE_ALGORITHM.getJcaName() : signatureAlgorithm.getJcaName());
    }
}