From 9c81137f4884c9d401dbc0435d40ba872dcb704e Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Wed, 3 May 2023 13:51:34 +0200
Subject: [PATCH] Add template methods to generate RSA keys with primary and
 subkeys

---
 .../key/generation/KeyRingTemplates.java      | 72 +++++++++++++++++++
 1 file changed, 72 insertions(+)

diff --git a/pgpainless-core/src/main/java/org/pgpainless/key/generation/KeyRingTemplates.java b/pgpainless-core/src/main/java/org/pgpainless/key/generation/KeyRingTemplates.java
index 42eb7efa..07f2235f 100644
--- a/pgpainless-core/src/main/java/org/pgpainless/key/generation/KeyRingTemplates.java
+++ b/pgpainless-core/src/main/java/org/pgpainless/key/generation/KeyRingTemplates.java
@@ -26,6 +26,78 @@ public final class KeyRingTemplates {
 
     }
 
+    /**
+     * Generate an RSA OpenPGP key consisting of an RSA primary key used for certification,
+     * a dedicated RSA subkey used for signing and a third RSA subkey used for encryption.
+     *
+     * @param userId userId or null
+     * @param length length of the RSA keys
+     * @return key
+     * @throws InvalidAlgorithmParameterException in case of invalid key generation parameters
+     * @throws NoSuchAlgorithmException in case of missing algorithm implementation in the crypto provider
+     * @throws PGPException in case of an OpenPGP related error
+     */
+    public PGPSecretKeyRing rsaKeyRing(@Nullable CharSequence userId,
+                                       @Nonnull RsaLength length)
+            throws PGPException, InvalidAlgorithmParameterException, NoSuchAlgorithmException {
+        return rsaKeyRing(userId, length, Passphrase.emptyPassphrase());
+    }
+
+    /**
+     * Generate an RSA OpenPGP key consisting of an RSA primary key used for certification,
+     * a dedicated RSA subkey used for signing and a third RSA subkey used for encryption.
+     *
+     * @param userId userId or null
+     * @param length length of the RSA keys
+     * @param password passphrase to encrypt the key with
+     * @return key
+     * @throws InvalidAlgorithmParameterException in case of invalid key generation parameters
+     * @throws NoSuchAlgorithmException in case of missing algorithm implementation in the crypto provider
+     * @throws PGPException in case of an OpenPGP related error
+     */
+    public PGPSecretKeyRing rsaKeyRing(@Nullable CharSequence userId,
+                                       @Nonnull RsaLength length,
+                                       @Nonnull String password)
+            throws PGPException, InvalidAlgorithmParameterException, NoSuchAlgorithmException {
+        Passphrase passphrase = Passphrase.emptyPassphrase();
+        if (!isNullOrEmpty(password)) {
+            passphrase = Passphrase.fromPassword(password);
+        }
+        return rsaKeyRing(userId, length, passphrase);
+    }
+
+    /**
+     * Generate an RSA OpenPGP key consisting of an RSA primary key used for certification,
+     * a dedicated RSA subkey used for signing and a third RSA subkey used for encryption.
+     *
+     * @param userId userId or null
+     * @param length length of the RSA keys
+     * @param passphrase passphrase to encrypt the key with
+     * @return key
+     * @throws InvalidAlgorithmParameterException in case of invalid key generation parameters
+     * @throws NoSuchAlgorithmException in case of missing algorithm implementation in the crypto provider
+     * @throws PGPException in case of an OpenPGP related error
+     */
+    public PGPSecretKeyRing rsaKeyRing(@Nullable CharSequence userId,
+                                       @Nonnull RsaLength length,
+                                       @Nonnull Passphrase passphrase)
+            throws PGPException, InvalidAlgorithmParameterException, NoSuchAlgorithmException {
+        KeyRingBuilder builder = PGPainless.buildKeyRing()
+                .setPrimaryKey(KeySpec.getBuilder(KeyType.RSA(length), KeyFlag.CERTIFY_OTHER))
+                .addSubkey(KeySpec.getBuilder(KeyType.RSA(length), KeyFlag.SIGN_DATA))
+                .addSubkey(KeySpec.getBuilder(KeyType.RSA(length), KeyFlag.ENCRYPT_COMMS, KeyFlag.ENCRYPT_STORAGE));
+
+        if (userId != null) {
+            builder.addUserId(userId.toString());
+        }
+
+        if (!passphrase.isEmpty()) {
+            builder.setPassphrase(passphrase);
+        }
+
+        return builder.build();
+    }
+
     /**
      * Creates a simple, unencrypted RSA KeyPair of length {@code length} with user-id {@code userId}.
      * The KeyPair consists of a single RSA master key which is used for signing, encryption and certification.