https://github.com/lloydmeta/actix-jwt-authc
JWT authentication middleware for Actix with support for JWT invalidation and custom Claims structs.
https://github.com/lloydmeta/actix-jwt-authc
actix actix-web actix-web-middleware authentication jsonwebtoken jwt jwt-authentication middleware rust
Last synced: 5 months ago
JSON representation
JWT authentication middleware for Actix with support for JWT invalidation and custom Claims structs.
- Host: GitHub
- URL: https://github.com/lloydmeta/actix-jwt-authc
- Owner: lloydmeta
- License: mit
- Created: 2022-07-04T05:44:25.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-06T09:33:58.000Z (almost 3 years ago)
- Last Synced: 2025-02-01T03:06:36.964Z (5 months ago)
- Topics: actix, actix-web, actix-web-middleware, authentication, jsonwebtoken, jwt, jwt-authentication, middleware, rust
- Language: Rust
- Homepage:
- Size: 1.26 MB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## actix-jwt-authc
[](https://crates.io/crates/actix-jwt-authc)
[](https://docs.rs/actix-jwt-authc)
[](https://github.com/lloydmeta/actix-jwt-authc/actions/workflows/ci.yaml)
[](https://coveralls.io/github/lloydmeta/actix-jwt-authc?branch=main)
JWT authentication middleware for Actix that supports checking for invalidated JWTs without paying the cost of a per-request
IO call. It sources invalidated JWTs from a Stream and stores them in memory.
This middleware is based on the assumption that since JWTs (should) have an expiry, ultimately, an in-memory set of
explicitly-invalidated-yet-unexpired JWTs that are loaded from a stream (e.g. populated once on bootstrap, then
updated via diffs) should not be overwhelmingly big enough to cause problems. Only testing can truly answer if this
assumption works for a given usecase.
[Docs for `main`](https://beachape.com/actix-jwt-authc/actix_jwt_authc)
### Uses
- [Actix](https://actix.rs)
- [jsonwebtoken](https://github.com/Keats/jsonwebtoken) for JWT encoding + validation
### Features
- `tracing` enables instrumentation by pulling in [tracing](https://github.com/tokio-rs/tracing)
- `log` enables logs (via [tracing](https://github.com/tokio-rs/tracing)) using the [compatibility layer](https://docs.rs/tracing-log/latest/tracing_log/#convert-tracing-events-to-logs)
- `session` enables [`actix-session`](https://crates.io/crates/actix-session) integration, allowing you to extract
JWTs from a configurable session key.
### Example
The example included in this repo has
- A simple set of routes for starting and inspecting the current session
- An in-memory implementation of the invalidated JWT interface
- In-memory loop for purging expired JWTs from the store
- Channel-based Stream of invalidated JWT events for powering the invalidated JWT set used by the middleware
- [ring](https://github.com/briansmith/ring) to generate an Ed25519 keypair for [EdDSA-signed JWTs](https://www.scottbrady91.com/jose/jwts-which-signing-algorithm-should-i-use)
Both session and JWT keys are generated on the fly, so JWTs are incompatible across restarts.
It supports `tracing`, `log` and `session` as features. To run a server on 8080:
```shell
cargo run --example inmemory --features tracing,session,log
```
Supported endpoints
- `/login` to start a session
- `/logout` to destroy the current session (requires a session)
- `/session` to inspect the current session (requires a session)
- `/maybe_session` to inspect the current session if it exists
If `session` is not passed, authentication in the example is dependent on `Bearer` tokens sent as an `Authorization` header.
### Disclaimer
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.