iaik.pkcs.pkcs11.provider.keyfactories

Class RsaKeyFactory

java.lang.Object

java.security.KeyFactorySpi

iaik.pkcs.pkcs11.provider.keyfactories.PKCS11KeyFactory

iaik.pkcs.pkcs11.provider.keyfactories.RsaKeyFactory

All Implemented Interfaces:

PKCS11EngineClass

public class RsaKeyFactory
extends PKCS11KeyFactory

This is a RSA key factory that transforms RSA key specs into PKCS#11 key objects and vice versa. To create PKCS#11 private or public keys, the application cannot pass the actual key specs directly to the factory. It must wrap them into a PKCS11KeySpec, which tells the factory on which token to generate the key. For private keys this key factory supports RSAPrivateKeySpec, RSAPrivateCrtKeySpec and PKCS8EncodedKeySpec. For public keys it supports RSAPublicKeySpec and X509EncodedKeySpec.

Author:

Karl Scheibelhofer

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	KEY_FACTORY_ALGORITHM_NAME The JCA standard name of this signature algorithm.
static int	PKCS1_VERSION The PKCS#1 version field in the ASN.1 encoding.

Fields inherited from class iaik.pkcs.pkcs11.provider.keyfactories.PKCS11KeyFactory

pkcs11KeySpec_, pkcs11OperationInitialized_, PKCS8_VERSION, session_, softwareDelegate_, tokenManager_

Constructor Summary

Constructors

Constructor and Description
RsaKeyFactory() Default constructor.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getAlgorithmName() Return the JCA standard name of this key factory algorithm.
protected java.lang.String	getSoftwareDelegateAlgorithm() Return the name of the software algorithm to use, if this object must use a software delegation object.
protected java.security.PrivateKey	pkcs11GeneratePrivate(java.security.spec.KeySpec keySpec) Generates a private key object from the provided key specification (key material).
protected java.security.PublicKey	pkcs11GeneratePublic(java.security.spec.KeySpec keySpec) Generates a public key object from the provided key specification (key material).
protected java.security.spec.KeySpec	pkcs11GetKeySpec(java.security.Key key, java.lang.Class keySpecClass) Returns a specification (key material) of the given key object.
protected void	verifyPrivateCRTKeyExtractable(iaik.pkcs.pkcs11.objects.RSAPrivateKey key) Verifies that the CRT components of the key are present and extractable; i.e.
protected void	verifyPrivateKeyExtractable(iaik.pkcs.pkcs11.objects.RSAPrivateKey key) Verifies that the components of the key are present and extractable; i.e.
protected void	verifyPublicKeyExtractable(iaik.pkcs.pkcs11.objects.RSAPublicKey key) Verifies that the components of the key are present and extractable; i.e.

Methods inherited from class iaik.pkcs.pkcs11.provider.keyfactories.PKCS11KeyFactory

createKey, engineGeneratePrivate, engineGeneratePublic, engineGetKeySpec, engineTranslateKey, finalize, finalizePkcs11Operation, initializePkcs11Operation, initializeSession, initializeSoftwareDelegate, isSessionAppropriate, isSupportedBy, pkcs11TranslateKey

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PKCS1_VERSION

public static final int PKCS1_VERSION

The PKCS#1 version field in the ASN.1 encoding.

See Also:

Constant Field Values

KEY_FACTORY_ALGORITHM_NAME

protected static java.lang.String KEY_FACTORY_ALGORITHM_NAME

The JCA standard name of this signature algorithm.

Constructor Detail

RsaKeyFactory

public RsaKeyFactory()

Default constructor.

Method Detail

getSoftwareDelegateAlgorithm

protected java.lang.String getSoftwareDelegateAlgorithm()

Return the name of the software algorithm to use, if this object must use a software delegation object.

Specified by:

getSoftwareDelegateAlgorithm in class PKCS11KeyFactory

Returns:

The name of the software secure random; e.g. RSA.

Postconditions:

(result <> null)

getAlgorithmName

protected java.lang.String getAlgorithmName()

Return the JCA standard name of this key factory algorithm.

Specified by:

getAlgorithmName in class PKCS11KeyFactory

