https://github.com/robertohuertasm/actix-web-middleware-cognito
🔩 Middleware for actix-web that helps you validate Cognito tokens
https://github.com/robertohuertasm/actix-web-middleware-cognito
actix-web cognito http-server jwt library middleware rust
Last synced: 3 months ago
JSON representation
🔩 Middleware for actix-web that helps you validate Cognito tokens
- Host: GitHub
- URL: https://github.com/robertohuertasm/actix-web-middleware-cognito
- Owner: robertohuertasm
- License: mit
- Created: 2020-08-03T18:17:09.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-01-07T16:20:06.000Z (over 3 years ago)
- Last Synced: 2025-03-16T16:39:40.839Z (3 months ago)
- Topics: actix-web, cognito, http-server, jwt, library, middleware, rust
- Language: Rust
- Homepage:
- Size: 21.5 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# actix-web-middleware-cognito
[](https://github.com/robertohuertasm/actix-web-middleware-cognito/actions) [](https://crates.io/crates/actix-web-middleware-cognito) [](https://docs.rs/actix-web-middleware-cognito)
Middleware for [actix-web](https://github.com/actix/actix-web) that helps you validate Cognito tokens.
## Cognito validator
Before setting up the middleware we have to create a `CognitoValidator` that will be built by receiving some variables from the environment:
- **COGNITO_REGION**: The region of the Cognito pool.
- **COGNITO_POOLID**: The Cognito pool id.
- **COGNITO_CLIENTID**: The client id of your app.
- **COGNITO_ENABLED** (optional): if not present or 0 no validation will be done.
- **COGNITO_VERIFY_ACCESSTOKEN** (optional): if not present or 0 idToken will be validated. If present, the accessToken will be validated instead.
## Usage
Setting up the middleware:
```rust
// builidng the validator in order to be shared between all threads.
let cognito_validator =
Arc::new(CognitoValidator::create().expect("Cognito configuration error"));
HttpServer::new(move || {
// cognito middleware
let cognito = Cognito::new(cognito_validator.clone());
// set up the app
App::new()
.wrap(cognito)
.route("/", web::get().to(index))
})
.bind(format!("0.0.0.0:{}", PORT))
.unwrap_or_else(|_| panic!("🔥 Couldn't start the server at port {}", PORT))
.run()
.await
```
## Extracting the token from the request
The library provides a `CognitoInfo` extractor for you to get information about the Cognito token. If the token is invalid or you disable the middleware (by omitting the `COGNITO_ENABLED` environment variable) you will always get a disabled `CognitoInfo`, i.e. a `CognitoInfo` with no `token`.
```rust
async fn index(auth: CognitoInfo) -> impl Responder {
let msg = format!(
"User with id {} made this call with token {}",
auth.user.unwrap(),
auth.token.unwrap()
);
HttpResponse::Ok().body(msg)
}
```
## Example
You can check the `example` in the repo or run it: `cargo run --example main`.