org.multibit.commons.crypto

Class PGPUtils

java.lang.Object

org.multibit.commons.crypto.PGPUtils

public class PGPUtils
extends Object

Utility to provide the following to BRIT API:

• Access to PGP crypto functions in Bouncy Castle

Derived from org.bouncycastle.openpgp.examples by seamans

Since:

0.0.1

Method Summary

Modifier and Type	Method and Description
static void	decryptFile(InputStream encryptedInputStream, OutputStream decryptedOutputStream, InputStream keyInputStream, char[] password) Decrypt the passed in message stream
static void	encryptFile(OutputStream armoredOut, File inputFile, org.bouncycastle.openpgp.PGPPublicKey encKey) Encrypt a file
static org.bouncycastle.openpgp.PGPPrivateKey	findPrivateKey(InputStream keyIn, long keyID, char[] pass) Load a secret key ring collection from keyIn and find the secret key corresponding to keyID if it exists.
static org.bouncycastle.openpgp.PGPPublicKey	readPublicKey(InputStream in) Load a PGP public key from a public keyring or ASCII armored text file

Methods inherited from class java.lang.Object

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

Method Detail

readPublicKey

public static org.bouncycastle.openpgp.PGPPublicKey readPublicKey(InputStream in)
                                                           throws IOException,
                                                                  org.bouncycastle.openpgp.PGPException

Load a PGP public key from a public keyring or ASCII armored text file

Returns:

key the first PGP public key in the found keyring/ ASCII armored text file

Throws:

IOException

org.bouncycastle.openpgp.PGPException

findPrivateKey

public static org.bouncycastle.openpgp.PGPPrivateKey findPrivateKey(InputStream keyIn,
                                                                    long keyID,
                                                                    char[] pass)
                                                             throws IOException,
                                                                    org.bouncycastle.openpgp.PGPException,
                                                                    NoSuchProviderException

Load a secret key ring collection from keyIn and find the secret key corresponding to keyID if it exists.

Parameters:

keyIn - input stream representing a key ring collection.

keyID - keyID we want.

pass - passphrase to decrypt secret key with.

Returns:

The PGPPrivate key matching the keyID

Throws:

IOException - If the input stream has a problem

org.bouncycastle.openpgp.PGPException - If the data format is incorrect

NoSuchProviderException - If the digest provider is not available

decryptFile

public static void decryptFile(InputStream encryptedInputStream,
                               OutputStream decryptedOutputStream,
                               InputStream keyInputStream,
                               char[] password)
                        throws IOException,
                               org.bouncycastle.openpgp.PGPException,
                               NoSuchProviderException

Decrypt the passed in message stream

Parameters:

encryptedInputStream - The input stream

decryptedOutputStream - The output stream

keyInputStream - The key input stream

password - The credentials

Throws:

IOException - If the input stream has a problem

org.bouncycastle.openpgp.PGPException - If the data format is incorrect

NoSuchProviderException - If the digest provider is not available

encryptFile

public static void encryptFile(OutputStream armoredOut,
                               File inputFile,
                               org.bouncycastle.openpgp.PGPPublicKey encKey)
                        throws IOException,
                               NoSuchProviderException,
                               org.bouncycastle.openpgp.PGPException

Encrypt a file

Parameters:

armoredOut - The output stream

inputFile - The input file

encKey - The PGP public key for encrypting

Throws:

IOException

NoSuchProviderException

org.bouncycastle.openpgp.PGPException