Swiftpack.co - Package - OAuthSwift/OAuthSwift

OAuthSwift

OAuthSwift

Swift based OAuth library for iOS and macOS.

Support OAuth1.0, OAuth2.0

Twitter, Flickr, Github, Instagram, Foursquare, Fitbit, Withings, Linkedin, Dropbox, Dribbble, Salesforce, BitBucket, GoogleDrive, Smugmug, Intuit, Zaim, Tumblr, Slack, Uber, Gitter, Facebook, Spotify, Typetalk, SoundCloud, etc

Installation

OAuthSwift is packaged as a Swift framework. Currently this is the simplest way to add it to your app:

  • Drag OAuthSwift.xcodeproj to your project in the Project Navigator.
  • Select your project and then your app target. Open the Build Phases panel.
  • Expand the Target Dependencies group, and add OAuthSwift framework.
  • import OAuthSwift whenever you want to use OAuthSwift.

Support Carthage

  • Install Carthage (https://github.com/Carthage/Carthage)
  • Create Cartfile file
github "OAuthSwift/OAuthSwift" ~> 2.0.0
  • Run carthage update.
  • On your application targets’ “General” settings tab, in the “Embedded Binaries” section, drag and drop OAuthSwift.framework from the Carthage/Build/iOS folder on disk.

Support CocoaPods

  • Podfile
platform :ios, '10.0'
use_frameworks!

pod 'OAuthSwift', '~> 2.0.0'

Old versions

swift 3

Use the swift3 branch, or the tag 1.1.2 on main branch

swift 4

Use the tag 1.2.0 on main branch

objective c

Use the tag 1.4.1 on main branch

How to

Setting URL Schemes

In info tab of your target Image Replace oauth-swift by your application name

Handle URL in AppDelegate

  • On iOS implement UIApplicationDelegate method
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey  : Any] = [:]) -> Bool {
  if (url.host == "oauth-callback") {
    OAuthSwift.handle(url: url)
  }
  return true
}

:warning: Any other application may try to open a URL with your url scheme. So you can check the source application, for instance for safari controller :

