Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

gnu.java.security.key.rsa

Class GnuRSAPrivateKey

Implemented Interfaces:
Key, PrivateKey, RSAKey, RSAPrivateCrtKey, RSAPrivateKey, Serializable
public class GnuRSAPrivateKey
extends GnuRSAKey
implements PrivateKey, RSAPrivateCrtKey
An object that embodies an RSA private key.

References:

  1. RSA-PSS Signature Scheme with Appendix, part B.
    Primitive specification and supporting documentation.
    Jakob Jonsson and Burt Kaliski.

Field Summary

Fields inherited from class gnu.java.security.key.rsa.GnuRSAKey

defaultFormat

Fields inherited from interface java.security.Key

serialVersionUID

Fields inherited from interface java.security.PrivateKey

serialVersionUID

Fields inherited from interface java.security.interfaces.RSAPrivateCrtKey

serialVersionUID

Fields inherited from interface java.security.interfaces.RSAPrivateKey

serialVersionUID

Constructor Summary

GnuRSAPrivateKey(int preferredFormat, BigInteger p, BigInteger q, BigInteger e, BigInteger d)
Constructs a new instance of a GnuRSAPrivateKey given the designated arguments.
GnuRSAPrivateKey(int preferredFormat, BigInteger n, BigInteger e, BigInteger d, BigInteger p, BigInteger q, BigInteger dP, BigInteger dQ, BigInteger qInv)
Constructs a new instance of a GnuRSAPrivateKey given the designated arguments.
GnuRSAPrivateKey(BigInteger p, BigInteger q, BigInteger e, BigInteger d)
Convenience constructor.

Method Summary

boolean
equals(Object obj)
Returns true if the designated object is an instance of this class and has the same RSA parameter values as this one.
BigInteger
getCrtCoefficient()
Returns the CRT coefficient
byte[]
getEncoded(int format)
Returns the encoded form of this private key according to the designated format.
BigInteger
getPrimeExponentP()
Returns the primeExponentP
BigInteger
getPrimeExponentQ()
Returns the primeExponentQ
BigInteger
getPrimeP()
Returns the primeP value
BigInteger
getPrimeQ()
Returns the primeQ value
BigInteger
getPrivateExponent()
Returns the private exponent value for this key
String
toString()
Convert this Object to a human-readable String.
static GnuRSAPrivateKey
valueOf(byte[] k)
A class method that takes the output of the encodePrivateKey() method of an RSA keypair codec object (an instance implementing IKeyPairCodec for RSA keys, and re-constructs an instance of this object.

Methods inherited from class gnu.java.security.key.rsa.GnuRSAKey

equals, getAlgorithm, getE, getEncoded, getEncoded, getFormat, getModulus, getN, getPublicExponent, toString

Methods inherited from class java.lang.Object

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

Constructor Details

GnuRSAPrivateKey

public GnuRSAPrivateKey(int preferredFormat,
                        BigInteger p,
                        BigInteger q,
                        BigInteger e,
                        BigInteger d)
Constructs a new instance of a GnuRSAPrivateKey given the designated arguments.
Parameters:
preferredFormat - the indetifier of the preferred encoding format to use when externalizing this key.
p - the modulus first prime divisor.
q - the modulus second prime divisor.
e - the public exponent.
d - the private exponent.

GnuRSAPrivateKey

public GnuRSAPrivateKey(int preferredFormat,
                        BigInteger n,
                        BigInteger e,
                        BigInteger d,
                        BigInteger p,
                        BigInteger q,
                        BigInteger dP,
                        BigInteger dQ,
                        BigInteger qInv)
Constructs a new instance of a GnuRSAPrivateKey given the designated arguments.
Parameters:
preferredFormat - the indetifier of the preferred encoding format to use when externalizing this key.
n - the public modulus, which is also the product of p and q.
e - the public exponent.
d - the private exponent.
p - the modulus first prime divisor.
q - the modulus second prime divisor.
dP - the first prime's exponen. A positive integer less than p and q, satisfying e * dP = 1 (mod p-1).
dQ - the second prime's exponent. A positive integer less than p and q, satisfying e * dQ = 1 (mod p-1).
qInv - the Chinese Remainder Theorem coefiicient. A positive integer less than p, satisfying q * qInv = 1 (mod p).

GnuRSAPrivateKey

public GnuRSAPrivateKey(BigInteger p,
                        BigInteger q,
                        BigInteger e,
                        BigInteger d)
Convenience constructor. Calls the constructor with 5 arguments passing Registry.RAW_ENCODING_ID as the identifier of the preferred encoding format.
Parameters:
p - the modulus first prime divisor.
q - the modulus second prime divisor.
e - the public exponent.
d - the private exponent.

Method Details

equals

public boolean equals(Object obj)
Returns true if the designated object is an instance of this class and has the same RSA parameter values as this one.
Overrides:
equals in interface GnuRSAKey
Parameters:
obj - the other non-null RSA key to compare to.
Returns:
true if the designated object is of the same type and value as this one.

getCrtCoefficient

public BigInteger getCrtCoefficient()
Returns the CRT coefficient
Specified by:
getCrtCoefficient in interface RSAPrivateCrtKey
Returns:
The CRT coefficient

getEncoded

public byte[] getEncoded(int format)
Returns the encoded form of this private key according to the designated format.
Overrides:
getEncoded in interface GnuRSAKey
Parameters:
format - the desired format identifier of the resulting encoding.
Returns:
the byte sequence encoding this key according to the designated format.
Throws:
IllegalArgumentException - if the format is not supported.
See Also:
RSAKeyPairRawCodec, RSAKeyPairPKCS8Codec

getPrimeExponentP

public BigInteger getPrimeExponentP()
Returns the primeExponentP
Specified by:
getPrimeExponentP in interface RSAPrivateCrtKey
Returns:
The primeExponentP

getPrimeExponentQ

public BigInteger getPrimeExponentQ()
Returns the primeExponentQ
Specified by:
getPrimeExponentQ in interface RSAPrivateCrtKey
Returns:
The primeExponentQ

getPrimeP

public BigInteger getPrimeP()
Returns the primeP value
Specified by:
getPrimeP in interface RSAPrivateCrtKey
Returns:
The primeP value

getPrimeQ

public BigInteger getPrimeQ()
Returns the primeQ value
Specified by:
getPrimeQ in interface RSAPrivateCrtKey
Returns:
The primeQ value

getPrivateExponent

public BigInteger getPrivateExponent()
Returns the private exponent value for this key
Specified by:
getPrivateExponent in interface RSAPrivateKey
Returns:
The private exponent value for this key

toString

public String toString()
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:
toString in interface GnuRSAKey
Returns:
the String representing this Object, which may be null
See Also:
getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)

valueOf

public static GnuRSAPrivateKey valueOf(byte[] k)
A class method that takes the output of the encodePrivateKey() method of an RSA keypair codec object (an instance implementing IKeyPairCodec for RSA keys, and re-constructs an instance of this object.
Parameters:
k - the contents of a previously encoded instance of this object.
Throws:
ArrayIndexOutOfBoundsException - if there is not enough bytes, in k, to represent a valid encoding of an instance of this object.
IllegalArgumentException - if the byte sequence does not represent a valid encoding of an instance of this object.
GnuRSAPrivateKey.java -- Copyright 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.

Overview Package Class Use Source Tree Index Deprecated About