Can read unencrypted history message when crypto is configured. (#153)

Co-authored-by: PubNub Release Bot <[email protected]>
Co-authored-by: Serhii Mamontov <[email protected]>

Author: 3 people

.pubnub.yml

@@ -1,9 +1,9 @@
 name: kotlin
-version: 7.7.1
+version: 7.7.2
 schema: 1
 scm: github.com/pubnub/kotlin
 files:
-  - build/libs/pubnub-kotlin-7.7.1-all.jar
+  - build/libs/pubnub-kotlin-7.7.2-all.jar
 sdks:
   - 
       type: library
@@ -23,8 +23,8 @@ sdks:
             -
               distribution-type: library
               distribution-repository: maven
-              package-name: pubnub-kotlin-7.7.1
-              location: https://repo.maven.apache.org/maven2/com/pubnub/pubnub-kotlin/7.7.1/pubnub-kotlin-7.7.1.jar
+              package-name: pubnub-kotlin-7.7.2
+              location: https://repo.maven.apache.org/maven2/com/pubnub/pubnub-kotlin/7.7.2/pubnub-kotlin-7.7.2.jar
               supported-platforms:
                 supported-operating-systems:
                   Android:
@@ -114,6 +114,11 @@ sdks:
                   license-url: https://www.apache.org/licenses/LICENSE-2.0.txt
                   is-required: Required
 changelog:
+  - date: 2023-11-08
+    version: v7.7.2
+    changes:
+      - type: bug
+        text: "Fixed reading unencrypted history message when crypto is configured."
   - date: 2023-10-30
     version: v7.7.1
     changes:

CHANGELOG.md

@@ -1,3 +1,11 @@
+## v7.7.2
+November 08 2023
+
+#### Fixed
+- Fixed reading unencrypted history message when crypto is configured.
+
+
+
 ## v7.7.1
 October 30 2023
 

README.md

@@ -20,13 +20,13 @@ You will need the publish and subscribe keys to authenticate your app. Get your
      <dependency>
         <groupId>com.pubnub</groupId>
         <artifactId>pubnub-kotlin</artifactId>
-        <version>7.7.1</version>
+        <version>7.7.2</version>
      </dependency>
      ```
 
    * for Gradle, add the following dependency in your `gradle.build`:
      ```groovy
-     implementation 'com.pubnub:pubnub-kotlin:7.7.1'
+     implementation 'com.pubnub:pubnub-kotlin:7.7.2'
      ```
 
 2. Configure your keys:

gradle.properties

@@ -21,7 +21,7 @@ SONATYPE_HOST=DEFAULT
 SONATYPE_AUTOMATIC_RELEASE=true
 GROUP=com.pubnub
 POM_ARTIFACT_ID=pubnub-kotlin
-VERSION_NAME=7.7.1
+VERSION_NAME=7.7.2
 POM_PACKAGING=jar
 
 POM_NAME=PubNub Kotlin SDK

src/integrationTest/kotlin/com/pubnub/api/integration/HistoryIntegrationTest.kt

@@ -5,6 +5,9 @@ import com.google.gson.JsonPrimitive
 import com.pubnub.api.CommonUtils
 import com.pubnub.api.CommonUtils.emoji
 import com.pubnub.api.CommonUtils.randomChannel
+import com.pubnub.api.PubNub
+import com.pubnub.api.PubNubError
+import com.pubnub.api.crypto.CryptoModule
 import com.pubnub.api.models.consumer.history.Action
 import com.pubnub.api.models.consumer.history.HistoryMessageType
 import com.pubnub.api.models.consumer.history.PNFetchMessageItem
@@ -61,6 +64,56 @@ class HistoryIntegrationTest : BaseIntegrationTest() {
         assertEquals(expectedHistoryResultChannels, historyResult?.messages)
     }
 
+    @Test
+    fun `when reading unencrypted message from history using pubNub with configured encryption should log error and return error in response and return unencrypted message`() {
+        val pnConfigurationWithCrypto = getBasicPnConfiguration()
+        val cipherKey = "enigma"
+        pnConfigurationWithCrypto.cryptoModule =
+            CryptoModule.createAesCbcCryptoModule(cipherKey = cipherKey, randomIv = false)
+        val pubNubWithCrypto = PubNub(pnConfigurationWithCrypto)
+
+        val channel = randomChannel()
+        val expectedMeta = JsonObject().also { it.add("thisIsMeta", JsonPrimitive("thisIsMetaValue")) }
+        val expectedMessage = "this is not encrypted message"
+
+        val result = pubnub.publish(
+            channel = channel,
+            message = expectedMessage,
+            meta = expectedMeta,
+            shouldStore = true,
+            ttl = 60
+        ).sync()!!
+
+        var historyResult: PNHistoryResult? = null
+
+        await
+            .pollInterval(Duration.ofMillis(1_000))
+            .pollDelay(Duration.ofMillis(1_000))
+            .atMost(Duration.ofMillis(10_000))
+            .untilAsserted {
+                historyResult = pubNubWithCrypto.history(
+                    channel = channel,
+                    includeMeta = true,
+                    includeTimetoken = true,
+                ).sync()
+
+                assertNotNull(historyResult)
+                assertThat(historyResult?.messages, hasSize(not(0)))
+            }
+
+        val expectedHistoryResultChannels =
+            listOf(
+                PNHistoryItemResult(
+                    entry = JsonPrimitive(expectedMessage),
+                    timetoken = result.timetoken,
+                    meta = expectedMeta,
+                    error = PubNubError.CRYPTO_IS_CONFIGURED_BUT_MESSAGE_IS_NOT_ENCRYPTED
+                )
+            )
+
+        assertEquals(expectedHistoryResultChannels, historyResult?.messages)
+    }
+
     @Test
     fun fetchMessagesSingleScenario() {
         val channel = randomChannel()
@@ -150,6 +203,65 @@ class HistoryIntegrationTest : BaseIntegrationTest() {
         )
     }
 
+    @Test
+    fun `when fetching unencrypted message using pubNub with configured encryption should log error and return error in respone and return unencrypted message`() {
+        val pnConfigurationWithCrypto = getBasicPnConfiguration()
+        val cipherKey = "enigma"
+        pnConfigurationWithCrypto.cryptoModule =
+            CryptoModule.createLegacyCryptoModule(cipherKey = cipherKey, randomIv = true)
+        val pubNubWithCrypto = PubNub(pnConfigurationWithCrypto)
+
+        val channel = randomChannel()
+        val expectedMeta = JsonObject().also { it.add("thisIsMeta", JsonPrimitive("thisIsMetaValue")) }
+        val expectedMessage = CommonUtils.generatePayload()
+
+        val result = pubnub.publish(
+            channel = channel,
+            message = expectedMessage,
+            meta = expectedMeta,
+            shouldStore = true,
+            ttl = 60
+        ).sync()!!
+
+        var fetchResult: PNFetchMessagesResult? = null
+
+        await
+            .pollInterval(Duration.ofMillis(1_000))
+            .pollDelay(Duration.ofMillis(1_000))
+            .atMost(Duration.ofMillis(10_000))
+            .untilAsserted {
+                fetchResult = pubNubWithCrypto.fetchMessages(
+                    includeMeta = true,
+                    includeMessageActions = true,
+                    includeMessageType = true,
+                    includeUUID = true,
+                    channels = listOf(channel)
+                ).sync()
+                assertNotNull(fetchResult)
+                assertThat(fetchResult?.channels, aMapWithSize(not(0)))
+            }
+
+        val expectedItem = PNFetchMessageItem(
+            uuid = pubnub.configuration.userId.value,
+            message = expectedMessage,
+            timetoken = result.timetoken,
+            meta = expectedMeta,
+            messageType = HistoryMessageType.Message,
+            actions = emptyMap<String, Map<String, List<Action>>>(),
+            error = PubNubError.CRYPTO_IS_CONFIGURED_BUT_MESSAGE_IS_NOT_ENCRYPTED
+        )
+
+        val expectedChannelsResponse: Map<String, List<PNFetchMessageItem>> =
+            mapOf(
+                channel to listOf(
+                    expectedItem
+                )
+            )
+
+        val fetchMessageItem = fetchResult!!
+        assertEquals(expectedChannelsResponse, fetchMessageItem.channels)
+    }
+
     @Test
     fun always() {
         assertEquals(

src/main/kotlin/com/pubnub/api/PubNub.kt

@@ -106,7 +106,7 @@ class PubNub internal constructor(
 
     companion object {
         private const val TIMESTAMP_DIVIDER = 1000
-        private const val SDK_VERSION = "7.7.1"
+        private const val SDK_VERSION = "7.7.2"
         private const val MAX_SEQUENCE = 65535
 
         /**

src/main/kotlin/com/pubnub/api/PubNubError.kt

@@ -226,6 +226,11 @@ enum class PubNubError(private val code: Int, val message: String) {
         "Encryption of empty data not allowed."
     ),
 
+    CRYPTO_IS_CONFIGURED_BUT_MESSAGE_IS_NOT_ENCRYPTED(
+        177,
+        "Crypto is configured but message is not encrypted."
+    ),
+
     ;
 
     override fun toString(): String {

src/main/kotlin/com/pubnub/api/endpoints/FetchMessages.kt

@@ -82,7 +82,10 @@ class FetchMessages internal constructor(
         val body = input.body()!!
         val channelsMap = body.channels.mapValues { (_, value) ->
             value.map { serverMessageItem ->
-                val newMessage = serverMessageItem.message.processHistoryMessage(pubnub.cryptoModule, pubnub.mapper)
+                val (newMessage, error) = serverMessageItem.message.processHistoryMessage(
+                    pubnub.cryptoModule,
+                    pubnub.mapper
+                )
                 val newActions =
                     if (includeMessageActions) serverMessageItem.actions ?: mapOf() else serverMessageItem.actions
                 PNFetchMessageItem(
@@ -92,6 +95,7 @@ class FetchMessages internal constructor(
                     timetoken = serverMessageItem.timetoken,
                     actions = newActions,
                     messageType = if (includeMessageType) HistoryMessageType.of(serverMessageItem.messageType) else null,
+                    error = error
                 )
             }
         }.toMap()

src/main/kotlin/com/pubnub/api/endpoints/History.kt

@@ -71,26 +71,30 @@ class History internal constructor(
 
                 val historyEntry = iterator.next()
 
-                var message: JsonElement
                 var timetoken: Long? = null
                 var meta: JsonElement? = null
+                val historyMessageWithError: Pair<JsonElement, PubNubError?>
 
                 if (includeTimetoken || includeMeta) {
-                    message = pubnub.mapper.getField(historyEntry, "message")!!.processHistoryMessage(pubnub.cryptoModule, pubnub.mapper)
+                    historyMessageWithError = pubnub.mapper.getField(historyEntry, "message")!!.processHistoryMessage(pubnub.cryptoModule, pubnub.mapper)
                     if (includeTimetoken) {
                         timetoken = pubnub.mapper.elementToLong(historyEntry, "timetoken")
                     }
                     if (includeMeta) {
                         meta = pubnub.mapper.getField(historyEntry, "meta")
                     }
                 } else {
-                    message = historyEntry.processHistoryMessage(pubnub.cryptoModule, pubnub.mapper)
+                    historyMessageWithError = historyEntry.processHistoryMessage(pubnub.cryptoModule, pubnub.mapper)
                 }
 
+                val message: JsonElement = historyMessageWithError.first
+                val error: PubNubError? = historyMessageWithError.second
+
                 val historyItem = PNHistoryItemResult(
                     entry = message,
                     timetoken = timetoken,
-                    meta = meta
+                    meta = meta,
+                    error = error
                 )
 
                 messages.add(historyItem)

src/main/kotlin/com/pubnub/api/models/consumer/history/PNFetchMessage.kt

@@ -2,6 +2,7 @@ package com.pubnub.api.models.consumer.history
 
 import com.google.gson.JsonElement
 import com.pubnub.api.PubNub
+import com.pubnub.api.PubNubError
 import com.pubnub.api.endpoints.FetchMessages
 import com.pubnub.api.models.consumer.PNBoundedPage
 
@@ -28,17 +29,20 @@ data class PNFetchMessagesResult(
  * The key of the map is the action type. The value is another map,
  * which key is the actual value of the message action,
  * and the key being a list of actions, ie. a list of UUIDs which have posted such a message action.
- * @property messageType The message type associated with the item.
- *
  * @see [Action]
+ * @property messageType The message type associated with the item.
+ * @property error The error associated with message retrieval, if any.
+ * e.g. a message is unencrypted but PubNub instance is configured with the Crypto
+ * so PubNub can't decrypt the unencrypted message and return the message.
  */
 data class PNFetchMessageItem(
     val uuid: String?,
     val message: JsonElement,
     val meta: JsonElement?,
     val timetoken: Long,
     val actions: Map<String, Map<String, List<Action>>>? = null,
-    val messageType: HistoryMessageType?
+    val messageType: HistoryMessageType?,
+    val error: PubNubError? = null
 )
 
 /**

src/main/kotlin/com/pubnub/api/models/consumer/history/PNHistoryResult.kt

@@ -2,6 +2,7 @@ package com.pubnub.api.models.consumer.history
 
 import com.google.gson.JsonElement
 import com.pubnub.api.PubNub
+import com.pubnub.api.PubNubError
 import com.pubnub.api.endpoints.History
 
 /**
@@ -24,9 +25,13 @@ class PNHistoryResult internal constructor(
  * @property timetoken Publish timetoken of the message, if requested via [History.includeTimetoken]
  * @property meta Metadata of the message, if requested via [History.includeMeta].
  * Is `null` if not requested, otherwise an empty string if requested but no associated metadata.
+ * @property error The error associated with message retrieval, if any.
+ * e.g. a message is unencrypted but PubNub instance is configured with the Crypto
+ * so PubNub can't decrypt the unencrypted message and return the message.
  */
 data class PNHistoryItemResult(
     val entry: JsonElement,
     val timetoken: Long? = null,
-    val meta: JsonElement? = null
+    val meta: JsonElement? = null,
+    val error: PubNubError? = null
 )