Merge pull request #815 from AzureAD/release/1.0.6

antrix1989 · web-flow · commit 1c88515647b3 · 2020-01-02T14:24:38.000-08:00
[Blocked for release freeze] Release 1.0.6 into master
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+## [1.0.6] - 2020-01-03
+### Fixed
+- Set mobile content type for the WKWebView configuration (#810)
+- Better error handling for missing broker query schemes (#811)
+- Enable dogfood Authenticator support by default (#812)
+- Optimiza external account writing logic (#813)
+
 ## [1.0.5] - 2019-12-13
 ### Fixed
 - Account lookup fix when no refresh tokens present (#799)
diff --git a/MSAL.podspec b/MSAL.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name         = "MSAL"
-  s.version      = "1.0.5"
+  s.version      = "1.0.6"
   s.summary      = "Microsoft Authentication Library (MSAL) Preview for iOS"
 
   s.description  = <<-DESC
diff --git a/MSAL/IdentityCore b/MSAL/IdentityCore
@@ -1 +1 @@
-Subproject commit 62e57b814e21a2b57981794df4528261c722c606
+Subproject commit 735e540a7cb7dd28d92f2daf46702ef3845f237e
diff --git a/MSAL/MSAL.xcodeproj/project.pbxproj b/MSAL/MSAL.xcodeproj/project.pbxproj
@@ -549,6 +549,7 @@
 		B2BB739C2112C7F9000EA4C5 /* Security.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = B2BB739B2112C7F9000EA4C5 /* Security.framework */; };
 		B2BB739D2112C82E000EA4C5 /* Security.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = B2BB739B2112C7F9000EA4C5 /* Security.framework */; };
 		B2BDEEE821FEA205001EBB8B /* MSALMultiAppCacheCoexistenceTests.m in Sources */ = {isa = PBXBuildFile; fileRef = B2734C1B21253AD300DAB1CD /* MSALMultiAppCacheCoexistenceTests.m */; };
+		B2C0E80923AF06DB006C9CAD /* MSALLegacySharedAccountsProvider+Internal.h in Headers */ = {isa = PBXBuildFile; fileRef = B2C0E80723AF06DB006C9CAD /* MSALLegacySharedAccountsProvider+Internal.h */; };
 		B2C17B071FC8DAC50070A514 /* libIdentityCore.a in Frameworks */ = {isa = PBXBuildFile; fileRef = D6A206231FC50A4D00755A51 /* libIdentityCore.a */; };
 		B2C17B081FC8DACC0070A514 /* libIdentityCore.a in Frameworks */ = {isa = PBXBuildFile; fileRef = D6A206251FC50A4D00755A51 /* libIdentityCore.a */; };
 		B2C17B0A1FC8DB2E0070A514 /* MSIDVersion.m in Sources */ = {isa = PBXBuildFile; fileRef = B2C17B091FC8DB2E0070A514 /* MSIDVersion.m */; };
@@ -1228,6 +1229,7 @@
 		B2BB73962112C4B3000EA4C5 /* msal__ui_test__ios.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; path = msal__ui_test__ios.xcconfig; sourceTree = "<group>"; };
 		B2BB73982112C51E000EA4C5 /* MSALUITests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = MSALUITests.swift; sourceTree = "<group>"; };
 		B2BB739B2112C7F9000EA4C5 /* Security.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Security.framework; path = Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS11.4.sdk/System/Library/Frameworks/Security.framework; sourceTree = DEVELOPER_DIR; };
+		B2C0E80723AF06DB006C9CAD /* MSALLegacySharedAccountsProvider+Internal.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "MSALLegacySharedAccountsProvider+Internal.h"; sourceTree = "<group>"; };
 		B2C17B091FC8DB2E0070A514 /* MSIDVersion.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSIDVersion.m; sourceTree = "<group>"; };
 		B2C2329F21224C21008092C1 /* MSALBlackforestUITests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSALBlackforestUITests.m; sourceTree = "<group>"; };
 		B2C232AA2122A6A5008092C1 /* MSALCacheRemovalTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSALCacheRemovalTests.m; sourceTree = "<group>"; };
@@ -1719,6 +1721,7 @@
 				B223B0C422AE215D00FB8713 /* MSALLegacySharedAccountFactory.m */,
 				B266391922B4B84600FEB673 /* NSString+MSALAccountIdenfiers.h */,
 				B266391A22B4B84600FEB673 /* NSString+MSALAccountIdenfiers.m */,
+				B2C0E80723AF06DB006C9CAD /* MSALLegacySharedAccountsProvider+Internal.h */,
 			);
 			path = ios;
 			sourceTree = "<group>";
@@ -2497,6 +2500,7 @@
 				B29A56C122826EE00023F5E6 /* MSALSerializedADALCacheProvider.h in Headers */,
 				96CF95212268FD0400D97374 /* MSALAccount.h in Headers */,
 				B267569D228F335E000F01D7 /* MSALExternalAccountHandler.h in Headers */,
+				B2C0E80923AF06DB006C9CAD /* MSALLegacySharedAccountsProvider+Internal.h in Headers */,
 				B26756C422921C42000F01D7 /* MSALAADOauth2Provider.h in Headers */,
 				232D6195224C62FF00260C42 /* MSALIndividualClaimRequest+Internal.h in Headers */,
 				B26756BE22921A71000F01D7 /* MSALOauth2Provider.h in Headers */,
diff --git a/MSAL/resources/ios/Info.plist b/MSAL/resources/ios/Info.plist
@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.0.5</string>
+	<string>1.0.6</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSPrincipalClass</key>
diff --git a/MSAL/resources/mac/Info.plist b/MSAL/resources/mac/Info.plist
@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.0.5</string>
+	<string>1.0.6</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSHumanReadableCopyright</key>
diff --git a/MSAL/src/MSALPublicClientApplication.m b/MSAL/src/MSALPublicClientApplication.m
@@ -94,6 +94,7 @@
 #import "MSIDMacKeychainTokenCache.h"
 #endif
 
+#import "MSIDTokenResult.h"
 #import "MSIDKeychainTokenCache.h"
 
 @interface MSALPublicClientApplication()
@@ -193,6 +194,16 @@ - (instancetype)initWithConfiguration:(MSALPublicClientApplicationConfig *)confi
         if (error) *error = [MSALErrorConverter msalErrorFromMsidError:msidError];
         return nil;
     }
+        
+#if TARGET_OS_IPHONE
+    if (MSALGlobalConfig.brokerAvailability == MSALBrokeredAvailabilityAuto
+        && msalRedirectUri.brokerCapable
+        && ![MSALRedirectUriVerifier verifyAdditionalRequiredSchemesAreRegistered:&msidError])
+    {
+        if (error) *error = [MSALErrorConverter msalErrorFromMsidError:msidError];
+        return nil;
+    }
+#endif
     
     config.verifiedRedirectUri = msalRedirectUri;
     
@@ -696,7 +707,13 @@ - (void)acquireTokenSilentWithParameters:(MSALSilentTokenParameters *)parameters
         
         NSError *resultError = nil;
         MSALResult *msalResult = [self.msalOauth2Provider resultWithTokenResult:result error:&resultError];
-        [self updateExternalAccountsWithResult:msalResult context:msidParams];
+        
+        if (result.tokenResponse)
+        {
+            // Only update external accounts if we got new result from network as an optimization
+            [self updateExternalAccountsWithResult:msalResult context:msidParams];
+        }
+        
         block(msalResult, resultError, msidParams);
     }];
 }
