Dsa ActiveX Reference Documentation

Dsa

Current Version: 10.1.2

Requires Chilkat Bundle License

The Digital Signature Algorithm (DSA) is a United States Federal Government standard or FIPS for digital signatures. It was proposed by the National Institute of Standards and Technology (NIST) in August 1991 for use in their Digital Signature Standard (DSS).

Object Creation

Note:
For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.Dsa" instead of "Chilkat.Dsa"
For a specific major version, use "Chilkat.Dsa.<major_version>", such as "Chilkat.Dsa.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

(ASP)
set obj = Server.CreateObject("Chilkat.Dsa")

(AutoIt)
$obj = ObjCreate("Chilkat.Dsa")

(Visual Basic 6.0)
Dim obj As New ChilkatDsa

(VBScript)
set obj = CreateObject("Chilkat.Dsa")

(Delphi)
obj := TChilkatDsa.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat.Dsa')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat.Dsa")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.Dsa', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat.Dsa");

Properties

DebugLogFilePath

DebugLogFilePath As String

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

(AutoIt) Example showing how to use DebugLogFilePath.(Classic ASP) Example showing how to use DebugLogFilePath.(PowerBuilder) Example showing how to use DebugLogFilePath.(SQL Server) Example showing how to use DebugLogFilePath.(VBScript) Example showing how to use DebugLogFilePath.(Visual Basic 6.0) Example showing how to use DebugLogFilePath.(Visual FoxPro) Example showing how to use DebugLogFilePath.

GroupSize

GroupSize As Long

The group size (in bits) to be used in DSA key generation. The default value is 160 and corresponds to the fact that SHA-1 is used in signature generation. This property setting should not be changed. It exists for future expansion when additional underlying hash algorithms are supported.

Hash

Hash As Variant

The hash to be signed or verified via the SignHash and Verify methods. In both cases, the Hash should be set prior to calling SignHash or Verify. This property may also be set via the SetEncodedHash method.

HexG

HexG As String (read-only)

The "G" part of a public or private DSA key returned as a hex-encoded SSH1-format bignum. The "G" is the generator. DSA key params consist of G, P, and Q.

HexP

HexP As String (read-only)

The "P" part of a public or private DSA key returned as a hex-encoded SSH1-format bignum. The "P" is a large prime. DSA key params consist of G, P, and Q.

HexQ

HexQ As String (read-only)

The "Q" part of a public or private DSA key returned as a hex-encoded SSH1-format bignum. DSA key params consist of G, P, and Q.

HexX

HexX As String (read-only)

The "X" part of a DSA private key returned as a hex-encoded SSH1-format bignum.

HexY

HexY As String (read-only)

The "Y" part of a DSA public key returned as a hex-encoded SSH1-format bignum. (The "Y" value is also accessible w/ a private key, but the "X" value is not available in a DSA public key.)

LastBinaryResult

