iaik.pkcs.pkcs8

Class AsymmetricKeyPackage

java.lang.Object

iaik.pkcs.pkcs8.AsymmetricKeyPackage

All Implemented Interfaces:

ASN1Type

public class AsymmetricKeyPackage
extends java.lang.Object
implements ASN1Type

This class implements the AsymmetricKeyPackage type as specified by RFC 5958 for packaging private key information.

An AsymmetricKeyPackage may hold on ore more OneAsymmetricKey elements:

 AsymmetricKeyPackage ::= SEQUENCE SIZE (1..MAX) OF OneAsymmetricKey
 

OneAsymmetricKey basically is the same as PKCS#8 PrivateKeyInfo as specified by by RFC 5208 but adds the publicKey field to the PrivateKeyInfo (or now OneAsymmetricKey) structure (see RFC 5998):

 OneAsymmetricKey ::= SEQUENCE {
     version                   Version,
     privateKeyAlgorithm       PrivateKeyAlgorithmIdentifier,
     privateKey                PrivateKey,
     attributes            [0] Attributes OPTIONAL,
     ...,
     [[2: publicKey        [1] PublicKey OPTIONAL ]],
     ...
    }
    
    PrivateKeyInfo ::= OneAsymmetricKey
 

Backwards compatibility is maintained by the version number field. IAIK-JCE adds support for the OneAsymmetricKey type by simply adding the publicKey field to the PrivateKeyInfo class. This allows to use the publicKey enhancement by all PrivateKey classes that are extended from PKCS#8 PrivateKeyInfo.

Since OneAsymmetricKey is not implemented in an own class the AsymmetricKeyPackage can be also seen as a SEQUENCE OF PrivateKeyInfo elements and are handled as general PrivateKey elements.
When creating a new AsymmetricKeyPackage the OneAsymmetricKey/PrivateKeyInfo element(s) have to be provided as PrivateKey objects that must represent PKCS#8 OneAsymmetricKey(s)/ PrivateKeyInfo(s):

 PrivateKey[] privateKeys = ...;
 AsymmetricKeyPackage keyPack = new AsymmetricKeyPackage(privateKeys);
 

When having encoded some AsymmetricKeyPackage:

 byte[] encodedKeyPack = keyPack.getEncoded();
 

it maybe read and parsed again by creating a new AsymmetricKeyPackage:

 AsymmetricKeyPackage keyPack = new AsymmetricKeyPackage(encodedKeyPack);
 PrivateKey[] privateKeys = keyPack.getPrivateKeys();
 

Version:

File Revision 33

Constructor Summary

Constructors

Constructor and Description
AsymmetricKeyPackage(ASN1Object obj) Creates an AsymmetricKeyPackage from an ASN1Object.
AsymmetricKeyPackage(byte[] arr) Creates a new AsymmetricKeyPackage from a byte array.
AsymmetricKeyPackage(java.io.InputStream is) Creates a new AsymmetricKeyPackage from an InputStream.
AsymmetricKeyPackage(java.security.PrivateKey key) Creates a new AsymmetricKeyPackage with the given OneAsymmetricKey/PrivateKeyInfo.
AsymmetricKeyPackage(java.security.PrivateKey[] keys) Creates a new AsymmetricKeyPackage with the given OneAsymmetricKey/PrivateKeyInfos.

Method Summary

Methods

Modifier and Type	Method and Description
void	addKey(java.security.PrivateKey key) Adds an OneAsymmetricKey/PrivateKeyInfo.
void	addKeys(java.security.PrivateKey[] keys) Adds an array of OneAsymmetricKey/PrivateKeyInfos.
void	decode(ASN1Object obj) Decodes an AsymmetricKeyPackage from an ASN1Object.
byte[]	getEncoded() Returns this AsymmetricKeyPackage as a DER encoded ASN.1 data structure.
java.security.PrivateKey[]	getKeys() Gets the OneAsymmetricKey/PrivateKeyInfos contained in the AsymmetricKeyPackage.
ASN1Object	toASN1Object() Returns this AsymmetricKeyPackage as ASN1Object.
java.lang.String	toString() Returns a string that represents the contents of this private key.
void	writeTo(java.io.OutputStream os) Writes this AsymmetricKeyPackage DER encoded to an output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsymmetricKeyPackage

