Skip to content

Latest commit

 

History

History
674 lines (427 loc) · 38.5 KB

README.md

File metadata and controls

674 lines (427 loc) · 38.5 KB

源GitHub仓库】 | 【Gitee镜像库】如果本文档图片没有显示,请手动切换到Gitee镜像库阅读文档。

📖RSA-csharp使用文档 ( English Documentation )

本项目核心功能:支持.NET Core.NET Framework环境下PEMPKCS#1PKCS#8)格式RSA密钥生成、导入、导出,多种常见RSA加密、签名填充算法支持。

  • 支持.NET Framework 4.5+、.NET Standard 2.0+(.NET Core 2.0+、.NET 5+)
  • 可通过PEMXML格式密钥创建RSA
  • 可通过指定密钥位数、密钥参数创建RSA
  • 可导出PEMXML格式公钥、私钥,格式相互转换
  • 公钥加密、私钥解密:NoPaddingPKCS1PaddingOAEP+MD5OAEP+SHA1 ... SHA3-512
  • 私钥签名、公钥验证:PKCS1+SHA1 ... SHA3-512PKCS1+MD5PSS+SHA1 ... SHA3-512
  • 非常规的:私钥加密、公钥解密,公钥签名、私钥验证
  • 多语言支持:提供中文、英文两种语言支持
  • 另有Java版 RSA-java,所有加密签名算法在Java.NETOpenSSL中均可互通
  • 源码简单,提供编译测试.bat|.sh脚本,无需Visual Studio即可修改和运行,copy即用

你可以只copy RSA_PEM.csRSA_Util.cs 文件到你的项目中使用,即可使用上所有的功能。也可以clone整个项目代码双击 Test-Build-Run.bat 即可直接运行测试(macOS、linux用终端运行.sh的),通过scripts/Create-dll.bat(sh)脚本可生成dll文件供项目引用。

RSA_PEM类底层实现采用PEM文件二进制层面上进行字节码解析,简单轻巧0依赖;RSA_Util为封装RSA操作类,支持跨平台使用,可选搭配使用BouncyCastle加密增强库可获得更丰富的加密签名模式支持。

源文件 平台支持 功能说明 依赖项
RSA_PEM.cs .NET Core、.NET Framework 用于解析和导出PEM,创建RSA实例
RSA_Util.cs .NET Core、.NET Framework RSA操作类,封装了加密、解密、验签 RSA_PEM
Program.cs .NET Core、.NET Framework 测试控制台程序 RSA_PEM、RSA_Util

Test-Build-Run.bat 测试编译运行截图:

控制台测试

快速使用:加密、解密、签名、校验

步骤一:引入RSA-csharp

  • 方法1:直接复制 RSA_PEM.csRSA_Util.cs 文件到你的项目中使用。
  • 方法2:使用scripts/Create-dll.bat(sh)脚本生成dll文件,项目添加这个dll的引用即可使用。
  • 方法3:下载Releases中对应版本的dll文件(就是方法2脚本生成的dll),项目添加这个dll的引用即可使用。

注意:.NET Framework项目可能需要手动引入System.Numerics程序集来支持BigInteger,vs默认创建的项目没有自动引入此程序集,.NET Core项目不需要此操作。

步骤二:编写代码

//先解析pem或xml,公钥私钥均可解析 
//var pem=RSA_PEM.FromPEM("-----BEGIN XXX KEY-----....-----END XXX KEY-----");
//var pem=RSA_PEM.FromXML("<RSAKeyValue><Modulus>....</RSAKeyValue>");

//直接创建RSA操作类,可创建成全局对象,加密解密签名均支持并发调用
//var rsa=new RSA_Util(pem);
var rsa=new RSA_Util(2048); //也可以直接生成新密钥,rsa.ToPEM()得到pem对象

//可选注册BouncyCastle加密增强库(程序启动时注册一次即可),用来实现.NET不支持的加密签名填充方式,NuGet:Portable.BouncyCastle或BouncyCastle.Cryptography
//RSA_Util.UseBouncyCastle(typeof(RsaEngine).Assembly);

//公钥加密,填充方式:PKCS1,可以使用 OAEP+SHA256 等填充方式
var enTxt=rsa.Encrypt("PKCS1", "测试123");
//私钥解密
var deTxt=rsa.Decrypt("PKCS1", enTxt);

//私钥签名,填充方式:PKCS1+SHA1,可以使用 PSS+SHA256 等填充方式
var sign=rsa.Sign("PKCS1+SHA1", "测试123");
//公钥校验签名
var isVerify=rsa.Verify("PKCS1+SHA1", sign, "测试123");

//导出pem文本
var pemTxt=rsa.ToPEM().ToPEM_PKCS8();

//非常规的(不安全、不建议使用):私钥加密、公钥解密,公钥签名、私钥验证
RSA_Util rsaS_Private=rsa.SwapKey_Exponent_D__Unsafe();
RSA_Util rsaS_Public=new RSA_Util(rsa.ToPEM(true)).SwapKey_Exponent_D__Unsafe();
//... rsaS_Private.Encrypt rsaS_Public.Decrypt
//... rsaS_Public.Sign rsaS_Private.Verify

Console.WriteLine(pemTxt+"\n"+enTxt+"\n"+deTxt+"\n"+sign+"\n"+isVerify);
Console.ReadLine();
//****更多的实例,请阅读 Program.cs****
//****更多功能方法,请阅读下面的详细文档****

如需功能定制,网站、App、小程序开发等需求,请加下面的QQ群,联系群主(即作者),谢谢~

【QQ群】交流与支持

欢迎加QQ群:421882406,纯小写口令:xiangyuecn

📖文档

加密填充方式

下表中Frame为.NET Framework支持情况,Core为.NET Core的支持情况,BC为BouncyCastle加密增强库支持情况(可通过RSA_Util.UseBouncyCastle方法注册);√为支持,×为不支持,其他值为某版本开始支持;其中OAEP的掩码生成函数MGF1使用和OAEP相同的Hash算法。

