Package org.pgpainless.key.generation

Class KeyRingBuilder

java.lang.Object

org.pgpainless.key.generation.KeyRingBuilder

All Implemented Interfaces:

KeyRingBuilderInterface

public class KeyRingBuilder
extends java.lang.Object
implements KeyRingBuilderInterface

Nested Class Summary

Nested classes/interfaces inherited from interface org.pgpainless.key.generation.KeyRingBuilderInterface

KeyRingBuilderInterface.Build, KeyRingBuilderInterface.WithPassphrase, KeyRingBuilderInterface.WithPrimaryUserId

Constructor Summary

Constructors

Constructor	Description
KeyRingBuilder()

Method Summary

Modifier and Type	Method	Description
PGPKeyRing	simpleEcKeyRing(java.lang.String userId)	Creates an unencrypted key ring consisting of an ECDSA master key and an ECDH sub-key.
PGPKeyRing	simpleEcKeyRing(java.lang.String userId, java.lang.String password)	Creates a key ring consisting of an ECDSA master key and an ECDH sub-key.
PGPKeyRing	simpleRsaKeyRing(java.lang.String userId, RsaLength length)	Creates a simple, unencrypted RSA KeyPair of length length with user-id userId.
PGPKeyRing	simpleRsaKeyRing(java.lang.String userId, RsaLength length, java.lang.String password)	Creates a simple RSA KeyPair of length length with user-id userId.
KeyRingBuilderInterface.WithPrimaryUserId	withMasterKey(KeySpec spec)
KeyRingBuilderInterface	withSubKey(KeySpec type)

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyRingBuilder

public KeyRingBuilder()

Method Detail

simpleRsaKeyRing

public PGPKeyRing simpleRsaKeyRing(@Nonnull
                                   java.lang.String userId,
                                   @Nonnull
                                   RsaLength length)
                            throws java.security.InvalidAlgorithmParameterException,
                                   java.security.NoSuchAlgorithmException,
                                   org.bouncycastle.openpgp.PGPException

Creates a simple, unencrypted RSA KeyPair of length length with user-id userId. The KeyPair consists of a single RSA master key which is used for signing, encryption and certification.

Parameters:

userId - user id.

length - length in bits.

Returns:

PGPSecretKeyRing containing the KeyPair.

Throws:

org.bouncycastle.openpgp.PGPException

java.security.NoSuchAlgorithmException

java.security.InvalidAlgorithmParameterException

simpleRsaKeyRing

public PGPKeyRing simpleRsaKeyRing(@Nonnull
                                   java.lang.String userId,
                                   @Nonnull
                                   RsaLength length,
                                   java.lang.String password)
                            throws org.bouncycastle.openpgp.PGPException,
                                   java.security.NoSuchAlgorithmException,
                                   java.security.InvalidAlgorithmParameterException

Creates a simple RSA KeyPair of length length with user-id userId. The KeyPair consists of a single RSA master key which is used for signing, encryption and certification.

Parameters:

userId - user id.

length - length in bits.

password - Password of the key. Can be null for unencrypted keys.

Returns:

PGPSecretKeyRing containing the KeyPair.

Throws:

org.bouncycastle.openpgp.PGPException

java.security.NoSuchAlgorithmException

java.security.InvalidAlgorithmParameterException

simpleEcKeyRing

public PGPKeyRing simpleEcKeyRing(@Nonnull
                                  java.lang.String userId)
                           throws java.security.InvalidAlgorithmParameterException,
                                  java.security.NoSuchAlgorithmException,
                                  org.bouncycastle.openpgp.PGPException

Creates an unencrypted key ring consisting of an ECDSA master key and an ECDH sub-key. The ECDSA master key is used for signing messages and certifying the sub key. The ECDH sub-key is used for encryption of messages.

Parameters:

userId - user-id

Returns:

PGPSecretKeyRing containing the key pairs.

Throws:

org.bouncycastle.openpgp.PGPException

java.security.NoSuchAlgorithmException

java.security.InvalidAlgorithmParameterException

simpleEcKeyRing

public PGPKeyRing simpleEcKeyRing(@Nonnull
                                  java.lang.String userId,
                                  java.lang.String password)
                           throws org.bouncycastle.openpgp.PGPException,
                                  java.security.NoSuchAlgorithmException,
                                  java.security.InvalidAlgorithmParameterException

Creates a key ring consisting of an ECDSA master key and an ECDH sub-key. The ECDSA master key is used for signing messages and certifying the sub key. The ECDH sub-key is used for encryption of messages.

Parameters:

userId - user-id

password - Password of the private key. Can be null for an unencrypted key.

Returns:

PGPSecretKeyRing containing the key pairs.

Throws:

org.bouncycastle.openpgp.PGPException

java.security.NoSuchAlgorithmException

java.security.InvalidAlgorithmParameterException

withSubKey

public KeyRingBuilderInterface withSubKey(@Nonnull
                                          KeySpec type)

Specified by:

withSubKey in interface KeyRingBuilderInterface

withMasterKey

public KeyRingBuilderInterface.WithPrimaryUserId withMasterKey(@Nonnull
                                                               KeySpec spec)

Specified by:

withMasterKey in interface KeyRingBuilderInterface