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-03-10 20:14:38 -06:00
parent d72fa3bda5
commit 8b5d9ab6dd
No known key found for this signature in database
GPG key ID: 1D2A29322FBB6FCB
1 changed files with 17 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -23,9 +23,17 @@ To start the authentication flow, run the following commands:
./opaal login --flow authorization_code --config config.yaml ./opaal login --flow authorization_code --config config.yaml
``` ```
These commands will create a default config, then start the login process. Maybe sure to change the config file to match your setup! These commands will create a default config, then start the login process. Maybe sure to change the config file to match your setup! The tool has been tested and confirmed to work with the following identity providers so far:
- [Gitlab](https://about.gitlab.com/)
- [Forgejo](https://forgejo.org/) (fork of Gitea)
### Authorization Code Flow
`opaal` has the ability to completely execute the authorization code and return an access token from an authorization server using social sign-in. The process works as follows:
1. Click the authorization link or navigate to the hosted endpoint in your browser (127.0.0.1:3333 by default) 1. Click the authorization link or navigate to the hosted endpoint in your browser (127.0.0.1:3333 by default)
- Alternatively, you can use a link produced
2. Login using identity provider credentials 2. Login using identity provider credentials
3. Authorize application registered with IdP 3. Authorize application registered with IdP
4. IdP redirects to specified redirect URI 4. IdP redirects to specified redirect URI
@ -37,6 +45,11 @@ These commands will create a default config, then start the login process. Maybe
*After receiving the ID token, the rest of the flow requires the appropriate URLs to be set to continue. *After receiving the ID token, the rest of the flow requires the appropriate URLs to be set to continue.
### Client Credentials Flow
`opaal` also has
## Configuration ## Configuration
Here is an example configuration file: Here is an example configuration file:
@ -105,4 +118,6 @@ options:
- Add details about configuration parameters - Add details about configuration parameters
- Implement client credentials flow to easily fetch tokens - Implement client credentials flow to easily fetch tokens
- Fix how OAuth clients are managed with the authorization server - Fix how OAuth clients are managed with the authorization server
- Fix how the trusted issuer is added to the authorization server - Fix how the trusted issuer is added to the authorization server
- Allow signing JWTs by supplying key pair
- Separate `jwt_bearer` grant type from the authorization code flow