DSA Class

Properties   Methods   Events   Config Settings   Errors  

The DSA (Digital Signature Algorithm) class enables users to generate DSA hash signatures.

Syntax

ipworksencrypt.Dsa

Remarks

The DSA (Digital Signature Algorithm) class enables users to generate DSA hash signatures.

To begin you must either specify an existing key or create a new key. Existing private keys may be specified by setting Key. To create a new key call CreateKey. Alternatively an existing certificate may be specified by setting Certificate

Signing

To sign data first set Key or Certificate. Select the input file by setting SetInputStream, InputFile, or InputMessage. Next call Sign. The Sign method will automatically compute the hash, and then sign the hash with the specified key.

Send the public key (see CreateKey for details), file, and HashSignature to the recipient.

To sign a hash without recomputing the hash simply set HashValue to the pre-computed hash value before calling Sign.

Signature Verification

To verify a signature specify the input data using InputFile or InputMessage. Set SignerKey or SignerCert. Next set HashSignature and call VerifySignature. The VerifySignature method will return True if the signature was successfully verified.

To verify a hash signature without recomputing the hash simply set HashValue to the pre-computed hash value before calling VerifySignature.

Hash Notes

The class will determine whether or not to recompute the hash based on the properties that are set. If a file is specified by SetInputStream, InputFile, or InputMessage the hash will be recomputed when calling Sign or VerifySignature. If the HashValue property is set the class will only sign the hash or verify the hash signature. Setting SetInputStream, InputFile, or InputMessage clears the HashValue property. Setting the HashValue property clears the input file selection.

DSA Key Notes

A DSA key is made up of a number of individual parameters. When calling CreateKey the Key property is populated with a new private and public key.

After calling Sign the public key must be sent to the recipient along with HashSignature so they may perform signature verification. Likewise you must obtain the public key along with HashSignature in order to perform signature verification.

The public key consists of the following parameters:

• P
• Q
• G
• Y

The class also includes the PublicKey field which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both signature creation and verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in PublicKey in which case the individual parameters must be sent.

The private key consists of the following parameters:

• P
• Q
• G
• Y
• X

The class also include the PrivateKey field which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily..

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Certificate Property (DSA Class)

The certificate used for signing.

Syntax

public Certificate getCertificate();


public void setCertificate(Certificate certificate);

Remarks

This property specifies a certificate with private key.

This may be set instead of Key. This allows a Certificate object to be used instead of a DSAKey object. This certificate is used when calling Sign. The specified certificate must have a private key.

If both this property and Key are specified, Key will be used and this property will be ignored.

Please refer to the Certificate type for a complete list of fields.

HashAlgorithm Property (DSA Class)

The hash algorithm used for hash computation.

Syntax

public int getHashAlgorithm();


public void setHashAlgorithm(int hashAlgorithm);


Enumerated values:
  public final static int dhaSHA1 = 0;
  public final static int dhaSHA224 = 1;
  public final static int dhaSHA256 = 2;
  public final static int dhaSHA384 = 3;
  public final static int dhaSHA512 = 4;
  public final static int dhaRIPEMD160 = 5;

Default Value

2

Remarks

This property specifies the hash algorithm used for hash computation. This is only applicable when calling Sign or VerifySignature and HashValue is computed. Possible values are:

HashSignature Property (DSA Class)

The hash signature.

Syntax

public byte[] getHashSignature();


public void setHashSignature(byte[] hashSignature);

Default Value

""

Remarks

This property holds the computed hash signature. This is populated after calling Sign. This must be set before calling VerifySignature.

HashValue Property (DSA Class)

The hash value of the data.

Syntax

public byte[] getHashValue();


public void setHashValue(byte[] hashValue);

Default Value

""

Remarks

This property holds the computed hash value for the specified data. This is populated when calling Sign or VerifySignature when an input file is specified by setting SetInputStream, InputFile, or InputMessage.

If you know the hash value prior to using the class you may specify the pre-computed hash value here.

Hash Notes

The class will determine whether or not to recompute the hash based on the properties that are set. If a file is specified by SetInputStream, InputFile, or InputMessage the hash will be recomputed when calling Sign or VerifySignature. If the HashValue property is set the class will only sign the hash or verify the hash signature. Setting SetInputStream, InputFile, or InputMessage clears the HashValue property. Setting the HashValue property clears the input file selection.

