IAIK PKCS#11 Provider API Documentation
version 1.6

iaik.pkcs.pkcs11.provider.keys
Class IAIKPKCS11DhPrivateKey

java.lang.Object
  extended by iaik.pkcs.pkcs11.provider.keys.IAIKPKCS11Key
      extended by iaik.pkcs.pkcs11.provider.keys.IAIKPKCS11PrivateKey
          extended by iaik.pkcs.pkcs11.provider.keys.IAIKPKCS11DhPrivateKey
All Implemented Interfaces:
java.io.Serializable, java.security.Key, java.security.PrivateKey, javax.crypto.interfaces.DHKey, javax.crypto.interfaces.DHPrivateKey

public class IAIKPKCS11DhPrivateKey
extends IAIKPKCS11PrivateKey
implements javax.crypto.interfaces.DHPrivateKey

A Java DH private key object that is associated with a PKCS#11 DH private key object. This class uses the PKCS#11 wrapper from IAIK.

Author:
Karl Scheibelhofer
See Also:
Serialized Form

Field Summary
 
Fields inherited from class iaik.pkcs.pkcs11.provider.keys.IAIKPKCS11Key
AES, BATON, BLOWFISH, CAST, CAST128, CAST3, CAST5, CDMF, DES, DES2, DESede, DH, DSA, ECDSA, GENERIC_SECRET, IDEA, JUNIPER, KEA, RC2, RC4, RC5, RSA, SKIPJACK, TWOFISH, VENDOR_DEFINED
 
Fields inherited from interface javax.crypto.interfaces.DHPrivateKey
serialVersionUID
 
Constructor Summary
IAIKPKCS11DhPrivateKey(TokenManager tokenManager, iaik.pkcs.pkcs11.objects.DHPrivateKey privateKeyObject)
          Construct a private key object that is associated with the given privatekeyObjecton the given token.
 
Method Summary
static IAIKPKCS11DhPrivateKey create(TokenManager tokenManager, iaik.pkcs.pkcs11.objects.DHPrivateKey privateKeyObject)
          Create a new instance of a IAIKPKCS11DhPrivateKey which's token managed by the given token manager and is based on the given PKCS#11 key object.
 java.lang.String getAlgorithm()
          Get the algorithm name.
 javax.crypto.spec.DHParameterSpec getParams()
          Get the DH parameters of this key.
 java.math.BigInteger getX()
          Get the private value X of this key.
 
Methods inherited from class iaik.pkcs.pkcs11.provider.keys.IAIKPKCS11PrivateKey
create, getEncoded, getFormat
 
Methods inherited from class iaik.pkcs.pkcs11.provider.keys.IAIKPKCS11Key
create, destroy, finalize, getAlgorithmCode, getAlgorithmName, getAlias, getKeyID, getKeyObject, getSession, getTokenManager, isAutoDestroy, isDestroyed, setAutoDestroy, setSession, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.security.Key
getEncoded, getFormat
 

Constructor Detail

IAIKPKCS11DhPrivateKey

public IAIKPKCS11DhPrivateKey(TokenManager tokenManager,
                              iaik.pkcs.pkcs11.objects.DHPrivateKey privateKeyObject)
Construct a private key object that is associated with the given privatekeyObjecton the given token.

Parameters:
tokenManager - The token manager of the token where this key resides.
privateKeyObject - The PKCS#11 key object.
Preconditions
(token <> null) and (privateKeyObject <> null)
Method Detail

create

public static IAIKPKCS11DhPrivateKey create(TokenManager tokenManager,
                                            iaik.pkcs.pkcs11.objects.DHPrivateKey privateKeyObject)
Create a new instance of a IAIKPKCS11DhPrivateKey which's token managed by the given token manager and is based on the given PKCS#11 key object.

Parameters:
tokenManager - The token manager of the token where the key is.
privateKeyObject - The PKCS#11 key object.
Returns:
A new IAIKPKCS11DhPrivateKey that can be used with this provider.
Postconditions
(result <> null)

getX

public java.math.BigInteger getX()
Get the private value X of this key.

Specified by:
getX in interface javax.crypto.interfaces.DHPrivateKey
Returns:
The private value X.
Throws:
java.lang.UnsupportedOperationException - If the value is not present or if the value is sensitive.
Postconditions
(result <> null)

getParams

public javax.crypto.spec.DHParameterSpec getParams()
Get the DH parameters of this key.

Specified by:
getParams in interface javax.crypto.interfaces.DHKey
Returns:
The DH parameters.
Throws:
java.lang.UnsupportedOperationException - If the value is not present or if the value is sensitive.
Postconditions
(result <> null)

getAlgorithm

public java.lang.String getAlgorithm()
Get the algorithm name.

Specified by:
getAlgorithm in interface java.security.Key
Overrides:
getAlgorithm in class IAIKPKCS11Key
Returns:
"DH".
Postconditions
(result <> null) and (result.equals("DH"))

IAIK PKCS#11 Provider API Documentation
version 1.6

IAIK JavaSecurity Website http://jce.iaik.tugraz.at/

IAIK at Graz University of Technology, Austria, Europe
Copyright 2001-2004, IAIK, Graz University of Technology, Inffeldgasse 16a, 8010 Graz, Austria. All Rights Reserved.
version 1.6