加密填充方式 Algorithm Frame Core BC
NO RSA/ECB/NoPadding
PKCS1 RSA/ECB/PKCS1Padding
OAEP+SHA1 RSA/ECB/OAEPwithSHA-1andMGF1Padding
OAEP+SHA256 RSA/ECB/OAEPwithSHA-256andMGF1Padding 4.6+
OAEP+SHA224 RSA/ECB/OAEPwithSHA-224andMGF1Padding × ×
OAEP+SHA384 RSA/ECB/OAEPwithSHA-384andMGF1Padding 4.6+
OAEP+SHA512 RSA/ECB/OAEPwithSHA-512andMGF1Padding 4.6+
OAEP+SHA-512/224 RSA/ECB/OAEPwithSHA-512/224andMGF1Padding × ×
OAEP+SHA-512/256 RSA/ECB/OAEPwithSHA-512/256andMGF1Padding × ×
OAEP+SHA3-256 RSA/ECB/OAEPwithSHA3-256andMGF1Padding × 8+
OAEP+SHA3-224 RSA/ECB/OAEPwithSHA3-224andMGF1Padding × ×
OAEP+SHA3-384 RSA/ECB/OAEPwithSHA3-384andMGF1Padding × 8+
OAEP+SHA3-512 RSA/ECB/OAEPwithSHA3-512andMGF1Padding × 8+
OAEP+MD5 RSA/ECB/OAEPwithMD5andMGF1Padding 4.6+

签名填充方式

下表中Frame为.NET Framework支持情况,Core为.NET Core的支持情况,BC为BouncyCastle加密增强库支持情况(可通过RSA_Util.UseBouncyCastle方法注册);√为支持,×为不支持,其他值为某版本开始支持;其中PSS的salt字节数等于使用的Hash算法字节数,PSS的掩码生成函数MGF1使用和PSS相同的Hash算法,跟踪属性TrailerField取值固定为0xBC。

签名填充方式 Algorithm Frame Core BC
SHA1 ... SHA3-512 等同于PKCS1+SHA***
PKCS1+SHA1 SHA1withRSA
PKCS1+SHA256 SHA256withRSA
PKCS1+SHA224 SHA224withRSA × ×
PKCS1+SHA384 SHA384withRSA
PKCS1+SHA512 SHA512withRSA
PKCS1+SHA-512/224 SHA512/224withRSA × ×
PKCS1+SHA-512/256 SHA512/256withRSA × ×
PKCS1+SHA3-256 SHA3-256withRSA × 8+
PKCS1+SHA3-224 SHA3-224withRSA × ×
PKCS1+SHA3-384 SHA3-384withRSA × 8+
PKCS1+SHA3-512 SHA3-512withRSA × 8+
PKCS1+MD5 MD5withRSA
PSS+SHA1 SHA1withRSA/PSS 4.6+
PSS+SHA256 SHA256withRSA/PSS 4.6+
PSS+SHA224 SHA224withRSA/PSS × ×
PSS+SHA384 SHA384withRSA/PSS 4.6+
PSS+SHA512 SHA512withRSA/PSS 4.6+
PSS+SHA-512/224 SHA512/224withRSA/PSS × ×
PSS+SHA-512/256 SHA512/256withRSA/PSS × ×
PSS+SHA3-256 SHA3-256withRSA/PSS × 8+
PSS+SHA3-224 SHA3-224withRSA/PSS × ×
PSS+SHA3-384 SHA3-384withRSA/PSS × 8+
PSS+SHA3-512 SHA3-512withRSA/PSS × 8+
PSS+MD5 MD5withRSA/PSS 4.6+

RSA_PEM 类文档

RSA_PEM.cs文件不依赖任何文件,可以直接copy这个文件到你项目中用;通过FromPEMToPEMFromXMLToXML这两对方法,可以实现PEMPKCS#1PKCS#8相互转换,PEM、XML的相互转换。

注:openssl rsa -in 私钥文件 -pubout导出的是PKCS#8格式公钥(用的比较多),openssl rsa -pubin -in PKCS#8公钥文件 -RSAPublicKey_out导出的是PKCS#1格式公钥(用的比较少)。

静态属性和方法

RSA_PEM FromPEM(string pem):用PEM格式密钥对创建RSA,支持PKCS#1、PKCS#8格式的PEM,出错将会抛出异常。pem格式如:-----BEGIN XXX KEY-----....-----END XXX KEY-----

RSA_PEM FromXML(string xml):将XML格式密钥转成PEM,支持公钥xml、私钥xml,出错将会抛出异常。xml格式如:<RSAKeyValue><Modulus>....</RSAKeyValue>

string T(string zh, string en):简版多语言支持,根据当前语言Lang值返回中文或英文。

string Lang:简版多语言支持,取值:zh(简体中文)、en(English-US),默认根据系统取值,可赋值指定语言。

构造方法

RSA_PEM(RSA rsa, bool convertToPublic = false):通过RSA中的公钥和私钥构造一个PEM,如果convertToPublic含私钥的RSA将只读取公钥,仅含公钥的RSA不受影响。

RSA_PEM(byte[] modulus, byte[] exponent, byte[] d, byte[] p, byte[] q, byte[] dp, byte[] dq, byte[] inverseQ):通过全量的PEM字段数据构造一个PEM,除了模数modulus和公钥指数exponent必须提供外,其他私钥指数信息要么全部提供,要么全部不提供(导出的PEM就只包含公钥)注意:所有参数首字节如果是0,必须先去掉。

RSA_PEM(byte[] modulus, byte[] exponent, byte[] dOrNull):通过公钥指数和私钥指数构造一个PEM,会反推计算出P、Q但和原始生成密钥的P、Q极小可能相同。注意:所有参数首字节如果是0,必须先去掉。出错将会抛出异常。私钥指数可以不提供,导出的PEM就只包含公钥。

实例属性

byte[]Key_Modulus(模数n,公钥、私钥都有)、Key_Exponent(公钥指数e,公钥、私钥都有)、Key_D(私钥指数d,只有私钥的时候才有);有这3个足够用来加密解密。

byte[]Val_P(prime1)、Val_Q(prime2)、Val_DP(exponent1)、Val_DQ(exponent2)、Val_InverseQ(coefficient); (PEM中的私钥才有的更多的数值;可通过n、e、d反推出这些值(只是反推出有效值,和原始的值大概率不同))。

