Skip to content

Commit

Permalink
Returning the original message in case of decryption failure (#151)
Browse files Browse the repository at this point in the history 
fix(crypto): handle unencrypted message while getting it with CryptoModule configured
  • Loading branch information
@jguz-pubnub
jguz-pubnub authored Nov 28, 2023
1 parent 6980f9f commit b47b478
Show file tree
Hide file tree
Showing 10 changed files with 267 additions and 39 deletions.
9 changes: 7 additions & 2 deletions .pubnub.yml
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
---
name: swift
scm: github.com/pubnub/swift
version: "6.2.2"
version: "6.2.3"
schema: 1
changelog:
- date: 2023-11-28
version: 6.2.3
changes:
- type: bug
text: "Handle unencrypted message while getting it with CryptoModule configured."
- date: 2023-10-30
version: 6.2.2
changes:
Expand Down Expand Up @@ -507,7 +512,7 @@ sdks:
- distribution-type: source
distribution-repository: GitHub release
package-name: PubNub
location: https://github.com/pubnub/swift/archive/refs/tags/6.2.2.zip
location: https://github.com/pubnub/swift/archive/refs/tags/6.2.3.zip
supported-platforms:
supported-operating-systems:
macOS:
Expand Down
20 changes: 12 additions & 8 deletions PubNub.xcodeproj/project.pbxproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,7 @@
3DACC7F72AB88F8E00210B14 /* Data+CommonCrypto.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3DACC7F62AB88F8E00210B14 /* Data+CommonCrypto.swift */; };
3DBB2C212ABD8053008A100E /* PubNubCryptoModuleContractTestSteps.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3DBB2C202ABD8053008A100E /* PubNubCryptoModuleContractTestSteps.swift */; };
3DBB2C222ABD8053008A100E /* PubNubCryptoModuleContractTestSteps.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3DBB2C202ABD8053008A100E /* PubNubCryptoModuleContractTestSteps.swift */; };
3DFB01942B0E30EE00146B57 /* subscription_encrypted_message_success.json in Resources */ = {isa = PBXBuildFile; fileRef = 3DFB01932B0E30EE00146B57 /* subscription_encrypted_message_success.json */; };
4C2A8D84BCD39B07A66FD9B4 /* Pods_PubNubContractTests.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 1E7F3D449F2D66FC29674EF6 /* Pods_PubNubContractTests.framework */; };
79407BD2271D4CFA0032076C /* PubNubContractTestCase.swift in Sources */ = {isa = PBXBuildFile; fileRef = 79407BBF271D4CFA0032076C /* PubNubContractTestCase.swift */; };
79407BD3271D4CFA0032076C /* PubNubContractTestCase.swift in Sources */ = {isa = PBXBuildFile; fileRef = 79407BBF271D4CFA0032076C /* PubNubContractTestCase.swift */; };
Expand Down Expand Up @@ -924,6 +925,7 @@
3DACC7F62AB88F8E00210B14 /* Data+CommonCrypto.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Data+CommonCrypto.swift"; sourceTree = "<group>"; };
3DBB2C202ABD8053008A100E /* PubNubCryptoModuleContractTestSteps.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = PubNubCryptoModuleContractTestSteps.swift; sourceTree = "<group>"; };
3DE632651BA8B2E27ACFC4AD /* Pods-PubNubContractTestsBeta.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-PubNubContractTestsBeta.release.xcconfig"; path = "Target Support Files/Pods-PubNubContractTestsBeta/Pods-PubNubContractTestsBeta.release.xcconfig"; sourceTree = "<group>"; };
3DFB01932B0E30EE00146B57 /* subscription_encrypted_message_success.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = subscription_encrypted_message_success.json; sourceTree = "<group>"; };
793079152667C63700F23B72 /* CODEOWNERS */ = {isa = PBXFileReference; lastKnownFileType = text; path = CODEOWNERS; sourceTree = "<group>"; };
793079172667C63700F23B72 /* validate-yml.js */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.javascript; path = "validate-yml.js"; sourceTree = "<group>"; };
793079182667C63700F23B72 /* validate-pubnub-yml.yml */ = {isa = PBXFileReference; lastKnownFileType = text.yaml; path = "validate-pubnub-yml.yml"; sourceTree = "<group>"; };
Expand Down Expand Up @@ -1320,6 +1322,7 @@
isa = PBXGroup;
children = (
359287C423185EEE0046F7A2 /* subscription_success.json */,
3DFB01932B0E30EE00146B57 /* subscription_encrypted_message_success.json */,
35C6B6DF22F513D80054F242 /* subscription_mixed_success.json */,
359287BE23183DBB0046F7A2 /* subscription_signal_success.json */,
359287C023183E4A0046F7A2 /* subscription_presence_success.json */,
Expand Down Expand Up @@ -2637,6 +2640,7 @@
35FE941422EFB7C10051C455 /* unknownEndpointError.json in Resources */,
35FE93F122EF93A90051C455 /* serverCertificateUntrusted.json in Resources */,
35A6C79A22FBC2AD00E97CC5 /* groups_delete_success.json in Resources */,
3DFB01942B0E30EE00146B57 /* subscription_encrypted_message_success.json in Resources */,
35293A872369F0230049A71F /* addMessageAction_error_400.json in Resources */,
35FE93F622EF93A90051C455 /* cannotParseResponse.json in Resources */,
35A6C79C22FBC2D100E97CC5 /* groups_channels_add_success.json in Resources */,
Expand Down Expand Up @@ -3436,7 +3440,7 @@
"@executable_path/Frameworks",
"@loader_path/Frameworks",
);
MARKETING_VERSION = 6.2.2;
MARKETING_VERSION = 6.2.3;
MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE;
MTL_FAST_MATH = YES;
PRODUCT_BUNDLE_IDENTIFIER = com.pubnub.swift.PubNubUser;
Expand Down Expand Up @@ -3483,7 +3487,7 @@
"@executable_path/Frameworks",
"@loader_path/Frameworks",
);
MARKETING_VERSION = 6.2.2;
MARKETING_VERSION = 6.2.3;
MTL_ENABLE_DEBUG_INFO = NO;
MTL_FAST_MATH = YES;
PRODUCT_BUNDLE_IDENTIFIER = com.pubnub.swift.PubNubUser;
Expand Down Expand Up @@ -3583,7 +3587,7 @@
"@executable_path/Frameworks",
"@loader_path/Frameworks",
);
MARKETING_VERSION = 6.2.2;
MARKETING_VERSION = 6.2.3;
MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE;
MTL_FAST_MATH = YES;
PRODUCT_BUNDLE_IDENTIFIER = com.pubnub.swift.PubNubSpace;
Expand Down Expand Up @@ -3632,7 +3636,7 @@
"@executable_path/Frameworks",
"@loader_path/Frameworks",
);
MARKETING_VERSION = 6.2.2;
MARKETING_VERSION = 6.2.3;
MTL_ENABLE_DEBUG_INFO = NO;
MTL_FAST_MATH = YES;
PRODUCT_BUNDLE_IDENTIFIER = com.pubnub.swift.PubNubSpace;
Expand Down Expand Up @@ -3745,7 +3749,7 @@
"@executable_path/Frameworks",
"@loader_path/Frameworks",
);
MARKETING_VERSION = 6.2.2;
MARKETING_VERSION = 6.2.3;
MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE;
MTL_FAST_MATH = YES;
PRODUCT_BUNDLE_IDENTIFIER = com.pubnub.swift.PubNubMembership;
Expand Down Expand Up @@ -3793,7 +3797,7 @@
"@executable_path/Frameworks",
"@loader_path/Frameworks",
);
MARKETING_VERSION = 6.2.2;
MARKETING_VERSION = 6.2.3;
MTL_ENABLE_DEBUG_INFO = NO;
MTL_FAST_MATH = YES;
PRODUCT_BUNDLE_IDENTIFIER = com.pubnub.swift.PubNubMembership;
Expand Down Expand Up @@ -4253,7 +4257,7 @@
"$(inherited)",
"$(TOOLCHAIN_DIR)/usr/lib/swift/macosx",
);
MARKETING_VERSION = 6.2.2;
MARKETING_VERSION = 6.2.3;
OTHER_CFLAGS = "$(inherited)";
OTHER_LDFLAGS = "$(inherited)";
OTHER_SWIFT_FLAGS = "$(inherited)";
Expand Down Expand Up @@ -4292,7 +4296,7 @@
"$(inherited)",
"$(TOOLCHAIN_DIR)/usr/lib/swift/macosx",
);
MARKETING_VERSION = 6.2.2;
MARKETING_VERSION = 6.2.3;
OTHER_CFLAGS = "$(inherited)";
OTHER_LDFLAGS = "$(inherited)";
OTHER_SWIFT_FLAGS = "$(inherited)";
Expand Down
2 changes: 1 addition & 1 deletion PubNubSwift.podspec
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'PubNubSwift'
s.version = '6.2.2'
s.version = '6.2.3'
s.homepage = 'https://github.com/pubnub/swift'
s.documentation_url = 'https://www.pubnub.com/docs/swift-native/pubnub-swift-sdk'
s.authors = { 'PubNub, Inc.' => '[email protected]' }
Expand Down
2 changes: 1 addition & 1 deletion Sources/PubNub/Helpers/Constants.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public enum Constant {

static let pubnubSwiftSDKName: String = "PubNubSwift"

static let pubnubSwiftSDKVersion: String = "6.2.2"
static let pubnubSwiftSDKVersion: String = "6.2.3"

static let appBundleId: String = {
if let info = Bundle.main.infoDictionary,
Expand Down
71 changes: 58 additions & 13 deletions Sources/PubNub/Models/PubNubMessage.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ public protocol PubNubMessage {
var metadata: JSONCodable? { get set }
/// The type of message that was received
var messageType: PubNubMessageType { get set }

/// An error (if any) occured while getting this message
var error: PubNubError? { get set }

/// Allows for transcoding between different MessageEvent types
init(from other: PubNubMessage) throws
}
Expand Down Expand Up @@ -69,16 +71,17 @@ public extension PubNubMessage {

/// The default implementation of the `PubNubMessage` protocol
public struct PubNubMessageBase: PubNubMessage, Codable, Hashable {
var concretePayload: AnyJSON
public var publisher: String?
var concreteMessageActions: [PubNubMessageActionBase]
public var channel: String
public var subscription: String?
public var published: Timetoken
var concreteMetadata: AnyJSON?

public var messageType: PubNubMessageType

public var error: PubNubError?

var concretePayload: AnyJSON
var concreteMessageActions: [PubNubMessageActionBase]
var concreteMetadata: AnyJSON?

public var payload: JSONCodable {
get { return concretePayload }
set {
Expand Down Expand Up @@ -109,7 +112,8 @@ public struct PubNubMessageBase: PubNubMessage, Codable, Hashable {
subscription: other.subscription,
published: other.published,
metadata: other.metadata?.codableValue,
messageType: other.messageType
messageType: other.messageType,
error: other.error
)
}

Expand All @@ -122,7 +126,8 @@ public struct PubNubMessageBase: PubNubMessage, Codable, Hashable {
subscription: subscribe.subscription,
published: subscribe.publishTimetoken.timetoken,
metadata: subscribe.metadata,
messageType: subscribe.messageType.asPubNubMessageType
messageType: subscribe.messageType.asPubNubMessageType,
error: subscribe.error
)
}

Expand All @@ -141,7 +146,8 @@ public struct PubNubMessageBase: PubNubMessage, Codable, Hashable {
subscription: nil,
published: history.timetoken,
metadata: history.meta,
messageType: history.messageType ?? .unknown
messageType: history.messageType ?? .unknown,
error: history.error
)
}

Expand All @@ -153,16 +159,55 @@ public struct PubNubMessageBase: PubNubMessage, Codable, Hashable {
subscription: String?,
published: Timetoken,
metadata: AnyJSON?,
messageType: PubNubMessageType = .unknown
messageType: PubNubMessageType = .unknown,
error: PubNubError? = nil
) {
concretePayload = payload
concreteMessageActions = actions
self.concretePayload = payload
self.concreteMessageActions = actions
self.publisher = publisher
self.channel = channel
self.subscription = subscription
self.published = published
concreteMetadata = metadata
self.concreteMetadata = metadata
self.messageType = messageType
self.error = error
}

public func encode(to encoder: Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)

try container.encode(self.concretePayload, forKey: .concretePayload)
try container.encodeIfPresent(self.publisher, forKey: .publisher)
try container.encode(self.concreteMessageActions, forKey: .concreteMessageActions)
try container.encode(self.channel, forKey: .channel)
try container.encodeIfPresent(self.subscription, forKey: .subscription)
try container.encode(self.published, forKey: .published)
try container.encodeIfPresent(self.concreteMetadata, forKey: .concreteMetadata)
try container.encode(self.messageType, forKey: .messageType)
}

enum CodingKeys: CodingKey {
case concretePayload
case publisher
case concreteMessageActions
case channel
case subscription
case published
case concreteMetadata
case messageType
}

public init(from decoder: Decoder) throws {
let container = try decoder.container(keyedBy: CodingKeys.self)

self.concretePayload = try container.decode(AnyJSON.self, forKey: .concretePayload)
self.publisher = try container.decodeIfPresent(String.self, forKey: .publisher)
self.concreteMessageActions = try container.decode([PubNubMessageActionBase].self, forKey: .concreteMessageActions)
self.channel = try container.decode(String.self, forKey: .channel)
self.subscription = try container.decodeIfPresent(String.self, forKey: .subscription)
self.published = try container.decode(Timetoken.self, forKey: .published)
self.concreteMetadata = try container.decodeIfPresent(AnyJSON.self, forKey: .concreteMetadata)
self.messageType = try container.decode(PubNubMessageType.self, forKey: .messageType)
}
}

Expand Down
33 changes: 30 additions & 3 deletions Sources/PubNub/Networking/Routers/HistoryRouter.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,13 +190,36 @@ struct MessageHistoryResponseDecoder: ResponseDecoder {
timetoken: message.timetoken,
meta: message.meta,
uuid: message.uuid,
messageType: message.messageType
messageType: message.messageType,
error: nil
)
case .failure(let error):
PubNub.log.error("History message failed to decrypt due to \(error)")
messages[index] = MessageHistoryMessagePayload(
message: message.message,
timetoken: message.timetoken,
meta: message.meta,
uuid: message.uuid,
messageType: message.messageType,
error: error
)
PubNub.log.warn("History message failed to decrypt due to \(error)")
}
} else {
messages[index] = MessageHistoryMessagePayload(
message: message.message,
timetoken: message.timetoken,
meta: message.meta,
uuid: message.uuid,
messageType: message.messageType,
error: PubNubError(
.decryptionFailure,
additional: ["Cannot decrypt message due to invalid Base-64 input"]
)
)
}
}


return messages
}

Expand Down Expand Up @@ -284,21 +307,24 @@ struct MessageHistoryMessagePayload: Codable {
let uuid: String?
let messageType: PubNubMessageType?
let actions: RawMessageAction
let error: PubNubError?

init(
message: JSONCodable,
timetoken: Timetoken = 0,
meta: JSONCodable? = nil,
uuid: String?,
messageType: PubNubMessageType?,
actions: RawMessageAction = [:]
actions: RawMessageAction = [:],
error: PubNubError?
) {
self.message = message.codableValue
self.timetoken = timetoken
self.uuid = uuid
self.messageType = messageType
self.meta = meta?.codableValue
self.actions = actions
self.error = error
}

enum CodingKeys: String, CodingKey {
Expand All @@ -319,6 +345,7 @@ struct MessageHistoryMessagePayload: Codable {
messageType = try container.decodeIfPresent(PubNubMessageType.self, forKey: .messageType)
timetoken = Timetoken(try container.decode(String.self, forKey: .timetoken)) ?? 0
actions = try container.decodeIfPresent(RawMessageAction.self, forKey: .actions) ?? [:]
error = nil
}

public func encode(to encoder: Encoder) throws {
Expand Down
Loading

0 comments on commit b47b478

Please sign in to comment.