gnu.java.security.provider

Class RSA

Implemented Interfaces:
Cloneable
Known Direct Subclasses:
MD2withRSA, MD4withRSA, MD5withRSA, SHA1withRSA

public abstract class RSA
extends SignatureSpi
implements Cloneable

Field Summary

protected static OID
DIGEST_ALGORITHM
digestAlgorithm OBJECT IDENTIFIER ::= { iso(1) member-body(2) US(840) rsadsi(113549) digestAlgorithm(2) }
protected OID
digestAlgorithm
protected MessageDigest
md
protected RSAPrivateKey
signerKey
protected RSAPublicKey
verifierKey

Fields inherited from class java.security.SignatureSpi

appRandom

Constructor Summary

RSA(MessageDigest md, OID digestAlgorithm)

Method Summary

Object
clone()
Returns a clone if the implementation is cloneable.
protected Object
engineGetParameter(String param)
Deprecated.
protected void
engineInitSign(PrivateKey privateKey)
Initializes this signature object with the specified private key for signing operations.
protected void
engineInitSign(PrivateKey privateKey, SecureRandom random)
Initializes this signature object with the specified private key and source of randomness for signing operations.

This concrete method has been added to this previously-defined abstract class.

protected void
engineInitVerify(PublicKey publicKey)
Initializes this signature object with the specified public key for verification operations.
protected void
engineSetParameter(String param, Object value)
Deprecated. Replaced by engineSetParameter(AlgorithmParameterSpec).
protected byte[]
engineSign()
Returns the signature bytes of all the data updated so far.
protected int
engineSign(byte[] out, int off, int len)
Finishes this signature operation and stores the resulting signature bytes in the provided buffer outbuf, starting at offset .
protected void
engineUpdate(byte b)
Updates the data to be signed or verified using the specified byte.
protected void
engineUpdate(byte[] buf, int off, int len)
Updates the data to be signed or verified, using the specified array of bytes, starting at the specified offset.
protected boolean
engineVerify(byte[] sig)
Verifies the passed-in signature.
protected boolean
engineVerify(byte[] sig, int off, int len)
Verifies the passed-in signature in the specified array of bytes, starting at the specified offset.

Note: Subclasses should overwrite the default implementation.

Methods inherited from class java.security.SignatureSpi

clone, engineGetParameter, engineGetParameters, engineInitSign, engineInitSign, engineInitVerify, engineSetParameter, engineSetParameter, engineSign, engineSign, engineUpdate, engineUpdate, engineVerify, engineVerify

Methods inherited from class java.lang.Object

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

Field Details

DIGEST_ALGORITHM

protected static final OID DIGEST_ALGORITHM
digestAlgorithm OBJECT IDENTIFIER ::= { iso(1) member-body(2) US(840) rsadsi(113549) digestAlgorithm(2) }

digestAlgorithm

protected final OID digestAlgorithm

md

protected final MessageDigest md

signerKey

protected RSAPrivateKey signerKey

verifierKey

protected RSAPublicKey verifierKey

Constructor Details

RSA

protected RSA(MessageDigest md,
              OID digestAlgorithm)

Method Details

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone if the implementation is cloneable.
Overrides:
clone in interface SignatureSpi
Returns:
a clone if the implementation is cloneable.
Throws:
CloneNotSupportedException - if this is called on an implementation that does not support Cloneable.
See Also:
Cloneable

engineGetParameter

protected Object engineGetParameter(String param)

Deprecated.

Gets the value of the specified algorithm parameter. This method supplies a general-purpose mechanism through which it is possible to get the various parameters of this object. A parameter may be any settable parameter for the algorithm, such as a parameter size, or a source of random bits for signature generation (if appropriate), or an indication of whether or not to perform a specific but optional computation. A uniform algorithm-specific naming scheme for each parameter is desirable but left unspecified at this time.
Overrides:
engineGetParameter in interface SignatureSpi
Parameters:
param - the string name of the parameter.
Returns:
the object that represents the parameter value, or null if there is none.
Throws:
InvalidParameterException - if param is an invalid parameter for this engine, or another exception occurs while trying to get this parameter.

engineInitSign

protected void engineInitSign(PrivateKey privateKey)
            throws InvalidKeyException
Initializes this signature object with the specified private key for signing operations.
Overrides:
engineInitSign in interface SignatureSpi
Parameters:
privateKey - the private key of the identity whose signature will be generated.
Throws:
InvalidKeyException - if the key is improperly encoded, parameters are missing, and so on.

engineInitSign

protected void engineInitSign(PrivateKey privateKey,
                              SecureRandom random)
            throws InvalidKeyException
