iaik.utils

Class SSLeayPrivateKey

java.lang.Object

iaik.utils.SSLeayPrivateKey

All Implemented Interfaces:

java.io.Serializable, java.security.Key, java.security.PrivateKey

public class SSLeayPrivateKey
extends java.lang.Object
implements java.security.PrivateKey

The SSLeayPrivateKey is used to read/write and decrypt/encrypt private keys created with SSLeay or OpenSSL, respectively.

Version:

File Revision 19

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SSLeayPrivateKey(java.io.InputStream is) Reads a private key created by SSLeay from the specified file.
SSLeayPrivateKey(java.security.PrivateKey privateKey) This constructor gets a private key object to convert it into the OpenSSL format.
SSLeayPrivateKey(java.lang.String fileName) Reads a private key created by SSLeay from the specified file.

Method Summary

Methods

Modifier and Type	Method and Description
void	decrypt(java.lang.String password) Decrypts this private key.
void	encrypt(java.lang.String password, java.lang.String encryptionAlg, byte[] iv) Encrypts this private key.
java.lang.String	getAlgorithm() Returns the symmetric encryption algorithm used to protect this private key.
byte[]	getEncoded() This method returns the DER encoded OpenSSL key which has PKCS#1 format.
java.lang.String	getFormat() Returns the format used to encode the key or null if the key does not support encoding.
java.security.PrivateKey	getPrivateKey() Returns the included private key.
boolean	isEncrypted() Test if this private key is encrypted.
void	writeTo(java.io.OutputStream out) Write the SSLeayPrivateKey to a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

SSLeayPrivateKey

public SSLeayPrivateKey(java.security.PrivateKey privateKey)
                 throws java.security.InvalidKeyException,
                        CodingException

This constructor gets a private key object to convert it into the OpenSSL format. The object should be an instance of RSAPrivateKey, DSAPrivateKey, or DHPrivateKey.

Parameters:

privateKey - the key object

Throws:

java.security.InvalidKeyException - if the key is invalid

CodingException - if the key cannot be encoded

SSLeayPrivateKey

public SSLeayPrivateKey(java.lang.String fileName)
                 throws java.io.IOException,
                        java.security.InvalidKeyException

Reads a private key created by SSLeay from the specified file.

Parameters:

fileName - the name of the file containing the private key

Throws:

java.io.IOException - if an error occurs during reading the key

java.security.InvalidKeyException - if the key can not be parsed

SSLeayPrivateKey

public SSLeayPrivateKey(java.io.InputStream is)
                 throws java.io.IOException,
                        java.security.InvalidKeyException

Reads a private key created by SSLeay from the specified file.

Parameters:

is - an input stream containing the private key

Throws:

java.io.IOException - if an error occurs during reading the key

java.security.InvalidKeyException - if the key can not be parsed

Method Detail

isEncrypted

public boolean isEncrypted()

Test if this private key is encrypted.

Returns:

true if this private key is encrypted

getPrivateKey

public java.security.PrivateKey getPrivateKey()
                                       throws java.security.InvalidKeyException

Returns the included private key.

Returns:

the private key

Throws:

java.security.InvalidKeyException - if an error occurs during parsing this private key or the is not decrypted yet

decrypt

public void decrypt(java.lang.String password)
             throws java.security.InvalidKeyException

Decrypts this private key. Does nothing if the key is not encrypted.

Parameters:

password - the password to decrypt the private key

Throws:

java.security.InvalidKeyException

encrypt

public void encrypt(java.lang.String password,
           java.lang.String encryptionAlg,
           byte[] iv)
             throws java.security.InvalidKeyException,
                    java.security.NoSuchAlgorithmException,
                    java.security.GeneralSecurityException

Encrypts this private key. Does nothing if the key is already encrypted. The algorithm should be one of DES-CBC, DES-EDE3-CBC (default if null), or IDEA/CBC/PKCS5Padding. If iv is null, a new value is generated

Parameters:

password - the password to decrypt the private key

encryptionAlg - the algorithm used to encrypt the private key

iv - the initialization vector

Throws:

java.security.InvalidKeyException

java.security.NoSuchAlgorithmException

java.security.GeneralSecurityException

getAlgorithm

public java.lang.String getAlgorithm()

Returns the symmetric encryption algorithm used to protect this private key.

Specified by:

getAlgorithm in interface java.security.Key

Returns:

the encryption algorithm or null if the private key is not encrypted

getEncoded

public byte[] getEncoded()

This method returns the DER encoded OpenSSL key which has PKCS#1 format.

Specified by:

getEncoded in interface java.security.Key

Returns:

the encoded OpenSSL key

getFormat

public java.lang.String getFormat()

Returns the format used to encode the key or null if the key does not support encoding.

Specified by:

getFormat in interface java.security.Key

Returns:

the string "SSLeay"

writeTo

public void writeTo(java.io.OutputStream out)
             throws java.io.IOException

Write the SSLeayPrivateKey to a file.

Throws:

java.io.IOException