CkDsa Ruby Programming
Reference Documentation

CkDsa

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

# Returns an integer value
get_GroupSize( )

# newVal is an integer (input)
put_GroupSize( newVal )

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.

# data is a CkByteData object (output)
get_Hash( data )

# data is a CkByteData object (output)
put_Hash( data )

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.

# str is a CkString object (output)
get_HexG( str )

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.

# str is a CkString object (output)
get_HexP( str )

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.

# str is a CkString object (output)
get_HexQ( str )

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.

# str is a CkString object (output)
get_HexX( str )

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

# str is a CkString object (output)
get_HexY( str )

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

# str is a CkString object (output)
LastErrorHtml( str )

Error information in HTML format for the last method called.

# str is a CkString object (output)
LastErrorText( str )

Error information in plain-text format for the last method called.

# str is a CkString object (output)
LastErrorXml( str )

Error information in XML format for the last method called.

# data is a CkByteData object (output)
get_Signature( data )

# data is a CkByteData object (output)
put_Signature( data )

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

# Returns a boolean value
get_Utf8( )

# b is a boolean (input)
put_Utf8( b )

To be documented soon...

# str is a CkString object (output)
get_Version( str )

A version string such as "1.3.0"

Methods

# derData is a CkByteData object (output)
# Returns a boolean value
FromDer( derData )

Loads a DSA private key from in-memory DSA DER encoded bytes.
Returns true for success, false for failure.

# filename is a string (input)
# Returns a boolean value
FromDerFile( filename )

Loads a DSA private key from a DER-encoded file.
Returns true for success, false for failure.

# password is a string (input)
# pemData is a string (input)
# Returns a boolean value
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 true for success, false for failure.

# pemData is a string (input)
# Returns a boolean value
FromPem( pemData )

Loads a DSA private key from an in-memory unencrypted PEM-formatted string.
Returns true for success, false for failure.

# derData is a CkByteData object (output)
# Returns a boolean value
FromPublicDer( derData )

Loads a DSA public key from an in-memory DER-encoded byte array.
Returns true for success, false for failure.

# filename is a string (input)
# Returns a boolean value
FromPublicDerFile( filename )

Loads a DSA public key from a DER-encoded file.
Returns true for success, false for failure.

# pemData is a string (input)
# Returns a boolean value
FromPublicPem( pemData )

Loads a DSA public-key from an in-memory PEM string.
Returns true for success, false for failure.

# xmlKey is a string (input)
# Returns a boolean value
FromXml( xmlKey )

Loads a DSA public or private key from an in-memory XML string.
Returns true for success, false for failure.

# numBits is an integer (input)
# Returns a boolean value
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 true for success, false for failure.

# derBytes is a CkByteData object (output)
# Returns a boolean value
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 true for success, false for failure.

# filename is a string (input)
# Returns a boolean value
GenKeyFromParamsDerFile( filename )

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.

# pem is a string (input)
# Returns a boolean value
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 true for success, false for failure.

# filename is a string (input)
# Returns a boolean value
GenKeyFromParamsPemFile( filename )

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.

# encoding is a string (input)
# outStr is a CkString object (output)
# Returns a boolean value
GetEncodedHash( encoding, outStr )

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.

# encoding is a string (input)
# outStr is a CkString object (output)
# Returns a boolean value
GetEncodedSignature( encoding, outStr )

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.

# filename is a string (input)
# outStr is a CkString object (output)
# Returns a boolean value
LoadText( filename, outStr )

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.

# filename is a string (input)
# Returns a boolean value
SaveLastError( filename )

Saves the last error information to an XML formatted file.

# strToSave is a string (input)
# filename is a string (input)
# Returns a boolean value
SaveText( strToSave, filename )

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.

# encoding is a string (input)
# encodedHash is a string (input)
# Returns a boolean value
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 true for success, false for failure.

# encoding is a string (input)
# encodedSig is a string (input)
# Returns a boolean value
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 true for success, false for failure.

# groupSizeInBytes is an integer (input)
# pHex is a string (input)
# qHex is a string (input)
# gHex is a string (input)
# xHex is a string (input)
# Returns a boolean value
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 true for success, false for failure.

# groupSizeInBytes is an integer (input)
# pHex is a string (input)
# qHex is a string (input)
# gHex is a string (input)
# yHex is a string (input)
# Returns a boolean value
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 true for success, false for failure.

# Returns a boolean value
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.

# outBytes is a CkByteData object (output)
# Returns a boolean value
ToDer( outBytes )

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

# filename is a string (input)
# Returns a boolean value
ToDerFile( filename )

Writes the DSA private key to a DER-format file.
Returns true for success, false for failure.

# password is a string (input)
# outStr is a CkString object (output)
# Returns a boolean value
ToEncryptedPem( password, outStr )

Writes the DSA private key to an in-memory encrypted PEM string.
Returns true for success, false for failure.

# outStr is a CkString object (output)
# Returns a boolean value
ToPem( outStr )

Writes the DSA private key to an in-memory PEM string.
Returns true for success, false for failure.

# outBytes is a CkByteData object (output)
# Returns a boolean value
ToPublicDer( outBytes )

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

# filename is a string (input)
# Returns a boolean value
ToPublicDerFile( filename )

Writes the DSA public key to a DER-format file.
Returns true for success, false for failure.

# outStr is a CkString object (output)
# Returns a boolean value
ToPublicPem( outStr )

Writes the DSA public key to an in-memory PEM string.
Returns true for success, false for failure.

# bPublicOnly is a boolean (input)
# outStr is a CkString object (output)
# Returns a boolean value
ToXml( bPublicOnly, outStr )

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.

# unlockCode is a string (input)
# Returns a boolean value
UnlockComponent( unlockCode )

Unlocks the component. This must be called once prior to calling any other method.
Returns true for success, false for failure.

# Returns a boolean value
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.

# Returns a boolean value
VerifyKey( )

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

# encoding is a string (input)
# Returns a string
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 true for success, false for failure.

# encoding is a string (input)
# Returns a string
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 true for success, false for failure.

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

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

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

# Returns a string
hexX( )

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

# Returns a 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.)

# Returns a string
lastErrorHtml( )

Error information in HTML format for the last method called.

# Returns a string
lastErrorText( )

Error information in plain-text format for the last method called.

# Returns a string
lastErrorXml( )

Error information in XML format for the last method called.

# password is a string (input)
# Returns a string
toEncryptedPem( password )

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

# Returns a string
toPem( )

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

# Returns a string
toPublicPem( )

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

# bPublicOnly is a boolean (input)
# Returns a string
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 a string
version( )

A version string such as "1.3.0"

CkDsa Ruby ProgrammingReference Documentation

CkDsa

CkDsa Ruby Programming
Reference Documentation