EcDsaKeyFactory (IAIK PKCS#11 Provider API Documentation)

java.lang.Object
- java.security.KeyFactorySpi
- - iaik.pkcs.pkcs11.provider.keyfactories.PKCS11KeyFactory
  - - iaik.pkcs.pkcs11.provider.keyfactories.EcDsaKeyFactory

All Implemented Interfaces:

PKCS11EngineClass
```
public class EcDsaKeyFactory
extends PKCS11KeyFactory
```
This is an ECDSA key factory that transforms ECDSA 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 public keys, this factory can handle X.509 public key specs ( java.security.spec.X509EncodedKeySpec) For private keys, it handles PKCS#8 encoded key specs (java.security.spec.PKCS8EncodedKeySpec). Both key specs must carry ANSI X9.62 encoded keys internally. This standard is compatible to IEEE 1363 and Certicom Sec 1.

Author:

Karl Scheibelhofer

Field Summary

Fields
Modifier and Type	Field and Description
`protected static iaik.asn1.structures.AlgorithmID`	`EC_ALGORITHM_ID` Algorithm identifier for subject public key info
`static iaik.asn1.INTEGER`	`EC_PRIVATE_KEY_VERSION` The version field in the ASN.1 encoding of the private key (SEC standard).
`protected static java.lang.String`	`KEY_FACTORY_ALGORITHM_NAME` The JCA standard name of this signature algorithm.
`protected static iaik.asn1.ObjectID`	`OBJECT_ID_EC_KEY` This object identifier names the public key type defined in the X9.62 standard

Fields inherited from class iaik.pkcs.pkcs11.provider.keyfactories.PKCS11KeyFactory
pkcs11KeySpec_, pkcs11OperationInitialized_, PKCS8_VERSION, session_, softwareDelegate_, tokenManager_

Constructor Summary

Constructors
Constructor and Description

EcDsaKeyFactory()
Default constructor.

Constructors
Constructor and Description
`EcDsaKeyFactory()` Default constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static boolean`	`checkJdk16AndEccelerate()` check if JDK 1.5 is used and IAIK ECCelerate is in classpath and set isJdk16AndEccelerate.
`protected java.security.PrivateKey`	`createECPrivateKey(byte[] encodedParameters, byte[] encodedPrivateKeyValue)` Creates a new PKCS#11 EC private key for the given parameters and encoding.
`protected java.security.PublicKey`	`createECPublicKey(byte[] encodedParameters, byte[] encodedPublicKeyValue)` Creates a new PKCS#11 EC public key for the given parameters and encoding.
`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`	`verifyPrivateKeyExtractable(iaik.pkcs.pkcs11.objects.ECDSAPrivateKey key)` Verifies that the components of the key are present and extractable; i.e.
`protected void`	`verifyPublicKeyExtractable(iaik.pkcs.pkcs11.objects.ECDSAPublicKey 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
  - KEY_FACTORY_ALGORITHM_NAME
```
protected static java.lang.String KEY_FACTORY_ALGORITHM_NAME
```
    The JCA standard name of this signature algorithm.
  - OBJECT_ID_EC_KEY
```
protected static final iaik.asn1.ObjectID OBJECT_ID_EC_KEY
```
    This object identifier names the public key type defined in the X9.62 standard
  - EC_ALGORITHM_ID
```
protected static final iaik.asn1.structures.AlgorithmID EC_ALGORITHM_ID
```
    Algorithm identifier for subject public key info
  - EC_PRIVATE_KEY_VERSION
```
public static final iaik.asn1.INTEGER EC_PRIVATE_KEY_VERSION
```
    The version field in the ASN.1 encoding of the private key (SEC standard).
- Constructor Detail
  - EcDsaKeyFactory
```
public EcDsaKeyFactory()
```
    Default constructor.
- Method Detail
  - checkJdk16AndEccelerate
```
protected static boolean checkJdk16AndEccelerate()
```
    check if JDK 1.5 is used and IAIK ECCelerate is in classpath and set isJdk16AndEccelerate.
  - 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. ECDSA.
    
    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 (keySpecClass.equals(PKCS11KeySpec.class))
  - createECPublicKey
```
protected java.security.PublicKey createECPublicKey(byte[] encodedParameters,
                                                    byte[] encodedPublicKeyValue)
                                             throws java.security.spec.InvalidKeySpecException
```
    Creates a new PKCS#11 EC public key for the given parameters and encoding.
    
    Parameters:
    
    encodedParameters - the parameters of the key
    
    encodedPublicKeyValue - the public key value
    
    Returns:
    
    the PKCS#11 key
    
    Throws:
    
    java.security.spec.InvalidKeySpecException
  - 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 (keySpecClass.equals(PKCS11KeySpec.class))
  - createECPrivateKey
```
protected java.security.PrivateKey createECPrivateKey(byte[] encodedParameters,
                                                      byte[] encodedPrivateKeyValue)
                                               throws java.security.spec.InvalidKeySpecException
```
    Creates a new PKCS#11 EC private key for the given parameters and encoding.
    
    Parameters:
    
    encodedParameters - the parameters of the key
    
    encodedPublicKeyValue - the private key value
    
    Returns:
    
    the PKCS#11 key
    
    Throws:
    
    java.security.spec.InvalidKeySpecException
  - 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 PKCS8EncodedKeySpec.class, to indicate that the private key material should be returned in an instance of the PKCS8EncodedKeySpec 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(PKCS8EncodedKeySpec.class) or keySpecClass.equals(X509EncodedKeySpec.class)
  - verifyPublicKeyExtractable
```
protected void verifyPublicKeyExtractable(iaik.pkcs.pkcs11.objects.ECDSAPublicKey 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.ECDSAPrivateKey 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)

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

IAIK at Graz University of Technology, Austria, Europe
Copyright 2001-2023 IAIK, Graz University of Technology, Inffeldgasse 16a, 8010 Graz, Austria. All Rights Reserved. Version 1.9.4

Class EcDsaKeyFactory

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

KEY_FACTORY_ALGORITHM_NAME

OBJECT_ID_EC_KEY

EC_ALGORITHM_ID

EC_PRIVATE_KEY_VERSION

Constructor Detail

EcDsaKeyFactory

Method Detail

checkJdk16AndEccelerate

getSoftwareDelegateAlgorithm

getAlgorithmName

pkcs11GeneratePublic

createECPublicKey

pkcs11GeneratePrivate

createECPrivateKey

pkcs11GetKeySpec

verifyPublicKeyExtractable

verifyPrivateKeyExtractable