Merge pull request #2339 from AzureAD/oldalton/extra_query_params_signout

Support extra query parameters in logout endpoint

Author: oldalton

CHANGELOG.md

@@ -1,4 +1,7 @@
 ## [TBD]:
+* Support extra query parameters on logout endpoint (#2339)
+
+## [1.5.1]:
 * Parse and add STS error codes in token error result (#2319)
 * VisionOS support added (#2139)
 

MSAL.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name         = "MSAL"
-  s.version      = "1.5.0"
+  s.version      = "1.5.1"
   s.summary      = "Microsoft Authentication Library (MSAL) for iOS"
   s.description  = <<-DESC
                    The MSAL library for iOS gives your app the ability to begin using the Microsoft Cloud by supporting Microsoft Azure Active Directory and Microsoft Accounts in a converged experience using industry standard OAuth2 and OpenID Connect. The library also supports Microsoft Azure B2C for those using our hosted identity management service.

MSAL/IdentityCore

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.5.0</string>
+	<string>1.5.1</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSPrincipalClass</key>

MSAL/resources/ios/Info.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.5.0</string>
+	<string>1.5.1</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSHumanReadableCopyright</key>

MSAL/resources/mac/Info.plist

@@ -1458,6 +1458,10 @@ - (void)signoutWithAccount:(nonnull MSALAccount *)account
     msidParams.platformSequence = [NSString msidUpdatePlatformSequenceParamWithSrcName:[MSIDVersion platformName]
                                                                             srcVersion:[MSIDVersion sdkVersion]
                                                                               sequence:nil];
+    
+    // Extra parameters to be added to the /authorize endpoint.
+    msidParams.extraURLQueryParameters = signoutParameters.extraQueryParameters;
+    
     NSError *localError;
     BOOL localRemovalResult = [self removeAccountImpl:account wipeAccount:signoutParameters.wipeAccount error:&localError];
 

MSAL/src/MSALPublicClientApplication.m

@@ -27,7 +27,7 @@
 
 #define MSAL_VER_HIGH       1
 #define MSAL_VER_LOW        5
-#define MSAL_VER_PATCH      0
+#define MSAL_VER_PATCH      1
 
 #define STR_HELPER(x) #x
 #define STR(x) STR_HELPER(x)

MSAL/src/MSAL_Internal.h

@@ -68,6 +68,11 @@ NS_ASSUME_NONNULL_BEGIN
 */
 @property (nonatomic) BOOL wipeCacheForAllAccounts;
 
+/**
+ Key-value pairs to pass to the logout endpoint. This should not be url-encoded value.
+ */
+@property (nonatomic, nullable) NSDictionary <NSString *, NSString *> *extraQueryParameters;
+
 /**
  Initialize MSALSignoutParameters with web parameters.
  

MSAL/src/public/MSALSignoutParameters.h

@@ -3565,6 +3565,7 @@ - (void)testSignoutWithAccount_whenNonNilAccount_andSignoutFromBrowserTrue_andBr
     MSALWebviewParameters *webParams = [[MSALWebviewParameters alloc] initWithAuthPresentationViewController:[self.class sharedViewControllerStub]];
     MSALSignoutParameters *parameters = [[MSALSignoutParameters alloc] initWithWebviewParameters:webParams];
     parameters.signoutFromBrowser = YES;
+    parameters.extraQueryParameters = @{@"key1": @"value1"};
     MSALGlobalConfig.brokerAvailability = MSALBrokeredAvailabilityNone;
 
     XCTAssertEqual([application allAccounts:nil].count, 1);
@@ -3581,6 +3582,7 @@ - (void)testSignoutWithAccount_whenNonNilAccount_andSignoutFromBrowserTrue_andBr
 
         XCTAssertEqualObjects(params.accountIdentifier.displayableId, @"[email protected]");
         XCTAssertEqualObjects(params.accountIdentifier.homeAccountId, @"myuid.utid");
+        XCTAssertEqualObjects(params.extraURLQueryParameters[@"key1"], @"value1");
 
         XCTAssertEqualObjects(params.authority.url.absoluteString, @"https://login.microsoftonline.com/common");
         XCTAssertEqualObjects(params.clientId, UNIT_TEST_CLIENT_ID);