Chilkat C# Rsa Class Reference
Rsa
RSA encryption component / library. Encrypt and decrypt byte arrays and strings. Generate public/private key pairs from 384 to 4096 bits in length. Import and export RSA keys. Import keys from SNK files. Input/output in raw binary, base64, hex encoding, quoted-printable, URL-encoding, etc.
Object Creation
(C#)
Chilkat.Rsa obj = new Chilkat.Rsa();
(VB.NET)
Dim obj As New Chilkat.Rsa()
Properties
public string Charset {get; set; }
This property only applies when encrypting, decrypting, signing, or verifying signatures for strings. When encrypting strings, the input string is first converted to this charset before encrypting.
When decrypting, the decrypted data is interpreted as a string with this charset encoding and converted to the appropriate return. For example, ActiveX's returning strings always return Unicode (2 bytes/char). Java strings are utf-8. Chilkat C++ strings are ANSI or utf-8. .NET strings are Unicode.
When signing string data, the input string is first converted to this charset before being hashed and signed. When verifying the signature for string data, the input string is first converted to this charset before the verification process begins.
public string EncodingMode {get; set; }
Encoding mode to be used in methods ending in "ENC", such as EncryptStringENC. Valid EncodingModes are "base64", "hex", "url", or "quoted-printable" (or "qp"). Encryption methods ending in "ENC" will return encrypted data as a string encoded according to this property's value. Decryption methods ending in "ENC" accept an encoded string as specified by this property. The string is first decoded and then decrypted. The default value is "base64".
This property also applies to the "ENC" methods for creating and verifying digital signatures.
public string LastErrorHtml {get; }
Error information in HTML format for the last method called.
public string LastErrorText {get; }
Error information in plain-text format for the last method called.
public string LastErrorXml {get; }
Error information in XML format for the last method called.
public bool LittleEndian {get; set; }
The default value is true, which means that signatures and encrypted output will be created using the little-endian byte ordering, which is what Microsoft's Crypto API produces. To produce big-endian output, set the property equal to false. Chilkat RSA is capable of reading and verifying either little-endian or big-endian signatures, regardless of this setting. When decrypting, this property's value must match the byte ordering used when encrypting.
public int NumBits {get; }
The number of bits of the key generated or imported into this RSA encryption object. Keys ranging in size from 384 bits to 4096 bits can be generated by calling GenerateKey. A public or private key may be imported by calling ImportPublicKey or ImportPrivateKey. A key must be available either via GenerateKey or import before any of the encrypt/decrypt methods may be called.
public bool OaepPadding {get; set; }
Controls whether Optimal Asymmetric Encryption Padding (OAEP) is used for the padding scheme (for encrypting/decrypting). If set to false, PKCS1 v1.5 padding is used. If set to true, PKCS1 v2.0 (OAEP) padding is used.
When creating digital signatures, this property controls whether RSA-PSS or PKCS1 v1.5 is used. If true, then the RSA-PSS signature scheme is used.
public string Version {get; }
Returns the version of the component as a string, such as "2.0.0".
Methods
public byte[] DecryptBytes(byte[] inData, bool usePrivateKey);
Decrypts byte data using the RSA encryption algorithm. usePrivateKey should be set to true if the private key is to be used for decrypting. Otherwise it should be set to false if the public key is to be used for decrypting. Returns null on failure
public byte[] DecryptBytesENC(string str, bool bUsePrivateKey);
Same as DecryptBytes, except the input is an encoded string. The encoding is specified by the EncodingMode property, which can have values such as "base64", "hex", "quoted-printable", "url", etc. Returns null on failure
public string DecryptString(byte[] binarySig, bool usePrivateKey);
Decrypts encrypted string data and returns an unencrypted string. usePrivateKey should be set to true if the private key is to be used for decrypting. Otherwise it should be set to false if the public key is to be used. The Charset property controls how the component interprets the decrypted string. Depending on the programming language, strings are returned to the application as Unicode, utf-8, or ANSI. Internal to DecryptString, the decrypted string is automatically converted from the charset specified by the Charset property to the encoding required by the calling programming language. Returns a null on failure
public string DecryptStringENC(string encodedSig, bool usePrivateKey);
Same as DecryptString, except the input is an encoded string. The encoding is specified by the EncodingMode property, which can have values such as "base64", "hex", "quoted-printable", "url", etc. Returns a null on failure
public byte[] EncryptBytes(byte[] binaryData, bool usePrivateKey);
Encrypts byte data using the RSA encryption algorithm. usePrivateKey should be set to true if the private key is to be used for encrypting. Otherwise it should be set to false if the public key is to be used for encrypting. Returns null on failure
public string EncryptBytesENC(byte[] data, bool bUsePrivateKey);
Same as EncryptBytes, except the output is an encoded string. The encoding is specified by the EncodingMode property, which can have values such as "base64", "hex", "quoted-printable", "url", etc. Returns a null on failure
public byte[] EncryptString(string stringToSign, bool usePrivateKey);
Encrypts a string using the RSA encryption algorithm. usePrivateKey should be set to true if the private key is to be used for encrypting. Otherwise it should be set to false if the public key is to be used for encrypting. The string is first converted (if necessary) to the character encoding specified by the Charset property before encrypting. The encrypted bytes are returned. Returns null on failure
public string EncryptStringENC(string str, bool bUsePrivateKey);
Same as EncryptString, except the output is an encoded string. The encoding is specified by the EncodingMode property, which can have values such as "base64", "hex", "quoted-printable", "url", etc. Returns a null on failure
public string ExportPrivateKey();
Exports the private-key of an RSA key pair to XML format. This is typically called after generating a new RSA key via the GenerateKey method. Returns a null on failure
public string ExportPublicKey();
Exports the public-key of an RSA key pair to XML format. This is typically called after generating a new RSA key via the GenerateKey method. Returns a null on failure
public bool GenerateKey(int numBits);
Generates a new RSA public/private key pair. The number of bits can range from 384 to 4096. Typical key lengths are 1024 or 2048 bits. After successful generation, the public/private parts of the key can be exported to XML via the ExportPrivateKey and ExportPublicKey methods. Returns true for success, false for failure.
public bool ImportPrivateKey(string xmlKey);
Imports a private key from XML format. After successful import, the private key can be used to encrypt or decrypt. A private key (by definition) contains both private and public parts. This is because the public key consist of modulus and exponent. The private key consists of modulus, exponent, P, Q, DP, DQ, InverseQ, and D:
<RSAKeyValue>
<Modulus>...</Modulus>
<Exponent>...</Exponent>
<P>...</P>
<Q>...</Q>
<DP>...</DP>
<DQ>...</DQ>
<InverseQ>...</InverseQ>
<D>...</D>
</RSAKeyValue>
Important: The Rsa object can contain either a private key or a public key, but not both. Importing a private key overwrites the existing key regardless of whether the type of key is public or private. Returns true for success, false for failure.
public bool ImportPublicKey(string xmlKey);
Imports a public key from XML format. After successful import, the public key can be used to encrypt or decrypt.
Note: Importing a public key overwrites the key that is currently contained in this object - even if it's a private key.
A public key consists of modulus and exponent:
<RSAKeyValue>
<Modulus>...<</Modulus>
<Exponent>...</Exponent>
</RSAKeyValue>
Important: The Rsa object can contain either a private key or a public key, but not both. Importing a private key overwrites the existing key regardless of whether the type of key is public or private. Returns true for success, false for failure.
public byte[] OpenSslSignBytes(byte[] data);
(PreRelease) Duplicates OpenSSL's rsautl utility for creating RSA signatures. Input data consists of binary bytes, and returns the signature bytes. Returns null on failure Duplicating OpenSSL rsautl (creating RSA signatures)
public string OpenSslSignBytesENC(byte[] data);
(PreRelease) Duplicates OpenSSL's rsautl utility for creating RSA signatures. Input data consists of binary bytes, and returns the signature as a string encoded according to the EncodingMode property (base64, hex, etc.). Returns a null on failure
public byte[] OpenSslSignString(string str);
(PreRelease) Duplicates OpenSSL's rsautl utility for creating RSA signatures. Input data is a string, and returns the signature bytes. Returns null on failure
public string OpenSslSignStringENC(string str);
(PreRelease) Duplicates OpenSSL's rsautl utility for creating RSA signatures. Input data is a string, and returns the signature as a string encoded according to the EncodingMode property (base64, hex, etc.). Returns a null on failure Duplicating OpenSSL rsautl (creating RSA signatures)
public byte[] OpenSslVerifyBytes(byte[] signature);
(PreRelease) Duplicates OpenSSL's rsautl utility for verifying RSA signatures and recovering the original data. Input data consists of the raw signature bytes and returns the original bytes. Returns null on failure Duplicating OpenSSL rsautl (creating RSA signatures)
public byte[] OpenSslVerifyBytesENC(string str);
(PreRelease) Duplicates OpenSSL's rsautl utility for verifying RSA signatures and recovering the original data. Input data is a signature string encoded according to the EncodingMode property (base64, hex, etc.). Returns the original bytes. Returns null on failure
public string OpenSslVerifyString(byte[] data);
(PreRelease) Duplicates OpenSSL's rsautl utility for verifying RSA signatures and recovering the original data. Input data consists of the raw signature bytes and returns the original string. Returns a null on failure
public string OpenSslVerifyStringENC(string str);
(PreRelease) Duplicates OpenSSL's rsautl utility for verifying RSA signatures and recovering the original data. Input data is a signature string encoded according to the EncodingMode property (base64, hex, etc.). Returns the original string. Returns a null on failure Duplicating OpenSSL rsautl (creating RSA signatures)
public bool SaveLastError(string filename);
Saves the last error information to an XML formatted file.
public byte[] SignBytes(byte[] binaryData, string hashAlgorithm);
Creates an RSA digital signature by hashing binaryData and then signing the hash. The hash algorithm is specified by hashAlgorithm, which may be "SHA-1", "MD5", "MD2", "SHA-256", "SHA-384", or "SHA-512". The recommended hash algorithm is "SHA-1".
A private key is required to create a digital signature.
An error is indicated when a byte array of 0 length is returned. Returns null on failure
public string SignBytesENC(byte[] binaryData, string hashAlgorithm);
Creates an RSA digital signature by hashing binaryData and then signing the hash. The hash algorithm is specified by hashAlgorithm, which may be "SHA-1", "MD5", "MD2", "SHA-256", "SHA-384", or "SHA-512". The recommended hash algorithm is "SHA-1". The digital signature is returned as an encoded string, where the encoding is specified by the EncodingMode property.
A private key is required to create a digital signature.
An error is indicated when null reference is returned. Returns a null on failure
public byte[] SignString(string strToBeHashed, string hashAlgorithm);
Creates an RSA digital signature by hashing strToBeHashed and then signing the hash. The hash algorithm is specified by hashAlgorithm, which may be "SHA-1", "MD5", "MD2", "SHA-256", "SHA-384", or "SHA-512". The recommended hash algorithm is "SHA-1".
A private key is required to create a digital signature.
An error is indicated when a byte array of 0 length is returned. Returns null on failure
public string SignStringENC(string strToBeHashed, string hashAlgorithm);
Creates an RSA digital signature by hashing strToBeHashed and then signing the hash. The hash algorithm is specified by hashAlgorithm, which may be "SHA-1", "MD5", "MD2", "SHA-256", "SHA-384", or "SHA-512". The recommended hash algorithm is "SHA-1". The digital signature is returned as an encoded string, where the encoding is specified by the EncodingMode property.
A private key is required to create a digital signature.
An error is indicated when null reference is returned. Returns a null on failure
public string SnkToXml(string filename);
Imports a .snk file to an XML document that can be imported via the ImportPrivateKey method. Returns a null on failure
public bool UnlockComponent(string unlockCode);
Unlocks the component. This must be called once prior to calling any other method. Returns true for success, false for failure.
public bool VerifyBytes(byte[] originalData, string hashAlgorithm, byte[] signatureBytes);
Verifies an RSA digital signature. Returns true if the signature is valid for the originalData. The hashAlgorithm may be "SHA-1", "MD5", "MD2", "SHA-256", "SHA-384", or "SHA-512". The recommended hash algorithm is "SHA-1".
public bool VerifyBytesENC(byte[] originalData, string hashAlgorithm, string encodedSig);
Verifies an RSA digital signature. Returns true if the signature is valid for the originalData. The hashAlgorithm may be "SHA-1", "MD5", "MD2", "SHA-256", "SHA-384", or "SHA-512". The recommended hash algorithm is "SHA-1".
The encodedSig is a digital signature encoded according to the EncodingMode property (i.e. base64, hex, etc.).
public bool VerifyString(string originalString, string hashAlgorithm, byte[] binarySig);
Verifies an RSA digital signature. Returns true if the signature is valid for the originalString. The hashAlgorithm may be "SHA-1", "MD5", "MD2", "SHA-256", "SHA-384", or "SHA-512". The recommended hash algorithm is "SHA-1".
public bool VerifyStringENC(string originalString, string hashAlgorithm, string encodedSig);
Verifies an RSA digital signature. Returns true if the signature is valid for the originalString. The hashAlgorithm may be "SHA-1", "MD5", "MD2", "SHA-256", "SHA-384", or "SHA-512". The recommended hash algorithm is "SHA-1".
The encodedSig is a digital signature encoded according to the EncodingMode property (i.e. base64, hex, etc.).
|