Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
/*! @file OIDExternalUserAgentIOSSafariViewController.h
@brief AppAuth iOS SDK
@copyright
Copyright 2018 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.
*/
#import <UIKit/UIKit.h>
#import "OIDExternalUserAgentIOSSafariViewController.h"
#import "OIDExternalUserAgent.h"
#import "OIDExternalUserAgentIOS.h"
NS_ASSUME_NONNULL_BEGIN
/*! @brief Allows library consumers to bootstrap an @c SFSafariViewController as they see fit.
@remarks Useful for customizing tint colors and presentation styles.
*/
@protocol OIDSafariViewControllerFactory
/*! @brief Creates and returns a new @c SFSafariViewController.
@param URL The URL which the @c SFSafariViewController should load initially.
*/
- (SFSafariViewController *)safariViewControllerWithURL:(NSURL *)URL;
@end
/*! @brief A special-case iOS external user-agent that always uses
\SFSafariViewController (on iOS 9+). Most applications should use
the more generic @c OIDExternalUserAgentIOS to get the default
AppAuth user-agent handling with the benefits of Single Sign-on (SSO)
for all supported versions of iOS.
*/
@interface OIDExternalUserAgentIOSSafariViewController : NSObject<OIDExternalUserAgent>
/*! @brief Allows library consumers to change the @c OIDSafariViewControllerFactory used to create
new instances of @c SFSafariViewController.
@remarks Useful for customizing tint colors and presentation styles.
@param factory The @c OIDSafariViewControllerFactory to use for creating new instances of
@c SFSafariViewController.
*/
+ (void)setSafariViewControllerFactory:(id<OIDSafariViewControllerFactory>)factory;
/*! @internal
@brief Unavailable. Please use @c initWithPresentingViewController:
*/
- (nonnull instancetype)init NS_UNAVAILABLE;
/*! @brief The designated initializer.
@param presentingViewController The view controller from which to present the
\SFSafariViewController.
*/
- (nullable instancetype)initWithPresentingViewController:
(UIViewController *)presentingViewController
NS_DESIGNATED_INITIALIZER;
@end
NS_ASSUME_NONNULL_END
/*! @file OIDExternalUserAgentIOSSafariViewController.m
@brief AppAuth iOS SDK
@copyright
Copyright 2018 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.
*/
#import "OIDExternalUserAgentIOSSafariViewController.h"
#import <SafariServices/SafariServices.h>
#import "OIDErrorUtilities.h"
#import "OIDExternalUserAgentSession.h"
#import "OIDExternalUserAgentRequest.h"
NS_ASSUME_NONNULL_BEGIN
/** @brief The global/shared Safari view controller factory. Responsible for creating all new
instances of @c SFSafariViewController.
*/
static id<OIDSafariViewControllerFactory> __nullable gSafariViewControllerFactory;
/** @brief The default @c OIDSafariViewControllerFactory which creates new instances of
@c SFSafariViewController using known best practices.
*/
@interface OIDDefaultSafariViewControllerFactory : NSObject<OIDSafariViewControllerFactory>
@end
@interface OIDExternalUserAgentIOSSafariViewController ()<SFSafariViewControllerDelegate>
@end
@implementation OIDExternalUserAgentIOSSafariViewController {
UIViewController *_presentingViewController;
BOOL _externalUserAgentFlowInProgress;
__weak id<OIDExternalUserAgentSession> _session;
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wpartial-availability"
__weak SFSafariViewController *_safariVC;
#pragma clang diagnostic pop
}
/** @brief Obtains the current @c OIDSafariViewControllerFactory; creating a new default instance if
required.
*/
+ (id<OIDSafariViewControllerFactory>)safariViewControllerFactory {
if (!gSafariViewControllerFactory) {
gSafariViewControllerFactory = [[OIDDefaultSafariViewControllerFactory alloc] init];
}
return gSafariViewControllerFactory;
}
+ (void)setSafariViewControllerFactory:(id<OIDSafariViewControllerFactory>)factory {
NSAssert(factory, @"Parameter: |factory| must be non-nil.");
gSafariViewControllerFactory = factory;
}
- (nullable instancetype)initWithPresentingViewController:
(UIViewController *)presentingViewController {
self = [super init];
if (self) {
_presentingViewController = presentingViewController;
}
return self;
}
- (BOOL)presentExternalUserAgentRequest:(id<OIDExternalUserAgentRequest>)request
session:(id<OIDExternalUserAgentSession>)session {
if (_externalUserAgentFlowInProgress) {
// TODO: Handle errors as authorization is already in progress.
return NO;
}
_externalUserAgentFlowInProgress = YES;
_session = session;
BOOL openedSafari = NO;
NSURL *requestURL = [request externalUserAgentRequestURL];
if (@available(iOS 9.0, *)) {
SFSafariViewController *safariVC =
[[[self class] safariViewControllerFactory] safariViewControllerWithURL:requestURL];
safariVC.delegate = self;
_safariVC = safariVC;
[_presentingViewController presentViewController:safariVC animated:YES completion:nil];
openedSafari = YES;
} else {
openedSafari = [[UIApplication sharedApplication] openURL:requestURL];
}
if (!openedSafari) {
[self cleanUp];
NSError *safariError = [OIDErrorUtilities errorWithCode:OIDErrorCodeSafariOpenError
underlyingError:nil
description:@"Unable to open Safari."];
[session failExternalUserAgentFlowWithError:safariError];
}
return openedSafari;
}
- (void)dismissExternalUserAgentAnimated:(BOOL)animated completion:(void (^)(void))completion {
if (!_externalUserAgentFlowInProgress) {
// Ignore this call if there is no authorization flow in progress.
return;
}
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wpartial-availability"
SFSafariViewController *safariVC = _safariVC;
#pragma clang diagnostic pop
[self cleanUp];
if (@available(iOS 9.0, *)) {
if (safariVC) {
[safariVC dismissViewControllerAnimated:YES completion:completion];
} else {
if (completion) completion();
}
} else {
if (completion) completion();
}
}
- (void)cleanUp {
// The weak references to |_safariVC| and |_session| are set to nil to avoid accidentally using
// them while not in an authorization flow.
_safariVC = nil;
_session = nil;
_externalUserAgentFlowInProgress = NO;
}
#pragma mark - SFSafariViewControllerDelegate
- (void)safariViewControllerDidFinish:(SFSafariViewController *)controller NS_AVAILABLE_IOS(9.0) {
if (controller != _safariVC) {
// Ignore this call if the safari view controller do not match.
return;
}
if (!_externalUserAgentFlowInProgress) {
// Ignore this call if there is no authorization flow in progress.
return;
}
id<OIDExternalUserAgentSession> session = _session;
[self cleanUp];
NSError *error = [OIDErrorUtilities errorWithCode:OIDErrorCodeProgramCanceledAuthorizationFlow
underlyingError:nil
description:nil];
[session failExternalUserAgentFlowWithError:error];
}
@end
@implementation OIDDefaultSafariViewControllerFactory
- (SFSafariViewController *)safariViewControllerWithURL:(NSURL *)URL NS_AVAILABLE_IOS(9.0) {
SFSafariViewController *safariViewController =
[[SFSafariViewController alloc] initWithURL:URL entersReaderIfAvailable:NO];
return safariViewController;
}
@end
NS_ASSUME_NONNULL_END
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
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.
@WilliamDenniss