Initializes this signature object with the specified private key and source of randomness for signing operations.

This concrete method has been added to this previously-defined abstract class. (For backwards compatibility, it cannot be abstract.)

Overrides:
engineInitSign in interface SignatureSpi
Parameters:
privateKey - the private key of the identity whose signature will be generated.
random - the source of randomness.
Throws:
InvalidKeyException - if the key is improperly encoded, parameters are missing, and so on.
Since:
1.2

engineInitVerify

protected void engineInitVerify(PublicKey publicKey)
            throws InvalidKeyException
Initializes this signature object with the specified public key for verification operations.
Overrides:
engineInitVerify in interface SignatureSpi
Parameters:
publicKey - the public key of the identity whose signature is going to be verified.
Throws:
InvalidKeyException - if the key is improperly encoded, parameters are missing, and so on.

engineSetParameter

protected void engineSetParameter(String param,
                                  Object value)

Deprecated. Replaced by engineSetParameter(AlgorithmParameterSpec).

Sets the specified algorithm parameter to the specified value. This method supplies a general-purpose mechanism through which it is possible to set the various parameters of this object. A parameter may be any settable parameter for the algorithm, such as a parameter size, or a source of random bits for signature generation (if appropriate), or an indication of whether or not to perform a specific but optional computation. A uniform algorithm-specific naming scheme for each parameter is desirable but left unspecified at this time.
Overrides:
engineSetParameter in interface SignatureSpi
Parameters:
param - the string identifier of the parameter.
value - the parameter value.
Throws:
InvalidParameterException - if param is an invalid parameter for this signature algorithm engine, the parameter is already set and cannot be set again, a security exception occurs, and so on.

engineSign

protected byte[] engineSign()
            throws SignatureException
Returns the signature bytes of all the data updated so far. The format of the signature depends on the underlying signature scheme.
Overrides:
engineSign in interface SignatureSpi
Returns:
the signature bytes of the signing operation's result.
Throws:
SignatureException - if the engine is not initialized properly.

engineSign

protected int engineSign(byte[] out,
                         int off,
                         int len)
            throws SignatureException
Finishes this signature operation and stores the resulting signature bytes in the provided buffer outbuf, starting at offset . The format of the signature depends on the underlying signature scheme.

The signature implementation is reset to its initial state (the state it was in after a call to one of the engineInitSign() methods) and can be reused to generate further signatures with the same private key. This method should be abstract, but we leave it concrete for binary compatibility. Knowledgeable providers should override this method.

Overrides:
engineSign in interface SignatureSpi
Parameters:
len - number of bytes within outbuf allotted for the signature. Both this default implementation and the GNU provider do not return partial digests. If the value of this parameter is less than the actual signature length, this method will throw a SignatureException. This parameter is ignored if its value is greater than or equal to the actual signature length.
Returns:
the number of bytes placed into outbuf.
Throws:
SignatureException - if an error occurs or len is less than the actual signature length.
Since:
1.2

engineUpdate

protected void engineUpdate(byte b)
            throws SignatureException
Updates the data to be signed or verified using the specified byte.
Overrides:
engineUpdate in interface SignatureSpi
Parameters:
b - the byte to use for the update.
Throws:
SignatureException - if the engine is not initialized properly.

engineUpdate

protected void engineUpdate(byte[] buf,
                            int off,
                            int len)
            throws SignatureException
Updates the data to be signed or verified, using the specified array of bytes, starting at the specified offset.
Overrides:
engineUpdate in interface SignatureSpi
Parameters:
off - the offset to start from in the array of bytes.
len - the number of bytes to use, starting at offset.
Throws:
SignatureException - if the engine is not initialized properly.

engineVerify

protected boolean engineVerify(byte[] sig)
            throws SignatureException
Verifies the passed-in signature.
Overrides:
engineVerify in interface SignatureSpi
Parameters:
Returns:
true if the signature was verified, false if not.
Throws:
SignatureException - if the engine is not initialized properly, or the passed-in signature is improperly encoded or of the wrong type, etc.

engineVerify

protected boolean engineVerify(byte[] sig,
                               int off,
                               int len)
            throws SignatureException
Verifies the passed-in signature in the specified array of bytes, starting at the specified offset.

Note: Subclasses should overwrite the default implementation.

Overrides:
engineVerify in interface SignatureSpi
Parameters:
Returns:
true if the signature was verified, false if not.
Throws:
SignatureException - if the engine is not initialized properly, or the passed-in signature is improperly encoded or of the wrong type, etc.

RSA.java -- RSA PKCS#1 signatures. Copyright (C) 2004 Free Software Foundation, Inc. This file is 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, 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; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, 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.