KeyUtil (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.crypto.KeyUtil

public class KeyUtil
extends Object

密钥工具类

包括:

 1、生成密钥（单密钥、密钥对）
 2、读取密钥文件

Since:: 4.4.1
Author:: looly, Gsealy

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_KEY_SIZE` 默认密钥字节数 RSA/DSA Default Keysize 1024 Keysize must be a multiple of 64, ranging from 512 to 1024 (inclusive).

Constructor Summary

Constructors
Constructor and Description

KeyUtil()

Constructors
Constructor and Description
`KeyUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static PrivateKey`	`decodeECPrivateKey(byte[] encodeByte, String curveName)` 解码恢复EC私钥,支持Base64和Hex编码,（基于BouncyCastle）
`static PrivateKey`	`decodeECPrivateKey(String encode, String curveName)` 解码恢复EC私钥,支持Base64和Hex编码,（基于BouncyCastle）
`static PublicKey`	`decodeECPublicKey(byte[] encodeByte, String curveName)` 解码恢复EC压缩公钥,支持Base64和Hex编码,（基于BouncyCastle）见：...
`static PublicKey`	`decodeECPublicKey(String encode, String curveName)` 解码恢复EC压缩公钥,支持Base64和Hex编码,（基于BouncyCastle）见：...
`static byte[]`	`encodeECPrivateKey(PrivateKey privateKey)` 编码压缩EC私钥（基于BouncyCastle）
`static byte[]`	`encodeECPublicKey(PublicKey publicKey)` 编码压缩EC公钥（基于BouncyCastle）见：...
`static SecretKey`	`generateDESKey(String algorithm, byte[] key)` 生成 `SecretKey`
`static SecretKey`	`generateKey(String algorithm)` 生成 `SecretKey`，仅用于对称加密和摘要算法密钥生成
`static SecretKey`	`generateKey(String algorithm, byte[] key)` 生成 `SecretKey`，仅用于对称加密和摘要算法密钥生成
`static SecretKey`	`generateKey(String algorithm, int keySize)` 生成 `SecretKey`，仅用于对称加密和摘要算法密钥生成当指定keySize<0时，AES默认长度为128，其它算法不指定。
`static SecretKey`	`generateKey(String algorithm, int keySize, SecureRandom random)` 生成 `SecretKey`，仅用于对称加密和摘要算法密钥生成当指定keySize<0时，AES默认长度为128，其它算法不指定。
`static SecretKey`	`generateKey(String algorithm, KeySpec keySpec)` 生成 `SecretKey`，仅用于对称加密和摘要算法
`static KeyPair`	`generateKeyPair(String algorithm)` 生成用于非对称加密的公钥和私钥，仅用于非对称加密密钥对生成算法见：...
`static KeyPair`	`generateKeyPair(String algorithm, AlgorithmParameterSpec params)` 生成用于非对称加密的公钥和私钥密钥对生成算法见：...
`static KeyPair`	`generateKeyPair(String algorithm, byte[] seed, AlgorithmParameterSpec param)` 生成用于非对称加密的公钥和私钥密钥对生成算法见：...
`static KeyPair`	`generateKeyPair(String algorithm, int keySize)` 生成用于非对称加密的公钥和私钥密钥对生成算法见：...
`static KeyPair`	`generateKeyPair(String algorithm, int keySize, byte[] seed)` 生成用于非对称加密的公钥和私钥密钥对生成算法见：...
`static KeyPair`	`generateKeyPair(String algorithm, int keySize, byte[] seed, AlgorithmParameterSpec... params)` 生成用于非对称加密的公钥和私钥密钥对生成算法见：...
`static KeyPair`	`generateKeyPair(String algorithm, int keySize, SecureRandom random, AlgorithmParameterSpec... params)` 生成用于非对称加密的公钥和私钥密钥对生成算法见：...
`static SecretKey`	`generatePBEKey(String algorithm, char[] password)` 生成PBE `SecretKey`
`static PrivateKey`	`generatePrivateKey(KeyStore keyStore, String alias, char[] password)` 生成私钥，仅用于非对称加密
`static PrivateKey`	`generatePrivateKey(String algorithm, byte[] key)` 生成私钥，仅用于非对称加密采用PKCS#8规范，此规范定义了私钥信息语法和加密私钥语法算法见：...
`static PrivateKey`	`generatePrivateKey(String algorithm, KeySpec keySpec)` 生成私钥，仅用于非对称加密算法见：...
`static PublicKey`	`generatePublicKey(String algorithm, byte[] key)` 生成公钥，仅用于非对称加密采用X509证书规范算法见：...
`static PublicKey`	`generatePublicKey(String algorithm, KeySpec keySpec)` 生成公钥，仅用于非对称加密算法见：...
`static PrivateKey`	`generateRSAPrivateKey(byte[] key)` 生成RSA私钥，仅用于非对称加密采用PKCS#8规范，此规范定义了私钥信息语法和加密私钥语法算法见：...
`static PublicKey`	`generateRSAPublicKey(byte[] key)` 生成RSA公钥，仅用于非对称加密采用X509证书规范算法见：...
`static String`	`getAlgorithmAfterWith(String algorithm)` 获取用于密钥生成的算法获取XXXwithXXX算法的后半部分算法，如果为ECDSA或SM2，返回算法为EC
`static KeyFactory`	`getKeyFactory(String algorithm)` 获取`KeyFactory`
`static KeyGenerator`	`getKeyGenerator(String algorithm)` 获取`KeyGenerator`
`static KeyPair`	`getKeyPair(KeyStore keyStore, char[] password, String alias)` 从KeyStore中获取私钥公钥
`static KeyPair`	`getKeyPair(String type, InputStream in, char[] password, String alias)` 从KeyStore中获取私钥公钥
`static KeyPairGenerator`	`getKeyPairGenerator(String algorithm)` 获取`KeyPairGenerator`
`static String`	`getMainAlgorithm(String algorithm)` 获取主体算法名，例如RSA/ECB/PKCS1Padding的主体算法是RSA
`static PublicKey`	`getRSAPublicKey(BigInteger modulus, BigInteger publicExponent)` 获得RSA公钥对象
`static PublicKey`	`getRSAPublicKey(PrivateKey privateKey)` 通过RSA私钥生成RSA公钥
`static PublicKey`	`getRSAPublicKey(String modulus, String publicExponent)` 获得RSA公钥对象
`static SecretKeyFactory`	`getSecretKeyFactory(String algorithm)` 获取`SecretKeyFactory`
`static boolean`	`isEmpty(KeyPair keyPair)` 检查`KeyPair` 是否为空，空的条件是： keyPair本身为`null` `KeyPair.getPrivate()`和`KeyPair.getPublic()`都为`null`
`static PublicKey`	`readPublicKeyFromCert(InputStream in)` 读取X.509 Certification文件中的公钥 Certification为证书文件 see: ...
`static String`	`toBase64(Key key)` 将密钥编码为Base64格式

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

- Field Detail
  - DEFAULT_KEY_SIZE
```
public static final int DEFAULT_KEY_SIZE
```
    默认密钥字节数
```
 RSA/DSA
 Default Keysize 1024
 Keysize must be a multiple of 64, ranging from 512 to 1024 (inclusive).
 
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - KeyUtil
```
public KeyUtil()
```
- Method Detail
  - toBase64
```
public static String toBase64(Key key)
```
    将密钥编码为Base64格式
    
    Parameters:
    
    key - 密钥
    
    Returns:
    
    Base64格式密钥
    
    Since:
    
    5.7.22
  - generateKey
```
public static SecretKey generateKey(String algorithm)
```
    生成 SecretKey，仅用于对称加密和摘要算法密钥生成
    
    Parameters:
    
    algorithm - 算法，支持PBE算法
    
    Returns:
    
    SecretKey
  - generateKey
```
public static SecretKey generateKey(String algorithm,
                                    int keySize)
```
    生成 SecretKey，仅用于对称加密和摘要算法密钥生成
    当指定keySize<0时，AES默认长度为128，其它算法不指定。
    
    Parameters:
    
    algorithm - 算法，支持PBE算法
    
    keySize - 密钥长度，<0表示不设定密钥长度，即使用默认长度
    
    Returns:
    
    SecretKey
    
    Since:
    
    3.1.2
  - generateKey
```
public static SecretKey generateKey(String algorithm,
                                    int keySize,
                                    SecureRandom random)
```
    生成 SecretKey，仅用于对称加密和摘要算法密钥生成
    当指定keySize<0时，AES默认长度为128，其它算法不指定。
    
    Parameters:
    
    algorithm - 算法，支持PBE算法
    
    keySize - 密钥长度，<0表示不设定密钥长度，即使用默认长度
    
    random - 随机数生成器，null表示默认
    
    Returns:
    
    SecretKey
    
    Since:
    
    5.5.2
  - generateKey
```
public static SecretKey generateKey(String algorithm,
                                    byte[] key)
```
    生成 SecretKey，仅用于对称加密和摘要算法密钥生成
    
    Parameters:
    
    algorithm - 算法
    
    key - 密钥，如果为null 自动生成随机密钥
    
    Returns:
    
    SecretKey
  - generateDESKey
```
public static SecretKey generateDESKey(String algorithm,
                                       byte[] key)
```
    生成 SecretKey
    
    Parameters:
    
    algorithm - DES算法，包括DES、DESede等
    
    key - 密钥
    
    Returns:
    
    SecretKey
  - generatePBEKey
```
public static SecretKey generatePBEKey(String algorithm,
                                       char[] password)
```
    生成PBE SecretKey
    
    Parameters:
    
    algorithm - PBE算法，包括：PBEWithMD5AndDES、PBEWithSHA1AndDESede、PBEWithSHA1AndRC2_40等
    
    password - 口令
    
    Returns:
    
    SecretKey
  - generateKey
```
public static SecretKey generateKey(String algorithm,
                                    KeySpec keySpec)
```
    生成 SecretKey，仅用于对称加密和摘要算法
    
    Parameters:
    
    algorithm - 算法
    
    keySpec - KeySpec
    
    Returns:
    
    SecretKey
  - getKeyGenerator
```
public static KeyGenerator getKeyGenerator(String algorithm)
```
    获取KeyGenerator
    
    Parameters:
    
    algorithm - 对称加密算法
    
    Returns:
    
    KeyGenerator
    
    Since:
    
    4.5.2
  - generateRSAPrivateKey
```
public static PrivateKey generateRSAPrivateKey(byte[] key)
```
    生成RSA私钥，仅用于非对称加密
    采用PKCS#8规范，此规范定义了私钥信息语法和加密私钥语法
    算法见：...
    
    Parameters:
    
    key - 密钥，必须为DER编码存储
    
    Returns:
    
    RSA私钥 PrivateKey
    
    Since:
    
    4.5.2
  - generatePrivateKey
```
public static PrivateKey generatePrivateKey(String algorithm,
                                            byte[] key)
```
    生成私钥，仅用于非对称加密
    采用PKCS#8规范，此规范定义了私钥信息语法和加密私钥语法
    算法见：...
    
    Parameters:
    
    algorithm - 算法，如RSA、EC、SM2等
    
    key - 密钥，PKCS#8格式
    
    Returns:
    
    私钥 PrivateKey
  - generatePrivateKey
```
public static PrivateKey generatePrivateKey(String algorithm,
                                            KeySpec keySpec)
```
    生成私钥，仅用于非对称加密
    算法见：...
    
    Parameters:
    
    algorithm - 算法，如RSA、EC、SM2等
    
    keySpec - KeySpec
    
    Returns:
    
    私钥 PrivateKey
    
    Since:
    
    3.1.1
  - generatePrivateKey
```
public static PrivateKey generatePrivateKey(KeyStore keyStore,
                                            String alias,
                                            char[] password)
```
    生成私钥，仅用于非对称加密
    
    Parameters:
    
    keyStore - KeyStore
    
    alias - 别名
    
    password - 密码
    
    Returns:
    
    私钥 PrivateKey
  - generateRSAPublicKey
```
public static PublicKey generateRSAPublicKey(byte[] key)
```
    生成RSA公钥，仅用于非对称加密
    采用X509证书规范
    算法见：...
    
    Parameters:
    
    key - 密钥，必须为DER编码存储
    
    Returns:
    
    公钥 PublicKey
    
    Since:
    
    4.5.2
  - generatePublicKey
```
public static PublicKey generatePublicKey(String algorithm,
                                          byte[] key)
```
    生成公钥，仅用于非对称加密
    采用X509证书规范
    算法见：...
    
    Parameters:
    
    algorithm - 算法
    
    key - 密钥，必须为DER编码存储
    
    Returns:
    
    公钥 PublicKey
  - generatePublicKey
```
public static PublicKey generatePublicKey(String algorithm,
                                          KeySpec keySpec)
```
    生成公钥，仅用于非对称加密
    算法见：...
    
    Parameters:
    
    algorithm - 算法
    
    keySpec - KeySpec
    
    Returns:
    
    公钥 PublicKey
    
    Since:
    
    3.1.1
  - getRSAPublicKey
```
public static PublicKey getRSAPublicKey(PrivateKey privateKey)
```
    通过RSA私钥生成RSA公钥
    
    Parameters:
    
    privateKey - RSA私钥
    
    Returns:
    
    RSA公钥，null表示私钥不被支持
    
    Since:
    
    5.3.6
  - getRSAPublicKey
```
public static PublicKey getRSAPublicKey(String modulus,
                                        String publicExponent)
```
    获得RSA公钥对象
    
    Parameters:
    
    modulus - Modulus
    
    publicExponent - Public Exponent
    
    Returns:
    
    公钥
    
    Since:
    
    5.3.6
  - getRSAPublicKey
```
public static PublicKey getRSAPublicKey(BigInteger modulus,
                                        BigInteger publicExponent)
```
    获得RSA公钥对象
    
    Parameters:
    
    modulus - Modulus
    
    publicExponent - Public Exponent
    
    Returns:
    
    公钥
    
    Since:
    
    5.3.6
  - isEmpty
```
public static boolean isEmpty(KeyPair keyPair)
```
    检查KeyPair 是否为空，空的条件是：
    - keyPair本身为null
    - KeyPair.getPrivate()和KeyPair.getPublic()都为null
    Parameters:
    
    keyPair - 密钥对
    
    Returns:
    
    是否为空
  - generateKeyPair
```
public static KeyPair generateKeyPair(String algorithm)
```
    生成用于非对称加密的公钥和私钥，仅用于非对称加密
    密钥对生成算法见：...
    
    Parameters:
    
    algorithm - 非对称加密算法
    
    Returns:
    
    KeyPair
  - generateKeyPair
```
public static KeyPair generateKeyPair(String algorithm,
                                      int keySize)
```
    生成用于非对称加密的公钥和私钥
    密钥对生成算法见：...
    
    Parameters:
    
    algorithm - 非对称加密算法
    
    keySize - 密钥模（modulus ）长度
    
    Returns:
    
    KeyPair
  - generateKeyPair
```
public static KeyPair generateKeyPair(String algorithm,
                                      int keySize,
                                      byte[] seed)
```
    生成用于非对称加密的公钥和私钥
    密钥对生成算法见：...
    
    Parameters:
    
    algorithm - 非对称加密算法
    
    keySize - 密钥模（modulus ）长度
    
    seed - 种子
    
    Returns:
    
    KeyPair
  - generateKeyPair
```
public static KeyPair generateKeyPair(String algorithm,
                                      AlgorithmParameterSpec params)
```
    生成用于非对称加密的公钥和私钥
    密钥对生成算法见：...
    
    Parameters:
    
    algorithm - 非对称加密算法
    
    params - AlgorithmParameterSpec
    
    Returns:
    
    KeyPair
    
    Since:
    
    4.3.3
  - generateKeyPair
```
public static KeyPair generateKeyPair(String algorithm,
                                      byte[] seed,
                                      AlgorithmParameterSpec param)
```
    生成用于非对称加密的公钥和私钥
    密钥对生成算法见：...
    
    Parameters:
    
    algorithm - 非对称加密算法
    
    param - AlgorithmParameterSpec
    
    seed - 种子
    
    Returns:
    
    KeyPair
    
    Since:
    
    4.3.3
  - generateKeyPair
```
public static KeyPair generateKeyPair(String algorithm,
                                      int keySize,
                                      byte[] seed,
                                      AlgorithmParameterSpec... params)
```
    生成用于非对称加密的公钥和私钥
    密钥对生成算法见：...
    对于非对称加密算法，密钥长度有严格限制，具体如下：
    RSA：
```
 RS256、PS256：2048 bits
 RS384、PS384：3072 bits
 RS512、RS512：4096 bits
 
```
    EC（Elliptic Curve）：
```
 EC256：256 bits
 EC384：384 bits
 EC512：512 bits
 
```
    Parameters:
    
    algorithm - 非对称加密算法
    
    keySize - 密钥模（modulus ）长度（单位bit）
    
    seed - 种子
    
    params - AlgorithmParameterSpec
    
    Returns:
    
    KeyPair
    
    Since:
    
    4.3.3
  - generateKeyPair
```
public static KeyPair generateKeyPair(String algorithm,
                                      int keySize,
                                      SecureRandom random,
                                      AlgorithmParameterSpec... params)
```
    生成用于非对称加密的公钥和私钥
    密钥对生成算法见：...
    对于非对称加密算法，密钥长度有严格限制，具体如下：
    RSA：
```
 RS256、PS256：2048 bits
 RS384、PS384：3072 bits
 RS512、RS512：4096 bits
 
```
    EC（Elliptic Curve）：
```
 EC256：256 bits
 EC384：384 bits
 EC512：512 bits
 
```
    Parameters:
    
    algorithm - 非对称加密算法
    
    keySize - 密钥模（modulus ）长度（单位bit）
    
    random - SecureRandom 对象，创建时可选传入seed
    
    params - AlgorithmParameterSpec
    
    Returns:
    
    KeyPair
    
    Since:
    
    4.6.5
  - getKeyPair
```
public static KeyPair getKeyPair(String type,
                                 InputStream in,
                                 char[] password,
                                 String alias)
```
    从KeyStore中获取私钥公钥
    
    Parameters:
    
    type - 类型
    
    in - InputStream 如果想从文件读取.keystore文件，使用 FileUtil.getInputStream(java.io.File) 读取
    
    password - 密码
    
    alias - 别名
    
    Returns:
    
    KeyPair
    
    Since:
    
    4.4.1
  - getKeyPair
```
public static KeyPair getKeyPair(KeyStore keyStore,
                                 char[] password,
                                 String alias)
```
    从KeyStore中获取私钥公钥
    
    Parameters:
    
    keyStore - KeyStore
    
    password - 密码
    
    alias - 别名
    
    Returns:
    
    KeyPair
    
    Since:
    
    4.4.1
  - getKeyPairGenerator
```
public static KeyPairGenerator getKeyPairGenerator(String algorithm)
```
    获取KeyPairGenerator
    
    Parameters:
    
    algorithm - 非对称加密算法
    
    Returns:
    
    KeyPairGenerator
    
    Since:
    
    4.4.3
  - getKeyFactory
```
public static KeyFactory getKeyFactory(String algorithm)
```
    获取KeyFactory
    
    Parameters:
    
    algorithm - 非对称加密算法
    
    Returns:
    
    KeyFactory
    
    Since:
    
    4.4.4
  - getSecretKeyFactory
```
public static SecretKeyFactory getSecretKeyFactory(String algorithm)
```
    获取SecretKeyFactory
    
    Parameters:
    
    algorithm - 对称加密算法
    
    Returns:
    
    KeyFactory
    
    Since:
    
    4.5.2
  - getMainAlgorithm
```
public static String getMainAlgorithm(String algorithm)
```
    获取主体算法名，例如RSA/ECB/PKCS1Padding的主体算法是RSA
    
    Parameters:
    
    algorithm - XXXwithXXX算法
    
    Returns:
    
    主体算法名
    
    Since:
    
    4.5.2
  - getAlgorithmAfterWith
```
public static String getAlgorithmAfterWith(String algorithm)
```
    获取用于密钥生成的算法
    获取XXXwithXXX算法的后半部分算法，如果为ECDSA或SM2，返回算法为EC
    
    Parameters:
    
    algorithm - XXXwithXXX算法
    
    Returns:
    
    算法
  - readPublicKeyFromCert
```
public static PublicKey readPublicKeyFromCert(InputStream in)
```
    读取X.509 Certification文件中的公钥
    Certification为证书文件
    see: ...
    
    Parameters:
    
    in - InputStream 如果想从文件读取.cer文件，使用 FileUtil.getInputStream(File) 读取
    
    Returns:
    
    KeyStore
    
    Since:
    
    4.5.2
  - encodeECPrivateKey
```
public static byte[] encodeECPrivateKey(PrivateKey privateKey)
```
    编码压缩EC私钥（基于BouncyCastle）
    
    Parameters:
    
    privateKey - PrivateKey，必须为org.bouncycastle.jcajce.provider.asymmetric.ec.BCECPrivateKey
    
    Returns:
    
    压缩得到的D
  - decodeECPrivateKey
```
public static PrivateKey decodeECPrivateKey(String encode,
                                            String curveName)
```
    解码恢复EC私钥,支持Base64和Hex编码,（基于BouncyCastle）
    
    Parameters:
    
    encode - 私钥
    
    curveName - EC曲线名
    
    Returns:
    
    私钥
  - decodeECPrivateKey
```
public static PrivateKey decodeECPrivateKey(byte[] encodeByte,
                                            String curveName)
```
    解码恢复EC私钥,支持Base64和Hex编码,（基于BouncyCastle）
    
    Parameters:
    
    encodeByte - 私钥
    
    curveName - EC曲线名
    
    Returns:
    
    私钥
  - encodeECPublicKey
```
public static byte[] encodeECPublicKey(PublicKey publicKey)
```
    编码压缩EC公钥（基于BouncyCastle）
    见：...
    
    Parameters:
    
    publicKey - PublicKey，必须为org.bouncycastle.jcajce.provider.asymmetric.ec.BCECPublicKey
    
    Returns:
    
    压缩得到的X
    
    Since:
    
    4.4.4
  - decodeECPublicKey
```
public static PublicKey decodeECPublicKey(String encode,
                                          String curveName)
```
    解码恢复EC压缩公钥,支持Base64和Hex编码,（基于BouncyCastle）
    见：...
    
    Parameters:
    
    encode - 压缩公钥
    
    curveName - EC曲线名
    
    Returns:
    
    公钥
    
    Since:
    
    4.4.4
  - decodeECPublicKey
```
public static PublicKey decodeECPublicKey(byte[] encodeByte,
                                          String curveName)
```
    解码恢复EC压缩公钥,支持Base64和Hex编码,（基于BouncyCastle）
    见：...
    
    Parameters:
    
    encodeByte - 压缩公钥
    
    curveName - EC曲线名
    
    Returns:
    
    公钥
    
    Since:
    
    4.4.4

Class KeyUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_KEY_SIZE

Constructor Detail

KeyUtil

Method Detail

toBase64

generateKey

generateKey

generateKey

generateKey

generateDESKey

generatePBEKey

generateKey

getKeyGenerator

generateRSAPrivateKey

generatePrivateKey

generatePrivateKey

generatePrivateKey

generateRSAPublicKey

generatePublicKey

generatePublicKey

getRSAPublicKey

getRSAPublicKey

getRSAPublicKey

isEmpty

generateKeyPair

generateKeyPair

generateKeyPair

generateKeyPair

generateKeyPair

generateKeyPair

generateKeyPair

getKeyPair

getKeyPair

getKeyPairGenerator

getKeyFactory

getSecretKeyFactory

getMainAlgorithm

getAlgorithmAfterWith

readPublicKeyFromCert

encodeECPrivateKey

decodeECPrivateKey

decodeECPrivateKey

encodeECPublicKey

decodeECPublicKey

decodeECPublicKey