mirror of
https://github.com/pfzetto/axum-oidc.git
synced 2024-11-22 19:42:50 +01:00
34 lines
1.5 KiB
Markdown
34 lines
1.5 KiB
Markdown
**THIS IS AN OLD VERSION! PLEASE USE THE LATEST VERSION IF POSSIBLE!**
|
|
|
|
This Library allows using [OpenID Connect](https://openid.net/developers/how-connect-works/) with [axum](https://github.com/tokio-rs/axum).
|
|
It authenticates the user with the OpenID Conenct Issuer and provides Extractors.
|
|
|
|
# Usage
|
|
The `OidcAuthLayer` must be loaded on any handler that might use the extractors.
|
|
The user won't be automatically logged in using this layer.
|
|
If a valid session is found, the extractors will return the correct value and fail otherwise.
|
|
|
|
The `OidcLoginLayer` should be loaded on any handler on which the user is supposed to be authenticated.
|
|
The User will be redirected to the OpenId Conect Issuer to authenticate.
|
|
The extractors will always return a value.
|
|
|
|
The `OidcClaims`-extractor can be used to get the OpenId Conenct Claims.
|
|
The `OidcAccessToken`-extractor can be used to get the OpenId Connect Access Token.
|
|
|
|
Your OIDC-Client must be allowed to redirect to **every** subpath of your application base url.
|
|
|
|
# Examples
|
|
Take a look at the `examples` folder for examples.
|
|
|
|
# Example Projects
|
|
Here is a place for projects that are using this library.
|
|
- [zettoIT ARS - AudienceResponseSystem](https://git2.zettoit.eu/zettoit/ars) (by me)
|
|
|
|
# Contributing
|
|
I'm happy about any contribution in any form.
|
|
Feel free to submit feature requests and bug reports using a GitHub Issue.
|
|
PR's are also appreciated.
|
|
|
|
# License
|
|
This Library is licensed under [LGPLv3](https://www.gnu.org/licenses/lgpl-3.0.en.html).
|
|
|