Remove identity core classes from public api (AzureAD#1158)

* Remove identity core classes from public api. * Add MSALParameters to public headers of static libs. * Add missed files to static lib targets. * Add missed file to static lib target. * Update changelog.
hongshancapital · Jan 6, 2021 · cde2b50 · cde2b50
1 parent c0307e0
commit cde2b50
Show file tree

Hide file tree

Showing 18 changed files with 228 additions and 46 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,5 @@
-## TBD
+## TBD 
+* Removed identity core classes from public api (#1158).
 * Fixed possible deadlock caused by thread explosion
 * Added pipeline configuration to generate framework for SPM & automate MSAL release.
 

diff --git a/MSAL/MSAL.xcodeproj/project.pbxproj b/MSAL/MSAL.xcodeproj/project.pbxproj
diff --git a/MSAL/src/MSALAuthenticationSchemeBearer+Internal.h b/MSAL/src/MSALAuthenticationSchemeBearer+Internal.h
@@ -0,0 +1,36 @@
+//
+// 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 <MSAL/MSAL.h>
+#import "MSALAuthenticationSchemeBearer.h"
+#import "MSALAuthenticationSchemeProtocolInternal.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface MSALAuthenticationSchemeBearer () <MSALAuthenticationSchemeProtocolInternal>
+
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/MSAL/src/MSALAuthenticationSchemeBearer.m b/MSAL/src/MSALAuthenticationSchemeBearer.m
@@ -25,7 +25,7 @@
 //
 //------------------------------------------------------------------------------
 
-#import "MSALAuthenticationSchemeBearer.h"
+#import "MSALAuthenticationSchemeBearer+Internal.h"
 #import "MSIDAuthenticationScheme.h"
 #import "MSALAuthScheme.h"
 #import "MSIDAccessToken.h"
@@ -45,6 +45,15 @@ - (instancetype)init
     return self;
 }
 
+#pragma mark - MSALAuthenticationSchemeProtocol
+
+- (NSString *)authenticationScheme
+{
+    return MSALParameterStringForAuthScheme(self.scheme);
+}
+
+#pragma mark - MSALAuthenticationSchemeProtocolInternal
+
 - (MSIDAuthenticationScheme *)createMSIDAuthenticationSchemeWithParams:(nullable NSDictionary *)params
 {
     return [[MSIDAuthenticationScheme alloc] initWithSchemeParameters:params];
@@ -60,11 +69,6 @@ - (NSString *)getClientAccessToken:(MSIDAccessToken *)accessToken popManager:(nu
     return accessToken.accessToken;
 }
 
-- (NSString *)authenticationScheme
-{
-    return MSALParameterStringForAuthScheme(self.scheme);
-}
-
 - (NSString *)getAuthorizationHeader:(NSString *)accessToken
 {
     return [NSString stringWithFormat:@"%@%@%@", self.authenticationScheme, keyDelimiter, accessToken];

diff --git a/MSAL/src/MSALAuthenticationSchemePop+Internal.h b/MSAL/src/MSALAuthenticationSchemePop+Internal.h
@@ -0,0 +1,36 @@
+//
+// 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 <MSAL/MSAL.h>
+#import "MSALAuthenticationSchemePop.h"
+#import "MSALAuthenticationSchemeProtocolInternal.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface MSALAuthenticationSchemePop () <MSALAuthenticationSchemeProtocolInternal>
+
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/MSAL/src/MSALAuthenticationSchemePop.m b/MSAL/src/MSALAuthenticationSchemePop.m
@@ -25,7 +25,7 @@
 //
 //------------------------------------------------------------------------------
 
-#import "MSALAuthenticationSchemePop.h"
+#import "MSALAuthenticationSchemePop+Internal.h"
 #import "MSIDAuthenticationSchemePop.h"
 #import "MSALHttpMethod.h"
 #import "MSIDDevicePopManager.h"
@@ -65,6 +65,13 @@ - (instancetype)initWithHttpMethod:(MSALHttpMethod)httpMethod
     return self;
 }
 
+- (NSString *)authenticationScheme
+{
+    return MSALParameterStringForAuthScheme(self.scheme);
+}
+
+#pragma mark - MSALAuthenticationSchemeProtocolInternal
+
 - (MSIDAuthenticationScheme *)createMSIDAuthenticationSchemeWithParams:(nullable NSDictionary *)params
 {
     return [[MSIDAuthenticationSchemePop alloc] initWithSchemeParameters:params];
@@ -118,11 +125,6 @@ - (nullable NSString *)getClientAccessToken:(MSIDAccessToken *)accessToken popMa
     return signedAccessToken;
 }
 
-- (NSString *)authenticationScheme
-{
-    return MSALParameterStringForAuthScheme(self.scheme);
-}
-
 - (NSString *)getAuthorizationHeader:(NSString *)accessToken
 {
     return [NSString stringWithFormat:@"%@%@%@", self.authenticationScheme, keyDelimiter, accessToken];

diff --git a/MSAL/src/MSALAuthenticationSchemeProtocolInternal.h b/MSAL/src/MSALAuthenticationSchemeProtocolInternal.h
@@ -0,0 +1,48 @@
+//
+// 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>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@class MSIDDevicePopManager;
+@class MSIDAccessToken;
+@class MSIDAuthenticationScheme;
+
+@protocol MSALAuthenticationSchemeProtocolInternal <NSObject>
+
+- (MSIDAuthenticationScheme *)createMSIDAuthenticationSchemeWithParams:(nullable NSDictionary *)params;
+
+- (nullable NSDictionary *)getSchemeParameters:(nonnull MSIDDevicePopManager *)popManager;
+
+- (nullable NSString *)getAuthorizationHeader:(nonnull NSString *)accessToken;
+
+- (nullable NSString *)getClientAccessToken:(MSIDAccessToken *)accessToken
+                                 popManager:(nullable MSIDDevicePopManager *)popManager
+                                      error:(NSError **)error;
+
+
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/MSAL/src/MSALPublicClientApplication.m b/MSAL/src/MSALPublicClientApplication.m
@@ -103,6 +103,7 @@
 #import "MSALPublicClientApplication+SingleAccount.h"
 #import "MSALDeviceInfoProvider.h"
 #import "MSALAuthenticationSchemeProtocol.h"
+#import "MSALAuthenticationSchemeProtocolInternal.h"
 #import "MSIDCurrentRequestTelemetry.h"
 #import "MSIDCacheConfig.h"
 #import "MSIDDevicePopManager.h"
@@ -817,8 +818,16 @@ - (void)acquireTokenSilentWithParameters:(MSALSilentTokenParameters *)parameters
 
     MSIDRequestType requestType = [self requestType];
 
-    NSDictionary *schemeParams = [parameters.authenticationScheme getSchemeParameters:self.popManager];
-    MSIDAuthenticationScheme *msidAuthScheme = [parameters.authenticationScheme createMSIDAuthenticationSchemeWithParams:schemeParams];
+    id<MSALAuthenticationSchemeProtocol, MSALAuthenticationSchemeProtocolInternal>authenticationScheme = [self getInternalAuthenticationSchemeProtocolForScheme:parameters.authenticationScheme withError:&msidError];
+
+    if (msidError)
+    {
+        block(nil, msidError, nil);
+        return;
+    }
+
+    NSDictionary *schemeParams = [authenticationScheme getSchemeParameters:self.popManager];
+    MSIDAuthenticationScheme *msidAuthScheme = [authenticationScheme createMSIDAuthenticationSchemeWithParams:schemeParams];
 
     // add known authorities here.
     MSIDRequestParameters *msidParams = [[MSIDRequestParameters alloc] initWithAuthority:requestAuthority
@@ -1104,8 +1113,16 @@ - (void)acquireTokenWithParameters:(MSALInteractiveTokenParameters *)parameters
 
 #endif
 
-    NSDictionary *schemeParams = [parameters.authenticationScheme getSchemeParameters:self.popManager];
-    MSIDAuthenticationScheme *msidAuthScheme = [parameters.authenticationScheme createMSIDAuthenticationSchemeWithParams:schemeParams];
+    id<MSALAuthenticationSchemeProtocol, MSALAuthenticationSchemeProtocolInternal>authenticationScheme = [self getInternalAuthenticationSchemeProtocolForScheme:parameters.authenticationScheme withError:&msidError];
+
+    if (msidError)
+    {
+        block(nil, msidError, nil);
+        return;
+    }
+
+    NSDictionary *schemeParams = [authenticationScheme getSchemeParameters:self.popManager];
+    MSIDAuthenticationScheme *msidAuthScheme = [authenticationScheme createMSIDAuthenticationSchemeWithParams:schemeParams];
 
     MSIDInteractiveTokenRequestParameters *msidParams =
     [[MSIDInteractiveTokenRequestParameters alloc] initWithAuthority:requestAuthority
@@ -1550,6 +1567,20 @@ + (NSString *)sdkVersion
 
 #pragma mark - Private
 
+- (id<MSALAuthenticationSchemeProtocol, MSALAuthenticationSchemeProtocolInternal>)getInternalAuthenticationSchemeProtocolForScheme:(id<MSALAuthenticationSchemeProtocol>)authenticationScheme
+                                                                                                                         withError:(NSError **)error
+{
+    if (![authenticationScheme conformsToProtocol:@protocol(MSALAuthenticationSchemeProtocolInternal)])
+    {
+        NSError *msidError = MSIDCreateError(MSIDErrorDomain, MSIDErrorInternal, @"authenticationScheme doesn't support MSALAuthenticationSchemeProtocolInternal protocol.", nil, nil, nil, nil, nil, YES);
+        if (error) *error = msidError;
+
+        return nil;
+    }
+
+    return (id<MSALAuthenticationSchemeProtocol, MSALAuthenticationSchemeProtocolInternal>)authenticationScheme;
+}
+
 - (MSIDRequestType)requestType
 {
     MSIDRequestType requestType = MSIDRequestBrokeredType;

diff --git a/MSAL/src/MSALResult+Internal.h b/MSAL/src/MSALResult+Internal.h
@@ -29,13 +29,14 @@
 
 @class MSIDTokenResult;
 @protocol MSALAuthenticationSchemeProtocol;
+@protocol MSALAuthenticationSchemeProtocolInternal;
 @class MSIDDevicePopManager;
 
 @interface MSALResult (Internal)
 
 + (MSALResult *)resultWithMSIDTokenResult:(MSIDTokenResult *)tokenResult
                                 authority:(MSALAuthority *)authority
-                               authScheme:(id<MSALAuthenticationSchemeProtocol>)authScheme
+                               authScheme:(id<MSALAuthenticationSchemeProtocol, MSALAuthenticationSchemeProtocolInternal>)authScheme
                                popManager:(MSIDDevicePopManager *)popManager
                                     error:(NSError **)error;
 

diff --git a/MSAL/src/MSALResult.m b/MSAL/src/MSALResult.m
@@ -43,10 +43,11 @@
 #import "MSALTenantProfile+Internal.h"
 #import "MSIDDevicePopManager.h"
 #import "MSALAuthenticationSchemeProtocol.h"
+#import "MSALAuthenticationSchemeProtocolInternal.h"
 
 @interface MSALResult()
 
-@property id<MSALAuthenticationSchemeProtocol> authScheme;
+@property id<MSALAuthenticationSchemeProtocol, MSALAuthenticationSchemeProtocolInternal> authScheme;
 
 @end
 
@@ -77,7 +78,7 @@ + (MSALResult *)resultWithAccessToken:(NSString *)accessToken
                                scopes:(NSArray<NSString *> *)scopes
                             authority:(MSALAuthority *)authority
                         correlationId:(NSUUID *)correlationId
-                           authScheme:(id<MSALAuthenticationSchemeProtocol>)authScheme
+                           authScheme:(id<MSALAuthenticationSchemeProtocol, MSALAuthenticationSchemeProtocolInternal>)authScheme
 {
     MSALResult *result = [MSALResult new];
     result->_accessToken = accessToken;
@@ -97,7 +98,7 @@ + (MSALResult *)resultWithAccessToken:(NSString *)accessToken
 
 + (MSALResult *)resultWithMSIDTokenResult:(MSIDTokenResult *)tokenResult
                                 authority:(MSALAuthority *)authority
-                               authScheme:(id<MSALAuthenticationSchemeProtocol>)authScheme
+                               authScheme:(id<MSALAuthenticationSchemeProtocol, MSALAuthenticationSchemeProtocolInternal>)authScheme
                                popManager:(MSIDDevicePopManager *)popManager
                                     error:(NSError **)error
 {

diff --git a/MSAL/src/instance/oauth2/MSALOauth2Provider.m b/MSAL/src/instance/oauth2/MSALOauth2Provider.m
@@ -57,7 +57,7 @@ - (instancetype)initWithClientId:(NSString *)clientId
 }
 
 - (MSALResult *)resultWithTokenResult:(MSIDTokenResult *)tokenResult
-                           authScheme:(id<MSALAuthenticationSchemeProtocol>)authScheme
+                           authScheme:(id<MSALAuthenticationSchemeProtocol, MSALAuthenticationSchemeProtocolInternal>)authScheme
                            popManager:(MSIDDevicePopManager *)popManager
                                 error:(NSError **)error
 {

diff --git a/MSAL/src/instance/oauth2/aad/MSALAADOauth2Provider.m b/MSAL/src/instance/oauth2/aad/MSALAADOauth2Provider.m
@@ -50,7 +50,7 @@ @implementation MSALAADOauth2Provider
 #pragma mark - Public
 
 - (MSALResult *)resultWithTokenResult:(MSIDTokenResult *)tokenResult
-                           authScheme:(id<MSALAuthenticationSchemeProtocol>)authScheme
+                           authScheme:(id<MSALAuthenticationSchemeProtocol, MSALAuthenticationSchemeProtocolInternal>)authScheme
                            popManager:(MSIDDevicePopManager *)popManager
                                 error:(NSError **)error
 {

diff --git a/MSAL/src/instance/oauth2/adfs/MSALADFSOauth2Provider.m b/MSAL/src/instance/oauth2/adfs/MSALADFSOauth2Provider.m
@@ -38,7 +38,7 @@ @implementation MSALADFSOauth2Provider
 #pragma mark - Public
 
 - (MSALResult *)resultWithTokenResult:(MSIDTokenResult *)tokenResult
-                           authScheme:(id<MSALAuthenticationSchemeProtocol>)authScheme
+                           authScheme:(id<MSALAuthenticationSchemeProtocol, MSALAuthenticationSchemeProtocolInternal>)authScheme
                            popManager:(MSIDDevicePopManager *)popManager
                                 error:(NSError **)error
 {

diff --git a/MSAL/src/instance/oauth2/b2c/MSALB2COauth2Provider.m b/MSAL/src/instance/oauth2/b2c/MSALB2COauth2Provider.m
@@ -46,7 +46,7 @@ @implementation MSALB2COauth2Provider
 #pragma mark - Public
 
 - (MSALResult *)resultWithTokenResult:(MSIDTokenResult *)tokenResult
-                           authScheme:(id<MSALAuthenticationSchemeProtocol>)authScheme
+                           authScheme:(id<MSALAuthenticationSchemeProtocol, MSALAuthenticationSchemeProtocolInternal>)authScheme
                            popManager:(MSIDDevicePopManager *)popManager
                                 error:(NSError **)error
 {

diff --git a/MSAL/src/public/MSALAuthenticationSchemeProtocol.h b/MSAL/src/public/MSALAuthenticationSchemeProtocol.h
@@ -27,10 +27,6 @@
 
 #import <Foundation/Foundation.h>
 
-@class MSIDDevicePopManager;
-@class MSIDAccessToken;
-@class MSIDAuthenticationScheme;
-
 NS_ASSUME_NONNULL_BEGIN
 
 @protocol MSALAuthenticationSchemeProtocol <NSObject>
@@ -39,16 +35,6 @@ NS_ASSUME_NONNULL_BEGIN
 
 @property (nonatomic, readonly) NSString *authenticationScheme;
 
-- (MSIDAuthenticationScheme *)createMSIDAuthenticationSchemeWithParams:(nullable NSDictionary *)params;
-
-- (nullable NSDictionary *)getSchemeParameters:(nonnull MSIDDevicePopManager *)popManager;
-
-- (nullable NSString *)getAuthorizationHeader:(nonnull NSString *)accessToken;
-
-- (nullable NSString *)getClientAccessToken:(MSIDAccessToken *)accessToken
-                                 popManager:(nullable MSIDDevicePopManager *)popManager
-                                      error:(NSError **)error;
-
 @end
 
 NS_ASSUME_NONNULL_END
diff --git a/MSAL/src/public/MSALAuthority.h b/MSAL/src/public/MSALAuthority.h
@@ -27,8 +27,6 @@
 
 #import <Foundation/Foundation.h>
 
-@protocol MSIDRequestContext;
-
 /**
     MSALAuthority represents an identity provider instance that MSAL can use to obtain tokens. For AAD it is of the form https://aad_instance/aad_tenant, where aad_instance is the
     directory host (e.g. https://login.microsoftonline.com) and aad_tenant is a identifier within the directory itself (e.g. a domain associated to the tenant, such as contoso.onmicrosoft.com, or the GUID representing the TenantID property of the directory)