Chilkat C# Dsa Class Reference
Dsa
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
(C#)
Chilkat.Dsa obj = new Chilkat.Dsa();
(VB.NET)
Dim obj As New Chilkat.Dsa()
Properties
public bool EnableEvents {get; set; }
This property must be set to true to enable events. By default, it is false.
public int GroupSize {get; set; }
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.
public byte[] Hash {get; set; }
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.
public string HexG {get; }
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.
public string HexP {get; }
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.
public string HexQ {get; }
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.
public string HexX {get; }
The "X" part of a DSA private key returned as a hex-encoded SSH1-format bignum.
public string HexY {get; }
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.)
public string LastErrorHtml {get; }
Error information in HTML format for the last method called.
public string LastErrorText {get; }
Error information in plain-text format for the last method called.
public string LastErrorXml {get; }
Error information in XML format for the last method called.
public byte[] Signature {get; set; }
The signature created by calling SignHash. If verifying a signature, this may be set prior to calling the Verify method.
public string Version {get; }
A version string such as "1.3.0"
Methods
public bool FromDer(byte[] derData);
Loads a DSA private key from in-memory DSA DER encoded bytes. Returns true for success, false for failure.
public bool FromDerFile(string filename);
Loads a DSA private key from a DER-encoded file. Returns true for success, false for failure.
public 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.
public bool FromPem(string pemData);
Loads a DSA private key from an in-memory unencrypted PEM-formatted string. Returns true for success, false for failure.
public bool FromPublicDer(byte[] derData);
Loads a DSA public key from an in-memory DER-encoded byte array. Returns true for success, false for failure.
public bool FromPublicDerFile(string filename);
Loads a DSA public key from a DER-encoded file. Returns true for success, false for failure.
public bool FromPublicPem(string pemData);
Loads a DSA public-key from an in-memory PEM string. Returns true for success, false for failure.
public bool FromXml(string xmlKey);
Loads a DSA public or private key from an in-memory XML string. Returns true for success, false for failure.
public 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.
public bool GenKeyFromParamsDer(byte[] 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.
public bool GenKeyFromParamsDerFile(string 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.
public 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.
public bool GenKeyFromParamsPemFile(string 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.
public 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 a null on failure
public 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 a null on failure
public bool LoadText(string filename, string 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.
public bool SaveLastError(string filename);
Saves the last error information to an XML formatted file.
public bool SaveText(string strToSave, string 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public byte[] ToDer();
Writes the DSA private key to a DER-encoded byte array. Returns an empty byte array on failure
public bool ToDerFile(string filename);
Writes the DSA private key to a DER-format file. Returns true for success, false for failure.
public string ToEncryptedPem(string password);
Writes the DSA private key to an in-memory encrypted PEM string. Returns a null on failure
public string ToPem();
Writes the DSA private key to an in-memory PEM string. Returns a null on failure
public byte[] ToPublicDer();
Writes the DSA public key to a DER-encoded byte array. Returns an empty byte array on failure
public bool ToPublicDerFile(string filename);
Writes the DSA public key to a DER-format file. Returns true for success, false for failure.
public string ToPublicPem();
Writes the DSA public key to an in-memory PEM string. Returns a null on failure
public 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 a null on failure
public bool UnlockComponent(string unlockCode);
Unlocks the component. This must be called once prior to calling any other method. Returns true for success, false for failure.
public 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.
public bool VerifyKey();
Verifies that the public or private key contained in the calling Dsa object is valid. Returns true if valid, otherwise returns false.
|