messagesign

Crates.iomessagesign
lib.rsmessagesign
version7.0.2
created_at2024-12-07 01:08:11.353462+00
updated_at2025-03-17 10:22:14.971572+00
descriptionLibrary for signing requests to mehal services
homepagehttps://github.com/mehal-tech/messagesign
repositoryhttps://github.com/mehal-tech/messagesign
max_upload_size
id1474903
size66,374
Anton Whalley (No9)

documentation

https://docs.rs/messagesign

README

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 codecov OpenSSF Best Practices

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
       "hostname", // 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)
Commit count: 34

cargo fmt