Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/perfectlysoft/perfect-oauth2
OAuth2 Implementations with Facebook, Google, LinkedIn, Slack, SalesForce and GitHub providers.
https://github.com/perfectlysoft/perfect-oauth2
oauth2 perfect server-side-swift swift
Last synced: about 2 months ago
JSON representation
OAuth2 Implementations with Facebook, Google, LinkedIn, Slack, SalesForce and GitHub providers.
- Host: GitHub
- URL: https://github.com/perfectlysoft/perfect-oauth2
- Owner: PerfectlySoft
- License: apache-2.0
- Created: 2017-06-08T17:37:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-28T18:49:42.000Z (almost 6 years ago)
- Last Synced: 2024-10-30T04:00:02.926Z (2 months ago)
- Topics: oauth2, perfect, server-side-swift, swift
- Language: Swift
- Homepage:
- Size: 38.1 KB
- Stars: 10
- Watchers: 6
- Forks: 10
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Perfect-Authentication
[](http://perfect.org/get-involved.html)
[](https://github.com/PerfectlySoft/Perfect)
[](https://gitter.im/PerfectlySoft/Perfect)
[](https://twitter.com/perfectlysoft)
[](http://perfect.ly)
[](https://developer.apple.com/swift/)
[](https://developer.apple.com/swift/)
[](http://perfect.org/licensing.html)
[](http://twitter.com/PerfectlySoft)
[](https://gitter.im/PerfectlySoft/Perfect?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](http://perfect.ly) [](https://badge.fury.io/gh/PerfectlySoft%2FPerfect-CURL)
## OAuth2 Library for Perfect
This project provides [OAuth2](https://oauth.net/2/) libraries and select OAuth2 provider drivers - Facebook, Google, GitHub.
Full documentation can be found at [http://www.perfect.org/docs/OAuth2.html](http://www.perfect.org/docs/OAuth2.html)
A demo application can be found at [https://github.com/PerfectExamples/Perfect-Authentication-Demo](https://github.com/PerfectExamples/Perfect-Authentication-Demo) that shows the usage of the system.
This package builds with Swift Package Manager and is part of the [Perfect](https://github.com/PerfectlySoft/Perfect) project. It was written to be stand-alone and so does not require PerfectLib or any other components.
Ensure you have installed and activated the latest Swift 4.0 tool chain.
## Adding to your project
Add this project as a dependency in your Package.swift file.
``` swift
.Package(url: "https://github.com/PerfectlySoft/Perfect-OAuth2.git", majorVersion: 3)
```
To then use the OAuth2 module in your code:
``` swift
import OAuth2
```
## Configuration
Each provider needs an "appid", also known as a "key", and a "secret". These are usually generated by the OAuth Host, such as Facebook, GitHub and Google developer consoles. These values, as well as an "endpointAfterAuth" and "redirectAfterAuth" value must be set for each provider you wish to use.
To configure Facebook as a provider:
``` swift
FacebookConfig.appid = "yourAppID"
FacebookConfig.secret = "yourSecret"
FacebookConfig.endpointAfterAuth = "http://localhost:8181/auth/response/facebook"
FacebookConfig.redirectAfterAuth = "http://localhost:8181/"
```
To configure Google as a provider:
``` swift
GoogleConfig.appid = "yourAppID"
GoogleConfig.secret = "yourSecret"
GoogleConfig.endpointAfterAuth = "http://localhost:8181/auth/response/google"
GoogleConfig.redirectAfterAuth = "http://localhost:8181/"
```
To configure GitHub as a provider:
``` swift
GitHubConfig.appid = "yourAppID"
GitHubConfig.secret = "yourSecret"
GitHubConfig.endpointAfterAuth = "http://localhost:8181/auth/response/github"
GitHubConfig.redirectAfterAuth = "http://localhost:8181/"
```
## Adding Routes
The OAuth2 system relies on an authentication / exchange system, which requires a URL to be specially assembled that the user is redirected to, and a URL that the user is returned to after the user has committed the authorization action.
The first set of routes below are the action URL's that will redirect to the OAuth2 provider's system. They can be anything you wish them to be. The user will never see anything on them as they will be immediately redirected to the correct place.
The second set of routes below are where the OAuth2 provider should return the user to. Note that this is the same as the "endpointAfterAuth" configuration option. Once the "authResponse" function has been completed the user is automatically forwarded to the URL in the "redirectAfterAuth" option.
``` swift
var routes: [[String: Any]] = [[String: Any]]()
routes.append(["method":"get", "uri":"/to/facebook", "handler":Facebook.sendToProvider])
routes.append(["method":"get", "uri":"/to/github", "handler":GitHub.sendToProvider])
routes.append(["method":"get", "uri":"/to/google", "handler":Google.sendToProvider])
routes.append(["method":"get", "uri":"/auth/response/facebook", "handler":Facebook.authResponse])
routes.append(["method":"get", "uri":"/auth/response/github", "handler":GitHub.authResponse])
routes.append(["method":"get", "uri":"/auth/response/google", "handler":Google.authResponse])
```
## Information returned and made available
After the user has been authenticated, certain information is gleaned from the OAuth2 provider.
Note that the session ID can be retrieved using:
``` swift
request.session?.token
```
The user-specific information can be accessed as part of the session info:
``` swift
// The UserID as defined by the provider
request.session?.userid
// designates the OAuth2 source - useful if you are allowing multiple OAuth providers
request.session?.data["loginType"]
// The access token obtained in the process
request.session?.data["accessToken"]
// The user's first name as supplied by the provider
request.session?.data["firstName"]
// The user's last name as supplied by the provider
request.session?.data["lastName"]
// The user's profile picture as supplied by the provider
request.session?.data["picture"]
```
With access to this information, you can now save to the database of your choice.
## Further Information
For more information on the Perfect project, please visit [perfect.org](http://perfect.org).