feat: 🎉 ssl pinning [CS-36095]

uttamukkoji · uttamukkoji · commit 0c1e2346ff47 · 2023-03-28T09:54:37.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+### Version: 3.11.0
+#### Date: Apr-04-2023
+
+#####  Enahancement:
+- SSL pinning for CSURLSession using CSURLSessionDelegate 
+
 ### Version: 3.10.1
 #### Date: Nov-11-2022
 
diff --git a/Contentstack.podspec b/Contentstack.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
 s.name             = 'Contentstack'
-s.version          = '3.10.1'
+s.version          = '3.11.0'
 s.summary          = 'Contentstack is a headless CMS with an API-first approach that puts content at the centre.'
 
 s.description      = <<-DESC
@@ -12,7 +12,7 @@ s.homepage         = 'https://www.contentstack.com/'
 s.license          = { :type => 'Commercial',:text => 'See https://www.contentstack.com/'}
 s.author           = { 'Contentstack' => 'support@contentstack.io' }
 
-s.source           = { :git => 'https://github.com/contentstack/contentstack-ios.git', :tag => 'v3.10.1' }
+s.source           = { :git => 'https://github.com/contentstack/contentstack-ios.git', :tag => 'v3.11.0' }
 s.social_media_url = 'https://twitter.com/Contentstack'
 
 s.ios.deployment_target = '8.0'
diff --git a/Contentstack.xcodeproj/project.pbxproj b/Contentstack.xcodeproj/project.pbxproj
@@ -48,6 +48,7 @@
 		0F9C0FC6221ADAC90091205A /* SyncStack.h in Headers */ = {isa = PBXBuildFile; fileRef = 0F9C0FAD221ADAC90091205A /* SyncStack.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		0F9C0FC7221ADAC90091205A /* Entry.h in Headers */ = {isa = PBXBuildFile; fileRef = 0F9C0FAE221ADAC90091205A /* Entry.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		0F9C0FC8221ADAC90091205A /* NamespacedDependencies.h in Headers */ = {isa = PBXBuildFile; fileRef = 0F9C0FB0221ADAC90091205A /* NamespacedDependencies.h */; };
+		0FD6BAEF29CD6E73001A0930 /* CSURLSessionDelegate.h in Headers */ = {isa = PBXBuildFile; fileRef = 0FD6BAEE29CD6E73001A0930 /* CSURLSessionDelegate.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		0FEAEF282361A18600985FF9 /* CSNetworking.h in Headers */ = {isa = PBXBuildFile; fileRef = 0FEAEF232361A18600985FF9 /* CSNetworking.h */; };
 		0FEAEF292361A18600985FF9 /* CSError.h in Headers */ = {isa = PBXBuildFile; fileRef = 0FEAEF242361A18600985FF9 /* CSError.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		0FEAEF2A2361A18600985FF9 /* CSURLSessionManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 0FEAEF252361A18600985FF9 /* CSURLSessionManager.m */; };
@@ -166,6 +167,7 @@
 		0F9C0FAD221ADAC90091205A /* SyncStack.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SyncStack.h; sourceTree = "<group>"; };
 		0F9C0FAE221ADAC90091205A /* Entry.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = Entry.h; sourceTree = "<group>"; };
 		0F9C0FB0221ADAC90091205A /* NamespacedDependencies.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = NamespacedDependencies.h; sourceTree = "<group>"; };
+		0FD6BAEE29CD6E73001A0930 /* CSURLSessionDelegate.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = CSURLSessionDelegate.h; sourceTree = "<group>"; };
 		0FDC02D1254A9CFA005EDDE3 /* libContentstackUtils.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; path = libContentstackUtils.a; sourceTree = BUILT_PRODUCTS_DIR; };
 		0FEAEF232361A18600985FF9 /* CSNetworking.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = CSNetworking.h; sourceTree = "<group>"; };
 		0FEAEF242361A18600985FF9 /* CSError.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = CSError.h; sourceTree = "<group>"; };
@@ -307,6 +309,7 @@
 				0F9C0FA7221ADAC80091205A /* Stack.m */,
 				0F9C0FAD221ADAC90091205A /* SyncStack.h */,
 				0F9C0FA0221ADAC80091205A /* SyncStack.m */,
+				0FD6BAEE29CD6E73001A0930 /* CSURLSessionDelegate.h */,
 				0F9C0FAF221ADAC90091205A /* ThirdPartyNamespaceHeader */,
 				230B38C41C16E98B00444A14 /* Info.plist */,
 			);
@@ -507,6 +510,7 @@
 				230B39011C16EB8D00444A14 /* ISO8601DateFormatter.h in Headers */,
 				23A53F401E276C83001DBE35 /* CSIOInternalHeaders.h in Headers */,
 				0F9C0FB1221ADAC90091205A /* AssetLibrary.h in Headers */,
+				0FD6BAEF29CD6E73001A0930 /* CSURLSessionDelegate.h in Headers */,
 				0F9C0FB6221ADAC90091205A /* Config.h in Headers */,
 				0F9C0FC2221ADAC90091205A /* Query.h in Headers */,
 				0FEAEF292361A18600985FF9 /* CSError.h in Headers */,
diff --git a/Contentstack/CSURLSessionDelegate.h b/Contentstack/CSURLSessionDelegate.h
@@ -0,0 +1,28 @@
+//
+//  CSURLSessionDelegate.h
+//  Contentstack
+//
+//  Created by Uttam Ukkoji on 24/03/23.
+//  Copyright © 2023 Contentstack. All rights reserved.
+//
+
+#ifndef CSURLSessionDelegate_h
+#define CSURLSessionDelegate_h
+#import <Foundation/NSURLRequest.h>
+
+@class NSURLSession;
+@class NSURLAuthenticationChallenge;
+
+API_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0))
+@protocol CSURLSessionDelegate <NSObject>
+@optional
+
+- (void)URLSession:(NSURLSession *_Nonnull)session didReceiveChallenge:(NSURLAuthenticationChallenge *_Nonnull)challenge
+ completionHandler:(void (NS_SWIFT_SENDABLE ^_Nonnull)(NSURLSessionAuthChallengeDisposition disposition, NSURLCredential * _Nullable credential))completionHandler;
+
+- (void)URLSession:(NSURLSession *_Nonnull)session task:(NSURLSessionTask *_Nonnull)task
+                            didReceiveChallenge:(NSURLAuthenticationChallenge *_Nonnull)challenge
+                              completionHandler:(void (NS_SWIFT_SENDABLE ^_Nonnull)(NSURLSessionAuthChallengeDisposition disposition, NSURLCredential * _Nullable credential))completionHandler;
+
+@end
+#endif /* CSURLSessionDelegate_h */
diff --git a/Contentstack/Config.h b/Contentstack/Config.h
@@ -8,6 +8,7 @@
 
 #import <Foundation/Foundation.h>
 #import "ContentstackDefinitions.h"
