jwt-authorizer/README.md

41 lines
1.1 KiB
Markdown
Raw Normal View History

2023-01-08 13:45:21 +01:00
# jwt-authorizer
2023-05-19 09:14:53 +02:00
JWT authorizer Layer for Axum.
2023-01-08 13:45:21 +01:00
2023-02-27 08:37:36 +01:00
[![Build status](https://github.com/cduvray/jwt-authorizer/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/tokio-rs/cduvray/jwt-authorizer/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/jwt-authorizer)](https://crates.io/crates/jwt-authorizer)
[![Documentation](https://docs.rs/jwt-authorizer/badge.svg)](https://docs.rs/jwt-authorizer)
> **Tonic support is temporarily removed** (waiting upgrade to hyper 1 and axum 0.7 hyperium/tonic/#1584)
2023-01-08 13:45:21 +01:00
## Features
2023-01-25 08:38:09 +01:00
- JWT token verification (Bearer)
- Algoritms: ECDSA, RSA, EdDSA, HMAC
2023-01-25 08:38:09 +01:00
- JWKS endpoint support
- Configurable refresh
- OpenId Connect Discovery
- Validation
- exp, nbf, iss, aud
2023-01-08 13:45:21 +01:00
- Claims extraction
2023-05-19 09:14:53 +02:00
- into custom deserializable structs or into `RegisteredClaims` (default)
2023-01-21 08:34:11 +01:00
- Claims checker
- Tracing support (error logging)
- ~~*tonic* support~~
2023-01-08 13:45:21 +01:00
## Usage
See documentation of the [`jwt-authorizer`](./jwt-authorizer/docs/README.md) module or the [`demo-server`](./demo-server/) example.
2023-02-13 08:40:22 +01:00
## Development
2023-01-08 13:45:21 +01:00
Minimum supported Rust version is 1.65.
2023-01-08 13:45:21 +01:00
## Contributing
Contributions are wellcome!
## License
2023-02-13 08:40:22 +01:00
MIT