Merge branch 'dev' into kasong/2914053-common-interface

Author: Kai Song

IdentityCore/IdentityCore.xcodeproj/project.pbxproj

@@ -97,6 +97,7 @@ extern NSString * _Nonnull const MSID_SKIP_VALIDATE_RESULT_ACCOUNT_KEY;
 extern NSString * _Nonnull const MSID_JIT_TROUBLESHOOTING_HOST;
 extern NSString * _Nonnull const MSID_IS_CALLER_MANAGED_KEY;
 extern NSString * _Nonnull const MSID_BROKER_PREFERRED_AUTH_CONFIGURATION_KEY;
+extern NSString * _Nonnull const MSID_BROKER_CLIENT_FLIGHTS_KEY;
 extern NSString * _Nonnull const MSID_BROKER_SDM_WPJ_ATTEMPTED;
 extern NSString * _Nonnull const MSID_EXP_RETRY_ON_NETWORK;
 extern NSString * _Nonnull const MSID_EXP_ENABLE_CONNECTION_CLOSE;

IdentityCore/src/MSIDBrokerConstants.h

@@ -78,6 +78,7 @@
 NSString *const MSID_BROKER_TYPES_OF_HEADER = @"types_of_header";
 NSString *const MSID_BROKER_REQUEST_SENT_TIMESTAMP = @"request_sent_timestamp";
 NSString *const MSID_BROKER_PREFERRED_AUTH_CONFIGURATION_KEY = @"preferred_auth_config";
+NSString *const MSID_BROKER_CLIENT_FLIGHTS_KEY = @"client_flights";
 NSString *const MSID_BROKER_ACCOUNT_HOME_TENANT_ID = @"account_home_tenant_id";
 NSString *const MSID_CLIENT_SKU_KEY = @"client_sku";
 NSString *const MSID_SKIP_VALIDATE_RESULT_ACCOUNT_KEY = @"skip_validate_result_account";

IdentityCore/src/MSIDBrokerConstants.m

@@ -0,0 +1,40 @@
+
+//
+// Copyright (c) Microsoft Corporation.
+// All rights reserved.
+//
+// This code is licensed under the MIT License.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files(the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions :
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.  
+
+#import <Foundation/Foundation.h>
+#import "MSIDFlightManager.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface MSIDBrokerFlightProvider : NSObject <MSIDFlightManagerInterface>
+
+- (instancetype _Nullable)initWithBase64EncodedFlightsPayload:(nullable NSString *)base64EncodedFlightsPayload NS_DESIGNATED_INITIALIZER;
+
+- (instancetype _Nullable)init NS_UNAVAILABLE;
++ (instancetype _Nullable)new NS_UNAVAILABLE;
+
+@end
+
+NS_ASSUME_NONNULL_END

IdentityCore/src/MSIDBrokerFlightProvider.h

