gnu.java.security.sig

Class BaseSignature

Implemented Interfaces:
Cloneable, ISignature
Known Direct Subclasses:
DSSSignature, RSAPKCS1V1_5Signature, RSAPSSSignature

public abstract class BaseSignature
extends Object
implements ISignature

A base abstract class to facilitate implementations of concrete Signatures.

Field Summary

protected IMessageDigest
md
The underlying message digest instance for this signature scheme.
protected PrivateKey
privateKey
The private key to use when generating signatures (signing).
protected PublicKey
publicKey
The public key to use when verifying signatures.
protected String
schemeName
The canonical name of this signature scheme.

Fields inherited from interface gnu.java.security.sig.ISignature

SIGNER_KEY, SOURCE_OF_RANDOMNESS, VERIFIER_KEY

Constructor Summary

BaseSignature(String schemeName, IMessageDigest md)
Trivial constructor.

Method Summary

abstract Object
clone()
Returns a clone copy of this instance.
protected abstract Object
generateSignature()
protected void
init()
Initialises the internal fields of this instance.
String
name()
Returns the canonical name of this signature scheme.
protected void
nextRandomBytes(byte[] buffer)
Fills the designated byte array with random data.
protected abstract void
setupForSigning(PrivateKey key)
protected abstract void
setupForVerification(PublicKey key)
void
setupSign(Map<K,V> attributes)
Initialises this instance for signature generation.
void
setupVerify(Map<K,V> attributes)
Initialises this instance for signature verification.
Object
sign()
Terminates a signature generation phase by digesting and processing the context of the underlying message digest algorithm instance.
void
update(byte b)
Digests one byte of a message for signing or verification purposes.
void
update(byte[] b, int off, int len)
Digests a sequence of bytes from a message for signing or verification purposes.
boolean
verify(Object sig)
Terminates a signature verification phase by digesting and processing the context of the underlying message digest algorithm instance.
protected abstract boolean
verifySignature(Object signature)

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

md

protected IMessageDigest md
The underlying message digest instance for this signature scheme.

privateKey

protected PrivateKey privateKey
The private key to use when generating signatures (signing).

publicKey

protected PublicKey publicKey
The public key to use when verifying signatures.

schemeName

protected String schemeName
The canonical name of this signature scheme.

Constructor Details

BaseSignature

protected BaseSignature(String schemeName,
                        IMessageDigest md)
Trivial constructor.
Parameters:
schemeName - the name of this signature scheme.
md - the underlying instance of the message digest algorithm.
Throws:
IllegalArgumentException - if the designated hash instance is null.

Method Details

clone

public abstract Object clone()
Returns a clone copy of this instance.
Specified by:
clone in interface ISignature
Overrides:
clone in interface Object
Returns:
a clone copy of this instance.

generateSignature

protected abstract Object generateSignature()
            throws IllegalStateException

init

protected void init()
Initialises the internal fields of this instance.

name

public String name()
Returns the canonical name of this signature scheme.
Specified by:
name in interface ISignature
Returns:
the canonical name of this instance.

nextRandomBytes

protected void nextRandomBytes(byte[] buffer)
Fills the designated byte array with random data.
Parameters:
buffer - the byte array to fill with random data.

setupForSigning

protected abstract void setupForSigning(PrivateKey key)
            throws IllegalArgumentException

setupForVerification

protected abstract void setupForVerification(PublicKey key)
            throws IllegalArgumentException

setupSign

public void setupSign(Map<K,V> attributes)
            throws IllegalArgumentException
Initialises this instance for signature generation.
Specified by:
setupSign in interface ISignature
Parameters:
attributes - the attributes to use for setting up this instance.
Throws:
IllegalArgumentException - if the designated private key is not appropriate for this signature scheme.

setupVerify

public void setupVerify(Map<K,V> attributes)
            throws IllegalArgumentException
Initialises this instance for signature verification.
Specified by:
setupVerify in interface ISignature
Parameters:
attributes - the attributes to use for setting up this instance.
Throws:
IllegalArgumentException - if the designated public key is not appropriate for this signature scheme.

sign

public Object sign()
Terminates a signature generation phase by digesting and processing the context of the underlying message digest algorithm instance.
Specified by:
sign in interface ISignature
Returns:
a Object representing the native output of the signature scheme implementation.
Throws:
IllegalStateException - if this instance was not setup for signature generation.

update

public void update(byte b)
Digests one byte of a message for signing or verification purposes.
Specified by:
update in interface ISignature
Parameters:
b - the message byte to digest.
Throws:
IllegalStateException - if this instance was not setup for signature generation/verification.

update

public void update(byte[] b,
                   int off,
                   int len)
Digests a sequence of bytes from a message for signing or verification purposes.
Specified by:
update in interface ISignature
Parameters:
Throws:
IllegalStateException - if this instance was not setup for signature generation/verification.

verify

public boolean verify(Object sig)
Terminates a signature verification phase by digesting and processing the context of the underlying message digest algorithm instance.
Specified by:
verify in interface ISignature
Parameters:
Returns:
true iff the outpout of the verification phase confirms that the designated signature object has been generated using the corresponding public key of the recepient.
Throws:
IllegalStateException - if this instance was not setup for signature verification.

verifySignature

protected abstract boolean verifySignature(Object signature)
            throws IllegalStateException

BaseSignature.java -- Copyright (C) 2001, 2002, 2003, 2006 Free Software Foundation, Inc. This file is a part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.