IAIK PKCS#11 Provider API Documentation
version 1.6

iaik.pkcs.pkcs11.provider.keypairgenerators
Class PKCS11KeyPairGenerationSpec

java.lang.Object
  extended by iaik.pkcs.pkcs11.provider.spec.PKCS11Spec
      extended by iaik.pkcs.pkcs11.provider.keypairgenerators.PKCS11KeyPairGenerationSpec
All Implemented Interfaces:
java.security.spec.AlgorithmParameterSpec, java.security.spec.KeySpec

public class PKCS11KeyPairGenerationSpec
extends PKCS11Spec
implements java.security.spec.AlgorithmParameterSpec

Objects of this algorithm parameters class allows an application to control the generation of PKCS#11 key-pairs using the provided JCE key generators.


Field Summary
 
Fields inherited from class iaik.pkcs.pkcs11.provider.spec.PKCS11Spec
USE_PUBLIC_SESSION, USE_READ_ONLY_SESSION, USE_READ_WRITE_SESSION, USE_USER_SESSION
 
Constructor Summary
PKCS11KeyPairGenerationSpec(java.security.spec.AlgorithmParameterSpec parameterSpec, iaik.pkcs.pkcs11.objects.PublicKey publicKeyTemplate, iaik.pkcs.pkcs11.objects.PrivateKey privateKeyTemplate)
          Constructor taking several parameters that control where and how the key should be generated.
PKCS11KeyPairGenerationSpec(iaik.pkcs.pkcs11.objects.PublicKey publicKeyTemplate, iaik.pkcs.pkcs11.objects.PrivateKey privateKeyTemplate)
          Constructor taking several parameters that control where and how the key should be generated.
PKCS11KeyPairGenerationSpec(TokenManager tokenManager, java.security.spec.AlgorithmParameterSpec parameterSpec, iaik.pkcs.pkcs11.objects.PublicKey publicKeyTemplate, iaik.pkcs.pkcs11.objects.PrivateKey privateKeyTemplate, boolean useROSession, boolean useUserSession)
          Deprecated.  
PKCS11KeyPairGenerationSpec(TokenManager tokenManager, iaik.pkcs.pkcs11.objects.PublicKey publicKeyTemplate, iaik.pkcs.pkcs11.objects.PrivateKey privateKeyTemplate, boolean useROSession, boolean useUserSession)
          Deprecated.  
 
Method Summary
 java.security.spec.AlgorithmParameterSpec getAlgorithmParameterSpec()
          Get the parameter spec if available.
 iaik.pkcs.pkcs11.objects.PrivateKey getPrivateKeyTemplate()
          Get the template for the new private key.
 iaik.pkcs.pkcs11.objects.PublicKey getPublicKeyTemplate()
          Get the template for the new public key.
 
Methods inherited from class iaik.pkcs.pkcs11.provider.spec.PKCS11Spec
getPin, getTokenManager, isUseAnonymousRole, isUseROSession, isUseRwSession, isUseSORole, isUseUserRole, isUseUserSession, setPin, setTokenManager, setUseAnonymousRole, setUseSORole, setUseUserRole
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PKCS11KeyPairGenerationSpec

public PKCS11KeyPairGenerationSpec(TokenManager tokenManager,
                                   iaik.pkcs.pkcs11.objects.PublicKey publicKeyTemplate,
                                   iaik.pkcs.pkcs11.objects.PrivateKey privateKeyTemplate,
                                   boolean useROSession,
                                   boolean useUserSession)
Deprecated. 

Constructor taking several parameters that control where and how the key should be generated.

Parameters:
tokenManager - The manager to handle the token.
publicKeyTemplate - The template for the new public key.
privateKeyTemplate - The template for the new private key.
useROSession - true (USE_READ_ONLY_SESSION), if the keys should be generated using a read-only session. This is only possible for session-objects. false ( USE_READ_WRITE_SESSION) to use a read-write session.
useUserSession - true (USE_USER_SESSION), if the keys should be generated using a user session. This is required for private objects (key); i.e. keys that have their private flag set. false (USE_PUBLIC_SESSION) to use a public session. This will only work for public objects.

PKCS11KeyPairGenerationSpec

public PKCS11KeyPairGenerationSpec(iaik.pkcs.pkcs11.objects.PublicKey publicKeyTemplate,
                                   iaik.pkcs.pkcs11.objects.PrivateKey privateKeyTemplate)
Constructor taking several parameters that control where and how the key should be generated.

Parameters:
publicKeyTemplate - The template for the new public key.
privateKeyTemplate - The template for the new private key.

PKCS11KeyPairGenerationSpec

public PKCS11KeyPairGenerationSpec(TokenManager tokenManager,
                                   java.security.spec.AlgorithmParameterSpec parameterSpec,
                                   iaik.pkcs.pkcs11.objects.PublicKey publicKeyTemplate,
                                   iaik.pkcs.pkcs11.objects.PrivateKey privateKeyTemplate,
                                   boolean useROSession,
                                   boolean useUserSession)
Deprecated. 

Constructor taking several parameters that control where and how the key should be generated.

Parameters:
tokenManager - The manager to handle the token.
parameterSpec - The parameters to use for generating the key-pair. The values in this object have lower priority than those in the key templates.
publicKeyTemplate - The template for the new public key.
privateKeyTemplate - The template for the new private key.
useROSession - true (USE_READ_ONLY_SESSION), if the keys should be generated using a read-only session. This is only possible for session-objects. false ( USE_READ_WRITE_SESSION) to use a read-write session.
useUserSession - true (USE_USER_SESSION), if the keys should be generated using a user session. This is required for private objects (key); i.e. keys that have their private flag set. false (USE_PUBLIC_SESSION) to use a public session. This will only work for public objects.

PKCS11KeyPairGenerationSpec

public PKCS11KeyPairGenerationSpec(java.security.spec.AlgorithmParameterSpec parameterSpec,
                                   iaik.pkcs.pkcs11.objects.PublicKey publicKeyTemplate,
                                   iaik.pkcs.pkcs11.objects.PrivateKey privateKeyTemplate)
Constructor taking several parameters that control where and how the key should be generated.

Parameters:
parameterSpec - The parameters to use for generating the key-pair. The values in this object have lower priority than those in the key templates.
publicKeyTemplate - The template for the new public key.
privateKeyTemplate - The template for the new private key.
Method Detail

getPrivateKeyTemplate

public iaik.pkcs.pkcs11.objects.PrivateKey getPrivateKeyTemplate()
Get the template for the new private key.

Returns:
The template for the new private key.

getPublicKeyTemplate

public iaik.pkcs.pkcs11.objects.PublicKey getPublicKeyTemplate()
Get the template for the new public key.

Returns:
The template for the new public key.

getAlgorithmParameterSpec

public java.security.spec.AlgorithmParameterSpec getAlgorithmParameterSpec()
Get the parameter spec if available.

Returns:
The spec for the for the key-pair generation.

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