@@ -0,0 +1,110 @@
+//
+// Copyright (c) Microsoft Corporation.
+// All rights reserved.
+//
+// This code is licensed under the MIT License.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files(the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions :
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.  
+
+#import "MSIDBrokerFlightProvider.h"
+#import "NSJSONSerialization+MSIDExtensions.h"
+
+@interface MSIDBrokerFlightProvider()
+
+@property (nonatomic, nullable, readonly) NSDictionary *clientFlightsPayload;
+
+@end
+
+@implementation MSIDBrokerFlightProvider
+
+- (instancetype _Nullable)initWithBase64EncodedFlightsPayload:(nullable NSString *)base64EncodedFlightsPayload
+{
+    self = [super init];
+    
+    if (self)
+    {
+        if ([NSString msidIsStringNilOrBlank:base64EncodedFlightsPayload])
+        {
+            MSID_LOG_WITH_CTX(MSIDLogLevelInfo,nil, @"Broker client flights is nil or empty");
+            return nil;
+        }
+        
+        NSDictionary *clientFlightsDict = nil;
+        
+        NSData *decodedJsonData =  [[base64EncodedFlightsPayload msidBase64UrlDecode] dataUsingEncoding:NSUTF8StringEncoding];
+        if (decodedJsonData && [decodedJsonData length])
+        {
+            clientFlightsDict = [NSJSONSerialization msidNormalizedDictionaryFromJsonData:decodedJsonData error:nil];
+            
+            if (![clientFlightsDict isKindOfClass:[NSDictionary class]])
+            {
+                MSID_LOG_WITH_CTX(MSIDLogLevelWarning,nil, @"Invalid broker client flight format");
+                return nil;
+            }
+        }
+        else
+        {
+            MSID_LOG_WITH_CTX(MSIDLogLevelWarning,nil, @"Failed to decode base64encoded client flights from broker");
+            return nil;
+        }
+        
+        if (clientFlightsDict)
+        {
+            _clientFlightsPayload = clientFlightsDict;
+            MSID_LOG_WITH_CTX(MSIDLogLevelInfo, nil, @"Client flights from broker is decoded successfully");
+        }
+    }
+    
+    return self;
+}
+
+#pragma mark - MSIDFlightManagerInterface
+
+- (BOOL)boolForKey:(nonnull NSString *)flightKey
+{
+    if (self.clientFlightsPayload)
+    {
+        id value = self.clientFlightsPayload[flightKey];
+        
+        if ([value isKindOfClass:[NSNumber class]] || [value isKindOfClass:[NSString class]])
+        {
+            return [value boolValue];
+        }
+    }
+    
+    return NO;
+}
+
+- (nullable NSString *)stringForKey:(nonnull NSString *)flightKey
+{
+    if (self.clientFlightsPayload)
+    {
+        id value = self.clientFlightsPayload[flightKey];
+        
+        if ([value isKindOfClass:[NSString class]])
+        {
+            return value;
+        }
+    }
+    
+    return nil;
+}
+
+
+@end

IdentityCore/src/MSIDBrokerFlightProvider.m

@@ -184,5 +184,6 @@ extern NSString * _Nonnull const MSID_BROWSER_RESPONSE_SWITCH_BROWSER_RESUME;
 
 extern NSString * _Nonnull const MSID_FLIGHT_USE_V2_WEB_RESPONSE_FACTORY;
 extern NSString * _Nonnull const MSID_FLIGHT_SUPPORT_DUNA_CBA;
+extern NSString * _Nonnull const MSID_FLIGHT_CLIENT_SFRT_STATUS;
 
 #define METHODANDLINE   [NSString stringWithFormat:@"%s [Line %d]", __PRETTY_FUNCTION__, __LINE__]

IdentityCore/src/MSIDConstants.h

@@ -77,7 +77,8 @@
 NSString *const MSID_BROWSER_RESPONSE_SWITCH_BROWSER_RESUME = @"switch_browser_resume";
 
 NSString *const MSID_FLIGHT_USE_V2_WEB_RESPONSE_FACTORY = @"use_v2_web_response_factory";
-NSString *const MSID_FLIGHT_SUPPORT_DUNA_CBA = @"support_duna_cba";
+NSString *const MSID_FLIGHT_SUPPORT_DUNA_CBA = @"support_duna_cba_v2";
+NSString *const MSID_FLIGHT_CLIENT_SFRT_STATUS = @"sfrt_status";
 
 
 #define METHODANDLINE   [NSString stringWithFormat:@"%s [Line %d]", __PRETTY_FUNCTION__, __LINE__]

IdentityCore/src/MSIDConstants.m

@@ -30,12 +30,14 @@ NS_ASSUME_NONNULL_BEGIN
 @protocol MSIDFlightManagerInterface <NSObject>
 
 - (BOOL)boolForKey:(NSString *)flightKey;
+- (nullable NSString *)stringForKey:(NSString *)key;
+
 
 @end
 
 @interface MSIDFlightManager : NSObject <MSIDFlightManagerInterface>
 
-@property (nonatomic) id<MSIDFlightManagerInterface> flightProvider;
+@property (nonatomic, nullable) id<MSIDFlightManagerInterface> flightProvider;
 
 + (instancetype)sharedInstance;
 

IdentityCore/src/MSIDFlightManager.h

@@ -25,26 +25,76 @@
 
 #import "MSIDFlightManager.h"
 