int KeySize:密钥位数。

bool HasPrivate:是否包含私钥。

实例方法

RSA GetRSA_ForCore():将PEM中的公钥私钥转成RSA对象,如果未提供私钥,RSA中就只包含公钥。返回的RSA支持跨平台使用,但只支持在.NET Core环境中使用。

RSACryptoServiceProvider GetRSA_ForWindows():将PEM中的公钥私钥转成RSA对象,如果未提供私钥,RSA中就只包含公钥。.NET Core、.NET Framework均可用,但返回的RSACryptoServiceProvider不支持跨平台,所以只支持在Windows系统中使用。

void GetRSA__ImportParameters(RSA rsa):将密钥参数导入到RSA对象中,GetRSA_ForCoreGetRSA_ForWindows中调用了本方法,可用于创建其他类型的RSA时使用。

RSA_PEM CopyToNew(bool convertToPublic = false):将当前PEM中的密钥对复制出一个新的PEM对象。convertToPublic:等于true时含私钥的PEM将只返回公钥,仅含公钥的PEM不受影响。

RSA_PEM SwapKey_Exponent_D__Unsafe():【不安全、不建议使用】对调交换公钥指数(Key_Exponent)和私钥指数(Key_D):把公钥当私钥使用(new.Key_D=this.Key_Exponent)、私钥当公钥使用(new.Key_Exponent=this.Key_D),返回一个新PEM对象;比如用于:私钥加密、公钥解密,这是非常规的用法。当前对象必须含私钥,否则无法交换会直接抛异常。注意:把公钥当私钥使用是非常不安全的,因为绝大部分生成的密钥的公钥指数为 0x10001(AQAB),太容易被猜测到,无法作为真正意义上的私钥。

byte[] ToDER(bool convertToPublic, bool privateUsePKCS8, bool publicUsePKCS8):将RSA中的密钥对转换成DER格式,DER格式为PEM中的Base64文本编码前的二进制数据,参数含义参考ToPEM方法。

string ToPEM(bool convertToPublic, bool privateUsePKCS8, bool publicUsePKCS8):将RSA中的密钥对转换成PEM格式。convertToPublic:等于true时含私钥的RSA将只返回公钥,仅含公钥的RSA不受影响 。privateUsePKCS8:私钥的返回格式,等于true时返回PKCS#8格式(-----BEGIN PRIVATE KEY-----),否则返回PKCS#1格式(-----BEGIN RSA PRIVATE KEY-----),返回公钥时此参数无效;两种格式使用都比较常见。publicUsePKCS8:公钥的返回格式,等于true时返回PKCS#8格式(-----BEGIN PUBLIC KEY-----),否则返回PKCS#1格式(-----BEGIN RSA PUBLIC KEY-----),返回私钥时此参数无效;一般用的多的是true PKCS#8格式公钥,PKCS#1格式公钥似乎比较少见。

string ToPEM_PKCS1(bool convertToPublic=false):ToPEM方法的简化写法,不管公钥还是私钥都返回PKCS#1格式;似乎导出PKCS#1公钥用的比较少,PKCS#8的公钥用的多些,私钥#1#8都差不多。

string ToPEM_PKCS8(bool convertToPublic=false):ToPEM方法的简化写法,不管公钥还是私钥都返回PKCS#8格式。

string ToXML(bool convertToPublic):将RSA中的密钥对转换成XML格式,如果convertToPublic含私钥的RSA将只返回公钥,仅含公钥的RSA不受影响。

RSA_Util 类文档

RSA_Util.cs文件依赖RSA_PEM.cs,封装了加密、解密、签名、验证、秘钥导入导出操作;.NET Core下由实际的RSA实现类提供支持,.NET Framework 4.5及以下由RSACryptoServiceProvider提供支持,.NET Framework 4.6及以上由RSACng提供支持;或者引入BouncyCastle加密增强库提供支持。

静态属性和方法

string RSAPadding_Enc(string padding):将加密填充方式转换成对应的Algorithm字符串,比如PKCS1 -> RSA/ECB/PKCS1Padding

string RSAPadding_Sign(string hash):将签名填充方式转换成对应的Algorithm字符串,比如PKCS1+SHA1 -> SHA1withRSA

bool IsDotNetSupportError(string errMsg):判断异常消息是否是因为.NET兼容性产生的错误。

void UseBouncyCastle(Assembly bouncyCastleAssembly):强制使用BouncyCastle加密增强库进行RSA操作。只需在程序启动后调用一次即可,直接调用一下BouncyCastle里面的类,传入程序集:UseBouncyCastle(typeof(RsaEngine).Assembly),传入null取消使用。项目中引入BouncyCastle加密增强库来扩充.NET加密功能,NuGet:Portable.BouncyCastle或BouncyCastle.Cryptography,文档 https://www.bouncycastle.org/csharp/ ,在程序启动时调用本方法进行注册即可得到全部的加密签名填充方式支持。

bool IsUseBouncyCastle:是否强制使用BouncyCastle加密增强库进行RSA操作,为true时将不会使用.NET的RSA。

bool IS_CORE:当前运行环境是否为.NET Core,false为.NET Framework。

构造方法

RSA_Util(int keySize):用指定密钥大小创建一个新的RSA,会生成新密钥,出错抛异常。

RSA_Util(string pemOrXML):通过PEM格式XML格式密钥,创建一个RSA,pem或xml内可以只包含一个公钥或私钥,或都包含,出错抛异常。XML格式如:<RSAKeyValue><Modulus>...</RSAKeyValue>。pem支持PKCS#1PKCS#8格式,格式如:-----BEGIN XXX KEY-----....-----END XXX KEY-----

RSA_Util(RSA_PEM pem):通过一个pem对象创建RSA,pem为公钥或私钥,出错抛异常。

RSA_Util(byte[] modulus, byte[] exponent, byte[] d, byte[] p, byte[] q, byte[] dp, byte[] dq, byte[] inverseQ):本方法会先生成RSA_PEM再创建RSA。通过全量的PEM字段数据构造一个PEM,除了模数modulus和公钥指数exponent必须提供外,其他私钥指数信息要么全部提供,要么全部不提供(导出的PEM就只包含公钥)注意:所有参数首字节如果是0,必须先去掉。

