Struct DirectUpload 

pub struct DirectUpload {
    pub signed_key: String,
    pub url: String,
    pub headers: BTreeMap<String, String>,
}

A direct upload the browser may perform: PUT the file to url with headers, then submit signed_key.

Returned by direct_upload and sent to the browser as JSON (Rails’ direct_upload: { url, headers } plus signed_id). signed_key is the new object key followed by an HMAC: attach_direct_upload accepts only keys this app issued, so a client cannot claim another record’s file.

Examples

use ocre::storage::{DirectUpload, DirectUploadRequest, Rules, S3Endpoint};

const PHOTO: Rules = Rules { max_bytes: 1024, content_types: &["image/png"] };
let r2 = S3Endpoint::r2("acc", "blog-storage", "AKID", "secret");
let request = DirectUploadRequest { filename: "a.png".into(), content_type: "image/png".into(), size: 10 };
let upload = DirectUpload::sign(&r2, "uploads/photos", "image", &request, &PHOTO, 1_790_000_000, 600).unwrap();
assert!(upload.signed_key.starts_with("uploads/photos/"));
assert_eq!(upload.headers["Content-Type"], "image/png");
let json = serde_json::to_value(&upload).unwrap();
assert!(json["url"].as_str().unwrap().contains("X-Amz-SignedHeaders=content-length%3Bcontent-type%3Bhost"));

Fields

signed_key: String

The object key and its signature (<prefix>/<22 characters>.<43 characters>); the form submits it.

url: String

Presigned PUT URL on R2’s S3 API.

headers: BTreeMap<String, String>

Headers the PUT must carry, exactly (Content-Type); the browser adds Content-Length itself.

Implementations

impl DirectUpload

pub fn sign( endpoint: &S3Endpoint, prefix: &str, field: &str, request: &DirectUploadRequest, rules: &Rules, now: i64, expires_in: u64, ) -> Result<Self>

Checks request against rules and presigns a PUT of a new key under prefix, valid expires_in seconds.

The URL signs Content-Type (the declared type, normalized) and Content-Length (the declared size), so R2 refuses a PUT of another type or size. direct_upload calls it with the R2_* settings and ocre::now().

Errors

Error::Invalid (422) on field when the declared size or type breaks rules (the messages of Validator::file); Error::Internal when expires_in is out of range.

Examples

use ocre::storage::{DirectUpload, DirectUploadRequest, Rules, S3Endpoint};

const PHOTO: Rules = Rules { max_bytes: 1024, content_types: &["image/png"] };
let r2 = S3Endpoint::r2("acc", "blog-storage", "AKID", "secret");
let svg = DirectUploadRequest { filename: "a.svg".into(), content_type: "image/svg+xml".into(), size: 10 };
let err = DirectUpload::sign(&r2, "uploads", "image", &svg, &PHOTO, 1_790_000_000, 600).unwrap_err();
assert_eq!(err.to_string(), "invalid: Image has an unsupported type (allowed: image/png)");

Trait Implementations

impl Clone for DirectUpload

fn clone(&self) -> DirectUpload

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DirectUpload

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DirectUpload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DirectUpload

impl PartialEq for DirectUpload

fn eq(&self, other: &DirectUpload) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DirectUpload

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DirectUpload