5 releases (3 breaking)
Uses new Rust 2024
| 0.4.0 | Dec 30, 2025 |
|---|---|
| 0.3.1 |
|
| 0.3.0 | Feb 26, 2025 |
| 0.2.1 | Feb 26, 2025 |
| 0.1.0 | Feb 19, 2025 |
#635 in Authentication
2,027 downloads per month
Used in openfga-client
55KB
1K
SLoC
Client Authentication Middleware
This crate provides authentication middleware for clients that need to access secure HTTP and gRPC APIs. Features include:
- Automatic token renewal when expired in a background task
- Thread-safe token management with interior mutability
reqwestintegration by using a wrappedHttpClienttonicintegration via Interceptors- Support for OAuth2 Client Credential flow
- Support for Bearer Token authentication
- Based on the
oauth2crate - Safe defaults - does not follow redirects and hides sensitive data in Debug
- More flows coming soon!
Example
In the following example we create a middle::HttpClient that wraps a reqwest::Client.
The token is kept fresh with a background task of the ClientCredentialAuthorizer, so that the client always sends authorized requests.
use std::str::FromStr;
use middle::{Authorizer, BasicClientCredentialAuthorizer};
use reqwest::Client;
use url::Url;
#[tokio::main]
async fn main() {
let client_id = "my-client-id";
let client_secret = "my-client-secret";
let token_endpoint = Url::from_str("https://identity.example.com/oauth2/token").unwrap();
// Create a new Authorizer. The Authorizer keeps the token refreshed in the background.
let authorizer =
BasicClientCredentialAuthorizer::basic_builder(client_id, client_secret, token_endpoint)
.add_scope("my-scope")
.refresh_tolerance(std::time::Duration::from_secs(30)) // Refresh 30 seconds before expiry
.build()
.await
.unwrap();
// The current authorization header. The header is always kept up-to-date.
// Returns an error if the last refresh failed.
let _header = authorizer.authorization_header().unwrap();
// Generate a new reqwest Client and wrap it with `HttpClient`.
let reqwest_client = Client::new();
let client = middle::HttpClient::new(authorizer).set_client(reqwest_client);
// Start using the client - the authorization header is automatically added.
let request = client.get("https://api.example.com/data").unwrap();
let _response = request.send().await.unwrap();
}
Tonic Integration
ALl Authorizers implemented by the middle crate, implement tonic::service::Interceptor if the tonic feature is enabled.
use hello_world::{greeter_service_client::GreeterServiceClient, SayHelloRequest};
use middle::BearerTokenAuthorizer;
use tonic::transport::Endpoint;
pub mod hello_world {
tonic::include_proto!("helloworld");
}
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
// All authorizers provided by the `middle` crate implement the `tonic::Interceptor` trait.
let authorizer = BearerTokenAuthorizer::new("my-super-secret-token")?;
let channel = Endpoint::from_static("http://service.example.com:50051")
.connect()
.await?;
// Use the authorizer as an interceptor.
let mut client = GreeterServiceClient::with_interceptor(channel, authorizer);
// All following requests include the authorization header.
let request = tonic::Request::new(SayHelloRequest {
name: "Tonic".into(),
});
let response = client.say_hello(request).await?;
println!("RESPONSE={:?}", response);
Ok(())
}
Feature Flags
- all: Includes
rustls-tls,tonic,client-credentials, andruntime-tokio. - default: Includes
rustls-tls,client-credentials, andruntime-tokio. - rustls-tls: Enables
reqwest/rustls-tlsandreqwest/rustls-tls-native-roots. - tonic: Implement
tonic::service::Interceptorfor all Authorizers - runtime-tokio: Enables the
tokioruntime (currently the only supported async runtime). Some Authorizers depend on an async runtime to spawn refresh tasks. - client-credentials: Enables the
ClientCredentialAuthorizerfor the OAuth2 Client Credential flow
Dependencies
~11–29MB
~300K SLoC