RSA_Util(byte[] modulus, byte[] exponent, byte[] dOrNull):本方法会先生成RSA_PEM再创建RSA。通过公钥指数和私钥指数构造一个PEM,会反推计算出P、Q但和原始生成密钥的P、Q极小可能相同。注意:所有参数首字节如果是0,必须先去掉。出错将会抛出异常。私钥指数可以不提供,导出的PEM就只包含公钥。

实例属性

RSA RSAObject:获取最底层的RSA对象,.NET Core下为实际的RSA实现类,.NET Framework 4.5及以下RSACryptoServiceProvider,.NET Framework 4.6及以上RSACng;注意:IsUseBouncyCastle时将不会使用.NET的RSA。

bool RSAIsUseCore:最底层的RSA对象是否是使用的.NET Core(RSA),否则将是使用的.NET Framework(4.5及以下RSACryptoServiceProvider、4.6及以上RSACng);注意:IsUseBouncyCastle时将不会使用.NET的RSA。

int KeySize:密钥位数。

bool HasPrivate:是否包含私钥。

实例方法

string ToXML(bool convertToPublic = false):导出XML格式秘钥对。如果RSA包含私钥,默认会导出私钥,设置仅仅导出公钥时只会导出公钥;不包含私钥只会导出公钥。

RSA_PEM ToPEM(bool convertToPublic = false):导出RSA_PEM对象(然后可以通过RSA_PEM.ToPEM方法导出PEM文本),如果convertToPublic含私钥的RSA将只返回公钥,仅含公钥的RSA不受影响。

RSA_Util SwapKey_Exponent_D__Unsafe():【不安全、不建议使用】对调交换公钥指数(Key_Exponent)和私钥指数(Key_D):把公钥当私钥使用(new.Key_D=this.Key_Exponent)、私钥当公钥使用(new.Key_Exponent=this.Key_D),返回一个新RSA对象;比如用于:私钥加密、公钥解密,这是非常规的用法。当前密钥如果只包含公钥,将不会发生对调,返回的新RSA将允许用公钥进行解密和签名操作;但.NET自带的RSA不支持仅含公钥的密钥进行解密和签名,必须进行指数对调(如果是.NET Framework 4.5及以下版本,公钥私钥均不支持),使用NoPadding填充方式或IsUseBouncyCastle时无此问题。注意:把公钥当私钥使用是非常不安全的,因为绝大部分生成的密钥的公钥指数为 0x10001(AQAB),太容易被猜测到,无法作为真正意义上的私钥。部分私钥加密实现中,比如Java自带的RSA,使用非NoPadding填充方式时,用私钥对象进行加密可能会采用EMSA-PKCS1-v1_5填充方式(用私钥指数构造成公钥对象无此问题),因此在不同程序之间互通时,可能需要自行使用对应填充算法先对数据进行填充,然后再用NoPadding填充方式进行加密(解密也按NoPadding填充进行解密,然后去除填充数据)。

string Encrypt(string padding, string str):加密任意长度字符串(utf-8)返回base64,出错抛异常。本方法线程安全。padding指定填充方式,如:PKCS1、OAEP+SHA256大写,参考上面的加密填充方式表格,使用空值时默认为PKCS1。

byte[] Encrypt(string padding, byte[] data):加密任意长度数据,出错抛异常。本方法线程安全。

string Decrypt(string padding, string str):解密任意长度密文(base64)得到字符串(utf-8),出错抛异常。本方法线程安全。padding指定填充方式,如:PKCS1、OAEP+SHA256大写,参考上面的加密填充方式表格,使用空值时默认为PKCS1。

byte[] Decrypt(string padding, byte[] data):解密任意长度数据,出错抛异常。本方法线程安全。

string Sign(string hash, string str):对字符串str进行签名,返回base64结果,出错抛异常。本方法线程安全。hash指定签名摘要算法和填充方式,如:SHA256、PSS+SHA1大写,参考上面的签名填充方式表格。

byte[] Sign(string hash, byte[] data):对data进行签名,出错抛异常。本方法线程安全。

bool Verify(string hash, string sign, string str):验证字符串str的签名是否是sign(base64),出错抛异常。本方法线程安全。hash指定签名摘要算法和填充方式,如:SHA256、PSS+SHA1大写,参考上面的签名填充方式表格。

bool Verify(string hash, byte[] sign, byte[] data):验证data的签名是否是sign,出错抛异常。本方法线程安全。

OpenSSL RSA常用命令行参考

::先准备一个测试文件 test.txt 里面填少量内容,openssl不支持自动分段加密

::生成新密钥
openssl genrsa -out private.pem 1024

::提取公钥PKCS#8
openssl rsa -in private.pem -pubout -out public.pem

::转换成RSAPublicKey PKCS#1
openssl rsa -pubin -in public.pem -RSAPublicKey_out -out public.pem.rsakey
::测试RSAPublicKey PKCS#1,不出意外会出错。因为这个公钥里面没有OID,通过RSA_PEM转换成PKCS#8自动带上OID就能正常加密
echo abcd123 | openssl rsautl -encrypt -inkey public.pem.rsakey -pubin



::加密和解密,填充方式:PKCS1
openssl pkeyutl -encrypt -pkeyopt rsa_padding_mode:pkcs1 -in test.txt -pubin -inkey public.pem -out test.txt.enc.bin
openssl pkeyutl -decrypt -pkeyopt rsa_padding_mode:pkcs1 -in test.txt.enc.bin -inkey private.pem -out test.txt.dec.txt

::加密和解密,填充方式:OAEP+SHA256,掩码生成函数MGF1使用相同的hash算法
openssl pkeyutl -encrypt -pkeyopt rsa_padding_mode:oaep -pkeyopt rsa_oaep_md:sha256 -in test.txt -pubin -inkey public.pem -out test.txt.enc.bin
openssl pkeyutl -decrypt -pkeyopt rsa_padding_mode:oaep -pkeyopt rsa_oaep_md:sha256 -in test.txt.enc.bin -inkey private.pem -out test.txt.dec.txt


