Swift based OAuth library for iOS and macOS.
Twitter, Flickr, Github, Instagram, Foursquare, Fitbit, Withings, Linkedin, Dropbox, Dribbble, Salesforce, BitBucket, GoogleDrive, Smugmug, Intuit, Zaim, Tumblr, Slack, Uber, Gitter, Facebook, Spotify, Typetalk, SoundCloud, Twitch, Reddit, etc
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.
- Install Carthage (https://github.com/Carthage/Carthage)
- Create
Cartfilefile
github "OAuthSwift/OAuthSwift" ~> 2.2.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.
- Podfile
platform :ios, '10.0'
use_frameworks!
pod 'OAuthSwift', '~> 2.2.0'import PackageDescription
let package = Package(
name: "MyApp",
dependencies: [
.package(name: "OAuthSwift",
url: "https://github.com/OAuthSwift/OAuthSwift.git",
.upToNextMajor(from: "2.2.0"))
]
)Use the swift3 branch, or the tag 1.1.2 on main branch
Use the tag 1.2.0 on main branch
Use the tag 1.4.1 on main branch
In info tab of your target
Replace oauth-swift by your application name
- On iOS implement
UIApplicationDelegatemethod
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
if url.host == "oauth-callback" {
OAuthSwift.handle(url: url)
}
return true
}- On iOS 13, UIKit will notify
UISceneDelegateinstead ofUIApplicationDelegate. - Implement
UISceneDelegatemethod
func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
guard let url = URLContexts.first?.url else {
return
}
if url.host == "oauth-callback" {
OAuthSwift.handle(url: url)
}
}if options[.sourceApplication] as? String == "com.apple.SafariViewService" {- On macOS you must register a handler on
NSAppleEventManagerfor event typekAEGetURL(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)
}
}// 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: "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)
}
}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):
//...
}
}// create an instance and retain it
oauthswift = OAuth2Swift(
consumerKey: "********",
consumerSecret: "********",
authorizeUrl: "https://api.instagram.com/oauth/authorize",
responseType: "token"
)
let handle = oauthswift.authorize(
withCallbackURL: "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)
}
}// create an instance and retain it
oauthswift = OAuth2Swift(
consumerKey: "********",
consumerSecret: "********",
authorizeUrl: "https://server.com/oauth/authorize",
responseType: "code"
)
oauthswift.accessTokenBasicAuthentification = true
guard let codeVerifier = generateCodeVerifier() else {return}
guard let codeChallenge = generateCodeChallenge(codeVerifier: codeVerifier) else {return}
let handle = oauthswift.authorize(
withCallbackURL: "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
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
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.
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
- Flickr
- Github
- Foursquare
- Fitbit
- Withings
- Dropbox
- Dribbble
- Salesforce
- BitBucket
- GoogleDrive
- Smugmug
- Intuit
- Zaim
- Tumblr
- Slack
- Uber
- Gitter
- Spotify
- Trello
- Buffer
- Goodreads
- Typetalk
- SoundCloud
- Doper
- NounProject
See CONTRIBUTING.md
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
OAuthSwift is available under the MIT license. See the LICENSE file for more info.
