rocket-apitoken

Crates.iorocket-apitoken
lib.rsrocket-apitoken
version0.1.0
sourcesrc
created_at2024-12-02 04:50:58.307878
updated_at2024-12-02 04:50:58.307878
descriptionA very simple API Authorization module for Rocket web applications
homepage
repositoryhttps://github.com/kvinwang/rocket-apitoken
max_upload_size
id1468252
size6,177
Kevin Wang (kvinwang)

documentation

https://docs.rs/rocket-apitoken

README

rocket-apitoken

Crate API

A very simple API Authorization module for Rocket web applications

Overview

This module provides a simple token-based authorization system for Rocket web applications. It supports both enabled and disabled states, and validates Bearer tokens against a predefined set.

Usage Example

use rocket;
use rocket_apitoken::{ApiToken, Authorized};

#[post("/<method>?<json>", data = "<data>")]
async fn protected_endpoint(_auth: Authorized, /* other params */) {
    // If this executes, the request was authorized
    // ...
}

#[launch]
fn rocket() -> _ {
    let tokens = vec!["secret-token".to_string()];
    rocket::build()
        .manage(ApiToken::new(tokens, true))
        .mount("/api", routes![protected_endpoint])
}

Configuration

  • Create an ApiToken instance with a list of valid tokens and enabled state
  • Add it to Rocket's state using .manage()
  • Use the Authorized guard in your route handlers

When enabled, requests must include a valid token in the Authorization header. When disabled, all requests are authorized automatically.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Commit count: 4

cargo fmt