::命令行参数中的sha256可以换成md5、sha1等;如需sha3系列,就换成sha3-256即可


::签名和验证,填充方式:PKCS1+SHA256
openssl dgst -sha256 -binary -sign private.pem -out test.txt.sign.bin test.txt
openssl dgst -sha256 -binary -verify public.pem -signature test.txt.sign.bin test.txt

::签名和验证,填充方式:PSS+SHA256 ,salt=-1使用hash长度=256/8,掩码生成函数MGF1使用相同的hash算法
openssl dgst -sha256 -binary -out test.txt.hash test.txt
openssl pkeyutl -sign -pkeyopt digest:sha256 -pkeyopt rsa_padding_mode:pss -pkeyopt rsa_pss_saltlen:-1 -in test.txt.hash -inkey private.pem -out test.txt.sign.bin
openssl pkeyutl -verify -pkeyopt digest:sha256 -pkeyopt rsa_padding_mode:pss -pkeyopt rsa_pss_saltlen:-1 -in test.txt.hash -pubin -inkey public.pem -sigfile test.txt.sign.bin

📖知识库

在写一个小转换工具时加入了RSA加密解密支持,实现相应功能发现原有RSA操作类不能良好工作,PEM->XML没问题,只要能通过PEM创建RSA,就能用RSACryptoServiceProvider自带方法导出XML。但XML->PEM没有找到相应的简单实现方法,大部分博客写的用BouncyCastle库来操作,代码是少,但BouncyCastle就有好几兆大小,我的小工具啊才100K;所以自己实现了一个支持导出PKCS#1PKCS#8格式PEM密钥的方法RSA_PEM.ToPEM

操作过程中发现原有RSA操作类不支持用PKCS#8格式PEM密钥来创建RSA对象(用的RSACryptoServiceProviderExtension的扩展方法来支持PEM密钥),仅支持PKCS#1,所以又自己实现了一个从PEM密钥来创建RSACryptoServiceProvider的方法RSA_PEM.FromPEM

在实现导入导出PEM密钥过程中,对PKCS#1PKCS#8格式的PEM密钥有了一定的了解,主要参考了:

RSA公钥文件(PEM)解析》:公钥字节码分解。

RSA私钥文件(PEM)解析》:私钥字节码分解。

iOS安全相关 - RSA中公钥的DER格式组成》:1字节和2字节长度表述方法,和为什么有些字段前面要加0x00。

PEM密钥编码格式

此结构分析为初学RSA秘钥格式时总结出来的,比较粗糙但够用了。后面研究了ASN.1结构,然后实现了个ASN.1标准的解析器,按照ASN.1语法去解析和生成RSA PEM秘钥代码会简单严谨许多(另外在此基础上实现了个CSR解析生成器,有了ASN.1标准解析器,做啥都简单了)。

长度表述方法

PEM格式中,每段数据基本上都是type+长度数据占用位数+长度数值+数据这种格式。

长度数据占用位数有0x81和0x82两个值,分别代表长度数值占用了1字节和2字节。

但长度数据占用位数不一定存在,如果长度数值<0x80时(理由应该和下面这个加0x00一致),长度数值直接在type后面用1位来表述,变成了type+长度数值(<0x80)+数据

什么情况下内容前面要加0x00

type=02 INTEGER时

如果内容的bit流的前4 bit十六进制值>=8就要在内容前面加0x00,其他不用加。

一个大整数,最高位为符号位,其为1时,就是负数,所以要在最高位填充0x00以保证不为负。

type=03 BIT STRING时

内容前面要加0(可能现在全部是加0吧,数据结尾这个字节不满8位?什么情况下会出现不够1字节?不够就用二进制0补齐,然后内容前面加补了几位)。

PEM PKCS#8公钥编码格式

/*****1024位PKCS#8公钥*****/
-----BEGIN PUBLIC KEY-----
MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCYw9+M3+REzDtYqwBrs/as/Oy8
GRE5OmnqOV0EfkEiCIjiczbVEFnZ3qRjLbDATfmBxNQ6c6Fga8nX28glEH/aL/RG
2KdpI8KMUqKAszNydsHSeh9MSKcd5zgS4NuE0u+eR7CB8kOWipiLDQmY38kpM36p
RWdNQlpIaTDo5IhJJwIDAQAB
-----END PUBLIC KEY-----

/*****二进制表述(文本是16进制下同)*****/
30819F300D06092A864886F70D010101050003818D003081890281810098C3DF8CDFE444CC3B58AB006BB3F6ACFCECBC1911393A69EA395D047E41220888E27336D51059D9DEA4632DB0C04DF981C4D43A73A1606BC9D7DBC825107FDA2FF446D8A76923C28C52A280B3337276C1D27A1F4C48A71DE73812E0DB84D2EF9E47B081F243968A988B0D0998DFC929337EA945674D425A486930E8E48849270203010001


/*****二进制分解*****/

