# DSA Class

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

## Class Name

**IPWorksEncrypt_DSA**

## Procedural Interface

```text
 ipworksencrypt_dsa_open();
 ipworksencrypt_dsa_close($res);
 ipworksencrypt_dsa_register_callback($res, $id, $function);
 ipworksencrypt_dsa_get_last_error($res);
 ipworksencrypt_dsa_get_last_error_code($res);
 ipworksencrypt_dsa_set($res, $id, $index, $value);
 ipworksencrypt_dsa_get($res, $id, $index);
 ipworksencrypt_dsa_do_config($res, $configurationstring);
 ipworksencrypt_dsa_do_createkey($res);
 ipworksencrypt_dsa_do_reset($res);
 ipworksencrypt_dsa_do_sign($res);
 ipworksencrypt_dsa_do_verifysignature($res);
```

## 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 Key. To create a new key call [CreateKey](#createkey-method-ipworksencrypt_dsa-class). Alternatively an existing certificate may be specified by setting Certificate

**Signing**

To sign data first set Key or Certificate. Select the input file by setting [InputFile](#inputfile-property-ipworksencrypt_dsa-class) or [InputMessage](#inputmessage-property-ipworksencrypt_dsa-class). Next call [Sign](#sign-method-ipworksencrypt_dsa-class). The [Sign](#sign-method-ipworksencrypt_dsa-class) method will automatically compute the hash, and then sign the hash with the specified key.

Send the public key (see [CreateKey](#createkey-method-ipworksencrypt_dsa-class) for details), file, and [HashSignature](#hashsignature-property-ipworksencrypt_dsa-class) to the recipient.

To sign a hash without recomputing the hash simply set [HashValue](#hashvalue-property-ipworksencrypt_dsa-class) to the pre-computed hash value before calling [Sign](#sign-method-ipworksencrypt_dsa-class).

**Signature Verification**

To verify a signature specify the input data using [InputFile](#inputfile-property-ipworksencrypt_dsa-class) or [InputMessage](#inputmessage-property-ipworksencrypt_dsa-class). Set SignerKey or SignerCert. Next set [HashSignature](#hashsignature-property-ipworksencrypt_dsa-class) and call [VerifySignature](#verifysignature-method-ipworksencrypt_dsa-class). The [VerifySignature](#verifysignature-method-ipworksencrypt_dsa-class) method will return True if the signature was successfully verified.

To verify a hash signature without recomputing the hash simply set [HashValue](#hashvalue-property-ipworksencrypt_dsa-class) to the pre-computed hash value before calling [VerifySignature](#verifysignature-method-ipworksencrypt_dsa-class).

**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](#inputfile-property-ipworksencrypt_dsa-class) or [InputMessage](#inputmessage-property-ipworksencrypt_dsa-class), the hash will be recomputed when calling [Sign](#sign-method-ipworksencrypt_dsa-class) or [VerifySignature](#verifysignature-method-ipworksencrypt_dsa-class). If the [HashValue](#hashvalue-property-ipworksencrypt_dsa-class) property is set, the class will only sign the hash or verify the hash signature. Setting [InputFile](#inputfile-property-ipworksencrypt_dsa-class) or [InputMessage](#inputmessage-property-ipworksencrypt_dsa-class) clears the [HashValue](#hashvalue-property-ipworksencrypt_dsa-class) property. Setting the [HashValue](#hashvalue-property-ipworksencrypt_dsa-class) property clears the input file selection.

**DSA Key Notes**

A DSA key is made up of a number of individual parameters. When calling [CreateKey](#createkey-method-ipworksencrypt_dsa-class) the key property is populated with a new private and public key.

After calling [Sign](#sign-method-ipworksencrypt_dsa-class) the public key must be sent to the recipient along with [HashSignature](#hashsignature-property-ipworksencrypt_dsa-class) so they may perform signature verification. Likewise you must obtain the public key along with [HashSignature](#hashsignature-property-ipworksencrypt_dsa-class) in order to perform signature verification.

The public key consists of the following parameters:

- [KeyP](#keyp-property-ipworksencrypt_dsa-class)
- [KeyQ](#keyq-property-ipworksencrypt_dsa-class)
- [KeyG](#keyg-property-ipworksencrypt_dsa-class)
- [KeyY](#keyy-property-ipworksencrypt_dsa-class)

The class also includes the [KeyPublicKey](#keypublickey-property-ipworksencrypt_dsa-class) 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](#keypublickey-property-ipworksencrypt_dsa-class) in which case the individual parameters must be sent.

The private key consists of the following parameters:

- [KeyP](#keyp-property-ipworksencrypt_dsa-class)
- [KeyQ](#keyq-property-ipworksencrypt_dsa-class)
- [KeyG](#keyg-property-ipworksencrypt_dsa-class)
- [KeyY](#keyy-property-ipworksencrypt_dsa-class)
- [KeyX](#keyx-property-ipworksencrypt_dsa-class)

 The class also include the [KeyPrivateKey](#keyprivatekey-property-ipworksencrypt_dsa-class) property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily..

## Property List

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

|  |  |
| --- | --- |
| [CertEffectiveDate](#certeffectivedate-property-ipworksencrypt_dsa-class) | The date on which this certificate becomes valid. |
| [CertExpirationDate](#certexpirationdate-property-ipworksencrypt_dsa-class) | The date on which the certificate expires. |
| [CertExtendedKeyUsage](#certextendedkeyusage-property-ipworksencrypt_dsa-class) | A comma-delimited list of extended key usage identifiers. |
| [CertFingerprint](#certfingerprint-property-ipworksencrypt_dsa-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [CertFingerprintSHA1](#certfingerprintsha1-property-ipworksencrypt_dsa-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [CertFingerprintSHA256](#certfingerprintsha256-property-ipworksencrypt_dsa-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [CertIssuer](#certissuer-property-ipworksencrypt_dsa-class) | The issuer of the certificate. |
| [CertPrivateKey](#certprivatekey-property-ipworksencrypt_dsa-class) | The private key of the certificate (if available). |
| [CertPrivateKeyAvailable](#certprivatekeyavailable-property-ipworksencrypt_dsa-class) | Whether a PrivateKey is available for the selected certificate. |
| [CertPrivateKeyContainer](#certprivatekeycontainer-property-ipworksencrypt_dsa-class) | The name of the PrivateKey container for the certificate (if available). |
| [CertPublicKey](#certpublickey-property-ipworksencrypt_dsa-class) | The public key of the certificate. |
| [CertPublicKeyAlgorithm](#certpublickeyalgorithm-property-ipworksencrypt_dsa-class) | The textual description of the certificate's public key algorithm. |
| [CertPublicKeyLength](#certpublickeylength-property-ipworksencrypt_dsa-class) | The length of the certificate's public key (in bits). |
| [CertSerialNumber](#certserialnumber-property-ipworksencrypt_dsa-class) | The serial number of the certificate encoded as a string. |
| [CertSignatureAlgorithm](#certsignaturealgorithm-property-ipworksencrypt_dsa-class) | The text description of the certificate's signature algorithm. |
| [CertStore](#certstore-property-ipworksencrypt_dsa-class) | The name of the certificate store for the client certificate. |
| [CertStorePassword](#certstorepassword-property-ipworksencrypt_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. |
| [CertStoreType](#certstoretype-property-ipworksencrypt_dsa-class) | The type of certificate store for this certificate. |
| [CertSubjectAltNames](#certsubjectaltnames-property-ipworksencrypt_dsa-class) | Comma-separated lists of alternative subject names for the certificate. |
| [CertThumbprintMD5](#certthumbprintmd5-property-ipworksencrypt_dsa-class) | The MD5 hash of the certificate. |
| [CertThumbprintSHA1](#certthumbprintsha1-property-ipworksencrypt_dsa-class) | The SHA-1 hash of the certificate. |
| [CertThumbprintSHA256](#certthumbprintsha256-property-ipworksencrypt_dsa-class) | The SHA-256 hash of the certificate. |
| [CertUsage](#certusage-property-ipworksencrypt_dsa-class) | The text description of UsageFlags . |
| [CertUsageFlags](#certusageflags-property-ipworksencrypt_dsa-class) | The flags that show intended use for the certificate. |
| [CertVersion](#certversion-property-ipworksencrypt_dsa-class) | The certificate's version number. |
| [CertSubject](#certsubject-property-ipworksencrypt_dsa-class) | The subject of the certificate used for client authentication. |
| [CertEncoded](#certencoded-property-ipworksencrypt_dsa-class) | The certificate (PEM/Base64 encoded). |
| [HashAlgorithm](#hashalgorithm-property-ipworksencrypt_dsa-class) | The hash algorithm used for hash computation. |
| [HashSignature](#hashsignature-property-ipworksencrypt_dsa-class) | The hash signature. |
| [HashValue](#hashvalue-property-ipworksencrypt_dsa-class) | The hash value of the data. |
| [InputFile](#inputfile-property-ipworksencrypt_dsa-class) | The file to process. |
| [InputMessage](#inputmessage-property-ipworksencrypt_dsa-class) | The message to process. |
| [KeyG](#keyg-property-ipworksencrypt_dsa-class) | Represents the G parameter for the DSA algorithm. |
| [KeyP](#keyp-property-ipworksencrypt_dsa-class) | Represents the P parameter for the DSA algorithm. |
| [KeyPrivateKey](#keyprivatekey-property-ipworksencrypt_dsa-class) | This property is a PEM formatted private key. |
| [KeyPublicKey](#keypublickey-property-ipworksencrypt_dsa-class) | This property is a PEM formatted public key. |
| [KeyQ](#keyq-property-ipworksencrypt_dsa-class) | Represents the Q parameter for the DSA algorithm. |
| [KeyX](#keyx-property-ipworksencrypt_dsa-class) | Represents the X parameter for the DSA algorithm. |
| [KeyY](#keyy-property-ipworksencrypt_dsa-class) | Represents the Y parameter for the DSA algorithm. |
| [SignerCertEffectiveDate](#signercerteffectivedate-property-ipworksencrypt_dsa-class) | The date on which this certificate becomes valid. |
| [SignerCertExpirationDate](#signercertexpirationdate-property-ipworksencrypt_dsa-class) | The date on which the certificate expires. |
| [SignerCertExtendedKeyUsage](#signercertextendedkeyusage-property-ipworksencrypt_dsa-class) | A comma-delimited list of extended key usage identifiers. |
| [SignerCertFingerprint](#signercertfingerprint-property-ipworksencrypt_dsa-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [SignerCertFingerprintSHA1](#signercertfingerprintsha1-property-ipworksencrypt_dsa-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [SignerCertFingerprintSHA256](#signercertfingerprintsha256-property-ipworksencrypt_dsa-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [SignerCertIssuer](#signercertissuer-property-ipworksencrypt_dsa-class) | The issuer of the certificate. |
| [SignerCertPrivateKey](#signercertprivatekey-property-ipworksencrypt_dsa-class) | The private key of the certificate (if available). |
| [SignerCertPrivateKeyAvailable](#signercertprivatekeyavailable-property-ipworksencrypt_dsa-class) | Whether a PrivateKey is available for the selected certificate. |
| [SignerCertPrivateKeyContainer](#signercertprivatekeycontainer-property-ipworksencrypt_dsa-class) | The name of the PrivateKey container for the certificate (if available). |
| [SignerCertPublicKey](#signercertpublickey-property-ipworksencrypt_dsa-class) | The public key of the certificate. |
| [SignerCertPublicKeyAlgorithm](#signercertpublickeyalgorithm-property-ipworksencrypt_dsa-class) | The textual description of the certificate's public key algorithm. |
| [SignerCertPublicKeyLength](#signercertpublickeylength-property-ipworksencrypt_dsa-class) | The length of the certificate's public key (in bits). |
| [SignerCertSerialNumber](#signercertserialnumber-property-ipworksencrypt_dsa-class) | The serial number of the certificate encoded as a string. |
| [SignerCertSignatureAlgorithm](#signercertsignaturealgorithm-property-ipworksencrypt_dsa-class) | The text description of the certificate's signature algorithm. |
| [SignerCertStore](#signercertstore-property-ipworksencrypt_dsa-class) | The name of the certificate store for the client certificate. |
| [SignerCertStorePassword](#signercertstorepassword-property-ipworksencrypt_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. |
| [SignerCertStoreType](#signercertstoretype-property-ipworksencrypt_dsa-class) | The type of certificate store for this certificate. |
| [SignerCertSubjectAltNames](#signercertsubjectaltnames-property-ipworksencrypt_dsa-class) | Comma-separated lists of alternative subject names for the certificate. |
| [SignerCertThumbprintMD5](#signercertthumbprintmd5-property-ipworksencrypt_dsa-class) | The MD5 hash of the certificate. |
| [SignerCertThumbprintSHA1](#signercertthumbprintsha1-property-ipworksencrypt_dsa-class) | The SHA-1 hash of the certificate. |
| [SignerCertThumbprintSHA256](#signercertthumbprintsha256-property-ipworksencrypt_dsa-class) | The SHA-256 hash of the certificate. |
| [SignerCertUsage](#signercertusage-property-ipworksencrypt_dsa-class) | The text description of UsageFlags . |
| [SignerCertUsageFlags](#signercertusageflags-property-ipworksencrypt_dsa-class) | The flags that show intended use for the certificate. |
| [SignerCertVersion](#signercertversion-property-ipworksencrypt_dsa-class) | The certificate's version number. |
| [SignerCertSubject](#signercertsubject-property-ipworksencrypt_dsa-class) | The subject of the certificate used for client authentication. |
| [SignerCertEncoded](#signercertencoded-property-ipworksencrypt_dsa-class) | The certificate (PEM/Base64 encoded). |
| [SignerKeyG](#signerkeyg-property-ipworksencrypt_dsa-class) | Represents the G parameter for the DSA algorithm. |
| [SignerKeyP](#signerkeyp-property-ipworksencrypt_dsa-class) | Represents the P parameter for the DSA algorithm. |
| [SignerKeyPublicKey](#signerkeypublickey-property-ipworksencrypt_dsa-class) | This property is a PEM formatted public key. |
| [SignerKeyQ](#signerkeyq-property-ipworksencrypt_dsa-class) | Represents the Q parameter for the DSA algorithm. |
| [SignerKeyY](#signerkeyy-property-ipworksencrypt_dsa-class) | Represents the Y parameter for the DSA algorithm. |
| [UseHex](#usehex-property-ipworksencrypt_dsa-class) | Whether HashValue and HashSignature are hex encoded. |

## Method List

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

|  |  |
| --- | --- |
| [Config](#config-method-ipworksencrypt_dsa-class) | Sets or retrieves a configuration setting. |
| [CreateKey](#createkey-method-ipworksencrypt_dsa-class) | Creates a new key. |
| [Reset](#reset-method-ipworksencrypt_dsa-class) | Resets the class. |
| [Sign](#sign-method-ipworksencrypt_dsa-class) | Creates a hash signature. |
| [VerifySignature](#verifysignature-method-ipworksencrypt_dsa-class) | Verifies the signature for the specified data. |

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

|  |  |
| --- | --- |
| [Error](#error-event-ipworksencrypt_dsa-class) | Fired when information is available about errors during data delivery. |
| [Progress](#progress-event-ipworksencrypt_dsa-class) | Fired as progress is made. |

## Config Settings

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

|  |  |
| --- | --- |
| [HashSignatureFormat](#HashSignatureFormat) | The format of the HashSignature. |
| [KeyFormat](#KeyFormat) | How the public and private key are formatted. |
| [KeySize](#KeySize) | The size, in bits, of the secret key. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# CertEffectiveDate Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The date on which this certificate becomes valid.

## Object Oriented Interface

```text
public function getCertEffectiveDate();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 1 );
```

## Default Value

''

## Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

## Data Type

String

# CertExpirationDate Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The date on which the certificate expires.

## Object Oriented Interface

```text
public function getCertExpirationDate();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 2 );
```

## Default Value

''

## Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

## Data Type

String

# CertExtendedKeyUsage Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

A comma-delimited list of extended key usage identifiers.

## Object Oriented Interface

```text
public function getCertExtendedKeyUsage();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 3 );
```

## Default Value

''

## Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

## Data Type

String

# CertFingerprint Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getCertFingerprint();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 4 );
```

## Default Value

''

## Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*

This property is read-only.

## Data Type

String

# CertFingerprintSHA1 Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getCertFingerprintSHA1();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 5 );
```

## Default Value

''

## Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*

This property is read-only.

## Data Type

String

# CertFingerprintSHA256 Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getCertFingerprintSHA256();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 6 );
```

## Default Value

''

## Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*

This property is read-only.

## Data Type

String

# CertIssuer Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The issuer of the certificate.

## Object Oriented Interface

```text
public function getCertIssuer();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 7 );
```

## Default Value

''

## Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

## Data Type

String

# CertPrivateKey Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The private key of the certificate (if available).

## Object Oriented Interface

```text
public function getCertPrivateKey();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 8 );
```

## Default Value

''

## Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The [CertPrivateKey](#certprivatekey-property-ipworksencrypt_dsa-class) may be available but not exportable. In this case, [CertPrivateKey](#certprivatekey-property-ipworksencrypt_dsa-class) returns an empty string.

This property is read-only.

## Data Type

String

# CertPrivateKeyAvailable Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

Whether a PrivateKey is available for the selected certificate.

## Object Oriented Interface

```text
public function getCertPrivateKeyAvailable();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 9 );
```

## Default Value

false

## Remarks

Whether a [CertPrivateKey](#certprivatekey-property-ipworksencrypt_dsa-class) is available for the selected certificate. If [CertPrivateKeyAvailable](#certprivatekeyavailable-property-ipworksencrypt_dsa-class) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

Boolean

# CertPrivateKeyContainer Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The name of the PrivateKey container for the certificate (if available).

## Object Oriented Interface

```text
public function getCertPrivateKeyContainer();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 10 );
```

## Default Value

''

## Remarks

The name of the [CertPrivateKey](#certprivatekey-property-ipworksencrypt_dsa-class) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# CertPublicKey Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The public key of the certificate.

## Object Oriented Interface

```text
public function getCertPublicKey();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 11 );
```

## Default Value

''

## Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

## Data Type

String

# CertPublicKeyAlgorithm Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The textual description of the certificate's public key algorithm.

## Object Oriented Interface

```text
public function getCertPublicKeyAlgorithm();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 12 );
```

## Default Value

''

## Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

## Data Type

String

# CertPublicKeyLength Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The length of the certificate's public key (in bits).

## Object Oriented Interface

```text
public function getCertPublicKeyLength();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 13 );
```

## Default Value

0

## Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

## Data Type

Integer

# CertSerialNumber Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The serial number of the certificate encoded as a string.

## Object Oriented Interface

```text
public function getCertSerialNumber();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 14 );
```

## Default Value

''

## Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

## Data Type

String

# CertSignatureAlgorithm Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The text description of the certificate's signature algorithm.

## Object Oriented Interface

```text
public function getCertSignatureAlgorithm();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 15 );
```

## Default Value

''

## Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

## Data Type

String

# CertStore Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The name of the certificate store for the client certificate.

## Object Oriented Interface

```text
public function getCertStore();
public function setCertStore($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 16 );
ipworksencrypt_dsa_set($res, 16, $value );
```

## Default Value

'MY'

## Remarks

The name of the certificate store for the client certificate.

The [CertStoreType](#certstoretype-property-ipworksencrypt_dsa-class) property denotes the type of the certificate store specified by [CertStore](#certstore-property-ipworksencrypt_dsa-class). If the store is password-protected, specify the password in [CertStorePassword](#certstorepassword-property-ipworksencrypt_dsa-class).

[CertStore](#certstore-property-ipworksencrypt_dsa-class) is used in conjunction with the [CertSubject](#certsubject-property-ipworksencrypt_dsa-class) property to specify client certificates. If [CertStore](#certstore-property-ipworksencrypt_dsa-class) has a value, and [CertSubject](#certsubject-property-ipworksencrypt_dsa-class) or [CertEncoded](#certencoded-property-ipworksencrypt_dsa-class) is set, a search for a certificate is initiated. Please see the [CertSubject](#certsubject-property-ipworksencrypt_dsa-class) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, 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 ([IPWorksEncrypt_DSA](#dsa-class) Class)

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

## Object Oriented Interface

```text
public function getCertStorePassword();
public function setCertStorePassword($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 17 );
ipworksencrypt_dsa_set($res, 17, $value );
```

## 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 ([IPWorksEncrypt_DSA](#dsa-class) Class)

The type of certificate store for this certificate.

## Object Oriented Interface

```text
public function getCertStoreType();
public function setCertStoreType($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 18 );
ipworksencrypt_dsa_set($res, 18, $value );
```

## Possible Values

```text
DSA_CERTSTORETYPE_USER(0), DSA_CERTSTORETYPE_MACHINE(1), DSA_CERTSTORETYPE_PFXFILE(2), DSA_CERTSTORETYPE_PFXBLOB(3), DSA_CERTSTORETYPE_JKSFILE(4), DSA_CERTSTORETYPE_JKSBLOB(5), DSA_CERTSTORETYPE_PEMKEY_FILE(6), DSA_CERTSTORETYPE_PEMKEY_BLOB(7), DSA_CERTSTORETYPE_PUBLIC_KEY_FILE(8), DSA_CERTSTORETYPE_PUBLIC_KEY_BLOB(9), DSA_CERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), DSA_CERTSTORETYPE_P7BFILE(11), DSA_CERTSTORETYPE_P7BBLOB(12), DSA_CERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), DSA_CERTSTORETYPE_PPKFILE(14), DSA_CERTSTORETYPE_PPKBLOB(15), DSA_CERTSTORETYPE_XMLFILE(16), DSA_CERTSTORETYPE_XMLBLOB(17), DSA_CERTSTORETYPE_JWKFILE(18), DSA_CERTSTORETYPE_JWKBLOB(19), DSA_CERTSTORETYPE_SECURITY_KEY(20), DSA_CERTSTORETYPE_BCFKSFILE(21), DSA_CERTSTORETYPE_BCFKSBLOB(22), DSA_CERTSTORETYPE_PKCS11(23), DSA_CERTSTORETYPE_AUTO(99)
```

## Default Value

0

## Remarks

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:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [CertStoreType](#certstoretype-property-ipworksencrypt_dsa-class), the full path of the PKCS#11 DLL as the [CertStore](#certstore-property-ipworksencrypt_dsa-class), and the PIN as the [CertStorePassword](#certstorepassword-property-ipworksencrypt_dsa-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [CertStore](#certstore-property-ipworksencrypt_dsa-class) and set [CertStorePassword](#certstorepassword-property-ipworksencrypt_dsa-class) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

## Data Type

Integer

# CertSubjectAltNames Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

Comma-separated lists of alternative subject names for the certificate.

## Object Oriented Interface

```text
public function getCertSubjectAltNames();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 19 );
```

## Default Value

''

## Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

## Data Type

String

# CertThumbprintMD5 Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The MD5 hash of the certificate.

## Object Oriented Interface

```text
public function getCertThumbprintMD5();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 20 );
```

## Default Value

''

## Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

## Data Type

String

# CertThumbprintSHA1 Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The SHA-1 hash of the certificate.

## Object Oriented Interface

```text
public function getCertThumbprintSHA1();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 21 );
```

## Default Value

''

## Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

## Data Type

String

# CertThumbprintSHA256 Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The SHA-256 hash of the certificate.

## Object Oriented Interface

```text
public function getCertThumbprintSHA256();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 22 );
```

## Default Value

''

## Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

## Data Type

String

# CertUsage Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The text description of UsageFlags .

## Object Oriented Interface

```text
public function getCertUsage();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 23 );
```

## Default Value

''

## Remarks

The text description of [CertUsageFlags](#certusageflags-property-ipworksencrypt_dsa-class).

This value will be one or more of the following strings and will be separated by commas:

- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

## Data Type

String

# CertUsageFlags Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The flags that show intended use for the certificate.

## Object Oriented Interface

```text
public function getCertUsageFlags();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 24 );
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [CertUsageFlags](#certusageflags-property-ipworksencrypt_dsa-class) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [CertUsage](#certusage-property-ipworksencrypt_dsa-class) property for a text representation of [CertUsageFlags](#certusageflags-property-ipworksencrypt_dsa-class).

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

## Data Type

Integer

# CertVersion Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The certificate's version number.

## Object Oriented Interface

```text
public function getCertVersion();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 25 );
```

## Default Value

''

## Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

## Data Type

String

# CertSubject Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The subject of the certificate used for client authentication.

## Object Oriented Interface

```text
public function getCertSubject();
public function setCertSubject($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 26 );
ipworksencrypt_dsa_set($res, 26, $value );
```

## Default Value

''

## Remarks

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=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

## Data Type

String

# CertEncoded Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The certificate (PEM/Base64 encoded).

## Object Oriented Interface

```text
public function getCertEncoded();
public function setCertEncoded($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 27 );
ipworksencrypt_dsa_set($res, 27, $value );
```

## Default Value

''

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [CertStore](#certstore-property-ipworksencrypt_dsa-class) and [CertSubject](#certsubject-property-ipworksencrypt_dsa-class) properties also may be used to specify a certificate.

When [CertEncoded](#certencoded-property-ipworksencrypt_dsa-class) is set, a search is initiated in the current [CertStore](#certstore-property-ipworksencrypt_dsa-class) for the private key of the certificate. If the key is found, [CertSubject](#certsubject-property-ipworksencrypt_dsa-class) is updated to reflect the full subject of the selected certificate; otherwise, [CertSubject](#certsubject-property-ipworksencrypt_dsa-class) is set to an empty string.

This property is not available at design time.

## Data Type

Binary String

# HashAlgorithm Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The hash algorithm used for hash computation.

## Object Oriented Interface

```text
public function getHashAlgorithm();
public function setHashAlgorithm($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 28 );
ipworksencrypt_dsa_set($res, 28, $value );
```

## Possible Values

```text
DSA_HASHALGORITHM_SHA1(0), DSA_HASHALGORITHM_SHA224(1), DSA_HASHALGORITHM_SHA256(2), DSA_HASHALGORITHM_SHA384(3), DSA_HASHALGORITHM_SHA512(4), DSA_HASHALGORITHM_RIPEMD160(5)
```

## Default Value

2

## Remarks

This property specifies the hash algorithm used for hash computation. This is only applicable when calling [Sign](#sign-method-ipworksencrypt_dsa-class) or [VerifySignature](#verifysignature-method-ipworksencrypt_dsa-class) and [HashValue](#hashvalue-property-ipworksencrypt_dsa-class) is computed. Possible values are:

|  |  |
| --- | --- |
| 0 (dhaSHA1) | SHA-1 |
| 1 (dhaSHA224) | SHA-224 |
| 2 (dhaSHA256 - default) | SHA-256 |
| 3 (dhaSHA384) | SHA-384 |
| 4 (dhaSHA512) | SHA-512 |
| 5 (dhaRIPEMD160) | RIPEMD-160 |

## Data Type

Integer

# HashSignature Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The hash signature.

## Object Oriented Interface

```text
public function getHashSignature();
public function setHashSignature($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 29 );
ipworksencrypt_dsa_set($res, 29, $value );
```

## Default Value

''

## Remarks

This property holds the computed hash signature. This is populated after calling [Sign](#sign-method-ipworksencrypt_dsa-class). This must be set before calling [VerifySignature](#verifysignature-method-ipworksencrypt_dsa-class).

## Data Type

Binary String

# HashValue Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The hash value of the data.

## Object Oriented Interface

```text
public function getHashValue();
public function setHashValue($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 30 );
ipworksencrypt_dsa_set($res, 30, $value );
```

## Default Value

''

## Remarks

This property holds the computed hash value for the specified data. This is populated when calling [Sign](#sign-method-ipworksencrypt_dsa-class) or [VerifySignature](#verifysignature-method-ipworksencrypt_dsa-class) when an input file is specified by setting [InputFile](#inputfile-property-ipworksencrypt_dsa-class) or [InputMessage](#inputmessage-property-ipworksencrypt_dsa-class).

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](#inputfile-property-ipworksencrypt_dsa-class) or [InputMessage](#inputmessage-property-ipworksencrypt_dsa-class), the hash will be recomputed when calling [Sign](#sign-method-ipworksencrypt_dsa-class) or [VerifySignature](#verifysignature-method-ipworksencrypt_dsa-class). If the HashValue property is set, the class will only sign the hash or verify the hash signature. Setting [InputFile](#inputfile-property-ipworksencrypt_dsa-class) or [InputMessage](#inputmessage-property-ipworksencrypt_dsa-class) clears the HashValue property. Setting the HashValue property clears the input file selection.

## Data Type

Binary String

# InputFile Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The file to process.

## Object Oriented Interface

```text
public function getInputFile();
public function setInputFile($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 31 );
ipworksencrypt_dsa_set($res, 31, $value );
```

## 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:

- InputFile
- [InputMessage](#inputmessage-property-ipworksencrypt_dsa-class)

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

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

## Data Type

String

# InputMessage Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The message to process.

## Object Oriented Interface

```text
public function getInputMessage();
public function setInputMessage($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 32 );
ipworksencrypt_dsa_set($res, 32, $value );
```

## 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:

- [InputFile](#inputfile-property-ipworksencrypt_dsa-class)
- InputMessage

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

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

## Data Type

Binary String

# KeyG Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

Represents the G parameter for the DSA algorithm.

## Object Oriented Interface

```text
public function getKeyG();
public function setKeyG($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 33 );
ipworksencrypt_dsa_set($res, 33, $value );
```

## Default Value

''

## Remarks

Represents the G parameter for the DSA algorithm.

## Data Type

Binary String

# KeyP Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

Represents the P parameter for the DSA algorithm.

## Object Oriented Interface

```text
public function getKeyP();
public function setKeyP($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 34 );
ipworksencrypt_dsa_set($res, 34, $value );
```

## Default Value

''

## Remarks

Represents the P parameter for the DSA algorithm.

## Data Type

Binary String

# KeyPrivateKey Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

This property is a PEM formatted private key.

## Object Oriented Interface

```text
public function getKeyPrivateKey();
public function setKeyPrivateKey($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 35 );
ipworksencrypt_dsa_set($res, 35, $value );
```

## 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 ([IPWorksEncrypt_DSA](#dsa-class) Class)

This property is a PEM formatted public key.

## Object Oriented Interface

```text
public function getKeyPublicKey();
public function setKeyPublicKey($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 36 );
ipworksencrypt_dsa_set($res, 36, $value );
```

## 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 ([IPWorksEncrypt_DSA](#dsa-class) Class)

Represents the Q parameter for the DSA algorithm.

## Object Oriented Interface

```text
public function getKeyQ();
public function setKeyQ($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 37 );
ipworksencrypt_dsa_set($res, 37, $value );
```

## Default Value

''

## Remarks

Represents the Q parameter for the DSA algorithm.

## Data Type

Binary String

# KeyX Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

Represents the X parameter for the DSA algorithm.

## Object Oriented Interface

```text
public function getKeyX();
public function setKeyX($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 38 );
ipworksencrypt_dsa_set($res, 38, $value );
```

## Default Value

''

## Remarks

Represents the X parameter for the DSA algorithm.

## Data Type

Binary String

# KeyY Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

Represents the Y parameter for the DSA algorithm.

## Object Oriented Interface

```text
public function getKeyY();
public function setKeyY($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 39 );
ipworksencrypt_dsa_set($res, 39, $value );
```

## Default Value

''

## Remarks

Represents the Y parameter for the DSA algorithm.

## Data Type

Binary String

# SignerCertEffectiveDate Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The date on which this certificate becomes valid.

## Object Oriented Interface

```text
public function getSignerCertEffectiveDate();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 40 );
```

## Default Value

''

## Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

## Data Type

String

# SignerCertExpirationDate Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The date on which the certificate expires.

## Object Oriented Interface

```text
public function getSignerCertExpirationDate();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 41 );
```

## Default Value

''

## Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

## Data Type

String

# SignerCertExtendedKeyUsage Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

A comma-delimited list of extended key usage identifiers.

## Object Oriented Interface

```text
public function getSignerCertExtendedKeyUsage();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 42 );
```

## Default Value

''

## Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

## Data Type

String

# SignerCertFingerprint Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getSignerCertFingerprint();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 43 );
```

## Default Value

''

## Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*

This property is read-only.

## Data Type

String

# SignerCertFingerprintSHA1 Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getSignerCertFingerprintSHA1();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 44 );
```

## Default Value

''

## Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*

This property is read-only.

## Data Type

String

# SignerCertFingerprintSHA256 Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getSignerCertFingerprintSHA256();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 45 );
```

## Default Value

''

## Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*

This property is read-only.

## Data Type

String

# SignerCertIssuer Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The issuer of the certificate.

## Object Oriented Interface

```text
public function getSignerCertIssuer();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 46 );
```

## Default Value

''

## Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

## Data Type

String

# SignerCertPrivateKey Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The private key of the certificate (if available).

## Object Oriented Interface

```text
public function getSignerCertPrivateKey();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 47 );
```

## Default Value

''

## Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The [SignerCertPrivateKey](#signercertprivatekey-property-ipworksencrypt_dsa-class) may be available but not exportable. In this case, [SignerCertPrivateKey](#signercertprivatekey-property-ipworksencrypt_dsa-class) returns an empty string.

This property is read-only.

## Data Type

String

# SignerCertPrivateKeyAvailable Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

Whether a PrivateKey is available for the selected certificate.

## Object Oriented Interface

```text
public function getSignerCertPrivateKeyAvailable();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 48 );
```

## Default Value

false

## Remarks

Whether a [SignerCertPrivateKey](#signercertprivatekey-property-ipworksencrypt_dsa-class) is available for the selected certificate. If [SignerCertPrivateKeyAvailable](#signercertprivatekeyavailable-property-ipworksencrypt_dsa-class) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

Boolean

# SignerCertPrivateKeyContainer Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The name of the PrivateKey container for the certificate (if available).

## Object Oriented Interface

```text
public function getSignerCertPrivateKeyContainer();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 49 );
```

## Default Value

''

## Remarks

The name of the [SignerCertPrivateKey](#signercertprivatekey-property-ipworksencrypt_dsa-class) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# SignerCertPublicKey Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The public key of the certificate.

## Object Oriented Interface

```text
public function getSignerCertPublicKey();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 50 );
```

## Default Value

''

## Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

## Data Type

String

# SignerCertPublicKeyAlgorithm Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The textual description of the certificate's public key algorithm.

## Object Oriented Interface

```text
public function getSignerCertPublicKeyAlgorithm();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 51 );
```

## Default Value

''

## Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

## Data Type

String

# SignerCertPublicKeyLength Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The length of the certificate's public key (in bits).

## Object Oriented Interface

```text
public function getSignerCertPublicKeyLength();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 52 );
```

## Default Value

0

## Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

## Data Type

Integer

# SignerCertSerialNumber Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The serial number of the certificate encoded as a string.

## Object Oriented Interface

```text
public function getSignerCertSerialNumber();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 53 );
```

## Default Value

''

## Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

## Data Type

String

# SignerCertSignatureAlgorithm Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The text description of the certificate's signature algorithm.

## Object Oriented Interface

```text
public function getSignerCertSignatureAlgorithm();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 54 );
```

## Default Value

''

## Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

## Data Type

String

# SignerCertStore Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The name of the certificate store for the client certificate.

## Object Oriented Interface

```text
public function getSignerCertStore();
public function setSignerCertStore($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 55 );
ipworksencrypt_dsa_set($res, 55, $value );
```

## Default Value

'MY'

## Remarks

The name of the certificate store for the client certificate.

The [SignerCertStoreType](#signercertstoretype-property-ipworksencrypt_dsa-class) property denotes the type of the certificate store specified by [SignerCertStore](#signercertstore-property-ipworksencrypt_dsa-class). If the store is password-protected, specify the password in [SignerCertStorePassword](#signercertstorepassword-property-ipworksencrypt_dsa-class).

[SignerCertStore](#signercertstore-property-ipworksencrypt_dsa-class) is used in conjunction with the [SignerCertSubject](#signercertsubject-property-ipworksencrypt_dsa-class) property to specify client certificates. If [SignerCertStore](#signercertstore-property-ipworksencrypt_dsa-class) has a value, and [SignerCertSubject](#signercertsubject-property-ipworksencrypt_dsa-class) or [SignerCertEncoded](#signercertencoded-property-ipworksencrypt_dsa-class) is set, a search for a certificate is initiated. Please see the [SignerCertSubject](#signercertsubject-property-ipworksencrypt_dsa-class) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, 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 ([IPWorksEncrypt_DSA](#dsa-class) Class)

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

## Object Oriented Interface

```text
public function getSignerCertStorePassword();
public function setSignerCertStorePassword($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 56 );
ipworksencrypt_dsa_set($res, 56, $value );
```

## 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 ([IPWorksEncrypt_DSA](#dsa-class) Class)

The type of certificate store for this certificate.

## Object Oriented Interface

```text
public function getSignerCertStoreType();
public function setSignerCertStoreType($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 57 );
ipworksencrypt_dsa_set($res, 57, $value );
```

## Possible Values

```text
DSA_SIGNERCERTSTORETYPE_USER(0), DSA_SIGNERCERTSTORETYPE_MACHINE(1), DSA_SIGNERCERTSTORETYPE_PFXFILE(2), DSA_SIGNERCERTSTORETYPE_PFXBLOB(3), DSA_SIGNERCERTSTORETYPE_JKSFILE(4), DSA_SIGNERCERTSTORETYPE_JKSBLOB(5), DSA_SIGNERCERTSTORETYPE_PEMKEY_FILE(6), DSA_SIGNERCERTSTORETYPE_PEMKEY_BLOB(7), DSA_SIGNERCERTSTORETYPE_PUBLIC_KEY_FILE(8), DSA_SIGNERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), DSA_SIGNERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), DSA_SIGNERCERTSTORETYPE_P7BFILE(11), DSA_SIGNERCERTSTORETYPE_P7BBLOB(12), DSA_SIGNERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), DSA_SIGNERCERTSTORETYPE_PPKFILE(14), DSA_SIGNERCERTSTORETYPE_PPKBLOB(15), DSA_SIGNERCERTSTORETYPE_XMLFILE(16), DSA_SIGNERCERTSTORETYPE_XMLBLOB(17), DSA_SIGNERCERTSTORETYPE_JWKFILE(18), DSA_SIGNERCERTSTORETYPE_JWKBLOB(19), DSA_SIGNERCERTSTORETYPE_SECURITY_KEY(20), DSA_SIGNERCERTSTORETYPE_BCFKSFILE(21), DSA_SIGNERCERTSTORETYPE_BCFKSBLOB(22), DSA_SIGNERCERTSTORETYPE_PKCS11(23), DSA_SIGNERCERTSTORETYPE_AUTO(99)
```

## Default Value

0

## Remarks

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:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SignerCertStoreType](#signercertstoretype-property-ipworksencrypt_dsa-class), the full path of the PKCS#11 DLL as the [SignerCertStore](#signercertstore-property-ipworksencrypt_dsa-class), and the PIN as the [SignerCertStorePassword](#signercertstorepassword-property-ipworksencrypt_dsa-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SignerCertStore](#signercertstore-property-ipworksencrypt_dsa-class) and set [SignerCertStorePassword](#signercertstorepassword-property-ipworksencrypt_dsa-class) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

## Data Type

Integer

# SignerCertSubjectAltNames Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

Comma-separated lists of alternative subject names for the certificate.

## Object Oriented Interface

```text
public function getSignerCertSubjectAltNames();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 58 );
```

## Default Value

''

## Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

## Data Type

String

# SignerCertThumbprintMD5 Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The MD5 hash of the certificate.

## Object Oriented Interface

```text
public function getSignerCertThumbprintMD5();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 59 );
```

## Default Value

''

## Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

## Data Type

String

# SignerCertThumbprintSHA1 Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The SHA-1 hash of the certificate.

## Object Oriented Interface

```text
public function getSignerCertThumbprintSHA1();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 60 );
```

## Default Value

''

## Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

## Data Type

String

# SignerCertThumbprintSHA256 Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The SHA-256 hash of the certificate.

## Object Oriented Interface

```text
public function getSignerCertThumbprintSHA256();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 61 );
```

## Default Value

''

## Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

## Data Type

String

# SignerCertUsage Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The text description of UsageFlags .

## Object Oriented Interface

```text
public function getSignerCertUsage();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 62 );
```

## Default Value

''

## Remarks

The text description of [SignerCertUsageFlags](#signercertusageflags-property-ipworksencrypt_dsa-class).

This value will be one or more of the following strings and will be separated by commas:

- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

## Data Type

String

# SignerCertUsageFlags Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The flags that show intended use for the certificate.

## Object Oriented Interface

```text
public function getSignerCertUsageFlags();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 63 );
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [SignerCertUsageFlags](#signercertusageflags-property-ipworksencrypt_dsa-class) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [SignerCertUsage](#signercertusage-property-ipworksencrypt_dsa-class) property for a text representation of [SignerCertUsageFlags](#signercertusageflags-property-ipworksencrypt_dsa-class).

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

## Data Type

Integer

# SignerCertVersion Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The certificate's version number.

## Object Oriented Interface

```text
public function getSignerCertVersion();
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 64 );
```

## Default Value

''

## Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

## Data Type

String

# SignerCertSubject Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The subject of the certificate used for client authentication.

## Object Oriented Interface

```text
public function getSignerCertSubject();
public function setSignerCertSubject($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 65 );
ipworksencrypt_dsa_set($res, 65, $value );
```

## Default Value

''

## Remarks

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=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

## Data Type

String

# SignerCertEncoded Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

The certificate (PEM/Base64 encoded).

## Object Oriented Interface

```text
public function getSignerCertEncoded();
public function setSignerCertEncoded($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 66 );
ipworksencrypt_dsa_set($res, 66, $value );
```

## Default Value

''

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SignerCertStore](#signercertstore-property-ipworksencrypt_dsa-class) and [SignerCertSubject](#signercertsubject-property-ipworksencrypt_dsa-class) properties also may be used to specify a certificate.

When [SignerCertEncoded](#signercertencoded-property-ipworksencrypt_dsa-class) is set, a search is initiated in the current [SignerCertStore](#signercertstore-property-ipworksencrypt_dsa-class) for the private key of the certificate. If the key is found, [SignerCertSubject](#signercertsubject-property-ipworksencrypt_dsa-class) is updated to reflect the full subject of the selected certificate; otherwise, [SignerCertSubject](#signercertsubject-property-ipworksencrypt_dsa-class) is set to an empty string.

This property is not available at design time.

## Data Type

Binary String

# SignerKeyG Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

Represents the G parameter for the DSA algorithm.

## Object Oriented Interface

```text
public function getSignerKeyG();
public function setSignerKeyG($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 67 );
ipworksencrypt_dsa_set($res, 67, $value );
```

## Default Value

''

## Remarks

Represents the G parameter for the DSA algorithm.

## Data Type

Binary String

# SignerKeyP Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

Represents the P parameter for the DSA algorithm.

## Object Oriented Interface

```text
public function getSignerKeyP();
public function setSignerKeyP($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 68 );
ipworksencrypt_dsa_set($res, 68, $value );
```

## Default Value

''

## Remarks

Represents the P parameter for the DSA algorithm.

## Data Type

Binary String

# SignerKeyPublicKey Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

This property is a PEM formatted public key.

## Object Oriented Interface

```text
public function getSignerKeyPublicKey();
public function setSignerKeyPublicKey($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 70 );
ipworksencrypt_dsa_set($res, 70, $value );
```

## 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 ([IPWorksEncrypt_DSA](#dsa-class) Class)

Represents the Q parameter for the DSA algorithm.

## Object Oriented Interface

```text
public function getSignerKeyQ();
public function setSignerKeyQ($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 71 );
ipworksencrypt_dsa_set($res, 71, $value );
```

## Default Value

''

## Remarks

Represents the Q parameter for the DSA algorithm.

## Data Type

Binary String

# SignerKeyY Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

Represents the Y parameter for the DSA algorithm.

## Object Oriented Interface

```text
public function getSignerKeyY();
public function setSignerKeyY($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 73 );
ipworksencrypt_dsa_set($res, 73, $value );
```

## Default Value

''

## Remarks

Represents the Y parameter for the DSA algorithm.

## Data Type

Binary String

# UseHex Property ([IPWorksEncrypt_DSA](#dsa-class) Class)

Whether HashValue and HashSignature are hex encoded.

## Object Oriented Interface

```text
public function getUseHex();
public function setUseHex($value);
```

## Procedural Interface

```text
ipworksencrypt_dsa_get($res, 74 );
ipworksencrypt_dsa_set($res, 74, $value );
```

## Default Value

false

## Remarks

This property specifies whether [HashValue](#hashvalue-property-ipworksencrypt_dsa-class) and [HashSignature](#hashsignature-property-ipworksencrypt_dsa-class) are hex encoded.

If set to True, when [Sign](#sign-method-ipworksencrypt_dsa-class) is called the class will compute the hash for the specified file and populate [HashValue](#hashvalue-property-ipworksencrypt_dsa-class) with the hex encoded hash value. It will then create the hash signature and populate [HashSignature](#hashsignature-property-ipworksencrypt_dsa-class) with the hex encoded hash signature value. If [HashValue](#hashvalue-property-ipworksencrypt_dsa-class) is specified directly, it must be a hex encoded value.

If set to True, when [VerifySignature](#verifysignature-method-ipworksencrypt_dsa-class) is called the class will compute the hash value for the specified file and populate [HashValue](#hashvalue-property-ipworksencrypt_dsa-class) with the hex encoded hash value. It will then hex decode [HashSignature](#hashsignature-property-ipworksencrypt_dsa-class) and verify the signature. [HashSignature](#hashsignature-property-ipworksencrypt_dsa-class) must hold a hex encoded value. If [HashValue](#hashvalue-property-ipworksencrypt_dsa-class) is specified directly, it must be a hex encoded value.

## Data Type

Boolean

# Config Method ([IPWorksEncrypt_DSA](#dsa-class) Class)

Sets or retrieves a configuration setting.

## Object Oriented Interface

```text
public function doConfig($configurationstring);
```

## Procedural Interface

```text
ipworksencrypt_dsa_do_config($res, $configurationstring);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-dsa-class) 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](#config-settings-dsa-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

# CreateKey Method ([IPWorksEncrypt_DSA](#dsa-class) Class)

Creates a new key.

## Object Oriented Interface

```text
public function doCreateKey();
```

## Procedural Interface

```text
ipworksencrypt_dsa_do_createkey($res);
```

## 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 property is populated with a new private and public key.

After calling [Sign](#sign-method-ipworksencrypt_dsa-class) the public key must be sent to the recipient along with [HashSignature](#hashsignature-property-ipworksencrypt_dsa-class) so they may perform signature verification. Likewise you must obtain the public key along with [HashSignature](#hashsignature-property-ipworksencrypt_dsa-class) in order to perform signature verification.

The public key consists of the following parameters:

- [KeyP](#keyp-property-ipworksencrypt_dsa-class)
- [KeyQ](#keyq-property-ipworksencrypt_dsa-class)
- [KeyG](#keyg-property-ipworksencrypt_dsa-class)
- [KeyY](#keyy-property-ipworksencrypt_dsa-class)

The class also includes the [KeyPublicKey](#keypublickey-property-ipworksencrypt_dsa-class) 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](#keypublickey-property-ipworksencrypt_dsa-class) in which case the individual parameters must be sent.

The private key consists of the following parameters:

- [KeyP](#keyp-property-ipworksencrypt_dsa-class)
- [KeyQ](#keyq-property-ipworksencrypt_dsa-class)
- [KeyG](#keyg-property-ipworksencrypt_dsa-class)
- [KeyY](#keyy-property-ipworksencrypt_dsa-class)
- [KeyX](#keyx-property-ipworksencrypt_dsa-class)

 The class also include the [KeyPrivateKey](#keyprivatekey-property-ipworksencrypt_dsa-class) property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

# Reset Method ([IPWorksEncrypt_DSA](#dsa-class) Class)

Resets the class.

## Object Oriented Interface

```text
public function doReset();
```

## Procedural Interface

```text
ipworksencrypt_dsa_do_reset($res);
```

## Remarks

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

# Sign Method ([IPWorksEncrypt_DSA](#dsa-class) Class)

Creates a hash signature.

## Object Oriented Interface

```text
public function doSign();
```

## Procedural Interface

```text
ipworksencrypt_dsa_do_sign($res);
```

## Remarks

This method will create a hash signature.

Before calling this method specify the input file by setting [InputFile](#inputfile-property-ipworksencrypt_dsa-class) or [InputMessage](#inputmessage-property-ipworksencrypt_dsa-class).

A key is required to create the hash signature. You may create a new key by calling [CreateKey](#createkey-method-ipworksencrypt_dsa-class), 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](#hashvalue-property-ipworksencrypt_dsa-class). It will then create the hash signature using the specified Key and populate [HashSignature](#hashsignature-property-ipworksencrypt_dsa-class).

To create the hash signature without first computing the hash simply specify [HashValue](#hashvalue-property-ipworksencrypt_dsa-class) before calling this method.

The [Progress](#progress-event-ipworksencrypt_dsa-class) event will fire with updates for the hash computation progress only. The hash signature creation process is quick and does not require progress updates.

# VerifySignature Method ([IPWorksEncrypt_DSA](#dsa-class) Class)

Verifies the signature for the specified data.

## Object Oriented Interface

```text
public function doVerifySignature();
```

## Procedural Interface

```text
ipworksencrypt_dsa_do_verifysignature($res);
```

## Remarks

This method will verify a hash signature.

Before calling this method specify the input file by setting [InputFile](#inputfile-property-ipworksencrypt_dsa-class) or [InputMessage](#inputmessage-property-ipworksencrypt_dsa-class).

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](#hashsignature-property-ipworksencrypt_dsa-class).

When this method is called the class will compute the hash for the specified file and populate [HashValue](#hashvalue-property-ipworksencrypt_dsa-class). It will verify the signature using the specified SignerKey and [HashSignature](#hashsignature-property-ipworksencrypt_dsa-class).

To verify the hash signature without first computing the hash simply specify [HashValue](#hashvalue-property-ipworksencrypt_dsa-class) before calling this method.

The [Progress](#progress-event-ipworksencrypt_dsa-class) 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 Event ([IPWorksEncrypt_DSA](#dsa-class) Class)

Fired when information is available about errors during data delivery.

## Object Oriented Interface

```text
public function fireError($param);
```

## Procedural Interface

```text
ipworksencrypt_dsa_register_callback($res, 1, array($this, 'fireError'));
```

## Parameter List

```text
 'errorcode' 'description'
```

## 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](#trappable-errors-dsa-class) section.

# Progress Event ([IPWorksEncrypt_DSA](#dsa-class) Class)

Fired as progress is made.

## Object Oriented Interface

```text
public function fireProgress($param);
```

## Procedural Interface

```text
ipworksencrypt_dsa_register_callback($res, 2, array($this, 'fireProgress'));
```

## Parameter List

```text
 'bytesprocessed' 'percentprocessed'
```

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

# Config Settings ([DSA](#dsa-class) Class)

 The class accepts one or more of the following *configuration settings*. Configuration 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](#config-method-ipworksencrypt_dsa-class) method.

### DSA Config Settings

**HashSignatureFormat**: The format of the HashSignature.This setting specifies the format of [HashSignature](#hashsignature-property-ipworksencrypt_dsa-class) when calling [Sign](#sign-method-ipworksencrypt_dsa-class). The way the [HashSignature](#hashsignature-property-ipworksencrypt_dsa-class) parameters are represented can be changed to be interoperable with other implementations. Possible values are:

|  |  |
| --- | --- |
| 0 (Concatenated - default) | Compatible with Windows/.NET |
| 1 (ASN) | Compatible with OpenSSL/Mac/iOS |

 The default value is 0 (Concatenated). This setting is only applicable when calling [Sign](#sign-method-ipworksencrypt_dsa-class). When calling [VerifySignature](#verifysignature-method-ipworksencrypt_dsa-class) the format is automatically determined by the class.

**KeyFormat**: How the public and private key are formatted.This setting controls the format of [KeyPublicKey](#keypublickey-property-ipworksencrypt_dsa-class) and [KeyPrivateKey](#keyprivatekey-property-ipworksencrypt_dsa-class). By default these properties hold PEM formatted public and private key data. When set to 1 (XML) the keys are stored in a XML format. This only affects the values returned by the class; the actual keys remain the same regardless of this setting. Possible values are:

- 0 (PEM - PKCS#1)
- 1 (XML)
- 2 (PEM - PKCS#8 - default)

 The default value is 2 (PEM - PKCS#8).

**KeySize**: The size, in bits, of the secret key.This specifies the size, in bits, of the secret key. The minimum key size for DSA is 512. The maximum key size is 4096. Note that large values such as 4096 will impact performance. The default value is 1024.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

**SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

**UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *true*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article.

NOTE: This setting is applicable only on Windows.

NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([DSA](#dsa-class) Class)

### DSA Errors

|  |  |
| --- | --- |
| 102 | No Key specified. |
| 104 | Cannot read or write file. |
| 105 | Key parameters incorrect. |
| 106 | Cannot create hash. |
| 113 | Input data or HashValue must be specified. |
| 121 | Invalid certificate. |
| 124 | HashSignature must be specified. |
| 304 | Cannot write file. |
| 305 | Cannot read file. |
| 1201 | Specified DSA parameters are invalid. |
| 1202 | Missing hash value. |
| 1203 | Public key must be specified. |
| 1204 | Key must be specified. |
| 1205 | HashSignature must be specified. |
| 1206 | Invalid key size. |