diff --git a/MSAL/src/MSAL_Internal.h b/MSAL/src/MSAL_Internal.h
@@ -27,7 +27,7 @@
 
 #define MSAL_VER_HIGH       1
 #define MSAL_VER_LOW        0
-#define MSAL_VER_PATCH      5
+#define MSAL_VER_PATCH      6
 
 #define STR_HELPER(x) #x
 #define STR(x) STR_HELPER(x)
diff --git a/MSAL/src/configuration/external/ios/MSALLegacySharedAccountsProvider+Internal.h b/MSAL/src/configuration/external/ios/MSALLegacySharedAccountsProvider+Internal.h
@@ -0,0 +1,39 @@
+// 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 "MSALLegacySharedAccountsProvider.h"
+#import "MSALLegacySharedAccount.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface MSALLegacySharedAccountsProvider (Internal)
+
+- (void)updateAccountAsync:(id<MSALAccount>)account
+             idTokenClaims:(nullable NSDictionary *)idTokenClaims
+            tenantProfiles:(nullable NSArray<MSALTenantProfile *> *)tenantProfiles
+                 operation:(MSALLegacySharedAccountWriteOperation)operation
+                completion:(void (^)(BOOL result, NSError *error))completion;
+
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/MSAL/src/configuration/external/ios/MSALLegacySharedAccountsProvider.m b/MSAL/src/configuration/external/ios/MSALLegacySharedAccountsProvider.m
@@ -184,11 +184,12 @@ - (BOOL)updateAccount:(id<MSALAccount>)account idTokenClaims:(NSDictionary *)idT
 {
     MSID_LOG_WITH_CTX_PII(MSIDLogLevelInfo, nil, @"Updating account %@", MSID_PII_LOG_MASKABLE(account));
     
-    return [self updateAccount:account
-                 idTokenClaims:idTokenClaims
-                tenantProfiles:nil
-                     operation:MSALLegacySharedAccountUpdateOperation
-                         error:error];
+    [self updateAccountAsync:account
+               idTokenClaims:idTokenClaims
+              tenantProfiles:nil
+                   operation:MSALLegacySharedAccountUpdateOperation
+                  completion:nil];
+    return YES;
 }
 
 - (nullable NSArray<MSALLegacySharedAccount *> *)updatableAccountsFromJsonObject:(NSDictionary *)jsonDictionary
