DSA Class

Properties   Methods   Events   Config Settings   Errors  

The DSA (Digital Signature Algorithm) class enables users to generate DSA hash signatures.

Syntax

DSA

Remarks

The DSA (Digital Signature Algorithm) class enables users to generate DSA 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. Select the input file by setting InputFile or InputMessage. Next call Sign. The Sign method will automatically compute the hash, and then sign the hash with the specified key.

Send the public key (see CreateKey for details), file, and HashSignature to the recipient.

To sign a hash without recomputing the hash simply set HashValue to the pre-computed hash value before calling Sign.

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.

To verify a hash signature without recomputing the hash simply set HashValue to the pre-computed hash value before calling VerifySignature.

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.

DSA Key Notes

A DSA key is made up of a number of individual parameters. When calling CreateKey the Key* properties are populated with a new private and public key.

After calling Sign the public key must be sent to the recipient along with HashSignature so they may perform signature verification. Likewise you must obtain the public key along with HashSignature in order to perform signature verification.

The public key consists of the following parameters:

• KeyP
• KeyQ
• KeyG
• KeyY

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 signature creation and 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 consists of the following parameters:

• KeyP
• KeyQ
• KeyG
• KeyY
• KeyX

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 (DSA 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_dsa_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworksencrypt_dsa_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 (DSA 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_dsa_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworksencrypt_dsa_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 designations are 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., PKCS#12 certificate store).

Data Type

Binary String

CertStorePassword Property (DSA 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_dsa_getcertstorepassword(void* lpObj);
int ipworksencrypt_dsa_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 (DSA 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_dsa_getcertstoretype(void* lpObj);
int ipworksencrypt_dsa_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 (DSA 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_dsa_getcertsubject(void* lpObj);
int ipworksencrypt_dsa_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 as follows:

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

Data Type

String

HashAlgorithm Property (DSA Class)

The hash algorithm used for hash computation.

Syntax

• C++
• C
• Qt

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

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

DHA_SHA1(0), 
DHA_SHA224(1), 
DHA_SHA256(2), 
DHA_SHA384(3), 
DHA_SHA512(4), 
DHA_RIPEMD160(5)

int ipworksencrypt_dsa_gethashalgorithm(void* lpObj);
int ipworksencrypt_dsa_sethashalgorithm(void* lpObj, int iHashAlgorithm);

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

Default Value

2

Remarks

This property specifies the hash algorithm used for hash computation. This is only applicable when calling Sign or VerifySignature and HashValue is computed. Possible values are:

Data Type

Integer

HashSignature Property (DSA 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_dsa_gethashsignature(void* lpObj, char** lpHashSignature, int* lenHashSignature);
int ipworksencrypt_dsa_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 (DSA 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_dsa_gethashvalue(void* lpObj, char** lpHashValue, int* lenHashValue);
int ipworksencrypt_dsa_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 (DSA 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_dsa_getinputfile(void* lpObj);
int ipworksencrypt_dsa_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 (DSA 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_dsa_getinputmessage(void* lpObj, char** lpInputMessage, int* lenInputMessage);
int ipworksencrypt_dsa_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

KeyG Property (DSA Class)

Represents the G parameter for the DSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyG(char* &lpKeyG, int &lenKeyG);
int SetKeyG(const char* lpKeyG, int lenKeyG);

Unicode (Windows)
INT GetKeyG(LPSTR &lpKeyG, INT &lenKeyG);
INT SetKeyG(LPCSTR lpKeyG, INT lenKeyG);

int ipworksencrypt_dsa_getkeyg(void* lpObj, char** lpKeyG, int* lenKeyG);
int ipworksencrypt_dsa_setkeyg(void* lpObj, const char* lpKeyG, int lenKeyG);

QByteArray GetKeyG();
int SetKeyG(QByteArray qbaKeyG);

Default Value

""

Remarks

Represents the G parameter for the DSA algorithm.

Data Type

Binary String

KeyP Property (DSA Class)

Represents the P parameter for the DSA 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_dsa_getkeyp(void* lpObj, char** lpKeyP, int* lenKeyP);
int ipworksencrypt_dsa_setkeyp(void* lpObj, const char* lpKeyP, int lenKeyP);

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

Default Value

""

Remarks

Represents the P parameter for the DSA algorithm.

Data Type

Binary String

KeyPrivateKey Property (DSA 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_dsa_getkeyprivatekey(void* lpObj);
int ipworksencrypt_dsa_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 (DSA 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_dsa_getkeypublickey(void* lpObj);
int ipworksencrypt_dsa_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 (DSA Class)

Represents the Q parameter for the DSA 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_dsa_getkeyq(void* lpObj, char** lpKeyQ, int* lenKeyQ);
int ipworksencrypt_dsa_setkeyq(void* lpObj, const char* lpKeyQ, int lenKeyQ);

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

Default Value

""

Remarks

Represents the Q parameter for the DSA algorithm.

Data Type

Binary String

KeyX Property (DSA Class)

Represents the X parameter for the DSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyX(char* &lpKeyX, int &lenKeyX);
int SetKeyX(const char* lpKeyX, int lenKeyX);

Unicode (Windows)
INT GetKeyX(LPSTR &lpKeyX, INT &lenKeyX);
INT SetKeyX(LPCSTR lpKeyX, INT lenKeyX);

int ipworksencrypt_dsa_getkeyx(void* lpObj, char** lpKeyX, int* lenKeyX);
int ipworksencrypt_dsa_setkeyx(void* lpObj, const char* lpKeyX, int lenKeyX);

QByteArray GetKeyX();
int SetKeyX(QByteArray qbaKeyX);

Default Value

""

Remarks

Represents the X parameter for the DSA algorithm.

Data Type

Binary String

KeyY Property (DSA Class)

Represents the Y parameter for the DSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyY(char* &lpKeyY, int &lenKeyY);
int SetKeyY(const char* lpKeyY, int lenKeyY);

Unicode (Windows)
INT GetKeyY(LPSTR &lpKeyY, INT &lenKeyY);
INT SetKeyY(LPCSTR lpKeyY, INT lenKeyY);

int ipworksencrypt_dsa_getkeyy(void* lpObj, char** lpKeyY, int* lenKeyY);
int ipworksencrypt_dsa_setkeyy(void* lpObj, const char* lpKeyY, int lenKeyY);

QByteArray GetKeyY();
int SetKeyY(QByteArray qbaKeyY);

Default Value

""

Remarks

Represents the Y parameter for the DSA algorithm.

Data Type

Binary String

SignerCertEncoded Property (DSA 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_dsa_getsignercertencoded(void* lpObj, char** lpSignerCertEncoded, int* lenSignerCertEncoded);
int ipworksencrypt_dsa_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 (DSA 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_dsa_getsignercertstore(void* lpObj, char** lpSignerCertStore, int* lenSignerCertStore);
int ipworksencrypt_dsa_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 designations are 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., PKCS#12 certificate store).

Data Type

Binary String

SignerCertStorePassword Property (DSA 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_dsa_getsignercertstorepassword(void* lpObj);
int ipworksencrypt_dsa_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 (DSA 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_dsa_getsignercertstoretype(void* lpObj);
int ipworksencrypt_dsa_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 (DSA 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_dsa_getsignercertsubject(void* lpObj);
int ipworksencrypt_dsa_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 as follows:

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

Data Type

String

SignerKeyG Property (DSA Class)

Represents the G parameter for the DSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerKeyG(char* &lpSignerKeyG, int &lenSignerKeyG);
int SetSignerKeyG(const char* lpSignerKeyG, int lenSignerKeyG);

Unicode (Windows)
INT GetSignerKeyG(LPSTR &lpSignerKeyG, INT &lenSignerKeyG);
INT SetSignerKeyG(LPCSTR lpSignerKeyG, INT lenSignerKeyG);

int ipworksencrypt_dsa_getsignerkeyg(void* lpObj, char** lpSignerKeyG, int* lenSignerKeyG);
int ipworksencrypt_dsa_setsignerkeyg(void* lpObj, const char* lpSignerKeyG, int lenSignerKeyG);

QByteArray GetSignerKeyG();
int SetSignerKeyG(QByteArray qbaSignerKeyG);

Default Value

""

Remarks

Represents the G parameter for the DSA algorithm.

Data Type

Binary String

SignerKeyP Property (DSA Class)

Represents the P parameter for the DSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerKeyP(char* &lpSignerKeyP, int &lenSignerKeyP);
int SetSignerKeyP(const char* lpSignerKeyP, int lenSignerKeyP);

Unicode (Windows)
INT GetSignerKeyP(LPSTR &lpSignerKeyP, INT &lenSignerKeyP);
INT SetSignerKeyP(LPCSTR lpSignerKeyP, INT lenSignerKeyP);

int ipworksencrypt_dsa_getsignerkeyp(void* lpObj, char** lpSignerKeyP, int* lenSignerKeyP);
int ipworksencrypt_dsa_setsignerkeyp(void* lpObj, const char* lpSignerKeyP, int lenSignerKeyP);

QByteArray GetSignerKeyP();
int SetSignerKeyP(QByteArray qbaSignerKeyP);

Default Value

""

Remarks

Represents the P parameter for the DSA algorithm.

Data Type

Binary String

SignerKeyPublicKey Property (DSA 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_dsa_getsignerkeypublickey(void* lpObj);
int ipworksencrypt_dsa_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

SignerKeyQ Property (DSA Class)

Represents the Q parameter for the DSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerKeyQ(char* &lpSignerKeyQ, int &lenSignerKeyQ);
int SetSignerKeyQ(const char* lpSignerKeyQ, int lenSignerKeyQ);

Unicode (Windows)
INT GetSignerKeyQ(LPSTR &lpSignerKeyQ, INT &lenSignerKeyQ);
INT SetSignerKeyQ(LPCSTR lpSignerKeyQ, INT lenSignerKeyQ);

int ipworksencrypt_dsa_getsignerkeyq(void* lpObj, char** lpSignerKeyQ, int* lenSignerKeyQ);
int ipworksencrypt_dsa_setsignerkeyq(void* lpObj, const char* lpSignerKeyQ, int lenSignerKeyQ);

QByteArray GetSignerKeyQ();
int SetSignerKeyQ(QByteArray qbaSignerKeyQ);

Default Value

""

Remarks

Represents the Q parameter for the DSA algorithm.

Data Type

Binary String

SignerKeyY Property (DSA Class)

Represents the Y parameter for the DSA algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerKeyY(char* &lpSignerKeyY, int &lenSignerKeyY);
int SetSignerKeyY(const char* lpSignerKeyY, int lenSignerKeyY);

Unicode (Windows)
INT GetSignerKeyY(LPSTR &lpSignerKeyY, INT &lenSignerKeyY);
INT SetSignerKeyY(LPCSTR lpSignerKeyY, INT lenSignerKeyY);

int ipworksencrypt_dsa_getsignerkeyy(void* lpObj, char** lpSignerKeyY, int* lenSignerKeyY);
int ipworksencrypt_dsa_setsignerkeyy(void* lpObj, const char* lpSignerKeyY, int lenSignerKeyY);

QByteArray GetSignerKeyY();
int SetSignerKeyY(QByteArray qbaSignerKeyY);

Default Value

""

Remarks

Represents the Y parameter for the DSA algorithm.

Data Type

Binary String

UseHex Property (DSA Class)

Whether HashValue and HashSignature are 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_dsa_getusehex(void* lpObj);
int ipworksencrypt_dsa_setusehex(void* lpObj, int bUseHex);

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

Default Value

FALSE

Remarks

This property specifies whether HashValue and HashSignature are hex encoded.

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

Config Method (DSA 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_dsa_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 (DSA Class)

Creates a new key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateKey();

Unicode (Windows)
INT CreateKey();

int ipworksencrypt_dsa_createkey(void* lpObj);

int CreateKey();

Remarks

This method creates a new public and private key.

DSA Key Notes

A DSA key is made up of a number of individual parameters. When calling CreateKey the Key* properties are populated with a new private and public key.

After calling Sign the public key must be sent to the recipient along with HashSignature so they may perform signature verification. Likewise you must obtain the public key along with HashSignature in order to perform signature verification.

The public key consists of the following parameters:

• KeyP
• KeyQ
• KeyG
• KeyY

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 signature creation and 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 consists of the following parameters:

• KeyP
• KeyQ
• KeyG
• KeyY
• KeyX

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 (DSA Class)

Resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksencrypt_dsa_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 (DSA 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_dsa_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.)

Sign Method (DSA Class)

Creates a hash signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Sign();

Unicode (Windows)
INT Sign();

int ipworksencrypt_dsa_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 (DSA Class)

Verifies the signature for the specified data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VerifySignature();

Unicode (Windows)
INT VerifySignature();

int ipworksencrypt_dsa_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 (DSA Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_DSA_ERROR 1

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

class DSAErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

The ErrorCode parameter contains an error code, and the Description parameter 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 (DSA Class)

Fired as progress is made.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_DSA_PROGRESS 2

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

class DSAProgressEventParams {
public:
  qint64 BytesProcessed();

  int PercentProcessed();

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

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

// Or, subclass DSA and override this emitter function.
virtual int FireProgress(DSAProgressEventParams *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 DSA 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 DSA 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 (DSA Class)

DSA Config Settings

Base Config Settings

Trappable Errors (DSA 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.

DSA Errors