# RSAUtil

**Repository Path**: shipingx/RSAUtil

## Basic Information

- **Project Name**: RSAUtil
- **Description**: 使用帮助工具的 .NET Core RSA 算法。支持数据加密、解密、签名和验证签名。它支持三种关键格式，即：xml、pkcs1、pkcs8。它还支持这三种格式的密钥转换。最后还支持 pem 格式。
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-02
- **Last Updated**: 2024-07-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# RSAUtil  [中文文档](https://github.com/stulzq/RSAUtil/blob/master/README_Chinese.md "中文文档")

[![Build Status](https://ci2.xcmaster.com/job/RSAUtil/job/master/badge/icon)](https://ci2.xcmaster.com/job/RSAUtil/job/master/)

.NET Core RSA algorithm using the help tool.It supports data encryption, decryption, signature and verification signature.It supports three key formats, namely: xml, pkcs1, pkcs8.It also supports key conversion for these three formats.Last also support pem formatting.

Thanks for onovotny's [bc-csharp](https://github.com/onovotny/bc-csharp "bc-csharp")

[![Latest version](https://img.shields.io/nuget/v/XC.RSAUtil.svg?style=flat-square)](https://www.nuget.org/packages/XC.RSAUtil/)

# Install

````shell
Install-Package XC.RSAUtil
````

> The old package name is `XC.Framework.Security.RSAUtil`. Now renamed `XC.RSAUtil` and will continue to use.

# Doc

### Generate the key

>Use class `RsaKeyGenerator`.The result returned is a list of two-element strings,Element 1 is the private key and element 2 is the public key.

Format: XML

```csharp
var keyList = RsaKeyGenerator.XmlKey(2048);
var privateKey = keyList[0];
var publicKey = keyList[1];
```

Format: Pkcs1

```csharp
var keyList = RsaKeyGenerator.Pkcs1Key(2048);
var privateKey = keyList[0];
var publicKey = keyList[1];
```

Format: Pkcs8

```csharp
var keyList = RsaKeyGenerator.Pkcs8Key(2048);
var privateKey = keyList[0];
var publicKey = keyList[1];
```

### RSA key conversion

>Use class `RsaKeyConvert`.It  supports key conversion for these three formats,namely: xml, pkcs1, pkcs8.

##### XML->Pkcs1:

- Private Key : `RsaKeyConvert.PrivateKeyXmlToPkcs1()`
- Public Key  : `RsaKeyConvert.PublicKeyXmlToPem()`

##### XML->Pkcs8:

- Private Key : `RsaKeyConvert.PrivateKeyXmlToPkcs8()`
- Public Key  : `RsaKeyConvert.PublicKeyXmlToPem()`

##### Pkcs1->XML:

- Private Key : `RsaKeyConvert.PrivateKeyPkcs1ToXml()`
- Public Key  : `RsaKeyConvert.PublicKeyPemToXml()`

##### Pkcs1->Pkcs8:

- Private Key : `RsaKeyConvert.PrivateKeyPkcs1ToPkcs8()`
- Public Key  : No conversion required

##### Pkcs8->XML:

- Private Key : `RsaKeyConvert.PrivateKeyPkcs8ToXml()`
- Public Key  : `RsaKeyConvert.PublicKeyPemToXml()`

##### Pkcs8->Pkcs1:

- Private Key : `RsaKeyConvert.PrivateKeyPkcs8ToPkcs1()`
- Public Key  : No conversion required

### Encrypt, decrypt, sign, and verify signatures

>XML, Pkcs1, Pkcs8 respectively corresponding categories: `RsaXmlUtil`, `RsaPkcs1Util`, `RsaPkcs8Util`.They inherit from the abstract class `RSAUtilBase`

- Encrypt: `RSAUtilBase.Encrypt()`
- Decrypt: `RSAUtilBase.Decrypt()`
- Sign: `RSAUtilBase.SignData()`
- Verify: `RSAUtilBase.VerifyData()`

### PEM formatting

>Use class `RsaPemFormatHelper`.

- Format Pkcs1 format private key: `RsaPemFormatHelper.Pkcs1PrivateKeyFormat()`

- Remove the Pkcs1 format private key format: `RsaPemFormatHelper.Pkcs1PrivateKeyFormatRemove()`

- Format Pkcs8 format private key: `RsaPemFormatHelper.Pkcs8PrivateKeyFormat()`

- Remove the Pkcs8 format private key format: `RsaPemFormatHelper.Pkcs8PrivateKeyFormatRemove()`

## Reference component

 [bc-csharp](https://github.com/onovotny/bc-csharp "bc-csharp") - onovotny

## Cases

[dotnetrsa](https://github.com/stulzq/dotnetrsa) - DotnetRSA is a .NET Core Global Tool.Dotnet RSA Tool can help you generate xml pkcs1, pkcs8 three kinds of format keys, and supports three types of mutual conversion.