Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/owez/axum-auth
High-level http auth extractors for axum
https://github.com/owez/axum-auth
auth axum bearer rust web
Last synced: 12 days ago
JSON representation
High-level http auth extractors for axum
- Host: GitHub
- URL: https://github.com/owez/axum-auth
- Owner: Owez
- License: apache-2.0
- Created: 2022-03-27T22:35:28.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-28T20:51:32.000Z (9 months ago)
- Last Synced: 2024-10-12T19:52:02.994Z (about 1 month ago)
- Topics: auth, axum, bearer, rust, web
- Language: Rust
- Homepage:
- Size: 61.5 KB
- Stars: 98
- Watchers: 2
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Auth for axum
High-level [http auth](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) extractors for [axum](https://github.com/tokio-rs/axum)
🚨 This crate provides an alternative to `TypedHeader>` which you may [use](https://docs.rs/axum-extra/latest/axum_extra/struct.TypedHeader.html) instead. Take a look at the fantastic [axum-login](https://github.com/maxcountryman/axum-login) crate if your looking for more robust session management. I will continue to maintain this crate.
## Usage
Bearer Authentication:
```rust
use axum_auth::AuthBearer;
/// Handler for a typical axum route, takes a `token` and returns it
async fn handler(AuthBearer(token): AuthBearer) -> String {
format!("Found a bearer token: {}", token)
}
```
Basic Authentication:
```rust
use axum_auth::AuthBasic;
/// Takes basic auth details and shows a message
async fn handler(AuthBasic((id, password)): AuthBasic) -> String {
if let Some(password) = password {
format!("User '{}' with password '{}'", id, password)
} else {
format!("User '{}' without password", id)
}
}
```
You can also define custom extractors, letting you return custom extractors, status codes, and messages to users if the auth fails. Check out the [crate documentation](https://docs.rs/axum-auth) for more in-depth information into how everything works!
## Installation
Simply place the following inside of your `Cargo.toml` file for axum:
```toml
[dependencies]
axum-auth = "0.7"
```
Our version follows axum since 0.7. You can also enable just basic/bearer auth via features. To enable just basic auth, you can add this to the `Cargo.toml` file instead:
```toml
[dependencies]
axum-auth = { version = "0.7", default-features = false, features = ["auth-basic"] }
```
If you're still using axum 0.5, use version 0.3. If you're still using axum 0.6, use version 0.4.
## Security
Some essential security considerations to take into account are the following:
- This crate has not been audited by any security professionals. If you are willing to do or have already done an audit on this crate, please create an issue as it would help out enormously! 😊
- This crate purposefully does not limit the maximum length of headers arriving so please ensure your webserver configurations are set properly.
## Licensing
This project is dual-licensed under both the [MIT](https://github.com/Owez/argi/blob/master/LICENSE-MIT) and [Apache](https://github.com/Owez/argi/blob/master/LICENSE-APACHE), so feel free to use either at your discretion.