/*
后续(到结尾)内容长度为0x9F字节,相当于整个文件长度-当前这3字节。
格式:type[+长度数据占用位数(可选)]+后续长度数值,
	此处type=0x30,
	长度数据占用1位(参考前面长度表述方法),
	后续长度数值=0x9F个字节

直观JSON化ASN.1(后面新学的ASN.1结构):
30_SEQUENCE{
	03_BIT_STRING: "二进制内容(看是什么,也许是纯二进制,或者是一个可以解析成ASN.1格式的内容)"
	, 05_NULL: "NULL,后面内容长度为0"
	, 30_SEQUENCE:{
		02_INTEGER: "整数"
		, 02_INTEGER: "整数"
	}
}
*/
30 81 9F //容器[30 SEQUENCE] [81 长度数据占1位] [9F 容器内有9F字节数据]

	/*
	固定内容,长度为0x0D个字节,为RSA OID(1.2.840.113549.1.1.1)

	RSAES-PKCS1-v1_5 encryption scheme: http://www.oid-info.com/get/1.2.840.113549.1.1.1
	*/
	30 0D //容器[30 SEQUENCE] [0D 容器内有0D字节数据]
		06 09 2A864886F70D010101 //06 OID 1.2.840.113549.1.1.1
		05 00 //NULL

	/*后续内容长度,后面内容长度为0x8D字节,和开头格式一致*/
	03 81 8D //03 BIT STRING,后面放的是二进制公钥数据,此内容其实还是一个结构
		00 //BIT STRING内容前面需要加00

		/*后续内容长度,后面内容长度为0x89字节,和开头格式一致*/
		30 81 89 //容器[30 SEQUENCE] [81 长度数据占1位] [89 容器内有0x89字节数据]

			/*
			RSA Modulus内容
			格式:type[+长度数据占用位数(可选)]+内容长度数值+内容,
				此处type=0x02,所有RSA相关参数都是用02,
				长度数据占用位数为1字节,
				内容长度数值=0x81个字节,
				内容为0x00-0x27这一段(参考前面什么情况下要加0x00)。
			*/
			02 81 81 //02 INTEGER整数[02 INTEGER] [81 长度数据占1位] [81 Modulus内容长x81字节]
				0098C3DF8CDFE444CC3B58AB006BB3F6ACFCECBC1911393A69EA395D047E41220888E27336D51059D9DEA4632DB0C04DF981C4D43A73A1606BC9D7DBC825107FDA2FF446D8A76923C28C52A280B3337276C1D27A1F4C48A71DE73812E0DB84D2EF9E47B081F243968A988B0D0998DFC929337EA945674D425A486930E8E4884927

			/*RSA Exponent内容,和Modulus一样,但此处长度数据占用位数不存在*/
			02 03 //02 INTEGER整数[02 INTEGER] [03 Exponent内容长x03字节]
				010001

PEM PKCS#1公钥编码格式

/*****1024位PKCS#1公钥*****/
-----BEGIN RSA PUBLIC KEY-----
MIGJAoGBAJjD34zf5ETMO1irAGuz9qz87LwZETk6aeo5XQR+QSIIiOJzNtUQWdne
pGMtsMBN+YHE1DpzoWBrydfbyCUQf9ov9EbYp2kjwoxSooCzM3J2wdJ6H0xIpx3n
OBLg24TS755HsIHyQ5aKmIsNCZjfySkzfqlFZ01CWkhpMOjkiEknAgMBAAE=
-----END RSA PUBLIC KEY-----

/*****二进制表述*****/
3081890281810098C3DF8CDFE444CC3B58AB006BB3F6ACFCECBC1911393A69EA395D047E41220888E27336D51059D9DEA4632DB0C04DF981C4D43A73A1606BC9D7DBC825107FDA2FF446D8A76923C28C52A280B3337276C1D27A1F4C48A71DE73812E0DB84D2EF9E47B081F243968A988B0D0998DFC929337EA945674D425A486930E8E48849270203010001


/*****二进制分解(和PKCS#8公钥格式就是只留了N、E两个数据,及其简单)*****/
30 81 89

	/*RSA Modulus*/
	02 81 81
		0098C3DF8CDFE444CC3B58AB006BB3F6ACFCECBC1911393A69EA395D047E41220888E27336D51059D9DEA4632DB0C04DF981C4D43A73A1606BC9D7DBC825107FDA2FF446D8A76923C28C52A280B3337276C1D27A1F4C48A71DE73812E0DB84D2EF9E47B081F243968A988B0D0998DFC929337EA945674D425A486930E8E4884927
	
	/*RSA Exponent*/
	02 03
		010001

PEM PKCS#1私钥编码格式

/*****1024位PKCS#1私钥*****/
-----BEGIN RSA PRIVATE KEY-----
MIICXAIBAAKBgQCYw9+M3+REzDtYqwBrs/as/Oy8GRE5OmnqOV0EfkEiCIjiczbV
EFnZ3qRjLbDATfmBxNQ6c6Fga8nX28glEH/aL/RG2KdpI8KMUqKAszNydsHSeh9M
SKcd5zgS4NuE0u+eR7CB8kOWipiLDQmY38kpM36pRWdNQlpIaTDo5IhJJwIDAQAB
AoGAcGNSWRrynia+1onf4lzg8v2U0QGEKV0vRNF0/HRCSN6MjkUDJxdDc0UYHZsk
uSXklTMQi/w70msacQNRqOsNk32O6vVPxr4NfTVaIV59Jv9Z5SXGiRmRZXeRw0ks
KYdOwaDJJu9zETNHZoMFJm8sq/tGJPQCPNesoZRZssL7mjkCQQDOI6jKt60bvu6V
XvtQoyUUbyMj9eCOBatS49jRvv326TMc951e9TcbnD0cxJrV1N6yIi+++ejwfagb
eYf++N61AkEAvbc8KTlBbI9TMwnVkQpst+ckgm3gpRDhAfQ/Lt7r8g2KAHsJv+wb
AJCgu8PgqM9mQjVxZ+78+aLEQ+h5rvMV6wJAY1c9/ct8ihV+Zs+qL1cgBHP2rFrO
x8KlqMGS+KmhPD9v2XLfDScBUrX9oYKB17DJTXE6Lz/CaTs1K2BrEI4gzQJBAJIQ
s9chaAfHSc1v8uha2F23Ltrk8iLknfi9LrBNneedGPVJxbXoeNm0gKxQIXaXSCoN
r6TP0iH5eZa3NIjIS8UCQAbw+d2WJIon+vuUsKk2dtZTqZx8e53NreZUFMaIkoS5
JPJqI6/6hq8/2ARFO3P9/qkxDMkJv8mSjV91cZixB10=
-----END RSA PRIVATE KEY-----