@@ -247,11 +248,29 @@ - (BOOL)removeAccount:(id<MSALAccount>)account
                 error:(NSError * _Nullable * _Nullable)error
 {
     MSID_LOG_WITH_CTX_PII(MSIDLogLevelInfo, nil, @"Removing account %@", MSID_PII_LOG_MASKABLE(account));
-    return [self updateAccount:account
-                 idTokenClaims:nil
-                tenantProfiles:tenantProfiles
-                     operation:MSALLegacySharedAccountRemoveOperation
-                         error:error];
+    
+    __block BOOL result = YES;
+    __block NSError *removeError;
+    
+    dispatch_barrier_sync(self.synchronizationQueue, ^{
+        result = [self updateAccountImpl:account
+                           idTokenClaims:nil
+                          tenantProfiles:tenantProfiles
+                               operation:MSALLegacySharedAccountRemoveOperation
+                                   error:&removeError];
+        
+        if (!result)
+        {
+            MSID_LOG_WITH_CTX(MSIDLogLevelError, nil, @"Encountered an error updating legacy accounts %@", MSID_PII_LOG_MASKABLE(removeError));
+        }
+    });
+    
+    if (error)
+    {
+        *error = removeError;
+    }
+    
+    return result;
 }
 
 - (nullable NSArray<MSALLegacySharedAccount *> *)removableAccountsFromJsonObject:(NSDictionary *)jsonDictionary
@@ -303,29 +322,27 @@ - (BOOL)removeAccount:(id<MSALAccount>)account
 
 #pragma mark - Write
 
