RSA Class

Properties   Methods   Events   Config Settings   Errors  

Implements RSA public-key cryptography to encrypt/decrypt and sign/verify messages.

Syntax

RSA

Remarks

The RSA class implements RSA public-key cryptography to encrypt/decrypt messages and sign/verify hash signatures.

To begin you must either specify an existing key or create a new key. Existing private keys may be specified by setting the Key* properties. To create a new key call CreateKey. Alternatively an existing certificate may be specified by setting the Certificate* properties

Signing

To sign data first set Key or Certificate. Specify the input data using InputFile or InputMessage. Next call Sign. The class will populate HashValue and HashSignature. After calling Sign the public key must be sent to the recipient along with HashSignature.

Encrypting

To encrypt data set RecipientKey or RecipientCert. Specify the input data using InputFile or InputMessage. Next call Encrypt. The class will populate OutputMessage, or write to the file specified by OutputFile.

Signature Verification

To verify a signature specify the input data using InputFile or InputMessage. Set SignerKey or SignerCert. Next set HashSignature and call VerifySignature. The VerifySignature method will return True if the signature was successfully verified.

Decrypting

To decrypt data first set Key or Certificate. Specify the input data using InputFile or InputMessage. Next call Decrypt. The class will populate OutputMessage, or write to the file specified by OutputFile.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

RSA Keys

A RSA key is made up of a number of individual parameters.

The public key consists of the following parameters:

• KeyModulus
• KeyExponent

The class also includes the KeyPublicKey property which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both sides of the encryption/signing and decryption/signature verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in KeyPublicKey in which case the individual parameters must be sent.

The private key may be represented in one of two ways. Both are mathematically equivalent. Private key format 1:

• KeyModulus
• KeyP
• KeyQ
• KeyDP
• KeyDQ

• KeyModulus
• KeyD

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

