---
product: Chilkat
product_version: 11.7.0
language: phpx
language_label: PHP ActiveX
class: Dsa
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/phpDsaRef.html
---
# Chilkat Dsa — PHP ActiveX — v11.7.0

> Chilkat 11.7.0 · language=phpx · class=Dsa
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Dsa.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpx/guide.md`.

## Purpose

**Generate, import, export, sign, and verify DSA keys and signatures.**

`Chilkat.Dsa` is the Chilkat class for DSA key generation, DSA key import/export, DSA hash signing, and DSA signature verification. It supports private and public keys in DER, PEM, encrypted PEM, XML, explicit component, and OpenSSL parameter workflows. It also exposes DSA key components as hex-encoded SSH1-format bignums and provides helpers for working with encoded hashes and signatures.

**Generate DSA keys**

Create DSA key pairs and parameters for workflows that still require DSA-based signing or verification.

**Import and export keys**

Load and save private or public DSA keys in DER, PEM, encrypted PEM, XML, component-based, and OpenSSL-compatible formats.

**Sign hashes**

Create DSA signatures over message digests using a loaded private key and the appropriate encoded hash input.

**Verify signatures**

Verify DSA signatures using a public key, encoded hash, and signature data.

**Key components**

Access DSA parameters and key components as hex-encoded SSH1-format bignums for low-level interoperability scenarios.

**Encoded data helpers**

Work with encoded hashes and signatures when applications need hex, Base64, or other textual representations of binary values.

**Common pattern:** Load or generate a DSA key, compute the message hash with the desired hash algorithm, then use `Dsa` to sign the hash with the private key or verify the signature with the public key. For new protocol designs, consider whether a more modern signature algorithm is preferred; use this class when DSA is required for compatibility.

For an extended overview, see [Dsa Class Overview](https://www.chilkatsoft.com/dsa_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```php
Chilkat v10.0.0 or greater:
$obj = new COM("Chilkat.Dsa");
Chilkat v9.5.0.*:
$obj = new COM("Chilkat_9_5_0.Dsa");
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in PHP ActiveX.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `string DebugLogFilePath` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `VARIANT LastBinaryResult (read-only)` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `string LastErrorHtml (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string LastErrorText (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string LastErrorXml (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `bool LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `LastStringResult` | `string LastStringResult (read-only)` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `int LastStringResultLen (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `bool VerboseLogging` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string Version (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `GroupSize` | property, read/write | `int GroupSize` |
| `Hash` | property, read/write | `VARIANT Hash` |
| `HexG` | property, read-only | `string HexG (read-only)` |
| `HexP` | property, read-only | `string HexP (read-only)` |
| `HexQ` | property, read-only | `string HexQ (read-only)` |
| `HexX` | property, read-only | `string HexX (read-only)` |
| `HexY` | property, read-only | `string HexY (read-only)` |
| `Signature` | property, read/write | `VARIANT Signature` |
| `UncommonOptions` | property, read/write | `string UncommonOptions` |
| `FromDer` | method | `bool FromDer(VARIANT derData)` |
| `FromDerBd` | method | `bool FromDerBd(Chilkat.BinData bd)` |
| `FromDerFile` | method | `bool FromDerFile(string path)` |
| `FromEncryptedPem` | method | `bool FromEncryptedPem(string password, string pemData)` |
| `FromPem` | method | `bool FromPem(string pemData)` |
| `FromPublicDer` | method | `bool FromPublicDer(VARIANT derData)` |
| `FromPublicDerBd` | method | `bool FromPublicDerBd(Chilkat.BinData bd)` |
| `FromPublicDerFile` | method | `bool FromPublicDerFile(string path)` |
| `FromPublicPem` | method | `bool FromPublicPem(string pemData)` |
| `FromXml` | method | `bool FromXml(string xmlKey)` |
| `GenKey` | method | `bool GenKey(int numBits)` |
| `GenKey2` | method | `bool GenKey2(int keyLenBits, int modLenBits)` |
| `GenKeyFromParamsDer` | method | `bool GenKeyFromParamsDer(VARIANT derBytes)` |
| `GenKeyFromParamsDerBd` | method | `bool GenKeyFromParamsDerBd(Chilkat.BinData bd)` |
| `GenKeyFromParamsDerFile` | method | `bool GenKeyFromParamsDerFile(string path)` |
| `GenKeyFromParamsPem` | method | `bool GenKeyFromParamsPem(string pem)` |
| `GenKeyFromParamsPemFile` | method | `bool GenKeyFromParamsPemFile(string path)` |
| `GenKeyFromPQG` | method | `bool GenKeyFromPQG(string pHex, string qHex, string gHex)` |
| `GetEncodedHash` | method | `string GetEncodedHash(string encoding)` |
| `GetEncodedSignature` | method | `string GetEncodedSignature(string encoding)` |
| `LoadText` | method | `string LoadText(string path)` |
| `SaveText` | method | `bool SaveText(string strToSave, string path)` |
| `SetEncodedHash` | method | `bool SetEncodedHash(string encoding, string encodedHash)` |
| `SetEncodedSignature` | method | `bool SetEncodedSignature(string encoding, string encodedSig)` |
| `SetEncodedSignatureRS` | method | `bool SetEncodedSignatureRS(string encoding, string encodedR, string encodedS)` |
| `SetKeyExplicit` | method | `bool SetKeyExplicit(int groupSizeInBytes, string pHex, string qHex, string gHex, string xHex)` |
| `SetPubKeyExplicit` | method | `bool SetPubKeyExplicit(int groupSizeInBytes, string pHex, string qHex, string gHex, string yHex)` |
| `SignHash` | method | `bool SignHash()` |
| `ToDer` | method | `VARIANT ToDer()` |
| `ToDerBd` | method | `bool ToDerBd(Chilkat.BinData bd)` |
| `ToDerFile` | method | `bool ToDerFile(string path)` |
| `ToEncryptedPem` | method | `string ToEncryptedPem(string password)` |
| `ToPem` | method | `string ToPem()` |
| `ToPublicDer` | method | `VARIANT ToPublicDer()` |
| `ToPublicDerBd` | method | `bool ToPublicDerBd(Chilkat.BinData bd)` |
| `ToPublicDerFile` | method | `bool ToPublicDerFile(string path)` |
| `ToPublicPem` | method | `string ToPublicPem()` |
| `ToXml` | method | `string ToXml(bool bPublicOnly)` |
| `Verify` | method | `bool Verify()` |
| `VerifyKey` | method | `bool VerifyKey()` |

## Properties

### Dsa.GroupSize

`Chilkat 11.7.0 · phpx · Dsa · GroupSize · property · read/write`

```php
int GroupSize
```

Specifies the size, in bits, of the DSA subgroup parameter `Q` used by the legacy `GenKey` method. The default is `160`. This also determines the natural size of the DSA signature components `r` and `s`.

Applications should normally leave this property at its default. When an explicit standards-era `(L, N)` parameter pair is required, use `GenKey2`, where `L` is the bit length of `P` and `N` is the bit length of `Q`.

**Legacy algorithm:** NIST FIPS 186-5 no longer approves DSA for generating new digital signatures. Retain DSA generation and signing only for interoperability with systems or data formats that specifically require it; DSA verification remains useful for legacy signatures.

### Dsa.Hash

`Chilkat 11.7.0 · phpx · Dsa · Hash · property · read/write`

```php
VARIANT Hash
```

Contains the message digest to be signed by `SignHash` or checked by `Verify`. Set this property before calling either method. The same value can also be supplied in encoded form with `SetEncodedHash`.

The `Dsa` class does not hash the original message. The application must compute the exact digest required by the protocol or file format and provide the resulting bytes here.

**Important:** Signing and verification must use identical digest bytes. A different hash algorithm, text encoding, canonicalization rule, or line-ending convention produces a different digest and causes verification to fail.

### Dsa.HexG

`Chilkat 11.7.0 · phpx · Dsa · HexG · property · read-only`

```php
string HexG (read-only)
```

Returns the DSA domain parameter `G`, the generator of the subgroup of order `Q` modulo `P`.

The returned text is a hexadecimal encoding of Chilkat's SSH1-format bignum representation, which includes a two-byte bit-length prefix followed by the unsigned integer bytes.

### Dsa.HexP

`Chilkat 11.7.0 · phpx · Dsa · HexP · property · read-only`

```php
string HexP (read-only)
```

Returns the DSA domain parameter `P`, the large prime modulus.

The returned text is a hexadecimal encoding of Chilkat's SSH1-format bignum representation, which includes a two-byte bit-length prefix followed by the unsigned integer bytes.

### Dsa.HexQ

`Chilkat 11.7.0 · phpx · Dsa · HexQ · property · read-only`

```php
string HexQ (read-only)
```

Returns the DSA domain parameter `Q`, a prime divisor of `P - 1`. The bit length of `Q` is commonly written as `N` and determines the range of the private value `X` and signature components `r` and `s`.

The returned text is a hexadecimal encoding of Chilkat's SSH1-format bignum representation, which includes a two-byte bit-length prefix followed by the unsigned integer bytes.

### Dsa.HexX

`Chilkat 11.7.0 · phpx · Dsa · HexX · property · read-only`

```php
string HexX (read-only)
```

Returns the DSA private value `X`. It is present only when the object contains a private key and satisfies `0 < X < Q`.

The returned text is a hexadecimal encoding of Chilkat's SSH1-format bignum representation, which includes a two-byte bit-length prefix followed by the unsigned integer bytes.

**Sensitive value:** Anyone who obtains `X` can create signatures as the key owner. Do not log, transmit, or persist this value unless it is protected as private-key material.

### Dsa.HexY

`Chilkat 11.7.0 · phpx · Dsa · HexY · property · read-only`

```php
string HexY (read-only)
```

Returns the DSA public value `Y`, where `Y = GX mod P`. It is available when either a public or private DSA key is loaded.

The returned text is a hexadecimal encoding of Chilkat's SSH1-format bignum representation, which includes a two-byte bit-length prefix followed by the unsigned integer bytes.

### Dsa.Signature

`Chilkat 11.7.0 · phpx · Dsa · Signature · property · read/write`

```php
VARIANT Signature
```

Contains the DSA signature produced by `SignHash`. Before calling `Verify`, set this property to the signature being checked, or use `SetEncodedSignature` or `SetEncodedSignatureRS`.

Chilkat represents the signature as an ASN.1 DER `SEQUENCE` containing the two DSA integers `r` and `s`. Use `GetEncodedSignature` to obtain a hexadecimal or Base64 representation.

### Dsa.UncommonOptions

`Chilkat 11.7.0 · phpx · Dsa · UncommonOptions · property · read/write · since 9.5.0.90`

```php
string UncommonOptions
```

Reserved for uncommon or compatibility-specific options. The default is the empty string, and applications should normally leave this property unchanged unless Chilkat documentation or support identifies a specific keyword required for the target system.

## Methods

### Dsa.FromDer

`Chilkat 11.7.0 · phpx · Dsa · FromDer · method`

```php
bool FromDer(VARIANT derData)
```

Loads a DSA private key from the DER-encoded bytes in `derData`. On success, the object contains both the private and public key components and can sign or verify digests.

**Private-key handling:** The input contains secret key material. Keep it out of logs and protect any storage or transport that carries these bytes.

Returns true for success, false for failure.

### Dsa.FromDerBd

`Chilkat 11.7.0 · phpx · Dsa · FromDerBd · method · since 11.0.0`

```php
bool FromDerBd(Chilkat.BinData bd)
```

Loads a DSA private key from the DER bytes contained in the `BinData` object passed in `bd`. Returns `true` on successful decoding.

**Private-key handling:** The `BinData` content contains secret key material and should be cleared or released when no longer needed.

Returns true for success, false for failure.

### Dsa.FromDerFile

`Chilkat 11.7.0 · phpx · Dsa · FromDerFile · method`

```php
bool FromDerFile(string path)
```

Loads a DSA private key from the DER-encoded file specified by `path`. Returns `true` when the file is read and decoded successfully; otherwise returns `false`.

**Private-key handling:** Restrict access to the file because it contains secret key material. Check `LastErrorText` when loading fails.

Returns true for success, false for failure.

### Dsa.FromEncryptedPem

`Chilkat 11.7.0 · phpx · Dsa · FromEncryptedPem · method`

```php
bool FromEncryptedPem(string password, string pemData)
```

Loads a DSA private key from the PEM text in `pemData`. `password` supplies the password when the PEM is encrypted. If the PEM is unencrypted, the password is ignored and the key is loaded normally.

Returns `true` on success and `false` if the PEM cannot be decoded, the password is incorrect, or the contained key is not a supported DSA private key.

**Security:** Do not embed production passwords in source code or log the PEM text. Prefer protected secret storage and encrypted private-key files where practical.

Returns true for success, false for failure.

### Dsa.FromPem

`Chilkat 11.7.0 · phpx · Dsa · FromPem · method`

```php
bool FromPem(string pemData)
```

Loads an unencrypted DSA private key from the PEM text in `pemData`. On success, the object contains the private key and its corresponding public components.

**Unencrypted private key:** PEM armor is only a text encoding; it does not protect the private key. Treat the string as highly sensitive and use `FromEncryptedPem` when password-protected PEM is available.

Returns true for success, false for failure.

### Dsa.FromPublicDer

`Chilkat 11.7.0 · phpx · Dsa · FromPublicDer · method`

```php
bool FromPublicDer(VARIANT derData)
```

Loads a DSA public key from the DER-encoded bytes in `derData`. A public key can be used with `Verify` and can be exported, but it cannot be used by `SignHash`.

Returns true for success, false for failure.

### Dsa.FromPublicDerBd

`Chilkat 11.7.0 · phpx · Dsa · FromPublicDerBd · method · since 11.0.0`

```php
bool FromPublicDerBd(Chilkat.BinData bd)
```

Loads a DSA public key from the DER bytes contained in the `BinData` object passed in `bd`. The resulting key can verify signatures but cannot sign.

Returns true for success, false for failure.

### Dsa.FromPublicDerFile

`Chilkat 11.7.0 · phpx · Dsa · FromPublicDerFile · method`

```php
bool FromPublicDerFile(string path)
```

Loads a DSA public key from the DER-encoded file specified by `path`. Returns `true` when the file is read and decoded successfully; otherwise returns `false`.

Returns true for success, false for failure.

### Dsa.FromPublicPem

`Chilkat 11.7.0 · phpx · Dsa · FromPublicPem · method`

```php
bool FromPublicPem(string pemData)
```

Loads a DSA public key from the PEM text in `pemData`. Returns `true` when the PEM contains a supported DSA public key and is decoded successfully.

Returns true for success, false for failure.

### Dsa.FromXml

`Chilkat 11.7.0 · phpx · Dsa · FromXml · method`

```php
bool FromXml(string xmlKey)
```

Loads a DSA public or private key from the XML text in `xmlKey`. The XML content determines whether the resulting object contains public components only or also includes the private value `X`.

**Security:** XML is only a representation format. If the XML contains `X`, it contains the complete private key and must be protected accordingly.

Returns true for success, false for failure.

### Dsa.GenKey

`Chilkat 11.7.0 · phpx · Dsa · GenKey · method`

```php
bool GenKey(int numBits)
```

Generates a new DSA key pair with a `P` size of `numBits` bits. `numBits` must be at least 1024 and a multiple of 64. This legacy method uses the subgroup size selected by `GroupSize`, whose default is 160 bits.

For explicit standard parameter pairs such as `(2048, 224)` or `(3072, 256)`, use `GenKey2`.

**Legacy algorithm:** DSA signature generation is no longer approved by FIPS 186-5. Generate new DSA keys only when required for compatibility with an existing protocol, key store, or signature format.

Returns true for success, false for failure.

### Dsa.GenKey2

`Chilkat 11.7.0 · phpx · Dsa · GenKey2 · method · since 9.5.0.90`

```php
bool GenKey2(int keyLenBits, int modLenBits)
```

Generates a new DSA key pair using an explicit `(L, N)` parameter-size combination. `keyLenBits` is `L`, the bit length of the prime modulus `P`. `modLenBits` is `N`, the bit length of the subgroup prime `Q`.

| L | N | Historical FIPS 186-4 combination |
| :--- | :--- | :--- |
| `1024` | `160` | Legacy |
| `2048` | `224` or `256` | Supported parameter pairs |
| `3072` | `256` | Largest listed pair |

**Current standards status:** These combinations come from the superseded FIPS 186-4 DSA specification. FIPS 186-5 no longer approves DSA signature generation; use this method only for compatibility.

Returns true for success, false for failure.

### Dsa.GenKeyFromParamsDer

`Chilkat 11.7.0 · phpx · Dsa · GenKeyFromParamsDer · method`

```php
bool GenKeyFromParamsDer(VARIANT derBytes)
```

Generates a new DSA key pair from OpenSSL-style DSA parameters supplied as DER-encoded bytes in `derBytes`.

The supplied data contains DSA domain parameters `P`, `Q`, and `G`, not an existing private key. Chilkat validates or imports those parameters and generates a fresh private value `X` and corresponding public value `Y`.

Returns true for success, false for failure.

### Dsa.GenKeyFromParamsDerBd

`Chilkat 11.7.0 · phpx · Dsa · GenKeyFromParamsDerBd · method · since 11.0.0`

```php
bool GenKeyFromParamsDerBd(Chilkat.BinData bd)
```

Generates a new DSA key pair from OpenSSL-style DSA parameters stored as DER bytes in the `BinData` object passed in `bd`.

The supplied data contains DSA domain parameters `P`, `Q`, and `G`, not an existing private key. Chilkat validates or imports those parameters and generates a fresh private value `X` and corresponding public value `Y`.

Returns true for success, false for failure.

### Dsa.GenKeyFromParamsDerFile

`Chilkat 11.7.0 · phpx · Dsa · GenKeyFromParamsDerFile · method`

```php
bool GenKeyFromParamsDerFile(string path)
```

Generates a new DSA key pair from the OpenSSL-style DER DSA-parameters file specified by `path`.

The supplied data contains DSA domain parameters `P`, `Q`, and `G`, not an existing private key. Chilkat validates or imports those parameters and generates a fresh private value `X` and corresponding public value `Y`.

Returns `true` when the parameters are loaded and a key pair is generated successfully.

Returns true for success, false for failure.

### Dsa.GenKeyFromParamsPem

`Chilkat 11.7.0 · phpx · Dsa · GenKeyFromParamsPem · method`

```php
bool GenKeyFromParamsPem(string pem)
```

Generates a new DSA key pair from OpenSSL-style DSA parameters supplied as PEM text in `pem`.

The supplied data contains DSA domain parameters `P`, `Q`, and `G`, not an existing private key. Chilkat validates or imports those parameters and generates a fresh private value `X` and corresponding public value `Y`.

Returns true for success, false for failure.

### Dsa.GenKeyFromParamsPemFile

`Chilkat 11.7.0 · phpx · Dsa · GenKeyFromParamsPemFile · method`

```php
bool GenKeyFromParamsPemFile(string path)
```

Generates a new DSA key pair from the OpenSSL-style PEM DSA-parameters file specified by `path`.

The supplied data contains DSA domain parameters `P`, `Q`, and `G`, not an existing private key. Chilkat validates or imports those parameters and generates a fresh private value `X` and corresponding public value `Y`.

A typical parameter file is PEM-armored with a `BEGIN DSA PARAMETERS` header. The newly generated private key can be exported with the applicable `To*` methods.

Returns true for success, false for failure.

### Dsa.GenKeyFromPQG

`Chilkat 11.7.0 · phpx · Dsa · GenKeyFromPQG · method · since 9.5.0.90`

```php
bool GenKeyFromPQG(string pHex, string qHex, string gHex)
```

Generates a new DSA private/public key pair using the preselected domain parameters `P`, `Q`, and `G` supplied in `pHex`, `qHex`, and `gHex`.

Each argument is hexadecimal text in Chilkat's SSH1-format bignum representation. Chilkat generates a fresh private value `X` and derives `Y`; the supplied values are domain parameters, not an existing key pair.

**Parameter provenance:** Only use DSA parameters obtained from a trusted, validated source. Malformed or maliciously chosen domain parameters can undermine signature security.

Returns true for success, false for failure.

### Dsa.GetEncodedHash

`Chilkat 11.7.0 · phpx · Dsa · GetEncodedHash · method`

```php
string GetEncodedHash(string encoding)
```

Returns the current `Hash` bytes encoded according to `encoding`. Use `hex` or `base64`.

This method does not compute a hash; it only converts the bytes already stored in the `Hash` property to text.

Returns `null` on failure

### Dsa.GetEncodedSignature

`Chilkat 11.7.0 · phpx · Dsa · GetEncodedSignature · method`

```php
string GetEncodedSignature(string encoding)
```

Returns the current `Signature` bytes encoded according to `encoding`. Use `hex` or `base64`.

After a successful `SignHash` call, the returned bytes are the ASN.1 DER-encoded DSA signature containing the integers `r` and `s`.

Returns `null` on failure

### Dsa.LoadText

`Chilkat 11.7.0 · phpx · Dsa · LoadText · method`

```php
string LoadText(string path)
```

Loads the entire file specified by `path` and returns its contents as text using the legacy ANSI character encoding.

**Encoding note:** This convenience method is suitable for ASCII-compatible PEM and similar legacy text. It is not a general Unicode file reader; use an API with an explicit character encoding when UTF-8 or other Unicode text must be preserved.

Returns `null` on failure

### Dsa.SaveText

`Chilkat 11.7.0 · phpx · Dsa · SaveText · method`

```php
bool SaveText(string strToSave, string path)
```

Writes `strToSave` to the file specified by `path` using the legacy ANSI character encoding. Returns `true` on success.

**Encoding note:** This convenience method is appropriate for ASCII-compatible PEM text. It can lose characters that are not representable in the active ANSI encoding, so use an explicitly encoded text-writing API for general Unicode content.

Returns true for success, false for failure.

### Dsa.SetEncodedHash

`Chilkat 11.7.0 · phpx · Dsa · SetEncodedHash · method`

```php
bool SetEncodedHash(string encoding, string encodedHash)
```

Decodes `encodedHash` using the encoding named by `encoding` and stores the resulting bytes in the `Hash` property. Use `hex` or `base64`.

The decoded value must be the already-computed message digest that will be signed by `SignHash` or checked by `Verify`.

Returns true for success, false for failure.

### Dsa.SetEncodedSignature

`Chilkat 11.7.0 · phpx · Dsa · SetEncodedSignature · method`

```php
bool SetEncodedSignature(string encoding, string encodedSig)
```

Decodes the signature text in `encodedSig` using the encoding named by `encoding` and stores the resulting bytes in the `Signature` property. Use `hex` or `base64`.

The decoded bytes are expected to contain the ASN.1 DER-encoded DSA signature. Set the corresponding `Hash` and public key before calling `Verify`.

Returns true for success, false for failure.

### Dsa.SetEncodedSignatureRS

`Chilkat 11.7.0 · phpx · Dsa · SetEncodedSignatureRS · method`

```php
bool SetEncodedSignatureRS(string encoding, string encodedR, string encodedS)
```

Builds the DSA signature from separately encoded `r` and `s` integer values. `encoding` identifies the encoding used by both `encodedR` and `encodedS`; use `hex` or `base64`.

On success, `Signature` contains the ASN.1 DER `SEQUENCE` of the two integers and is ready for use with `Verify`.

Returns true for success, false for failure.

### Dsa.SetKeyExplicit

`Chilkat 11.7.0 · phpx · Dsa · SetKeyExplicit · method`

```php
bool SetKeyExplicit(int groupSizeInBytes, string pHex, string qHex, string gHex, string xHex)
```

Loads a DSA private key from explicitly supplied components. `groupSizeInBytes` is the size of `Q` in bytes. `pHex`, `qHex`, `gHex`, and `xHex` provide `P`, `Q`, `G`, and the private value `X`, respectively.

The corresponding public value `Y = GX mod P` is derived from the private key.

**SSH1 bignums:** Each component string is hexadecimal text representing an SSH1-format bignum: a two-byte bit-length prefix followed by the unsigned integer bytes.

**Sensitive value:** `xHex` contains the private key. Do not expose it in logs or transmit it over an unprotected channel.

Returns true for success, false for failure.

### Dsa.SetPubKeyExplicit

`Chilkat 11.7.0 · phpx · Dsa · SetPubKeyExplicit · method`

```php
bool SetPubKeyExplicit(int groupSizeInBytes, string pHex, string qHex, string gHex, string yHex)
```

Loads a DSA public key from explicitly supplied components. `groupSizeInBytes` is the size of `Q` in bytes. `pHex`, `qHex`, `gHex`, and `yHex` provide `P`, `Q`, `G`, and the public value `Y`, respectively.

The resulting object can verify DSA signatures but cannot create them.

**SSH1 bignums:** Each component string is hexadecimal text representing an SSH1-format bignum: a two-byte bit-length prefix followed by the unsigned integer bytes.

Returns true for success, false for failure.

### Dsa.SignHash

`Chilkat 11.7.0 · phpx · Dsa · SignHash · method`

```php
bool SignHash()
```

Creates a DSA signature over the digest currently stored in `Hash`. A DSA private key must be loaded, and the digest must be set directly or with `SetEncodedHash` before this method is called.

On success, `Signature` contains an ASN.1 DER-encoded sequence of the DSA values `r` and `s`. Retrieve it with `GetEncodedSignature` or read the `Signature` property.

**Security-critical nonce:** Each DSA signature requires a secret per-signature value. Reuse or poor generation of that value can reveal the private key. Chilkat performs this generation internally; applications should not attempt to reuse signature state.

**Standards status:** FIPS 186-5 no longer approves DSA for generating new signatures. Use this method only for required legacy interoperability.

Returns true for success, false for failure.

### Dsa.ToDer

`Chilkat 11.7.0 · phpx · Dsa · ToDer · method`

```php
VARIANT ToDer()
```

Returns the loaded DSA private key as DER-encoded bytes. A private key must be present; a public-only key cannot be exported by this method.

**Sensitive output:** The returned bytes contain the private key and must be protected in memory, storage, and transit.

Returns `null` on failure

### Dsa.ToDerBd

`Chilkat 11.7.0 · phpx · Dsa · ToDerBd · method · since 11.0.0`

```php
bool ToDerBd(Chilkat.BinData bd)
```

Writes the DER-encoded DSA private key to the `BinData` object passed in `bd`. Returns `true` on success.

**Sensitive output:** The destination contains unencrypted private-key bytes after a successful call. Protect and clear it appropriately.

Returns true for success, false for failure.

### Dsa.ToDerFile

`Chilkat 11.7.0 · phpx · Dsa · ToDerFile · method`

```php
bool ToDerFile(string path)
```

Writes the loaded DSA private key to the DER file specified by `path`. Returns `true` on success.

**Sensitive output:** The file contains unencrypted private-key material. Apply restrictive filesystem permissions and avoid writing it to shared or temporary locations.

Returns true for success, false for failure.

### Dsa.ToEncryptedPem

`Chilkat 11.7.0 · phpx · Dsa · ToEncryptedPem · method`

```php
string ToEncryptedPem(string password)
```

Returns the loaded DSA private key as password-encrypted PEM text using `password` as the password.

**Password protection:** Use a strong password and protect it separately from the PEM. Encrypted PEM reduces exposure at rest but does not make it safe to log or transmit indiscriminately.

Returns `null` on failure

### Dsa.ToPem

`Chilkat 11.7.0 · phpx · Dsa · ToPem · method`

```php
string ToPem()
```

Returns the loaded DSA private key as unencrypted PEM text.

**Unencrypted private key:** PEM armor is not encryption. Anyone who obtains this text can use the private key, so prefer `ToEncryptedPem` when password protection is required.

Returns `null` on failure

### Dsa.ToPublicDer

`Chilkat 11.7.0 · phpx · Dsa · ToPublicDer · method`

```php
VARIANT ToPublicDer()
```

Returns the public portion of the loaded DSA key as DER-encoded bytes. This works whether the object contains a public key or a private key with a corresponding public value.

Returns `null` on failure

### Dsa.ToPublicDerBd

`Chilkat 11.7.0 · phpx · Dsa · ToPublicDerBd · method · since 11.0.0`

```php
bool ToPublicDerBd(Chilkat.BinData bd)
```

Writes the DER-encoded public portion of the loaded DSA key to the `BinData` object passed in `bd`. Returns `true` on success.

Returns true for success, false for failure.

### Dsa.ToPublicDerFile

`Chilkat 11.7.0 · phpx · Dsa · ToPublicDerFile · method`

```php
bool ToPublicDerFile(string path)
```

Writes the public portion of the loaded DSA key to the DER file specified by `path`. Returns `true` on success.

Returns true for success, false for failure.

### Dsa.ToPublicPem

`Chilkat 11.7.0 · phpx · Dsa · ToPublicPem · method`

```php
string ToPublicPem()
```

Returns the public portion of the loaded DSA key as PEM text. Public-key PEM may be distributed to parties that need to verify signatures; it does not contain the private value `X`.

Returns `null` on failure

### Dsa.ToXml

`Chilkat 11.7.0 · phpx · Dsa · ToXml · method`

```php
string ToXml(bool bPublicOnly)
```

Returns the loaded DSA key as XML. Set `bPublicOnly` to `true` to export public components only. Set it to `false` to include the private component when a private key is loaded.

**Security:** When `bPublicOnly` is `false`, the XML can contain the private value `X`. Protect it as private-key material.

Returns `null` on failure

### Dsa.Verify

`Chilkat 11.7.0 · phpx · Dsa · Verify · method`

```php
bool Verify()
```

Verifies the DSA signature currently stored in `Signature` against the digest stored in `Hash`, using the loaded public key. Both values must be set before calling this method.

Returns `true` only when the signature is valid. A `false` result can indicate an invalid signature, malformed input, an incompatible key, or another operational error; inspect `LastErrorText` when the reason matters.

Returns true for success, false for failure.

### Dsa.VerifyKey

`Chilkat 11.7.0 · phpx · Dsa · VerifyKey · method`

```php
bool VerifyKey()
```

Checks the mathematical validity and internal consistency of the DSA public or private key currently loaded in the object. Returns `true` when the key parameters and available key components pass validation.

This does not establish who owns the key, whether the key came from a trusted source, or whether it is suitable for a particular protocol.

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpx/classes/BinData.md)

