pysm4技术文档
pysm4 Python SM4 项目地址: https://gitcode.com/gh_mirrors/py/pysm4
概述
pysm4是一款专为Python设计的国密SM4算法实现库,旨在提供简单、高效的对称加密解决方案。SM4算法作为中国国家商用密码算法,适用于128位的数据分组和同样长度的密钥,广泛应用于数据安全保护。本文档详细指导如何安装、使用pysm4,并介绍了其核心API,以及基本的兼容性和性能表现。
安装指南
使用GitHub安装
确保您的计算机已安装Git和Python。接着,在命令行执行以下命令来克隆仓库并安装:
git clone https://github.com/yang3yen/pysm4.git
cd pysm4
python setup.py install
通过PyPI安装
对于更简便的安装方法,您可以直接使用pip:
pip install pysm4
这适用于大多数Python环境,自动处理依赖关系。
项目使用说明
pysm4提供了多种加密解密函数,以适应不同的应用场景。
基础加密解密
基础的加密解密函数用于原始数据的处理:
- 加密: 使用
encrypt
- 解密: 使用
decrypt
示例代码如下:
from pysm4 import encrypt, decrypt
clear_num = 0x0123456789ABCDEFfedcba9876543210
mk = 0x0123456789ABCDEFfedcba9876543210
cipher_num = encrypt(clear_num, mk)
assert hex(decrypt(cipher_num, mk))[2:].replace('L', '') == hex(clear_num)[2:]
ECB模式
电子密码书(Electronic Codebook, ECB)模式:
- 加密:
encrypt_ecb
- 解密:
decrypt_ecb
示例:
from pysm4 import encrypt_ecb, decrypt_ecb
plain_text = "pysm4是国密SM4算法的Python实现"
key = "hello, world!"
cipher_text = encrypt_ecb(plain_text.encode(), key.encode())
assert plain_text == decrypt_ecb(cipher_text.decode(), key.encode())
CBC模式
密码块链接(Cipher Block Chaining, CBC)模式增加了初始化向量(IV):
- 加密:
encrypt_cbc
- 解密:
decrypt_cbc
示例:
from pysm4 import encrypt_cbc, decrypt_cbc
iv = "11111111"
cipher_text = encrypt_cbc(plain_text.encode(), key.encode(), iv.encode())
assert plain_text == decrypt_cbc(cipher_text.decode(), key.encode(), iv.encode())
项目API使用文档
- encrypt 和 decrypt: 直接加密和解密数字或字符串(字符串需转为字节流)。
- encrypt_ecb 和 decrypt_ecb: 使用ECB模式加密和解密字符串,适用于不关心重复模式的短消息。
- encrypt_cbc 和 decrypt_cbc: 使用CBC模式,引入初始化向量提高安全性,适用于长文本或连续数据加密。
兼容性
pysm4支持Python 2.7及Python 3.3以上的版本。请注意,随着Python 2的支持结束,新项目应考虑使用Python 3版本。
性能注意
虽然pysm4实现了SM4算法的功能,但在纯Python环境下,其性能可能不如C/C++或Java等语言实现的版本。对于高负载加密任务,考虑性能要求是非常重要的。
本技术文档为开发者提供了详尽的指导,使您能够顺利地集成pysm4到您的Python项目中,加强数据安全保障。
pysm4 Python SM4 项目地址: https://gitcode.com/gh_mirrors/py/pysm4
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考