dax / actix-jwt-authc Goto Github PK

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

• Actix
• jsonwebtoken for JWT encoding + validation

• tracing enables instrumentation by pulling in tracing
• log enables logs (via tracing) using the compatibility layer
• session enables actix-session integration, allowing you to extract JWTs from a configurable session key.

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 to generate an Ed25519 keypair for EdDSA-signed JWTs

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:

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.

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.