com.addc.server.commons.security

Class PemSecretKeyHelper

java.lang.Object

com.addc.server.commons.security.PemSecretKeyHelper

public final class PemSecretKeyHelper
extends Object

The PemSecretKeyHelper supplies a helper for reading and writing SecretKeys to PKCS#8 password encrypted files

Method Summary

Methods

Modifier and Type	Method and Description
static PemSecretKeyHelper	getInstance() Get the singleton instance of this class.
SecretKey	readPrivateKeyFromPEM(String fileName, char[] passwd) Read a secret key from a PEM file.
SecretKey	readSecretKeyFromPEM(File file, char[] passwd) Read a secret key from a PEM file.
SecretKey	readSecretKeyFromPEM(InputStream inStream, char[] passwd) file Read a secret key from a stream.
void	writeSecretKeyToPEM(SecretKey secretKey, File file, char[] passwd) Write a Secret Key to the given file
void	writeSecretKeyToPEM(SecretKey secretKey, OutputStream outStream, char[] passwd) Write a Secret Key to the given output stream
void	writeSecretKeyToPEM(SecretKey secretKey, String fileName, char[] passwd) Write a Secret Key to the given file

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static PemSecretKeyHelper getInstance()

Get the singleton instance of this class.

Returns:

the singleton instance of this class.

readPrivateKeyFromPEM

public SecretKey readPrivateKeyFromPEM(String fileName,
                              char[] passwd)
                                throws IOException,
                                       GeneralSecurityException

Read a secret key from a PEM file.

Parameters:

fileName - The name of the pem file if the name starts with classpath: the file is sought on the class path.

passwd - The password to decrypt the content

Returns:

The secret key

Throws:

GeneralSecurityException - If any of the ciphers or factories fails

IOException - if the resource cannot be opened or there is a read error

readSecretKeyFromPEM

public SecretKey readSecretKeyFromPEM(File file,
                             char[] passwd)
                               throws IOException,
                                      GeneralSecurityException

Read a secret key from a PEM file.

Parameters:

file - The file to read from

passwd - The password to decrypt the content

Returns:

The secret key

Throws:

GeneralSecurityException - If any of the ciphers or factories fails

IOException - if the resource cannot be opened or there is a read error

readSecretKeyFromPEM

public SecretKey readSecretKeyFromPEM(InputStream inStream,
                             char[] passwd)
                               throws GeneralSecurityException,
                                      IOException

file Read a secret key from a stream.

Parameters:

inStream - The stream to read from

passwd - The password to decrypt the content

Returns:

The secret key

Throws:

GeneralSecurityException - If any of the ciphers or factories fails

IOException - if the resource cannot be opened or there is a read error

writeSecretKeyToPEM

public void writeSecretKeyToPEM(SecretKey secretKey,
                       String fileName,
                       char[] passwd)
                         throws GeneralSecurityException,
                                IOException

Write a Secret Key to the given file

Parameters:

secretKey - The key to write

fileName - The name of the file to write to

passwd - The password to encrypt the content

Throws:

GeneralSecurityException - If any of the algorithms or ciphers fails

IOException - If the file cannot be opened or written to

writeSecretKeyToPEM

public void writeSecretKeyToPEM(SecretKey secretKey,
                       File file,
                       char[] passwd)
                         throws GeneralSecurityException,
                                IOException

Write a Secret Key to the given file

Parameters:

secretKey - The key to write

file - The file to write to

passwd - The password to encrypt the content

Throws:

GeneralSecurityException - If any of the algorithms or ciphers fails

IOException - If the file cannot be opened or written to

writeSecretKeyToPEM

public void writeSecretKeyToPEM(SecretKey secretKey,
                       OutputStream outStream,
                       char[] passwd)
                         throws GeneralSecurityException,
                                IOException

Write a Secret Key to the given output stream

Parameters:

secretKey - The key to write

outStream - The stream to write to

passwd - The password to encrypt the content

Throws:

GeneralSecurityException - If any of the algorithms or ciphers fails

IOException - If the file cannot be opened or written to