/*****二进制表述*****/
3082025C0201000281810098C3DF8CDFE444CC3B58AB006BB3F6ACFCECBC1911393A69EA395D047E41220888E27336D51059D9DEA4632DB0C04DF981C4D43A73A1606BC9D7DBC825107FDA2FF446D8A76923C28C52A280B3337276C1D27A1F4C48A71DE73812E0DB84D2EF9E47B081F243968A988B0D0998DFC929337EA945674D425A486930E8E48849270203010001028180706352591AF29E26BED689DFE25CE0F2FD94D10184295D2F44D174FC744248DE8C8E45032717437345181D9B24B925E49533108BFC3BD26B1A710351A8EB0D937D8EEAF54FC6BE0D7D355A215E7D26FF59E525C6891991657791C3492C29874EC1A0C926EF73113347668305266F2CABFB4624F4023CD7ACA19459B2C2FB9A39024100CE23A8CAB7AD1BBEEE955EFB50A325146F2323F5E08E05AB52E3D8D1BEFDF6E9331CF79D5EF5371B9C3D1CC49AD5D4DEB2222FBEF9E8F07DA81B7987FEF8DEB5024100BDB73C2939416C8F533309D5910A6CB7E724826DE0A510E101F43F2EDEEBF20D8A007B09BFEC1B0090A0BBC3E0A8CF6642357167EEFCF9A2C443E879AEF315EB024063573DFDCB7C8A157E66CFAA2F57200473F6AC5ACEC7C2A5A8C192F8A9A13C3F6FD972DF0D270152B5FDA18281D7B0C94D713A2F3FC2693B352B606B108E20CD0241009210B3D7216807C749CD6FF2E85AD85DB72EDAE4F222E49DF8BD2EB04D9DE79D18F549C5B5E878D9B480AC50217697482A0DAFA4CFD221F97996B73488C84BC5024006F0F9DD96248A27FAFB94B0A93676D653A99C7C7B9DCDADE65414C6889284B924F26A23AFFA86AF3FD804453B73FDFEA9310CC909BFC9928D5F757198B1075D

/*****二进制分解(大部分和公钥格式相同)*****/

/*后续内容长度,后面内容长度为0x025C个字节,和公钥开头格式一致,参考公钥部分*/
30 82 025C

	/*固定版本号*/
	02 01
		00

	/*#####从这里开始后面就是内容了 注:KCS#8仅仅是在此处插入部分内容#####*/

	/*RSA Modulus内容,和公钥开头格式一致,参考公钥部分*/
	02 81 81 
		0098C3DF8CDFE444CC3B58AB006BB3F6ACFCECBC1911393A69EA395D047E41220888E27336D51059D9DEA4632DB0C04DF981C4D43A73A1606BC9D7DBC825107FDA2FF446D8A76923C28C52A280B3337276C1D27A1F4C48A71DE73812E0DB84D2EF9E47B081F243968A988B0D0998DFC929337EA945674D425A486930E8E4884927

	/*RSA Exponent*/
	02 03
		010001

	/*RSA D*/
	02 81 80
		706352591AF29E26BED689DFE25CE0F2FD94D10184295D2F44D174FC744248DE8C8E45032717437345181D9B24B925E49533108BFC3BD26B1A710351A8EB0D937D8EEAF54FC6BE0D7D355A215E7D26FF59E525C6891991657791C3492C29874EC1A0C926EF73113347668305266F2CABFB4624F4023CD7ACA19459B2C2FB9A39

	/*RSA P*/
	02 41
		00CE23A8CAB7AD1BBEEE955EFB50A325146F2323F5E08E05AB52E3D8D1BEFDF6E9331CF79D5EF5371B9C3D1CC49AD5D4DEB2222FBEF9E8F07DA81B7987FEF8DEB5

	/*RSA Q*/
	02 41
		00BDB73C2939416C8F533309D5910A6CB7E724826DE0A510E101F43F2EDEEBF20D8A007B09BFEC1B0090A0BBC3E0A8CF6642357167EEFCF9A2C443E879AEF315EB

	/*RSA DP*/
	02 40
		63573DFDCB7C8A157E66CFAA2F57200473F6AC5ACEC7C2A5A8C192F8A9A13C3F6FD972DF0D270152B5FDA18281D7B0C94D713A2F3FC2693B352B606B108E20CD

	/*RSA DQ*/
	02 41
		009210B3D7216807C749CD6FF2E85AD85DB72EDAE4F222E49DF8BD2EB04D9DE79D18F549C5B5E878D9B480AC50217697482A0DAFA4CFD221F97996B73488C84BC5

	/*RSA InverseQ*/
	02 40
		06F0F9DD96248A27FAFB94B0A93676D653A99C7C7B9DCDADE65414C6889284B924F26A23AFFA86AF3FD804453B73FDFEA9310CC909BFC9928D5F757198B1075D

PEM PKCS#8私钥编码格式

/*****1024位PKCS#8私钥*****/
-----BEGIN PRIVATE KEY-----
MIICdgIBADANBgkqhkiG9w0BAQEFAASCAmAwggJcAgEAAoGBAJjD34zf5ETMO1ir
AGuz9qz87LwZETk6aeo5XQR+QSIIiOJzNtUQWdnepGMtsMBN+YHE1DpzoWBrydfb
yCUQf9ov9EbYp2kjwoxSooCzM3J2wdJ6H0xIpx3nOBLg24TS755HsIHyQ5aKmIsN
CZjfySkzfqlFZ01CWkhpMOjkiEknAgMBAAECgYBwY1JZGvKeJr7Wid/iXODy/ZTR
AYQpXS9E0XT8dEJI3oyORQMnF0NzRRgdmyS5JeSVMxCL/DvSaxpxA1Go6w2TfY7q
9U/Gvg19NVohXn0m/1nlJcaJGZFld5HDSSwph07BoMkm73MRM0dmgwUmbyyr+0Yk
9AI816yhlFmywvuaOQJBAM4jqMq3rRu+7pVe+1CjJRRvIyP14I4Fq1Lj2NG+/fbp
Mxz3nV71NxucPRzEmtXU3rIiL7756PB9qBt5h/743rUCQQC9tzwpOUFsj1MzCdWR
Cmy35ySCbeClEOEB9D8u3uvyDYoAewm/7BsAkKC7w+Coz2ZCNXFn7vz5osRD6Hmu
8xXrAkBjVz39y3yKFX5mz6ovVyAEc/asWs7HwqWowZL4qaE8P2/Zct8NJwFStf2h
goHXsMlNcTovP8JpOzUrYGsQjiDNAkEAkhCz1yFoB8dJzW/y6FrYXbcu2uTyIuSd
+L0usE2d550Y9UnFteh42bSArFAhdpdIKg2vpM/SIfl5lrc0iMhLxQJABvD53ZYk
iif6+5SwqTZ21lOpnHx7nc2t5lQUxoiShLkk8mojr/qGrz/YBEU7c/3+qTEMyQm/
yZKNX3VxmLEHXQ==
-----END PRIVATE KEY-----

