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

:open_book:RSA-java的帮助文档

本项目核心功能：支持Java环境下PEM（PKCS#1、PKCS#8）格式RSA密钥对导入、导出。

你可以只copy RSA_PEM.java 文件到你的项目中使用（建好package目录或者修改一下package），只需这一个文件你就拥有了通过PEM格式密钥简单快速创建RSA Cipher的能力。也可以clone整个项目代码双击Start.bat即可直接测试。

底层实现采用PEM文件二进制层面上进行字节码解析，简单轻巧0依赖；附带实现了一个RSA封装操作类（RSA_Util.java），和一个测试控制台程序（Test.java，双击Start.bat即可运行，前提装了JDK）。

如需功能定制，网站、App、小程序开发等需求，请加本文档下面的QQ群，联系群主（即作者），谢谢~

【C#版】：RSA-csharp，本Java项目从C#版移植。

​

特性

• 通过XML格式密钥对创建RSAPublicKey、RSAPrivateKey、Cipher
• 通过PEM格式密钥对创建RSAPublicKey、RSAPrivateKey、Cipher
• 通过指定密钥位数创建RSA（生成公钥、私钥）
• RSA加密、解密
• RSA签名、验证
• 导出XML格式公钥、私钥
• 导出PEM格式公钥、私钥
• PEM格式秘钥对和XML格式秘钥对互转

​

如何加密、解密、签名、校验

得到了RSA_PEM后，加密解密就异常简单了，没那么多啰嗦难懂的代码：

//先解析pem，公钥私钥都行，如果是xml就用 RSA_PEM.FromXML("<RSAKeyValue><Modulus>....</RSAKeyValue>")
RSA_PEM pem=RSA_PEM.FromPEM("-----BEGIN XXX KEY-----..此处意思意思..-----END XXX KEY-----");

//直接创建RSA操作类
RSA_Util rsa=new RSA_Util(pem);
//RSA_Util rsa=new RSA_Util(2048); //也可以直接生成新密钥，rsa.ToPEM()得到pem对象

//加密
String enTxt=rsa.Encode("测试123");

//解密
String deTxt=rsa.Decode(enTxt);

//签名
String sign=rsa.Sign("SHA1", "测试123");

//校验签名
boolean isVerify=rsa.Verify("SHA1", sign, "测试123");

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

System.out.println(pemTxt+"\n"+enTxt+"\n"+deTxt+"\n"+sign+"\n"+isVerify);
//****更多的实例，请阅读 Test.java****
//****更多功能方法，请阅读下面的详细文档****

​

【QQ群】交流与支持

欢迎加QQ群：421882406，纯小写口令：xiangyuecn

​

​

​

​

​

​

:open_book:文档

【RSA_PEM.java】

此文件不依赖任何文件，可以直接copy这个文件到你项目中用；通过FromPEM、ToPEM 和FromXML、ToXML这两对方法，可以实现PEMPKCS#1、PKCS#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>。

构造方法

RSA_PEM(RSAPublicKey publicKey, RSAPrivateKey privateKeyOrNull)：通过RSA中的公钥和私钥构造一个PEM，私钥可以不提供，导出的PEM就只包含公钥。

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()：密钥位数。

boolean hasPrivate()：是否包含私钥。

实例方法

RSAPublicKey getRSAPublicKey()：得到公钥Java对象。

RSAPrivateKey getRSAPrivateKey()：得到私钥Java对象，如果此PEM不含私钥会直接报错。

String ToPEM(boolean convertToPublic, boolean privateUsePKCS8, boolean 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(boolean convertToPublic)：ToPEM方法的简化写法，不管公钥还是私钥都返回PKCS#1格式；似乎导出PKCS#1公钥用的比较少，PKCS#8的公钥用的多些，私钥#1#8都差不多。

String ToPEM_PKCS8(boolean convertToPublic)：ToPEM方法的简化写法，不管公钥还是私钥都返回PKCS#8格式。

String ToXML(boolean convertToPublic)：将RSA中的密钥对转换成XML格式，如果convertToPublic含私钥的RSA将只返回公钥，仅含公钥的RSA不受影响。

【RSA_Util.java】

这个文件依赖RSA_PEM.java，封装了加密、解密、签名、验证、秘钥导入导出操作。

构造方法

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

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

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

实例属性

RSAPublicKey publicKey：RSA公钥。

RSAPrivateKey privateKey：RSA私钥，仅有公钥时为null。

int keySize()：密钥位数。

boolean hasPrivate()：是否包含私钥。

实例方法

String ToXML(boolean convertToPublic)：导出XML格式秘钥对，如果convertToPublic含私钥的RSA将只返回公钥，仅含公钥的RSA不受影响。

RSA_PEM ToPEM(boolean convertToPublic)：导出RSA_PEM对象（然后可以通过RSA_PEM.ToPEM方法导出PEM文本），如果convertToPublic含私钥的RSA将只返回公钥，仅含公钥的RSA不受影响。

String Encode(String str)：加密操作，支持任意长度数据，出错抛异常。

byte[] Encode(byte[] data)：加密数据，支持任意长度数据，出错抛异常。

String Decode(String str)：解密字符串（utf-8），出错抛异常。

byte[] Decode(byte[] data)：解密数据，出错抛异常。

String Sign(String hash, String str)：对str进行签名，并指定hash算法（如：SHA256 大写）。

byte[] Sign(String hash, byte[] data)：对data进行签名，并指定hash算法（如：SHA256 大写）。

boolean Verify(String hash, String sign, String str)：验证字符串str的签名是否是sign，并指定hash算法（如：SHA256 大写）。

boolean Verify(String hash, byte[] sign, byte[] data)：验证data的签名是否是sign，并指定hash算法（如：SHA256 大写）。

​

​

​

​

​

​

:open_book:图例

控制台运行：

RSA工具（非开源）：

​

​

​

:open_book:知识库

请移步到RSA-csharp阅读知识库部分，知识库内包含了详细的PEM格式解析，和部分ASN.1语法；然后逐字节分解PEM字节码教程。

本库的诞生是由于微信付款到银行卡的功能，然后微信提供的RSA公钥接口返回的公钥和openssl -RSAPublicKey_out生成的一样，公钥 PEM 字节码内没有OID（目测是因为不带 OID 所以openssl 自己都不支持用这个公钥来加密数据）,这种是不是PKCS#1 格式不清楚(目测是，大部分文章也说是)，正反都是难用，所以就撸了一个java版转换代码，也不是难事以前撸过C#的，copy C#的代码过来改改就上线使用了。

本库的代码整理未使用IDE，RSA_PEM.java copy过来的，Test.java直接用的文本编辑器编写，*.java文件全部丢到根目录，没有创建包名目录，源码直接根目录裸奔，简单粗暴；这样的项目结构肉眼看去也算是简洁，也方便copy文件使用。

​

​

​

:star:捐赠

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

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