From 0bce68d6ee3c147d707b627a5766c01f76a107ae Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Mon, 4 Apr 2022 20:18:15 +0200
Subject: [PATCH] Add shortcut SigningOptions.addSignature() method

---
 .../encryption_signing/SigningOptions.java        | 15 +++++++++++++++
 .../test/java/org/pgpainless/example/Sign.java    |  2 +-
 2 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/pgpainless-core/src/main/java/org/pgpainless/encryption_signing/SigningOptions.java b/pgpainless-core/src/main/java/org/pgpainless/encryption_signing/SigningOptions.java
index 0608b22e..52d21641 100644
--- a/pgpainless-core/src/main/java/org/pgpainless/encryption_signing/SigningOptions.java
+++ b/pgpainless-core/src/main/java/org/pgpainless/encryption_signing/SigningOptions.java
@@ -98,6 +98,21 @@ public final class SigningOptions {
         return new SigningOptions();
     }
 
+    /**
+     * Sign the message using an inline signature made by the provided signing key.
+     *
+     * @param signingKeyProtector protector to unlock the signing key
+     * @param signingKey key ring containing the signing key
+     * @return this
+     *
+     * @throws PGPException if the key cannot be unlocked or a signing method cannot be created
+     */
+    public SigningOptions addSignature(SecretKeyRingProtector signingKeyProtector,
+                                       PGPSecretKeyRing signingKey)
+            throws PGPException {
+        return addInlineSignature(signingKeyProtector, signingKey, DocumentSignatureType.BINARY_DOCUMENT);
+    }
+
     /**
      * Add inline signatures with all secret key rings in the provided secret key ring collection.
      *
diff --git a/pgpainless-core/src/test/java/org/pgpainless/example/Sign.java b/pgpainless-core/src/test/java/org/pgpainless/example/Sign.java
index 13185e37..77db571d 100644
--- a/pgpainless-core/src/test/java/org/pgpainless/example/Sign.java
+++ b/pgpainless-core/src/test/java/org/pgpainless/example/Sign.java
@@ -55,7 +55,7 @@ public class Sign {
         EncryptionStream signingStream = PGPainless.encryptAndOrSign()
                 .onOutputStream(signedOut)
                 .withOptions(ProducerOptions.sign(SigningOptions.get()
-                                .addInlineSignature(protector, secretKey, DocumentSignatureType.CANONICAL_TEXT_DOCUMENT))
+                                .addSignature(protector, secretKey))
                 );
 
         Streams.pipeAll(messageIn, signingStream);