CkDsa Perl Reference Documentation

CkDsa

Current Version: 9.5.0.75

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

$obj = chilkat::CkDsa->new();

Properties

DebugLogFilePath
# $strVal is a string
# $ckStr is a CkString
$dsa->get_DebugLogFilePath($ckStr);
$strVal = $dsa->debugLogFilePath();
$dsa->put_DebugLogFilePath($strVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
GroupSize
# $intVal is an integer
$intVal = $dsa->get_GroupSize();
$dsa->put_GroupSize($intVal);

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.

top
Hash
# $ckBytes is a CkByteData
$dsa->get_Hash($ckBytes);
$dsa->put_Hash($ckBytes);

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.

top
HexG
# $strVal is a string
# $ckStr is a CkString
$dsa->get_HexG($ckStr);
$strVal = $dsa->hexG();

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.

top
HexP
# $strVal is a string
# $ckStr is a CkString
$dsa->get_HexP($ckStr);
$strVal = $dsa->hexP();

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.

top
HexQ
# $strVal is a string
# $ckStr is a CkString
$dsa->get_HexQ($ckStr);
$strVal = $dsa->hexQ();

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.

top
HexX
# $strVal is a string
# $ckStr is a CkString
$dsa->get_HexX($ckStr);
$strVal = $dsa->hexX();

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

top
HexY
# $strVal is a string
# $ckStr is a CkString
$dsa->get_HexY($ckStr);
$strVal = $dsa->hexY();

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

top
LastErrorHtml
# $strVal is a string
# $ckStr is a CkString
$dsa->get_LastErrorHtml($ckStr);
$strVal = $dsa->lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
# $strVal is a string
# $ckStr is a CkString
$dsa->get_LastErrorText($ckStr);
$strVal = $dsa->lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
# $strVal is a string
# $ckStr is a CkString
$dsa->get_LastErrorXml($ckStr);
$strVal = $dsa->lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
# $boolVal is a boolean
$boolVal = $dsa->get_LastMethodSuccess();
$dsa->put_LastMethodSuccess($boolVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Signature
# $ckBytes is a CkByteData
$dsa->get_Signature($ckBytes);
$dsa->put_Signature($ckBytes);

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

top
Utf8
# $boolVal is a boolean
$boolVal = $dsa->get_Utf8();
$dsa->put_Utf8($boolVal);

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top
VerboseLogging
# $boolVal is a boolean
$boolVal = $dsa->get_VerboseLogging();
$dsa->put_VerboseLogging($boolVal);

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.

top
Version
# $strVal is a string
# $ckStr is a CkString
$dsa->get_Version($ckStr);
$strVal = $dsa->version();

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

top

Methods

FromDer
# $derData is a CkByteData
$status = $dsa->FromDer($derData);

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

Returns 1 for success, 0 for failure.

top
FromDerFile
# $path is a string
$status = $dsa->FromDerFile($path);

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
FromEncryptedPem
# $password is a string
# $pemData is a string
$status = $dsa->FromEncryptedPem($password, $pemData);

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.

top
FromPem
# $pemData is a string
$status = $dsa->FromPem($pemData);

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
FromPublicDer
# $derData is a CkByteData
$status = $dsa->FromPublicDer($derData);

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

Returns 1 for success, 0 for failure.

top
FromPublicDerFile
# $path is a string
$status = $dsa->FromPublicDerFile($path);

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

Returns 1 for success, 0 for failure.

top
FromPublicPem
# $pemData is a string
$status = $dsa->FromPublicPem($pemData);

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

Returns 1 for success, 0 for failure.

top
FromXml
# $xmlKey is a string
$status = $dsa->FromXml($xmlKey);

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

Returns 1 for success, 0 for failure.

top
GenKey
# $numBits is an integer
$status = $dsa->GenKey($numBits);

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
top
GenKeyFromParamsDer
# $derBytes is a CkByteData
$status = $dsa->GenKeyFromParamsDer($derBytes);

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.

top
GenKeyFromParamsDerFile
# $path is a string
$status = $dsa->GenKeyFromParamsDerFile($path);

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.

top
GenKeyFromParamsPem
# $pem is a string
$status = $dsa->GenKeyFromParamsPem($pem);

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.

top
GenKeyFromParamsPemFile
# $path is a string
$status = $dsa->GenKeyFromParamsPemFile($path);

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.

top
GetEncodedHash
# $encoding is a string
# $outStr is a CkString (output)
$status = $dsa->GetEncodedHash($encoding, $outStr);
$retStr = $dsa->getEncodedHash($encoding);

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 1 for success, 0 for failure.

top
GetEncodedSignature
# $encoding is a string
# $outStr is a CkString (output)
$status = $dsa->GetEncodedSignature($encoding, $outStr);
$retStr = $dsa->getEncodedSignature($encoding);

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 1 for success, 0 for failure.

top
LoadText
# $path is a string
# $outStr is a CkString (output)
$status = $dsa->LoadText($path, $outStr);
$retStr = $dsa->loadText($path);

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 1 for success, 0 for failure.

top
SaveLastError
# $path is a string
$status = $dsa->SaveLastError($path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns 1 for success, 0 for failure.

top
SaveText
# $strToSave is a string
# $path is a string
$status = $dsa->SaveText($strToSave, $path);

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.

top
SetEncodedHash
# $encoding is a string
# $encodedHash is a string
$status = $dsa->SetEncodedHash($encoding, $encodedHash);

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.

top
SetEncodedSignature
# $encoding is a string
# $encodedSig is a string
$status = $dsa->SetEncodedSignature($encoding, $encodedSig);

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.

top
SetEncodedSignatureRS
# $encoding is a string
# $encodedR is a string
# $encodedS is a string
$status = $dsa->SetEncodedSignatureRS($encoding, $encodedR, $encodedS);

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.

top
SetKeyExplicit
# $groupSizeInBytes is an integer
# $pHex is a string
# $qHex is a string
# $gHex is a string
# $xHex is a string
$status = $dsa->SetKeyExplicit($groupSizeInBytes, $pHex, $qHex, $gHex, $xHex);

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.

top
SetPubKeyExplicit
# $groupSizeInBytes is an integer
# $pHex is a string
# $qHex is a string
# $gHex is a string
# $yHex is a string
$status = $dsa->SetPubKeyExplicit($groupSizeInBytes, $pHex, $qHex, $gHex, $yHex);

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.

top
SignHash
$status = $dsa->SignHash();

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
top
ToDer
# $outBytes is a CkByteData (output)
$status = $dsa->ToDer($outData);

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

Returns 1 for success, 0 for failure.

top
ToDerFile
# $path is a string
$status = $dsa->ToDerFile($path);

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
ToEncryptedPem
# $password is a string
# $outStr is a CkString (output)
$status = $dsa->ToEncryptedPem($password, $outStr);
$retStr = $dsa->toEncryptedPem($password);

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

Returns 1 for success, 0 for failure.

top
ToPem
# $outStr is a CkString (output)
$status = $dsa->ToPem($outStr);
$retStr = $dsa->toPem();

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
ToPublicDer
# $outBytes is a CkByteData (output)
$status = $dsa->ToPublicDer($outData);

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

Returns 1 for success, 0 for failure.

top
ToPublicDerFile
# $path is a string
$status = $dsa->ToPublicDerFile($path);

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
ToPublicPem
# $outStr is a CkString (output)
$status = $dsa->ToPublicPem($outStr);
$retStr = $dsa->toPublicPem();

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
ToXml
# $bPublicOnly is a boolean
# $outStr is a CkString (output)
$status = $dsa->ToXml($bPublicOnly, $outStr);
$retStr = $dsa->toXml($bPublicOnly);

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 1 for success, 0 for failure.

More Information and Examples
top
UnlockComponent
# $unlockCode is a string
$status = $dsa->UnlockComponent($unlockCode);

Unlocks the component. This must be called once prior to calling any other method.

Returns 1 for success, 0 for failure.

top
Verify
$status = $dsa->Verify();

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
top
VerifyKey
$retBool = $dsa->VerifyKey();

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
top