Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Colaski/SwAuth
OAuth 2.0 library using async/await written in Swift.
https://github.com/Colaski/SwAuth
async-await device-flow ios macos oauth2 oauth2-authentication oauth2-client oauth2-flow pkce-flow swauth swift swift-package-manager tvos watchos
Last synced: 3 months ago
JSON representation
OAuth 2.0 library using async/await written in Swift.
- Host: GitHub
- URL: https://github.com/Colaski/SwAuth
- Owner: Colaski
- License: mit
- Archived: true
- Created: 2021-11-25T08:38:34.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-05T02:07:32.000Z (about 2 years ago)
- Last Synced: 2023-03-10T20:56:56.291Z (almost 2 years ago)
- Topics: async-await, device-flow, ios, macos, oauth2, oauth2-authentication, oauth2-client, oauth2-flow, pkce-flow, swauth, swift, swift-package-manager, tvos, watchos
- Language: Swift
- Homepage: https://swauth.netlify.app/documentation/Swauth
- Size: 1.03 MB
- Stars: 18
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
**This repository is now archived as my time has become limited and my interest in Apple development has waned.**
# SwAuth [](https://github.com/Colaski/SwAuth#license) 
[](https://app.codacy.com/gh/Colaski/SwAuth?utm_source=github.com&utm_medium=referral&utm_content=Colaski/SwAuth&utm_campaign=Badge_Grade_Settings)
[](https://github.com/Colaski/SwAuth/actions/workflows/build.yml)
SwAuth is an OAuth 2.0 HTTP request library written in Swift for iOS 13.0+, macOS 10.15+, watchOS 6.0+, and tvOS 13.0+.
- [Features](#features)
- [Built-in Support](#built-in-support)
- [Requirements](#requirements)
- [Installation/Integration](#installationintegration)
- [Swift Package](#swift-package)
- [App](#app)
- [Basic Usage](#basic-usage)
- [Contributing](#contributing)
- [License](#license)
## Features
- [x] Beautiful readable syntax with async/await! Kiss completion handler hell and the closure jungle goodbye!
- [x] Supports Authorization Code Grant (RFC 6749/6750), Proof Key for Code Exchange (PKCE) extension for Authorization Code Grant (RFC 7636), and the Device Authorization Grant (RFC 8628).
- [x] Support for all Apple device platforms.
- [x] Retry errored requests.
- [x] Automatically refreshes tokens.
- [x] Tokens stored on Keychain and cross-site request forgery mitigation by default.
- [x] Easily deal with JSON responses with [SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON) built-in.
- [x] Easily integrate with SwiftUI.
- [x] [Complete, meticulous, thorough, documentation.](https://swauth.netlify.app/documentation/Swauth)
- [x] Errors that are probably, maybe, useful.
- [x] Built on [SwiftNIO](https://github.com/apple/swift-nio) with [AsyncHTTPClient](https://github.com/swift-server/async-http-client).
- [x] QR Code for the Device Authorization Flow (tvOS/watchOS).
- [x] Sample/Example Apps.
- [x] Built- in support for some popular Web APIs.
### Built-in Support
SwAuth has build in support for some Web API's with more to come:
- [Spotify](https://swauth.netlify.app/documentation/swauth/spotify)
## Requirements
- Xcode 13.2+
- iOS 13.0+ | macOS 10.15+ | watchOS 6.0+ | tvOS 13.0+
## Installation/Integration
### Swift Package
Use the Swift Package Manager to add SwAuth to your project! Simply add the package to dependencies in your `Package.swift`:
```swift
// swift-tools-version:5.5
import PackageDescription
let package = Package(
name: "YourPackageName",
products: [
.library(name: "YourPackageName", targets: ["YourPackageName"]),
],
dependencies: [
.package(url: "https://github.com/Colaski/SwAuth.git", from: "1.0.1"),
],
targets: [
.target(name: "YourPackageName", dependencies: ["SwAuth"]),
]
)
```
### App
Select `File > Add Packages` in Xcode and enter `https://github.com/Colaski/SwAuth.git`
Xcode should take care of the rest!
## Basic Usage
1. Import SwAuth in files you wish to use it's amazing features:
```swift
import SwAuth
```
2. Create an instance of keychain:
```swift
let keychain = Keychain(service: "com.your.bundleID",
accessGroup: "appIdentifierPrefix.com.your.bundleID").label("Your App Name")
```
SwAuth uses KeychainAccess to make setting up the keychain easy. You can see a full list of options for it here: [https://github.com/kishikawakatsumi/KeychainAccess#key-configuration-accessibility-sharing-icloud-sync](https://github.com/kishikawakatsumi/KeychainAccess#key-configuration-accessibility-sharing-icloud-sync).
3. Create an instance of the proper authorization flow for your Web API.
```swift
let keychain = Keychain(service: "com.your.bundleID",
accessGroup: "appIdentifierPrefix.com.your.bundleID").label("Your App Name")
var spotify = PKCEAuthorizationFlow(clientID: "YourClientID",
authorizationEndpoint: URL(string: "https://accounts.spotify.com/authorize")!,
tokenEndpoint: URL(string: "https://accounts.spotify.com/api/token")!,
redirectURI: "someapp://callback",
keychain: keychain,
scopes: "user-follow-modify")
spotify.additionalRefreshTokenBodyParams = ["client_id": "YourClientID"] // Spotify specifically requires the client ID to be included in the refresh token's body parameters.
```
4. Start an ASWebAuthenticationSession like in the [example app](https://github.com/Colaski/SwAuth/blob/main/SwAuthTestApp/SwAuthTestApp/ProviderView.swift#L94) with the instance's authorization URL:
```swift
spotify.authorizationURL
```
5. Pass the callback URL from the ASWebAuthenticationSession into the provided handler method:
```swift
do {
try await spotify.authorizationResponseHandler(for: callbackURL)
} catch {
print(error.localizedDescription)
}
```
6. Make an authorized request:
```swift
do {
// https://developer.spotify.com/documentation/web-api/reference/#/operations/follow-artists-users
var request = HTTPRequest(endpoint: URL(sting: "https://api.spotify.com/v1/me/following")!)
request.httpMethod = .PUT
request.endpointQueryItems = ["type": "artist"]
request.httpBody = ["ids": ["5K4W6rqBFWDnAN6FQUkS6x"]]
request.bodyEncoding = .JSON
// Send an authenticated HTTP request, this one will follow the artist Kanye West on Spotify.
let json = try await spotify.authenticatedRequest(for: request, numberOfRetries: 2).json()
// Prints the JSON output
print(json)
} catch {
print(error.localizedDescription)
}
```
For more information, read my beautiful documentation: [https://swauth.netlify.app/documentation/Swauth](https://swauth.netlify.app/documentation/Swauth)
## Contributing
Check out [CONTRIBUTING.md](./CONTRIBUTING.md) for information!
## License
SwAuth its self is licensed under the [MIT License](./LICENSE), however please take notice of the [NOTICE](./NOTICE.md) file in the root of this repository. Also, make sure to check the respective licenses of this library's dependencies before releasing your project.