-- (BOOL)updateAccount:(id<MSALAccount>)account
-        idTokenClaims:(NSDictionary *)idTokenClaims
-       tenantProfiles:(NSArray<MSALTenantProfile *> *)tenantProfiles
-            operation:(MSALLegacySharedAccountWriteOperation)operation
-                error:(NSError **)error
+- (void)updateAccountAsync:(id<MSALAccount>)account
+             idTokenClaims:(NSDictionary *)idTokenClaims
+            tenantProfiles:(NSArray<MSALTenantProfile *> *)tenantProfiles
+                 operation:(MSALLegacySharedAccountWriteOperation)operation
+                completion:(void (^)(BOOL result, NSError *error))completion
 {
-    __block BOOL result = YES;
-    __block NSError *updateError = nil;
-    
-    dispatch_barrier_sync(self.synchronizationQueue, ^{
-        result = [self updateAccountImpl:account
-                           idTokenClaims:idTokenClaims
-                          tenantProfiles:tenantProfiles
-                               operation:operation
-                                   error:&updateError];
+    dispatch_barrier_async(self.synchronizationQueue, ^{
+        NSError *updateError;
+        BOOL result = [self updateAccountImpl:account
+                                idTokenClaims:idTokenClaims
+                               tenantProfiles:tenantProfiles
+                                    operation:operation
+                                        error:&updateError];
+        
+        if (!result)
+        {
+            MSID_LOG_WITH_CTX(MSIDLogLevelError, nil, @"Encountered an error updating legacy accounts %@", MSID_PII_LOG_MASKABLE(updateError));
+        }
+        
+        if (completion) completion(result, updateError);
     });
-    
-    if (error && updateError)
-    {
-        *error = updateError;
-    }
-    
-    return result;
 }
 
 - (BOOL)updateAccountImpl:(id<MSALAccount>)account
diff --git a/MSAL/src/util/MSALRedirectUriVerifier.h b/MSAL/src/util/MSALRedirectUriVerifier.h
@@ -35,4 +35,6 @@
                                          clientId:(NSString *)clientId
                                             error:(NSError * __autoreleasing *)error;
 
++ (BOOL)verifyAdditionalRequiredSchemesAreRegistered:(NSError **)error;
+
 @end
diff --git a/MSAL/src/util/ios/MSALRedirectUriVerifier.m b/MSAL/src/util/ios/MSALRedirectUriVerifier.m
@@ -138,4 +138,23 @@ + (BOOL)verifySchemeIsRegistered:(NSURL *)redirectUri
     return NO;
 }
 
++ (BOOL)verifyAdditionalRequiredSchemesAreRegistered:(NSError **)error
+{
+    NSArray *querySchemes = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"LSApplicationQueriesSchemes"];
+    
+    if (![querySchemes containsObject:@"msauthv2"]
+        || ![querySchemes containsObject:@"msauthv3"])
+    {
+        if (error)
+        {
+            NSString *message = @"The required query schemes \"msauthv2\" and \"msauthv3\" are not registered in the app's info.plist file. Please add \"msauthv2\" and \"msauthv3\" into Info.plist under LSApplicationQueriesSchemes without any whitespaces.";
+            MSIDFillAndLogError(error, MSIDErrorRedirectSchemeNotRegistered, message, nil);
+        }
+        
+        return NO;
+    }
+    
+    return YES;
+}
+
 @end
diff --git a/MSAL/src/util/mac/MSALRedirectUriVerifier.m b/MSAL/src/util/mac/MSALRedirectUriVerifier.m
@@ -44,4 +44,9 @@ + (MSALRedirectUri *)msalRedirectUriWithCustomUri:(NSString *)customRedirectUri
                                           brokerCapable:NO];
 }
 
++ (BOOL)verifyAdditionalRequiredSchemesAreRegistered:(__unused NSError **)error
+{
+    return YES;
+}
+
 @end
diff --git a/MSAL/test/app/MSALStressTestHelper.m b/MSAL/test/app/MSALStressTestHelper.m
@@ -38,6 +38,7 @@
 #import "MSALPublicClientApplication.h"
 #import "MSALResult.h"
 #import "MSALSilentTokenParameters.h"
+#import "MSALAccount.h"
 
 @implementation MSALStressTestHelper
 
@@ -79,7 +80,7 @@ + (void)testAcquireTokenSilentWithExpiringTokenImpl:(BOOL)expireToken
 {
     dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
 
-        __block dispatch_semaphore_t sem = dispatch_semaphore_create(10);
+        __block dispatch_semaphore_t sem = dispatch_semaphore_create(50);
         __block NSUInteger userIndex = 0;
 
         while (!s_stop)
@@ -89,7 +90,8 @@ + (void)testAcquireTokenSilentWithExpiringTokenImpl:(BOOL)expireToken
             dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
 
                 MSALAccount *account = accounts[userIndex];
-
+                account = [application accountForIdentifier:account.identifier error:nil];
+                
                 if (multipleUsers)
                 {
                     userIndex = ++userIndex >= [accounts count] ? 0 : userIndex;
@@ -104,7 +106,7 @@ + (void)testAcquireTokenSilentWithExpiringTokenImpl:(BOOL)expireToken
                      {
                          [self expireAllAccessTokens];
                      }
-                     
+                                         
                      dispatch_semaphore_signal(sem);
                  }];
             });
