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

javax.crypto

Class KeyAgreementSpi

Known Direct Subclasses:
DiffieHellmanImpl
public abstract class KeyAgreementSpi
extends Object
This is the Service Provider Interface (SPI) for the KeyAgreement class.

Providers wishing to implement a key agreement algorithm must subclass this and provide an appropriate implementation for all the abstract methods below, and provide an appropriate entry in the master Provider class (the service name for key agreement algorithms is "KeyAgreement").

Since:
1.4
See Also:
KeyAgreement, SecretKey

Constructor Summary

KeyAgreementSpi()
Create a new KeyAgreementSpi instance.

Method Summary

protected abstract Key
engineDoPhase(Key key, boolean lastPhase)
Do a phase in the key agreement.
protected abstract byte[]
engineGenerateSecret()
Generate the shared secret in a new byte array.
protected abstract int
engineGenerateSecret(byte[] sharedSecret, int offset)
Generate the shared secret, storing it into the specified array.
protected abstract SecretKey
engineGenerateSecret(String algorithm)
Generate the shared secret and return it as a SecretKey.
protected abstract void
engineInit(Key key, SecureRandom random)
Initialize this key agreement with a key and source of randomness.
protected abstract void
engineInit(Key key, AlgorithmParameterSpec params, SecureRandom random)
Initialize this key agreement with a key, parameters, and source of randomness.

Methods inherited from class java.lang.Object

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

Constructor Details

KeyAgreementSpi

public KeyAgreementSpi()
Create a new KeyAgreementSpi instance.

Method Details

engineDoPhase

protected abstract Key engineDoPhase(Key key,
                                     boolean lastPhase)
            throws IllegalStateException,
                   InvalidKeyException
Do a phase in the key agreement.
Parameters:
key - The key to use for this phase.
lastPhase - true if this call should be the last phase.
Returns:
The intermediate result, or null if there is no intermediate result.
Throws:
IllegalStateException - If this instance has not been initialized.
InvalidKeyException - If the supplied key is not appropriate.

engineGenerateSecret

protected abstract byte[] engineGenerateSecret()
            throws IllegalStateException
Generate the shared secret in a new byte array.
Returns:
The shared secret in a new byte array.
Throws:
IllegalStateException - If this key agreement is not ready to generate the secret.

engineGenerateSecret

protected abstract int engineGenerateSecret(byte[] sharedSecret,
                                            int offset)
            throws IllegalStateException,
                   ShortBufferException
Generate the shared secret, storing it into the specified array.
Parameters:
sharedSecret - The byte array in which to store the secret.
offset - The offset into the byte array to start.
Returns:
The size of the shared secret.
Throws:
IllegalStateException - If this key agreement is not ready to generate the secret.
ShortBufferException - If there is not enough space in the supplied array for the shared secret.

engineGenerateSecret

protected abstract SecretKey engineGenerateSecret(String algorithm)
            throws IllegalStateException,
                   InvalidKeyException,
                   NoSuchAlgorithmException
Generate the shared secret and return it as a SecretKey.
Parameters:
algorithm - The algorithm with which to generate the secret key.
Returns:
The shared secret as a secret key.
Throws:
IllegalStateException - If this key agreement is not ready to generate the secret.
InvalidKeyException - If the shared secret cannot be made into a SecretKey.
NoSuchAlgorithmException - If algorithm cannot be found.

engineInit

protected abstract void engineInit(Key key,
                                   SecureRandom random)
            throws InvalidKeyException
Initialize this key agreement with a key and source of randomness.
Parameters:
key - The key to initialize with, usually a private key.
random - The source of randomness to use.
Throws:
InvalidKeyException - If the supplied key is inappropriate.

engineInit

protected abstract void engineInit(Key key,
                                   AlgorithmParameterSpec params,
                                   SecureRandom random)
            throws InvalidAlgorithmParameterException,
                   InvalidKeyException
Initialize this key agreement with a key, parameters, and source of randomness.
Parameters:
key - The key to initialize with, usually a private key.
params - The parameters to initialize with.
random - The source of randomness to use.
Throws:
InvalidAlgorithmParameterException - If the supplied parameters are inappropriate.
InvalidKeyException - If the supplied key is inappropriate.
KeyAgreementSpi.java -- The key agreement service provider interface. 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.

Overview Package Class Use Source Tree Index Deprecated About