+@interface MSIDFlightManager()
+
+@property (nonatomic) dispatch_queue_t synchronizationQueue;
+
+@end
+
+
 @implementation MSIDFlightManager
 
 + (instancetype)sharedInstance
 {
     static MSIDFlightManager *sharedInstance = nil;
     static dispatch_once_t onceToken;
     dispatch_once(&onceToken, ^{
-        sharedInstance = [[self.class alloc] init];
+        sharedInstance = [[self.class alloc] initInternal];
     });
 
     return sharedInstance;
 }
 
+- (instancetype)initInternal
+{
+    self = [super init];
+    if (self)
+    {
+        _synchronizationQueue = [self initializeDispatchQueue];
+    }
+    return self;
+}
+
+- (dispatch_queue_t)initializeDispatchQueue
+{
+    NSString *queueName = [NSString stringWithFormat:@"com.microsoft.msidflightmanager-%@", [NSUUID UUID].UUIDString];
+    return dispatch_queue_create([queueName cStringUsingEncoding:NSASCIIStringEncoding], DISPATCH_QUEUE_CONCURRENT);
+}
+
+- (void)setFlightProvider:(id<MSIDFlightManagerInterface>)flightProvider
+{
+    dispatch_barrier_async(self.synchronizationQueue, ^{
+        self->_flightProvider = flightProvider;
+    });
+}
+
 #pragma mark - MSIDFlightManagerInterface
 
 - (BOOL)boolForKey:(nonnull NSString *)flightKey 
 {
-    if (self.flightProvider) { return [self.flightProvider boolForKey:flightKey]; }
+    __block BOOL result = NO;
+    if (self.flightProvider)
+    {
+        dispatch_sync(self.synchronizationQueue, ^{
+            result = [self.flightProvider boolForKey:flightKey];
+        });
+    }
 
-    return NO;
+    return result;
 }
 
+- (nullable NSString *)stringForKey:(nonnull NSString *)flightKey
+{
+    __block NSString* result = nil;
+    if (self.flightProvider)
+    {
+        dispatch_sync(self.synchronizationQueue, ^{
+            result = [self.flightProvider stringForKey:flightKey];
+        });
+    }
+    
+    return result;
+}
+
+
 @end

IdentityCore/src/MSIDFlightManager.m

@@ -36,11 +36,13 @@ extern MSIDJsonSerializableType const MSID_JSON_TYPE_OPERATION_REQUEST_GET_ACCOU
 extern MSIDJsonSerializableType const MSID_JSON_TYPE_OPERATION_REQUEST_GET_DEVICE_INFO;
 extern MSIDJsonSerializableType const MSID_JSON_TYPE_OPERATION_REQUEST_GET_PRT;
 extern MSIDJsonSerializableType const MSID_JSON_TYPE_OPERATION_REQUEST_GET_SSO_COOKIES;
-extern MSIDJsonSerializableType const MSID_JSON_TYPE_OPERATION_REQUEST_BROWSER_NATIVE_MESSAGE;
 extern MSIDJsonSerializableType const MSID_JSON_TYPE_OPERATION_REQUEST_PASSKEY_ASSERTION;
 extern MSIDJsonSerializableType const MSID_JSON_TYPE_OPERATION_REQUEST_PASSKEY_CREDENTIAL;
+extern MSIDJsonSerializableType const MSID_JSON_TYPE_OPERATION_REQUEST_BROWSER_NATIVE_MESSAGE;
+extern MSIDJsonSerializableType const MSID_JSON_TYPE_OPERATION_REQUEST_BROWSER_NATIVE_GET_SUPPORTED_CONTRACTS;
 
 extern MSIDJsonSerializableType const MSID_JSON_TYPE_BROKER_OPERATION_BROWSER_NATIVE_MESSAGE_RESPONSE;
+extern MSIDJsonSerializableType const MSID_JSON_TYPE_BROKER_OPERATION_BROWSER_NATIVE_GET_SUPPORTED_CONTRACTS_RESPONSE;
 extern MSIDJsonSerializableType const MSID_JSON_TYPE_BROKER_OPERATION_GET_ACCOUNTS_RESPONSE;
 extern MSIDJsonSerializableType const MSID_JSON_TYPE_BROKER_OPERATION_GENERIC_RESPONSE;
 extern MSIDJsonSerializableType const MSID_JSON_TYPE_BROKER_OPERATION_TOKEN_RESPONSE;