public AsymmetricKeyPackage(java.security.PrivateKey key)
                     throws java.security.InvalidKeyException

Creates a new AsymmetricKeyPackage with the given OneAsymmetricKey/PrivateKeyInfo.

Parameters:

key - the OneAsymmetricKey/PrivateKeyInfo

Throws:

java.security.InvalidKeyException - if the key does not represent an OneAsymmetricKey/PrivateKeyInfo (does not have "PKCS#8" format)

AsymmetricKeyPackage

public AsymmetricKeyPackage(java.security.PrivateKey[] keys)
                     throws java.security.InvalidKeyException

Creates a new AsymmetricKeyPackage with the given OneAsymmetricKey/PrivateKeyInfos.

Parameters:

keys - the OneAsymmetricKey/PrivateKeyInfos

Throws:

java.security.InvalidKeyException - if the key does not represent an OneAsymmetricKey/PrivateKeyInfo (does not have "PKCS#8" format)

AsymmetricKeyPackage

public AsymmetricKeyPackage(ASN1Object obj)
                     throws CodingException

Creates an AsymmetricKeyPackage from an ASN1Object.

Parameters:

obj - the AsymmetricKeyPackage as ASN1Object

Throws:

CodingException - if the ASN1Object can not be parsed

AsymmetricKeyPackage

public AsymmetricKeyPackage(java.io.InputStream is)
                     throws CodingException,
                            java.io.IOException

Creates a new AsymmetricKeyPackage from an InputStream.

Parameters:

is - the input stream from where the encoded AsymmetricKeyPackage shall be read

Throws:

CodingException - if the key package can not be parsed

java.io.IOException - if an I/O error occurs

AsymmetricKeyPackage

public AsymmetricKeyPackage(byte[] arr)
                     throws CodingException

Creates a new AsymmetricKeyPackage from a byte array.

Parameters:

arr - the array containing the encoded AsymmetricKeyPackage

Throws:

CodingException - if the key package can not be parsed

Method Detail

addKey

public void addKey(java.security.PrivateKey key)
            throws java.security.InvalidKeyException

Adds an OneAsymmetricKey/PrivateKeyInfo.

Parameters:

key - the OneAsymmetricKey/PrivateKeyInfo to be added

Throws:

java.security.InvalidKeyException - if the key does not represent an OneAsymmetricKey/PrivateKeyInfo (does not have "PKCS#8" format)

addKeys

public void addKeys(java.security.PrivateKey[] keys)
             throws java.security.InvalidKeyException

Adds an array of OneAsymmetricKey/PrivateKeyInfos.

Parameters:

keys - the OneAsymmetricKey/PrivateKeyInfos to be added

Throws:

java.security.InvalidKeyException - if any of the keys does not represent an OneAsymmetricKey/PrivateKeyInfo (does not have "PKCS#8" format)

getKeys

public java.security.PrivateKey[] getKeys()

Gets the OneAsymmetricKey/PrivateKeyInfos contained in the AsymmetricKeyPackage.

Returns:

the OneAsymmetricKey/PrivateKeyInfos

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes an AsymmetricKeyPackage from an ASN1Object.

Specified by:

decode in interface ASN1Type

Parameters:

obj - the AsymmetricKeyPackage as ASN1Object

Throws:

CodingException - if the ASn1Object can not be parsed

toASN1Object

public ASN1Object toASN1Object()
                        throws CodingException

Returns this AsymmetricKeyPackage as ASN1Object.

Specified by:

toASN1Object in interface ASN1Type

Returns:

this AsymmetricKeyPackage as ASN1Object

Throws:

if - the ASN1Object cannot be built

CodingException - if an de/encoding error occurs

getEncoded

public byte[] getEncoded()
                  throws CodingException

Returns this AsymmetricKeyPackage as a DER encoded ASN.1 data structure.

Returns:

this AsymmetricKeyPackage as DER encoded byte array

Throws:

CodingException - if the encoding fails

writeTo

public void writeTo(java.io.OutputStream os)
             throws java.io.IOException,
                    CodingException

Writes this AsymmetricKeyPackage DER encoded to an output stream.

Parameters:

os - the output stream

Throws:

java.io.IOException - if an I/O error occurs

CodingException - if the encoding fails

toString

public java.lang.String toString()

Returns a string that represents the contents of this private key.

Overrides:

toString in class java.lang.Object

Returns:

the string representation