fix: save generated cipher params in ChannelOptions

ably · Sep 28, 2023 · 188541d · 188541d
1 parent da5406f
commit 188541d
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 14 deletions.
diff --git a/lib/src/main/java/io/ably/lib/types/BaseMessage.java b/lib/src/main/java/io/ably/lib/types/BaseMessage.java
@@ -147,7 +147,7 @@ public void decode(ChannelOptions opts,  DecodingContext context) throws Message
                         case "cipher":
                             if(opts != null && opts.encrypted) {
                                 try {
-                                    DecryptingChannelCipher cipher = Crypto.createChannelDecipher(opts);
+                                    DecryptingChannelCipher cipher = Crypto.createChannelDecipher(opts.getCipherParamsOrDefault());
                                     data = cipher.decrypt((byte[]) data);
                                 } catch(AblyException e) {
                                     throw MessageDecodeException.fromDescription(e.errorInfo.message);
@@ -196,7 +196,7 @@ public void encode(ChannelOptions opts) throws AblyException {
             }
         }
         if (opts != null && opts.encrypted) {
-            EncryptingChannelCipher cipher = Crypto.createChannelEncipher(opts);
+            EncryptingChannelCipher cipher = Crypto.createChannelEncipher(opts.getCipherParamsOrDefault());
             data = cipher.encrypt((byte[]) data);
             encoding = ((encoding == null) ? "" : encoding + "/") + "cipher+" + cipher.getAlgorithm();
         }

diff --git a/lib/src/main/java/io/ably/lib/types/ChannelOptions.java b/lib/src/main/java/io/ably/lib/types/ChannelOptions.java
@@ -4,6 +4,7 @@
 
 import io.ably.lib.util.Base64Coder;
 import io.ably.lib.util.Crypto;
+import io.ably.lib.util.Crypto.CipherParams;
 
 /**
  * Passes additional properties to a {@link io.ably.lib.rest.Channel} or {@link io.ably.lib.realtime.Channel} object,
@@ -105,4 +106,15 @@ public static ChannelOptions withCipherKey(byte[] key) throws AblyException {
     public static ChannelOptions withCipherKey(String base64Key) throws AblyException {
         return withCipherKey(Base64Coder.decode(base64Key));
     }
+
+    /**
+     * Internal; returns cipher params or generate default
+     */
+    public synchronized CipherParams getCipherParamsOrDefault() throws AblyException {
+        CipherParams params = Crypto.checkCipherParams(this.cipherParams);
+        if (this.cipherParams == null) {
+            this.cipherParams = params;
+        }
+        return params;
+    }
 }