diff --git a/MSAL/test/app/ios/MSALTestAppAcquireTokenViewController.m b/MSAL/test/app/ios/MSALTestAppAcquireTokenViewController.m
@@ -549,6 +549,10 @@ - (void)runStressTestWithType:(MSALStressTestType)type
                                                                                                    redirectUri:redirectUri
                                                                                                      authority:authority];
     
+    MSALLegacySharedAccountsProvider *provider = [[MSALLegacySharedAccountsProvider alloc] initWithSharedKeychainAccessGroup:@"com.microsoft.adalcache" serviceIdentifier:@"legacy-accounts-service" applicationIdentifier:@"my.msal.testapp"];
+    provider.sharedAccountMode = MSALLegacySharedAccountModeReadWrite;
+    [pcaConfig.cacheConfig addExternalAccountProvider:provider];
+    
     NSError *error;
     MSALPublicClientApplication *application = [[MSALPublicClientApplication alloc] initWithConfiguration:pcaConfig error:&error];
     
diff --git a/MSAL/test/unit/MSALPublicClientApplicationAccountUpdateTests.m b/MSAL/test/unit/MSALPublicClientApplicationAccountUpdateTests.m
@@ -45,6 +45,7 @@
 #import "MSALTestBundle.h"
 #import "MSALOauth2Provider.h"
 #import "XCTestCase+HelperMethods.h"
+#import "MSIDTokenResponse.h"
 
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
@@ -117,19 +118,26 @@ - (void)testAcquireTokenSilent_whenSuccessfulResponse_shouldUpdateExternalAccoun
                               class:[MSIDSilentController class]
                               block:(id)^(MSIDSilentController *obj, MSIDRequestCompletionBlock completionBlock)
      {
-         XCTAssertTrue([obj isKindOfClass:[MSIDSilentController class]]);
-         
-         completionBlock([self testTokenResult], nil);
+            XCTAssertTrue([obj isKindOfClass:[MSIDSilentController class]]);
+        
+            MSIDTokenResult *result = [self testTokenResult];
+            result.tokenResponse = [MSIDTokenResponse new];
+            completionBlock(result, nil);
      }];
     
+    XCTestExpectation *updateExpectation = [self keyValueObservingExpectationForObject:mockExternalAccountHandler keyPath:@"updateInvokedCount" expectedValue:@1];
+    XCTestExpectation *acquireTokenExpectation = [self expectationWithDescription:@"Acquire token silent"];
+    
     [application acquireTokenSilentForScopes:@[@"fakescope1", @"fakescope2"]
                                      account:[self testMSALAccount]
                              completionBlock:^(MSALResult * _Nullable result, NSError * _Nullable error) {
                                  
                                  XCTAssertNotNil(result);
                                  XCTAssertNil(error);
-                                 XCTAssertEqual(mockExternalAccountHandler.updateInvokedCount, 1);
+                                 [acquireTokenExpectation fulfill];
                              }];
+    
+    [self waitForExpectations:@[updateExpectation, acquireTokenExpectation] timeout:1];
 }
 
 - (void)testRemoveAccount_whenAccountExistsInExternalCache_shouldCallRemoveAccountFromExternalCache
diff --git a/MSAL/test/unit/MSALPublicClientApplicationTests.m b/MSAL/test/unit/MSALPublicClientApplicationTests.m
diff --git a/MSAL/test/unit/ios/MSALRedirectUriVerifierTests.m b/MSAL/test/unit/ios/MSALRedirectUriVerifierTests.m
diff --git a/MSAL/test/unit/ios/external-cache/MSALLegacySharedAccountsProviderTests.m b/MSAL/test/unit/ios/external-cache/MSALLegacySharedAccountsProviderTests.m
