#amazon-s3 #api-bindings #api-endpoint #s3v4

s3-presign

A minimal library for generating presigned URLs for Amazon S3 compatible services

3 releases

0.0.3 Oct 18, 2024
0.0.2 Feb 2, 2023
0.0.1 Jan 15, 2023

#265 in Authentication

Download history 121/week @ 2024-11-27 18/week @ 2024-12-04 76/week @ 2024-12-11 54/week @ 2024-12-18 55/week @ 2024-12-25 67/week @ 2025-01-01 2/week @ 2025-01-08 4/week @ 2025-01-29 433/week @ 2025-02-05 27/week @ 2025-02-12 97/week @ 2025-02-19 438/week @ 2025-02-26 46/week @ 2025-03-05 55/week @ 2025-03-12

643 downloads per month
Used in 3 crates (via atm0s-media-server-connec…)

MIT/Apache

20KB
426 lines

s3-presign

Minimal library to get an S3 presign URL.

Usage

use s3_presign::{Credentials, Presigner};

let credentials = Credentials::new(
    "blah.....blah...",
    "blah.....xxxxxxx",
    None,
);

let bucket = "my-bucket";
let region = "us-east-1";

let mut presigner = Presigner::new(credentials, bucket, region);
// presigner.endpoint(endpoint);
let url = self.presigner.url_for_s3_url(path).unwrap();

let signed_url = self.sign_s3_request("HEAD", &url);

let signed_url = self.sign_s3_request("PUT", &url);
let signed_url = self.sign_s3_request("GET", &url);

S3-compatible APIs

If you want to use the presigner with a different service that exposes an S3-compatible API (like Cloudflare R2), you can do so by specifying a root when creating the Presigner/Bucket.

let root = "xxxxx.eu.r2.cloudflarestorage.com";

let bucketObj = Bucket::mew_with_root(bucket, root, root);
let mut preBucket = Presigner::from_bucket(credentials, bucketObj);
preBucket.use_path_style(); // Cloudflare R2 only works with Path-Style!!!

let mut presigner = Presigner::new_with_root(credentials, bucket, region, root);

⚠️ Cloudflare R2

The R2s S3-API requires path style! Therefore, you can not use the global convenience function. Instead you need to create a Presigner and call Presigner::use_path_style(&self) on it.

Dependencies

~3.5–5MB
~91K SLoC