-
Notifications
You must be signed in to change notification settings - Fork 117
/
DBOAuth.m
437 lines (353 loc) · 13.6 KB
/
DBOAuth.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
///
/// Copyright (c) 2016 Dropbox, Inc. All rights reserved.
///
#import "DBOAuth.h"
#import "DBOAuthResult.h"
#import "DBSDKKeychain.h"
#import "DBSDKReachability.h"
#import "DBSharedApplicationProtocol.h"
/// A shared instance of a `DBOAuthManager` for convenience
static DBOAuthManager *sharedOAuthManager;
#pragma mark - OAuth manager base
@interface DBOAuthManager ()
@property (nonatomic, copy) NSString * _Nullable appKey;
@property (nonatomic, copy) NSURL * _Nullable redirectURL;
@property (nonatomic, copy) NSURL * _Nullable cancelURL;
@property (nonatomic, copy) NSString * _Nullable host;
@property (nonatomic, copy) NSMutableArray<NSURL *> * _Nullable urls;
@end
@implementation DBOAuthManager
#pragma mark - Shared instance accessors and mutators
+ (DBOAuthManager *)sharedOAuthManager {
return sharedOAuthManager;
}
+ (void)setSharedOAuthManager:(DBOAuthManager *)sharedManager {
sharedOAuthManager = sharedManager;
}
#pragma mark - Constructors
- (instancetype)initWithAppKey:(NSString *)appKey {
return [self initWithAppKey:appKey host:@"www.dropbox.com"];
}
- (instancetype)initWithAppKey:(NSString *)appKey host:(NSString *)host {
self = [super init];
if (self) {
_appKey = appKey;
_redirectURL = [[NSURL alloc] initWithString:[NSString stringWithFormat:@"db-%@://2/token", _appKey]];
_cancelURL = [NSURL URLWithString:[NSString stringWithFormat:@"db-%@://2/cancel", _appKey]];
_host = host;
_urls = [NSMutableArray arrayWithObjects:_redirectURL, nil];
}
return self;
}
#pragma mark - Auth flow methods
- (DBOAuthResult *)handleRedirectURL:(NSURL *)url {
// check if url is a cancel url
if (([[url host] isEqualToString:@"1"] && [[url path] isEqualToString:@"/cancel"]) ||
([[url host] isEqualToString:@"2"] && [[url path] isEqualToString:@"/cancel"])) {
return [[DBOAuthResult alloc] initWithCancel];
}
if (![self canHandleURL:url]) {
return nil;
}
DBOAuthResult *result = [self extractFromUrl:url];
if ([result isSuccess]) {
[DBSDKKeychain set:result.accessToken.uid value:result.accessToken.accessToken];
}
return result;
}
- (void)authorizeFromSharedApplication:(id<DBSharedApplication>)sharedApplication browserAuth:(BOOL)browserAuth {
void (^cancelHandler)() = ^{
[sharedApplication presentExternalApp:_cancelURL];
};
if ([[DBSDKReachability reachabilityForInternetConnection] currentReachabilityStatus] == DBNotReachable) {
NSString *message = @"Try again once you have an internet connection.";
NSString *title = @"No internet connection";
NSDictionary<NSString *, void (^)()> *buttonHandlers = @{
@"Cancel" : ^{
cancelHandler();
},
@"Retry" : ^{
[self authorizeFromSharedApplication:sharedApplication browserAuth:browserAuth];
},
};
[sharedApplication presentErrorMessageWithHandlers:message title:title buttonHandlers:buttonHandlers];
return;
}
if (![self conformsToAppScheme]) {
NSString *message = [NSString stringWithFormat:@"DropboxSDK: unable to link; app isn't registered for correct URL "
@"scheme (db-%@). Add this scheme to your project Info.plist file, "
@"associated with following key: \"Information Property List\" > "
@"\"URL types\" > \"Item 0\" > \"URL Schemes\" > \"Item <N>\".",
_appKey];
NSString *title = @"DropboxSDK Error";
[sharedApplication presentErrorMessage:message title:title];
return;
}
NSURL *url = [self authURL];
if ([self checkAndPresentPlatformSpecificAuth:sharedApplication]) {
return;
}
if (browserAuth) {
[sharedApplication presentBrowserAuth:url];
} else {
BOOL (^tryInterceptHandler)
(NSURL *) = ^BOOL(NSURL *url) {
if ([self canHandleURL:url]) {
[sharedApplication presentExternalApp:url];
return YES;
} else {
return NO;
}
};
[sharedApplication presentWebViewAuth:url tryInterceptHandler:tryInterceptHandler cancelHandler:cancelHandler];
}
}
- (BOOL)conformsToAppScheme {
NSString *appScheme = [NSString stringWithFormat:@"db-%@", _appKey];
NSArray *urlTypes = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"CFBundleURLTypes"] ?: @[];
for (NSDictionary *urlType in urlTypes) {
NSArray<NSString *> *schemes = [urlType objectForKey:@"CFBundleURLSchemes"];
for (NSString *scheme in schemes) {
if ([scheme isEqualToString:appScheme]) {
return YES;
}
}
}
return NO;
}
- (NSURL *)authURL {
NSURLComponents *components = [[NSURLComponents alloc] init];
components.scheme = @"https";
components.host = _host;
components.path = @"/oauth2/authorize";
components.queryItems = @[
[NSURLQueryItem queryItemWithName:@"response_type" value:@"token"],
[NSURLQueryItem queryItemWithName:@"client_id" value:_appKey],
[NSURLQueryItem queryItemWithName:@"redirect_uri" value:[_redirectURL absoluteString]],
[NSURLQueryItem queryItemWithName:@"disable_signup" value:@"true"],
];
return components.URL;
}
- (BOOL)canHandleURL:(NSURL *)url {
for (NSURL *known in _urls) {
if ([url.scheme isEqualToString:known.scheme] && [url.host isEqualToString:known.host] &&
[url.path isEqualToString:known.path]) {
return YES;
}
}
return NO;
}
- (DBOAuthResult *)extractFromRedirectURL:(NSURL *)url {
NSMutableDictionary *results = [[NSMutableDictionary alloc] init];
NSArray *pairs = [[url fragment] componentsSeparatedByString:@"&"] ?: @[];
for (NSString *pair in pairs) {
NSArray *kv = [pair componentsSeparatedByString:@"="];
[results setObject:[kv objectAtIndex:1] forKey:[kv objectAtIndex:0]];
}
if (results[@"error"]) {
NSString *desc = [[results[@"error_description"] stringByReplacingOccurrencesOfString:@"+" withString:@" "]
stringByRemovingPercentEncoding]
?: @"";
if ([results[@"error"] isEqualToString:@"access_denied"]) {
return [[DBOAuthResult alloc] initWithCancel];
}
return [[DBOAuthResult alloc] initWithError:results[@"error"] errorDescription:desc];
} else {
NSString *uid = results[@"uid"];
DBAccessToken *accessToken = [[DBAccessToken alloc] initWithAccessToken:results[@"access_token"] uid:uid];
return [[DBOAuthResult alloc] initWithSuccess:accessToken];
}
}
- (DBOAuthResult *)extractFromUrl:(NSURL *)url {
return [self extractFromRedirectURL:url];
}
- (BOOL)checkAndPresentPlatformSpecificAuth:(id<DBSharedApplication>)sharedApplication {
#pragma unused(sharedApplication)
return NO;
}
#pragma mark - Keychain methods
- (BOOL)storeAccessToken:(DBAccessToken *)accessToken {
return [DBSDKKeychain set:accessToken.uid value:accessToken.accessToken];
}
- (DBAccessToken *)getFirstAccessToken {
NSDictionary<NSString *, DBAccessToken *> *tokens = [self getAllAccessTokens];
NSArray *values = [tokens allValues];
if ([values count] != 0) {
return [values objectAtIndex:0];
}
return nil;
}
- (DBAccessToken *)getAccessToken:(NSString *)owner {
NSString *accessToken = [DBSDKKeychain get:owner];
if (accessToken != nil) {
return [[DBAccessToken alloc] initWithAccessToken:accessToken uid:owner];
} else {
return nil;
}
}
- (NSDictionary<NSString *, DBAccessToken *> *)getAllAccessTokens {
NSArray<NSString *> *users = [DBSDKKeychain getAll];
NSMutableDictionary<NSString *, DBAccessToken *> *result = [[NSMutableDictionary alloc] init];
for (NSString *user in users) {
NSString *accessToken = [DBSDKKeychain get:user];
if (accessToken != nil) {
result[user] = [[DBAccessToken alloc] initWithAccessToken:accessToken uid:user];
}
}
return result;
}
- (BOOL)hasStoredAccessTokens {
return [self getAllAccessTokens].count != 0;
}
- (BOOL)clearStoredAccessToken:(DBAccessToken *)token {
return [DBSDKKeychain delete:token.uid];
}
- (BOOL)clearStoredAccessTokens {
return [DBSDKKeychain clear];
}
@end
#pragma mark - OAuth manager base (macOS)
@implementation DBDesktopOAuthManager
@end
#pragma mark - OAuth manager base (iOS)
static NSString *kDBLinkNonce = @"dropbox.sync.nonce";
@interface DBMobileOAuthManager ()
// "re-declaring" private variables from parent (with @dynamic tag in @implementation)
@property (nonatomic, copy) NSString * _Nullable appKey;
@property (nonatomic, copy) NSURL * _Nullable redirectURL;
@property (nonatomic, copy) NSString * _Nullable host;
@property (nonatomic, copy) NSMutableArray<NSURL *> * _Nullable urls;
/// The redirect url from the mobile "direct auth" flow, wherein
/// authorization is received from an official Dropbox mobile app,
/// if one exists.
@property (nonatomic, copy) NSURL * _Nullable dauthRedirectURL;
@end
@implementation DBMobileOAuthManager
@dynamic appKey;
@dynamic redirectURL;
@dynamic host;
@dynamic urls;
- (instancetype)initWithAppKey:(NSString *)appKey {
self = [super initWithAppKey:appKey];
if (self) {
_dauthRedirectURL = [NSURL URLWithString:[NSString stringWithFormat:@"db-%@://1/connect", appKey]];
[self.urls addObject:_dauthRedirectURL];
}
return self;
}
- (instancetype)initWithAppKey:(NSString *)appKey host:(NSString *)host {
self = [super initWithAppKey:appKey host:host];
if (self) {
_dauthRedirectURL = [NSURL URLWithString:[NSString stringWithFormat:@"db-%@://1/connect", appKey]];
[self.urls addObject:_dauthRedirectURL];
}
return self;
}
- (DBOAuthResult *)extractFromUrl:(NSURL *)url {
DBOAuthResult *result;
if ([url.host isEqualToString:@"1"]) { // dauth
result = [self extractfromDAuthURL:url];
} else {
result = [self extractFromRedirectURL:url];
}
return result;
}
- (BOOL)checkAndPresentPlatformSpecificAuth:(id<DBSharedApplication>)sharedApplication {
if (![self hasApplicationQueriesSchemes]) {
NSString *message = @"DropboxSDK: unable to link; app isn't registered to query for URL schemes dbapi-2 and "
@"dbapi-8-emm. In your project's Info.plist file, add a \"dbapi-2\" value and a "
@"\"dbapi-8-emm\" value associated with the following keys: \"Information Property List\" > "
@"\"LSApplicationQueriesSchemes\" > \"Item <N>\" and \"Item <N+1>\".";
NSString *title = @"ObjectiveDropbox Error";
[sharedApplication presentErrorMessage:message title:title];
return YES;
}
NSString *scheme = [self dAuthScheme:sharedApplication];
if (scheme != nil) {
NSString *nonce = [[NSUUID alloc] init].UUIDString;
[[NSUserDefaults standardUserDefaults] setObject:nonce forKey:kDBLinkNonce];
[[NSUserDefaults standardUserDefaults] synchronize];
[sharedApplication presentExternalApp:[self dAuthURL:scheme nonce:nonce]];
return YES;
}
return NO;
}
- (NSURL *)dAuthURL:(NSString *)scheme nonce:(NSString *)nonce {
NSURLComponents *components = [[NSURLComponents alloc] init];
components.scheme = scheme;
components.host = @"1";
components.path = @"/connect";
if (nonce != nil) {
NSString *state = [NSString stringWithFormat:@"oauth2:%@", nonce];
components.queryItems = @[
[NSURLQueryItem queryItemWithName:@"k" value:self.appKey],
[NSURLQueryItem queryItemWithName:@"s" value:@""],
[NSURLQueryItem queryItemWithName:@"state" value:state],
];
}
return components.URL;
}
- (NSString *)dAuthScheme:(id<DBSharedApplication>)sharedApplication {
if ([sharedApplication canPresentExternalApp:[self dAuthURL:@"dbapi-2" nonce:nil]]) {
return @"dbapi-2";
} else if ([sharedApplication canPresentExternalApp:[self dAuthURL:@"dbapi-8-emm" nonce:nil]]) {
return @"dbapi-8-emm";
} else {
return nil;
}
}
- (DBOAuthResult *)extractfromDAuthURL:(NSURL *)url {
NSString *path = url.path;
if (path != nil) {
if ([path isEqualToString:@"/connect"]) {
NSMutableDictionary<NSString *, NSString *> *results = [[NSMutableDictionary alloc] init];
NSArray<NSString *> *pairs = [url.query componentsSeparatedByString:@"&"] ?: @[];
for (NSString *pair in pairs) {
NSArray *kv = [pair componentsSeparatedByString:@"="];
[results setObject:[kv objectAtIndex:1] forKey:[kv objectAtIndex:0]];
}
NSArray<NSString *> *state = [results[@"state"] componentsSeparatedByString:@"%3A"];
NSString *nonce = (NSString *)[[NSUserDefaults standardUserDefaults] objectForKey:kDBLinkNonce];
if (state.count == 2 && [state[0] isEqualToString:@"oauth2"] && [state[1] isEqualToString:nonce]) {
NSString *accessToken = results[@"oauth_token_secret"];
NSString *uid = results[@"uid"];
return [[DBOAuthResult alloc] initWithSuccess:[[DBAccessToken alloc] initWithAccessToken:accessToken uid:uid]];
} else {
return [[DBOAuthResult alloc] initWithError:@"" errorDescription:@"Unable to verify link request."];
}
}
}
return nil;
}
- (BOOL)hasApplicationQueriesSchemes {
NSArray<NSString *> *queriesSchemes =
[[NSBundle mainBundle] objectForInfoDictionaryKey:@"LSApplicationQueriesSchemes"];
BOOL foundApi2 = NO;
BOOL foundApi8Emm = NO;
for (NSString *scheme in queriesSchemes) {
if ([scheme isEqualToString:@"dbapi-2"]) {
foundApi2 = YES;
} else if ([scheme isEqualToString:@"dbapi-8-emm"]) {
foundApi8Emm = YES;
}
if (foundApi2 && foundApi8Emm) {
return YES;
}
}
return NO;
}
@end
#pragma mark - Access token class
@implementation DBAccessToken
- (instancetype)initWithAccessToken:(NSString *)accessToken uid:(NSString *)uid {
self = [super init];
if (self) {
_accessToken = accessToken;
_uid = uid;
}
return self;
}
- (NSString *)description {
return _accessToken;
}
@end