This is a small, simple, experimental OIDC login helper tool that automates the authorization flows defined by RFC 6749 for social sign-in with identity providers (IdP) like Google, Facebook, or GitHub. This tool is made to work when your identity provider is separate from your authorization server, and we only need the IdP to receive an ID token. In this document, the identity provider (or authentication server) is strictly the OIDC implementation that identifies the resource owner (ID token) whereas the resource provider (or authorization server) is the OIDC implementation that grants access to a resource (access token). OPAAL assumes that the authentication server is external and the authorization server is owned. This tool is tested with Ory Kratos and Hydra for user identity and session management and OAuth2/OIDC implementation respectively.
Note: This tool acts as an OAuth client, contains client secrets, and should not to be exposed to users! It would probably also be a good idea to use a reverse proxy and firewall to protect admin endpoints.
Clone the repository and build:
git clone https://github.com/davidallendj/opaal.git
cd opaal/
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 start the authentication flow, run the following commands:
./opaal 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! The tool has been tested and confirmed to work with the following identity providers so far:
The tool is now able to run an internal example identity provider using the serve
subcommand.
./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:
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 section for the entire config file.
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:
urn:ietf:params:oauth:grant-type:jwt-bearer
grant type*After receiving the ID token, the rest of the flow requires the appropriate URLs to be set to continue.
Here is an example configuration file:
version: "0.3.2"
server:
host: "127.0.0.1"
port: 3333
callback: "/oidc/callback"
issuer:
host: "127.0.0.1"
port: 3332
providers:
opaal: "https://127.0.0.1:3332"
forgejo: "http://127.0.0.1:3000"
authentication:
clients:
- id: "my_client_id"
secret: "my_client_secret"
name: "forgejo"
issuer: "http://127.0.0.1:3000"
scope:
- "openid"
- "profile"
- "read"
- "email"
redirect-uris:
- "http://127.0.0.1:3333/oidc/callback"
flows:
authorization-code:
state: ""
client-credentials:
authorization:
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
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
clients: http://127.0.0.1:4445/admin/clients
authorize: http://127.0.0.1:4444/oauth2/auth
register: http://127.0.0.1:4444/oauth2/register
token: http://127.0.0.1:4444/oauth2/token
options:
run-once: true
open-browser: false
flow: authorization_code
cache-only: false
verbose: true
curl https://<your authetication server>/.well-known/openid-configuration
opaal
will present the user with a "Success!" page along with the access token and a message indicating that the process is completed.jwt_bearer
grant type from the authorization code flow