EggEgg.XC.RSAUtil 136.1.0-rc52

EN | 中文

Notice

This package is not the official version of GitHub Repository stulzq/RSAUtil but a custom modified version. Please go to NuGet XC.RSAUtil for the official one.

RSAUtil

A .NET Core RSA tool that provides the ability of data encryption, decryption, signing and verifying signature. It supports using and converting RSA keys of 4 key formats, namely: xml, pkcs1, pkcs8, der.

Installation via NuGet

Install-Package EggEgg.XC.RSAUtil

Documentation

Ready to use

You can use RSAUtilBase.LoadRSAKey(byte[]) to quickly load private and public keys in XML, PKCS1, PKCS8 and DER formats, and paramters like the format and the bits of the RSA key can be auto-detected. The private key instance supports the functionality of the public key (public key encryption, signature verification).

Generating keys

Use the "RsaKeyGenerator" class. The result returned is a KeyResult containing privateKey and publicKey.

Format:

var keys = RsaKeyGenerator.XmlKey(2048); // XML format
// var keys = RsaKeyGenerator.Pkcs1Key(2048); // PKCS1 format
// var keys = RsaKeyGenerator.Pkcs8Key(2048); // PKCS8 format
var privateKey = keys.privateKey;
var publicKey = key.publicKey;

RSA key conversion

You can freely convert key formats using RsaKeyConvert.Format(). For example:

RsaKeyConvert.Format(key,
    new RsaKeyFeature { IsPrivate = true; Format = RsaKeyFormat.Xml; Padding = RsaKeyPadding.Xml }, 
    new RsaKeyFeature { IsPrivate = true; Format = RsaKeyFormat.Der; Padding = RsaKeyPadding.Pkcs1 });

RsaKeyConvert.Format(key,
    new RsaKeyFeature { IsPrivate = false; Format = RsaKeyFormat.Xml; Padding = RsaKeyPadding.Xml },
    new RsaKeyFeature { IsPrivate = false; Format = RsaKeyFormat.Pem; Padding = RsaKeyPadding.Pkcs1 });

RsaKeyConvert.Format(key, 
    new RsaKeyFeature { IsPrivate = true; Format = RsaKeyFormat.Pem; Padding = RsaKeyPadding.Pkcs1 },
    new RsaKeyFeatire { IsPrivate = false; Format = RsaKeyFormat.Pem; Padding = RsaKeyPadding.Pkcs8 });

Other hardcoded conversion methods can also be used under the RsaKeyConvert class.

Encryption, decryption, signing, and signature verification

XML, Pkcs1, and Pkcs8 correspond to the classes: RsaXmlUtil, RsaPkcs1Util, RsaPkcs8Util. They inherit from the abstract class RSAUtilBase.

• Encryption: RSAUtilBase.RsaEncrypt()
• Decryption: RSAUtilBase.RsaDecrypt()
• Sign: RSAUtilBase.SignData()
• Verification: RSAUtilBase.VerifyData()

Open-source components used

bc-csharp - onovotny