Class SM9Engine

java.lang.Object
org.bouncycastle.crypto.engines.SM9Engine

public class SM9Engine extends Object
The SM9 public key encryption algorithm (GM/T 0044.4-2016, clause 7). Two data-encapsulation methods are supported: a KDF-based stream cipher (SM9Engine.Mode.STREAM) and SM4 in ECB mode with PKCS#7 padding (SM9Engine.Mode.SM4). The ciphertext is C = C1 || C3 || C2, where C1 is the G1 point [r]Q_B encoded as x||y, C3 = MAC(K2, C2), and C2 is the encapsulated message.

Usage follows the SM2Engine pattern: construct with the desired mode, init(true, new ParametersWithRandom(recipientKey, random)) to encrypt or init(false, userKey) to decrypt, then processBlock(byte[], int, int).

The mode is the caller's to keep: C1 || C3 || C2 does not record which method produced it, so a ciphertext has to be decrypted by an engine constructed for the mode it was encrypted in. Neither mode produces or accepts a 16-byte C2: the stream mode refuses a 16-byte message, the SM4 mode a message of fewer than 16 bytes, which pads to one block, and both refuse a 16-byte C2 on decryption. A message of fewer than 16 bytes has to be sent in stream mode, and one of exactly 16 bytes in SM4 mode.

Usage warning: an identity's encryption key should be used for this algorithm or for the KEM (SM9KEMExtractor), but not for both. A deployment needing both has its KGC publish a separate hid for each function, as it already does for the key exchange, so that the two keys are distinct. init(boolean, CipherParameters) also refuses for decryption a key declared for the KEM, and one that has been used for it - see SM9EncPrivateKeyParameters.recordUsage(int).