RsaHelper (mica-core 2.7.18.9 API)

java.lang.Object
- net.dreamlu.mica.core.utils.RsaHelper

```
public class RsaHelper
extends Object
```
RSA PEM格式秘钥对的解析和导出
caiqy: 一般来说:网上的公钥都是pkcs8的,虽然选了pkcs1加密,但是还是给的pkcs8的公钥,所以不要再对公钥转了,转私钥就行
GitHub:https://github.com/xiangyuecn/RSA-java
https://github.com/xiangyuecn/RSA-java/blob/master/RSA_PEM.java 移植自：https://github.com/xiangyuecn/RSA-csharp/blob/master/RSA_PEM.cs

Author:

xiangyuecn, caiqyxyx, L.cm

Constructor Summary

Constructors
Constructor and Description
`RsaHelper(byte[] modulus, byte[] exponent, byte[] dOrNull)` 通过公钥指数和私钥指数构造一个PEM，会反推计算出P、Q但和原始生成密钥的P、Q极小可能相同注意：所有参数首字节如果是0，必须先去掉
`RsaHelper(byte[] modulus, byte[] exponent, byte[] d, byte[] p, byte[] q, byte[] dp, byte[] dq, byte[] inverseQ)` 通过全量的PEM字段数据构造一个PEM，除了模数modulus和公钥指数exponent必须提供外，其他私钥指数信息要么全部提供，要么全部不提供（导出的PEM就只包含公钥）注意：所有参数首字节如果是0，必须先去掉
`RsaHelper(RSAPublicKey publicKey, RSAPrivateKey privateKeyOrNull)` 通过公钥和私钥构造一个PEM

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static byte[]`	`bigB(BigInteger bigx)` BigInt导出byte整数首字节>0x7F的会加0前导，保证正整数，因此需要去掉0
`static BigInteger`	`bigX(byte[] bigb)` 转成正整数，如果是负数，需要加前导0转成正整数
`static RsaHelper`	`fromPem(String pem)` 用PEM格式密钥对创建RSA，支持PKCS#1、PKCS#8格式的PEM
`static RsaHelper`	`fromXml(String xml)` 将XML格式密钥转成PEM，支持公钥xml、私钥xml
`RSAPrivateKey`	`getRSAPrivateKey()` 得到私钥Java对象
`RSAPublicKey`	`getRSAPublicKey()` 得到公钥Java对象
`boolean`	`hasPrivate()` 是否包含私钥
`int`	`keySize()` 秘钥位数
`String`	`toPem(boolean convertToPublic, boolean privateUsePKCS8, boolean publicUsePKCS8)` 将RSA中的密钥对转换成PEM格式。
`String`	`toPemPKCS1(boolean convertToPublic)` 将RSA中的密钥对转换成PEM PKCS#8格式。
`String`	`toPemPKCS8(boolean convertToPublic)` 将RSA中的密钥对转换成PEM PKCS#8格式。
`String`	`toXml(boolean convertToPublic)` 将RSA中的密钥对转换成XML格式，如果convertToPublic含私钥的RSA将只返回公钥，仅含公钥的RSA不受影响

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RsaHelper
```
public RsaHelper(RSAPublicKey publicKey,
                 @Nullable
                 RSAPrivateKey privateKeyOrNull)
```
    通过公钥和私钥构造一个PEM
    
    Parameters:
    
    publicKey - 必须提供公钥
    
    privateKeyOrNull - 私钥可以不提供，导出的PEM就只包含公钥
  - RsaHelper
```
public RsaHelper(byte[] modulus,
                 byte[] exponent,
                 byte[] d,
                 byte[] p,
                 byte[] q,
                 byte[] dp,
                 byte[] dq,
                 byte[] inverseQ)
```
    通过全量的PEM字段数据构造一个PEM，除了模数modulus和公钥指数exponent必须提供外，其他私钥指数信息要么全部提供，要么全部不提供（导出的PEM就只包含公钥）注意：所有参数首字节如果是0，必须先去掉
  - RsaHelper
```
public RsaHelper(byte[] modulus,
                 byte[] exponent,
                 @Nullable
                 byte[] dOrNull)
```
    通过公钥指数和私钥指数构造一个PEM，会反推计算出P、Q但和原始生成密钥的P、Q极小可能相同注意：所有参数首字节如果是0，必须先去掉
    
    Parameters:
    
    modulus - 必须提供模数
    
    exponent - 必须提供公钥指数
    
    dOrNull - 私钥指数可以不提供，导出的PEM就只包含公钥
- Method Detail
  - keySize
```
public int keySize()
```
    秘钥位数
  - hasPrivate
```
public boolean hasPrivate()
```
    是否包含私钥
  - getRSAPublicKey
```
public RSAPublicKey getRSAPublicKey()
                             throws Exception
```
    得到公钥Java对象
    
    Throws:
    
    Exception
  - getRSAPrivateKey
```
public RSAPrivateKey getRSAPrivateKey()
                               throws Exception
```
    得到私钥Java对象
    
    Throws:
    
    Exception
  - bigX
```
public static BigInteger bigX(byte[] bigb)
```
    转成正整数，如果是负数，需要加前导0转成正整数
  - bigB
```
public static byte[] bigB(BigInteger bigx)
```
    BigInt导出byte整数首字节>0x7F的会加0前导，保证正整数，因此需要去掉0
  - fromPem
```
public static RsaHelper fromPem(String pem)
                         throws Exception
```
    用PEM格式密钥对创建RSA，支持PKCS#1、PKCS#8格式的PEM
    
    Throws:
    
    Exception
  - toPemPKCS1
```
public String toPemPKCS1(boolean convertToPublic)
                  throws Exception
```
    将RSA中的密钥对转换成PEM PKCS#8格式。convertToPublic：等于true时含私钥的RSA将只返回公钥，仅含公钥的RSA不受影响。公钥如：-----BEGIN RSA PUBLIC KEY-----，私钥如：-----BEGIN RSA PRIVATE KEY----- 。似乎导出PKCS#1公钥用的比较少，PKCS#8的公钥用的多些，私钥#1#8都差不多
    
    Throws:
    
    Exception
  - toPemPKCS8
```
public String toPemPKCS8(boolean convertToPublic)
                  throws Exception
```
    将RSA中的密钥对转换成PEM PKCS#8格式。convertToPublic：等于true时含私钥的RSA将只返回公钥，仅含公钥的RSA不受影响。公钥如：-----BEGIN PUBLIC KEY-----，私钥如：-----BEGIN PRIVATE KEY-----
    
    Throws:
    
    Exception
  - toPem
```
public String toPem(boolean convertToPublic,
                    boolean privateUsePKCS8,
                    boolean publicUsePKCS8)
             throws Exception
```
    将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格式公钥似乎比较少见
    
    Throws:
    
    Exception
  - fromXml
```
public static RsaHelper fromXml(String xml)
```
    将XML格式密钥转成PEM，支持公钥xml、私钥xml
  - toXml
```
public String toXml(boolean convertToPublic)
```
    将RSA中的密钥对转换成XML格式，如果convertToPublic含私钥的RSA将只返回公钥，仅含公钥的RSA不受影响

Class RsaHelper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RsaHelper

RsaHelper

RsaHelper

Method Detail

keySize

hasPrivate

getRSAPublicKey

getRSAPrivateKey

bigX

bigB

fromPem

toPemPKCS1

toPemPKCS8

toPem

fromXml

toXml