ChilkatRsa ActiveX Reference
ChilkatRsa
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
(Visual Basic 6.0)
Dim obj As New ChilkatRsa
(ASP)
set obj = Server.CreateObject("Chilkat.Rsa")
(VBScript)
set obj = CreateObject("Chilkat.Rsa")
(Delphi)
obj := TChilkatRsa.Create(Self);
(FoxPro)
loObject = CreateObject('Chilkat.Rsa')
(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.Rsa', @obj OUT
(Javascript)
var obj = new ActiveXObject("Chilkat.Rsa");
Properties
Charset As String
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.
EncodingMode As String
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.
LastErrorHtml As String (read-only)
Error information in HTML format for the last method called.
LastErrorText As String (read-only)
Error information in plain-text format for the last method called.
LastErrorXml As String (read-only)
Error information in XML format for the last method called.
LittleEndian As Long
The default value is 1, 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 0. 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.
NumBits As Long (read-only)
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.
OaepPadding As Long
Controls whether Optimal Asymmetric Encryption Padding (OAEP) is used for the padding scheme (for encrypting/decrypting). If set to 0, PKCS1 v1.5 padding is used. If set to 1, PKCS1 v2.0 (OAEP) padding is used.
When creating digital signatures, this property controls whether RSA-PSS or PKCS1 v1.5 is used. If 1, then the RSA-PSS signature scheme is used.
Version As String (read-only)
Returns the version of the component as a string, such as "2.0.0".
Methods
DecryptBytes(inData As Variant, usePrivateKey As Long) As Variant
Decrypts byte data using the RSA encryption algorithm. usePrivateKey should be set to 1 if the private key is to be used for decrypting. Otherwise it should be set to 0 if the public key is to be used for decrypting.
Important: If trying to match OpenSSL results, set the LittleEndian property = 0. Returns a zero-length byte array (as a Variant) on failure
DecryptBytesENC(inStr As String, usePrivateKey As Long) As Variant
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.
Important: If trying to match OpenSSL results, set the LittleEndian property = 0. Returns a zero-length byte array (as a Variant) on failure
DecryptString(binarySig As Variant, usePrivateKey As Long) As String
Decrypts encrypted string data and returns an unencrypted string. usePrivateKey should be set to 1 if the private key is to be used for decrypting. Otherwise it should be set to 0 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.
Important: If trying to match OpenSSL results, set the LittleEndian property = 0. Returns a null on failure
DecryptStringENC(encodedSig As String, usePrivateKey As Long) As String
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.
Important: If trying to match OpenSSL results, set the LittleEndian property = 0. Returns a null on failure
EncryptBytes(binaryData As Variant, usePrivateKey As Long) As Variant
Encrypts byte data using the RSA encryption algorithm. usePrivateKey should be set to 1 if the private key is to be used for encrypting. Otherwise it should be set to 0 if the public key is to be used for encrypting.
Important: If trying to match OpenSSL results, set the LittleEndian property = 0. Returns a zero-length byte array (as a Variant) on failure
EncryptBytesENC(inData As Variant, usePrivateKey As Long) As String
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.
Important: If trying to match OpenSSL results, set the LittleEndian property = 0. Returns a null on failure
EncryptString(stringToSign As String, usePrivateKey As Long) As Variant
Encrypts a string using the RSA encryption algorithm. usePrivateKey should be set to 1 if the private key is to be used for encrypting. Otherwise it should be set to 0 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.
Important: If trying to match OpenSSL results, set the LittleEndian property = 0. Returns a zero-length byte array (as a Variant) on failure
EncryptStringENC(inStr As String, usePrivateKey As Long) As String
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.
Important: If trying to match OpenSSL results, set the LittleEndian property = 0. Returns a null on failure
ExportPrivateKey() As String
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
ExportPublicKey() As String
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
GenerateKey(numBits As Long) As Long
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 1 for success, 0 for failure.
ImportPrivateKey(xmlKey As String) As Long
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 1 for success, 0 for failure.
ImportPublicKey(xmlKey As String) As Long
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 1 for success, 0 for failure.
OpenSslSignBytes(data As Variant) As Variant
Duplicates OpenSSL's rsautl utility for creating RSA signatures. Input data consists of binary bytes, and returns the signature bytes. Returns a zero-length byte array (as a Variant) on failure (ASP) Duplicating OpenSSL rsautl (creating RSA signatures) (VB6) Duplicating OpenSSL rsautl (creating RSA signatures) (Delphi) Duplicating OpenSSL rsautl (creating RSA signatures) (FoxPro) Duplicating OpenSSL rsautl (creating RSA signatures) (VBScript) Duplicating OpenSSL rsautl (creating RSA signatures)
OpenSslSignBytesENC(data As Variant) As String
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
OpenSslSignString(str As String) As Variant
Duplicates OpenSSL's rsautl utility for creating RSA signatures. Input data is a string, and returns the signature bytes. Returns a zero-length byte array (as a Variant) on failure
OpenSslSignStringENC(str As String) As String
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 (ASP) Duplicating OpenSSL rsautl (creating RSA signatures) (VB6) Duplicating OpenSSL rsautl (creating RSA signatures) (Delphi) Duplicating OpenSSL rsautl (creating RSA signatures) (FoxPro) Duplicating OpenSSL rsautl (creating RSA signatures) (VBScript) Duplicating OpenSSL rsautl (creating RSA signatures)
OpenSslVerifyBytes(signature As Variant) As Variant
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 a zero-length byte array (as a Variant) on failure (ASP) Duplicating OpenSSL rsautl (creating RSA signatures) (VB6) Duplicating OpenSSL rsautl (creating RSA signatures) (Delphi) Duplicating OpenSSL rsautl (creating RSA signatures) (FoxPro) Duplicating OpenSSL rsautl (creating RSA signatures) (VBScript) Duplicating OpenSSL rsautl (creating RSA signatures)
OpenSslVerifyBytesENC(str As String) As Variant
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 a zero-length byte array (as a Variant) on failure
OpenSslVerifyString(data As Variant) As String
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
OpenSslVerifyStringENC(str As String) As String
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 (ASP) Duplicating OpenSSL rsautl (creating RSA signatures) (VB6) Duplicating OpenSSL rsautl (creating RSA signatures) (Delphi) Duplicating OpenSSL rsautl (creating RSA signatures) (FoxPro) Duplicating OpenSSL rsautl (creating RSA signatures) (VBScript) Duplicating OpenSSL rsautl (creating RSA signatures)
SaveLastError(logFilename As String) As Long
Saves the last error information to an XML formatted file.
SignBytes(binaryData As Variant, hashAlgorithm As String) As Variant
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".
Important: If trying to match OpenSSL results, set the LittleEndian property = 0.
A private key is required to create a digital signature.
An error is indicated when a byte array of 0 length is returned. Returns a zero-length byte array (as a Variant) on failure
SignBytesENC(binaryData As Variant, hashAlgorithm As String) As String
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.
Important: If trying to match OpenSSL results, set the LittleEndian property = 0.
A private key is required to create a digital signature.
An error is indicated when null reference is returned. Returns a null on failure
SignString(strToBeHashed As String, hashAlgorithm As String) As Variant
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".
Important: If trying to match OpenSSL results, set the LittleEndian property = 0.
A private key is required to create a digital signature.
An error is indicated when a byte array of 0 length is returned. Returns a zero-length byte array (as a Variant) on failure
SignStringENC(strToBeHashed As String, hashAlgorithm As String) As String
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.
Important: If trying to match OpenSSL results, set the LittleEndian property = 0.
A private key is required to create a digital signature.
An error is indicated when null reference is returned. Returns a null on failure
SnkToXml(filename As String) As String
Imports a .snk file to an XML document that can be imported via the ImportPrivateKey method. Returns a null on failure
UnlockComponent(unlockCode As String) As Long
Unlocks the component. This must be called once prior to calling any other method. Returns 1 for success, 0 for failure.
VerifyBytes(originalData As Variant, hashAlgorithm As String, signatureBytes As Variant) As Long
Verifies an RSA digital signature. Returns 1 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".
VerifyBytesENC(originalData As Variant, hashAlgorithm As String, encodedSig As String) As Long
Verifies an RSA digital signature. Returns 1 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.).
VerifyPrivateKey(xml As String) As Long
To be documented soon. Returns 1 for success, 0 for failure.
VerifyString(originalString As String, hashAlgorithm As String, binarySig As Variant) As Long
Verifies an RSA digital signature. Returns 1 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".
VerifyStringENC(originalString As String, hashAlgorithm As String, encodedSig As String) As Long
Verifies an RSA digital signature. Returns 1 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.).
|