Android 国4加密（SM4）那些事儿

今天公司突然要在网络返回数据上进行国4加密。在网上百度了一下，国4加密五花八门，而且问题还特别多。通过不懈寻找终于将国4加密安排上了，在这里把国4加密的步骤和坑一一记录一下，希望能对安卓开发的朋友有所帮助。

国4加密项目集成步骤：

1、在app的build.gradle中引入依赖包

implementation 'org.bouncycastle:bcprov-jdk15on:1.68'

2、编写工具类

注意：本工具类加密方法会对加密后的字符串进行Base64编码，解密也是先Base64解码然后再进行解密的

import com.blankj.utilcode.util.StringUtils;

import org.bouncycastle.jce.provider.BouncyCastleProvider;
import org.bouncycastle.pqc.math.linearalgebra.ByteUtils;
import org.bouncycastle.util.encoders.Base64;

import java.nio.charset.StandardCharsets;
import java.security.Key;
import java.security.Security;

import javax.crypto.Cipher;
import javax.crypto.spec.SecretKeySpec;

/**
 * SM4加密算法 对称加密
 */
public class Sm4Util {

    /**
     * 算法名称
     */
    private static final String ALGORITHM_NAME = "SM4";

    /**
     * 密钥长度
     */
    private static final int KEY_LENGTH = 32;

    /**
     * 补位字符
     */
    private static final String RESERVE_CHAR = "a";

    /**
     * 加密算法/分组加密模式/分组填充方式
     * PKCS5Padding-以8个字节为一组进行分组加密
     * 定义分组加密模式使用：PKCS7Padding
     */
    private static final String ALGORITHM_NAME_ECB_PADDING = "SM4/ECB/PKCS7Padding";

    private static final String BC = "BC";

    static {
        if (Security.getProvider(BC) == null) {
            Security.addProvider(new BouncyCastleProvider());
        }
    }

    /**
     * 加密
     *
     * @param plainText 明文
     * @param key       密钥
     * @return
     * @throws Exception
     */
    public static String encode(String plainText, String key) throws Exception {
        byte[] srcData = plainText.getBytes();
        byte[] keyData = ByteUtils.fromHexString(key);
        return Base64.toBase64String(encrypt(srcData, keyData));
    }

    /**
     * 解密
     *
     * @param cipherText 密文
     * @param key        密钥
     * @return
     * @throws Exception
     */
    public static String decode(String cipherText, String key) throws Exception {
        byte[] cipherData = Base64.decode(cipherText);
        byte[] keyData = ByteUtils.fromHexString(key);
        byte[] ret = decrypt(cipherData, keyData);
        return new String(ret).trim();
    }

    /**
     * 生成密钥
     * 128 - 32位16进制，256 - 64位16进制
     *
     * @return
     */
    public static String generateKey(String str) {
        // 转为16进制字符串
        String key = ByteUtils.toHexString(str.getBytes(StandardCharsets.UTF_8));
        if (key.length() < KEY_LENGTH) {
            StringBuilder stringBuilder = new StringBuilder(key);
            // 密钥长度不够时补全
            while (stringBuilder.length() < KEY_LENGTH) {
                stringBuilder.append(RESERVE_CHAR);
            }
            return stringBuilder.toString();
        } else {
            // 密钥长度超出时只截取32位
            return key.substring(0, KEY_LENGTH);
        }
    }

    /**
     * 使用字符串作为密钥加密
     *
     * @param plainText 明文
     * @param str       字符串密钥
     * @return
     */
    public static String encodeByStr(String plainText, String str) throws Exception {
        try {
            if (StringUtils.isEmpty(plainText) || StringUtils.isEmpty(str)) {
                throw new Exception("明文或字符串密钥为空");
            }
            // 使用字符串作为密钥进行SM4加密
            return encode(plainText, generateKey(str));
        } catch (Exception e) {
            throw new Exception("加密失败，" + e.getMessage());
        }
    }

    /**
     * 使用字符串作为密钥加密解密
     *
     * @param cipherText 密文
     * @param str        字符串密钥
     * @return
     */
    public static String decodeByStr(String cipherText, String str) throws Exception {
        try {
            if (StringUtils.isEmpty(cipherText) || StringUtils.isEmpty(str)) {
                throw new Exception("密文或字符串密钥为空");
            }
            // 使用字符串作为密钥进行SM4解密
            return decode(cipherText, generateKey(str));
        } catch (Exception e) {
            throw new Exception("解密失败，" + e.getMessage());
        }
    }



    /**
     * 加密为16进制字符串
     *
     * @param plainText 明文
     * @param key       密钥
     * @return
     * @throws Exception
     */
    public static String encodeToHex(String plainText, String key) throws Exception {
        byte[] srcData = plainText.getBytes();
        byte[] keyData = ByteUtils.fromHexString(key);
        return ByteUtils.toHexString(encrypt(srcData, keyData));
    }


    /**
     * 加密
     *
     * @param plainText 明文
     * @param key       密钥
     * @return
     * @throws Exception
     */
    public static byte[] encrypt(byte[] plainText, byte[] key) throws Exception {
        Cipher cipher = generateEcbCipher(ALGORITHM_NAME_ECB_PADDING, Cipher.ENCRYPT_MODE, key);
        return cipher.doFinal(plainText);
    }



    /**
     * 解密16进制字符串
     *
     * @param cipherText 密文
     * @param key        密钥
     * @return
     * @throws Exception
     */
    public static String decodeFromHex(String cipherText, String key) throws Exception {
        byte[] cipherData = ByteUtils.fromHexString(cipherText);
        byte[] keyData = ByteUtils.fromHexString(key);
        byte[] ret = decrypt(cipherData, keyData);
        return new String(ret).trim();
    }

    /**
     * 解密
     *
     * @param cipherText 密文
     * @param key        密钥
     * @return
     * @throws Exception
     */
    public static byte[] decrypt(byte[] cipherText, byte[] key) throws Exception {
        Cipher cipher = generateEcbCipher(ALGORITHM_NAME_ECB_PADDING, Cipher.DECRYPT_MODE, key);
        return cipher.doFinal(cipherText);
    }

    /**
     * 生成ECB暗号
     *
     * @param algName 算法名称
     * @param mode    模式
     * @param key     密钥
     * @return
     * @throws Exception
     */
    private static Cipher generateEcbCipher(String algName, int mode, byte[] key) throws Exception {
        Security.removeProvider(BouncyCastleProvider.PROVIDER_NAME);
        Security.addProvider(new BouncyCastleProvider());
        Cipher cipher = Cipher.getInstance(algName, BouncyCastleProvider.PROVIDER_NAME);
        Key sm4Key = new SecretKeySpec(key, ALGORITHM_NAME);
        cipher.init(mode, sm4Key);
        return cipher;
    }
}

3、加入混淆

#国四加密混淆
-keep class org.bouncycastle.** { *; }

注意事项

在实践过程中很容易爆NoSuchAlgorithmException: Provider BC does not provide SM4 hutool这个错误，按上面的集成过程应该不会遇到这个错误。