CkDsa PHP Extension Reference Documentation

CkDsa

Current Version: 10.1.0

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

$obj = new CkDsa();

Properties

DebugLogFilePath

string debugLogFilePath();
void put_DebugLogFilePath(string 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:

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

More Information and Examples

Example showing how to use DebugLogFilePath.

GroupSize

int get_GroupSize()
void put_GroupSize(int 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.

Hash

void get_Hash(CkByteData byteData)
void put_Hash(CkByteData byteData);

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

(read-only)
string 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.

HexP

(read-only)
string 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.

HexQ

(read-only)
string 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.

HexX

(read-only)
string hexX();

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

HexY

(read-only)
string 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.)

LastErrorHtml

(read-only)
string 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.

LastErrorText

(read-only)
string 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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

(read-only)
string 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.

LastMethodSuccess

bool get_LastMethodSuccess()
void put_LastMethodSuccess(bool boolVal);

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false 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 = true and failure = false.
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 true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

Signature

void get_Signature(CkByteData byteData)
void put_Signature(CkByteData byteData);

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

UncommonOptions

string uncommonOptions();
void put_UncommonOptions(string strVal);

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.

Utf8

bool get_Utf8()
void put_Utf8(bool boolVal);

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

VerboseLogging

bool get_VerboseLogging()
void put_VerboseLogging(bool boolVal);

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

Version

(read-only)
string version();

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

FromDer

bool FromDer(CkByteData derData);

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

Returns true for success, false for failure.

FromDerFile

bool FromDerFile(string path);

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

Returns true for success, false for failure.

More Information and Examples

Convert DSA DER Private Key to PEM

FromEncryptedPem

bool FromEncryptedPem(string password, string 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 true for success, false for failure.

FromPem

bool FromPem(string pemData);

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

Returns true for success, false for failure.

More Information and Examples

DSA Signature Create and Verify

FromPublicDer

bool FromPublicDer(CkByteData derData);

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

Returns true for success, false for failure.

FromPublicDerFile

bool FromPublicDerFile(string path);

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

Returns true for success, false for failure.

FromPublicPem

bool FromPublicPem(string pemData);

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

Returns true for success, false for failure.

FromXml

bool FromXml(string xmlKey);

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

Returns true for success, false for failure.

GenKey

bool GenKey(int 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 true for success, false for failure.

More Information and Examples

DSA Generate Key

GenKey2

bool GenKey2(int keyLenBits, int modLenBits);

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 true for success, false for failure.

GenKeyFromParamsDer

bool GenKeyFromParamsDer(CkByteData 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 true for success, false for failure.

GenKeyFromParamsDerFile

bool GenKeyFromParamsDerFile(string 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 true for success, false for failure.

More Information and Examples

Generate new DSA Key from OpenSSL Parameters File

GenKeyFromParamsPem

bool GenKeyFromParamsPem(string 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 true for success, false for failure.

GenKeyFromParamsPemFile

bool GenKeyFromParamsPemFile(string 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 true for success, false for failure.

GenKeyFromPQG

bool GenKeyFromPQG(string pHex, string qHex, string gHex);

Introduced in version 9.5.0.90

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

Returns true for success, false for failure.

GetEncodedHash

bool GetEncodedHash(string encoding, CkString outStr);
string getEncodedHash(string 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 true for success, false for failure.

GetEncodedSignature

bool GetEncodedSignature(string encoding, CkString outStr);
string getEncodedSignature(string 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 true for success, false for failure.

LoadText

bool LoadText(string path, CkString outStr);
string loadText(string 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 true for success, false for failure.

SaveText

bool SaveText(string strToSave, string path);

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

Returns true for success, false for failure.

SetEncodedHash

bool SetEncodedHash(string encoding, string 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 true for success, false for failure.

SetEncodedSignature

bool SetEncodedSignature(string encoding, string 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 true for success, false for failure.

SetEncodedSignatureRS

bool SetEncodedSignatureRS(string encoding, string encodedR, string 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 true for success, false for failure.

SetKeyExplicit

bool SetKeyExplicit(int groupSizeInBytes, string pHex, string qHex, string gHex, string 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 true for success, false for failure.

SetPubKeyExplicit

bool SetPubKeyExplicit(int groupSizeInBytes, string pHex, string qHex, string gHex, string 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 true for success, false for failure.

SignHash

bool 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 true, the signature may be retrieved by either calling GetEncodedHash, or by accessing the Signature property.

Returns true for success, false for failure.

More Information and Examples

DSA Signature Create and Verify

ToDer

bool ToDer(CkByteData outBytes);

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

Returns true for success, false for failure.

ToDerFile

bool ToDerFile(string path);

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

Returns true for success, false for failure.

More Information and Examples

DSA Generate Key

ToEncryptedPem

bool ToEncryptedPem(string password, CkString outStr);
string toEncryptedPem(string password);

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

Returns true for success, false for failure.

More Information and Examples

DSA Generate Key Convert DSA DER Private Key to PEM

ToPem

bool ToPem(CkString outStr);
string toPem();

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

Returns true for success, false for failure.

More Information and Examples

Convert DSA DER Private Key to PEM

ToPublicDer

bool ToPublicDer(CkByteData outBytes);

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

Returns true for success, false for failure.

ToPublicDerFile

bool ToPublicDerFile(string path);

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

Returns true for success, false for failure.

More Information and Examples

DSA Generate Key

ToPublicPem

bool ToPublicPem(CkString outStr);
string toPublicPem();

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

Returns true for success, false for failure.

More Information and Examples

DSA Generate Key

ToXml

bool ToXml(bool bPublicOnly, CkString outStr);
string toXml(bool 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 true for success, false for failure.

More Information and Examples

DSA Get Key as XML

Verify

bool 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 true for success, false for failure.

More Information and Examples

DSA Signature Create and Verify DSA R,S Signature Values

VerifyKey

bool VerifyKey();

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

More Information and Examples

DSA Signature Create and Verify