Skip to content

Commit

Permalink
Merge pull request #1194 from ably/fix/1188-NSSecureCoding
Browse files Browse the repository at this point in the history 
Fix/1188 Added allowed class for NSKeyedUnarchiver
  • Loading branch information
@maratal
maratal authored Nov 5, 2021
2 parents 902c112 + b263103 commit ea4c72e
Show file tree
Hide file tree
Showing 8 changed files with 55 additions and 13 deletions.
4 changes: 4 additions & 0 deletions Ably.xcodeproj/project.pbxproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
56190954238C3D3200A862A6 /* CryptoTest.m in Sources */ = {isa = PBXBuildFile; fileRef = 56190953238C3D3200A862A6 /* CryptoTest.m */; };
56190955238C3D3200A862A6 /* CryptoTest.m in Sources */ = {isa = PBXBuildFile; fileRef = 56190953238C3D3200A862A6 /* CryptoTest.m */; };
56190956238C3D3200A862A6 /* CryptoTest.m in Sources */ = {isa = PBXBuildFile; fileRef = 56190953238C3D3200A862A6 /* CryptoTest.m */; };
841134782722205400CFA837 /* ARTArchiveTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 841134772722205400CFA837 /* ARTArchiveTests.m */; };
8412FDE72661AC37001FE9E6 /* AblyDeltaCodec.xcframework in Frameworks */ = {isa = PBXBuildFile; fileRef = 8412FDE12661AC37001FE9E6 /* AblyDeltaCodec.xcframework */; };
8412FDED2661AC37001FE9E6 /* msgpack.xcframework in Frameworks */ = {isa = PBXBuildFile; fileRef = 8412FDE32661AC37001FE9E6 /* msgpack.xcframework */; };
8412FDF52661AC7B001FE9E6 /* Aspects.xcframework in Frameworks */ = {isa = PBXBuildFile; fileRef = 8412FDF12661AC7A001FE9E6 /* Aspects.xcframework */; };
Expand Down Expand Up @@ -1005,6 +1006,7 @@
217D182025421FED00DFF07E /* ARTSRSecurityPolicy.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = ARTSRSecurityPolicy.h; sourceTree = "<group>"; };
560579D824AF1BA900A4D03D /* ARTDefaultTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ARTDefaultTests.swift; sourceTree = "<group>"; };
56190953238C3D3200A862A6 /* CryptoTest.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = CryptoTest.m; sourceTree = "<group>"; };
841134772722205400CFA837 /* ARTArchiveTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = ARTArchiveTests.m; sourceTree = "<group>"; };
8412FDE12661AC37001FE9E6 /* AblyDeltaCodec.xcframework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.xcframework; name = AblyDeltaCodec.xcframework; path = Carthage/Build/AblyDeltaCodec.xcframework; sourceTree = "<group>"; };
8412FDE32661AC37001FE9E6 /* msgpack.xcframework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.xcframework; name = msgpack.xcframework; path = Carthage/Build/msgpack.xcframework; sourceTree = "<group>"; };
8412FDF12661AC7A001FE9E6 /* Aspects.xcframework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.xcframework; name = Aspects.xcframework; path = Carthage/Build/Aspects.xcframework; sourceTree = "<group>"; };
Expand Down Expand Up @@ -1471,6 +1473,7 @@
856AAC9A1B6E326E00B07119 /* ably-common */,
856AAC951B6E30C800B07119 /* AblySpec-Bridging-Header.h */,
D780846C1C68B3E50083009D /* NSObject+TestSuite.h */,
841134772722205400CFA837 /* ARTArchiveTests.m */,
56190953238C3D3200A862A6 /* CryptoTest.m */,
848ED97226E50D0F0087E800 /* ObjcppTest.mm */,
D780846D1C68B3E50083009D /* NSObject+TestSuite.m */,
Expand Down Expand Up @@ -2641,6 +2644,7 @@
D798554823EB96C000946BE2 /* DeltaCodec.swift in Sources */,
D74CBC0B212EC22800D090E4 /* RestPaginated.swift in Sources */,
D72304701BB72CED00F1ABDA /* RealtimeClient.swift in Sources */,
841134782722205400CFA837 /* ARTArchiveTests.m in Sources */,
D74A17B81FA0D9A3006D27B5 /* PushAdmin.swift in Sources */,
EB7913A81C6E54C3000ABF9B /* Crypto.swift in Sources */,
D777EEE820650ADF002EBA03 /* PushChannel.swift in Sources */,
Expand Down
2 changes: 1 addition & 1 deletion Source/ARTDeviceIdentityTokenDetails.m
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ - (NSData *)archive {
}

+ (ARTDeviceIdentityTokenDetails *)unarchive:(NSData *)data {
return [NSObject art_unarchive:data];
return [self art_unarchiveFromData:data];
}

@end
2 changes: 1 addition & 1 deletion Source/ARTPushActivationEvent.m
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ - (NSData *)archive {
}

+ (ARTPushActivationEvent *)unarchive:(NSData *)data {
return [NSObject art_unarchive:data];
return [self art_unarchiveFromData:data];
}

@end
Expand Down
2 changes: 1 addition & 1 deletion Source/ARTPushActivationState.m
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ - (NSData *)archive {
}

+ (ARTPushActivationState *)unarchive:(NSData *)data {
return [NSObject art_unarchive:data];
return [self art_unarchiveFromData:data];
}

@end
Expand Down
4 changes: 2 additions & 2 deletions Source/ARTPushActivationStateMachine.m
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ - (instancetype)initWithRest:(ARTRestInternal *const)rest
_userQueue = _rest.userQueue;
// Unarchiving
NSData *stateData = [rest.storage objectForKey:ARTPushActivationCurrentStateKey];
_current = [NSObject art_unarchive:stateData];
_current = [ARTPushActivationState art_unarchiveFromData:stateData];
if (!_current) {
_current = [[ARTPushActivationStateNotActivated alloc] initWithMachine:self];
} else {
Expand All @@ -45,7 +45,7 @@ - (instancetype)initWithRest:(ARTRestInternal *const)rest
_current.machine = self;
}
NSData *pendingEventsData = [rest.storage objectForKey:ARTPushActivationPendingEventsKey];
_pendingEvents = [NSObject art_unarchive:pendingEventsData];
_pendingEvents = [ARTPushActivationEvent art_unarchiveFromData:pendingEventsData];
if (!_pendingEvents) {
_pendingEvents = [NSMutableArray array];
}
Expand Down
2 changes: 1 addition & 1 deletion Source/ARTTypes.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ NSString *generateNonce(void);

@interface NSObject (ARTArchive)
- (nullable NSData *)art_archive;
+ (nullable id)art_unarchive:(NSData *)data;
+ (nullable id)art_unarchiveFromData:(NSData *)data;
@end

@interface NSURLSessionTask (ARTCancellable) <ARTCancellable>
Expand Down
15 changes: 8 additions & 7 deletions Source/ARTTypes.m
View file
Original file line number Diff line number Diff line change
Expand Up @@ -370,15 +370,15 @@ - (nullable NSData *)art_archive {
NSError *error;
NSData *data = [NSKeyedArchiver archivedDataWithRootObject:self requiringSecureCoding:false error:&error];
if (error) {
NSLog(@"ARTDeviceIdentityTokenDetails Archive failed: %@", error);
NSLog(@"%@ archive failed: %@", [self class], error);
}
return data;
#else
if (@available(macOS 10.13, iOS 11, tvOS 11, *)) {
NSError *error;
NSData *data = [NSKeyedArchiver archivedDataWithRootObject:self requiringSecureCoding:false error:&error];
if (error) {
NSLog(@"ARTDeviceIdentityTokenDetails Archive failed: %@", error);
NSLog(@"%@ archive failed: %@", [self class], error);
}
return data;
}
Expand All @@ -388,20 +388,21 @@ - (nullable NSData *)art_archive {
#endif
}

+ (nullable id)art_unarchive:(NSData *)data {
+ (nullable id)art_unarchiveFromData:(NSData *)data {
NSSet* allowedTypes = [NSSet setWithArray:@[ [NSArray class], [NSDictionary class], self]];
#if TARGET_OS_MACCATALYST
NSError *error;
id result = [NSKeyedUnarchiver unarchivedObjectOfClass:[self class] fromData:data error:&error];
id result = [NSKeyedUnarchiver unarchivedObjectOfClasses:allowedTypes fromData:data error:&error];
if (error) {
NSLog(@"ARTDeviceIdentityTokenDetails Unarchive failed: %@", error);
NSLog(@"%@ unarchive failed: %@", self, error);
}
return result;
#else
if (@available(macOS 10.13, iOS 11, tvOS 11, *)) {
NSError *error;
id result = [NSKeyedUnarchiver unarchivedObjectOfClass:[self class] fromData:data error:&error];
id result = [NSKeyedUnarchiver unarchivedObjectOfClasses:allowedTypes fromData:data error:&error];
if (error) {
NSLog(@"ARTDeviceIdentityTokenDetails Unarchive failed: %@", error);
NSLog(@"%@ unarchive failed: %@", self, error);
}
return result;
}
Expand Down
37 changes: 37 additions & 0 deletions Spec/ARTArchiveTests.m
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
@import XCTest;
#import <Ably/Ably.h>

@interface _StateMachineDelegate : NSObject <ARTPushRegistererDelegate>
@end

@implementation _StateMachineDelegate
- (void)didActivateAblyPush:(nullable ARTErrorInfo *)error { }
- (void)didDeactivateAblyPush:(nullable ARTErrorInfo *)error { }
@end

@interface ARTArchiveTests : XCTestCase
@end

@implementation ARTArchiveTests

- (void)test_art_unarchivedObjectOfClass_for_state_machine_states {

ARTRest* rest = [[ARTRest alloc] initWithKey:@"xxxx:xxxx"];
ARTPushActivationStateMachine* stateMachine = [[ARTPushActivationStateMachine alloc] initWithRest:rest.internal delegate:[[_StateMachineDelegate alloc] init]];

NSArray* initialStates = [NSMutableArray arrayWithArray:@[
[[ARTPushActivationStateNotActivated alloc] initWithMachine:stateMachine],
[[ARTPushActivationStateWaitingForPushDeviceDetails alloc] initWithMachine:stateMachine],
[[ARTPushActivationStateAfterRegistrationSyncFailed alloc] initWithMachine:stateMachine]
]];

NSData* data = [initialStates art_archive];

NSArray* unarchivedStates = [ARTPushActivationState art_unarchiveFromData:data];

XCTAssert([unarchivedStates[0] isKindOfClass:[ARTPushActivationStateNotActivated class]]);
XCTAssert([unarchivedStates[1] isKindOfClass:[ARTPushActivationStateWaitingForPushDeviceDetails class]]);
XCTAssert([unarchivedStates[2] isKindOfClass:[ARTPushActivationStateAfterRegistrationSyncFailed class]]);
}

@end

0 comments on commit ea4c72e

Please sign in to comment.