Reworking the changes so that it stays compatible with previous version

AppAuth.xcodeproj/project.pbxproj

@@ -370,6 +370,10 @@
 		60140F801DE4344200DA0DC3 /* OIDRegistrationResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = 60140F7F1DE4344200DA0DC3 /* OIDRegistrationResponse.m */; };
 		60140F831DE43BAF00DA0DC3 /* OIDRegistrationRequestTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 60140F821DE43BAF00DA0DC3 /* OIDRegistrationRequestTests.m */; };
 		60140F861DE43CC700DA0DC3 /* OIDRegistrationResponseTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 60140F851DE43CC700DA0DC3 /* OIDRegistrationResponseTests.m */; };
+		A6339DAA20321ADD0043D1C9 /* OIDAuthorizationFlowSession.h in Headers */ = {isa = PBXBuildFile; fileRef = A6339DA3203211320043D1C9 /* OIDAuthorizationFlowSession.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		A6339DAB20321AE50043D1C9 /* OIDAuthorizationFlowSession.h in Headers */ = {isa = PBXBuildFile; fileRef = A6339DA3203211320043D1C9 /* OIDAuthorizationFlowSession.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		A6339DAC20321AE70043D1C9 /* OIDAuthorizationFlowSession.h in Headers */ = {isa = PBXBuildFile; fileRef = A6339DA3203211320043D1C9 /* OIDAuthorizationFlowSession.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		A6339DAD20321AEB0043D1C9 /* OIDAuthorizationFlowSession.h in Headers */ = {isa = PBXBuildFile; fileRef = A6339DA3203211320043D1C9 /* OIDAuthorizationFlowSession.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		A6DEAB9B2018E4AD0022AC32 /* OIDExternalUserAgentUICoordinator.h in Headers */ = {isa = PBXBuildFile; fileRef = A6DEAB982018E4A20022AC32 /* OIDExternalUserAgentUICoordinator.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		A6DEAB9C2018E4AD0022AC32 /* OIDExternalUserAgentUICoordinator.h in Headers */ = {isa = PBXBuildFile; fileRef = A6DEAB982018E4A20022AC32 /* OIDExternalUserAgentUICoordinator.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		A6DEAB9D2018E4AD0022AC32 /* OIDExternalUserAgentUICoordinator.h in Headers */ = {isa = PBXBuildFile; fileRef = A6DEAB982018E4A20022AC32 /* OIDExternalUserAgentUICoordinator.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -565,6 +569,7 @@
 		60140F821DE43BAF00DA0DC3 /* OIDRegistrationRequestTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OIDRegistrationRequestTests.m; sourceTree = "<group>"; };
 		60140F841DE43C8C00DA0DC3 /* OIDRegistrationResponseTests.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OIDRegistrationResponseTests.h; sourceTree = "<group>"; };
 		60140F851DE43CC700DA0DC3 /* OIDRegistrationResponseTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OIDRegistrationResponseTests.m; sourceTree = "<group>"; };
+		A6339DA3203211320043D1C9 /* OIDAuthorizationFlowSession.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OIDAuthorizationFlowSession.h; sourceTree = "<group>"; };
 		A6DEAB982018E4A20022AC32 /* OIDExternalUserAgentUICoordinator.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OIDExternalUserAgentUICoordinator.h; sourceTree = "<group>"; };
 		A6DEAB992018E4A20022AC32 /* OIDExternalUserAgentFlowSession.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OIDExternalUserAgentFlowSession.h; sourceTree = "<group>"; };
 		A6DEAB9A2018E4A20022AC32 /* OIDExternalUserAgentRequest.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OIDExternalUserAgentRequest.h; sourceTree = "<group>"; };
@@ -740,6 +745,7 @@
 				340DAE241D581FE700EC285B /* macOS */,
 				F6F60FAF1D2BFEF000325CB3 /* iOS */,
 				341741AF1C5D8243000EF209 /* AppAuth.h */,
+				A6339DA3203211320043D1C9 /* OIDAuthorizationFlowSession.h */,
 				341741B41C5D8243000EF209 /* OIDAuthorizationRequest.h */,
 				341741B51C5D8243000EF209 /* OIDAuthorizationRequest.m */,
 				341741B61C5D8243000EF209 /* OIDAuthorizationResponse.h */,
@@ -748,9 +754,6 @@
 				341741B91C5D8243000EF209 /* OIDAuthorizationService.m */,
 				341741BA1C5D8243000EF209 /* OIDAuthState.h */,
 				341741BB1C5D8243000EF209 /* OIDAuthState.m */,
-				A6DEAB992018E4A20022AC32 /* OIDExternalUserAgentFlowSession.h */,
-				A6DEAB9A2018E4A20022AC32 /* OIDExternalUserAgentRequest.h */,
-				A6DEAB982018E4A20022AC32 /* OIDExternalUserAgentUICoordinator.h */,
 				341741BC1C5D8243000EF209 /* OIDAuthStateChangeDelegate.h */,
 				341741BD1C5D8243000EF209 /* OIDAuthStateErrorDelegate.h */,
 				60140F781DE4262000DA0DC3 /* OIDClientMetadataParameters.h */,
@@ -760,6 +763,9 @@
 				341741C01C5D8243000EF209 /* OIDError.m */,
 				341741C11C5D8243000EF209 /* OIDErrorUtilities.h */,
 				341741C21C5D8243000EF209 /* OIDErrorUtilities.m */,
+				A6DEAB992018E4A20022AC32 /* OIDExternalUserAgentFlowSession.h */,
+				A6DEAB9A2018E4A20022AC32 /* OIDExternalUserAgentRequest.h */,
+				A6DEAB982018E4A20022AC32 /* OIDExternalUserAgentUICoordinator.h */,
 				341741C31C5D8243000EF209 /* OIDFieldMapping.h */,
 				341741C41C5D8243000EF209 /* OIDFieldMapping.m */,
 				60140F7E1DE4335200DA0DC3 /* OIDRegistrationResponse.h */,
@@ -909,6 +915,7 @@
 				343AAAF91E83499000F9D36E /* OIDTokenUtilities.h in Headers */,
 				343AAAEC1E83499000F9D36E /* OIDError.h in Headers */,
 				A6DEABAB2018E5C50022AC32 /* OIDExternalUserAgentUICoordinatorIOS.h in Headers */,
+				A6339DAA20321ADD0043D1C9 /* OIDAuthorizationFlowSession.h in Headers */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -936,6 +943,7 @@
 				343AAB101E83499100F9D36E /* OIDTokenResponse.h in Headers */,
 				343AAAFC1E83499100F9D36E /* OIDAuthorizationResponse.h in Headers */,
 				343AAB0C1E83499100F9D36E /* OIDScopeUtilities.h in Headers */,
+				A6339DAB20321AE50043D1C9 /* OIDAuthorizationFlowSession.h in Headers */,
 				343AAB011E83499100F9D36E /* OIDAuthStateErrorDelegate.h in Headers */,
 				343AAAFB1E83499100F9D36E /* OIDAuthorizationRequest.h in Headers */,
 				343AAB051E83499100F9D36E /* OIDErrorUtilities.h in Headers */,
@@ -966,6 +974,7 @@
 				343AAB281E83499200F9D36E /* OIDTokenResponse.h in Headers */,
 				343AAB141E83499200F9D36E /* OIDAuthorizationResponse.h in Headers */,
 				343AAB241E83499200F9D36E /* OIDScopeUtilities.h in Headers */,
+				A6339DAC20321AE70043D1C9 /* OIDAuthorizationFlowSession.h in Headers */,
 				343AAB191E83499200F9D36E /* OIDAuthStateErrorDelegate.h in Headers */,
 				343AAB131E83499200F9D36E /* OIDAuthorizationRequest.h in Headers */,
 				343AAB1D1E83499200F9D36E /* OIDErrorUtilities.h in Headers */,
@@ -998,6 +1007,7 @@
 				343AAAE11E83494A00F9D36E /* OIDLoopbackHTTPServer.h in Headers */,
 				343AAB311E83499200F9D36E /* OIDAuthStateErrorDelegate.h in Headers */,
 				343AAB2F1E83499200F9D36E /* OIDAuthState.h in Headers */,
+				A6339DAD20321AEB0043D1C9 /* OIDAuthorizationFlowSession.h in Headers */,
 				343AAB3E1E83499200F9D36E /* OIDServiceDiscovery.h in Headers */,
 				A6DEAB9E2018E4AE0022AC32 /* OIDExternalUserAgentUICoordinator.h in Headers */,
 				343AAADE1E83494400F9D36E /* OIDAuthorizationService+Mac.h in Headers */,

Source/AppAuth.h

@@ -17,13 +17,15 @@
  */
 
 #import "OIDAuthState.h"
+#import "OIDAuthorizationFlowSession.h"
 #import "OIDAuthStateChangeDelegate.h"
 #import "OIDAuthStateErrorDelegate.h"
 #import "OIDAuthorizationRequest.h"
 #import "OIDAuthorizationResponse.h"
 #import "OIDAuthorizationService.h"
 #import "OIDError.h"
 #import "OIDErrorUtilities.h"
+#import "OIDExternalUserAgentFlowSession.h"
 #import "OIDExternalUserAgentUICoordinator.h"
 #import "OIDGrantTypes.h"
 #import "OIDRegistrationRequest.h"

Source/OIDAuthState.h

@@ -23,6 +23,7 @@
 @class OIDRegistrationResponse;
 @class OIDTokenResponse;
 @class OIDTokenRequest;
+@protocol OIDAuthorizationFlowSession;
 @protocol OIDAuthStateChangeDelegate;
 @protocol OIDAuthStateErrorDelegate;
 @protocol OIDExternalUserAgentUICoordinator;
@@ -148,7 +149,7 @@ typedef void (^OIDAuthStateAuthorizationCallback)(OIDAuthState *_Nullable authSt
         receives a @c OIDExternalUserAgentFlowSession.cancel message, or after processing a
         @c OIDExternalUserAgentFlowSession.resumeExternalUserAgentFlowWithURL: message.
  */
-+ (id<OIDExternalUserAgentFlowSession>)
++ (id<OIDExternalUserAgentFlowSession, OIDAuthorizationFlowSession>)
     authStateByPresentingAuthorizationRequest:(OIDAuthorizationRequest *)authorizationRequest
                                 UICoordinator:(id<OIDExternalUserAgentUICoordinator>)UICoordinator
                                      callback:(OIDAuthStateAuthorizationCallback)callback;

Source/OIDAuthState.m

@@ -104,12 +104,12 @@ @implementation OIDAuthState
 
 #pragma mark - Convenience initializers
 
-+ (id<OIDExternalUserAgentFlowSession>)
++ (id<OIDExternalUserAgentFlowSession, OIDAuthorizationFlowSession>)
     authStateByPresentingAuthorizationRequest:(OIDAuthorizationRequest *)authorizationRequest
                                 UICoordinator:(id<OIDExternalUserAgentUICoordinator>)UICoordinator
                                      callback:(OIDAuthStateAuthorizationCallback)callback {
   // presents the authorization request
-  id<OIDExternalUserAgentFlowSession> authFlowSession = [OIDAuthorizationService
+  id<OIDExternalUserAgentFlowSession, OIDAuthorizationFlowSession> authFlowSession = [OIDAuthorizationService
       presentAuthorizationRequest:authorizationRequest
                     UICoordinator:UICoordinator
                          callback:^(OIDAuthorizationResponse *_Nullable authorizationResponse,

Source/OIDAuthorizationFlowSession.h

@@ -0,0 +1,42 @@
+/*! @file OIDAuthorizationRequest.h
+    @brief AppAuth iOS SDK
+    @copyright
+        Copyright 2015 Google Inc. All Rights Reserved.
+    @copydetails
+        Licensed under the Apache License, Version 2.0 (the "License");
+        you may not use this file except in compliance with the License.
+        You may obtain a copy of the License at
+ 
+        http://www.apache.org/licenses/LICENSE-2.0
+ 
+        Unless required by applicable law or agreed to in writing, software
+        distributed under the License is distributed on an "AS IS" BASIS,
+        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+        See the License for the specific language governing permissions and
+        limitations under the License.
+ */
+
+/*! @brief Represents an in-flight authorization flow session.
+ */
+@protocol OIDAuthorizationFlowSession <NSObject>
+
+/*! @brief Clients should call this method with the result of the authorization code flow if it
+        becomes available.
+    @param URL The redirect URL invoked by the authorization server.
+    @discussion When the URL represented a valid authorization response, implementations
+        should clean up any left-over UI state from the authorization, for example by
+        closing the \SFSafariViewController or looback HTTP listener if those were used.
+        The completion block of the pending authorization request should then be invoked.
+    @remarks Has no effect if called more than once, or after a @c cancel message was received.
+    @return YES if the passed URL matches the expected redirect URL and was consumed, NO otherwise.
+ */
+- (BOOL)resumeAuthorizationFlowWithURL:(NSURL *)URL;
+
+/*! @brief @c OIDAuthorizationUICoordinator or clients should call this method when the
+        authorization flow failed with a non-OAuth error.
+    @param error The error that is the reason for the failure of this authorization flow.
+    @remarks Has no effect if called more than once, or after a @c cancel message was received.
+ */
+- (void)failAuthorizationFlowWithError:(NSError *)error;
+
+@end

Source/OIDAuthorizationService.h

@@ -26,6 +26,7 @@
 @class OIDServiceConfiguration;
 @class OIDTokenRequest;
 @class OIDTokenResponse;
+@protocol OIDAuthorizationFlowSession;
 @protocol OIDExternalUserAgentFlowSession;
 @protocol OIDExternalUserAgentUICoordinator;
 
@@ -119,7 +120,7 @@ typedef void (^OIDRegistrationCompletion)(OIDRegistrationResponse *_Nullable reg
         receives a @c OIDExternalUserAgentFlowSession.cancel message, or after processing a
         @c OIDExternalUserAgentFlowSession.resumeExternalUserAgentFlowWithURL: message.
  */
-+ (id<OIDExternalUserAgentFlowSession>)
++ (id<OIDExternalUserAgentFlowSession, OIDAuthorizationFlowSession>)
     presentAuthorizationRequest:(OIDAuthorizationRequest *)request
                   UICoordinator:(id<OIDExternalUserAgentUICoordinator>)UICoordinator
                        callback:(OIDAuthorizationCallback)callback;

Source/OIDAuthorizationService.m

@@ -22,6 +22,7 @@
 #import "OIDAuthorizationResponse.h"
 #import "OIDDefines.h"
 #import "OIDErrorUtilities.h"
+#import "OIDAuthorizationFlowSession.h"
 #import "OIDExternalUserAgentFlowSession.h"
 #import "OIDExternalUserAgentUICoordinator.h"
 #import "OIDRegistrationRequest.h"
@@ -41,7 +42,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-@interface OIDAuthorizationFlowSessionImplementation : NSObject<OIDExternalUserAgentFlowSession> {
+@interface OIDAuthorizationFlowSessionImplementation : NSObject<OIDExternalUserAgentFlowSession, OIDAuthorizationFlowSession> {
   // private variables
   OIDAuthorizationRequest *_request;
   id<OIDExternalUserAgentUICoordinator> _UICoordinator;
@@ -170,6 +171,14 @@ - (void)didFinishWithResponse:(nullable OIDAuthorizationResponse *)response
   }
 }
 
+- (void)failAuthorizationFlowWithError:(NSError *)error {
+  [self failAuthorizationFlowWithError:error];
+}
+
+- (BOOL)resumeAuthorizationFlowWithURL:(NSURL *)URL {
+  return [self resumeExternalUserAgentFlowWithURL:URL];
+}
+
 @end
 
 @implementation OIDAuthorizationService
@@ -244,7 +253,7 @@ + (void)discoverServiceConfigurationForDiscoveryURL:(NSURL *)discoveryURL
 
 #pragma mark - Authorization Endpoint
 
-+ (id<OIDExternalUserAgentFlowSession>)
++ (id<OIDExternalUserAgentFlowSession, OIDAuthorizationFlowSession>)
     presentAuthorizationRequest:(OIDAuthorizationRequest *)request
                   UICoordinator:(id<OIDExternalUserAgentUICoordinator>)UICoordinator
                        callback:(OIDAuthorizationCallback)callback {

Source/iOS/OIDAuthState+IOS.h

@@ -36,7 +36,7 @@ NS_ASSUME_NONNULL_BEGIN
         receives a @c OIDExternalUserAgentFlowSession.cancel message, or after processing a
         @c OIDExternalUserAgentFlowSession.resumeExternalUserAgentFlowWithURL: message.
  */
-+ (id<OIDExternalUserAgentFlowSession>)
++ (id<OIDExternalUserAgentFlowSession, OIDAuthorizationFlowSession>)
     authStateByPresentingAuthorizationRequest:(OIDAuthorizationRequest *)authorizationRequest
                      presentingViewController:(UIViewController *)presentingViewController
                                      callback:(OIDAuthStateAuthorizationCallback)callback;

Source/iOS/OIDAuthState+IOS.m

@@ -22,7 +22,7 @@
 
 @implementation OIDAuthState (IOS)
 
-+ (id<OIDExternalUserAgentFlowSession>)
++ (id<OIDExternalUserAgentFlowSession, OIDAuthorizationFlowSession>)
     authStateByPresentingAuthorizationRequest:(OIDAuthorizationRequest *)authorizationRequest
                      presentingViewController:(UIViewController *)presentingViewController
                                      callback:(OIDAuthStateAuthorizationCallback)callback {

Source/iOS/OIDAuthorizationService+IOS.h

@@ -36,7 +36,7 @@ NS_ASSUME_NONNULL_BEGIN
         receives a @c OIDExternalUserAgentFlowSession.cancel message, or after processing a
         @c OIDExternalUserAgentFlowSession.resumeExternalUserAgentFlowWithURL: message.
  */
-+ (id<OIDExternalUserAgentFlowSession>)
++ (id<OIDExternalUserAgentFlowSession, OIDAuthorizationFlowSession>)
     presentAuthorizationRequest:(OIDAuthorizationRequest *)request
        presentingViewController:(UIViewController *)presentingViewController
                        callback:(OIDAuthorizationCallback)callback;

Source/iOS/OIDAuthorizationService+IOS.m

@@ -24,7 +24,7 @@
 
 @implementation OIDAuthorizationService (IOS)
 
-+ (id<OIDExternalUserAgentFlowSession>)
++ (id<OIDExternalUserAgentFlowSession, OIDAuthorizationFlowSession>)
     presentAuthorizationRequest:(OIDAuthorizationRequest *)request
        presentingViewController:(UIViewController *)presentingViewController
                        callback:(OIDAuthorizationCallback)callback {

Source/macOS/OIDAuthState+Mac.h

@@ -32,7 +32,7 @@ NS_ASSUME_NONNULL_BEGIN
         receives a @c OIDExternalUserAgentFlowSession.cancel message, or after processing a
         @c OIDExternalUserAgentFlowSession.resumeExternalUserAgentFlowWithURL: message.
  */
-+ (id<OIDExternalUserAgentFlowSession>)
++ (id<OIDExternalUserAgentFlowSession, OIDAuthorizationFlowSession>)
     authStateByPresentingAuthorizationRequest:(OIDAuthorizationRequest *)authorizationRequest
                                      callback:(OIDAuthStateAuthorizationCallback)callback;
 @end

Source/macOS/OIDAuthState+Mac.m

@@ -22,7 +22,7 @@
 
 @implementation OIDAuthState (Mac)
 
-+ (id<OIDExternalUserAgentFlowSession>)
++ (id<OIDExternalUserAgentFlowSession, OIDAuthorizationFlowSession>)
     authStateByPresentingAuthorizationRequest:(OIDAuthorizationRequest *)authorizationRequest
                                      callback:(OIDAuthStateAuthorizationCallback)callback {
   OIDExternalUserAgentUICoordinatorMac *coordinator = [[OIDExternalUserAgentUICoordinatorMac alloc] init];

Source/macOS/OIDAuthorizationService+Mac.h

@@ -31,7 +31,7 @@ NS_ASSUME_NONNULL_BEGIN
         receives a @c OIDExternalUserAgentFlowSession.cancel message, or after processing a
         @c OIDExternalUserAgentFlowSession.resumeExternalUserAgentFlowWithURL: message.
  */
-+ (id<OIDExternalUserAgentFlowSession>)presentAuthorizationRequest:(OIDAuthorizationRequest *)request
++ (id<OIDExternalUserAgentFlowSession, OIDAuthorizationFlowSession>)presentAuthorizationRequest:(OIDAuthorizationRequest *)request
                                                   callback:(OIDAuthorizationCallback)callback;
 @end
 

Source/macOS/OIDAuthorizationService+Mac.m

@@ -24,7 +24,7 @@
 
 @implementation OIDAuthorizationService (Mac)
 
-+ (id<OIDExternalUserAgentFlowSession>)presentAuthorizationRequest:(OIDAuthorizationRequest *)request
++ (id<OIDExternalUserAgentFlowSession, OIDAuthorizationFlowSession>)presentAuthorizationRequest:(OIDAuthorizationRequest *)request
                                                   callback:(OIDAuthorizationCallback)callback {
   OIDExternalUserAgentUICoordinatorMac *coordinator = [[OIDExternalUserAgentUICoordinatorMac alloc] init];
   return [self presentAuthorizationRequest:request UICoordinator:coordinator callback:callback];

Source/macOS/OIDRedirectHTTPHandler.h

@@ -21,6 +21,7 @@
 NS_ASSUME_NONNULL_BEGIN
 
 @class HTTPServer;
+@protocol OIDAuthorizationFlowSession;
 @protocol OIDExternalUserAgentFlowSession;
 
 /*! @brief Start a HTTP server on the loopback interface (i.e. @c 127.0.0.1) to receive the OAuth
@@ -31,7 +32,7 @@ NS_ASSUME_NONNULL_BEGIN
   HTTPServer *_httpServ;
   NSURL *_successURL;
   // property variables
-  NSObject<OIDExternalUserAgentFlowSession> *_currentExternalUserAgentFlow;
+  NSObject<OIDExternalUserAgentFlowSession, OIDAuthorizationFlowSession> *_currentAuthorizationFlow;
 }
 
 /*! @brief The external user-agent request flow session which receives the return URL from the
@@ -40,7 +41,8 @@ NS_ASSUME_NONNULL_BEGIN
         redirect handler to continue the flow. This should be set while an external user-agent
         request flow is in progress.
  */
-@property(nonatomic, strong, nullable) id<OIDExternalUserAgentFlowSession> currentExternalUserAgentFlow;
+@property(nonatomic, strong, nullable) id<OIDExternalUserAgentFlowSession,
+    OIDAuthorizationFlowSession> currentAuthorizationFlow;
 
 /*! @brief Creates an a loopback HTTP redirect URI handler with the given success URL.
     @param successURL The URL that the user is redirected to after the request flow completes