#oauth2 #reqwest-client #client-token #tonic #bearer #middleware #authorization

middle

Client Authorization Middleware for APIs secured via OAuth2 or Bearer Tokens. Tonic & reqwest integration. Based on the oauth2 crate.

2 unstable releases

new 0.2.0 Feb 20, 2025
0.1.0 Feb 19, 2025

#199 in Authentication

24 downloads per month

Apache-2.0

56KB
1K SLoC

Crates.io License Tests

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
  • reqwest integration by using a wrapped HttpClient
  • tonic integration via Interceptors
  • Support for OAuth2 Client Credential flow
  • Support for Bearer Token authentication
  • Based on the oauth2 crate
  • 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::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::new(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, and runtime-tokio.
  • default: Includes rustls-tls, client-credentials, and runtime-tokio.
  • rustls-tls: Enables reqwest/rustls-tls and reqwest/rustls-tls-native-roots.
  • tonic: Implement tonic::service::Interceptor for all Authorizers
  • runtime-tokio: Enables the tokio runtime (currently the only supported async runtime). Some Authorizers depend on an async runtime to spawn refresh tasks.
  • client-credentials: Enables the ClientCredentialAuthorizer for the OAuth2 Client Credential flow

Dependencies

~7–19MB
~261K SLoC