towk/opaal
1
0
Fork 0
mirror of https://github.com/davidallendj/opaal.git synced 2025-12-20 03:27:02 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated README.md

Browse source
This commit is contained in:
David Allen 2024-02-23 16:03:31 -07:00
parent 3020a9068e
commit 86f8784c19
1 changed files with 14 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,6 +1,18 @@
# OpenID Connect Authentication Helper # OIDC Provider Authentication/Authorization Login (OPAAL)
This is a small, simple, experimental helper tool that automates the authorization code flow for logging in with an identity provider like GitHub or GitLab. This tool acts as an OAuth app, contains client secrets, and should not be exposed to users! This is a small, simple, experimental OIDC login helper tool that automates the authorization code flow defined by [RFC 6749](https://datatracker.ietf.org/doc/html/rfc6749#section-4.1) for social sign-in with identity providers like Google, Facebook, or GitHub. This tool is made to work when your issuer/identity provider is separate from your authorization server.
Note: This tool acts as an OAuth client, contains client secrets, and should not be exposed to users!
## Build and Usage
Clone the repository and build:
```bash
git clone https://github.com/davidallendj/opal.git
cd opal/
go mod tidy && go build
```
To use this tool, you will have to register an OAuth2 application with you identity provider. Make sure you register the application first before proceeding, then set the callback URL to `{your host}/oauth/callback`. To use this tool, you will have to register an OAuth2 application with you identity provider. Make sure you register the application first before proceeding, then set the callback URL to `{your host}/oauth/callback`.