CkRsa C++ Class Reference (Visual C++)
CkRsa
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.
Properties
void get_Charset(CkString &out);
void put_Charset(const char *str);
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.
void get_EncodingMode(CkString &out);
void put_EncodingMode(const char *str);
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.
void LastErrorHtml(CkString &str);
Error information in HTML format for the last method called.
void LastErrorText(CkString &str);
Error information in plain-text format for the last method called.
void LastErrorXml(CkString &str);
Error information in XML format for the last method called.
bool get_LittleEndian(void);
void put_LittleEndian(bool newVal);
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.
long get_NumBits(void);
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.
bool get_OaepPadding(void);
void put_OaepPadding(bool newVal);
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.
bool get_Utf8(void) const;
void put_Utf8(bool b);
When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.
void get_Version(CkString &str);
Returns the version of the component as a string, such as "2.0.0".
Methods
bool DecryptBytes(const CkByteData & inData, bool usePrivateKey, CkByteData & out);
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.
Important: If trying to match OpenSSL results, set the LittleEndian property = false.
bool DecryptBytesENC(const char * str, bool bUsePrivateKey, CkByteData & out);
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 = false.
bool DecryptString(const CkByteData & binarySig, bool usePrivateKey, CkString & out);
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.
Important: If trying to match OpenSSL results, set the LittleEndian property = false. Returns true for success, false for failure.
bool DecryptStringENC(const char * encodedSig, bool usePrivateKey, CkString & out);
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 = false. Returns true for success, false for failure.
bool EncryptBytes(const CkByteData & binaryData, bool usePrivateKey, CkByteData & out);
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.
Important: If trying to match OpenSSL results, set the LittleEndian property = false.
bool EncryptBytesENC(const CkByteData & bData, bool bUsePrivateKey, CkString & out);
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 = false. Returns true for success, false for failure.
bool EncryptString(const char * stringToSign, bool usePrivateKey, CkByteData & out);
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.
Important: If trying to match OpenSSL results, set the LittleEndian property = false.
bool EncryptStringENC(const char * str, bool bUsePrivateKey, CkString & out);
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 = false. Returns true for success, false for failure.
bool ExportPrivateKey(CkString & strXml);
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 true for success, false for failure.
bool ExportPublicKey(CkString & strXml);
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 true for success, false for failure.
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.
bool ImportPrivateKey(const char * 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.
bool ImportPublicKey(const char * 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.
bool OpenSslSignBytes(CkByteData & data, CkByteData & outBytes);
Duplicates OpenSSL's rsautl utility for creating RSA signatures. Input data consists of binary bytes, and returns the signature bytes. Duplicating OpenSSL rsautl (creating RSA signatures)
bool OpenSslSignBytesENC(CkByteData & data, CkString & outStr);
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 true for success, false for failure.
bool OpenSslSignString(const char * str, CkByteData & outBytes);
Duplicates OpenSSL's rsautl utility for creating RSA signatures. Input data is a string, and returns the signature bytes.
bool OpenSslSignStringENC(const char * str, CkString & outStr);
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 true for success, false for failure. Duplicating OpenSSL rsautl (creating RSA signatures)
bool OpenSslVerifyBytes(CkByteData & signature, CkByteData & outBytes);
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. Duplicating OpenSSL rsautl (creating RSA signatures)
bool OpenSslVerifyBytesENC(const char * str, CkByteData & outBytes);
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.
bool OpenSslVerifyString(CkByteData & data, CkString & outStr);
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 true for success, false for failure.
bool OpenSslVerifyStringENC(const char * str, CkString & outStr);
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 true for success, false for failure. Duplicating OpenSSL rsautl (creating RSA signatures)
bool SaveLastError(const char * filename);
Saves the last error information to an XML formatted file.
bool SignBytes(const CkByteData & binaryData, const char * hashAlgorithm, CkByteData & out);
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 = false.
A private key is required to create a digital signature.
An error is indicated when a byte array of 0 length is returned.
bool SignBytesENC(const CkByteData & binaryData, const char * hashAlgorithm, CkString & out);
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 = false.
A private key is required to create a digital signature.
An error is indicated when null reference is returned. Returns true for success, false for failure.
bool SignString(const char * strToBeHashed, const char * hashAlgorithm, CkByteData & out);
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 = false.
A private key is required to create a digital signature.
An error is indicated when a byte array of 0 length is returned.
bool SignStringENC(const char * strToBeHashed, const char * hashAlgorithm, CkString & out);
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 = false.
A private key is required to create a digital signature.
An error is indicated when null reference is returned. Returns true for success, false for failure.
bool SnkToXml(const char * filename, CkString & strXml);
Imports a .snk file to an XML document that can be imported via the ImportPrivateKey method. Returns true for success, false for failure.
bool UnlockComponent(const char * unlockCode);
Unlocks the component. This must be called once prior to calling any other method. Returns true for success, false for failure.
bool VerifyBytes(const CkByteData & originalData, const char * hashAlgorithm, const CkByteData & 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".
bool VerifyBytesENC(const CkByteData & originalData, const char * hashAlgorithm, const char * 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.).
bool VerifyPrivateKey(const char * xml);
To be documented soon. Returns true for success, false for failure.
bool VerifyString(const char * originalString, const char * hashAlgorithm, const CkByteData & 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".
bool VerifyStringENC(const char * originalString, const char * hashAlgorithm, const char * 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.).
const char * charset();
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.
const char * decryptString(const char * binarySig, int usePrivateKey, bool bUsePrivateKey);
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.
Important: If trying to match OpenSSL results, set the LittleEndian property = false.
const char * decryptStringENC(const char * 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.
Important: If trying to match OpenSSL results, set the LittleEndian property = false.
const char * encodingMode();
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.
const char * encryptBytesENC(const char * bytes, int numBytes, 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.
Important: If trying to match OpenSSL results, set the LittleEndian property = false.
const char * encryptStringENC(const char * 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.
Important: If trying to match OpenSSL results, set the LittleEndian property = false.
const char * 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.
const char * 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.
const char * lastErrorHtml();
Error information in HTML format for the last method called.The "const char *" returned by this method will be overwritten or become invalid when other methods returning "const char *" are called. The calling application should copy the returned string to a safe place immediately.
const char * lastErrorText();
Error information in plain-text format for the last method called.The "const char *" returned by this method will be overwritten or become invalid when other methods returning "const char *" are called. The calling application should copy the returned string to a safe place immediately.
const char * lastErrorXml();
Error information in XML format for the last method called.The "const char *" returned by this method will be overwritten or become invalid when other methods returning "const char *" are called. The calling application should copy the returned string to a safe place immediately.
const char * openSslSignBytesENC(CkByteData & data);
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.).
const char * openSslSignStringENC(const char * str);
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.). Duplicating OpenSSL rsautl (creating RSA signatures)
const char * openSslVerifyString(CkByteData & data);
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.
const char * openSslVerifyStringENC(const char * str);
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. Duplicating OpenSSL rsautl (creating RSA signatures)
const char * signBytesENC(const CkByteData & binaryData, const char * 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.
Important: If trying to match OpenSSL results, set the LittleEndian property = false.
A private key is required to create a digital signature.
An error is indicated when null reference is returned.
const char * signStringENC(const char * strToBeHashed, const char * 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.
Important: If trying to match OpenSSL results, set the LittleEndian property = false.
A private key is required to create a digital signature.
An error is indicated when null reference is returned.
const char * snkToXml(const char * filename);
Imports a .snk file to an XML document that can be imported via the ImportPrivateKey method. Returns true for success, false for failure.
const char * version();
Returns the version of the component as a string, such as "2.0.0".
|