BDBOAuth1Manager

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #llm #golang #go #android #linux #docker #windows #awesome #cli #security

BDBOAuth1Manager

(★ 99)

OAuth 1.0a library for AFNetworking 2.x

파일 탐색기

최종 버전 다운로드 (.zip)

- - NSDictionary+BDBOAuth1Manager.h
  - NSDictionary+BDBOAuth1Manager.m
  - NSString+BDBOAuth1Manager.h
  - NSString+BDBOAuth1Manager.m
- BDBOAuth1RequestSerializer.h
- BDBOAuth1RequestSerializer.m
- BDBOAuth1SessionManager.h
- BDBOAuth1SessionManager.m
- - project.pbxproj
- - contents.xcworkspacedata
- - AppDelegate.h
  - AppDelegate.m
- - AppDelegate.h
  - AppDelegate.m
- Podfile
- Podfile.lock
.gitignore
BDBOAuth1Manager.podspec
LICENSE
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# BDBOAuth1Manager

BDBOAuth1Manager is an OAuth 1.0a library for AFNetworking 2.x.

## Usage

BDBOAuth1Manager consists of three core classes: `BDBOAuth1RequestSerializer`, `BDBOAuth1RequestOperationManger`, and `BDBOAuth1SessionManager`. Below I will provide a quick overview of each, but to really see how the three classes work together, take a look at the included demo apps. One is a simple Twitter client and the other a simple Flickr photo gallery, but they show how to get started using BDBOAuth1Manager in your projects.

### BDBOAuth1RequestOperationManger

`BDBOAuth1RequestOperationManger` is a subclass of `AFHTTPRequestOperationManager` that provides methods to facilitate the OAuth 1 authentication flow.

```objective-c
@property (nonatomic) BDBOAuth1RequestSerializer *requestSerializer;

#pragma mark Initialization
- (instancetype)initWithBaseURL:(NSURL *)baseURL
                    consumerKey:(NSString *)consumerKey
                 consumerSecret:(NSString *)consumerSecret;

#pragma mark Authorization Status
@property (nonatomic, assign, readonly, getter = isAuthorized) BOOL authorized;

- (BOOL)deauthorize;

#pragma mark OAuth Handshake
- (void)fetchRequestTokenWithPath:(NSString *)requestPath
                           method:(NSString *)method
                      callbackURL:(NSURL *)callbackURL
                            scope:(NSString *)scope
                          success:(void (^)(BDBOAuth1Credential *requestToken))success
                          failure:(void (^)(NSError *error))failure;

- (void)fetchAccessTokenWithPath:(NSString *)accessPath
                          method:(NSString *)method
                    requestToken:(BDBOAuth1Credential *)requestToken
                         success:(void (^)(BDBOAuth1Credential *accessToken))success
                         failure:(void (^)(NSError *error))failure;
```

### BDBOAuth1SessionManager

`BDBOAuth1SessionManager` is a subclass of `AFHTTPSessionManager` that has the same API as `BDBOAuth1RequestOperationManger`, which is described above.

If your deployment target is either iOS 6 or OS X 10.8, you must use `BDBOAuth1RequestOperationManger`, as the underlying `NSURLSession` that is used by `AFHTTPSessionManager` is a new addition to the iOS and OS X networking frameworks for iOS 7 and OS X 10.9.

### BDBOAuth1RequestSerializer

`BDBOAuth1RequestSerializer` is a subclass of `AFHTTPRequestSerializer` that handles all the networking requests performed by `BDBOAuth1RequestOperationManger` and `BDBOAuth1SessionManager`. Both classes automatically handle the creation of this serializer, so you should never have to instantiate it on your own.

`BDBOAuth1RequestSerializer` also has built-in support for storing and retrieving an OAuth access token to/from the user's keychain, utilizing the service name to differentiate tokens. `BDBOAuth1RequestOperationManger` and `BDBOAuth1SessionManager` automatically set the service name to baseURL.host (e.g. api.twitter.com) when they are instantiated.

## OAuth Handshake

The first step in performing the OAuth handshake is getting an OAuth request token for your application. This can be done with the `fetchRequestTokenWithPath:method:callbackURL:scope:success:failure:` method.

```objective-c
[self.networkManager fetchRequestTokenWithPath:@"/oauth/request_token"
                                        method:@"POST"
                                   callbackURL:[NSURL URLWithString:@"bdboauth://request"]
                                         scope:nil
                                       success:^(BDBOAuth1Credential *requestToken) {
                                           NSString *authURL = [NSString stringWithFormat:@"https://api.twitter.com/oauth/authorize?oauth_token=%@", requestToken.token];
                                           [[UIApplication sharedApplication] openURL:[NSURL URLWithString:authURL]];
                                       }
                                       failure:^(NSError *error) {
                                           NSLog(@"Error: %@", error.localizedDescription);
                                       }];
```

### Creating a URL Type for OAuth Callbacks

When calling `fetchRequestTokenWithPath:method:callbackURL:scope:success:failure:`, you must provide a unique callback URL whose scheme corresponds to a URL type you've added to your project target. This allows the OAuth provider to return the user to your app after the user has authorized it. For example, if I add a URL type to my project with the scheme `bdboauth`, my application would then respond to all URL requests that begin with `bdboauth:`. If I pass `bdboauth://request` as the callback URL, the OAuth provider would call that URL and my application would resume.

![URL Types Screenshot](https://dl.dropboxusercontent.com/u/6225/GitHub/BDBOAuth1Manager/urltypes.png)

### Responding to the OAuth Callback URL

In order to respond to your application's URL scheme being called, you must implement the `-application:openURL:sourceApplication:annotation` method within your application delegate. You can do something like this:

```objective-c
- (BOOL)application:(UIApplication *)application
            openURL:(NSURL *)url
  sourceApplication:(NSString *)sourceApplication
         annotation:(id)annotation {
	if ([url.scheme isEqualToString:@"bdboauth"]) {
		if ([url.host isEqualToString:@"request"]) {
			NSDictionary *parameters = [url dictionaryFromQueryString];
			if (parameters[@"oauth_token"] && parameters[@"oauth_verifier"]) {
				[self.networkManager fetchAccessTokenWithPath:@"/oauth/access_token"
                	                                   method:@"POST"
                    	                         requestToken:[BDBOAuth1Credential credentialWithQueryString:url.query]
                        	                          success:^(BDBOAuth1Credential *accessToken) {
                            	                          [self.networkManager.requestSerializer saveAccessToken:accessToken];
                                	                  }];
			}
		}
		return YES;
	}
    return NO;
}
```

## Credits

BDBOAuth1Manager was created by [Bradley David Bergeron](http://www.bradbergeron.com) and influenced by [AFOAuth1Client](https://github.com/AFNetworking/AFOAuth1Client). Both [AFNetworking](https://github.com/AFNetworking/AFNetworking) and [AFOAuth1Client](https://github.com/AFNetworking/AFOAuth1Client) are the awesome work of [Mattt Thompson](https://github.com/mattt).

BDBOAuth1Manager

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

BDBOAuth1Manager

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README