org.dihedron.crypto.operations.sign

Class Signer

java.lang.Object

org.dihedron.crypto.CryptoService

org.dihedron.crypto.operations.sign.Signer

Direct Known Subclasses:

PDFSigner, PKCS7Signer

@License
public abstract class Signer
extends CryptoService

This class acts as the base class, providing common functionalities, to all fashions of signers.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	alias The alias identifying the certificate to be used for signing.
protected boolean	encapsulate Whether the signer should encapsulate data along with the signature.
protected KeyRing	keyring The key ring (as a wrapper and helper to access the key store).
protected Provider	provider The security provider.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Signer(String alias, KeyRing keyring, Provider provider) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isEncapsulateData() Returns whether the data is going to be encapsulated along with the signature.
void	setEncapsulateData(boolean encapsulate) Sets whether the data should be encapsulated along with the signature, or the signature is detached.
abstract byte[]	sign(byte[] data) Signs the given set of data.
abstract void	sign(InputStream input, OutputStream output) Signs the given set of data; the caller must make sure both input and output stream are properly closed once the processing is complete.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

alias

protected String alias

The alias identifying the certificate to be used for signing.

keyring

protected KeyRing keyring

The key ring (as a wrapper and helper to access the key store).

provider

protected Provider provider

The security provider.

encapsulate

protected boolean encapsulate

Whether the signer should encapsulate data along with the signature.

Constructor Detail

Signer

protected Signer(String alias,
      KeyRing keyring,
      Provider provider)
          throws CryptoException

Constructor.

Parameters:

alias - the alias of the certificate to be used for signing.

keyring - the key ring, as a wrapper and helper to acces the key store.

provider - the security provider supporting and exposing the key store capabilities.

Throws:

CryptoException - if any of the input parameters is null.

Method Detail

setEncapsulateData

public void setEncapsulateData(boolean encapsulate)

Sets whether the data should be encapsulated along with the signature, or the signature is detached.

Parameters:

encapsulate - whether the data is encapsulated along with the signature.

isEncapsulateData

public boolean isEncapsulateData()

Returns whether the data is going to be encapsulated along with the signature.

Returns:

whether the data is going to be encapsulated along with the signature.

sign

public abstract byte[] sign(byte[] data)
                     throws CryptoException

Signs the given set of data.

Parameters:

data - the data to be signed.

Returns:

the signed data as a byte array.

Throws:

CryptoException

sign

public abstract void sign(InputStream input,
        OutputStream output)
                   throws CryptoException

Signs the given set of data; the caller must make sure both input and output stream are properly closed once the processing is complete.

Parameters:

input - the stream providing the data to be signed, as an input stream.

output - a stream to write to.

Throws:

CryptoException