Sign (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.crypto.asymmetric.BaseAsymmetric<Sign>
- - cn.hutool.crypto.asymmetric.Sign

All Implemented Interfaces:

Serializable
```
public class Sign
extends BaseAsymmetric<Sign>
```
签名包装，Signature 包装类

Since:

3.3.0

Author:

looly

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected Signature signature
签名，用于签名和验证
- Fields inherited from class cn.hutool.crypto.asymmetric.BaseAsymmetric
  algorithm, lock, privateKey, publicKey

Fields
Modifier and Type	Field and Description
`protected Signature`	`signature` 签名，用于签名和验证

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`digestHex(InputStream data, int bufferLength)` 生成签名，并转为16进制字符串使用默认缓存大小，见 `NioUtil.DEFAULT_BUFFER_SIZE`
`Signature`	`getSignature()` 获得签名对象
`Sign`	`init(String algorithm, PrivateKey privateKey, PublicKey publicKey)` 初始化
`Sign`	`setCertificate(Certificate certificate)` 设置`Certificate` 为PublicKey 如果Certificate是X509Certificate，我们需要检查是否有密钥扩展
`Sign`	`setParameter(AlgorithmParameterSpec params)` 设置签名的参数
`Sign`	`setSignature(Signature signature)` 设置签名
`byte[]`	`sign(byte[] data)` 用私钥对信息生成数字签名
`byte[]`	`sign(InputStream data)` 生成签名，使用默认缓存大小，见 `NioUtil.DEFAULT_BUFFER_SIZE`
`byte[]`	`sign(InputStream data, int bufferLength)` 生成签名
`byte[]`	`sign(String data)` 生成文件签名
`byte[]`	`sign(String data, Charset charset)` 生成文件签名
`String`	`signHex(byte[] data)` 生成签名，并转为16进制字符串
`String`	`signHex(InputStream data)` 生成签名，并转为16进制字符串使用默认缓存大小，见 `NioUtil.DEFAULT_BUFFER_SIZE`
`String`	`signHex(String data)` 生成文件签名
`String`	`signHex(String data, Charset charset)` 生成文件签名，并转为16进制字符串
`boolean`	`verify(byte[] data, byte[] sign)` 用公钥检验数字签名的合法性

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

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

- Field Detail
  - signature
```
protected Signature signature
```
    签名，用于签名和验证
- Constructor Detail
  - Sign
```
public Sign(SignAlgorithm algorithm)
```
    构造，创建新的私钥公钥对
    
    Parameters:
    
    algorithm - SignAlgorithm
  - Sign
```
public Sign(String algorithm)
```
    构造，创建新的私钥公钥对
    
    Parameters:
    
    algorithm - 算法
  - Sign
```
public Sign(SignAlgorithm algorithm,
            String privateKeyStr,
            String publicKeyStr)
```
    构造私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做签名或验证
    
    Parameters:
    
    algorithm - SignAlgorithm
    
    privateKeyStr - 私钥Hex或Base64表示
    
    publicKeyStr - 公钥Hex或Base64表示
  - Sign
```
public Sign(SignAlgorithm algorithm,
            byte[] privateKey,
            byte[] publicKey)
```
    构造私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做签名或验证
    
    Parameters:
    
    algorithm - SignAlgorithm
    
    privateKey - 私钥
    
    publicKey - 公钥
  - Sign
```
public Sign(SignAlgorithm algorithm,
            KeyPair keyPair)
```
    构造私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做签名或验证
    
    Parameters:
    
    algorithm - SignAlgorithm
    
    keyPair - 密钥对（包括公钥和私钥）
  - Sign
```
public Sign(SignAlgorithm algorithm,
            PrivateKey privateKey,
            PublicKey publicKey)
```
    构造私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做签名或验证
    
    Parameters:
    
    algorithm - SignAlgorithm
    
    privateKey - 私钥
    
    publicKey - 公钥
  - Sign
```
public Sign(String algorithm,
            String privateKeyBase64,
            String publicKeyBase64)
```
    构造私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做签名或验证
    
    Parameters:
    
    algorithm - 非对称加密算法
    
    privateKeyBase64 - 私钥Base64
    
    publicKeyBase64 - 公钥Base64
  - Sign
```
public Sign(String algorithm,
            byte[] privateKey,
            byte[] publicKey)
```
    构造
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做签名或验证
    
    Parameters:
    
    algorithm - 算法
    
    privateKey - 私钥
    
    publicKey - 公钥
  - Sign
```
public Sign(String algorithm,
            KeyPair keyPair)
```
    构造
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做签名或验证
    
    Parameters:
    
    algorithm - 算法，见SignAlgorithm
    
    keyPair - 密钥对（包括公钥和私钥）
  - Sign
```
public Sign(String algorithm,
            PrivateKey privateKey,
            PublicKey publicKey)
```
    构造
    私钥和公钥同时为空时生成一对新的私钥和公钥
    私钥和公钥可以单独传入一个，如此则只能使用此钥匙来做签名或验证
    
    Parameters:
    
    algorithm - 算法
    
    privateKey - 私钥
    
    publicKey - 公钥
- Method Detail
  - init
```
public Sign init(String algorithm,
                 PrivateKey privateKey,
                 PublicKey publicKey)
```
    初始化
    
    Overrides:
    
    init in class BaseAsymmetric<Sign>
    
    Parameters:
    
    algorithm - 算法
    
    privateKey - 私钥
    
    publicKey - 公钥
    
    Returns:
    
    this
  - setParameter
```
public Sign setParameter(AlgorithmParameterSpec params)
```
    设置签名的参数
    
    Parameters:
    
    params - AlgorithmParameterSpec
    
    Returns:
    
    this
    
    Since:
    
    4.6.5
  - sign
```
public byte[] sign(String data,
                   Charset charset)
```
    生成文件签名
    
    Parameters:
    
    data - 被签名数据
    
    charset - 编码
    
    Returns:
    
    签名
    
    Since:
    
    5.7.0
  - sign
```
public byte[] sign(String data)
```
    生成文件签名
    
    Parameters:
    
    data - 被签名数据
    
    Returns:
    
    签名
    
    Since:
    
    5.7.0
  - signHex
```
public String signHex(String data,
                      Charset charset)
```
    生成文件签名，并转为16进制字符串
    
    Parameters:
    
    data - 被签名数据
    
    charset - 编码
    
    Returns:
    
    签名
    
    Since:
    
    5.7.0
  - signHex
```
public String signHex(String data)
```
    生成文件签名
    
    Parameters:
    
    data - 被签名数据
    
    Returns:
    
    签名
    
    Since:
    
    5.7.0
  - sign
```
public byte[] sign(byte[] data)
```
    用私钥对信息生成数字签名
    
    Parameters:
    
    data - 加密数据
    
    Returns:
    
    签名
  - signHex
```
public String signHex(byte[] data)
```
    生成签名，并转为16进制字符串
    
    Parameters:
    
    data - 被签名数据
    
    Returns:
    
    签名
    
    Since:
    
    5.7.0
  - signHex
```
public String signHex(InputStream data)
```
    生成签名，并转为16进制字符串
    使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE
    
    Parameters:
    
    data - 被签名数据
    
    Returns:
    
    签名
    
    Since:
    
    5.7.0
  - sign
```
public byte[] sign(InputStream data)
```
    生成签名，使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE
    
    Parameters:
    
    data - InputStream 数据流
    
    Returns:
    
    签名bytes
    
    Since:
    
    5.7.0
  - digestHex
```
public String digestHex(InputStream data,
                        int bufferLength)
```
    生成签名，并转为16进制字符串
    使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE
    
    Parameters:
    
    data - 被签名数据
    
    bufferLength - 缓存长度，不足1使用 NioUtil.DEFAULT_BUFFER_SIZE 做为默认值
    
    Returns:
    
    签名
    
    Since:
    
    5.7.0
  - sign
```
public byte[] sign(InputStream data,
                   int bufferLength)
```
    生成签名
    
    Parameters:
    
    data - InputStream 数据流
    
    bufferLength - 缓存长度，不足1使用 NioUtil.DEFAULT_BUFFER_SIZE 做为默认值
    
    Returns:
    
    签名bytes
    
    Since:
    
    5.7.0
  - verify
```
public boolean verify(byte[] data,
                      byte[] sign)
```
    用公钥检验数字签名的合法性
    
    Parameters:
    
    data - 数据
    
    sign - 签名
    
    Returns:
    
    是否验证通过
  - getSignature
```
public Signature getSignature()
```
    获得签名对象
    
    Returns:
    
    Signature
  - setSignature
```
public Sign setSignature(Signature signature)
```
    设置签名
    
    Parameters:
    
    signature - 签名对象 Signature
    
    Returns:
    
    自身 AsymmetricCrypto
  - setCertificate
```
public Sign setCertificate(Certificate certificate)
```
    设置Certificate 为PublicKey
    如果Certificate是X509Certificate，我们需要检查是否有密钥扩展
    
    Parameters:
    
    certificate - Certificate
    
    Returns:
    
    this

Class Sign

Field Summary

Fields inherited from class cn.hutool.crypto.asymmetric.BaseAsymmetric

Constructor Summary

Method Summary

Methods inherited from class cn.hutool.crypto.asymmetric.BaseAsymmetric

Methods inherited from class java.lang.Object

Field Detail

signature

Constructor Detail

Sign

Sign

Sign

Sign

Sign

Sign

Sign

Sign

Sign

Sign

Method Detail

init

setParameter

sign

sign

signHex

signHex

sign

signHex

signHex

sign

digestHex

sign

verify

getSignature

setSignature

setCertificate