From 18a49d0afdb0e5ca18286fe1417cb1333cafec51 Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Tue, 20 May 2025 15:32:07 +0200
Subject: [PATCH] Add deprecation notices

---
 .../org/pgpainless/encryption_signing/EncryptionOptions.kt  | 2 ++
 .../src/main/kotlin/org/pgpainless/policy/Policy.kt         | 6 ++++++
 2 files changed, 8 insertions(+)

diff --git a/pgpainless-core/src/main/kotlin/org/pgpainless/encryption_signing/EncryptionOptions.kt b/pgpainless-core/src/main/kotlin/org/pgpainless/encryption_signing/EncryptionOptions.kt
index e971189d..45a8ba4e 100644
--- a/pgpainless-core/src/main/kotlin/org/pgpainless/encryption_signing/EncryptionOptions.kt
+++ b/pgpainless-core/src/main/kotlin/org/pgpainless/encryption_signing/EncryptionOptions.kt
@@ -47,6 +47,7 @@ class EncryptionOptions(private val purpose: EncryptionPurpose, private val api:
     @Deprecated(
         "Deprecated in favor of encryptionMechanismOverride",
         replaceWith = ReplaceWith("encryptionMechanismOverride"))
+    // TODO: Remove in 2.1
     val encryptionAlgorithmOverride
         get() =
             _encryptionMechanismOverride?.let {
@@ -394,6 +395,7 @@ class EncryptionOptions(private val purpose: EncryptionPurpose, private val api:
         replaceWith =
             ReplaceWith(
                 "overrideEncryptionMechanism(MessageEncryptionMechanism.integrityProtected(encryptionAlgorithm.algorithmId))"))
+    // TODO: Remove in 2.1
     fun overrideEncryptionAlgorithm(encryptionAlgorithm: SymmetricKeyAlgorithm) = apply {
         require(encryptionAlgorithm != SymmetricKeyAlgorithm.NULL) {
             "Encryption algorithm override cannot be NULL."
diff --git a/pgpainless-core/src/main/kotlin/org/pgpainless/policy/Policy.kt b/pgpainless-core/src/main/kotlin/org/pgpainless/policy/Policy.kt
index f6e1a4f0..be3d266c 100644
--- a/pgpainless-core/src/main/kotlin/org/pgpainless/policy/Policy.kt
+++ b/pgpainless-core/src/main/kotlin/org/pgpainless/policy/Policy.kt
@@ -49,6 +49,7 @@ class Policy {
         this.keyGenerationAlgorithmSuite = keyGenerationAlgorithmSuite
     }
 
+    @Deprecated("Constructors receiving SymmetricKeyAlgorithmPolicy objects are deprecated in favor of ones receiving MessageEncryptionMechanismPolicy objects.")
     constructor(
         certificationSignatureHashAlgorithmPolicy: HashAlgorithmPolicy,
         revocationSignatureHashAlgorithmPolicy: HashAlgorithmPolicy,
@@ -77,6 +78,7 @@ class Policy {
         this.keyGenerationAlgorithmSuite = keyGenerationAlgorithmSuite
     }
 
+    @Deprecated("Constructors receiving SymmetricKeyAlgorithmPolicy objects are deprecated in favor of ones receiving MessageEncryptionMechanismPolicy objects.")
     constructor() :
         this(
             HashAlgorithmPolicy.smartCertificationSignatureHashAlgorithmPolicy(),
@@ -91,10 +93,12 @@ class Policy {
             AlgorithmSuite.defaultAlgorithmSuite)
 
     @Deprecated("Deprecated in favor of messageEncryptionAlgorithmPolicy")
+    // TODO: Remove in 2.1
     val symmetricKeyEncryptionAlgorithmPolicy
         get() = messageEncryptionAlgorithmPolicy.symmetricAlgorithmPolicy
 
     @Deprecated("Deprecated in favor of messageDecryptionAlgorithmPolicy")
+    // TODO: Remove in 2.1
     val symmetricKeyDecryptionAlgorithmPolicy
         get() = messageDecryptionAlgorithmPolicy.symmetricAlgorithmPolicy
 
@@ -665,6 +669,7 @@ class Policy {
 
         @Deprecated(
             "Usage of SymmetricKeyAlgorithmPolicy is deprecated in favor of MessageEncryptionMechanismPolicy.")
+        // TODO: Remove in 2.1
         fun withSymmetricKeyEncryptionAlgorithmPolicy(
             symmetricKeyEncryptionAlgorithmPolicy: SymmetricKeyAlgorithmPolicy
         ) =
@@ -674,6 +679,7 @@ class Policy {
 
         @Deprecated(
             "Usage of SymmetricKeyAlgorithmPolicy is deprecated in favor of MessageEncryptionMechanismPolicy.")
+        // TODO: Remove in 2.1
         fun withSymmetricKeyDecryptionAlgorithmPolicy(
             symmetricKeyDecryptionAlgorithmPolicy: SymmetricKeyAlgorithmPolicy
         ) =