Return unencrypted data (#156)

refactor(crypto): return unencrypted data

Return source event data when a client configured with crypto is unable to decrypt it (can be not
encrypted data or encrypted with different options)

Author: parfeon

.pubnub.yml

@@ -1,6 +1,11 @@
 ---
-version: "5.3.1"
+version: "5.3.2"
 changelog:
+  - date: 2023-11-23
+    version: v5.3.2
+    changes:
+      - type: improvement
+        text: "Return source event data when a client configured with crypto is unable to decrypt it (can be not encrypted data or encrypted with different options)."
   - date: 2023-11-03
     version: v5.3.1
     changes:
@@ -675,7 +680,7 @@ sdks:
                     - x86-64
           - distribution-type: package
             distribution-repository: RubyGems
-            package-name: pubnub-5.3.1.gem
+            package-name: pubnub-5.3.2.gem
             location: https://rubygems.org/gems/pubnub
             requires:
               - name: addressable
@@ -780,8 +785,8 @@ sdks:
                     - x86-64
           - distribution-type: library
             distribution-repository: GitHub release
-            package-name: pubnub-5.3.1.gem
-            location: https://github.com/pubnub/ruby/releases/download/v5.3.1/pubnub-5.3.1.gem
+            package-name: pubnub-5.3.2.gem
+            location: https://github.com/pubnub/ruby/releases/download/v5.3.2/pubnub-5.3.2.gem
             requires:
               - name: addressable
                 min-version: 2.0.0

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v5.3.2
+November 23 2023
+
+#### Modified
+- Return source event data when a client configured with crypto is unable to decrypt it (can be not encrypted data or encrypted with different options).
+
 ## v5.3.1
 November 03 2023
 

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pubnub (5.3.1)
+    pubnub (5.3.2)
       addressable (>= 2.0.0)
       concurrent-ruby (~> 1.1.5)
       concurrent-ruby-edge (~> 0.5.0)

VERSION

@@ -1 +1 @@
-5.3.1
+5.3.2

fixtures/vcr_cassettes/examples/history/crypto_1.yml

@@ -68,30 +68,26 @@ def parameters(*_args)
 
     def decrypt_history(message, crypto)
       if @include_token || @include_meta
-        encrypted_message = Base64.decode64(message['message'])
+        encrypted_message = Base64.strict_decode64(message['message'])
         message['message'] = JSON.parse(crypto.decrypt(encrypted_message), quirks_mode: true)
-
         message
       else
-        encrypted_message = Base64.decode64(message)
+        encrypted_message = Base64.strict_decode64(message)
         JSON.parse(crypto.decrypt(encrypted_message), quirks_mode: true)
       end
+    rescue StandardError => e
+      puts "Pubnub :: DECRYPTION ERROR: #{e}"
+      message['decrypt_error'] = true if @include_token || @include_meta
+      message
     end
 
     def valid_envelope(parsed_response, req_res_objects)
       messages = parsed_response[0]
 
-      # TODO: Uncomment code below when cryptor implementations will be added.
       if crypto_module && messages
         crypto = crypto_module
         messages = messages.map { |message| decrypt_history(message, crypto) }
       end
-      # if (@cipher_key || @app.env[:cipher_key] || @cipher_key_selector || @app.env[:cipher_key_selector]) && messages
-      #   cipher_key = compute_cipher_key(parsed_response)
-      #   random_iv = compute_random_iv(parsed_response)
-      #   crypto = Crypto.new(cipher_key, random_iv)
-      #   messages = messages.map { |message| decrypt_history(message, crypto) }
-      # end
 
       start = parsed_response[1]
       finish = parsed_response[2]

fixtures/vcr_cassettes/examples/history/crypto_2.yml

@@ -41,7 +41,6 @@ def format_uuid(uuids, should_encode = true)
         end
       end
 
-      # TODO: Uncomment code below when cryptor implementations will be added.
       # Transforms message to json and encode it.
       #
       # @param message [Hash, String, Integer, Boolean] Message data which

fixtures/vcr_cassettes/examples/history/crypto_3.yml

@@ -33,10 +33,9 @@ def build_error_envelopes(_parsed_response, error, req_res_objects)
       end
 
       def decipher_payload(message)
-        # TODO: Uncomment code below when cryptor implementations will be added.
         return message[:payload] if message[:channel].end_with?('-pnpres') || crypto_module.nil?
 
-        encrypted_message = Base64.decode64(message[:payload])
+        encrypted_message = Base64.strict_decode64(message[:payload])
         JSON.parse(crypto_module.decrypt(encrypted_message), quirks_mode: true)
       rescue StandardError, UnknownCryptorError
         message[:payload]