| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056 |
- // Copyright 2021 Google LLC
- //
- // 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 "GoogleSignIn/Sources/Public/GoogleSignIn/GIDSignIn.h"
- #import "GoogleSignIn/Sources/GIDSignIn_Private.h"
- #import "GoogleSignIn/Sources/Public/GoogleSignIn/GIDAuthentication.h"
- #import "GoogleSignIn/Sources/Public/GoogleSignIn/GIDConfiguration.h"
- #import "GoogleSignIn/Sources/Public/GoogleSignIn/GIDGoogleUser.h"
- #import "GoogleSignIn/Sources/Public/GoogleSignIn/GIDProfileData.h"
- #import "GoogleSignIn/Sources/GIDSignInInternalOptions.h"
- #import "GoogleSignIn/Sources/GIDSignInPreferences.h"
- #import "GoogleSignIn/Sources/GIDCallbackQueue.h"
- #import "GoogleSignIn/Sources/GIDScopes.h"
- #import "GoogleSignIn/Sources/GIDSignInCallbackSchemes.h"
- #import "GoogleSignIn/Sources/GIDAuthStateMigration.h"
- #if TARGET_OS_IOS || TARGET_OS_MACCATALYST
- #import "GoogleSignIn/Sources/GIDEMMErrorHandler.h"
- #endif
- #import "GoogleSignIn/Sources/GIDAuthentication_Private.h"
- #import "GoogleSignIn/Sources/GIDGoogleUser_Private.h"
- #import "GoogleSignIn/Sources/GIDProfileData_Private.h"
- #ifdef SWIFT_PACKAGE
- @import AppAuth;
- @import GTMAppAuth;
- @import GTMSessionFetcherCore;
- #else
- #import <AppAuth/OIDAuthState.h>
- #import <AppAuth/OIDAuthorizationRequest.h>
- #import <AppAuth/OIDAuthorizationResponse.h>
- #import <AppAuth/OIDAuthorizationService.h>
- #import <AppAuth/OIDError.h>
- #import <AppAuth/OIDExternalUserAgentSession.h>
- #import <AppAuth/OIDIDToken.h>
- #import <AppAuth/OIDResponseTypes.h>
- #import <AppAuth/OIDServiceConfiguration.h>
- #import <AppAuth/OIDTokenRequest.h>
- #import <AppAuth/OIDTokenResponse.h>
- #import <AppAuth/OIDURLQueryComponent.h>
- #import <GTMAppAuth/GTMAppAuthFetcherAuthorization+Keychain.h>
- #import <GTMAppAuth/GTMAppAuthFetcherAuthorization.h>
- #import <GTMSessionFetcher/GTMSessionFetcher.h>
- #if TARGET_OS_IOS || TARGET_OS_MACCATALYST
- #import <AppAuth/OIDAuthorizationService+IOS.h>
- #elif TARGET_OS_OSX
- #import <AppAuth/OIDAuthorizationService+Mac.h>
- #endif
- #endif
- NS_ASSUME_NONNULL_BEGIN
- // The name of the query parameter used for logging the restart of auth from EMM callback.
- static NSString *const kEMMRestartAuthParameter = @"emmres";
- // The URL template for the authorization endpoint.
- static NSString *const kAuthorizationURLTemplate = @"https://%@/o/oauth2/v2/auth";
- // The URL template for the token endpoint.
- static NSString *const kTokenURLTemplate = @"https://%@/token";
- // The URL template for the URL to get user info.
- static NSString *const kUserInfoURLTemplate = @"https://%@/oauth2/v3/userinfo?access_token=%@";
- // The URL template for the URL to revoke the token.
- static NSString *const kRevokeTokenURLTemplate = @"https://%@/o/oauth2/revoke?token=%@";
- // Expected path in the URL scheme to be handled.
- static NSString *const kBrowserCallbackPath = @"/oauth2callback";
- // Expected path for EMM callback.
- static NSString *const kEMMCallbackPath = @"/emmcallback";
- // The EMM support version
- static NSString *const kEMMVersion = @"1";
- // The error code for Google Identity.
- NSErrorDomain const kGIDSignInErrorDomain = @"com.google.GIDSignIn";
- // Keychain constants for saving state in the authentication flow.
- static NSString *const kGTMAppAuthKeychainName = @"auth";
- // Basic profile (Fat ID Token / userinfo endpoint) keys
- static NSString *const kBasicProfileEmailKey = @"email";
- static NSString *const kBasicProfilePictureKey = @"picture";
- static NSString *const kBasicProfileNameKey = @"name";
- static NSString *const kBasicProfileGivenNameKey = @"given_name";
- static NSString *const kBasicProfileFamilyNameKey = @"family_name";
- // Parameters in the callback URL coming back from browser.
- static NSString *const kAuthorizationCodeKeyName = @"code";
- static NSString *const kOAuth2ErrorKeyName = @"error";
- static NSString *const kOAuth2AccessDenied = @"access_denied";
- static NSString *const kEMMPasscodeInfoRequiredKeyName = @"emm_passcode_info_required";
- // Error string for unavailable keychain.
- static NSString *const kKeychainError = @"keychain error";
- // Error string for user cancelations.
- static NSString *const kUserCanceledError = @"The user canceled the sign-in flow.";
- // User preference key to detect fresh install of the app.
- static NSString *const kAppHasRunBeforeKey = @"GID_AppHasRunBefore";
- // Maximum retry interval in seconds for the fetcher.
- static const NSTimeInterval kFetcherMaxRetryInterval = 15.0;
- // The delay before the new sign-in flow can be presented after the existing one is cancelled.
- static const NSTimeInterval kPresentationDelayAfterCancel = 1.0;
- // Parameters for the auth and token exchange endpoints.
- static NSString *const kAudienceParameter = @"audience";
- // See b/11669751 .
- static NSString *const kOpenIDRealmParameter = @"openid.realm";
- static NSString *const kIncludeGrantedScopesParameter = @"include_granted_scopes";
- static NSString *const kLoginHintParameter = @"login_hint";
- static NSString *const kHostedDomainParameter = @"hd";
- // Minimum time to expiration for a restored access token.
- static const NSTimeInterval kMinimumRestoredAccessTokenTimeToExpire = 600.0;
- // The callback queue used for authentication flow.
- @interface GIDAuthFlow : GIDCallbackQueue
- @property(nonatomic, strong, nullable) OIDAuthState *authState;
- @property(nonatomic, strong, nullable) NSError *error;
- @property(nonatomic, copy, nullable) NSString *emmSupport;
- @property(nonatomic, nullable) GIDProfileData *profileData;
- @end
- @implementation GIDAuthFlow
- @end
- @implementation GIDSignIn {
- // This value is used when sign-in flows are resumed via the handling of a URL. Its value is
- // set when a sign-in flow is begun via |signInWithOptions:| when the options passed don't
- // represent a sign in continuation.
- GIDSignInInternalOptions *_currentOptions;
- // AppAuth configuration object.
- OIDServiceConfiguration *_appAuthConfiguration;
- // AppAuth external user-agent session state.
- id<OIDExternalUserAgentSession> _currentAuthorizationFlow;
- // Flag to indicate that the auth flow is restarting.
- BOOL _restarting;
- }
- #pragma mark - Public methods
- - (BOOL)handleURL:(NSURL *)url {
- // Check if the callback path matches the expected one for a URL from Safari/Chrome/SafariVC.
- if ([url.path isEqual:kBrowserCallbackPath]) {
- if ([_currentAuthorizationFlow resumeExternalUserAgentFlowWithURL:url]) {
- _currentAuthorizationFlow = nil;
- return YES;
- }
- return NO;
- }
- // Check if the callback path matches the expected one for a URL from Google Device Policy app.
- if ([url.path isEqual:kEMMCallbackPath]) {
- return [self handleDevicePolicyAppURL:url];
- }
- return NO;
- }
- - (BOOL)hasPreviousSignIn {
- if ([_currentUser.authentication.authState isAuthorized]) {
- return YES;
- }
- OIDAuthState *authState = [self loadAuthState];
- return [authState isAuthorized];
- }
- - (void)restorePreviousSignInWithCallback:(nullable GIDSignInCallback)callback {
- [self signInWithOptions:[GIDSignInInternalOptions silentOptionsWithCallback:callback]];
- }
- - (BOOL)restorePreviousSignInNoRefresh {
- if (_currentUser) {
- return YES;
- }
- // Try retrieving an authorization object from the keychain.
- OIDAuthState *authState = [self loadAuthState];
- if (!authState) {
- return NO;
- }
- // Restore current user without refreshing the access token.
- OIDIDToken *idToken =
- [[OIDIDToken alloc] initWithIDTokenString:authState.lastTokenResponse.idToken];
- GIDProfileData *profileData = [self profileDataWithIDToken:idToken];
- GIDGoogleUser *user = [[GIDGoogleUser alloc] initWithAuthState:authState profileData:profileData];
- [self setCurrentUserWithKVO:user];
- return YES;
- }
- #if TARGET_OS_IOS || TARGET_OS_MACCATALYST
- - (void)signInWithConfiguration:(GIDConfiguration *)configuration
- presentingViewController:(UIViewController *)presentingViewController
- hint:(nullable NSString *)hint
- callback:(nullable GIDSignInCallback)callback {
- GIDSignInInternalOptions *options =
- [GIDSignInInternalOptions defaultOptionsWithConfiguration:configuration
- presentingViewController:presentingViewController
- loginHint:hint
- addScopesFlow:NO
- callback:callback];
- [self signInWithOptions:options];
- }
- - (void)signInWithConfiguration:(GIDConfiguration *)configuration
- presentingViewController:(UIViewController *)presentingViewController
- hint:(nullable NSString *)hint
- additionalScopes:(nullable NSArray<NSString *> *)additionalScopes
- callback:(nullable GIDSignInCallback)callback {
- GIDSignInInternalOptions *options =
- [GIDSignInInternalOptions defaultOptionsWithConfiguration:configuration
- presentingViewController:presentingViewController
- loginHint:hint
- addScopesFlow:NO
- scopes:additionalScopes
- callback:callback];
- [self signInWithOptions:options];
- }
- - (void)signInWithConfiguration:(GIDConfiguration *)configuration
- presentingViewController:(UIViewController *)presentingViewController
- callback:(nullable GIDSignInCallback)callback {
- [self signInWithConfiguration:configuration
- presentingViewController:presentingViewController
- hint:nil
- callback:callback];
- }
- - (void)addScopes:(NSArray<NSString *> *)scopes
- presentingViewController:(UIViewController *)presentingViewController
- callback:(nullable GIDSignInCallback)callback {
- // A currentUser must be available in order to complete this flow.
- if (!self.currentUser) {
- // No currentUser is set, notify callback of failure.
- NSError *error = [NSError errorWithDomain:kGIDSignInErrorDomain
- code:kGIDSignInErrorCodeNoCurrentUser
- userInfo:nil];
- if (callback) {
- dispatch_async(dispatch_get_main_queue(), ^{
- callback(nil, error);
- });
- }
- return;
- }
- GIDConfiguration *configuration =
- [[GIDConfiguration alloc] initWithClientID:self.currentUser.authentication.clientID
- serverClientID:self.currentUser.serverClientID
- hostedDomain:self.currentUser.hostedDomain
- openIDRealm:self.currentUser.openIDRealm];
- GIDSignInInternalOptions *options =
- [GIDSignInInternalOptions defaultOptionsWithConfiguration:configuration
- presentingViewController:presentingViewController
- loginHint:self.currentUser.profile.email
- addScopesFlow:YES
- callback:callback];
- NSSet<NSString *> *requestedScopes = [NSSet setWithArray:scopes];
- NSMutableSet<NSString *> *grantedScopes =
- [NSMutableSet setWithArray:self.currentUser.grantedScopes];
- // Check to see if all requested scopes have already been granted.
- if ([requestedScopes isSubsetOfSet:grantedScopes]) {
- // All requested scopes have already been granted, notify callback of failure.
- NSError *error = [NSError errorWithDomain:kGIDSignInErrorDomain
- code:kGIDSignInErrorCodeScopesAlreadyGranted
- userInfo:nil];
- if (callback) {
- dispatch_async(dispatch_get_main_queue(), ^{
- callback(nil, error);
- });
- }
- return;
- }
- // Use the union of granted and requested scopes.
- [grantedScopes unionSet:requestedScopes];
- options.scopes = [grantedScopes allObjects];
- [self signInWithOptions:options];
- }
- #elif TARGET_OS_OSX
- - (void)signInWithConfiguration:(GIDConfiguration *)configuration
- presentingWindow:(NSWindow *)presentingWindow
- hint:(nullable NSString *)hint
- callback:(nullable GIDSignInCallback)callback {
- GIDSignInInternalOptions *options =
- [GIDSignInInternalOptions defaultOptionsWithConfiguration:configuration
- presentingWindow:presentingWindow
- loginHint:hint
- addScopesFlow:NO
- callback:callback];
- [self signInWithOptions:options];
- }
- - (void)signInWithConfiguration:(GIDConfiguration *)configuration
- presentingWindow:(NSWindow *)presentingWindow
- callback:(nullable GIDSignInCallback)callback {
- [self signInWithConfiguration:configuration
- presentingWindow:presentingWindow
- hint:nil
- callback:callback];
- }
- - (void)signInWithConfiguration:(GIDConfiguration *)configuration
- presentingWindow:(NSWindow *)presentingWindow
- hint:(nullable NSString *)hint
- additionalScopes:(nullable NSArray<NSString *> *)additionalScopes
- callback:(nullable GIDSignInCallback)callback {
- GIDSignInInternalOptions *options =
- [GIDSignInInternalOptions defaultOptionsWithConfiguration:configuration
- presentingWindow:presentingWindow
- loginHint:hint
- addScopesFlow:NO
- scopes:additionalScopes
- callback:callback];
- [self signInWithOptions:options];
- }
- - (void)addScopes:(NSArray<NSString *> *)scopes
- presentingWindow:(NSWindow *)presentingWindow
- callback:(nullable GIDSignInCallback)callback {
- // A currentUser must be available in order to complete this flow.
- if (!self.currentUser) {
- // No currentUser is set, notify callback of failure.
- NSError *error = [NSError errorWithDomain:kGIDSignInErrorDomain
- code:kGIDSignInErrorCodeNoCurrentUser
- userInfo:nil];
- if (callback) {
- dispatch_async(dispatch_get_main_queue(), ^{
- callback(nil, error);
- });
- }
- return;
- }
- GIDConfiguration *configuration =
- [[GIDConfiguration alloc] initWithClientID:self.currentUser.authentication.clientID
- serverClientID:self.currentUser.serverClientID
- hostedDomain:self.currentUser.hostedDomain
- openIDRealm:self.currentUser.openIDRealm];
- GIDSignInInternalOptions *options =
- [GIDSignInInternalOptions defaultOptionsWithConfiguration:configuration
- presentingWindow:presentingWindow
- loginHint:self.currentUser.profile.email
- addScopesFlow:YES
- callback:callback];
- NSSet<NSString *> *requestedScopes = [NSSet setWithArray:scopes];
- NSMutableSet<NSString *> *grantedScopes =
- [NSMutableSet setWithArray:self.currentUser.grantedScopes];
- // Check to see if all requested scopes have already been granted.
- if ([requestedScopes isSubsetOfSet:grantedScopes]) {
- // All requested scopes have already been granted, notify callback of failure.
- NSError *error = [NSError errorWithDomain:kGIDSignInErrorDomain
- code:kGIDSignInErrorCodeScopesAlreadyGranted
- userInfo:nil];
- if (callback) {
- dispatch_async(dispatch_get_main_queue(), ^{
- callback(nil, error);
- });
- }
- return;
- }
- // Use the union of granted and requested scopes.
- [grantedScopes unionSet:requestedScopes];
- options.scopes = [grantedScopes allObjects];
- [self signInWithOptions:options];
- }
- #endif
- - (void)signOut {
- // Clear the current user if there is one.
- if (_currentUser) {
- [self willChangeValueForKey:NSStringFromSelector(@selector(currentUser))];
- _currentUser = nil;
- [self didChangeValueForKey:NSStringFromSelector(@selector(currentUser))];
- }
- // Remove all state from the keychain.
- [self removeAllKeychainEntries];
- }
- - (void)disconnectWithCallback:(nullable GIDDisconnectCallback)callback {
- GIDGoogleUser *user = _currentUser;
- OIDAuthState *authState = user.authentication.authState;
- if (!authState) {
- // Even the user is not signed in right now, we still need to remove any token saved in the
- // keychain.
- authState = [self loadAuthState];
- }
- // Either access or refresh token would work, but we won't have access token if the auth is
- // retrieved from keychain.
- NSString *token = authState.lastTokenResponse.accessToken;
- if (!token) {
- token = authState.lastTokenResponse.refreshToken;
- }
- if (!token) {
- [self signOut];
- // Nothing to do here, consider the operation successful.
- if (callback) {
- dispatch_async(dispatch_get_main_queue(), ^{
- callback(nil);
- });
- }
- return;
- }
- NSString *revokeURLString = [NSString stringWithFormat:kRevokeTokenURLTemplate,
- [GIDSignInPreferences googleAuthorizationServer], token];
- // Append logging parameter
- revokeURLString = [NSString stringWithFormat:@"%@&%@=%@&%@=%@",
- revokeURLString,
- kSDKVersionLoggingParameter,
- GIDVersion(),
- kEnvironmentLoggingParameter,
- GIDEnvironment()];
- NSURL *revokeURL = [NSURL URLWithString:revokeURLString];
- [self startFetchURL:revokeURL
- fromAuthState:authState
- withComment:@"GIDSignIn: revoke tokens"
- withCompletionHandler:^(NSData *data, NSError *error) {
- // Revoking an already revoked token seems always successful, which helps us here.
- if (!error) {
- [self signOut];
- }
- if (callback) {
- dispatch_async(dispatch_get_main_queue(), ^{
- callback(error);
- });
- }
- }];
- }
- #pragma mark - Custom getters and setters
- + (GIDSignIn *)sharedInstance {
- static dispatch_once_t once;
- static GIDSignIn *sharedInstance;
- dispatch_once(&once, ^{
- sharedInstance = [[self alloc] initPrivate];
- });
- return sharedInstance;
- }
- #pragma mark - Private methods
- - (id)initPrivate {
- self = [super init];
- if (self) {
- // Check to see if the 3P app is being run for the first time after a fresh install.
- BOOL isFreshInstall = [self isFreshInstall];
- // If this is a fresh install, ensure that any pre-existing keychain data is purged.
- if (isFreshInstall) {
- [self removeAllKeychainEntries];
- }
- NSString *authorizationEnpointURL = [NSString stringWithFormat:kAuthorizationURLTemplate,
- [GIDSignInPreferences googleAuthorizationServer]];
- NSString *tokenEndpointURL = [NSString stringWithFormat:kTokenURLTemplate,
- [GIDSignInPreferences googleTokenServer]];
- _appAuthConfiguration = [[OIDServiceConfiguration alloc]
- initWithAuthorizationEndpoint:[NSURL URLWithString:authorizationEnpointURL]
- tokenEndpoint:[NSURL URLWithString:tokenEndpointURL]];
- // Perform migration of auth state from old versions of the SDK if needed.
- [GIDAuthStateMigration migrateIfNeededWithTokenURL:_appAuthConfiguration.tokenEndpoint
- callbackPath:kBrowserCallbackPath
- keychainName:kGTMAppAuthKeychainName
- isFreshInstall:isFreshInstall];
- }
- return self;
- }
- // Does sanity check for parameters and then authenticates if necessary.
- - (void)signInWithOptions:(GIDSignInInternalOptions *)options {
- // Options for continuation are not the options we want to cache. The purpose of caching the
- // options in the first place is to provide continuation flows with a starting place from which to
- // derive suitable options for the continuation!
- if (!options.continuation) {
- _currentOptions = options;
- }
- if (options.interactive) {
- // Explicitly throw exception for missing client ID here. This must come before
- // scheme check because schemes rely on reverse client IDs.
- [self assertValidParameters];
- [self assertValidPresentingViewController];
- // If the application does not support the required URL schemes tell the developer so.
- GIDSignInCallbackSchemes *schemes =
- [[GIDSignInCallbackSchemes alloc] initWithClientIdentifier:options.configuration.clientID];
- NSArray<NSString *> *unsupportedSchemes = [schemes unsupportedSchemes];
- if (unsupportedSchemes.count != 0) {
- // NOLINTNEXTLINE(google-objc-avoid-throwing-exception)
- [NSException raise:NSInvalidArgumentException
- format:@"Your app is missing support for the following URL schemes: %@",
- [unsupportedSchemes componentsJoinedByString:@", "]];
- }
- }
- // If this is a non-interactive flow, use cached authentication if possible.
- if (!options.interactive && _currentUser.authentication) {
- [_currentUser.authentication doWithFreshTokens:^(GIDAuthentication *unused, NSError *error) {
- if (error) {
- [self authenticateWithOptions:options];
- } else {
- if (options.callback) {
- self->_currentOptions = nil;
- dispatch_async(dispatch_get_main_queue(), ^{
- options.callback(self->_currentUser, nil);
- });
- }
- }
- }];
- } else {
- [self authenticateWithOptions:options];
- }
- }
- #pragma mark - Authentication flow
- - (void)authenticateInteractivelyWithOptions:(GIDSignInInternalOptions *)options {
- GIDSignInCallbackSchemes *schemes =
- [[GIDSignInCallbackSchemes alloc] initWithClientIdentifier:options.configuration.clientID];
- NSURL *redirectURL = [NSURL URLWithString:[NSString stringWithFormat:@"%@:%@",
- [schemes clientIdentifierScheme],
- kBrowserCallbackPath]];
- NSString *emmSupport;
- #if TARGET_OS_MACCATALYST || TARGET_OS_OSX
- emmSupport = nil;
- #elif TARGET_OS_IOS
- emmSupport = [[self class] isOperatingSystemAtLeast9] ? kEMMVersion : nil;
- #endif
- NSMutableDictionary<NSString *, NSString *> *additionalParameters = [@{} mutableCopy];
- additionalParameters[kIncludeGrantedScopesParameter] = @"true";
- if (options.configuration.serverClientID) {
- additionalParameters[kAudienceParameter] = options.configuration.serverClientID;
- }
- if (options.loginHint) {
- additionalParameters[kLoginHintParameter] = options.loginHint;
- }
- if (options.configuration.hostedDomain) {
- additionalParameters[kHostedDomainParameter] = options.configuration.hostedDomain;
- }
- #if TARGET_OS_IOS
- [additionalParameters addEntriesFromDictionary:
- [GIDAuthentication parametersWithParameters:options.extraParams
- emmSupport:emmSupport
- isPasscodeInfoRequired:NO]];
- #elif TARGET_OS_OSX || TARGET_OS_MACCATALYST
- [additionalParameters addEntriesFromDictionary:options.extraParams];
- #endif
- additionalParameters[kSDKVersionLoggingParameter] = GIDVersion();
- additionalParameters[kEnvironmentLoggingParameter] = GIDEnvironment();
- #if TARGET_OS_IOS || TARGET_OS_MACCATALYST
- OIDAuthorizationRequest *request =
- [[OIDAuthorizationRequest alloc] initWithConfiguration:_appAuthConfiguration
- clientId:options.configuration.clientID
- scopes:options.scopes
- redirectURL:redirectURL
- responseType:OIDResponseTypeCode
- additionalParameters:additionalParameters];
- _currentAuthorizationFlow = [OIDAuthorizationService
- presentAuthorizationRequest:request
- presentingViewController:options.presentingViewController
- callback:^(OIDAuthorizationResponse *_Nullable authorizationResponse,
- NSError *_Nullable error) {
- [self processAuthorizationResponse:authorizationResponse
- error:error
- emmSupport:emmSupport];
- }];
- #elif TARGET_OS_OSX
- OIDAuthorizationRequest *request =
- [[OIDAuthorizationRequest alloc] initWithConfiguration:_appAuthConfiguration
- clientId:options.configuration.clientID
- clientSecret:@""
- scopes:options.scopes
- redirectURL:redirectURL
- responseType:OIDResponseTypeCode
- additionalParameters:additionalParameters];
- _currentAuthorizationFlow = [OIDAuthorizationService
- presentAuthorizationRequest:request
- presentingWindow:options.presentingWindow
- callback:^(OIDAuthorizationResponse *_Nullable authorizationResponse,
- NSError *_Nullable error) {
- [self processAuthorizationResponse:authorizationResponse
- error:error
- emmSupport:emmSupport];
- }];
- #endif
- }
- - (void)processAuthorizationResponse:(OIDAuthorizationResponse *)authorizationResponse
- error:(NSError *)error
- emmSupport:(NSString *)emmSupport{
- if (_restarting) {
- // The auth flow is restarting, so the work here would be performed in the next round.
- _restarting = NO;
- return;
- }
- GIDAuthFlow *authFlow = [[GIDAuthFlow alloc] init];
- authFlow.emmSupport = emmSupport;
- if (authorizationResponse) {
- if (authorizationResponse.authorizationCode.length) {
- authFlow.authState = [[OIDAuthState alloc]
- initWithAuthorizationResponse:authorizationResponse];
- // perform auth code exchange
- [self maybeFetchToken:authFlow fallback:nil];
- } else {
- // There was a failure, convert to appropriate error code.
- NSString *errorString;
- GIDSignInErrorCode errorCode = kGIDSignInErrorCodeUnknown;
- NSDictionary<NSString *, NSObject *> *params = authorizationResponse.additionalParameters;
- #if TARGET_OS_IOS
- if (authFlow.emmSupport) {
- [authFlow wait];
- BOOL isEMMError = [[GIDEMMErrorHandler sharedInstance]
- handleErrorFromResponse:params
- completion:^{
- [authFlow next];
- }];
- if (isEMMError) {
- errorCode = kGIDSignInErrorCodeEMM;
- }
- }
- #endif
- errorString = (NSString *)params[kOAuth2ErrorKeyName];
- if ([errorString isEqualToString:kOAuth2AccessDenied]) {
- errorCode = kGIDSignInErrorCodeCanceled;
- }
- authFlow.error = [self errorWithString:errorString code:errorCode];
- }
- } else {
- NSString *errorString = [error localizedDescription];
- GIDSignInErrorCode errorCode = kGIDSignInErrorCodeUnknown;
- if (error.code == OIDErrorCodeUserCanceledAuthorizationFlow) {
- // The user has canceled the flow at the iOS modal dialog.
- errorString = kUserCanceledError;
- errorCode = kGIDSignInErrorCodeCanceled;
- }
- authFlow.error = [self errorWithString:errorString code:errorCode];
- }
- [self addDecodeIdTokenCallback:authFlow];
- [self addSaveAuthCallback:authFlow];
- [self addCompletionCallback:authFlow];
- }
- // Perform authentication with the provided options.
- - (void)authenticateWithOptions:(GIDSignInInternalOptions *)options {
- // If this is an interactive flow, we're not going to try to restore any saved auth state.
- if (options.interactive) {
- [self authenticateInteractivelyWithOptions:options];
- return;
- }
- // Try retrieving an authorization object from the keychain.
- OIDAuthState *authState = [self loadAuthState];
- if (![authState isAuthorized]) {
- // No valid auth in keychain, per documentation/spec, notify callback of failure.
- NSError *error = [NSError errorWithDomain:kGIDSignInErrorDomain
- code:kGIDSignInErrorCodeHasNoAuthInKeychain
- userInfo:nil];
- if (options.callback) {
- _currentOptions = nil;
- dispatch_async(dispatch_get_main_queue(), ^{
- options.callback(nil, error);
- });
- }
- return;
- }
- // Complete the auth flow using saved auth in keychain.
- GIDAuthFlow *authFlow = [[GIDAuthFlow alloc] init];
- authFlow.authState = authState;
- [self maybeFetchToken:authFlow fallback:options.interactive ? ^() {
- [self authenticateInteractivelyWithOptions:options];
- } : nil];
- [self addDecodeIdTokenCallback:authFlow];
- [self addSaveAuthCallback:authFlow];
- [self addCompletionCallback:authFlow];
- }
- // Fetches the access token if necessary as part of the auth flow. If |fallback|
- // is provided, call it instead of continuing the auth flow in case of error.
- - (void)maybeFetchToken:(GIDAuthFlow *)authFlow fallback:(nullable void (^)(void))fallback {
- OIDAuthState *authState = authFlow.authState;
- // Do nothing if we have an auth flow error or a restored access token that isn't near expiration.
- if (authFlow.error ||
- (authState.lastTokenResponse.accessToken &&
- [authState.lastTokenResponse.accessTokenExpirationDate timeIntervalSinceNow] >
- kMinimumRestoredAccessTokenTimeToExpire)) {
- return;
- }
- NSMutableDictionary<NSString *, NSString *> *additionalParameters = [@{} mutableCopy];
- if (_currentOptions.configuration.serverClientID) {
- additionalParameters[kAudienceParameter] = _currentOptions.configuration.serverClientID;
- }
- if (_currentOptions.configuration.openIDRealm) {
- additionalParameters[kOpenIDRealmParameter] = _currentOptions.configuration.openIDRealm;
- }
- #if TARGET_OS_IOS
- NSDictionary<NSString *, NSObject *> *params =
- authState.lastAuthorizationResponse.additionalParameters;
- NSString *passcodeInfoRequired = (NSString *)params[kEMMPasscodeInfoRequiredKeyName];
- [additionalParameters addEntriesFromDictionary:
- [GIDAuthentication parametersWithParameters:@{}
- emmSupport:authFlow.emmSupport
- isPasscodeInfoRequired:passcodeInfoRequired.length > 0]];
- #endif
- additionalParameters[kSDKVersionLoggingParameter] = GIDVersion();
- additionalParameters[kEnvironmentLoggingParameter] = GIDEnvironment();
- OIDTokenRequest *tokenRequest;
- if (!authState.lastTokenResponse.accessToken &&
- authState.lastAuthorizationResponse.authorizationCode) {
- tokenRequest = [authState.lastAuthorizationResponse
- tokenExchangeRequestWithAdditionalParameters:additionalParameters];
- } else {
- [additionalParameters
- addEntriesFromDictionary:authState.lastTokenResponse.request.additionalParameters];
- tokenRequest = [authState tokenRefreshRequestWithAdditionalParameters:additionalParameters];
- }
- [authFlow wait];
- [OIDAuthorizationService
- performTokenRequest:tokenRequest
- callback:^(OIDTokenResponse *_Nullable tokenResponse,
- NSError *_Nullable error) {
- [authState updateWithTokenResponse:tokenResponse error:error];
- authFlow.error = error;
- if (!tokenResponse.accessToken || error) {
- if (fallback) {
- [authFlow reset];
- fallback();
- return;
- }
- }
- #if TARGET_OS_IOS
- if (authFlow.emmSupport) {
- [GIDAuthentication handleTokenFetchEMMError:error completion:^(NSError *error) {
- authFlow.error = error;
- [authFlow next];
- }];
- } else {
- [authFlow next];
- }
- #elif TARGET_OS_OSX || TARGET_OS_MACCATALYST
- [authFlow next];
- #endif
- }];
- }
- // Adds a callback to the auth flow to save the auth object to |self| and the keychain as well.
- - (void)addSaveAuthCallback:(GIDAuthFlow *)authFlow {
- __weak GIDAuthFlow *weakAuthFlow = authFlow;
- [authFlow addCallback:^() {
- GIDAuthFlow *handlerAuthFlow = weakAuthFlow;
- OIDAuthState *authState = handlerAuthFlow.authState;
- if (authState && !handlerAuthFlow.error) {
- if (![self saveAuthState:authState]) {
- handlerAuthFlow.error = [self errorWithString:kKeychainError
- code:kGIDSignInErrorCodeKeychain];
- return;
- }
- if (self->_currentOptions.addScopesFlow) {
- [self->_currentUser updateAuthState:authState
- profileData:handlerAuthFlow.profileData];
- } else {
- GIDGoogleUser *user = [[GIDGoogleUser alloc] initWithAuthState:authState
- profileData:handlerAuthFlow.profileData];
- [self setCurrentUserWithKVO:user];
- }
- }
- }];
- }
- // Adds a callback to the auth flow to extract user data from the ID token where available and
- // make a userinfo request if necessary.
- - (void)addDecodeIdTokenCallback:(GIDAuthFlow *)authFlow {
- __weak GIDAuthFlow *weakAuthFlow = authFlow;
- [authFlow addCallback:^() {
- GIDAuthFlow *handlerAuthFlow = weakAuthFlow;
- OIDAuthState *authState = handlerAuthFlow.authState;
- if (!authState || handlerAuthFlow.error) {
- return;
- }
- OIDIDToken *idToken =
- [[OIDIDToken alloc] initWithIDTokenString: authState.lastTokenResponse.idToken];
- // If the profile data are present in the ID token, use them.
- if (idToken) {
- handlerAuthFlow.profileData = [self profileDataWithIDToken:idToken];
- }
- // If we can't retrieve profile data from the ID token, make a userInfo request to fetch them.
- if (!handlerAuthFlow.profileData) {
- [handlerAuthFlow wait];
- NSURL *infoURL = [NSURL URLWithString:
- [NSString stringWithFormat:kUserInfoURLTemplate,
- [GIDSignInPreferences googleUserInfoServer],
- authState.lastTokenResponse.accessToken]];
- [self startFetchURL:infoURL
- fromAuthState:authState
- withComment:@"GIDSignIn: fetch basic profile info"
- withCompletionHandler:^(NSData *data, NSError *error) {
- if (data && !error) {
- NSError *jsonDeserializationError;
- NSDictionary<NSString *, NSString *> *profileDict =
- [NSJSONSerialization JSONObjectWithData:data
- options:NSJSONReadingMutableContainers
- error:&jsonDeserializationError];
- if (profileDict) {
- handlerAuthFlow.profileData = [[GIDProfileData alloc]
- initWithEmail:idToken.claims[kBasicProfileEmailKey]
- name:profileDict[kBasicProfileNameKey]
- givenName:profileDict[kBasicProfileGivenNameKey]
- familyName:profileDict[kBasicProfileFamilyNameKey]
- imageURL:[NSURL URLWithString:profileDict[kBasicProfilePictureKey]]];
- }
- }
- if (error) {
- handlerAuthFlow.error = error;
- }
- [handlerAuthFlow next];
- }];
- }
- }];
- }
- // Adds a callback to the auth flow to complete the flow by calling the sign-in callback.
- - (void)addCompletionCallback:(GIDAuthFlow *)authFlow {
- __weak GIDAuthFlow *weakAuthFlow = authFlow;
- [authFlow addCallback:^() {
- GIDAuthFlow *handlerAuthFlow = weakAuthFlow;
- if (self->_currentOptions.callback) {
- GIDSignInCallback callback = self->_currentOptions.callback;
- self->_currentOptions = nil;
- dispatch_async(dispatch_get_main_queue(), ^{
- callback(self->_currentUser, handlerAuthFlow.error);
- });
- }
- }];
- }
- - (void)startFetchURL:(NSURL *)URL
- fromAuthState:(OIDAuthState *)authState
- withComment:(NSString *)comment
- withCompletionHandler:(void (^)(NSData *, NSError *))handler {
- NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:URL];
- GTMSessionFetcher *fetcher;
- GTMAppAuthFetcherAuthorization *authorization =
- [[GTMAppAuthFetcherAuthorization alloc] initWithAuthState:authState];
- id<GTMSessionFetcherServiceProtocol> fetcherService = authorization.fetcherService;
- if (fetcherService) {
- fetcher = [fetcherService fetcherWithRequest:request];
- } else {
- fetcher = [GTMSessionFetcher fetcherWithRequest:request];
- }
- fetcher.retryEnabled = YES;
- fetcher.maxRetryInterval = kFetcherMaxRetryInterval;
- fetcher.comment = comment;
- [fetcher beginFetchWithCompletionHandler:handler];
- }
- // Parse incoming URL from the Google Device Policy app.
- - (BOOL)handleDevicePolicyAppURL:(NSURL *)url {
- OIDURLQueryComponent *queryComponent = [[OIDURLQueryComponent alloc] initWithURL:url];
- NSDictionary<NSString *, NSObject<NSCopying> *> *params = queryComponent.dictionaryValue;
- NSObject<NSCopying> *actionParam = params[@"action"];
- NSString *actionString =
- [actionParam isKindOfClass:[NSString class]] ? (NSString *)actionParam : nil;
- if (![@"restart_auth" isEqualToString:actionString]) {
- return NO;
- }
- #if TARGET_OS_IOS || TARGET_OS_MACCATALYST
- if (!_currentOptions.presentingViewController) {
- return NO;
- }
- #elif TARGET_OS_OSX
- if (!_currentOptions.presentingWindow) {
- return NO;
- }
- #endif
- if (!_currentAuthorizationFlow) {
- return NO;
- }
- _restarting = YES;
- [_currentAuthorizationFlow cancel];
- _currentAuthorizationFlow = nil;
- _restarting = NO;
- NSDictionary<NSString *, NSString *> *extraParameters = @{ kEMMRestartAuthParameter : @"1" };
- // In iOS 13 the presentation of ASWebAuthenticationSession needs an anchor window,
- // so we need to wait until the previous presentation is completely gone to ensure the right
- // anchor window is used here.
- dispatch_after(dispatch_time(DISPATCH_TIME_NOW,
- (int64_t)(kPresentationDelayAfterCancel * NSEC_PER_SEC)),
- dispatch_get_main_queue(), ^{
- [self signInWithOptions:[self->_currentOptions optionsWithExtraParameters:extraParameters
- forContinuation:YES]];
- });
- return YES;
- }
- #pragma mark - Key-Value Observing
- // Override |NSObject(NSKeyValueObservingCustomization)| method in order to provide custom KVO
- // notifications for the |currentUser| property.
- + (BOOL)automaticallyNotifiesObserversForKey:(NSString *)key {
- if ([key isEqual:NSStringFromSelector(@selector(currentUser))]) {
- return NO;
- }
- return [super automaticallyNotifiesObserversForKey:key];
- }
- #pragma mark - Helpers
- - (NSError *)errorWithString:(NSString *)errorString code:(GIDSignInErrorCode)code {
- if (errorString == nil) {
- errorString = @"Unknown error";
- }
- NSDictionary<NSString *, NSString *> *errorDict = @{ NSLocalizedDescriptionKey : errorString };
- return [NSError errorWithDomain:kGIDSignInErrorDomain
- code:code
- userInfo:errorDict];
- }
- + (BOOL)isOperatingSystemAtLeast9 {
- NSProcessInfo *processInfo = [NSProcessInfo processInfo];
- return [processInfo respondsToSelector:@selector(isOperatingSystemAtLeastVersion:)] &&
- [processInfo isOperatingSystemAtLeastVersion:(NSOperatingSystemVersion){.majorVersion = 9}];
- }
- // Asserts the parameters being valid.
- - (void)assertValidParameters {
- if (![_currentOptions.configuration.clientID length]) {
- // NOLINTNEXTLINE(google-objc-avoid-throwing-exception)
- [NSException raise:NSInvalidArgumentException
- format:@"You must specify |clientID| in |GIDConfiguration|"];
- }
- }
- // Assert that the presenting view controller has been set.
- - (void)assertValidPresentingViewController {
- #if TARGET_OS_IOS || TARGET_OS_MACCATALYST
- if (!_currentOptions.presentingViewController) {
- #elif TARGET_OS_OSX
- if (!_currentOptions.presentingWindow) {
- #endif
- // NOLINTNEXTLINE(google-objc-avoid-throwing-exception)
- [NSException raise:NSInvalidArgumentException
- format:@"|presentingViewController| must be set."];
- }
- }
- // Checks whether or not this is the first time the app runs.
- - (BOOL)isFreshInstall {
- NSUserDefaults* defaults = [NSUserDefaults standardUserDefaults];
- if ([defaults boolForKey:kAppHasRunBeforeKey]) {
- return NO;
- }
- [defaults setBool:YES forKey:kAppHasRunBeforeKey];
- return YES;
- }
- - (void)removeAllKeychainEntries {
- [GTMAppAuthFetcherAuthorization removeAuthorizationFromKeychainForName:kGTMAppAuthKeychainName];
- }
- - (BOOL)saveAuthState:(OIDAuthState *)authState {
- GTMAppAuthFetcherAuthorization *authorization =
- [[GTMAppAuthFetcherAuthorization alloc] initWithAuthState:authState];
- return [GTMAppAuthFetcherAuthorization saveAuthorization:authorization
- toKeychainForName:kGTMAppAuthKeychainName];
- }
- - (OIDAuthState *)loadAuthState {
- GTMAppAuthFetcherAuthorization *authorization =
- [GTMAppAuthFetcherAuthorization authorizationFromKeychainForName:kGTMAppAuthKeychainName];
- return authorization.authState;
- }
- // Generates user profile from OIDIDToken.
- - (GIDProfileData *)profileDataWithIDToken:(OIDIDToken *)idToken {
- if (!idToken ||
- !idToken.claims[kBasicProfilePictureKey] ||
- !idToken.claims[kBasicProfileNameKey] ||
- !idToken.claims[kBasicProfileGivenNameKey] ||
- !idToken.claims[kBasicProfileFamilyNameKey]) {
- return nil;
- }
- return [[GIDProfileData alloc]
- initWithEmail:idToken.claims[kBasicProfileEmailKey]
- name:idToken.claims[kBasicProfileNameKey]
- givenName:idToken.claims[kBasicProfileGivenNameKey]
- familyName:idToken.claims[kBasicProfileFamilyNameKey]
- imageURL:[NSURL URLWithString:idToken.claims[kBasicProfilePictureKey]]];
- }
- // Set currentUser making appropriate KVO calls.
- - (void)setCurrentUserWithKVO:(GIDGoogleUser *_Nullable)user {
- [self willChangeValueForKey:NSStringFromSelector(@selector(currentUser))];
- _currentUser = user;
- [self didChangeValueForKey:NSStringFromSelector(@selector(currentUser))];
- }
- @end
- NS_ASSUME_NONNULL_END
|