Deprecate addPassphrase()/addDecryptionPassphrase in favor of addMessagePassphrase()

pgpainless-core/src/main/kotlin/org/pgpainless/decryption_verification/ConsumerOptions.kt

@@ -196,7 +196,22 @@ class ConsumerOptions {
      * @param passphrase passphrase
      * @return options
      */
-    fun addDecryptionPassphrase(passphrase: Passphrase) = apply {
+    @Deprecated(
+        "Deprecated in favor of addMessagePassphrase",
+        ReplaceWith("addMessagePassphrase(passphrase)"))
+    fun addDecryptionPassphrase(passphrase: Passphrase) = addMessagePassphrase(passphrase)
+
+    /**
+     * Add a passphrase for message decryption. This passphrase will be used to try to decrypt
+     * messages which were symmetrically encrypted for a passphrase.
+     *
+     * See
+     * [Symmetrically Encrypted Data Packet](https://datatracker.ietf.org/doc/html/rfc4880#section-5.7)
+     *
+     * @param passphrase passphrase
+     * @return options
+     */
+    fun addMessagePassphrase(passphrase: Passphrase) = apply {
         decryptionPassphrases.add(passphrase)
     }
 

pgpainless-core/src/main/kotlin/org/pgpainless/encryption_signing/EncryptionOptions.kt

@@ -227,7 +227,18 @@ class EncryptionOptions(private val purpose: EncryptionPurpose) {
      * @param passphrase passphrase
      * @return this
      */
-    fun addPassphrase(passphrase: Passphrase) = apply {
+    @Deprecated(
+        "Deprecated in favor of addMessagePassphrase",
+        ReplaceWith("addMessagePassphrase(passphrase)"))
+    fun addPassphrase(passphrase: Passphrase) = addMessagePassphrase(passphrase)
+
+    /**
+     * Add a symmetric passphrase which the message will be encrypted to.
+     *
+     * @param passphrase passphrase
+     * @return this
+     */
+    fun addMessagePassphrase(passphrase: Passphrase) = apply {
         require(!passphrase.isEmpty) { "Passphrase MUST NOT be empty." }
         addEncryptionMethod(
             ImplementationFactory.getInstance().getPBEKeyEncryptionMethodGenerator(passphrase))