README
¶
Go + HTMX + OAuth2/OIDC + WebAuthn
A very simple example HTMX with OAuth2 with:
- Go HTML templating engine.
- HTMX solution for SSR.
- OAuth2 with Github Auth and OIDC. OAuth2 delegates authentication to another authentication service. OIDC provides identities.
- CSRF protection measures for OAuth2 and all requests.
- SQLite3 with sqlc and golang-migrate.
- Optional users in database as Identity Provider. Authentication is through WebAuthn, a solution to delegate authentication directly to the user.
- JWT is used a session token.
Embellishment:
- Notyf to notify about errors, include HTMX errors.
- Added Hyperscript for edge cases.
Motivation
For the hype.
Usage
-
Edit the config.yaml to set the OAuth2 providers.
-
Set the necessary parameters or environment variables:
## .env.local ## A 32 bytes hex secret () CSRF_SECRET=51b22632498f26d9131c4743b72c362567b5b4c96ac5e0f4fef7cb58ecac5684 ## A unique string secret JWT_SECRET=secret ## PUBLIC_URL will be used as redirect url which is ${PUBLIC_URL}/callback PUBLIC_URL=http://localhost:3000 # redirectURL: http://localhost:3000/callback DB_PATH=/data/db.sqlite3 # CONFIG_PATH=/path/to/config.yaml -
Run the binary:
./auth-htmx
Help:
NAME:
auth-htmx - Demo of Auth and HTMX.
USAGE:
auth-htmx [global options] command [command options] [arguments...]
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--csrf.secret value A 32 bytes hex secret [$CSRF_SECRET]
--jwt.secret value A unique string secret [$JWT_SECRET]
--config.path value, -c value Path of the configuration file. (default: "./config.yaml") [$CONFIG_PATH]
--public-url value An URL pointing to the server. (default: "http://localhost:3000") [$PUBLIC_URL]
--db.path value SQLite3 database file path. (default: "./db.sqlite3") [$DB_PATH]
--help, -h show help
--version, -v print the version
Application Flow
- A home page:
- Show login button if not logged in.
- Else, show a welcome with routing.
- A protected counter page.
The login process follows the standard OAuth2 process, which is fully documented on GitHub.
Fetching identity is through OIDC or GitHub API.
Documentation
¶
Overview ¶
Auth HTMX is a simple demonstration of OAuth2/OIDC in combination with HTMX, written in Go.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package auth defines the authentication layer of the application.
|
Package auth defines the authentication layer of the application. |
|
oauth
Package oauth defines the authentication layer of the application.
|
Package oauth defines the authentication layer of the application. |
|
webauthn
Package webauthn handles WebAuthn related functionalities.
|
Package webauthn handles WebAuthn related functionalities. |
|
webauthn/session
Package session handles the login/register sessions of webauthn.
|
Package session handles the login/register sessions of webauthn. |
|
webauthn/session/memory
Package memory implements a session store in-memory.
|
Package memory implements a session store in-memory. |
|
webauthn/user
Package user describes the methods to handle users needed for webauthn.
|
Package user describes the methods to handle users needed for webauthn. |
|
Package database handles the methods and definition to manipulate a database.
|
Package database handles the methods and definition to manipulate a database. |
|
counter
Package counter handles the logic of a counter.
|
Package counter handles the logic of a counter. |
|
user
Package user handle the database users.
|
Package user handle the database users. |
|
Package handler containers HTTP handling functions.
|
Package handler containers HTTP handling functions. |
|
Package jwt defines all the methods for JWT manipulation.
|
Package jwt defines all the methods for JWT manipulation. |
Click to show internal directories.
Click to hide internal directories.