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.javax.crypto.key.srp6

Class SRPPrivateKey

Implemented Interfaces:
Key, PrivateKey, Serializable
public class SRPPrivateKey
extends SRPKey
implements PrivateKey
A representation of an SRP ephemeral private key.

Reference:

  1. SRP Protocol Design
    Thomas J. Wu.
See Also:
Serialized Form

Field Summary

Fields inherited from class gnu.javax.crypto.key.srp6.SRPKey

N, g

Fields inherited from interface java.security.Key

serialVersionUID

Fields inherited from interface java.security.PrivateKey

serialVersionUID

Constructor Summary

SRPPrivateKey(BigInteger N, BigInteger g, BigInteger x)
Public constructor for use from outside this package.
SRPPrivateKey(BigInteger N, BigInteger g, BigInteger x, BigInteger v)
Public constructor for use from outside this package.

Method Summary

boolean
equals(Object obj)
Returns true if the designated object is an instance of SRPPrivateKey and has the same SRP parameter values as this one.
byte[]
getEncoded(int format)
Returns the encoded form of this private key according to the designated format.
BigInteger
getV()
Returns the user's verifier as a BigInteger.
BigInteger
getX()
Returns the private exponent of the key as a BigInteger.
static SRPPrivateKey
valueOf(byte[] k)
A class method that takes the output of the encodePrivateKey() method of an SRP keypair codec object (an instance implementing IKeyPairCodec for DSS keys, and re-constructs an instance of this object.

Methods inherited from class gnu.javax.crypto.key.srp6.SRPKey

equals, getAlgorithm, getEncoded, getEncoded, getFormat, getG, getN

Methods inherited from class java.lang.Object

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

Constructor Details

SRPPrivateKey

public SRPPrivateKey(BigInteger N,
                     BigInteger g,
                     BigInteger x)
Public constructor for use from outside this package.
Parameters:
N - the public shared modulus.
g - the generator.
x - the private exponent of the ephemeral key.

SRPPrivateKey

public SRPPrivateKey(BigInteger N,
                     BigInteger g,
                     BigInteger x,
                     BigInteger v)
Public constructor for use from outside this package.
Parameters:
N - the public shared modulus.
g - the generator.
x - the private exponent of the ephemeral key.
v - the user's verifier value (for the server side only).

Method Details

equals

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

getEncoded

public byte[] getEncoded(int format)
Returns the encoded form of this private key according to the designated format.
Overrides:
getEncoded in interface SRPKey
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.

getV

public BigInteger getV()
Returns the user's verifier as a BigInteger.
Returns:
the user's verifier as a BigInteger if this is an SRP private key of a Host, or null if this is a private SRP key for a User.

getX

public BigInteger getX()
Returns the private exponent of the key as a BigInteger.
Returns:
the private exponent of the key as a BigInteger.

valueOf

public static SRPPrivateKey valueOf(byte[] k)
A class method that takes the output of the encodePrivateKey() method of an SRP keypair codec object (an instance implementing IKeyPairCodec for DSS 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.
SRPPrivateKey.java -- Copyright (C) 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