LastBinaryResult As Variant (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. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

LastErrorHtml

LastErrorHtml As String (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

LastErrorText As String (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

LastErrorXml As String (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

LastMethodSuccess As Long

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

LastStringResult

LastStringResult As String (read-only)

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

LastStringResultLen As Long (read-only)

The length, in characters, of the string contained in the LastStringResult property.

Signature

Signature As Variant

The signature created by calling SignHash. If verifying a signature, this may be set prior to calling the Verify method.

UncommonOptions

UncommonOptions As String

Introduced in version 9.5.0.90

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.

VerboseLogging

VerboseLogging As Long

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

Version

Version As String (read-only)

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

More Information and Examples

(AutoIt) How to get the Chilkat version at runtime.(Classic ASP) How to get the Chilkat version at runtime.(PowerBuilder) How to get the Chilkat version at runtime.(SQL Server) How to get the Chilkat version at runtime.(VBScript) How to get the Chilkat version at runtime.(Visual Basic 6.0) How to get the Chilkat version at runtime.(Visual FoxPro) How to get the Chilkat version at runtime.

Methods

FromDer

FromDer(derData As Variant) As Long

Loads a DSA private key from in-memory DSA DER-encoded bytes.

Returns 1 for success, 0 for failure.

FromDerFile

FromDerFile(path As String) As Long

Loads a DSA private key from a DER-encoded file.

Returns 1 for success, 0 for failure.

More Information and Examples

(AutoIt) Convert DSA DER Private Key to PEM (Classic ASP) Convert DSA DER Private Key to PEM (PowerBuilder) Convert DSA DER Private Key to PEM (SQL Server) Convert DSA DER Private Key to PEM (VBScript) Convert DSA DER Private Key to PEM (Visual Basic 6.0) Convert DSA DER Private Key to PEM (Visual FoxPro) Convert DSA DER Private Key to PEM

FromEncryptedPem

FromEncryptedPem(password As String, pemData As String) As Long

Loads a DSA private key from an in-memory encrypted PEM-formatted string. If the PEM passed to this method is unencrypted, the password is ignored and the PEM is simply loaded.

Returns 1 for success, 0 for failure.

FromPem

FromPem(pemData As String) As Long

Loads a DSA private key from an in-memory unencrypted PEM-formatted string.

Returns 1 for success, 0 for failure.

More Information and Examples

(AutoIt) DSA Signature Create and Verify (Classic ASP) DSA Signature Create and Verify (PowerBuilder) DSA Signature Create and Verify (SQL Server) DSA Signature Create and Verify (VBScript) DSA Signature Create and Verify (Visual Basic 6.0) DSA Signature Create and Verify (Visual FoxPro) DSA Signature Create and Verify

FromPublicDer

FromPublicDer(derData As Variant) As Long

Loads a DSA public key from an in-memory DER-encoded byte array.

Returns 1 for success, 0 for failure.

FromPublicDerFile

FromPublicDerFile(path As String) As Long

Loads a DSA public key from a DER-encoded file.

Returns 1 for success, 0 for failure.

FromPublicPem

FromPublicPem(pemData As String) As Long

Loads a DSA public-key from an in-memory PEM string.

Returns 1 for success, 0 for failure.

FromXml

FromXml(xmlKey As String) As Long

Loads a DSA public or private key from an in-memory XML string.

Returns 1 for success, 0 for failure.

GenKey

GenKey(ByVal numBits As Long) As Long

Generates a new DSA key that is numBits bits in length. The numBits should be at least 1024 bits and a multiple of 64. Typical values are 1024 and 2048. The newly generated key may be exported by calling one of the To* methods.

Returns 1 for success, 0 for failure.

More Information and Examples

(AutoIt) DSA Generate Key (Classic ASP) DSA Generate Key (PowerBuilder) DSA Generate Key (SQL Server) DSA Generate Key (VBScript) DSA Generate Key (Visual Basic 6.0) DSA Generate Key (Visual FoxPro) DSA Generate Key

GenKey2

GenKey2(ByVal keyLenBits As Long, ByVal modLenBits As Long) As Long

Introduced in version 9.5.0.90

Generates a new DSA key that is keyLenBits bits in length with a modulus of size modLenBits bits. The keyLenBits should be at least 1024 bits and a multiple of 64. FIPS 186-4 specifies the key length (bits) and modulus size (bits) to have one of the values: (1024, 160), (2048, 224), (2048, 256), or (3072, 256).

Returns 1 for success, 0 for failure.

GenKeyFromParamsDer

GenKeyFromParamsDer(derBytes As Variant) As Long

Generates a new DSA key from in-memory DER parameters created by OpenSSL. The newly generated key may be exported by calling one of the To* methods.

Returns 1 for success, 0 for failure.

GenKeyFromParamsDerFile

GenKeyFromParamsDerFile(path As String) As Long

Generates a new DSA key from a DER-format parameters file created by OpenSSL. An example of using OpenSSL to generate DSA parameters in DER format is:

openssl dsaparam -outform DER 1024 < seedData.xml > dsaparam.der

The newly generated key may be exported by calling one of the To* methods.

Returns 1 for success, 0 for failure.

More Information and Examples

(AutoIt) Generate new DSA Key from OpenSSL Parameters File (Classic ASP) Generate new DSA Key from OpenSSL Parameters File (PowerBuilder) Generate new DSA Key from OpenSSL Parameters File (SQL Server) Generate new DSA Key from OpenSSL Parameters File (VBScript) Generate new DSA Key from OpenSSL Parameters File (Visual Basic 6.0) Generate new DSA Key from OpenSSL Parameters File (Visual FoxPro) Generate new DSA Key from OpenSSL Parameters File

GenKeyFromParamsPem

GenKeyFromParamsPem(pem As String) As Long

Generates a new DSA key from parameters (PEM formatted string) created by OpenSSL. The newly generated key may be exported by calling one of the To* methods.

Returns 1 for success, 0 for failure.

GenKeyFromParamsPemFile

GenKeyFromParamsPemFile(path As String) As Long

Generates a new DSA key from a PEM parameters file created by OpenSSL. The newly generated key may be exported by calling one of the To* methods.

OpenSSL provides the ability to generate DSA key parameters. For example:

openssl dsaparam 1024 < seedData.txt > dsaparam.pem

Here is a sample DSA parameters PEM:

-----BEGIN DSA PARAMETERS-----
MIIBHgKBgQCXIAx4XzLVZ5ZqOFzdsYWVyH/6E/mVPw4TgMZS6Wxajnbdn1/CUBzE
RWTUp8SguTSDpjC1Q/nyno0G6Q96VoW+PUXv8qUph8vbSaEdsjYO/8jSfzkGfvsa
cucr1ythfNyk63aZAKzxeutOmsVe77l6pZI96ROjWF5iizuUB4WgmwIVANxM70wH
8iPPYVzPZqtXCB66I2SnAoGAIbW2VYRjRdoA7trJgmnfWakghKwV1WyaYrotqeDE
07/dipp0cNuY0IAJgSmqLHlAkNa2ZNI/c1mNxcwhYzZrnn8CXIqrYmtI33w0PYCx
KHPqj7puhddFwYS/rFiyWAN0jtCMHlfCVzFGbSzach5QQraPV9YApJXy+ORJ8VPU
/zo=
-----END DSA PARAMETERS-----

Returns 1 for success, 0 for failure.

GenKeyFromPQG

GenKeyFromPQG(pHex As String, qHex As String, gHex As String) As Long

Introduced in version 9.5.0.90

Generates a new DSA key from pre-chosen P, Q, and G params.

Returns 1 for success, 0 for failure.

GetEncodedHash

GetEncodedHash(encoding As String) As String

Returns the bytes of the Hash property as a hex or base64 encoded string. The encoding should be set to either "hex" or "base64".

Returns Nothing on failure

GetEncodedSignature

GetEncodedSignature(encoding As String) As String

Returns the bytes of the Signature property as a hex or base64 encoded string. The encoding should be set to either "hex" or "base64". The Signature property is set when SignHash is called.

Returns Nothing on failure

LoadText

LoadText(path As String) As String

Convenience method to load the entire contents of a text file into a string. It is assumed that the text contains ANSI encoded character data.

Returns Nothing on failure

SaveText

SaveText(strToSave As String, path As String) As Long

Convenience method to save a string to a text file. The text is saved using the ANSI character encoding.

Returns 1 for success, 0 for failure.

SetEncodedHash

SetEncodedHash(encoding As String, encodedHash As String) As Long

Provides a way to set the Hash property by passing an encoded string. The encoding can be "hex" or "base64". The encodedHash contains the encoded bytes of the hash that will be signed or verified via the SignHash and Verify methods.

Returns 1 for success, 0 for failure.

SetEncodedSignature

SetEncodedSignature(encoding As String, encodedSig As String) As Long

Sets the bytes of the Signature property. (The signature must be specified prior to calling the Verify method.) This method allows for the signature to be set via a hex or base64 encoded string. The encoding should be set to either "hex" or "base64".

Returns 1 for success, 0 for failure.

SetEncodedSignatureRS

SetEncodedSignatureRS(encoding As String, encodedR As String, encodedS As String) As Long

Sets the bytes of the Signature property by providing the R and S values in encoded form. (The signature must be specified prior to calling the Verify method.) The R and S values may be set via a hex or base64 encoded string. The encoding should be set to either "hex" or "base64".

Returns 1 for success, 0 for failure.

SetKeyExplicit

SetKeyExplicit(ByVal groupSizeInBytes As Long, pHex As String, qHex As String, gHex As String, xHex As String) As Long

Sets the DSA object's private key from explicitly provided pHex, qHex, gHex, and xHex values. The groupSizeInBytes specifies the group size (in bytes). It is typically equal to 20, which is the length of the underlying hash function (SHA-1) for signing. The pHex, qHex, gHex, and xHex values are hex-encoded SSH1-format bignums.

Returns 1 for success, 0 for failure.

SetPubKeyExplicit

SetPubKeyExplicit(ByVal groupSizeInBytes As Long, pHex As String, qHex As String, gHex As String, yHex As String) As Long

Sets the DSA object's private key from explicitly provided pHex, qHex, gHex, and yHex values. The groupSizeInBytes specifies the group size (in bytes). It is typically equal to 20, which is the length of the underlying hash function (SHA-1) for signing. The pHex, qHex, gHex, and yHex values are hex-encoded SSH1-format bignums.

Returns 1 for success, 0 for failure.

SignHash

SignHash() As Long

Signs a hash using the digital signature algorithm. Before calling this method, set the hash to be signed by either calling SetEncodedHash or by setting the Hash property. If SignHash returns 1, the signature may be retrieved by either calling GetEncodedHash, or by accessing the Signature property.

Returns 1 for success, 0 for failure.

More Information and Examples

(AutoIt) DSA Signature Create and Verify (Classic ASP) DSA Signature Create and Verify (PowerBuilder) DSA Signature Create and Verify (SQL Server) DSA Signature Create and Verify (VBScript) DSA Signature Create and Verify (Visual Basic 6.0) DSA Signature Create and Verify (Visual FoxPro) DSA Signature Create and Verify

ToDer

ToDer() As Variant

Writes the DSA private key to a DER-encoded byte array.

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

ToDerFile

ToDerFile(path As String) As Long

Writes the DSA private key to a DER-format file.

Returns 1 for success, 0 for failure.

More Information and Examples

(AutoIt) DSA Generate Key (Classic ASP) DSA Generate Key (PowerBuilder) DSA Generate Key (SQL Server) DSA Generate Key (VBScript) DSA Generate Key (Visual Basic 6.0) DSA Generate Key (Visual FoxPro) DSA Generate Key

ToEncryptedPem

ToEncryptedPem(password As String) As String

Writes the DSA private key to an in-memory encrypted PEM string.

Returns Nothing on failure

More Information and Examples

(AutoIt) DSA Generate Key (Classic ASP) DSA Generate Key (PowerBuilder) DSA Generate Key (SQL Server) DSA Generate Key (VBScript) DSA Generate Key (Visual Basic 6.0) DSA Generate Key (Visual FoxPro) DSA Generate Key (AutoIt) Convert DSA DER Private Key to PEM (Classic ASP) Convert DSA DER Private Key to PEM (PowerBuilder) Convert DSA DER Private Key to PEM (SQL Server) Convert DSA DER Private Key to PEM (VBScript) Convert DSA DER Private Key to PEM (Visual Basic 6.0) Convert DSA DER Private Key to PEM (Visual FoxPro) Convert DSA DER Private Key to PEM

ToPem

ToPem() As String

Writes the DSA private key to an in-memory PEM string.

Returns Nothing on failure

More Information and Examples

(AutoIt) Convert DSA DER Private Key to PEM (Classic ASP) Convert DSA DER Private Key to PEM (PowerBuilder) Convert DSA DER Private Key to PEM (SQL Server) Convert DSA DER Private Key to PEM (VBScript) Convert DSA DER Private Key to PEM (Visual Basic 6.0) Convert DSA DER Private Key to PEM (Visual FoxPro) Convert DSA DER Private Key to PEM

ToPublicDer

ToPublicDer() As Variant

Writes the DSA public key to a DER-encoded byte array.

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

ToPublicDerFile

ToPublicDerFile(path As String) As Long

Writes the DSA public key to a DER-format file.

Returns 1 for success, 0 for failure.

More Information and Examples

(AutoIt) DSA Generate Key (Classic ASP) DSA Generate Key (PowerBuilder) DSA Generate Key (SQL Server) DSA Generate Key (VBScript) DSA Generate Key (Visual Basic 6.0) DSA Generate Key (Visual FoxPro) DSA Generate Key

ToPublicPem

ToPublicPem() As String

Writes the DSA public key to an in-memory PEM string.

Returns Nothing on failure

More Information and Examples

(AutoIt) DSA Generate Key (Classic ASP) DSA Generate Key (PowerBuilder) DSA Generate Key (SQL Server) DSA Generate Key (VBScript) DSA Generate Key (Visual Basic 6.0) DSA Generate Key (Visual FoxPro) DSA Generate Key

ToXml

ToXml(ByVal bPublicOnly As Long) As String

Writes the DSA private or public key to an in-memory XML string. The bPublicOnly determines whether the public or private key is written.

Returns Nothing on failure

More Information and Examples

(AutoIt) DSA Get Key as XML (Classic ASP) DSA Get Key as XML (PowerBuilder) DSA Get Key as XML (SQL Server) DSA Get Key as XML (VBScript) DSA Get Key as XML (Visual Basic 6.0) DSA Get Key as XML (Visual FoxPro) DSA Get Key as XML

Verify

Verify() As Long

Verifies a DSA signature. The Hash and Signature properties must be set prior to calling this method. (These properties may also be set via the SetEncodedHash and SetEncodedSignature methods.)

Returns 1 for success, 0 for failure.

More Information and Examples

(AutoIt) DSA Signature Create and Verify (Classic ASP) DSA Signature Create and Verify (PowerBuilder) DSA Signature Create and Verify (SQL Server) DSA Signature Create and Verify (VBScript) DSA Signature Create and Verify (Visual Basic 6.0) DSA Signature Create and Verify (Visual FoxPro) DSA Signature Create and Verify (AutoIt) DSA R,S Signature Values (Classic ASP) DSA R,S Signature Values (PowerBuilder) DSA R,S Signature Values (SQL Server) DSA R,S Signature Values (VBScript) DSA R,S Signature Values (Visual Basic 6.0) DSA R,S Signature Values (Visual FoxPro) DSA R,S Signature Values

VerifyKey

VerifyKey() As Long

Verifies that the public or private key contained in the calling Dsa object is valid. Returns 1 if valid, otherwise returns 0.

More Information and Examples

(AutoIt) DSA Signature Create and Verify (Classic ASP) DSA Signature Create and Verify (PowerBuilder) DSA Signature Create and Verify (SQL Server) DSA Signature Create and Verify (VBScript) DSA Signature Create and Verify (Visual Basic 6.0) DSA Signature Create and Verify (Visual FoxPro) DSA Signature Create and Verify