From a8a7da06ab9e71fb1946a2805684d7749f08a30f Mon Sep 17 00:00:00 2001 From: Philip Helger Date: Mon, 6 Jan 2025 12:02:26 +0100 Subject: [PATCH] Improved comments --- .../phase4/crypto/ICryptoSessionKeyProvider.java | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/phase4-lib/src/main/java/com/helger/phase4/crypto/ICryptoSessionKeyProvider.java b/phase4-lib/src/main/java/com/helger/phase4/crypto/ICryptoSessionKeyProvider.java index b55d81b9f..3be463e33 100644 --- a/phase4-lib/src/main/java/com/helger/phase4/crypto/ICryptoSessionKeyProvider.java +++ b/phase4-lib/src/main/java/com/helger/phase4/crypto/ICryptoSessionKeyProvider.java @@ -24,6 +24,13 @@ import org.apache.wss4j.common.ext.WSSecurityException; import org.apache.wss4j.common.util.KeyUtils; +/** + * Interface for a "session key" provider, that is used for encrypting + * documents. Default instances for AES-128 and AES-256 are provided for + * simplicity. + * + * @author Philip Helger + */ public interface ICryptoSessionKeyProvider { /** @@ -36,7 +43,8 @@ public interface ICryptoSessionKeyProvider SecretKey getSessionKey (); /** - * Session key provider for AES-128 keys that can be used e.g. for AES-128-CBC or AES-128-GCM + * Session key provider for AES-128 keys that can be used e.g. for AES-128-CBC + * or AES-128-GCM */ ICryptoSessionKeyProvider INSTANCE_RANDOM_AES_128 = () -> { try @@ -54,7 +62,8 @@ public interface ICryptoSessionKeyProvider ICryptoSessionKeyProvider INSTANCE_RANDOM_AES_128_GCM = INSTANCE_RANDOM_AES_128; /** - * Session key provider for AES-256 keys that can be used e.g. for AES-256-CBC or AES-256-GCM + * Session key provider for AES-256 keys that can be used e.g. for AES-256-CBC + * or AES-256-GCM */ ICryptoSessionKeyProvider INSTANCE_RANDOM_AES_256 = () -> { try @@ -70,5 +79,4 @@ public interface ICryptoSessionKeyProvider @Deprecated (forRemoval = true, since = "3.0.2") ICryptoSessionKeyProvider INSTANCE_RANDOM_AES_256_GCM = INSTANCE_RANDOM_AES_256; - }