mirror of
https://github.com/davidallendj/opaal.git
synced 2025-12-19 19:17:01 -07:00
Update README.md about internal IDP
This commit is contained in:
parent
b45821e587
commit
2762a95da5
1 changed files with 48 additions and 12 deletions
56
README.md
56
README.md
|
|
@ -28,6 +28,33 @@ These commands will create a default config, then start the login process. Maybe
|
||||||
- [Gitlab](https://about.gitlab.com/)
|
- [Gitlab](https://about.gitlab.com/)
|
||||||
- [Forgejo](https://forgejo.org/) (fork of Gitea)
|
- [Forgejo](https://forgejo.org/) (fork of Gitea)
|
||||||
|
|
||||||
|
The tool is now able to run an internal example identity provider using the `serve` subcommand.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./opaal serve --config config.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
This will start a server that allows you to login with `opaal` itself. Currently, it is only has one example user to use for log in. The username and password combination is `ochami:ochami`. It uses the same config file as before with additional parameters set in the config file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
server:
|
||||||
|
...
|
||||||
|
issuer:
|
||||||
|
host: "127.0.0.1"
|
||||||
|
port: 3332
|
||||||
|
|
||||||
|
authentication:
|
||||||
|
clients:
|
||||||
|
- id: "ochami"
|
||||||
|
secret: "ochami"
|
||||||
|
name: "ochami"
|
||||||
|
issuer: "http://127.0.0.1:3332"
|
||||||
|
redirect-uris:
|
||||||
|
- "http://127.0.0.1:3333/oidc/callback"
|
||||||
|
```
|
||||||
|
|
||||||
|
See the [Configuration](#configuration) section for the entire config file.
|
||||||
|
|
||||||
### Authorization Code Flow
|
### 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:
|
`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:
|
||||||
|
|
@ -47,21 +74,23 @@ These commands will create a default config, then start the login process. Maybe
|
||||||
|
|
||||||
### Client Credentials Flow
|
### Client Credentials Flow
|
||||||
|
|
||||||
`opaal` also has
|
|
||||||
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
Here is an example configuration file:
|
Here is an example configuration file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
version: "0.0.1"
|
version: "0.3.2"
|
||||||
server:
|
server:
|
||||||
host: "127.0.0.1"
|
host: "127.0.0.1"
|
||||||
port: 3333
|
port: 3333
|
||||||
callback: "/oidc/callback"
|
callback: "/oidc/callback"
|
||||||
|
issuer:
|
||||||
|
host: "127.0.0.1"
|
||||||
|
port: 3332
|
||||||
|
|
||||||
providers:
|
providers:
|
||||||
|
opaal: "https://127.0.0.1:3332"
|
||||||
forgejo: "http://127.0.0.1:3000"
|
forgejo: "http://127.0.0.1:3000"
|
||||||
|
|
||||||
authentication:
|
authentication:
|
||||||
|
|
@ -83,7 +112,17 @@ authentication:
|
||||||
client-credentials:
|
client-credentials:
|
||||||
|
|
||||||
authorization:
|
authorization:
|
||||||
urls:
|
token:
|
||||||
|
forwarding: false
|
||||||
|
refresh: false
|
||||||
|
duration: 16h
|
||||||
|
scope:
|
||||||
|
- smd.read
|
||||||
|
key-path: ./keys
|
||||||
|
endpoints:
|
||||||
|
issuer: http://127.0.0.1:4444
|
||||||
|
config: http://127.0.0.1:4444/.well-known/openid-configuration
|
||||||
|
jwks: http://127.0.0.1:4444/.well-known/jwks.json
|
||||||
#identities: http://127.0.0.1:4434/admin/identities
|
#identities: http://127.0.0.1:4434/admin/identities
|
||||||
trusted-issuers: http://127.0.0.1:4445/admin/trust/grants/jwt-bearer/issuers
|
trusted-issuers: http://127.0.0.1:4445/admin/trust/grants/jwt-bearer/issuers
|
||||||
login: http://127.0.0.1:4433/self-service/login/api
|
login: http://127.0.0.1:4433/self-service/login/api
|
||||||
|
|
@ -91,17 +130,14 @@ authorization:
|
||||||
authorize: http://127.0.0.1:4444/oauth2/auth
|
authorize: http://127.0.0.1:4444/oauth2/auth
|
||||||
register: http://127.0.0.1:4444/oauth2/register
|
register: http://127.0.0.1:4444/oauth2/register
|
||||||
token: http://127.0.0.1:4444/oauth2/token
|
token: http://127.0.0.1:4444/oauth2/token
|
||||||
clients:
|
|
||||||
- id: bss
|
|
||||||
secret: IAMBSS
|
|
||||||
|
|
||||||
|
|
||||||
options:
|
options:
|
||||||
decode-id-token: true
|
|
||||||
decode-access-token: true
|
|
||||||
run-once: true
|
run-once: true
|
||||||
open-browser: false
|
open-browser: false
|
||||||
forward: false
|
flow: authorization_code
|
||||||
|
cache-only: false
|
||||||
|
verbose: true
|
||||||
```
|
```
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue