Merge pull request #919 from BranchMetrics/INTENG-6187-bad-access-crash-

INTENG-6187 bad access crash

Author: echo-branch

Branch-SDK/Branch-SDK/BNCEncodingUtils.m

@@ -164,6 +164,13 @@ + (NSData *)encodeDictionaryToJsonData:(NSDictionary *)dictionary {
 + (NSString *)encodeDictionaryToJsonString:(NSDictionary *)dictionary {
     NSMutableString *encodedDictionary = [[NSMutableString alloc] initWithString:@"{"];
     for (NSString *key in dictionary) {
+        
+        // protect against non-string keys
+        if (![key isKindOfClass:[NSString class]]) {
+            BNCLogError(@"Unexpected key type %@. Skipping key.", [key class]);
+            continue;
+        }
+        
         NSString *value = nil;
         BOOL string = YES;
 

Branch-TestBed/Branch-SDK-Unhosted-Tests/BNCEncodingUtilsTests.m

@@ -0,0 +1,52 @@
+//
+//  BNCEncodingUtilsTests.m
+//  Branch-SDK-Unhosted-Tests
+//
+//  Created by Ernest Cho on 5/17/19.
+//  Copyright © 2019 Branch, Inc. All rights reserved.
+//
+
+#import <XCTest/XCTest.h>
+#import "BNCEncodingUtils.h"
+
+@interface BNCEncodingUtilsTests : XCTestCase
+
+@end
+
+@implementation BNCEncodingUtilsTests
+
+- (void)setUp {
+    // Put setup code here. This method is called before the invocation of each test method in the class.
+}
+
+- (void)tearDown {
+    // Put teardown code here. This method is called after the invocation of each test method in the class.
+}
+
+- (void) testSanitzeString {
+    NSString*test  = @"\b\f\n\r\t\"`\\";
+    NSString*truth = @"\\b\\f\\n\\r\\t\\\"'\\\\";
+    NSString*result = [BNCEncodingUtils sanitizedStringFromString:test];
+    XCTAssertEqualObjects(result, truth);
+}
+
+- (void)testSanitizeStringWithNil {
+    NSString *result = [BNCEncodingUtils sanitizedStringFromString:nil];
+    XCTAssertNil(result);
+}
+
+// INTENG-6187 bad access crash
+- (void)testEncodeDictionaryToJsonStringCrashTest {
+    NSString *expectedString = @"{\"World\":\"Hello\"}";
+    
+    // untyped collection
+    NSMutableDictionary *params = [[NSMutableDictionary alloc] init];
+    [params setValue:@"Hello" forKey:@"World"];
+    [params setObject:@"Goodbye" forKey:@(100)];
+    
+    // encodeDictionaryToJsonString should ignore non-string keys
+    NSString *result = [BNCEncodingUtils encodeDictionaryToJsonString:params];
+    XCTAssertTrue([expectedString isEqualToString:result]);
+}
+
+@end

Branch-TestBed/Branch-TestBed.xcodeproj/project.pbxproj

@@ -166,6 +166,7 @@
 		54391A161BA249FA0061CB0F /* BranchCSSearchableItemAttributeSet.m in Sources */ = {isa = PBXBuildFile; fileRef = 54391A141BA249FA0061CB0F /* BranchCSSearchableItemAttributeSet.m */; };
 		54FF1F8E1BD1D4AE0004CE2E /* BranchUniversalObject.m in Sources */ = {isa = PBXBuildFile; fileRef = 54FF1F8C1BD1D4AE0004CE2E /* BranchUniversalObject.m */; };
 		54FF1F921BD1DC320004CE2E /* BranchLinkProperties.m in Sources */ = {isa = PBXBuildFile; fileRef = 54FF1F901BD1DC320004CE2E /* BranchLinkProperties.m */; };
+		5F67F48E228F535500067429 /* BNCEncodingUtilsTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 5F67F48D228F535500067429 /* BNCEncodingUtilsTests.m */; };
 		5F8B7B4021B5F5CD009CE0A6 /* libBranch.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 466B58381B17773000A69EDE /* libBranch.a */; };
 		5F8B7B4721B5F5F0009CE0A6 /* Branch_setBranchKeyTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 5F8B7B4621B5F5F0009CE0A6 /* Branch_setBranchKeyTests.m */; };
 		63E4C4881D25E16A00A45FD8 /* LogOutputViewController.m in Sources */ = {isa = PBXBuildFile; fileRef = 63E4C4871D25E16A00A45FD8 /* LogOutputViewController.m */; };
@@ -388,6 +389,7 @@
 		54FF1F8C1BD1D4AE0004CE2E /* BranchUniversalObject.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = BranchUniversalObject.m; sourceTree = "<group>"; };
 		54FF1F8F1BD1DC320004CE2E /* BranchLinkProperties.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = BranchLinkProperties.h; sourceTree = "<group>"; };
 		54FF1F901BD1DC320004CE2E /* BranchLinkProperties.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = BranchLinkProperties.m; sourceTree = "<group>"; };
+		5F67F48D228F535500067429 /* BNCEncodingUtilsTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BNCEncodingUtilsTests.m; sourceTree = "<group>"; };
 		5F8B7B3B21B5F5CD009CE0A6 /* Branch-SDK-Unhosted-Tests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = "Branch-SDK-Unhosted-Tests.xctest"; sourceTree = BUILT_PRODUCTS_DIR; };
 		5F8B7B3F21B5F5CD009CE0A6 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		5F8B7B4621B5F5F0009CE0A6 /* Branch_setBranchKeyTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = Branch_setBranchKeyTests.m; sourceTree = "<group>"; };
@@ -647,6 +649,7 @@
 		5F8B7B3C21B5F5CD009CE0A6 /* Branch-SDK-Unhosted-Tests */ = {
 			isa = PBXGroup;
 			children = (
+				5F67F48D228F535500067429 /* BNCEncodingUtilsTests.m */,
 				5F8B7B4621B5F5F0009CE0A6 /* Branch_setBranchKeyTests.m */,
 				5F8B7B3F21B5F5CD009CE0A6 /* Info.plist */,
 			);
@@ -1066,6 +1069,7 @@
 			developmentRegion = English;
 			hasScannedForEncodings = 0;
 			knownRegions = (
+				English,
 				en,
 				Base,
 			);
@@ -1212,6 +1216,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				5F67F48E228F535500067429 /* BNCEncodingUtilsTests.m in Sources */,
 				5F8B7B4721B5F5F0009CE0A6 /* Branch_setBranchKeyTests.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;