CertEncoded Property (RSA Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertEncoded(char* &lpCertEncoded, int &lenCertEncoded);
int SetCertEncoded(const char* lpCertEncoded, int lenCertEncoded);

Unicode (Windows)
INT GetCertEncoded(LPSTR &lpCertEncoded, INT &lenCertEncoded);
INT SetCertEncoded(LPCSTR lpCertEncoded, INT lenCertEncoded);

int ipworksencrypt_rsa_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworksencrypt_rsa_setcertencoded(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);

QByteArray GetCertEncoded();
int SetCertEncoded(QByteArray qbaCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.

When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

CertStore Property (RSA Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertStore(char* &lpCertStore, int &lenCertStore);
int SetCertStore(const char* lpCertStore, int lenCertStore);

Unicode (Windows)
INT GetCertStore(LPSTR &lpCertStore, INT &lenCertStore);
INT SetCertStore(LPCSTR lpCertStore, INT lenCertStore);

int ipworksencrypt_rsa_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworksencrypt_rsa_setcertstore(void* lpObj, const char* lpCertStore, int lenCertStore);

QByteArray GetCertStore();
int SetCertStore(QByteArray qbaCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.

CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

CertStorePassword Property (RSA Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertStorePassword();
int SetCertStorePassword(const char* lpszCertStorePassword);

Unicode (Windows)
LPWSTR GetCertStorePassword();
INT SetCertStorePassword(LPCWSTR lpszCertStorePassword);

char* ipworksencrypt_rsa_getcertstorepassword(void* lpObj);
int ipworksencrypt_rsa_setcertstorepassword(void* lpObj, const char* lpszCertStorePassword);

QString GetCertStorePassword();
int SetCertStorePassword(QString qsCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

CertStoreType Property (RSA Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);

Unicode (Windows)
INT GetCertStoreType();
INT SetCertStoreType(INT iCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksencrypt_rsa_getcertstoretype(void* lpObj);
int ipworksencrypt_rsa_setcertstoretype(void* lpObj, int iCertStoreType);

int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

CertSubject Property (RSA Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertSubject();
int SetCertSubject(const char* lpszCertSubject);

Unicode (Windows)
LPWSTR GetCertSubject();
INT SetCertSubject(LPCWSTR lpszCertSubject);

char* ipworksencrypt_rsa_getcertsubject(void* lpObj);
int ipworksencrypt_rsa_setcertsubject(void* lpObj, const char* lpszCertSubject);

QString GetCertSubject();
int SetCertSubject(QString qsCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

Data Type

String

HashAlgorithm Property (RSA Class)

The hash algorithm used for signing and signature verification.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHashAlgorithm();
int SetHashAlgorithm(int iHashAlgorithm);

Unicode (Windows)
INT GetHashAlgorithm();
INT SetHashAlgorithm(INT iHashAlgorithm);

RHA_SHA1(0), 
RHA_SHA224(1), 
RHA_SHA256(2), 
RHA_SHA384(3), 
RHA_SHA512(4), 
RHA_RIPEMD160(5), 
RHA_MD2(6), 
RHA_MD5(7), 
RHA_MD5SHA1(8)

int ipworksencrypt_rsa_gethashalgorithm(void* lpObj);
int ipworksencrypt_rsa_sethashalgorithm(void* lpObj, int iHashAlgorithm);

int GetHashAlgorithm();
int SetHashAlgorithm(int iHashAlgorithm);

Default Value

2

Remarks

This property specifies the hash algorithm used for signing and signature verification. Possible values are:

Data Type

Integer

HashSignature Property (RSA Class)

The hash signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHashSignature(char* &lpHashSignature, int &lenHashSignature);
int SetHashSignature(const char* lpHashSignature, int lenHashSignature);

Unicode (Windows)
INT GetHashSignature(LPSTR &lpHashSignature, INT &lenHashSignature);
INT SetHashSignature(LPCSTR lpHashSignature, INT lenHashSignature);

int ipworksencrypt_rsa_gethashsignature(void* lpObj, char** lpHashSignature, int* lenHashSignature);
int ipworksencrypt_rsa_sethashsignature(void* lpObj, const char* lpHashSignature, int lenHashSignature);

QByteArray GetHashSignature();
int SetHashSignature(QByteArray qbaHashSignature);

Default Value

""

Remarks

This property holds the computed hash signature. This is populated after calling Sign. This must be set before calling VerifySignature.

Data Type

Binary String

HashValue Property (RSA Class)

The hash value of the data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHashValue(char* &lpHashValue, int &lenHashValue);
int SetHashValue(const char* lpHashValue, int lenHashValue);

Unicode (Windows)
INT GetHashValue(LPSTR &lpHashValue, INT &lenHashValue);
INT SetHashValue(LPCSTR lpHashValue, INT lenHashValue);

int ipworksencrypt_rsa_gethashvalue(void* lpObj, char** lpHashValue, int* lenHashValue);
int ipworksencrypt_rsa_sethashvalue(void* lpObj, const char* lpHashValue, int lenHashValue);

QByteArray GetHashValue();
int SetHashValue(QByteArray qbaHashValue);

Default Value

""

Remarks

This property holds the computed hash value for the specified data. This is populated when calling Sign or VerifySignature when an input file is specified by setting InputFile or InputMessage.

If you know the hash value prior to using the class you may specify the pre-computed hash value here.

Hash Notes

The class will determine whether or not to recompute the hash based on the properties that are set. If a file is specified by InputFile or InputMessage the hash will be recomputed when calling Sign or VerifySignature. If the HashValue property is set the class will only sign the hash or verify the hash signature. Setting InputFile or InputMessage clears the HashValue property. Setting the HashValue property clears the input file selection.

Data Type

Binary String

InputFile Property (RSA Class)

The file to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* ipworksencrypt_rsa_getinputfile(void* lpObj);
int ipworksencrypt_rsa_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Data Type

String

InputMessage Property (RSA Class)

The message to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputMessage(char* &lpInputMessage, int &lenInputMessage);
int SetInputMessage(const char* lpInputMessage, int lenInputMessage);

Unicode (Windows)
INT GetInputMessage(LPSTR &lpInputMessage, INT &lenInputMessage);
INT SetInputMessage(LPCSTR lpInputMessage, INT lenInputMessage);

int ipworksencrypt_rsa_getinputmessage(void* lpObj, char** lpInputMessage, int* lenInputMessage);
int ipworksencrypt_rsa_setinputmessage(void* lpObj, const char* lpInputMessage, int lenInputMessage);

QByteArray GetInputMessage();
int SetInputMessage(QByteArray qbaInputMessage);

Default Value

""

Remarks

This property specifies the message to be processed.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Data Type

Binary String

KeyD Property (RSA Class)

Represents the D parameter for the RSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyD(char* &lpKeyD, int &lenKeyD);
int SetKeyD(const char* lpKeyD, int lenKeyD);

Unicode (Windows)
INT GetKeyD(LPSTR &lpKeyD, INT &lenKeyD);
INT SetKeyD(LPCSTR lpKeyD, INT lenKeyD);

int ipworksencrypt_rsa_getkeyd(void* lpObj, char** lpKeyD, int* lenKeyD);
int ipworksencrypt_rsa_setkeyd(void* lpObj, const char* lpKeyD, int lenKeyD);

QByteArray GetKeyD();
int SetKeyD(QByteArray qbaKeyD);

Default Value

""

Remarks

Represents the D parameter for the RSA algorithm.

Data Type

Binary String

KeyDP Property (RSA Class)

Represents the DP parameter for the RSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyDP(char* &lpKeyDP, int &lenKeyDP);
int SetKeyDP(const char* lpKeyDP, int lenKeyDP);

Unicode (Windows)
INT GetKeyDP(LPSTR &lpKeyDP, INT &lenKeyDP);
INT SetKeyDP(LPCSTR lpKeyDP, INT lenKeyDP);

int ipworksencrypt_rsa_getkeydp(void* lpObj, char** lpKeyDP, int* lenKeyDP);
int ipworksencrypt_rsa_setkeydp(void* lpObj, const char* lpKeyDP, int lenKeyDP);

QByteArray GetKeyDP();
int SetKeyDP(QByteArray qbaKeyDP);

Default Value

""

Remarks

Represents the DP parameter for the RSA algorithm.

Data Type

Binary String

KeyDQ Property (RSA Class)

Represents the DQ parameter for the RSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyDQ(char* &lpKeyDQ, int &lenKeyDQ);
int SetKeyDQ(const char* lpKeyDQ, int lenKeyDQ);

Unicode (Windows)
INT GetKeyDQ(LPSTR &lpKeyDQ, INT &lenKeyDQ);
INT SetKeyDQ(LPCSTR lpKeyDQ, INT lenKeyDQ);

int ipworksencrypt_rsa_getkeydq(void* lpObj, char** lpKeyDQ, int* lenKeyDQ);
int ipworksencrypt_rsa_setkeydq(void* lpObj, const char* lpKeyDQ, int lenKeyDQ);

QByteArray GetKeyDQ();
int SetKeyDQ(QByteArray qbaKeyDQ);

Default Value

""

Remarks

Represents the DQ parameter for the RSA algorithm.

Data Type

Binary String

KeyExponent Property (RSA Class)

Represents the Exponent parameter for the RSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyExponent(char* &lpKeyExponent, int &lenKeyExponent);
int SetKeyExponent(const char* lpKeyExponent, int lenKeyExponent);

Unicode (Windows)
INT GetKeyExponent(LPSTR &lpKeyExponent, INT &lenKeyExponent);
INT SetKeyExponent(LPCSTR lpKeyExponent, INT lenKeyExponent);

int ipworksencrypt_rsa_getkeyexponent(void* lpObj, char** lpKeyExponent, int* lenKeyExponent);
int ipworksencrypt_rsa_setkeyexponent(void* lpObj, const char* lpKeyExponent, int lenKeyExponent);

QByteArray GetKeyExponent();
int SetKeyExponent(QByteArray qbaKeyExponent);

Default Value

""

Remarks

Represents the Exponent parameter for the RSA algorithm.

Data Type

Binary String

KeyInverseQ Property (RSA Class)

Represents the InverseQ parameter for the RSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyInverseQ(char* &lpKeyInverseQ, int &lenKeyInverseQ);
int SetKeyInverseQ(const char* lpKeyInverseQ, int lenKeyInverseQ);

Unicode (Windows)
INT GetKeyInverseQ(LPSTR &lpKeyInverseQ, INT &lenKeyInverseQ);
INT SetKeyInverseQ(LPCSTR lpKeyInverseQ, INT lenKeyInverseQ);

int ipworksencrypt_rsa_getkeyinverseq(void* lpObj, char** lpKeyInverseQ, int* lenKeyInverseQ);
int ipworksencrypt_rsa_setkeyinverseq(void* lpObj, const char* lpKeyInverseQ, int lenKeyInverseQ);

QByteArray GetKeyInverseQ();
int SetKeyInverseQ(QByteArray qbaKeyInverseQ);

Default Value

""

Remarks

Represents the InverseQ parameter for the RSA algorithm. This parameter is optional and is automatically calculated as necessary.

Data Type

Binary String

KeyModulus Property (RSA Class)

Represents the Modulus parameter for the RSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyModulus(char* &lpKeyModulus, int &lenKeyModulus);
int SetKeyModulus(const char* lpKeyModulus, int lenKeyModulus);

Unicode (Windows)
INT GetKeyModulus(LPSTR &lpKeyModulus, INT &lenKeyModulus);
INT SetKeyModulus(LPCSTR lpKeyModulus, INT lenKeyModulus);

int ipworksencrypt_rsa_getkeymodulus(void* lpObj, char** lpKeyModulus, int* lenKeyModulus);
int ipworksencrypt_rsa_setkeymodulus(void* lpObj, const char* lpKeyModulus, int lenKeyModulus);

QByteArray GetKeyModulus();
int SetKeyModulus(QByteArray qbaKeyModulus);

Default Value

""

Remarks

Represents the Modulus parameter for the RSA algorithm.

Data Type

Binary String

KeyP Property (RSA Class)

Represents the P parameter for the RSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyP(char* &lpKeyP, int &lenKeyP);
int SetKeyP(const char* lpKeyP, int lenKeyP);

Unicode (Windows)
INT GetKeyP(LPSTR &lpKeyP, INT &lenKeyP);
INT SetKeyP(LPCSTR lpKeyP, INT lenKeyP);

int ipworksencrypt_rsa_getkeyp(void* lpObj, char** lpKeyP, int* lenKeyP);
int ipworksencrypt_rsa_setkeyp(void* lpObj, const char* lpKeyP, int lenKeyP);

QByteArray GetKeyP();
int SetKeyP(QByteArray qbaKeyP);

Default Value

""

Remarks

Represents the P parameter for the RSA algorithm.

Data Type

Binary String

KeyPrivateKey Property (RSA Class)

This property is a PEM formatted private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyPrivateKey();
int SetKeyPrivateKey(const char* lpszKeyPrivateKey);

Unicode (Windows)
LPWSTR GetKeyPrivateKey();
INT SetKeyPrivateKey(LPCWSTR lpszKeyPrivateKey);

char* ipworksencrypt_rsa_getkeyprivatekey(void* lpObj);
int ipworksencrypt_rsa_setkeyprivatekey(void* lpObj, const char* lpszKeyPrivateKey);

QString GetKeyPrivateKey();
int SetKeyPrivateKey(QString qsKeyPrivateKey);

Default Value

""

Remarks

This property is a PEM formatted private key. The purpose of this property is to allow easier management of the private key parameters by using only a single value.

Data Type

String

KeyPublicKey Property (RSA Class)

This property is a PEM formatted public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyPublicKey();
int SetKeyPublicKey(const char* lpszKeyPublicKey);

Unicode (Windows)
LPWSTR GetKeyPublicKey();
INT SetKeyPublicKey(LPCWSTR lpszKeyPublicKey);

char* ipworksencrypt_rsa_getkeypublickey(void* lpObj);
int ipworksencrypt_rsa_setkeypublickey(void* lpObj, const char* lpszKeyPublicKey);

QString GetKeyPublicKey();
int SetKeyPublicKey(QString qsKeyPublicKey);

Default Value

""

Remarks

This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.

Data Type

String

KeyQ Property (RSA Class)

Represents the Q parameter for the RSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyQ(char* &lpKeyQ, int &lenKeyQ);
int SetKeyQ(const char* lpKeyQ, int lenKeyQ);

Unicode (Windows)
INT GetKeyQ(LPSTR &lpKeyQ, INT &lenKeyQ);
INT SetKeyQ(LPCSTR lpKeyQ, INT lenKeyQ);

int ipworksencrypt_rsa_getkeyq(void* lpObj, char** lpKeyQ, int* lenKeyQ);
int ipworksencrypt_rsa_setkeyq(void* lpObj, const char* lpKeyQ, int lenKeyQ);

QByteArray GetKeyQ();
int SetKeyQ(QByteArray qbaKeyQ);

Default Value

""

Remarks

Represents the Q parameter for the RSA algorithm.

Data Type

Binary String

OutputFile Property (RSA Class)

The output file when encrypting or decrypting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* ipworksencrypt_rsa_getoutputfile(void* lpObj);
int ipworksencrypt_rsa_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

""

Remarks

This property specifies the file to which the output will be written when Encrypt or Decrypt is called. This may be set to an absolute or relative path.

This property is only applicable to Encrypt and Decrypt.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Data Type

String

OutputMessage Property (RSA Class)

The output message after processing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputMessage(char* &lpOutputMessage, int &lenOutputMessage);

Unicode (Windows)
INT GetOutputMessage(LPSTR &lpOutputMessage, INT &lenOutputMessage);

int ipworksencrypt_rsa_getoutputmessage(void* lpObj, char** lpOutputMessage, int* lenOutputMessage);

QByteArray GetOutputMessage();

Default Value

""

Remarks

This property will be populated with the output from the operation if OutputFile is not set.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

This property is read-only and not available at design time.

Data Type

Binary String

Overwrite Property (RSA Class)

Indicates whether or not the class should overwrite files.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int ipworksencrypt_rsa_getoverwrite(void* lpObj);
int ipworksencrypt_rsa_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

This property indicates whether or not the class will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.

Data Type

Boolean

RecipientCertEncoded Property (RSA Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientCertEncoded(char* &lpRecipientCertEncoded, int &lenRecipientCertEncoded);
int SetRecipientCertEncoded(const char* lpRecipientCertEncoded, int lenRecipientCertEncoded);

Unicode (Windows)
INT GetRecipientCertEncoded(LPSTR &lpRecipientCertEncoded, INT &lenRecipientCertEncoded);
INT SetRecipientCertEncoded(LPCSTR lpRecipientCertEncoded, INT lenRecipientCertEncoded);

int ipworksencrypt_rsa_getrecipientcertencoded(void* lpObj, char** lpRecipientCertEncoded, int* lenRecipientCertEncoded);
int ipworksencrypt_rsa_setrecipientcertencoded(void* lpObj, const char* lpRecipientCertEncoded, int lenRecipientCertEncoded);

QByteArray GetRecipientCertEncoded();
int SetRecipientCertEncoded(QByteArray qbaRecipientCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The RecipientCertStore and RecipientCertSubject properties also may be used to specify a certificate.

When RecipientCertEncoded is set, a search is initiated in the current RecipientCertStore for the private key of the certificate. If the key is found, RecipientCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RecipientCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

RecipientCertStore Property (RSA Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientCertStore(char* &lpRecipientCertStore, int &lenRecipientCertStore);
int SetRecipientCertStore(const char* lpRecipientCertStore, int lenRecipientCertStore);

Unicode (Windows)
INT GetRecipientCertStore(LPSTR &lpRecipientCertStore, INT &lenRecipientCertStore);
INT SetRecipientCertStore(LPCSTR lpRecipientCertStore, INT lenRecipientCertStore);

int ipworksencrypt_rsa_getrecipientcertstore(void* lpObj, char** lpRecipientCertStore, int* lenRecipientCertStore);
int ipworksencrypt_rsa_setrecipientcertstore(void* lpObj, const char* lpRecipientCertStore, int lenRecipientCertStore);

QByteArray GetRecipientCertStore();
int SetRecipientCertStore(QByteArray qbaRecipientCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password protected, specify the password in RecipientCertStorePassword.

RecipientCertStore is used in conjunction with the RecipientCertSubject property to specify client certificates. If RecipientCertStore has a value, and RecipientCertSubject or RecipientCertEncoded is set, a search for a certificate is initiated. Please see the RecipientCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

RecipientCertStorePassword Property (RSA Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCertStorePassword();
int SetRecipientCertStorePassword(const char* lpszRecipientCertStorePassword);

Unicode (Windows)
LPWSTR GetRecipientCertStorePassword();
INT SetRecipientCertStorePassword(LPCWSTR lpszRecipientCertStorePassword);

char* ipworksencrypt_rsa_getrecipientcertstorepassword(void* lpObj);
int ipworksencrypt_rsa_setrecipientcertstorepassword(void* lpObj, const char* lpszRecipientCertStorePassword);

QString GetRecipientCertStorePassword();
int SetRecipientCertStorePassword(QString qsRecipientCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

RecipientCertStoreType Property (RSA Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientCertStoreType();
int SetRecipientCertStoreType(int iRecipientCertStoreType);

Unicode (Windows)
INT GetRecipientCertStoreType();
INT SetRecipientCertStoreType(INT iRecipientCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksencrypt_rsa_getrecipientcertstoretype(void* lpObj);
int ipworksencrypt_rsa_setrecipientcertstoretype(void* lpObj, int iRecipientCertStoreType);

int GetRecipientCertStoreType();
int SetRecipientCertStoreType(int iRecipientCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

RecipientCertSubject Property (RSA Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCertSubject();
int SetRecipientCertSubject(const char* lpszRecipientCertSubject);

Unicode (Windows)
LPWSTR GetRecipientCertSubject();
INT SetRecipientCertSubject(LPCWSTR lpszRecipientCertSubject);

char* ipworksencrypt_rsa_getrecipientcertsubject(void* lpObj);
int ipworksencrypt_rsa_setrecipientcertsubject(void* lpObj, const char* lpszRecipientCertSubject);

QString GetRecipientCertSubject();
int SetRecipientCertSubject(QString qsRecipientCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

Data Type

String

RecipientKeyExponent Property (RSA Class)

Represents the Exponent parameter for the RSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientKeyExponent(char* &lpRecipientKeyExponent, int &lenRecipientKeyExponent);
int SetRecipientKeyExponent(const char* lpRecipientKeyExponent, int lenRecipientKeyExponent);

Unicode (Windows)
INT GetRecipientKeyExponent(LPSTR &lpRecipientKeyExponent, INT &lenRecipientKeyExponent);
INT SetRecipientKeyExponent(LPCSTR lpRecipientKeyExponent, INT lenRecipientKeyExponent);

int ipworksencrypt_rsa_getrecipientkeyexponent(void* lpObj, char** lpRecipientKeyExponent, int* lenRecipientKeyExponent);
int ipworksencrypt_rsa_setrecipientkeyexponent(void* lpObj, const char* lpRecipientKeyExponent, int lenRecipientKeyExponent);

QByteArray GetRecipientKeyExponent();
int SetRecipientKeyExponent(QByteArray qbaRecipientKeyExponent);

Default Value

""

Remarks

Represents the Exponent parameter for the RSA algorithm.

Data Type

Binary String

RecipientKeyModulus Property (RSA Class)

Represents the Modulus parameter for the RSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientKeyModulus(char* &lpRecipientKeyModulus, int &lenRecipientKeyModulus);
int SetRecipientKeyModulus(const char* lpRecipientKeyModulus, int lenRecipientKeyModulus);

Unicode (Windows)
INT GetRecipientKeyModulus(LPSTR &lpRecipientKeyModulus, INT &lenRecipientKeyModulus);
INT SetRecipientKeyModulus(LPCSTR lpRecipientKeyModulus, INT lenRecipientKeyModulus);

int ipworksencrypt_rsa_getrecipientkeymodulus(void* lpObj, char** lpRecipientKeyModulus, int* lenRecipientKeyModulus);
int ipworksencrypt_rsa_setrecipientkeymodulus(void* lpObj, const char* lpRecipientKeyModulus, int lenRecipientKeyModulus);

QByteArray GetRecipientKeyModulus();
int SetRecipientKeyModulus(QByteArray qbaRecipientKeyModulus);

Default Value

""

Remarks

Represents the Modulus parameter for the RSA algorithm.

Data Type

Binary String

RecipientKeyPublicKey Property (RSA Class)

This property is a PEM formatted public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientKeyPublicKey();
int SetRecipientKeyPublicKey(const char* lpszRecipientKeyPublicKey);

Unicode (Windows)
LPWSTR GetRecipientKeyPublicKey();
INT SetRecipientKeyPublicKey(LPCWSTR lpszRecipientKeyPublicKey);

char* ipworksencrypt_rsa_getrecipientkeypublickey(void* lpObj);
int ipworksencrypt_rsa_setrecipientkeypublickey(void* lpObj, const char* lpszRecipientKeyPublicKey);

QString GetRecipientKeyPublicKey();
int SetRecipientKeyPublicKey(QString qsRecipientKeyPublicKey);

Default Value

""

Remarks

This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.

Data Type

String

SignerCertEncoded Property (RSA Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerCertEncoded(char* &lpSignerCertEncoded, int &lenSignerCertEncoded);
int SetSignerCertEncoded(const char* lpSignerCertEncoded, int lenSignerCertEncoded);

Unicode (Windows)
INT GetSignerCertEncoded(LPSTR &lpSignerCertEncoded, INT &lenSignerCertEncoded);
INT SetSignerCertEncoded(LPCSTR lpSignerCertEncoded, INT lenSignerCertEncoded);

int ipworksencrypt_rsa_getsignercertencoded(void* lpObj, char** lpSignerCertEncoded, int* lenSignerCertEncoded);
int ipworksencrypt_rsa_setsignercertencoded(void* lpObj, const char* lpSignerCertEncoded, int lenSignerCertEncoded);

QByteArray GetSignerCertEncoded();
int SetSignerCertEncoded(QByteArray qbaSignerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SignerCertStore and SignerCertSubject properties also may be used to specify a certificate.

When SignerCertEncoded is set, a search is initiated in the current SignerCertStore for the private key of the certificate. If the key is found, SignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SignerCertStore Property (RSA Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerCertStore(char* &lpSignerCertStore, int &lenSignerCertStore);
int SetSignerCertStore(const char* lpSignerCertStore, int lenSignerCertStore);

Unicode (Windows)
INT GetSignerCertStore(LPSTR &lpSignerCertStore, INT &lenSignerCertStore);
INT SetSignerCertStore(LPCSTR lpSignerCertStore, INT lenSignerCertStore);

int ipworksencrypt_rsa_getsignercertstore(void* lpObj, char** lpSignerCertStore, int* lenSignerCertStore);
int ipworksencrypt_rsa_setsignercertstore(void* lpObj, const char* lpSignerCertStore, int lenSignerCertStore);

QByteArray GetSignerCertStore();
int SetSignerCertStore(QByteArray qbaSignerCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password protected, specify the password in SignerCertStorePassword.

SignerCertStore is used in conjunction with the SignerCertSubject property to specify client certificates. If SignerCertStore has a value, and SignerCertSubject or SignerCertEncoded is set, a search for a certificate is initiated. Please see the SignerCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SignerCertStorePassword Property (RSA Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerCertStorePassword();
int SetSignerCertStorePassword(const char* lpszSignerCertStorePassword);

Unicode (Windows)
LPWSTR GetSignerCertStorePassword();
INT SetSignerCertStorePassword(LPCWSTR lpszSignerCertStorePassword);

char* ipworksencrypt_rsa_getsignercertstorepassword(void* lpObj);
int ipworksencrypt_rsa_setsignercertstorepassword(void* lpObj, const char* lpszSignerCertStorePassword);

QString GetSignerCertStorePassword();
int SetSignerCertStorePassword(QString qsSignerCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SignerCertStoreType Property (RSA Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerCertStoreType();
int SetSignerCertStoreType(int iSignerCertStoreType);

Unicode (Windows)
INT GetSignerCertStoreType();
INT SetSignerCertStoreType(INT iSignerCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksencrypt_rsa_getsignercertstoretype(void* lpObj);
int ipworksencrypt_rsa_setsignercertstoretype(void* lpObj, int iSignerCertStoreType);

int GetSignerCertStoreType();
int SetSignerCertStoreType(int iSignerCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SignerCertSubject Property (RSA Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerCertSubject();
int SetSignerCertSubject(const char* lpszSignerCertSubject);

Unicode (Windows)
LPWSTR GetSignerCertSubject();
INT SetSignerCertSubject(LPCWSTR lpszSignerCertSubject);

char* ipworksencrypt_rsa_getsignercertsubject(void* lpObj);
int ipworksencrypt_rsa_setsignercertsubject(void* lpObj, const char* lpszSignerCertSubject);

QString GetSignerCertSubject();
int SetSignerCertSubject(QString qsSignerCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

Data Type

String

SignerKeyExponent Property (RSA Class)

Represents the Exponent parameter for the RSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerKeyExponent(char* &lpSignerKeyExponent, int &lenSignerKeyExponent);
int SetSignerKeyExponent(const char* lpSignerKeyExponent, int lenSignerKeyExponent);

Unicode (Windows)
INT GetSignerKeyExponent(LPSTR &lpSignerKeyExponent, INT &lenSignerKeyExponent);
INT SetSignerKeyExponent(LPCSTR lpSignerKeyExponent, INT lenSignerKeyExponent);

int ipworksencrypt_rsa_getsignerkeyexponent(void* lpObj, char** lpSignerKeyExponent, int* lenSignerKeyExponent);
int ipworksencrypt_rsa_setsignerkeyexponent(void* lpObj, const char* lpSignerKeyExponent, int lenSignerKeyExponent);

QByteArray GetSignerKeyExponent();
int SetSignerKeyExponent(QByteArray qbaSignerKeyExponent);

Default Value

""

Remarks

Represents the Exponent parameter for the RSA algorithm.

Data Type

Binary String

SignerKeyModulus Property (RSA Class)

Represents the Modulus parameter for the RSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerKeyModulus(char* &lpSignerKeyModulus, int &lenSignerKeyModulus);
int SetSignerKeyModulus(const char* lpSignerKeyModulus, int lenSignerKeyModulus);

Unicode (Windows)
INT GetSignerKeyModulus(LPSTR &lpSignerKeyModulus, INT &lenSignerKeyModulus);
INT SetSignerKeyModulus(LPCSTR lpSignerKeyModulus, INT lenSignerKeyModulus);

int ipworksencrypt_rsa_getsignerkeymodulus(void* lpObj, char** lpSignerKeyModulus, int* lenSignerKeyModulus);
int ipworksencrypt_rsa_setsignerkeymodulus(void* lpObj, const char* lpSignerKeyModulus, int lenSignerKeyModulus);

QByteArray GetSignerKeyModulus();
int SetSignerKeyModulus(QByteArray qbaSignerKeyModulus);

Default Value

""

Remarks

Represents the Modulus parameter for the RSA algorithm.

Data Type

Binary String

SignerKeyPublicKey Property (RSA Class)

This property is a PEM formatted public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerKeyPublicKey();
int SetSignerKeyPublicKey(const char* lpszSignerKeyPublicKey);

Unicode (Windows)
LPWSTR GetSignerKeyPublicKey();
INT SetSignerKeyPublicKey(LPCWSTR lpszSignerKeyPublicKey);

char* ipworksencrypt_rsa_getsignerkeypublickey(void* lpObj);
int ipworksencrypt_rsa_setsignerkeypublickey(void* lpObj, const char* lpszSignerKeyPublicKey);

QString GetSignerKeyPublicKey();
int SetSignerKeyPublicKey(QString qsSignerKeyPublicKey);

Default Value

""

Remarks

This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.

Data Type

String

UseHex Property (RSA Class)

Whether input or output is hex encoded.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseHex();
int SetUseHex(int bUseHex);

Unicode (Windows)
BOOL GetUseHex();
INT SetUseHex(BOOL bUseHex);

int ipworksencrypt_rsa_getusehex(void* lpObj);
int ipworksencrypt_rsa_setusehex(void* lpObj, int bUseHex);

bool GetUseHex();
int SetUseHex(bool bUseHex);

Default Value

FALSE

Remarks

This property specifies whether the encrypted data, HashValue, and HashSignature are hex encoded.

If set to True, when Encrypt is called the class will perform the encryption as normal and then hex encode the output. OutputMessage or OutputFile will hold hex encoded data.

If set to True, when Decrypt is called the class will expect InputMessage or InputFile to hold hex encoded data. The class will then hex decode the data and perform decryption as normal.

If set to True, when Sign is called the class will compute the hash for the specified file and populate HashValue with the hex encoded hash value. It will then create the hash signature and populate HashSignature with the hex encoded hash signature value. If HashValue is specified directly it must be a hex encoded value.

If set to True, when VerifySignature is called the class will compute the hash value for the specified file and populate HashValue with the hex encoded hash value. It will then hex decode HashSignature and verify the signature. HashSignature must hold a hex encoded value. If HashValue is specified directly it must be a hex encoded value.

Data Type

Boolean

UseOAEP Property (RSA Class)

Whether to use Optimal Asymmetric Encryption Padding (OAEP).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseOAEP();
int SetUseOAEP(int bUseOAEP);

Unicode (Windows)
BOOL GetUseOAEP();
INT SetUseOAEP(BOOL bUseOAEP);

int ipworksencrypt_rsa_getuseoaep(void* lpObj);
int ipworksencrypt_rsa_setuseoaep(void* lpObj, int bUseOAEP);

bool GetUseOAEP();
int SetUseOAEP(bool bUseOAEP);

Default Value

FALSE

Remarks

Whether to use Optimal Asymmetric Encryption Padding (OAEP). By default this value is False and the class will use PKCS1.

Note: When set to True the HashAlgorithm is also applicable when calling Encrypt and Decrypt.

Data Type

Boolean

UsePSS Property (RSA Class)

Whether to use RSA-PSS during signing and verification.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUsePSS();
int SetUsePSS(int bUsePSS);

Unicode (Windows)
BOOL GetUsePSS();
INT SetUsePSS(BOOL bUsePSS);

int ipworksencrypt_rsa_getusepss(void* lpObj);
int ipworksencrypt_rsa_setusepss(void* lpObj, int bUsePSS);

bool GetUsePSS();
int SetUsePSS(bool bUsePSS);

Default Value

FALSE

Remarks

This property specifies whether RSA-PSS will be used when signing and verifying messages. The default value is False.

Data Type

Boolean

Config Method (RSA Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksencrypt_rsa_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateKey Method (RSA Class)

Creates a new key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateKey();

Unicode (Windows)
INT CreateKey();

int ipworksencrypt_rsa_createkey(void* lpObj);

int CreateKey();

Remarks

This method creates a new public and private key.

When calling CreateKey the Key* properties are populated with a new private and public key.

RSA Keys

A RSA key is made up of a number of individual parameters.

The public key consists of the following parameters:

• KeyModulus
• KeyExponent

The class also includes the KeyPublicKey property which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both sides of the encryption/signing and decryption/signature verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in KeyPublicKey in which case the individual parameters must be sent.

The private key may be represented in one of two ways. Both are mathematically equivalent. Private key format 1:

• KeyModulus
• KeyP
• KeyQ
• KeyDP
• KeyDQ

• KeyModulus
• KeyD

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Decrypt Method (RSA Class)

Decrypts the input data using the specified private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Decrypt();

Unicode (Windows)
INT Decrypt();

int ipworksencrypt_rsa_decrypt(void* lpObj);

int Decrypt();

Remarks

This method decrypts the input data using the private key specified in the Key* properties. Alternatively, a certificate may be specified by setting Certificate

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Key Size and the Maximum Length of Data

RSA has an upper limit to the amount of data that can be encrypted or decrypted, also known as message length. This can typically be calculated as the size of the key minus the size of the RSA header and padding.

When not using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (Header Bytes) = Length of data, where Header Bytes is always 11.

When using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (2 * Hash Length Bytes) - 2 = Length of data. The table below assumes SHA-256 for the hash, so Hash Length Bytes is 32.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Encrypt Method (RSA Class)

Encrypts the input data using the recipient's public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Encrypt();

Unicode (Windows)
INT Encrypt();

int ipworksencrypt_rsa_encrypt(void* lpObj);

int Encrypt();

Remarks

This method encrypts the input data using the public key specified in the RecipientKey* properties. Alternatively, a certificate may be specified by setting RecipientCert

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Key Size and the Maximum Length of Data

RSA has an upper limit to the amount of data that can be encrypted or decrypted, also known as message length. This can typically be calculated as the size of the key minus the size of the RSA header and padding.

When not using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (Header Bytes) = Length of data, where Header Bytes is always 11.

When using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (2 * Hash Length Bytes) - 2 = Length of data. The table below assumes SHA-256 for the hash, so Hash Length Bytes is 32.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (RSA Class)

Resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksencrypt_rsa_reset(void* lpObj);

int Reset();

Remarks

When called, the class will reset all of its properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetInputStream Method (RSA Class)

Sets the stream from which the class will read data to encrypt or decrypt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetInputStream(IPWorksEncryptStream* sInputStream);

Unicode (Windows)
INT SetInputStream(IPWorksEncryptStream* sInputStream);

int ipworksencrypt_rsa_setinputstream(void* lpObj, IPWorksEncryptStream* sInputStream);

int SetInputStream(IPWorksEncryptStream* sInputStream);

Remarks

This method sets the stream from which the class will read data to encrypt or decrypt.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetOutputStream Method (RSA Class)

Sets the stream to which the class will write encrypted or decrypted data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetOutputStream(IPWorksEncryptStream* sOutputStream);

Unicode (Windows)
INT SetOutputStream(IPWorksEncryptStream* sOutputStream);

int ipworksencrypt_rsa_setoutputstream(void* lpObj, IPWorksEncryptStream* sOutputStream);

int SetOutputStream(IPWorksEncryptStream* sOutputStream);

Remarks

This method sets the stream to which the class will write encrypted or decrypted data.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Sign Method (RSA Class)

Creates a hash signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Sign();

Unicode (Windows)
INT Sign();

int ipworksencrypt_rsa_sign(void* lpObj);

int Sign();

Remarks

This method will create a hash signature.

Before calling this method specify the input file by setting InputFile or InputMessage.

A key is required to create the hash signature. You may create a new key by calling CreateKey, or specify an existing key pair in Key. Alternatively, a certificate may be specified by setting Certificate. When this method is called the class will compute the hash for the specified file and populate HashValue. It will then create the hash signature using the specified Key and populate HashSignature.

To create the hash signature without first computing the hash simply specify HashValue before calling this method.

The Progress event will fire with updates for the hash computation progress only. The hash signature creation process is quick and does not require progress updates.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

VerifySignature Method (RSA Class)

Verifies the signature for the specified data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VerifySignature();

Unicode (Windows)
INT VerifySignature();

int ipworksencrypt_rsa_verifysignature(void* lpObj);

bool VerifySignature();

Remarks

This method will verify a hash signature.

Before calling this method specify the input file by setting InputFile or InputMessage.

A public key and the hash signature are required to perform the signature verification. Specify the public key in SignerKey. Alternatively, a certificate may be specified by setting SignerCert. Specify the hash signature in HashSignature.

When this method is called the class will compute the hash for the specified file and populate HashValue. It will verify the signature using the specified SignerKey and HashSignature.

To verify the hash signature without first computing the hash simply specify HashValue before calling this method.

The Progress event will fire with updates for the hash computation progress only. The hash signature verification process is quick and does not require progress updates.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Error Event (RSA Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(RSAErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} RSAErrorEventParams;


Unicode (Windows)
virtual INT FireError(RSAErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} RSAErrorEventParams;

#define EID_RSA_ERROR 1

virtual INT IPWORKSENCRYPT_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class RSAErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(RSAErrorEventParams *e);

// Or, subclass RSA and override this emitter function.
virtual int FireError(RSAErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Progress Event (RSA Class)

Fired as progress is made.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProgress(RSAProgressEventParams *e);

typedef struct {
  int64 BytesProcessed;
  int PercentProcessed;
  int reserved;
} RSAProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(RSAProgressEventParams *e);

typedef struct {
  LONG64 BytesProcessed;
  INT PercentProcessed;
  INT reserved;
} RSAProgressEventParams;

#define EID_RSA_PROGRESS 2

virtual INT IPWORKSENCRYPT_CALL FireProgress(LONG64 &lBytesProcessed, INT &iPercentProcessed);

class RSAProgressEventParams {
public:
  qint64 BytesProcessed();

  int PercentProcessed();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Progress(RSAProgressEventParams *e);

// Or, subclass RSA and override this emitter function.
virtual int FireProgress(RSAProgressEventParams *e) {...}

Remarks

This event is fired automatically as data is processed by the class.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

IPWorksEncryptStream Type

Syntax

IPWorksEncryptStream (declared in ipworksencrypt.h)

Remarks

The RSA class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksEncryptStream interface and pass the RSA class an instance of that concrete class.

When implementing the IPWorksEncryptStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (RSA Class)

RSA Config Settings

Base Config Settings

Trappable Errors (RSA Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

RSA Errors