InputFile Property (DSA Class)

The file to process.

Syntax

public String getInputFile();


public void setInputFile(String inputFile);

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

InputMessage Property (DSA Class)

The message to process.

Syntax

public byte[] getInputMessage();


public void setInputMessage(byte[] inputMessage);

Default Value

""

Remarks

This property specifies the message to be processed.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Key Property (DSA Class)

The DSA key.

Syntax

public DSAKey getKey();


public void setKey(DSAKey key);

Remarks

This property specifies the DSA key used to create a signature. This property must be set before calling Sign. Alternatively, a certificate may be specified by setting Certificate

DSA Key Notes

A DSA key is made up of a number of individual parameters. When calling CreateKey the Key property is populated with a new private and public key.

After calling Sign the public key must be sent to the recipient along with HashSignature so they may perform signature verification. Likewise you must obtain the public key along with HashSignature in order to perform signature verification.

The public key consists of the following parameters:

• P
• Q
• G
• Y

The class also includes the PublicKey field which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both signature creation and verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in PublicKey in which case the individual parameters must be sent.

The private key consists of the following parameters:

• P
• Q
• G
• Y
• X

The class also include the PrivateKey field which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

Please refer to the DSAKey type for a complete list of fields.

SignerCert Property (DSA Class)

The certificate used for signature verification.

Syntax

public Certificate getSignerCert();


public void setSignerCert(Certificate signerCert);

Remarks

This property specifies a certificate for signature verification.

This may be set instead of SignerKey. This allows a Certificate object to be used instead of a DSAKey object. This certificate is used when calling VerifySignature.

If both this property and SignerKey are specified, SignerKey will be used and this property will be ignored.

Please refer to the Certificate type for a complete list of fields.

SignerKey Property (DSA Class)

The public key used to verify the signature.

Syntax

public DSAKey getSignerKey();


public void setSignerKey(DSAKey signerKey);

Remarks

This property specifies the public key used to verify the signature. This public key corresponds to the private key used when creating the signature. This must be set before calling VerifySignature. Alternatively, a certificate may be specified by setting SignerCert

DSA Key Notes

A DSA key is made up of a number of individual parameters. When calling CreateKey the Key property is populated with a new private and public key.

After calling Sign the public key must be sent to the recipient along with HashSignature so they may perform signature verification. Likewise you must obtain the public key along with HashSignature in order to perform signature verification.

The public key consists of the following parameters:

• P
• Q
• G
• Y

The class also includes the PublicKey field which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both signature creation and verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in PublicKey in which case the individual parameters must be sent.

The private key consists of the following parameters:

• P
• Q
• G
• Y
• X

The class also include the PrivateKey field which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

Please refer to the DSAKey type for a complete list of fields.

UseHex Property (DSA Class)

Whether HashValue and HashSignature are hex encoded.

Syntax

public boolean isUseHex();


public void setUseHex(boolean useHex);

Default Value

False

Remarks

This property specifies whether HashValue and HashSignature are hex encoded.

If set to True, when Sign is called the class will compute the hash for the specified file and populate HashValue with the hex encoded hash value. It will then create the hash signature and populate HashSignature with the hex encoded hash signature value. If HashValue is specified directly it must be a hex encoded value.

If set to True, when VerifySignature is called the class will compute the hash value for the specified file and populate HashValue with the hex encoded hash value. It will then hex decode HashSignature and verify the signature. HashSignature must hold a hex encoded value. If HashValue is specified directly it must be a hex encoded value.