diff --git a/lib/src/main/java/io/ably/lib/util/Crypto.java b/lib/src/main/java/io/ably/lib/util/Crypto.java
@@ -212,18 +212,21 @@ public interface DecryptingChannelCipher {
     /**
      * Internal; get an encrypting cipher instance based on the given channel options.
      */
-    public static EncryptingChannelCipher createChannelEncipher(final Object cipherParams) throws AblyException {
-        return new EncryptingCBCCipher(checkCipherParams(cipherParams));
+    public static EncryptingChannelCipher createChannelEncipher(final CipherParams cipherParams) throws AblyException {
+        return new EncryptingCBCCipher(cipherParams);
     }
 
     /**
      * Internal; get a decrypting cipher instance based on the given channel options.
      */
-    public static DecryptingChannelCipher createChannelDecipher(final Object cipherParams) throws AblyException {
-        return new DecryptingCBCCipher(checkCipherParams(cipherParams));
+    public static DecryptingChannelCipher createChannelDecipher(final CipherParams cipherParams) throws AblyException {
+        return new DecryptingCBCCipher(cipherParams);
     }
 
-    private static CipherParams checkCipherParams(final Object cipherParams) throws AblyException {
+    /**
+     * Internal; if `cipherParams` is null returns default params otherwise check if params valid and returns them
+     */
+    public static CipherParams checkCipherParams(final Object cipherParams) throws AblyException {
         if (null == cipherParams) {
             return Crypto.getDefaultParams();
         } else if (cipherParams instanceof CipherParams) {

diff --git a/lib/src/test/java/io/ably/lib/test/realtime/RealtimeCryptoTest.java b/lib/src/test/java/io/ably/lib/test/realtime/RealtimeCryptoTest.java
@@ -121,7 +121,9 @@ public void single_send_256() {
             final CipherParams params = Crypto.getDefaultParams(key);
 
             /* create a channel */
-            ChannelOptions channelOpts = new ChannelOptions() {{ encrypted = true; this.cipherParams = params; }};
+            ChannelOptions channelOpts = new ChannelOptions();
+            channelOpts.encrypted = true;
+            channelOpts.cipherParams = params;
             final Channel channel = ably.channels.get(channelName, channelOpts);
 
             /* attach */
@@ -276,9 +278,16 @@ public void single_send_binary_text() {
             final CipherParams params = Crypto.getDefaultParams();
 
             /* create a channel */
-            final ChannelOptions senderChannelOpts = new ChannelOptions() {{ encrypted = true; cipherParams = params; }};
+            final ChannelOptions senderChannelOpts = new ChannelOptions();
+            senderChannelOpts.encrypted = true;
+            senderChannelOpts.cipherParams = params;
+
             final Channel senderChannel = sender.channels.get(channelName, senderChannelOpts);
-            final ChannelOptions receiverChannelOpts = new ChannelOptions() {{ encrypted = true; cipherParams = params; }};
+
+            final ChannelOptions receiverChannelOpts = new ChannelOptions();
+            receiverChannelOpts.encrypted = true;
+            receiverChannelOpts.cipherParams = params;
+
             final Channel receiverChannel = receiver.channels.get(channelName, receiverChannelOpts);
 
             /* attach */
@@ -570,9 +579,14 @@ public void set_cipher_params() {
             final CipherParams params1 = Crypto.getDefaultParams();
 
             /* create a channel */
-            ChannelOptions senderChannelOpts = new ChannelOptions() {{ encrypted = true; cipherParams = params1; }};
+            ChannelOptions senderChannelOpts = new ChannelOptions();
+            senderChannelOpts.encrypted = true;
+            senderChannelOpts.cipherParams = params1;
             final Channel senderChannel = sender.channels.get("set_cipher_params", senderChannelOpts);
-            ChannelOptions receiverChannelOpts = new ChannelOptions() {{ encrypted = true; cipherParams = params1; }};
+
+            ChannelOptions receiverChannelOpts = new ChannelOptions();
+            receiverChannelOpts.encrypted = true;
+            receiverChannelOpts.cipherParams = params1;
             final Channel receiverChannel = receiver.channels.get("set_cipher_params", receiverChannelOpts);
 
             /* attach */

diff --git a/lib/src/test/java/io/ably/lib/util/CryptoMessageTest.java b/lib/src/test/java/io/ably/lib/util/CryptoMessageTest.java
@@ -88,7 +88,9 @@ public void testDecrypt() throws NoSuchAlgorithmException, CloneNotSupportedExce
         final String algorithm = testData.algorithm;
 
         final CipherParams params = Crypto.getParams(algorithm, fixtureSet.key, fixtureSet.iv);
-        final ChannelOptions options = new ChannelOptions() {{encrypted = true; cipherParams = params;}};
+        final ChannelOptions options = new ChannelOptions();
+        options.encrypted = true;
+        options.cipherParams = params;
 
         for(final CryptoTestItem item : testData.items) {
             final Message plain = item.encoded;
@@ -116,7 +118,10 @@ public void testEncrypt() throws NoSuchAlgorithmException, CloneNotSupportedExce
         final CipherParams params = Crypto.getParams(algorithm, fixtureSet.key, fixtureSet.iv);
 
         for(final CryptoTestItem item : testData.items) {
-            final ChannelOptions options = new ChannelOptions() {{encrypted = true; cipherParams = params;}};
+            final ChannelOptions options = new ChannelOptions();
+            options.encrypted = true;
+            options.cipherParams = params;
+
             final Message plain = item.encoded;
             final Message encrypted = item.encrypted;
             assertThat(encrypted.encoding, endsWith(fixtureSet.cipherName + "/base64"));