Rsa C Reference Documentation

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.

Create/Dispose

HCkRsa CkRsa_Create(void);

Creates an instance of the HCkRsa object and returns a handle (i.e. a "void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkRsa_Dispose(HCkRsa handle);

Objects created by calling CkRsa_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkRsa_Dispose.

Properties

void CkRsa_getCharset(HCkRsa cHandle, HCkString retval);

void CkRsa_putCharset(HCkRsa cHandle, const char *newVal);

const char *CkRsa_charset(HCkRsa cHandle);

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.

Charset Considerations when RSA Encrypting Strings

void CkRsa_getDebugLogFilePath(HCkRsa cHandle, HCkString retval);

void CkRsa_putDebugLogFilePath(HCkRsa cHandle, const char *newVal);

const char *CkRsa_debugLogFilePath(HCkRsa cHandle);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

void CkRsa_getEncodingMode(HCkRsa cHandle, HCkString retval);

void CkRsa_putEncodingMode(HCkRsa cHandle, const char *newVal);

const char *CkRsa_encodingMode(HCkRsa cHandle);

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.

Base64url Encoding

void CkRsa_getLastErrorHtml(HCkRsa cHandle, HCkString retval);

const char *CkRsa_lastErrorHtml(HCkRsa cHandle);

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

void CkRsa_getLastErrorText(HCkRsa cHandle, HCkString retval);

const char *CkRsa_lastErrorText(HCkRsa cHandle);

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

void CkRsa_getLastErrorXml(HCkRsa cHandle, HCkString retval);

const char *CkRsa_lastErrorXml(HCkRsa cHandle);

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

BOOL CkRsa_getLastMethodSuccess(HCkRsa cHandle);

void CkRsa_putLastMethodSuccess(HCkRsa cHandle, BOOL newVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

BOOL CkRsa_getLittleEndian(HCkRsa cHandle);

void CkRsa_putLittleEndian(HCkRsa cHandle, BOOL newVal);

The default value is FALSE, which means that signatures and encrypted output will be created using the big endian byte ordering. A value of TRUE will produce little-endian output, which is what Microsoft's Crypto API produces.

Important: Prior to v9.5.0.49, this property behaved the opposite as it should for encryption. When updating from an older version of Chilkat to v9.5.0.49 or greater, the following change is required:

  • If the application did NOT explicity set the LittleEndian property, then no change is required for encryption/decryption. If signatures were being created or verified, then explicitly set this property to TRUE.
  • If the application explicitly set this property, then reverse the setting ONLY if doing encryption/decryption. No changes are required if doing signature creation/verification.

BOOL CkRsa_getNoUnpad(HCkRsa cHandle);

void CkRsa_putNoUnpad(HCkRsa cHandle, BOOL newVal);

If TRUE, skips unpadding when decrypting. The default is FALSE. This property value is typically left unchanged.

int CkRsa_getNumBits(HCkRsa cHandle);

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.

void CkRsa_getOaepHash(HCkRsa cHandle, HCkString retval);

void CkRsa_putOaepHash(HCkRsa cHandle, const char *newVal);

const char *CkRsa_oaepHash(HCkRsa cHandle);

Introduced in version 9.5.0.48

Selects the hash algorithm for use within OAEP padding. The valid choices are "sha1", "sha256", "sha384", "sha512", "md2", "md5", "haval", "ripemd128", "ripemd160","ripemd256", or "ripemd320". The default is "sha1".

void CkRsa_getOaepMgfHash(HCkRsa cHandle, HCkString retval);

void CkRsa_putOaepMgfHash(HCkRsa cHandle, const char *newVal);

const char *CkRsa_oaepMgfHash(HCkRsa cHandle);

Introduced in version 9.5.0.71

Selects the MGF (mask generation) hash algorithm for use within OAEP padding. The valid choices are "sha1", "sha256", "sha384", "sha512", "md2", "md5", "haval", "ripemd128", "ripemd160","ripemd256", or "ripemd320". The default is "sha1".

BOOL CkRsa_getOaepPadding(HCkRsa cHandle);

void CkRsa_putOaepPadding(HCkRsa cHandle, 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.

Important: The OAEP padding algorithm uses randomly generated bytes. Therefore, the RSA result will be different each time, even if all of the other inputs are identical. For example, if you RSA encrypt or sign the same data using the same key 100 times, the output will appear different each time, but they are all valid.

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. The default value of this property is FALSE.

RSA OAEP Padding

BOOL CkRsa_getUtf8(HCkRsa cHandle);

void CkRsa_putUtf8(HCkRsa cHandle, BOOL newVal);

When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.

BOOL CkRsa_getVerboseLogging(HCkRsa cHandle);

void CkRsa_putVerboseLogging(HCkRsa cHandle, BOOL newVal);

If set to TRUE, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is FALSE. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

void CkRsa_getVersion(HCkRsa cHandle, HCkString retval);

const char *CkRsa_version(HCkRsa cHandle);

Version of the component/library, such as "9.5.0.63"

Methods

BOOL CkRsa_DecryptBytes(HCkRsa cHandle, HCkByteData inData, BOOL usePrivateKey, HCkByteData outData);

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.

Returns TRUE for success, FALSE for failure.

BOOL CkRsa_DecryptBytesENC(HCkRsa cHandle, const char *str, BOOL bUsePrivateKey, HCkByteData outData);

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.

Returns TRUE for success, FALSE for failure.

BOOL CkRsa_DecryptString(HCkRsa cHandle, HCkByteData binarySig, BOOL usePrivateKey, HCkString outStr);

const char *CkRsa_decryptString(HCkRsa cHandle, HCkByteData 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.

Important: If trying to match OpenSSL results, set the LittleEndian property = FALSE.

Returns TRUE for success, FALSE for failure.

BOOL CkRsa_DecryptStringENC(HCkRsa cHandle, const char *encodedSig, BOOL usePrivateKey, HCkString outStr);

const char *CkRsa_decryptStringENC(HCkRsa cHandle, 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.

Returns TRUE for success, FALSE for failure.

RSA Encrypt and Decrypt Strings

RSA Encryption -- Same Key Different Results

RSA Encrypting Symmetric Secret Key

RSA Encrypt/Decrypt AES Key

BOOL CkRsa_EncryptBytes(HCkRsa cHandle, HCkByteData binaryData, BOOL usePrivateKey, HCkByteData outData);

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.

Returns TRUE for success, FALSE for failure.

BOOL CkRsa_EncryptBytesENC(HCkRsa cHandle, HCkByteData data, BOOL bUsePrivateKey, HCkString outStr);

const char *CkRsa_encryptBytesENC(HCkRsa cHandle, HCkByteData 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.

Important: If trying to match OpenSSL results, set the LittleEndian property = FALSE.

Returns TRUE for success, FALSE for failure.

RSA Encrypt with SHA-256 hash function and SHA-1 mask function

BOOL CkRsa_EncryptString(HCkRsa cHandle, const char *stringToEncrypt, BOOL usePrivateKey, HCkByteData outData);

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.

Returns TRUE for success, FALSE for failure.

Encrypt with Chilkat, Decrypt with OpenSSL

BOOL CkRsa_EncryptStringENC(HCkRsa cHandle, const char *str, BOOL bUsePrivateKey, HCkString outStr);

const char *CkRsa_encryptStringENC(HCkRsa cHandle, 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.

Returns TRUE for success, FALSE for failure.

RSA Encrypt and Decrypt Strings

RSA Encryption -- Same Key Different Results

RSA Encrypting Symmetric Secret Key

RSA Encrypt/Decrypt AES Key

BOOL CkRsa_ExportPrivateKey(HCkRsa cHandle, HCkString outStr);

const char *CkRsa_exportPrivateKey(HCkRsa cHandle);

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.

HCkPrivateKey CkRsa_ExportPrivateKeyObj(HCkRsa cHandle);

Introduced in version 9.5.0.40

Exports the private-key to a private key object. This is typically called after generating a new RSA key via the GenerateKey method. Once the private key object is obtained, it may be saved in a variety of different formats.

Returns NULL on failure

Generate RSA Key and Export to PKCS1 / PKCS8

BOOL CkRsa_ExportPublicKey(HCkRsa cHandle, HCkString outStr);

const char *CkRsa_exportPublicKey(HCkRsa cHandle);

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.

HCkPublicKey CkRsa_ExportPublicKeyObj(HCkRsa cHandle);

Introduced in version 9.5.0.40

Exports the public key to a public key object. Once the public key object is obtained, it may be saved in a variety of different formats.

Returns NULL on failure

Generate RSA Key and Export to PKCS1 / PKCS8

BOOL CkRsa_GenerateKey(HCkRsa cHandle, int numBits);

Generates a new RSA public/private key pair. The number of bits can range from 512 to 8192. Typical key lengths are 1024, 2048, or 4096 bits. After successful generation, the public/private parts of the key can be exported to XML via the ExportPrivateKey and ExportPublicKey methods.

Note: Prior to version 9.5.0.49, the max key size was 4096 bits. Generating an 8192-bit RSA key takes a considerable amount of time and CPU processing power. There are no event callbacks or progress monitoring for RSA key generation. Calling this will block the thread until it returns.

Returns TRUE for success, FALSE for failure.

Generate RSA Public/Private Key

BOOL CkRsa_ImportPrivateKey(HCkRsa cHandle, 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 using base64 representation:

<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.

RSA Signature with Certificate's Private Key from PFX

Load PEM Public/Private Key into RSA Object

BOOL CkRsa_ImportPrivateKeyObj(HCkRsa cHandle, HCkPrivateKey key);

Introduced in version 9.5.0.40

Imports a private key from a private key object. The imported private key is used in methods that sign or decrypt.

Returns TRUE for success, FALSE for failure.

RSA Sign Using Private Key from .pfx/.p12 to Base64 Signature

BOOL CkRsa_ImportPublicKey(HCkRsa cHandle, 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 using base64 representation:

<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.

RSA Encrypt with Modulus and Exponent

RSA Signature/Verify with .key and .cer

Load PEM Public/Private Key into RSA Object

BOOL CkRsa_ImportPublicKeyObj(HCkRsa cHandle, HCkPublicKey key);

Introduced in version 9.5.0.40

Imports a public key from a public key object. The imported public key is used in methods that encrypt data or verify signatures.

Returns TRUE for success, FALSE for failure.

Encrypt with Chilkat, Decrypt with OpenSSL

BOOL CkRsa_OpenSslSignBytes(HCkRsa cHandle, HCkByteData data, HCkByteData outBytes);

Duplicates OpenSSL's rsautl utility for creating RSA signatures. Input data consists of binary bytes, and returns the signature bytes.

Returns TRUE for success, FALSE for failure.

Duplicating OpenSSL rsautl (creating RSA signatures)

BOOL CkRsa_OpenSslSignBytesENC(HCkRsa cHandle, HCkByteData data, HCkString outStr);

const char *CkRsa_openSslSignBytesENC(HCkRsa cHandle, HCkByteData 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.).

Returns TRUE for success, FALSE for failure.

BOOL CkRsa_OpenSslSignString(HCkRsa cHandle, const char *str, HCkByteData outBytes);

Duplicates OpenSSL's rsautl utility for creating RSA signatures. Input data is a string, and returns the signature bytes.

Returns TRUE for success, FALSE for failure.

BOOL CkRsa_OpenSslSignStringENC(HCkRsa cHandle, const char *str, HCkString outStr);

const char *CkRsa_openSslSignStringENC(HCkRsa cHandle, 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.).

Returns TRUE for success, FALSE for failure.

Duplicating OpenSSL rsautl (creating RSA signatures)

BOOL CkRsa_OpenSslVerifyBytes(HCkRsa cHandle, HCkByteData signature, HCkByteData 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.

Returns TRUE for success, FALSE for failure.

Duplicating OpenSSL rsautl (creating RSA signatures)

BOOL CkRsa_OpenSslVerifyBytesENC(HCkRsa cHandle, const char *str, HCkByteData 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.

Returns TRUE for success, FALSE for failure.

BOOL CkRsa_OpenSslVerifyString(HCkRsa cHandle, HCkByteData data, HCkString outStr);

const char *CkRsa_openSslVerifyString(HCkRsa cHandle, HCkByteData 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.

Returns TRUE for success, FALSE for failure.

BOOL CkRsa_OpenSslVerifyStringENC(HCkRsa cHandle, const char *str, HCkString outStr);

const char *CkRsa_openSslVerifyStringENC(HCkRsa cHandle, 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.

Returns TRUE for success, FALSE for failure.

Duplicating OpenSSL rsautl (creating RSA signatures)

BOOL CkRsa_SaveLastError(HCkRsa cHandle, const char *path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns TRUE for success, FALSE for failure.

BOOL CkRsa_SignBytes(HCkRsa cHandle, HCkByteData binaryData, const char *hashAlgorithm, HCkByteData outData);

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. (The LittleEndian property should also be set to FALSE to match Amazon web services, such as CloudFront.)

A private key is required to create a digital signature.

An error is indicated when a byte array of 0 length is returned.

Returns TRUE for success, FALSE for failure.

BOOL CkRsa_SignBytesENC(HCkRsa cHandle, HCkByteData binaryData, const char *hashAlgorithm, HCkString outStr);

const char *CkRsa_signBytesENC(HCkRsa cHandle, HCkByteData 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. (The LittleEndian property should also be set to FALSE to match Amazon web services, such as CloudFront.)

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 CkRsa_SignHash(HCkRsa cHandle, HCkByteData hashBytes, const char *hashAlg, HCkByteData outBytes);

The same as the SignBytes method, except the hash to be signed is passed directly.

Returns TRUE for success, FALSE for failure.

BOOL CkRsa_SignHashENC(HCkRsa cHandle, const char *encodedHash, const char *hashAlg, HCkString outStr);

const char *CkRsa_signHashENC(HCkRsa cHandle, const char *encodedHash, const char *hashAlg);

The same as SignBytesENC except the hash is passed directly.

Returns TRUE for success, FALSE for failure.

BOOL CkRsa_SignString(HCkRsa cHandle, const char *strToBeHashed, const char *hashAlgorithm, HCkByteData outData);

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. (The LittleEndian property should also be set to FALSE to match Amazon web services, such as CloudFront.)

A private key is required to create a digital signature.

An error is indicated when a byte array of 0 length is returned.

Returns TRUE for success, FALSE for failure.

RSA SHA256 Signature using Private Key from Java Keystore

BOOL CkRsa_SignStringENC(HCkRsa cHandle, const char *strToBeHashed, const char *hashAlgorithm, HCkString outStr);

const char *CkRsa_signStringENC(HCkRsa cHandle, 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. (The LittleEndian property should also be set to FALSE to match Amazon web services, such as CloudFront.)

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.

Example Code: Create RSA Signature with PEM Private Key

Duplicate openssl dgst -md5 -sign myKey.pem something.txt | openssl enc -base64 -A

RSA Sign Using Private Key from .pfx/.p12 to Base64 Signature

Walmart Partner API Authentication (Generate a Signature for a Request)

BOOL CkRsa_SnkToXml(HCkRsa cHandle, const char *filename, HCkString outStr);

const char *CkRsa_snkToXml(HCkRsa cHandle, 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.

BOOL CkRsa_UnlockComponent(HCkRsa cHandle, const char *unlockCode);

Unlocks the component. This must be called once prior to calling any other method.

Returns TRUE for success, FALSE for failure.

Diagnosing UnlockComponent Problems

UnlockComponent LastErrorText shows exact string passed to it.

Verify UnlockComponent Success w/ Purchased Unlock Code

LastErrorText Standard Information

BOOL CkRsa_VerifyBytes(HCkRsa cHandle, HCkByteData originalData, const char *hashAlgorithm, HCkByteData 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 CkRsa_VerifyBytesENC(HCkRsa cHandle, HCkByteData 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 CkRsa_VerifyHash(HCkRsa cHandle, HCkByteData hashBytes, const char *hashAlg, HCkByteData sigBytes);

The same as VerifyBytes except the hash of the original data is passed directly.

BOOL CkRsa_VerifyHashENC(HCkRsa cHandle, const char *encodedHash, const char *hashAlg, const char *encodedSig);

The same as VerifyBytesENC except the hash of the original data is passed directly.

BOOL CkRsa_VerifyPrivateKey(HCkRsa cHandle, const char *xml);

Returns TRUE if the XML contains a valid RSA private key. Otherwise returns FALSE.

Returns TRUE for success, FALSE for failure.

BOOL CkRsa_VerifyString(HCkRsa cHandle, const char *originalString, const char *hashAlgorithm, HCkByteData 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 CkRsa_VerifyStringENC(HCkRsa cHandle, 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.).