Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codefiesta/OAuthKit
A Swift Package for OAuth 2.0
https://github.com/codefiesta/OAuthKit
ios macos oauth2 swift swift-package-manager swiftui visionos
Last synced: 4 months ago
JSON representation
A Swift Package for OAuth 2.0
- Host: GitHub
- URL: https://github.com/codefiesta/OAuthKit
- Owner: codefiesta
- License: mit
- Created: 2024-05-29T03:10:07.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-08-17T16:11:10.000Z (6 months ago)
- Last Synced: 2024-08-17T17:28:31.647Z (6 months ago)
- Topics: ios, macos, oauth2, swift, swift-package-manager, swiftui, visionos
- Language: Swift
- Homepage:
- Size: 41 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-visionOS - OAuthKit
README
[](https://opensource.org/licenses/MIT)
# OAuthKit
OAuthKit is a modern, event-driven Swift Package that leverages the [Combine](https://developer.apple.com/documentation/combine) Framework to publish [OAuth 2.0](https://oauth.net/2/) events which allows application developers to easily configure OAuth Providers and focus on making great applications instead of focusing on the details of authorization flows.
## OAuthKit Usage
The following is an example of the simplest usage of using OAuthKit in macOS:
```swift
import OAuthKit
import SwiftUI
@main
struct OAuthApp: App {
@Environment(\.oauth)
var oauth: OAuth
/// Build the scene body
var body: some Scene {
WindowGroup {
ContentView()
}.environmentObject(oauth)
WindowGroup(id: "oauth") {
OAWebView()
}.environmentObject(oauth)
}
}
struct ContentView: View {
@Environment(\.openWindow)
var openWindow
@Environment(\.dismissWindow)
private var dismissWindow
@EnvironmentObject
var oauth: OAuth
var body: some View {
VStack {
switch oauth.state {
case .empty:
providerList
case .authorizing(let provider):
Text("Authorizing [\(provider.id)]")
case .requestingAccessToken(let provider):
Text("Requesting Access Token [\(provider.id)]")
case .authorized(let auth):
Button("Authorized [\(auth.provider.id)]") {
oauth.clear()
}
}
}
.onReceive(oauth.$state) { state in
handle(state: state)
}
}
/// Displays a list of oauth providers.
var providerList: some View {
List(oauth.providers) { provider in
Button(provider.id) {
// Start the authorization flow
oauth.authorize(provider: provider)
}
}
}
/// Reacts to oauth state changes by opening or closing authorization windows.
/// - Parameter state: the published state change
private func handle(state: OAuth.State) {
switch state {
case .empty, .requestingAccessToken:
break
case .authorizing(let provider):
openWindow(id: "oauth")
case .authorized(_):
dismissWindow(id: "oauth")
}
}
}
```
## OAuthKit Configuration
By default, the easiest way to configure OAuthKit is to simply drop an `oauth.json` file into your main bundle and it will get automatically loaded into your swift application and available as an [EnvironmentObject](https://developer.apple.com/documentation/swiftui/environmentobject). You can find an example `oauth.json` file [here](https://github.com/codefiesta/OAuthKit/blob/main/Tests/OAuthKitTests/Resources/oauth.json).
```swift
@EnvironmentObject
var oauth: OAuth
```
If you want to customize your OAuth environment or are using modules in your application, you can also specify which bundle to load configure files from:
```swift
let oauth: OAuth = .init(.module)
```
If you are building your OAuth Providers programatically (recommended for production applications via a CI build pipeline for security purposes), you can pass providers and options as well.
```swift
let providers: [OAuth.Provider] = ...
let options: [OAuth.Option: Any] = [.applicationTag: "com.bundle.identifier"]
let oauth: OAuth = .init(providers: providers, options: options)
```
## Security Best Practices
Although OAuthKit will automatically try to load the `oauth.json` file found inside your main bundle (or bundle passed to the initializer) for convenience purposes, it is good policy to **NEVER** check in **clientID** or **clientSecret** values into source control. Also, it is possible for someone to [inspect and reverse engineer](https://www.nowsecure.com/blog/2021/09/08/basics-of-reverse-engineering-ios-mobile-apps/) the contents of your app and look at any files inside your app bundle which means you could potentially expose these secrets in the `oauth.json` file. The most secure way to protect OAuth secrets is to build your Providers programatically and bake [secret values](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) into your code via your CI pipeline.
## OAuth Providers
* [Github](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps)
* [Google](https://developers.google.com/identity/protocols/oauth2)
* [Instagram](https://developers.facebook.com/docs/instagram-basic-display-api/guides/getting-access-tokens-and-permissions)
* [Microsoft](https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-auth-code-flow)
* [Slack](https://api.slack.com/authentication/oauth-v2)
* [Twitter](https://developer.x.com/en/docs/authentication/oauth-2-0)