Config Method (Dsa Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateKey Method (Dsa Class)

Creates a new key.

Syntax

public void createKey();

Remarks

This method creates a new public and private key.

DSA Key Notes

A DSA key is made up of a number of individual parameters. When calling CreateKey the Key property is populated with a new private and public key.

After calling Sign the public key must be sent to the recipient along with HashSignature so they may perform signature verification. Likewise you must obtain the public key along with HashSignature in order to perform signature verification.

The public key consists of the following parameters:

• P
• Q
• G
• Y

The class also includes the PublicKey field which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both signature creation and verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in PublicKey in which case the individual parameters must be sent.

The private key consists of the following parameters:

• P
• Q
• G
• Y
• X

The class also include the PrivateKey field which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

Reset Method (Dsa Class)

Resets the class.

Syntax

public void reset();

Remarks

When called, the class will reset all of its properties to their default values.

SetInputStream Method (Dsa Class)

Sets the stream from which the class will read data to encrypt or decrypt.

Syntax

public void setInputStream(java.io.InputStream inputStream);

Remarks

This method sets the stream from which the class will read data to encrypt or decrypt.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Sign Method (Dsa Class)

Creates a hash signature.

Syntax

public void sign();

Remarks

This method will create a hash signature.

Before calling this method specify the input file by setting SetInputStream, InputFile, or InputMessage.

A key is required to create the hash signature. You may create a new key by calling CreateKey, or specify an existing key pair in Key. Alternatively, a certificate may be specified by setting Certificate. When this method is called the class will compute the hash for the specified file and populate HashValue. It will then create the hash signature using the specified Key and populate HashSignature.

To create the hash signature without first computing the hash simply specify HashValue before calling this method.

The Progress event will fire with updates for the hash computation progress only. The hash signature creation process is quick and does not require progress updates.

VerifySignature Method (Dsa Class)

Verifies the signature for the specified data.

Syntax

public boolean verifySignature();

Remarks

This method will verify a hash signature.

Before calling this method specify the input file by setting SetInputStream, InputFile, or InputMessage.

A public key and the hash signature are required to perform the signature verification. Specify the public key in SignerKey. Alternatively, a certificate may be specified by setting SignerCert. Specify the hash signature in HashSignature.

When this method is called the class will compute the hash for the specified file and populate HashValue. It will verify the signature using the specified SignerKey and HashSignature.

To verify the hash signature without first computing the hash simply specify HashValue before calling this method.

The Progress event will fire with updates for the hash computation progress only. The hash signature verification process is quick and does not require progress updates.

Error Event (Dsa Class)

Information about errors during data delivery.

Syntax

public class DefaultDsaEventListener implements DsaEventListener {
  ...
  public void error(DsaErrorEvent e) {}
  ...
}

public class DsaErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Progress Event (Dsa Class)

Fired as progress is made.

Syntax

public class DefaultDsaEventListener implements DsaEventListener {
  ...
  public void progress(DsaProgressEvent e) {}
  ...
}

public class DsaProgressEvent {
  public long bytesProcessed;
  public int percentProcessed;
}

Remarks

This event is fired automatically as data is processed by the class.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate( certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate( certificateData);

Parses CertificateData as an X509 public key.

public Certificate( certStoreType,  store,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate( certStoreType,  storeBlob,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

DSAKey Type

Contains the parameters for the DSA algorithm.

Remarks

This type is made up of fields that represent the private and public key parameters used by the DSA algorithm.

DSA Key Notes

A DSA key is made up of a number of individual parameters. When calling CreateKey the Key property is populated with a new private and public key.

After calling Sign the public key must be sent to the recipient along with HashSignature so they may perform signature verification. Likewise you must obtain the public key along with HashSignature in order to perform signature verification.

The public key consists of the following parameters:

• P
• Q
• G
• Y

The class also includes the PublicKey field which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both signature creation and verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in PublicKey in which case the individual parameters must be sent.

The private key consists of the following parameters:

• P
• Q
• G
• Y
• X

The class also include the PrivateKey field which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

Fields

Constructors

public DSAKey();

The default constructor creates a new DSAKey instance but does not assign a public or private key.

public DSAKey( P,  Q,  G,  Y);

The public key constructor assigns an existing public key.

public DSAKey( P,  Q,  G,  Y,  X);

The private key constructor assigns an existing private key.

Config Settings (Dsa Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

DSA Config Settings

Base Config Settings

Trappable Errors (Dsa Class)

DSA Errors

	102   No Key specified.
	104   Cannot read or write file.
	105   Key parameters incorrect.
	106   Cannot create hash.
	113   Input data or HashValue must be specified.
	121   Invalid certificate.
	124   HashSignature must be specified.
	304   Cannot write file.
	305   Cannot read file.