Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rgglez/gofiber-zitadel-middleware
Middleware to use along with the Zitadel IDP
https://github.com/rgglez/gofiber-zitadel-middleware
authentication authentication-middleware go gofiber idp jwt middleware oidc zitadel
Last synced: 1 day ago
JSON representation
Middleware to use along with the Zitadel IDP
- Host: GitHub
- URL: https://github.com/rgglez/gofiber-zitadel-middleware
- Owner: rgglez
- License: apache-2.0
- Created: 2024-10-31T01:32:57.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-07T08:38:32.000Z (about 2 months ago)
- Last Synced: 2024-11-07T09:36:37.446Z (about 2 months ago)
- Topics: authentication, authentication-middleware, go, gofiber, idp, jwt, middleware, oidc, zitadel
- Language: Go
- Homepage:
- Size: 55.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gofiber-zitadel-middleware
[](https://opensource.org/licenses/Apache-2.0)
[](https://goreportcard.com/report/github.com/rgglez/gofiber-zitadel-middleware)
[](https://github.com/rgglez/gofiber-zitadel-middleware/releases/)
**gofiber-zitadel-middleware** is a [gofiber](https://gofiber.io/) [middleware](https://docs.gofiber.io/category/-middleware/) to be used along with the [Zitadel](https://zitadel.com/) (and perhaps other [OIDC](https://auth0.com/es/intro-to-iam/what-is-openid-connect-oidc) servers) security manager to verify the [JWT token](https://jwt.io/) provided by it in the corresponding flows.
## Installation
```bash
go get github.com/rgglez/gofiber-zitadel-middleware
```
## Usage
```go
import gofiberzitadel "github.com/rgglez/gofiber-zitadel-middleware/gofiberzitadel"
// Initialize Fiber app and middleware
app := fiber.New()
app.Use(gofiberzitadel.New(gofiberzitadel.Config{ProviderUrl: providerUrl, ClientID: clientId}))
```
## Configuration
There are some configuration options available in the ```Config``` struct:
* **```Next```** defines a function to skip this middleware when returned true. Optional. Default: nil
* **```ProviderUrl```** a string which defines the URL of the Zitadel instance. Required.
* **```ClientID```** a string which defines the ```client_id``` of the application to be used in the validation. Required.
* **```StoreClaimsIndividually```** a boolean which defines if the claims should be stored as key:value pairs in the fiber context. Optional. Default: false.
## Notes
* The whole claims are stored in the fiber context as "claims" by default.
## Example
An example is provided in the [example/](example/) directory.
### Run it
```bash
cd example
go run main.go
```
### Try it
Then, if it started correctly, assuming that you filled the enviroment variables in ```test_data.sh``` . Or, just set the same variables explained in the Testing section.
```bash
# first step is optional
source /path/to/test_data.sh
```
You will need [pytest](https://en.wikipedia.org/wiki/Pytest) tu run the test:
```bash
cd tests
pytest
```
## Testing
A test is included. To run the test you must:
1. Setup a working Zitadel instance, either self-hosted or SaaS. You will need the URL of this instance, as the **Provider URL**.
1. Setup a Zitadel application in your instance. You will need the [**Client ID**](https://zitadel.com/docs/guides/manage/console/applications#application-settings) of this application.
1. Create a human user and write down the user's **name**. You will need it for the assertion of the claims.
1. Optionally, create an application which will be using the Zitadel provider for authentication. You can use [this](https://github.com/rvs1257/svelte-zitadel-pkce) Svelte application as the basis. You will need to login into a real or sample application in order to get the **```id_token```** field from the JSON returned by the ```/token``` endpoint.
Otherwise you would need to use the Zitadel API to get this token manually.
1. Set the test data in the enviroment. An example bash script is provided in [```test_data.sh```](test_data.sh) as a guide. You must fill in the values with your own data accordingly:
```bash
# The full URL including trailing / of your Zitadel instance
export ZITADEL_PROVIDER=
# The client_id of the Zitadel application
export ZITADEL_CLIENTID=
# A token got from a valid login
export ZITADEL_TOKEN=
# The "name" of the logged user
export ZITADEL_NAME=
```
If you use this script, you should need to [source](https://www.geeksforgeeks.org/source-command-in-linux-with-examples/) it.
1. Run
```bash
go test
```
inside the [```gofiberzitadel/```](gofiberzitadel/) directory.
## Dependencies
* [github.com/coreos/go-oidc](https://github.com/coreos/go-oidc)
* [github.com/gofiber/fiber/v2](https://github.com/gofiber/fiber/v2)
## License
Copyright (c) 2024 Rodolfo González González
Licensed under the [Apache 2.0](LICENSE) license. Read the [LICENSE](LICENSE) file.