This comment has been minimized.

Copy link
Owner Author

@WilliamDenniss WilliamDenniss commented Jul 12, 2018

Example usage:

  OIDExternalUserAgentIOSSafariViewController *externalUserAgent =
    [[OIDExternalUserAgentIOSSafariViewController alloc] initWithPresentingViewController:self];
  appDelegate.currentAuthorizationFlow =
      [OIDAuthState authStateByPresentingAuthorizationRequest:request
                                                UICoordinator:externalUserAgent
                          callback:^(OIDAuthState *_Nullable authState, NSError *_Nullable error) {
@ugenlik

This comment has been minimized.

Copy link

@ugenlik ugenlik commented Dec 8, 2018

I needed this in swift, so I created a gist, please let me know if violates any licenses or I have to add any licenses to it.

https://gist.github.com/ugenlik/2a543f351e9b9425800b48266760dc85

@WilliamDenniss

This comment has been minimized.

Copy link
Owner Author

@WilliamDenniss WilliamDenniss commented Jun 28, 2019

Cool, thanks for sharing!

@jimocallaghan

This comment has been minimized.

Copy link

@jimocallaghan jimocallaghan commented Aug 5, 2019

Hi, we're looking at using the OIDExternalUserAgentIOSSafariViewController but finding that Safari doesn't recognise the URI scheme for the callback at the end of the flow ("Safari cannot open the page because the address is invalid"), so stops after getting the token, and control never returns until we manually tap the "Done" button (not passing the token back then obviously). Is there anything we can do apart from looking at URL schemes / app links etc. for our app? Is there something obvious we're missing - we were trying this approach to avoid the credential prompt in Safari between app and browser - previously when the redirect URL (://cb?code=T8hUdNuw3KcYPSElz4YBRzO0h1t-Hr65MPgkLvGW&state=10fc200c-0ad9-4d53-b8a8-6d7efefdab5f) was hit at the end of the flow, external Safari returned control to our app and we completed as expected. Thanks for any suggestions.

@WilliamDenniss

This comment has been minimized.

Copy link
Owner Author

@WilliamDenniss WilliamDenniss commented Aug 16, 2019

At a guess, your custom URI scheme is not configured correctly in the app's plist. Check out the READMEs for the AppAuth iOS samples which show how to setup both the plist, and the AppDelegate to accept incoming links.

Also, ://cb?code=T8hUdNuw3KcYPSElz4YBRzO0h1t-Hr65MPgkLvGW&state=10fc200c-0ad9-4d53-b8a8-6d7efefdab5f is not a valid URI, it's missing the scheme completely.

@jimocallaghan

This comment has been minimized.

Copy link

@jimocallaghan jimocallaghan commented Aug 16, 2019

Thanks WilliamDennis it was indeed the custom URI scheme not being configured that caused the problem.

@WilliamDenniss

This comment has been minimized.

Copy link
Owner Author

@WilliamDenniss WilliamDenniss commented Aug 16, 2019

Glad you solved it!

@andriyslyusar

This comment has been minimized.

Copy link

@andriyslyusar andriyslyusar commented Sep 12, 2019

I am using Swift gist https://gist.github.com/WilliamDenniss/18f3779b4a310361bb955cf4e534f29c#gistcomment-2779971. After entering credentials, SafariViewController remain presented with white screen and do not close. Everything works correctly when using default ASWebAuthenticationSession. Do I need any extra configuration?

@Guy783

This comment has been minimized.

Copy link

@Guy783 Guy783 commented May 13, 2020

@avika-narula

This comment has been minimized.

Copy link

@avika-narula avika-narula commented May 18, 2020

I am using Swift gist https://gist.github.com/WilliamDenniss/18f3779b4a310361bb955cf4e534f29c#gistcomment-2779971. After entering credentials, SafariViewController remain presented with white screen and do not close. Everything works correctly when using default ASWebAuthenticationSession. Do I need any extra configuration?

@andriyslyusar were you able to figure out why SafariViewController wouldn't close? I am seeing the same issue. Works fine for me as well when I use ASWebAuthenticationSession, but I need this to work on iOS 12 & 13. Thanks!

@manivel-nagarajan

This comment has been minimized.

Copy link

@manivel-nagarajan manivel-nagarajan commented Jun 7, 2021

Hi @WilliamDennis,

In dismissExternalUserAgentAnimated , you're calling cleanUp method before dismissing the safariVC. So the safariVC will never get dismissed.

We need to call cleanUp after the dismissal of safariVC.

thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment