#signature #web #mehal #brog

messagesign

Library for signing requests to mehal services

4 stable releases

new 4.0.0 Feb 22, 2025
3.0.1 Dec 9, 2024
3.0.0 Dec 8, 2024
2.0.1 Dec 7, 2024
1.0.0 Dec 7, 2024

#472 in Authentication

Download history 360/week @ 2024-12-07 17/week @ 2024-12-14 3/week @ 2024-12-28 26/week @ 2025-01-25 119/week @ 2025-02-01

145 downloads per month

MIT license

17KB
240 lines

messagesign

A rust library to sign requests to mehal services based on the AWS S3V4 approach.

The implementation is based on the s3v4 library.

This crate provides a signature function that can be used to sign a request to an mehal services.

Both functions return an Error generated by the error_chain crate which can be converted to a String or accessed through the description method or display_chain and backtrace methods in case a full backtrace is needed.

Build

Examples

Signing a request

   let url = url::Url::parse("https://mehal.tech/endpoint").unwrap();
   let signature: messagesign::Signature = messagesign::signature(
       &url, // The endpoint of the mehel services
       "GET",   // The http Method  
       "ivegotthekey",  // the access key provided with your secret
       "ivegotthesecret", // The secret provided for your project
       "global", // A supported region See mehal.tech docs
       &"brog",
       "machineid", // The data in /etc/machine-id
       "UNSIGNED-PAYLOAD", //payload hash, or "UNSIGNED-PAYLOAD"
       "", // An empty string or a random u32
   ).map_err(|err| format!("Signature error: {}", err.display_chain()))?;

Using the signature data to make a request

Hyper

       let req = Request::builder()
       .method(Method::GET)
       .header("x-mhl-content-sha256", "UNSIGNED-PAYLOAD")
       .header("x-mhl-date", &signature.date_time)
       .header("x-mhl-mid", &machineid)
       .header("authorization", &signature.auth_header)

Ureq

   let agent = AgentBuilder::new().build();
   let response = agent
       .put(&uri)
       .set("x-mhl-content-sha256", "UNSIGNED-PAYLOAD")
       .set("x-mhl-date", &signature.date_time)
       .set("x-mhl-mid", &machineid)
       .set("authorization", &signature.auth_header)

Dependencies

~6–13MB
~158K SLoC