if (options[.sourceApplication] as? String == "com.apple.SafariViewService") {
  • On macOS you must register an handler on NSAppleEventManager for event type kAEGetURL (see demo code)
func applicationDidFinishLaunching(_ aNotification: NSNotification) {
    NSAppleEventManager.shared().setEventHandler(self, andSelector:#selector(AppDelegate.handleGetURL(event:withReplyEvent:)), forEventClass: AEEventClass(kInternetEventClass), andEventID: AEEventID(kAEGetURL))
}
func handleGetURL(event: NSAppleEventDescriptor!, withReplyEvent: NSAppleEventDescriptor!) {
    if let urlString = event.paramDescriptor(forKeyword: AEKeyword(keyDirectObject))?.stringValue, let url = URL(string: urlString) {
        OAuthSwift.handle(url: url)
    }
}

Authorize with OAuth1.0

// create an instance and retain it
oauthswift = OAuth1Swift(
    consumerKey:    "********",
    consumerSecret: "********",
    requestTokenUrl: "https://api.twitter.com/oauth/request_token",
    authorizeUrl:    "https://api.twitter.com/oauth/authorize",
    accessTokenUrl:  "https://api.twitter.com/oauth/access_token"
)
// authorize
let handle = oauthswift.authorize(
    withCallbackURL: URL(string: "oauth-swift://oauth-callback/twitter")!) { result in
    switch result {
    case .success(let (credential, response, parameters)):
      print(credential.oauthToken)
      print(credential.oauthTokenSecret)
      print(parameters["user_id"])
      // Do your request
    case .failure(let error):
      print(error.localizedDescription)
    }             
}

OAuth1 without authorization

No urls to specify here

// create an instance and retain it
oauthswift = OAuth1Swift(
    consumerKey:    "********",
    consumerSecret: "********"
)
// do your HTTP request without authorize
oauthswift.client.get("https://api.example.com/foo/bar") { result in
    switch result {
    case .success(let response):
        //....
    case .failure(let error):
        //...
    }
}

Authorize with OAuth2.0

// create an instance and retain it
oauthswift = OAuth2Swift(
    consumerKey:    "********",
    consumerSecret: "********",
    authorizeUrl:   "https://api.instagram.com/oauth/authorize",
    responseType:   "token"
)
let handle = oauthswift.authorize(
    withCallbackURL: URL(string: "oauth-swift://oauth-callback/instagram")!,
    scope: "likes+comments", state:"INSTAGRAM") { result in
    switch result {
    case .success(let (credential, response, parameters)):
      print(credential.oauthToken)
      // Do your request
    case .failure(let error):
      print(error.localizedDescription)
    }
}

Authorize with OAuth2.0 and proof key flow (PKCE)

// create an instance and retain it
oauthswift = OAuth2Swift(
    consumerKey:    "********",
    consumerSecret: "********",
    authorizeUrl: "https://server.com/oauth/authorize",
    responseType: "code"
)
oauthswift.accessTokenBasicAuthentification = true

let codeVerifier = base64url("abcd...")
let codeChallenge = codeChallenge(for: codeVerifier)

let handle = oauthswift.authorize(
    withCallbackURL: URL(string: "myApp://callback/")!,
    scope: "requestedScope", 
    state:"State01",
    codeChallenge: codeChallenge,
    codeChallengeMethod: "S256",
    codeVerifier: codeVerifier) { result in
    switch result {
    case .success(let (credential, response, parameters)):
      print(credential.oauthToken)
      // Do your request
    case .failure(let error):
      print(error.localizedDescription)
    }
}

See demo for more examples

Handle authorize URL

The authorize URL allows the user to connect to a provider and give access to your application.

By default this URL is opened into the external web browser (ie. safari), but apple does not allow it for app-store iOS applications.

To change this behavior you must set an OAuthSwiftURLHandlerType, simple protocol to handle an URL

oauthswift.authorizeURLHandler = ..

For instance you can embed a web view into your application by providing a controller that displays a web view (UIWebView, WKWebView). Then this controller must implement OAuthSwiftURLHandlerType to load the URL into the web view

func handle(_ url: NSURL) {
  let req = URLRequest(URL: targetURL)
  self.webView.loadRequest(req)
  ...

and present the view (present(viewController, performSegue(withIdentifier:, ...) You can extend OAuthWebViewController for a default implementation of view presentation and dismiss

Use the SFSafariViewController (iOS9)

A default implementation of OAuthSwiftURLHandlerType is provided using the SFSafariViewController, with automatic view dismiss.

oauthswift.authorizeURLHandler = SafariURLHandler(viewController: self, oauthSwift: oauthswift)

Of course you can create your own class or customize the controller by setting the variable SafariURLHandler#factory.

Make signed request

Just call HTTP functions of oauthswift.client

oauthswift.client.get("https://api.linkedin.com/v1/people/~") { result in
    switch result {
    case .success(let response):
        let dataString = response.string
        print(dataString)
    case .failure(let error):
        print(error)
    }
}
// same with request method
oauthswift.client.request("https://api.linkedin.com/v1/people/~", .GET,
      parameters: [:], headers: [:],
      completionHandler: { ...

See more examples in the demo application: ViewController.swift

OAuth provider pages

Images

Image Image Image

Contributing

See CONTRIBUTING.md

Add a new service in demo app

Integration

OAuthSwift could be used with others frameworks

You can sign Alamofire request with OAuthSwiftAlamofire

To achieve great asynchronous code you can use one of these integration frameworks

License

OAuthSwift is available under the MIT license. See the LICENSE file for more info.

License Platform Language Cocoapod Carthage compatible Build Status

Github

link
Stars: 2355
Help us keep the lights on

Dependencies

Used By

Total:

Releases

2.0.0 - Jun 10, 2019

Big breaking change on callback closure!

Result type is now used to merge the success and failure closure into one.

oauthswift.authorize(..) { result in
    switch result {
    case .success(let (credential, response, parameters)):
      // do something
    case .failure(let error):
      // do something
    }  
}
oauthswift.client.get(...) { result in
    switch result {
    case .success(let response):
        // do something
    case .failure(let error):
        // do something
    }
}

You can use the previous version 1.4.x if you do not want to upgrade your code

1.4.1 - Jun 10, 2019

Revert change for #522

  • no need to retain authorizeURLHandler
  • but to break memory cycle you can call .weak() on your OAuthSwiftURLHandlerType

1.4.0 - Jun 10, 2019

swift 5 @alex-taffe Add Safari views for iOS 11+ @SMillerDev

Fix #492 : option useRFC3986ToEncodeToken on OAutSwift1 Fix #509 : change on error domain, no more use of URLErrorDomain Fix #522 : now authorizeURLHandler attribute are "weak" to break cycle -> you must retain your object elsewhere to not be deallocated

1.1.2 - Jun 4, 2017

New

  • add encodeCallbackURL to oauth 2 to URL encore callback URL. Seems to be needed for some services issue #339, pr #325
  • in SafariURLHandler presentViewControllerAnimated variable added by @felipeflorencio
  • Optionally add callback URL to authorize URL using addCallbackURLToAuthorizeURL field of OAuth1Swift , as requested by PR #373
  • add NounProject and Digu to demo app

Change

  • swift 3.1 warning @patricks @hiragram
  • restore OAuth1Swift init without URL parameters @josephquigley
  • Allow changing grand type of device token authorisation Fix #377
  • Add parameters parameter to renewAccessToken @wesley-dynamicowl

Fix

  • Do not send oauth_verifier query parameter if not necessary ie. if allowMissingOAuthVerifier=true, Fix #334
  • Fix a crash when encoding credentials in a test target @eunikolsky

1.1.1 - Feb 26, 2017

Change

  • Now success Handler return a OAuthSwiftResponse, which contains the Data, the HTTPURLResponse and URLRequest
    • On this object you can get decoded json object, string value, ...
    • You can extends OAuthSwiftResponse to use some JSON decoded like SwiftyJSON or any object mapper
  • If there is some problem to encode URL with OAuth2, "handle" is not returned (request is cancelled)

New

  • OAuthSwiftError implement CustomNSError protocol
  • Ability to specify body data for POST request
  • Add wordpress in demo

Fix

  • Fix multipart request with some parameter #287 @ktakayama
  • Fix OAuthSwiftCredential.Version init(:) error @bzmario