#http #signatures #digest #reqwest

http-signature-normalization-reqwest

An HTTP Signatures library that leaves the signing to you

14 releases (7 breaking)

Uses new Rust 2021

0.8.0 Dec 8, 2022
0.7.1 Nov 23, 2022
0.6.0 Apr 25, 2022
0.5.0 Jan 17, 2022
0.1.3 Sep 30, 2020

#326 in Cryptography

Download history 325/week @ 2022-10-08 274/week @ 2022-10-15 550/week @ 2022-10-22 589/week @ 2022-10-29 506/week @ 2022-11-05 469/week @ 2022-11-12 603/week @ 2022-11-19 199/week @ 2022-11-26 200/week @ 2022-12-03 191/week @ 2022-12-10 284/week @ 2022-12-17 157/week @ 2022-12-24 162/week @ 2022-12-31 147/week @ 2023-01-07 177/week @ 2023-01-14 200/week @ 2023-01-21

705 downloads per month
Used in 16 crates (3 directly)

AGPL-3.0

60KB
1K SLoC

HTTP Signature Normaliztion Reqwest

An HTTP Signatures library that leaves the signing to you

Http Signature Normalization is a minimal-dependency crate for producing HTTP Signatures with user-provided signing and verification. The API is simple; there's a series of steps for creation and verification with types that ensure reasonable usage.

Usage

This crate provides extensions the RequestBuilder type from reqwest

First, add this crate to your dependencies

http-signature-normalization-reqwest = { version = "0.2.0", default-features = false, features = ["sha-2"] }
reqwest = "0.11"
sha2 = "0.9"
thiserror = "0.1"
tokio = "1"

Then, use it in your client

use http_signature_normalization_reqwest::prelude::*;
use reqwest::{header::DATE, Client};
use sha2::{Digest, Sha256};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let config = Config::default().require_header("accept");

    let digest = Sha256::new();

    let response = Client::new()
        .post("http://127.0.0.1:8010/")
        .header("User-Agent", "Reqwest")
        .header("Accept", "text/plain")
        .signature_with_digest(config, "my-key-id", digest, "my request body", |s| {
            println!("Signing String\n{}", s);
            Ok(base64::encode(s)) as Result<_, MyError>
        })
        .await?;

    let body = response.bytes().await.map_err(MyError::Body)?;

    println!("{:?}", body);
    Ok(())
}

#[derive(Debug, thiserror::Error)]
pub enum MyError {
    #[error("Failed to create signing string, {0}")]
    Convert(#[from] SignError),

    #[error("Failed to send request")]
    SendRequest(#[from] reqwest::Error),

    #[error("Failed to retrieve request body")]
    Body(reqwest::Error),
}

Contributing

Feel free to open issues for anything you find an issue with. Please note that any contributed code will be licensed under the AGPLv3.

License

Copyright © 2022 Riley Trautman

HTTP Signature Normalization Reqwest is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

HTTP Signature Normalization Reqwest is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. This file is part of HTTP Signature Normalization Reqwest.

You should have received a copy of the GNU General Public License along with HTTP Signature Normalization Reqwest. If not, see http://www.gnu.org/licenses/.

Dependencies

~4–12MB
~239K SLoC