AsymmetricCrypto (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.crypto.asymmetric.BaseAsymmetric<T>
- - org.dromara.hutool.crypto.asymmetric.AbstractAsymmetricCrypto<AsymmetricCrypto>
  - - org.dromara.hutool.crypto.asymmetric.AsymmetricCrypto

All Implemented Interfaces:: Serializable, AsymmetricDecryptor, AsymmetricEncryptor

Direct Known Subclasses:: ECIES, RSA

public class AsymmetricCrypto
extends AbstractAsymmetricCrypto<AsymmetricCrypto>

非对称加密算法

 1、签名：使用私钥加密，公钥解密。
 用于让所有公钥所有者验证私钥所有者的身份并且用来防止私钥所有者发布的内容被篡改，但是不用来保证内容不被他人获得。

 2、加密：用公钥加密，私钥解密。
 用于向公钥所有者发布信息,这个信息可能被他人篡改,但是无法被他人获得。

Author:: Looly
See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Cipher`	`cipher` Cipher负责完成加密或解密工作
`protected int`	`decryptBlockSize` 解密的块大小
`protected int`	`encryptBlockSize` 加密的块大小

Fields inherited from class org.dromara.hutool.crypto.asymmetric.BaseAsymmetric
algorithm, lock, privateKey, publicKey

Constructor Summary

Constructors
Constructor and Description
`AsymmetricCrypto(AsymmetricAlgorithm algorithm)` 构造，创建新的私钥公钥对
`AsymmetricCrypto(AsymmetricAlgorithm algorithm, byte[] privateKey, byte[] publicKey)` 构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
`AsymmetricCrypto(AsymmetricAlgorithm algorithm, PrivateKey privateKey, PublicKey publicKey)` 构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
`AsymmetricCrypto(AsymmetricAlgorithm algorithm, String privateKeyStr, String publicKeyStr)` 构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
`AsymmetricCrypto(String algorithm)` 构造，创建新的私钥公钥对
`AsymmetricCrypto(String algorithm, byte[] privateKey, byte[] publicKey)` 构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
`AsymmetricCrypto(String algorithm, KeyPair keyPair)` 构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
`AsymmetricCrypto(String algorithm, String privateKeyBase64, String publicKeyBase64)` 构造私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`decrypt(byte[] data, KeyType keyType)` 解密
`byte[]`	`encrypt(byte[] data, KeyType keyType)` 加密
`AlgorithmParameterSpec`	`getAlgorithmParameterSpec()` 获取`AlgorithmParameterSpec` 在某些算法中，需要特别的参数，例如在ECIES中，此处为IESParameterSpec
`Cipher`	`getCipher()` 获得加密或解密器
`int`	`getDecryptBlockSize()` 获取解密块大小
`int`	`getEncryptBlockSize()` 获取加密块大小
`AsymmetricCrypto`	`init(String algorithm, KeyPair keyPair)` 初始化私钥和公钥同时为空时生成一对新的私钥和公钥私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密（签名）或者解密（校验）
`protected void`	`initCipher()` 初始化`Cipher`，默认尝试加载BC库
`AsymmetricCrypto`	`setAlgorithmParameterSpec(AlgorithmParameterSpec algorithmParameterSpec)` 设置`AlgorithmParameterSpec` 在某些算法中，需要特别的参数，例如在ECIES中，此处为IESParameterSpec
`void`	`setDecryptBlockSize(int decryptBlockSize)` 设置解密块大小
`void`	`setEncryptBlockSize(int encryptBlockSize)` 设置加密块大小
`AsymmetricCrypto`	`setRandom(SecureRandom random)` 设置随机数生成器，可自定义随机数种子

Methods inherited from class org.dromara.hutool.crypto.asymmetric.BaseAsymmetric
getKeyByType, getPrivateKey, getPrivateKeyBase64, getPublicKey, getPublicKeyBase64, initKeys, setKey, setLock, setPrivateKey, setPublicKey

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

Methods inherited from interface org.dromara.hutool.crypto.asymmetric.AsymmetricEncryptor
encrypt, encrypt, encrypt, encryptBase64, encryptBase64, encryptBase64, encryptBase64, encryptHex, encryptHex, encryptHex, encryptHex

Methods inherited from interface org.dromara.hutool.crypto.asymmetric.AsymmetricDecryptor
decrypt, decrypt, decryptStr, decryptStr

- Field Detail
  - cipher
```
protected Cipher cipher
```
    Cipher负责完成加密或解密工作
  - encryptBlockSize
```
protected int encryptBlockSize
```
    加密的块大小
  - decryptBlockSize
```
protected int decryptBlockSize
```
    解密的块大小
- Constructor Detail
  - AsymmetricCrypto
```
public AsymmetricCrypto(AsymmetricAlgorithm algorithm)
```
    构造，创建新的私钥公钥对
    
    Parameters:
    
    algorithm - SymmetricAlgorithm
  - AsymmetricCrypto
```
public AsymmetricCrypto(String algorithm)
```
    构造，创建新的私钥公钥对
    
    Parameters:
    
    algorithm - 算法
  - AsymmetricCrypto
```
public AsymmetricCrypto(AsymmetricAlgorithm algorithm,
                        String privateKeyStr,
                        String publicKeyStr)
```
    构造私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    algorithm - SymmetricAlgorithm
    
    privateKeyStr - 私钥Hex或Base64表示
    
    publicKeyStr - 公钥Hex或Base64表示
  - AsymmetricCrypto
```
public AsymmetricCrypto(AsymmetricAlgorithm algorithm,
                        byte[] privateKey,
                        byte[] publicKey)
```
    构造私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    algorithm - SymmetricAlgorithm
    
    privateKey - 私钥
    
    publicKey - 公钥
  - AsymmetricCrypto
```
public AsymmetricCrypto(AsymmetricAlgorithm algorithm,
                        PrivateKey privateKey,
                        PublicKey publicKey)
```
    构造私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    algorithm - SymmetricAlgorithm
    
    privateKey - 私钥
    
    publicKey - 公钥
    
    Since:
    
    3.1.1
  - AsymmetricCrypto
```
public AsymmetricCrypto(String algorithm,
                        String privateKeyBase64,
                        String publicKeyBase64)
```
    构造私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    algorithm - 非对称加密算法
    
    privateKeyBase64 - 私钥Base64
    
    publicKeyBase64 - 公钥Base64
  - AsymmetricCrypto
```
public AsymmetricCrypto(String algorithm,
                        byte[] privateKey,
                        byte[] publicKey)
```
    构造
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    algorithm - 算法
    
    privateKey - 私钥
    
    publicKey - 公钥
  - AsymmetricCrypto
```
public AsymmetricCrypto(String algorithm,
                        KeyPair keyPair)
```
    构造
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密或者解密
    
    Parameters:
    
    algorithm - 算法
    
    keyPair - 密钥对，包含私钥和公钥，如果为null，则生成随机键值对
- Method Detail
  - getEncryptBlockSize
```
public int getEncryptBlockSize()
```
    获取加密块大小
    
    Returns:
    
    加密块大小
  - setEncryptBlockSize
```
public void setEncryptBlockSize(int encryptBlockSize)
```
    设置加密块大小
    
    Parameters:
    
    encryptBlockSize - 加密块大小
  - getDecryptBlockSize
```
public int getDecryptBlockSize()
```
    获取解密块大小
    
    Returns:
    
    解密块大小
  - setDecryptBlockSize
```
public void setDecryptBlockSize(int decryptBlockSize)
```
    设置解密块大小
    
    Parameters:
    
    decryptBlockSize - 解密块大小
  - getAlgorithmParameterSpec
```
public AlgorithmParameterSpec getAlgorithmParameterSpec()
```
    获取AlgorithmParameterSpec
    在某些算法中，需要特别的参数，例如在ECIES中，此处为IESParameterSpec
    
    Returns:
    
    AlgorithmParameterSpec
    
    Since:
    
    5.4.3
  - setAlgorithmParameterSpec
```
public AsymmetricCrypto setAlgorithmParameterSpec(AlgorithmParameterSpec algorithmParameterSpec)
```
    设置AlgorithmParameterSpec
    在某些算法中，需要特别的参数，例如在ECIES中，此处为IESParameterSpec
    
    Parameters:
    
    algorithmParameterSpec - AlgorithmParameterSpec
    
    Returns:
    
    this
  - setRandom
```
public AsymmetricCrypto setRandom(SecureRandom random)
```
    设置随机数生成器，可自定义随机数种子
    
    Parameters:
    
    random - 随机数生成器，可自定义随机数种子
    
    Returns:
    
    this
    
    Since:
    
    5.7.17
  - init
```
public AsymmetricCrypto init(String algorithm,
                             KeyPair keyPair)
```
    Description copied from class: BaseAsymmetric
    
    初始化
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做加密（签名）或者解密（校验）
    
    Overrides:
    
    init in class BaseAsymmetric<AsymmetricCrypto>
    
    Parameters:
    
    algorithm - 算法
    
    keyPair - 密钥对，包括私钥和公钥
    
    Returns:
    
    this
  - encrypt
```
public byte[] encrypt(byte[] data,
                      KeyType keyType)
```
    Description copied from interface: AsymmetricEncryptor
    
    加密
    
    Parameters:
    
    data - 被加密的bytes
    
    keyType - 私钥或公钥 KeyType
    
    Returns:
    
    加密后的bytes
  - decrypt
```
public byte[] decrypt(byte[] data,
                      KeyType keyType)
```
    Description copied from interface: AsymmetricDecryptor
    
    解密
    
    Parameters:
    
    data - 被解密的bytes
    
    keyType - 私钥或公钥 KeyType
    
    Returns:
    
    解密后的bytes
  - getCipher
```
public Cipher getCipher()
```
    获得加密或解密器
    
    Returns:
    
    加密或解密
    
    Since:
    
    5.4.3
  - initCipher
```
protected void initCipher()
```
    初始化Cipher，默认尝试加载BC库
    
    Since:
    
    4.5.2

Class AsymmetricCrypto

Field Summary

Fields inherited from class org.dromara.hutool.crypto.asymmetric.BaseAsymmetric

Constructor Summary

Method Summary

Methods inherited from class org.dromara.hutool.crypto.asymmetric.BaseAsymmetric

Methods inherited from class java.lang.Object

Methods inherited from interface org.dromara.hutool.crypto.asymmetric.AsymmetricEncryptor

Methods inherited from interface org.dromara.hutool.crypto.asymmetric.AsymmetricDecryptor

Field Detail

cipher

encryptBlockSize

decryptBlockSize

Constructor Detail

AsymmetricCrypto

AsymmetricCrypto

AsymmetricCrypto

AsymmetricCrypto

AsymmetricCrypto

AsymmetricCrypto

AsymmetricCrypto

AsymmetricCrypto

Method Detail

getEncryptBlockSize

setEncryptBlockSize

getDecryptBlockSize

setDecryptBlockSize

getAlgorithmParameterSpec

setAlgorithmParameterSpec

setRandom

init

encrypt

decrypt

getCipher

initCipher