Returns:

The JCA name of this key factory algorithm; e.g. RSA.

Postconditions:

(result <> null)

pkcs11GeneratePublic

protected java.security.PublicKey pkcs11GeneratePublic(java.security.spec.KeySpec keySpec)
                                                throws java.security.spec.InvalidKeySpecException

Generates a public key object from the provided key specification (key material).

Specified by:

pkcs11GeneratePublic in class PKCS11KeyFactory

Parameters:

keySpec - the specification (key material) of the public key.

Returns:

the public key.

Throws:

java.security.spec.InvalidKeySpecException - if the given key specification is inappropriate for this key factory to produce a public key.

Preconditions:

(keySpec <> null) and (keySpec instanceof PKCS11KeySpec)

pkcs11GeneratePrivate

protected java.security.PrivateKey pkcs11GeneratePrivate(java.security.spec.KeySpec keySpec)
                                                  throws java.security.spec.InvalidKeySpecException

Generates a private key object from the provided key specification (key material).

Specified by:

pkcs11GeneratePrivate in class PKCS11KeyFactory

Parameters:

keySpec - the specification (key material) of the private key.

Returns:

the private key.

Throws:

java.security.spec.InvalidKeySpecException - if the given key specification is inappropriate for this key factory to produce a private key.

Preconditions:

(keySpec <> null) and (keySpec instanceof PKCS11KeySpec)

pkcs11GetKeySpec

protected java.security.spec.KeySpec pkcs11GetKeySpec(java.security.Key key,
                                                      java.lang.Class keySpecClass)
                                               throws java.security.spec.InvalidKeySpecException

Returns a specification (key material) of the given key object. keySpec identifies the specification class in which the key material should be returned. It could, for example, be RSAPublicKeySpec.class, to indicate that the key material should be returned in an instance of the RSAPublicKeySpec class.

Specified by:

pkcs11GetKeySpec in class PKCS11KeyFactory

Parameters:

key - The key.

keySpecClass - The specification class in which the key material should be returned.

Returns:

The underlying key specification (key material) in an instance of the requested specification class.

Throws:

java.security.spec.InvalidKeySpecException - if the requested key specification is inappropriate for the given key, or the given key cannot be dealt with (e.g., the given key has an unrecognized format).

Postconditions:

(result <> null)

Preconditions:

(key <> null) and (keySpecClass <> null) and (keySpecClass.equals(RSAPublicKeySpec.class) or keySpecClass.equals(RSAPrivateKeySpec.class) or keySpecClass.equals(RSAPrivateCrtKeySpec.class))

verifyPublicKeyExtractable

protected void verifyPublicKeyExtractable(iaik.pkcs.pkcs11.objects.RSAPublicKey key)
                                   throws NonExtractableComponentException,
                                          IAIKPkcs11Exception

Verifies that the components of the key are present and extractable; i.e. we can read the attributes.

Parameters:

key - The key.

Throws:

NonExtractableComponentException - If any attribute is sensitive.

IAIKPkcs11Exception - If any attribute is not present.

Preconditions:

(key <> null)

verifyPrivateKeyExtractable

protected void verifyPrivateKeyExtractable(iaik.pkcs.pkcs11.objects.RSAPrivateKey key)
                                    throws NonExtractableComponentException,
                                           IAIKPkcs11Exception

Verifies that the components of the key are present and extractable; i.e. we can read the attributes.

Parameters:

key - The key.

Throws:

NonExtractableComponentException - If any attribute is sensitive.

IAIKPkcs11Exception - If any attribute is not present.

Preconditions:

(key <> null)

verifyPrivateCRTKeyExtractable

protected void verifyPrivateCRTKeyExtractable(iaik.pkcs.pkcs11.objects.RSAPrivateKey key)
                                       throws NonExtractableComponentException,
                                              IAIKPkcs11Exception

Verifies that the CRT components of the key are present and extractable; i.e. we can read the attributes.

Parameters:

key - The key.

Throws:

NonExtractableComponentException - If any attribute is sensitive.

IAIKPkcs11Exception - If any attribute is not present.

Preconditions:

(key <> null)