Package org.pgpainless

Class PGPainless

java.lang.Object

org.pgpainless.PGPainless

public class PGPainless
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
PGPainless()

Method Summary

Modifier and Type	Method	Description
static DecryptionBuilder	createDecryptor()	Deprecated. Use decryptAndOrVerify() instead.
static EncryptionBuilder	createEncryptor()	Deprecated. Use encryptAndOrSign() instead.
static DecryptionBuilder	decryptAndOrVerify()	Create a DecryptionStream, which can be used to decrypt and/or verify data using OpenPGP.
static byte[]	decryptWithPassword(byte[] data, Passphrase password)	Deprecated. Use decryptAndOrVerify() instead and provide the decryption passphrase in DecryptionBuilderInterface.DecryptWith.decryptWith(Passphrase).
static EncryptionBuilder	encryptAndOrSign()	Create an EncryptionStream, which can be used to encrypt and/or sign data using OpenPGP.
static EncryptionBuilder	encryptAndOrSign(EncryptionStream.Purpose purpose)	Create an EncryptionStream, that can be used to encrypt and/or sign data using OpenPGP.
static byte[]	encryptWithPassword(byte[] data, Passphrase password, SymmetricKeyAlgorithm algorithm)	Deprecated. use encryptAndOrSign() instead and provide a passphrase in EncryptionBuilderInterface.ToRecipients.forPassphrases(Passphrase...).
static KeyRingBuilder	generateKeyRing()	Generate a new OpenPGP key ring.
static KeyRingInfo	inspectKeyRing(org.bouncycastle.openpgp.PGPKeyRing keyRing)	Quickly access information about a PGPPublicKeyRing / PGPSecretKeyRing.
static SecretKeyRingEditorInterface	modifyKeyRing(org.bouncycastle.openpgp.PGPSecretKeyRing secretKeys)
static KeyRingReader	readKeyRing()	Read an existing OpenPGP key ring.

Methods inherited from class java.lang.Object

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

Constructor Detail

PGPainless

public PGPainless()

Method Detail

generateKeyRing

public static KeyRingBuilder generateKeyRing()

Generate a new OpenPGP key ring.

Returns:

builder

readKeyRing

public static KeyRingReader readKeyRing()

Read an existing OpenPGP key ring.

Returns:

builder

createEncryptor

@Deprecated
public static EncryptionBuilder createEncryptor()

Deprecated.

Use encryptAndOrSign() instead.

Create an EncryptionStream, which can be used to encrypt and/or sign data using OpenPGP.

Returns:

builder

encryptAndOrSign

public static EncryptionBuilder encryptAndOrSign()

Create an EncryptionStream, which can be used to encrypt and/or sign data using OpenPGP. This method assumes that the stream will be used to encrypt data for communication purposes. If you instead want to encrypt data that will be saved on disk (eg. a backup), use encryptAndOrSign(EncryptionStream.Purpose) and chose an appropriate purpose.

Returns:

builder

encryptAndOrSign

public static EncryptionBuilder encryptAndOrSign(EncryptionStream.Purpose purpose)

Create an EncryptionStream, that can be used to encrypt and/or sign data using OpenPGP.

Parameters:

purpose - how will the data be used?

Returns:

builder

createDecryptor

@Deprecated
public static DecryptionBuilder createDecryptor()

Deprecated.

Use decryptAndOrVerify() instead.

Create a DecryptionStream, which can be used to decrypt and/or verify data using OpenPGP.

Returns:

builder

decryptAndOrVerify

public static DecryptionBuilder decryptAndOrVerify()

Create a DecryptionStream, which can be used to decrypt and/or verify data using OpenPGP.

Returns:

builder

modifyKeyRing

public static SecretKeyRingEditorInterface modifyKeyRing(org.bouncycastle.openpgp.PGPSecretKeyRing secretKeys)

inspectKeyRing

public static KeyRingInfo inspectKeyRing(org.bouncycastle.openpgp.PGPKeyRing keyRing)

Quickly access information about a PGPPublicKeyRing / PGPSecretKeyRing.

Parameters:

keyRing - key ring

Returns:

access object

encryptWithPassword

@Deprecated
public static byte[] encryptWithPassword(@Nonnull
                                         byte[] data,
                                         @Nonnull
                                         Passphrase password,
                                         @Nonnull
                                         SymmetricKeyAlgorithm algorithm)
                                  throws java.io.IOException,
                                         org.bouncycastle.openpgp.PGPException

Deprecated.

use encryptAndOrSign() instead and provide a passphrase in EncryptionBuilderInterface.ToRecipients.forPassphrases(Passphrase...).

Encrypt some data symmetrically using OpenPGP and a password. The resulting data will be uncompressed and integrity protected.

Parameters:

data - input data.

password - password.

algorithm - symmetric encryption algorithm.

Returns:

symmetrically OpenPGP encrypted data.

Throws:

java.io.IOException - IO is dangerous.

org.bouncycastle.openpgp.PGPException - PGP is brittle.

decryptWithPassword

@Deprecated
public static byte[] decryptWithPassword(@Nonnull
                                         byte[] data,
                                         @Nonnull
                                         Passphrase password)
                                  throws java.io.IOException,
                                         org.bouncycastle.openpgp.PGPException

Deprecated.

Use decryptAndOrVerify() instead and provide the decryption passphrase in DecryptionBuilderInterface.DecryptWith.decryptWith(Passphrase).

Decrypt some symmetrically encrypted data using a password. The data is suspected to be integrity protected.

Parameters:

data - symmetrically OpenPGP encrypted data.

password - password.

Returns:

decrypted data.

Throws:

java.io.IOException - IO is dangerous.

org.bouncycastle.openpgp.PGPException - PGP is brittle.