Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/poundifdef/connectivly
Add OAuth + OIDC to your app with a single callback
https://github.com/poundifdef/connectivly
oauth2 oauth2-provider oauth2-server oidc oidc-provider
Last synced: about 12 hours ago
JSON representation
Add OAuth + OIDC to your app with a single callback
- Host: GitHub
- URL: https://github.com/poundifdef/connectivly
- Owner: poundifdef
- License: agpl-3.0
- Created: 2023-05-08T17:57:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-23T18:52:21.000Z (9 months ago)
- Last Synced: 2024-05-01T20:27:59.372Z (7 months ago)
- Topics: oauth2, oauth2-provider, oauth2-server, oidc, oidc-provider
- Language: Go
- Homepage:
- Size: 126 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Connectivly
**Add OAuth to your API in a few lines of code.**
Connectivly is an OAuth provider which requires minimal configuration.
It allows your users to create apps for your platform,
enables "sign in with YOUR APP", and handles the entire OAuth dance.
You can add OAuth + OIDC to your existing application by adding a single
authenticated endpoint to approve OAuth requests.
Connectivly doesn't "own" your users database - it assumes you're already
managing users and accounts in your own application. It work alonside your DB,
Auth0, Sign In With Google, or other third party identity provider.
## Getting Started
Connectivly is packaged as a single go binary. You just need to configure 1 option:
a callback URL to your app.
### 1. Run Connectivly Server
``` bash
$ export CONNECTIVLY_REDIRECT_URL="https://your-app.example.com/connectivly"
$ go run connectivly
Listening... http://localhost:3000
API Key: zWp2kjQSmN85saBgeWkWF6Riz1GmQEhR
Client 1 App
Client ID: client1
Client Secret: secret1
Client 2 App
Client ID: client2
Client Secret: secret2
```
The app will listen on `http://localhost:3000`. The first time it runs, connectivly
will automatically generate an API key and example client apps for testing.
### 2. Add a `/connectivly` endpoint to your app.
This endpoint **must** be authenticated (ie, users must be logged in to be able to reach this.)
During the auth flow, the user will be redirected to the URL you specify in
`CONNECTIVLY_REDIRECT_URL`, which is `https://your-app.example.com/connectively?token=12345`
in this example.
Your app should make a an API call to connectivly as follows:
``` bash
curl -XPOST -H 'X-API-KEY: zWp2kj...' \
-H "Content-type: application/json" \
-d '{"user": "[email protected]"}' \
'http://localhost:3000/api/auth_session/12345/approve'
```
This call is saying "We authorize `[email protected]` to log in." It will return a `redirect_uri`.
Redirect the user there and connectivly completes the OAuth dance.
Before you do this, you can call `GET /api/auth_session/12345`. This returns information about
the app, end-user, and scopes requested. If you don't want to approve the session, make a POST
request to `/deny` instead.
#### Flask Example
Here is an example using Flask:
``` py
@app.route("/connectivly")
@login_required
def connectivly_auth():
session_id = request.args["token"]
approval = requests.post(
"http://localhost:3000/api/auth_session/" + session_id + "/approve",
json={"user": "[email protected]"},
headers={"X-API-KEY": "zWp2kj..."},
).json()
return redirect(approval['redirect_uri'])
```
### 3. Authorize using OAuth
Using one of the Client ID credentials, you can now implement an oauth flow against your application.
Use "openid" as the scope.