+#import "CSURLSessionDelegate.h"
 @interface Config : NSObject
 
 /**----------------------------------------------------------------------------------------
@@ -72,4 +73,19 @@
  */
 @property (nonatomic, copy) NSString *branch;
 
+
+/**
+ Branch id for the
+ 
+     //Obj-C
+     Config *config = [[Config alloc] init];
+     config.delegate = [[CSDelegate alloc] init];
+     
+     //Swift
+     var config:Config = Config()
+     config.delegate = CSDelegate()
+ 
+ */
+@property (nullable, retain) id<CSURLSessionDelegate> delegate;
+
 @end
diff --git a/Contentstack/Contentstack.h b/Contentstack/Contentstack.h
@@ -19,6 +19,7 @@
 #import <Contentstack/QueryResult.h>
 #import <Contentstack/Group.h>
 #import <Contentstack/SyncStack.h>
+#import <Contentstack/CSURLSessionDelegate.h>
 
 @class Stack;
 
diff --git a/Contentstack/ContentstackDefinitions.h b/Contentstack/ContentstackDefinitions.h
@@ -78,7 +78,8 @@
     typedef NS_ENUM(NSUInteger, ContentstackRegion){
         US = 0,
         EU,
-        AZURE_NA
+        AZURE_NA,
+        AZURE_EU
     };
 
     typedef NS_ENUM(NSUInteger, Language) {
diff --git a/Contentstack/Stack.m b/Contentstack/Stack.m
@@ -39,7 +39,7 @@ - (instancetype)initWithAPIKey:(NSString*)apiKey andaccessToken:(NSString *)acce
         _apiKey = apiKey;
         _accessToken = accessToken;
         
-        _network = [[CSIOCoreHTTPNetworking alloc] init];
+        _network = [[CSIOCoreHTTPNetworking alloc] initWithDelegate:_config.delegate];
         _stackHeaders = [NSMutableDictionary dictionary];
         ISO8601DateFormatter *formatter = [[ISO8601DateFormatter alloc]init];
         _commonDateFormatter = formatter;
diff --git a/ContentstackInternal/CSIOCoreHTTPNetworking.h b/ContentstackInternal/CSIOCoreHTTPNetworking.h
@@ -7,8 +7,10 @@
 //
 
 #import <Foundation/Foundation.h>
+#import <Contentstack/CSURLSessionDelegate.h>
 #import "CSIOCoreNetworkingProtocol.h"
 
-@interface CSIOCoreHTTPNetworking : NSObject <CSIOCoreNetworkingProtocol>
 
+@interface CSIOCoreHTTPNetworking : NSObject <CSIOCoreNetworkingProtocol>
+-(instancetype)initWithDelegate: (id<CSURLSessionDelegate>) delegate;
 @end
diff --git a/ContentstackInternal/CSIOCoreHTTPNetworking.m b/ContentstackInternal/CSIOCoreHTTPNetworking.m
@@ -140,10 +140,10 @@ - (NSString *)URLEncodedStringValue {
 }
 @implementation CSIOCoreHTTPNetworking
 
--(instancetype)init {
+-(instancetype)initWithDelegate: (id<CSURLSessionDelegate>) delegate {
     if (self=[super init]) {
 //        _httpSessionManager = [AFHTTPSessionManager manager];
-        _urlSessionManager = [CSURLSessionManager manager:[self configuration]];
+        _urlSessionManager = [CSURLSessionManager manager:[self configuration] delegate:delegate];
         [NSURLCache setSharedURLCache:[CSIOURLCache standardURLCache]];
 //        [self sessionManagerQueryStringSerialization];
     }
diff --git a/ContentstackInternal/NSObject+Extensions.m b/ContentstackInternal/NSObject+Extensions.m
@@ -43,6 +43,7 @@ -(NSArray*)hostURLS {
     static dispatch_once_t hostURLSOnceToken;
     dispatch_once(&hostURLSOnceToken, ^{
         hostURLS = @[@"cdn.contentstack.io",
+                     @"cdn.contentstack.com",
                      @"cdn.contentstack.com",
                      @"cdn.contentstack.com"];
     });
@@ -59,7 +60,8 @@ -(NSArray*)regionCodes {
      dispatch_once(&regionCodesOnceToken, ^{
          regionCodes = @[@"us",
                          @"eu",
-                         @"azure-na"];
+                         @"azure-na",
+                         @"azure-eu"];
      });
     return regionCodes;
 }
diff --git a/ContentstackTest/ContentstackTest.m b/ContentstackTest/ContentstackTest.m
@@ -9,7 +9,47 @@
 #import <XCTest/XCTest.h>
 #import <Contentstack/Contentstack.h>
 
+@interface CSPinnig:  NSObject <CSURLSessionDelegate>{
+    
+}
+@end
+
+@implementation CSPinnig
+
+- (void)URLSession:(NSURLSession * _Nonnull)session didReceiveChallenge:(NSURLAuthenticationChallenge * _Nonnull)challenge completionHandler:(void (^ _Nonnull)(NSURLSessionAuthChallengeDisposition, NSURLCredential * _Nullable))completionHandler {
+    
+    NSURLSessionAuthChallengeDisposition disposition = NSURLSessionAuthChallengePerformDefaultHandling;
+    __block NSURLCredential *credential = nil;
+
+    if ([challenge.protectionSpace.authenticationMethod isEqualToString:NSURLAuthenticationMethodServerTrust]) {
+        disposition = NSURLSessionAuthChallengeUseCredential;
+        credential = [NSURLCredential credentialForTrust:challenge.protectionSpace.serverTrust];
+    } else {
+        disposition = NSURLSessionAuthChallengePerformDefaultHandling;
+    }
+
+    if (completionHandler) {
+        completionHandler(disposition, credential);
+    }
+}
+
+- (void)URLSession:(NSURLSession * _Nonnull)session task:(NSURLSessionTask * _Nonnull)task didReceiveChallenge:(NSURLAuthenticationChallenge * _Nonnull)challenge completionHandler:(void (^ _Nonnull)(NSURLSessionAuthChallengeDisposition, NSURLCredential * _Nullable))completionHandler {
+    NSURLSessionAuthChallengeDisposition disposition = NSURLSessionAuthChallengePerformDefaultHandling;
+    __block NSURLCredential *credential = nil;
+
+    if ([challenge.protectionSpace.authenticationMethod isEqualToString:NSURLAuthenticationMethodServerTrust]) {
+        disposition = NSURLSessionAuthChallengeUseCredential;
+        credential = [NSURLCredential credentialForTrust:challenge.protectionSpace.serverTrust];
+    } else {
+        disposition = NSURLSessionAuthChallengePerformDefaultHandling;
+    }
 
+    if (completionHandler) {
+        completionHandler(disposition, credential);
+    }
+}
+
+@end
 static NSInteger kRequestTimeOutInSeconds = 400;
 static NSString *_productUid = @"";
 static NSString *_assetUid = @"";
@@ -53,6 +93,7 @@ @implementation ContentstackTest
 - (void)setUp {
     [super setUp];
     config = [[Config alloc] init];
+//    config.delegate = [[CSPinnig alloc] init];
     NSString *path = [[NSBundle bundleForClass:self.class] pathForResource:@"config" ofType:@"json"];
     NSData *data = [NSData dataWithContentsOfFile:path];
     NSDictionary *dict =  [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:nil];
diff --git a/ThirdPartyExtension/Networking/CSURLSessionManager.h b/ThirdPartyExtension/Networking/CSURLSessionManager.h
@@ -7,17 +7,19 @@
 //
 
 #import <Foundation/Foundation.h>
-
+#import <Contentstack/CSURLSessionDelegate.h>
 NS_ASSUME_NONNULL_BEGIN
 
 @interface CSURLSessionManager : NSObject <NSURLSessionDelegate, NSURLSessionTaskDelegate, NSURLSessionDataDelegate>
 
-+ (instancetype)manager: (NSURLSessionConfiguration*) configuration;
++ (instancetype)manager: (NSURLSessionConfiguration*) configuration delegate:(id<CSURLSessionDelegate>) delegate;
 /**
  The managed session.
  */
 @property (readonly, nonatomic, strong) NSURLSession *session;
 
+@property (nullable, readonly, retain) id<CSURLSessionDelegate> delegate;
+
 /**
  The operation queue on which delegate callbacks are run.
  */
diff --git a/ThirdPartyExtension/Networking/CSURLSessionManager.m b/ThirdPartyExtension/Networking/CSURLSessionManager.m
@@ -67,11 +67,11 @@ @interface CSURLSessionManager ()
 
 @implementation CSURLSessionManager
 
-+ (instancetype)manager: (NSURLSessionConfiguration*) configuration {
-    return [[[self class] alloc] initWithConfiguration: configuration];
++ (instancetype)manager: (NSURLSessionConfiguration*) configuration delegate:(nonnull id<CSURLSessionDelegate>)delegate {
+    return [[[self class] alloc] initWithConfiguration: configuration delegate:delegate];
 }
 
-- (instancetype)initWithConfiguration: (NSURLSessionConfiguration *) configuration
+- (instancetype)initWithConfiguration: (NSURLSessionConfiguration *) configuration delegate:(nonnull id<CSURLSessionDelegate>)delegate
 {
     self = [super init];
     if (self) {
@@ -84,7 +84,7 @@ - (instancetype)initWithConfiguration: (NSURLSessionConfiguration *) configurati
         self.operationQueue.maxConcurrentOperationCount = 1;
 
         self.session = [NSURLSession sessionWithConfiguration:self.sessionConfiguration delegate:self delegateQueue:self.operationQueue];
-
+        _delegate = delegate;
     }
     return self;
 }
@@ -163,18 +163,22 @@ - (void)URLSession:(NSURLSession *)session
 didReceiveChallenge:(NSURLAuthenticationChallenge *)challenge
  completionHandler:(void (^)(NSURLSessionAuthChallengeDisposition disposition, NSURLCredential *credential))completionHandler
 {
-    NSURLSessionAuthChallengeDisposition disposition = NSURLSessionAuthChallengePerformDefaultHandling;
-    __block NSURLCredential *credential = nil;
-
-    if ([challenge.protectionSpace.authenticationMethod isEqualToString:NSURLAuthenticationMethodServerTrust]) {
-        disposition = NSURLSessionAuthChallengeUseCredential;
-        credential = [NSURLCredential credentialForTrust:challenge.protectionSpace.serverTrust];
+    if (self.delegate != nil) {
+        [self.delegate URLSession:session didReceiveChallenge:challenge completionHandler:completionHandler];
     } else {
-        disposition = NSURLSessionAuthChallengePerformDefaultHandling;
-    }
+        NSURLSessionAuthChallengeDisposition disposition = NSURLSessionAuthChallengePerformDefaultHandling;
+        __block NSURLCredential *credential = nil;
+
+        if ([challenge.protectionSpace.authenticationMethod isEqualToString:NSURLAuthenticationMethodServerTrust]) {
+            disposition = NSURLSessionAuthChallengeUseCredential;
+            credential = [NSURLCredential credentialForTrust:challenge.protectionSpace.serverTrust];
+        } else {
+            disposition = NSURLSessionAuthChallengePerformDefaultHandling;
+        }
 
-    if (completionHandler) {
-        completionHandler(disposition, credential);
+        if (completionHandler) {
+            completionHandler(disposition, credential);
+        }
     }
 }
 
@@ -197,18 +201,22 @@ - (void)URLSession:(NSURLSession *)session
 didReceiveChallenge:(NSURLAuthenticationChallenge *)challenge
  completionHandler:(void (^)(NSURLSessionAuthChallengeDisposition disposition, NSURLCredential *credential))completionHandler
 {
-    NSURLSessionAuthChallengeDisposition disposition = NSURLSessionAuthChallengePerformDefaultHandling;
-    __block NSURLCredential *credential = nil;
-
-    if ([challenge.protectionSpace.authenticationMethod isEqualToString:NSURLAuthenticationMethodServerTrust]) {
-        disposition = NSURLSessionAuthChallengeUseCredential;
-        credential = [NSURLCredential credentialForTrust:challenge.protectionSpace.serverTrust];
+    if (self.delegate != nil) {
+        [self.delegate URLSession:session task:task didReceiveChallenge:challenge completionHandler:completionHandler];
     } else {
-        disposition = NSURLSessionAuthChallengePerformDefaultHandling;
-    }
+        NSURLSessionAuthChallengeDisposition disposition = NSURLSessionAuthChallengePerformDefaultHandling;
+        __block NSURLCredential *credential = nil;
+
+        if ([challenge.protectionSpace.authenticationMethod isEqualToString:NSURLAuthenticationMethodServerTrust]) {
+            disposition = NSURLSessionAuthChallengeUseCredential;
+            credential = [NSURLCredential credentialForTrust:challenge.protectionSpace.serverTrust];
+        } else {
+            disposition = NSURLSessionAuthChallengePerformDefaultHandling;
+        }
 
-    if (completionHandler) {
-        completionHandler(disposition, credential);
+        if (completionHandler) {
+            completionHandler(disposition, credential);
+        }
     }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -140,10 +140,10 @@ - (NSString *)URLEncodedStringValue {`
`140`	`140`	`}`
`141`	`141`	`@implementation CSIOCoreHTTPNetworking`
`142`	`142`
`143`		`--(instancetype)init {`
	`143`	`+-(instancetype)initWithDelegate: (id<CSURLSessionDelegate>) delegate {`
`144`	`144`	`if (self=[super init]) {`
`145`	`145`	`// _httpSessionManager = [AFHTTPSessionManager manager];`
`146`		`- _urlSessionManager = [CSURLSessionManager manager:[self configuration]];`
	`146`	`+ _urlSessionManager = [CSURLSessionManager manager:[self configuration] delegate:delegate];`
`147`	`147`	`[NSURLCache setSharedURLCache:[CSIOURLCache standardURLCache]];`
`148`	`148`	`// [self sessionManagerQueryStringSerialization];`
`149`	`149`	`}`