-
Notifications
You must be signed in to change notification settings - Fork 198
/
GIDSignIn.m
1056 lines (930 loc) · 42.4 KB
/
GIDSignIn.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// 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/GIDConfiguration.h"
#import "GoogleSignIn/Sources/Public/GoogleSignIn/GIDGoogleUser.h"
#import "GoogleSignIn/Sources/Public/GoogleSignIn/GIDProfileData.h"
#import "GoogleSignIn/Sources/Public/GoogleSignIn/GIDSignInResult.h"
#import "GoogleSignIn/Sources/GIDEMMSupport.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"
#if TARGET_OS_IOS && !TARGET_OS_MACCATALYST
#import "GoogleSignIn/Sources/GIDAuthStateMigration.h"
#import "GoogleSignIn/Sources/GIDEMMErrorHandler.h"
#endif // TARGET_OS_IOS && !TARGET_OS_MACCATALYST
#import "GoogleSignIn/Sources/GIDGoogleUser_Private.h"
#import "GoogleSignIn/Sources/GIDProfileData_Private.h"
#import "GoogleSignIn/Sources/GIDSignInResult_Private.h"
@import GTMAppAuth;
#ifdef SWIFT_PACKAGE
@import AppAuth;
@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 <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;
// Info.plist config keys
static NSString *const kConfigClientIDKey = @"GIDClientID";
static NSString *const kConfigServerClientIDKey = @"GIDServerClientID";
static NSString *const kConfigHostedDomainKey = @"GIDHostedDomain";
static NSString *const kConfigOpenIDRealmKey = @"GIDOpenIDRealm";
// 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;
// Keychain manager for GTMAppAuth
GTMKeychainStore *_keychainStore;
}
#pragma mark - Public methods
// Handles the custom scheme URL opened by SFSafariViewController or the Device Policy App.
//
// For SFSafariViewController invoked via AppAuth, this method is used on iOS 10.
// For the Device Policy App (EMM flow) this method is used on all iOS versions.
- (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.authState isAuthorized]) {
return YES;
}
OIDAuthState *authState = [self loadAuthState];
return [authState isAuthorized];
}
- (void)restorePreviousSignInWithCompletion:(nullable void (^)(GIDGoogleUser *_Nullable user,
NSError *_Nullable error))completion {
[self signInWithOptions:[GIDSignInInternalOptions silentOptionsWithCompletion:
^(GIDSignInResult *signInResult, NSError *error) {
if (!completion) {
return;
}
if (signInResult) {
completion(signInResult.user, nil);
} else {
completion(nil, error);
}
}]];
}
- (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.currentUser = user;
return YES;
}
#if TARGET_OS_IOS || TARGET_OS_MACCATALYST
- (void)signInWithPresentingViewController:(UIViewController *)presentingViewController
hint:(nullable NSString *)hint
completion:(nullable GIDSignInCompletion)completion {
GIDSignInInternalOptions *options =
[GIDSignInInternalOptions defaultOptionsWithConfiguration:_configuration
presentingViewController:presentingViewController
loginHint:hint
addScopesFlow:NO
completion:completion];
[self signInWithOptions:options];
}
- (void)signInWithPresentingViewController:(UIViewController *)presentingViewController
hint:(nullable NSString *)hint
additionalScopes:(nullable NSArray<NSString *> *)additionalScopes
completion:(nullable GIDSignInCompletion)completion {
GIDSignInInternalOptions *options =
[GIDSignInInternalOptions defaultOptionsWithConfiguration:_configuration
presentingViewController:presentingViewController
loginHint:hint
addScopesFlow:NO
scopes:additionalScopes
completion:completion];
[self signInWithOptions:options];
}
- (void)signInWithPresentingViewController:(UIViewController *)presentingViewController
completion:(nullable GIDSignInCompletion)completion {
[self signInWithPresentingViewController:presentingViewController
hint:nil
completion:completion];
}
- (void)addScopes:(NSArray<NSString *> *)scopes
presentingViewController:(UIViewController *)presentingViewController
completion:(nullable GIDSignInCompletion)completion {
GIDConfiguration *configuration = self.currentUser.configuration;
GIDSignInInternalOptions *options =
[GIDSignInInternalOptions defaultOptionsWithConfiguration:configuration
presentingViewController:presentingViewController
loginHint:self.currentUser.profile.email
addScopesFlow:YES
completion:completion];
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 (completion) {
dispatch_async(dispatch_get_main_queue(), ^{
completion(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)signInWithPresentingWindow:(NSWindow *)presentingWindow
hint:(nullable NSString *)hint
completion:(nullable GIDSignInCompletion)completion {
GIDSignInInternalOptions *options =
[GIDSignInInternalOptions defaultOptionsWithConfiguration:_configuration
presentingWindow:presentingWindow
loginHint:hint
addScopesFlow:NO
completion:completion];
[self signInWithOptions:options];
}
- (void)signInWithPresentingWindow:(NSWindow *)presentingWindow
completion:(nullable GIDSignInCompletion)completion {
[self signInWithPresentingWindow:presentingWindow
hint:nil
completion:completion];
}
- (void)signInWithPresentingWindow:(NSWindow *)presentingWindow
hint:(nullable NSString *)hint
additionalScopes:(nullable NSArray<NSString *> *)additionalScopes
completion:(nullable GIDSignInCompletion)completion {
GIDSignInInternalOptions *options =
[GIDSignInInternalOptions defaultOptionsWithConfiguration:_configuration
presentingWindow:presentingWindow
loginHint:hint
addScopesFlow:NO
scopes:additionalScopes
completion:completion];
[self signInWithOptions:options];
}
- (void)addScopes:(NSArray<NSString *> *)scopes
presentingWindow:(NSWindow *)presentingWindow
completion:(nullable GIDSignInCompletion)completion {
GIDConfiguration *configuration = self.currentUser.configuration;
GIDSignInInternalOptions *options =
[GIDSignInInternalOptions defaultOptionsWithConfiguration:configuration
presentingWindow:presentingWindow
loginHint:self.currentUser.profile.email
addScopesFlow:YES
completion:completion];
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 (completion) {
dispatch_async(dispatch_get_main_queue(), ^{
completion(nil, error);
});
}
return;
}
// Use the union of granted and requested scopes.
[grantedScopes unionSet:requestedScopes];
options.scopes = [grantedScopes allObjects];
[self signInWithOptions:options];
}
#endif // TARGET_OS_OSX
- (void)signOut {
// Clear the current user if there is one.
if (_currentUser) {
self.currentUser = nil;
}
// Remove all state from the keychain.
[self removeAllKeychainEntries];
}
- (void)disconnectWithCompletion:(nullable GIDDisconnectCompletion)completion {
OIDAuthState *authState = _currentUser.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 (completion) {
dispatch_async(dispatch_get_main_queue(), ^{
completion(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 (completion) {
dispatch_async(dispatch_get_main_queue(), ^{
completion(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
- (instancetype)initWithKeychainStore:(GTMKeychainStore *)keychainStore {
self = [super init];
if (self) {
// Get the bundle of the current executable.
NSBundle *bundle = NSBundle.mainBundle;
// If we have a bundle, try to set the active configuration from the bundle's Info.plist.
if (bundle) {
_configuration = [GIDSignIn configurationFromBundle:bundle];
}
// 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]];
_keychainStore = keychainStore;
#if TARGET_OS_IOS && !TARGET_OS_MACCATALYST
// Perform migration of auth state from old (before 5.0) versions of the SDK if needed.
GIDAuthStateMigration *migration =
[[GIDAuthStateMigration alloc] initWithKeychainStore:_keychainStore];
[migration migrateIfNeededWithTokenURL:_appAuthConfiguration.tokenEndpoint
callbackPath:kBrowserCallbackPath
keychainName:kGTMAppAuthKeychainName
isFreshInstall:isFreshInstall];
#endif // TARGET_OS_IOS && !TARGET_OS_MACCATALYST
}
return self;
}
- (instancetype)initPrivate {
GTMKeychainStore *keychainStore =
[[GTMKeychainStore alloc] initWithItemName:kGTMAppAuthKeychainName];
return [self initWithKeychainStore:keychainStore];
}
// 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) {
// Ensure that a configuration has been provided.
if (!_configuration) {
// NOLINTNEXTLINE(google-objc-avoid-throwing-exception)
[NSException raise:NSInvalidArgumentException
format:@"No active configuration. Make sure GIDClientID is set in Info.plist."];
return;
}
// 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) {
[_currentUser refreshTokensIfNeededWithCompletion:^(GIDGoogleUser *unused, NSError *error) {
if (error) {
[self authenticateWithOptions:options];
} else {
if (options.completion) {
self->_currentOptions = nil;
dispatch_async(dispatch_get_main_queue(), ^{
GIDSignInResult *signInResult =
[[GIDSignInResult alloc] initWithGoogleUser:self->_currentUser serverAuthCode:nil];
options.completion(signInResult, 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_IOS && !TARGET_OS_MACCATALYST
emmSupport = [[self class] isOperatingSystemAtLeast9] ? kEMMVersion : nil;
#elif TARGET_OS_MACCATALYST || TARGET_OS_OSX
emmSupport = nil;
#endif // TARGET_OS_MACCATALYST || TARGET_OS_OSX
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 && !TARGET_OS_MACCATALYST
[additionalParameters addEntriesFromDictionary:
[GIDEMMSupport parametersWithParameters:options.extraParams
emmSupport:emmSupport
isPasscodeInfoRequired:NO]];
#elif TARGET_OS_OSX || TARGET_OS_MACCATALYST
[additionalParameters addEntriesFromDictionary:options.extraParams];
#endif // TARGET_OS_OSX || TARGET_OS_MACCATALYST
additionalParameters[kSDKVersionLoggingParameter] = GIDVersion();
additionalParameters[kEnvironmentLoggingParameter] = GIDEnvironment();
OIDAuthorizationRequest *request =
[[OIDAuthorizationRequest alloc] initWithConfiguration:_appAuthConfiguration
clientId:options.configuration.clientID
scopes:options.scopes
redirectURL:redirectURL
responseType:OIDResponseTypeCode
additionalParameters:additionalParameters];
_currentAuthorizationFlow = [OIDAuthorizationService
presentAuthorizationRequest:request
#if TARGET_OS_IOS || TARGET_OS_MACCATALYST
presentingViewController:options.presentingViewController
#elif TARGET_OS_OSX
presentingWindow:options.presentingWindow
#endif // TARGET_OS_OSX
callback:^(OIDAuthorizationResponse *_Nullable authorizationResponse,
NSError *_Nullable error) {
[self processAuthorizationResponse:authorizationResponse
error:error
emmSupport:emmSupport];
}];
}
- (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];
} 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 && !TARGET_OS_MACCATALYST
if (authFlow.emmSupport) {
[authFlow wait];
BOOL isEMMError = [[GIDEMMErrorHandler sharedInstance]
handleErrorFromResponse:params
completion:^{
[authFlow next];
}];
if (isEMMError) {
errorCode = kGIDSignInErrorCodeEMM;
}
}
#endif // TARGET_OS_IOS && !TARGET_OS_MACCATALYST
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.completion) {
_currentOptions = nil;
dispatch_async(dispatch_get_main_queue(), ^{
options.completion(nil, error);
});
}
return;
}
// Complete the auth flow using saved auth in keychain.
GIDAuthFlow *authFlow = [[GIDAuthFlow alloc] init];
authFlow.authState = authState;
[self maybeFetchToken:authFlow];
[self addDecodeIdTokenCallback:authFlow];
[self addSaveAuthCallback:authFlow];
[self addCompletionCallback:authFlow];
}
// Fetches the access token if necessary as part of the auth flow.
- (void)maybeFetchToken:(GIDAuthFlow *)authFlow {
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 && !TARGET_OS_MACCATALYST
NSDictionary<NSString *, NSObject *> *params =
authState.lastAuthorizationResponse.additionalParameters;
NSString *passcodeInfoRequired = (NSString *)params[kEMMPasscodeInfoRequiredKeyName];
[additionalParameters addEntriesFromDictionary:
[GIDEMMSupport parametersWithParameters:@{}
emmSupport:authFlow.emmSupport
isPasscodeInfoRequired:passcodeInfoRequired.length > 0]];
#endif // TARGET_OS_IOS && !TARGET_OS_MACCATALYST
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 TARGET_OS_IOS && !TARGET_OS_MACCATALYST
if (authFlow.emmSupport) {
[GIDEMMSupport handleTokenFetchEMMError:error completion:^(NSError *error) {
authFlow.error = error;
[authFlow next];
}];
} else {
[authFlow next];
}
#elif TARGET_OS_OSX || TARGET_OS_MACCATALYST
[authFlow next];
#endif // TARGET_OS_OSX || TARGET_OS_MACCATALYST
}];
}
// 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 updateWithTokenResponse:authState.lastTokenResponse
authorizationResponse:authState.lastAuthorizationResponse
profileData:handlerAuthFlow.profileData];
} else {
GIDGoogleUser *user = [[GIDGoogleUser alloc] initWithAuthState:authState
profileData:handlerAuthFlow.profileData];
self.currentUser = 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.completion) {
GIDSignInCompletion completion = self->_currentOptions.completion;
self->_currentOptions = nil;
dispatch_async(dispatch_get_main_queue(), ^{
if (handlerAuthFlow.error) {
completion(nil, handlerAuthFlow.error);
} else {
OIDAuthState *authState = handlerAuthFlow.authState;
NSString *_Nullable serverAuthCode =
[authState.lastTokenResponse.additionalParameters[@"server_code"] copy];
GIDSignInResult *signInResult =
[[GIDSignInResult alloc] initWithGoogleUser:self->_currentUser
serverAuthCode:serverAuthCode];
completion(signInResult, nil);
}
});
}
}];
}
- (void)startFetchURL:(NSURL *)URL
fromAuthState:(OIDAuthState *)authState
withComment:(NSString *)comment
withCompletionHandler:(void (^)(NSData *, NSError *))handler {
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:URL];
GTMSessionFetcher *fetcher;
GTMAuthSession *authorization = [[GTMAuthSession 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 // TARGET_OS_OSX
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 - 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 // TARGET_OS_OSX
{
// 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 {
[_keychainStore removeAuthSessionWithError:nil];
}
- (BOOL)saveAuthState:(OIDAuthState *)authState {
GTMAuthSession *authorization = [[GTMAuthSession alloc] initWithAuthState:authState];
NSError *error;
[_keychainStore saveAuthSession:authorization error:&error];
return error == nil;
}
- (OIDAuthState *)loadAuthState {
GTMAuthSession *authorization = [_keychainStore retrieveAuthSessionWithError:nil];