cloud.opencode.base.crypto.asymmetric.Sm2Cipher

All Implemented Interfaces:: AsymmetricCipher

public final class Sm2Cipher extends Object implements AsymmetricCipher

SM2 cipher implementation - Chinese national cryptographic standard SM2 密码实现 - 中国国密标准

SM2 is an elliptic curve cryptography algorithm specified in the Chinese National Standard GM/T 0003-2012. This implementation requires Bouncy Castle cryptographic provider to be available on the classpath. SM2 是中国国家标准 GM/T 0003-2012 中规定的椭圆曲线密码算法。此实现需要 Bouncy Castle 加密提供程序在类路径中可用。

Note: This class requires the optional Bouncy Castle dependency. If Bouncy Castle is not available, instantiation will fail with an exception. 注意：此类需要可选的 Bouncy Castle 依赖。如果 Bouncy Castle 不可用，实例化将失败并抛出异常。

Features | 主要功能:

SM2 encryption (Chinese national standard) - SM2 加密（中国国密标准）
Requires Bouncy Castle provider - 需要 Bouncy Castle 提供者

Usage Examples | 使用示例:

Sm2Cipher sm2 = Sm2Cipher.create();
sm2.setPublicKey(publicKey);
byte[] encrypted = sm2.encrypt(data);

Security | 安全性:

Thread-safe: No - 线程安全: 否
Null-safe: Yes - 空值安全: 是

Performance | 性能特性:

Time complexity: O(k^3) for key operations - 时间复杂度: O(k^3)，k为密钥参数
Space complexity: O(k) - 空间复杂度: O(k)

Since:

JDK 25, opencode-base-crypto V1.0.0

Author:

Leon Soo www.LeonSoo.com

See Also:

Method Summary

Modifier and Type

Method

Description

static Sm2Cipher

create()

Create a new SM2 cipher instance 创建新的 SM2 密码实例

byte[]

decrypt(byte[] ciphertext)

Decrypt data using private key 使用私钥解密数据

byte[]

decryptBase64(String base64Ciphertext)

Decrypt Base64 encoded ciphertext 解密 Base64 编码的密文

byte[]

decryptHex(String hexCiphertext)

Decrypt hexadecimal encoded ciphertext 解密十六进制编码的密文

String

decryptToString(byte[] ciphertext)

Decrypt data and return as string 解密数据并返回字符串

byte[]

encrypt(byte[] plaintext)

Encrypt data using public key 使用公钥加密数据

byte[]

encrypt(String plaintext)

Encrypt string using public key 使用公钥加密字符串

String

encryptBase64(byte[] plaintext)

Encrypt data and return Base64 encoded result 加密数据并返回 Base64 编码结果

String

encryptHex(byte[] plaintext)

Encrypt data and return hexadecimal encoded result 加密数据并返回十六进制编码结果

KeyPair

generateKeyPair()

Generate a new key pair for this cipher 为此加密器生成新的密钥对

String

getAlgorithm()

Get the algorithm name 获取算法名称

int

getMaxEncryptSize()

Get maximum size of data that can be encrypted in a single operation 获取单次操作可加密的最大数据大小

PrivateKey

getPrivateKey()

Get the private key 获取私钥

PublicKey

getPublicKey()

Get the public key 获取公钥

static boolean

isAvailable()

Check if SM2 is available (i.e., Bouncy Castle is present) 检查 SM2 是否可用（即 Bouncy Castle 是否存在）

AsymmetricCipher

setKeyPair(KeyPair keyPair)

Set both public and private keys from key pair 从密钥对设置公钥和私钥

AsymmetricCipher

setPrivateKey(byte[] encodedKey)

Set private key from encoded byte array 从编码的字节数组设置私钥

AsymmetricCipher

setPrivateKey(PrivateKey privateKey)

Set private key for decryption operations 设置用于解密操作的私钥

AsymmetricCipher

setPrivateKeyPem(String pem)

Set private key from PEM formatted string 从 PEM 格式字符串设置私钥

AsymmetricCipher

setPublicKey(byte[] encodedKey)

Set public key from encoded byte array 从编码的字节数组设置公钥

AsymmetricCipher

setPublicKey(PublicKey publicKey)

Set public key for encryption operations 设置用于加密操作的公钥

AsymmetricCipher

setPublicKeyPem(String pem)

Set public key from PEM formatted string 从 PEM 格式字符串设置公钥

static Sm2Cipher

withGeneratedKeyPair()

Create SM2 cipher with generated key pair 创建带生成密钥对的 SM2 密码

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

Method Details
- create
  
  public static Sm2Cipher create()
  
  Create a new SM2 cipher instance 创建新的 SM2 密码实例
  
  Returns:
  
  new SM2 cipher instance
  
  Throws:
  
  OpenCryptoException - if Bouncy Castle is not available
- withGeneratedKeyPair
  
  public static Sm2Cipher withGeneratedKeyPair()
  
  Create SM2 cipher with generated key pair 创建带生成密钥对的 SM2 密码
  
  Returns:
  
  SM2 cipher with generated keys
  
  Throws:
  
  OpenCryptoException - if Bouncy Castle is not available or key generation fails
- setPublicKey
  
  public AsymmetricCipher setPublicKey(PublicKey publicKey)
  
  Description copied from interface: AsymmetricCipher
  
  Set public key for encryption operations 设置用于加密操作的公钥
  
  Specified by:
  
  setPublicKey in interface AsymmetricCipher
  
  Parameters:
  
  publicKey - the public key
  
  Returns:
  
  this cipher instance for method chaining
- setPublicKey
  
  public AsymmetricCipher setPublicKey(byte[] encodedKey)
  
  Description copied from interface: AsymmetricCipher
  
  Set public key from encoded byte array 从编码的字节数组设置公钥
  
  Specified by:
  
  setPublicKey in interface AsymmetricCipher
  
  Parameters:
  
  encodedKey - the encoded public key bytes
  
  Returns:
  
  this cipher instance for method chaining
- setPublicKeyPem
  
  public AsymmetricCipher setPublicKeyPem(String pem)
  
  Description copied from interface: AsymmetricCipher
  
  Set public key from PEM formatted string 从 PEM 格式字符串设置公钥
  
  Specified by:
  
  setPublicKeyPem in interface AsymmetricCipher
  
  Parameters:
  
  pem - the PEM formatted public key
  
  Returns:
  
  this cipher instance for method chaining
- setPrivateKey
  
  public AsymmetricCipher setPrivateKey(PrivateKey privateKey)
  
  Description copied from interface: AsymmetricCipher
  
  Set private key for decryption operations 设置用于解密操作的私钥
  
  Specified by:
  
  setPrivateKey in interface AsymmetricCipher
  
  Parameters:
  
  privateKey - the private key
  
  Returns:
  
  this cipher instance for method chaining
- setPrivateKey
  
  public AsymmetricCipher setPrivateKey(byte[] encodedKey)
  
  Description copied from interface: AsymmetricCipher
  
  Set private key from encoded byte array 从编码的字节数组设置私钥
  
  Specified by:
  
  setPrivateKey in interface AsymmetricCipher
  
  Parameters:
  
  encodedKey - the encoded private key bytes
  
  Returns:
  
  this cipher instance for method chaining
- setPrivateKeyPem
  
  public AsymmetricCipher setPrivateKeyPem(String pem)
  
  Description copied from interface: AsymmetricCipher
  
  Set private key from PEM formatted string 从 PEM 格式字符串设置私钥
  
  Specified by:
  
  setPrivateKeyPem in interface AsymmetricCipher
  
  Parameters:
  
  pem - the PEM formatted private key
  
  Returns:
  
  this cipher instance for method chaining
- setKeyPair
  
  public AsymmetricCipher setKeyPair(KeyPair keyPair)
  
  Description copied from interface: AsymmetricCipher
  
  Set both public and private keys from key pair 从密钥对设置公钥和私钥
  
  Specified by:
  
  setKeyPair in interface AsymmetricCipher
  
  Parameters:
  
  keyPair - the key pair containing public and private keys
  
  Returns:
  
  this cipher instance for method chaining
- encrypt
  
  public byte[] encrypt(byte[] plaintext)
  
  Description copied from interface: AsymmetricCipher
  
  Encrypt data using public key 使用公钥加密数据
  
  Specified by:
  
  encrypt in interface AsymmetricCipher
  
  Parameters:
  
  plaintext - the data to encrypt
  
  Returns:
  
  encrypted bytes
- encrypt
  
  public byte[] encrypt(String plaintext)
  
  Description copied from interface: AsymmetricCipher
  
  Encrypt string using public key 使用公钥加密字符串
  
  Specified by:
  
  encrypt in interface AsymmetricCipher
  
  Parameters:
  
  plaintext - the string to encrypt
  
  Returns:
  
  encrypted bytes
- encryptBase64
  
  public String encryptBase64(byte[] plaintext)
  
  Description copied from interface: AsymmetricCipher
  
  Encrypt data and return Base64 encoded result 加密数据并返回 Base64 编码结果
  
  Specified by:
  
  encryptBase64 in interface AsymmetricCipher
  
  Parameters:
  
  plaintext - the data to encrypt
  
  Returns:
  
  Base64 encoded ciphertext
- encryptHex
  
  public String encryptHex(byte[] plaintext)
  
  Description copied from interface: AsymmetricCipher
  
  Encrypt data and return hexadecimal encoded result 加密数据并返回十六进制编码结果
  
  Specified by:
  
  encryptHex in interface AsymmetricCipher
  
  Parameters:
  
  plaintext - the data to encrypt
  
  Returns:
  
  hexadecimal encoded ciphertext
- decrypt
  
  public byte[] decrypt(byte[] ciphertext)
  
  Description copied from interface: AsymmetricCipher
  
  Decrypt data using private key 使用私钥解密数据
  
  Specified by:
  
  decrypt in interface AsymmetricCipher
  
  Parameters:
  
  ciphertext - the encrypted data
  
  Returns:
  
  decrypted bytes
- decryptToString
  
  public String decryptToString(byte[] ciphertext)
  
  Description copied from interface: AsymmetricCipher
  
  Decrypt data and return as string 解密数据并返回字符串
  
  Specified by:
  
  decryptToString in interface AsymmetricCipher
  
  Parameters:
  
  ciphertext - the encrypted data
  
  Returns:
  
  decrypted string
- decryptBase64
  
  public byte[] decryptBase64(String base64Ciphertext)
  
  Description copied from interface: AsymmetricCipher
  
  Decrypt Base64 encoded ciphertext 解密 Base64 编码的密文
  
  Specified by:
  
  decryptBase64 in interface AsymmetricCipher
  
  Parameters:
  
  base64Ciphertext - the Base64 encoded ciphertext
  
  Returns:
  
  decrypted bytes
- decryptHex
  
  public byte[] decryptHex(String hexCiphertext)
  
  Description copied from interface: AsymmetricCipher
  
  Decrypt hexadecimal encoded ciphertext 解密十六进制编码的密文
  
  Specified by:
  
  decryptHex in interface AsymmetricCipher
  
  Parameters:
  
  hexCiphertext - the hexadecimal encoded ciphertext
  
  Returns:
  
  decrypted bytes
- getAlgorithm
  
  public String getAlgorithm()
  
  Description copied from interface: AsymmetricCipher
  
  Get the algorithm name 获取算法名称
  
  Specified by:
  
  getAlgorithm in interface AsymmetricCipher
  
  Returns:
  
  the algorithm name
- getMaxEncryptSize
  
  public int getMaxEncryptSize()
  
  Description copied from interface: AsymmetricCipher
  
  Get maximum size of data that can be encrypted in a single operation 获取单次操作可加密的最大数据大小
  
  Specified by:
  
  getMaxEncryptSize in interface AsymmetricCipher
  
  Returns:
  
  maximum encrypt size in bytes, or -1 if not applicable
- generateKeyPair
  
  public KeyPair generateKeyPair()
  
  Description copied from interface: AsymmetricCipher
  
  Generate a new key pair for this cipher 为此加密器生成新的密钥对
  
  Specified by:
  
  generateKeyPair in interface AsymmetricCipher
  
  Returns:
  
  generated key pair
- getPublicKey
  
  public PublicKey getPublicKey()
  
  Get the public key 获取公钥
  
  Returns:
  
  the public key, or null if not set
- getPrivateKey
  
  public PrivateKey getPrivateKey()
  
  Get the private key 获取私钥
  
  Returns:
  
  the private key, or null if not set
- isAvailable
  
  public static boolean isAvailable()
  
  Check if SM2 is available (i.e., Bouncy Castle is present) 检查 SM2 是否可用（即 Bouncy Castle 是否存在）
  
  Returns:
  
  true if SM2 is available, false otherwise

Class Sm2Cipher

Method Summary

Methods inherited from class Object

Method Details

create

withGeneratedKeyPair

setPublicKey

setPublicKey

setPublicKeyPem

setPrivateKey

setPrivateKey

setPrivateKeyPem

setKeyPair

encrypt

encrypt

encryptBase64

encryptHex

decrypt

decryptToString

decryptBase64

decryptHex

getAlgorithm

getMaxEncryptSize

generateKeyPair

getPublicKey

getPrivateKey

isAvailable