/*****二进制表述*****/
30820276020100300D06092A864886F70D0101010500048202603082025C0201000281810098C3DF8CDFE444CC3B58AB006BB3F6ACFCECBC1911393A69EA395D047E41220888E27336D51059D9DEA4632DB0C04DF981C4D43A73A1606BC9D7DBC825107FDA2FF446D8A76923C28C52A280B3337276C1D27A1F4C48A71DE73812E0DB84D2EF9E47B081F243968A988B0D0998DFC929337EA945674D425A486930E8E48849270203010001028180706352591AF29E26BED689DFE25CE0F2FD94D10184295D2F44D174FC744248DE8C8E45032717437345181D9B24B925E49533108BFC3BD26B1A710351A8EB0D937D8EEAF54FC6BE0D7D355A215E7D26FF59E525C6891991657791C3492C29874EC1A0C926EF73113347668305266F2CABFB4624F4023CD7ACA19459B2C2FB9A39024100CE23A8CAB7AD1BBEEE955EFB50A325146F2323F5E08E05AB52E3D8D1BEFDF6E9331CF79D5EF5371B9C3D1CC49AD5D4DEB2222FBEF9E8F07DA81B7987FEF8DEB5024100BDB73C2939416C8F533309D5910A6CB7E724826DE0A510E101F43F2EDEEBF20D8A007B09BFEC1B0090A0BBC3E0A8CF6642357167EEFCF9A2C443E879AEF315EB024063573DFDCB7C8A157E66CFAA2F57200473F6AC5ACEC7C2A5A8C192F8A9A13C3F6FD972DF0D270152B5FDA18281D7B0C94D713A2F3FC2693B352B606B108E20CD0241009210B3D7216807C749CD6FF2E85AD85DB72EDAE4F222E49DF8BD2EB04D9DE79D18F549C5B5E878D9B480AC50217697482A0DAFA4CFD221F97996B73488C84BC5024006F0F9DD96248A27FAFB94B0A93676D653A99C7C7B9DCDADE65414C6889284B924F26A23AFFA86AF3FD804453B73FDFEA9310CC909BFC9928D5F757198B1075D


/*****二进制分解(和PKCS#1只是多了一段数据,详细结构参考PKCS#1的)*****/

/*后续内容长度*/
30 82 0276

	/*固定版本号*/
	02 01
		00

	/*#####相对于KCS#1仅仅是在此处开始插入部分数据 Begin#####*/

	/*
	固定内容 OID
	*/
	30 0D
		06 09 2A864886F70D010101
		05 00

	/*后续内容长度,后面内容长度为0x0260字节,和开头格式一致*/
	04 82 0260 //04 OCTET STRING

		/*后续内容长度,后面内容长度为0x025C字节,和开头格式一致*/
		30 82 025C

			/*固定版本号*/
			02 01
				00

			/*#####相对于KCS#1仅仅是在此处结束插入部分数据 End#####*/

			/*RSA Modulus内容*/
			02 81 81 
				0098C3DF8CDFE444CC3B58A...

	...后续内容省略...

Bug:C#生成的非正常密钥

RSACryptoServiceProvider生成的密钥,有一定概率生成某些字段首字节为0的密钥(测试时发现几百个里面有一个),解析这种数据就难搞了,Java生成的密钥就没有出现这种情况。直接放2个样本吧,这两个样本是有效的密钥:

样本一:D参数首字节是0
<RSAKeyValue><Modulus>3pfIaO4DYwrsymg7xddlr2gN2rtl2C+H3+RX6Nc3GQMJ+otZn5exMg5cMIWe+aS3mWB9XJi9AxlRdRAFf4j1PQ==</Modulus><Exponent>AQAB</Exponent><P>/nSZaBqEGehINeMa805aAqjNOhlHNYGZmF/C4evMvsc=</P><Q>3/GsDJA/AnKq/lqbpCr1OB5h2wIKsLlPGafPljFzN9s=</Q><DP>CSHGH6ZT91oOvWBZJ0I4mL/WHa+qjpEIIh/Nrq33uyE=</DP><DQ>nIg/m3SEJoDiVvIcko7YYwaRndT6hfaxfJxYtIISKDs=</DQ><InverseQ>rok4ds5VOzho0h+4uvTeeOjEL1jxDaarUlnb3gxB6yY=</InverseQ><D>ADQrXs04+5I6/URzKY807KAvww+A3F3OxgmzeucXidJSc+RMfVzkdf30X2iJHTj20EpzSfwCnlRNERCYXIqskQ==</D></RSAKeyValue>

样本二:DP参数首字节是0
<RSAKeyValue><Modulus>zbTQkRxbyJfCYnEzUjG3rWWRCpWYka5rWmnkqPXCYvLdZ5OIJEy+2Rgu9wCAnCdCBWMRLdUWjmJdNQizBcITVQ==</Modulus><Exponent>AQAB</Exponent><P>+N3qwya7gWN568BuciUwkSlgWVlORusk267Nkkiu3jc=</P><Q>05o0BiIaDFYtHYNUh5/ROgDSkWqPXjy8Nlmh0S6QdNM=</Q><DP>AJemo2hIMfqmo6UFnkfwYagTjqLjyM9uewdjfeGmaOk=</DP><DQ>ZK3D/v8Owbvm71njSDxkQmLNzV6UJFRlgL6Y3Xx4Qv0=</DQ><InverseQ>zHAAUftduljSvsxV0TAblEX+FUXw3unb3M6oaow7+R0=</InverseQ><D>n7XqVTAiZuzFBG+FfCSTynHYGdKqITm9qfYbjb85zF4EWxZWdMjm/9V2guKbRYGV9Xo96PowNnjeJ+NkbG5B5Q==</D></RSAKeyValue>

这几个问题是QQ:284485094 提出的,循环一下测试很容易出现这个现象,现在的代码已经兼容了这种密钥。

⭐捐赠

如果这个库有帮助到您,请 Star 一下。

您也可以使用支付宝或微信打赏作者: