Package org.pgpainless.key.generation

Class KeyRingTemplates

java.lang.Object
org.pgpainless.key.generation.KeyRingTemplates
public final class KeyRingTemplates extends Object

  • Constructor Summary

    Constructors
    Constructor
    Description
    KeyRingTemplates()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.bouncycastle.openpgp.PGPSecretKeyRing
    modernKeyRing(String userId)
    Generate a modern PGP key ring consisting of an ed25519 EdDSA primary key which is used to certify an X25519 XDH encryption subkey and an ed25519 EdDSA signing key.
    org.bouncycastle.openpgp.PGPSecretKeyRing
    modernKeyRing(String userId, String password)
    Generate a modern PGP key ring consisting of an ed25519 EdDSA primary key which is used to certify an X25519 XDH encryption subkey and an ed25519 EdDSA signing key.
    org.bouncycastle.openpgp.PGPSecretKeyRing
    modernKeyRing(String userId, Passphrase passphrase)
     
    org.bouncycastle.openpgp.PGPSecretKeyRing
    simpleEcKeyRing(String userId)
    Creates a key ring consisting of an ed25519 EdDSA primary key and a curve25519 XDH subkey.
    org.bouncycastle.openpgp.PGPSecretKeyRing
    simpleEcKeyRing(String userId, String password)
    Creates a key ring consisting of an ed25519 EdDSA primary key and a X25519 XDH subkey.
    org.bouncycastle.openpgp.PGPSecretKeyRing
    simpleEcKeyRing(String userId, Passphrase passphrase)
     
    org.bouncycastle.openpgp.PGPSecretKeyRing
    simpleEcKeyRing(UserId userId)
    Creates a key ring consisting of an ed25519 EdDSA primary key and a curve25519 XDH subkey.
    org.bouncycastle.openpgp.PGPSecretKeyRing
    simpleEcKeyRing(UserId userId, String password)
    Creates a key ring consisting of an ed25519 EdDSA primary key and a curve25519 XDH subkey.
    org.bouncycastle.openpgp.PGPSecretKeyRing
    simpleRsaKeyRing(String userId, RsaLength length)
    Creates a simple, unencrypted RSA KeyPair of length length with user-id userId.
    org.bouncycastle.openpgp.PGPSecretKeyRing
    simpleRsaKeyRing(String userId, RsaLength length, String password)
    Creates a simple RSA KeyPair of length length with user-id userId.
    org.bouncycastle.openpgp.PGPSecretKeyRing
    simpleRsaKeyRing(String userId, RsaLength length, Passphrase passphrase)
     
    org.bouncycastle.openpgp.PGPSecretKeyRing
    simpleRsaKeyRing(UserId userId, RsaLength length)
    Creates a simple, unencrypted RSA KeyPair of length length with user-id userId.
    org.bouncycastle.openpgp.PGPSecretKeyRing
    simpleRsaKeyRing(UserId userId, RsaLength length, String password)
    Creates a simple RSA KeyPair of length length with user-id userId.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • KeyRingTemplates

      public KeyRingTemplates()

  • Method Details

    • simpleRsaKeyRing

      public org.bouncycastle.openpgp.PGPSecretKeyRing simpleRsaKeyRing(@Nullable UserId userId, @Nonnull RsaLength length) throws InvalidAlgorithmParameterException, 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:
      InvalidAlgorithmParameterException - in case of invalid key generation parameters
      NoSuchAlgorithmException - in case of missing algorithm implementation in the crypto provider
      org.bouncycastle.openpgp.PGPException - in case of an OpenPGP related error

    • simpleRsaKeyRing

      public org.bouncycastle.openpgp.PGPSecretKeyRing simpleRsaKeyRing(@Nullable String userId, @Nonnull RsaLength length) throws InvalidAlgorithmParameterException, 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:
      InvalidAlgorithmParameterException - in case of invalid key generation parameters
      NoSuchAlgorithmException - in case of missing algorithm implementation in the crypto provider
      org.bouncycastle.openpgp.PGPException - in case of an OpenPGP related error

    • simpleRsaKeyRing

      public org.bouncycastle.openpgp.PGPSecretKeyRing simpleRsaKeyRing(@Nullable UserId userId, @Nonnull RsaLength length, @Nullable String password) throws InvalidAlgorithmParameterException, NoSuchAlgorithmException, org.bouncycastle.openpgp.PGPException
      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:
      InvalidAlgorithmParameterException - in case of invalid key generation parameters
      NoSuchAlgorithmException - in case of missing algorithm implementation in the crypto provider
      org.bouncycastle.openpgp.PGPException - in case of an OpenPGP related error

    • simpleRsaKeyRing

      public org.bouncycastle.openpgp.PGPSecretKeyRing simpleRsaKeyRing(@Nullable String userId, @Nonnull RsaLength length, @Nullable String password) throws org.bouncycastle.openpgp.PGPException, NoSuchAlgorithmException, 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:
      InvalidAlgorithmParameterException - in case of invalid key generation parameters
      NoSuchAlgorithmException - in case of missing algorithm implementation in the crypto provider
      org.bouncycastle.openpgp.PGPException - in case of an OpenPGP related error

    • simpleRsaKeyRing

      public org.bouncycastle.openpgp.PGPSecretKeyRing simpleRsaKeyRing(@Nullable String userId, @Nonnull RsaLength length, @Nonnull Passphrase passphrase) throws org.bouncycastle.openpgp.PGPException, InvalidAlgorithmParameterException, NoSuchAlgorithmException
      Throws:
      org.bouncycastle.openpgp.PGPException
      InvalidAlgorithmParameterException
      NoSuchAlgorithmException

    • simpleEcKeyRing

      public org.bouncycastle.openpgp.PGPSecretKeyRing simpleEcKeyRing(@Nullable UserId userId) throws InvalidAlgorithmParameterException, NoSuchAlgorithmException, org.bouncycastle.openpgp.PGPException
      Creates a key ring consisting of an ed25519 EdDSA primary key and a curve25519 XDH subkey. The EdDSA primary key is used for signing messages and certifying the sub key. The XDH subkey is used for encryption and decryption of messages.
      Parameters:
      userId - user-id
      Returns:
      PGPSecretKeyRing containing the key pairs.
      Throws:
      InvalidAlgorithmParameterException - in case of invalid key generation parameters
      NoSuchAlgorithmException - in case of missing algorithm implementation in the crypto provider
      org.bouncycastle.openpgp.PGPException - in case of an OpenPGP related error

    • simpleEcKeyRing

      public org.bouncycastle.openpgp.PGPSecretKeyRing simpleEcKeyRing(@Nullable String userId) throws InvalidAlgorithmParameterException, NoSuchAlgorithmException, org.bouncycastle.openpgp.PGPException
      Creates a key ring consisting of an ed25519 EdDSA primary key and a curve25519 XDH subkey. The EdDSA primary key is used for signing messages and certifying the sub key. The XDH subkey is used for encryption and decryption of messages.
      Parameters:
      userId - user-id
      Returns:
      PGPSecretKeyRing containing the key pairs.
      Throws:
      InvalidAlgorithmParameterException - in case of invalid key generation parameters
      NoSuchAlgorithmException - in case of missing algorithm implementation in the crypto provider
      org.bouncycastle.openpgp.PGPException - in case of an OpenPGP related error

    • simpleEcKeyRing

      public org.bouncycastle.openpgp.PGPSecretKeyRing simpleEcKeyRing(@Nullable UserId userId, String password) throws InvalidAlgorithmParameterException, NoSuchAlgorithmException, org.bouncycastle.openpgp.PGPException
      Creates a key ring consisting of an ed25519 EdDSA primary key and a curve25519 XDH subkey. The EdDSA primary key is used for signing messages and certifying the sub key. The XDH subkey is used for encryption and decryption 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:
      InvalidAlgorithmParameterException - in case of invalid key generation parameters
      NoSuchAlgorithmException - in case of missing algorithm implementation in the crypto provider
      org.bouncycastle.openpgp.PGPException - in case of an OpenPGP related error

    • simpleEcKeyRing

      public org.bouncycastle.openpgp.PGPSecretKeyRing simpleEcKeyRing(@Nullable String userId, String password) throws org.bouncycastle.openpgp.PGPException, NoSuchAlgorithmException, InvalidAlgorithmParameterException
      Creates a key ring consisting of an ed25519 EdDSA primary key and a X25519 XDH subkey. The EdDSA primary key is used for signing messages and certifying the sub key. The XDH subkey is used for encryption and decryption 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:
      InvalidAlgorithmParameterException - in case of invalid key generation parameters
      NoSuchAlgorithmException - in case of missing algorithm implementation in the crypto provider
      org.bouncycastle.openpgp.PGPException - in case of an OpenPGP related error

    • simpleEcKeyRing

      public org.bouncycastle.openpgp.PGPSecretKeyRing simpleEcKeyRing(@Nullable String userId, @Nonnull Passphrase passphrase) throws org.bouncycastle.openpgp.PGPException, InvalidAlgorithmParameterException, NoSuchAlgorithmException
      Throws:
      org.bouncycastle.openpgp.PGPException
      InvalidAlgorithmParameterException
      NoSuchAlgorithmException

    • modernKeyRing

      public org.bouncycastle.openpgp.PGPSecretKeyRing modernKeyRing(@Nullable String userId) throws org.bouncycastle.openpgp.PGPException, InvalidAlgorithmParameterException, NoSuchAlgorithmException
      Generate a modern PGP key ring consisting of an ed25519 EdDSA primary key which is used to certify an X25519 XDH encryption subkey and an ed25519 EdDSA signing key.
      Parameters:
      userId - primary user id
      Returns:
      key ring
      Throws:
      InvalidAlgorithmParameterException - in case of invalid key generation parameters
      NoSuchAlgorithmException - in case of missing algorithm implementation in the crypto provider
      org.bouncycastle.openpgp.PGPException - in case of an OpenPGP related error

    • modernKeyRing

      public org.bouncycastle.openpgp.PGPSecretKeyRing modernKeyRing(@Nullable String userId, @Nullable String password) throws InvalidAlgorithmParameterException, NoSuchAlgorithmException, org.bouncycastle.openpgp.PGPException
      Generate a modern PGP key ring consisting of an ed25519 EdDSA primary key which is used to certify an X25519 XDH encryption subkey and an ed25519 EdDSA signing key.
      Parameters:
      userId - primary user id
      password - passphrase or null if the key should be unprotected.
      Returns:
      key ring
      Throws:
      InvalidAlgorithmParameterException - in case of invalid key generation parameters
      NoSuchAlgorithmException - in case of missing algorithm implementation in the crypto provider
      org.bouncycastle.openpgp.PGPException - in case of an OpenPGP related error

    • modernKeyRing

      public org.bouncycastle.openpgp.PGPSecretKeyRing modernKeyRing(@Nullable String userId, @Nonnull Passphrase passphrase) throws org.bouncycastle.openpgp.PGPException, InvalidAlgorithmParameterException, NoSuchAlgorithmException
      Throws:
      org.bouncycastle.openpgp.PGPException
      InvalidAlgorithmParameterException
      NoSuchAlgorithmException