Functional Weave
Code in Rust

storage.signed-url@1.0.0

contracts.json

14,302 bytes · view raw

[
  {"fn":"signUpload","name":"s3: a PUT URL for an avatar, the content type signed","provider":"s3","env":{"S3_BUCKET":"acme-uploads","S3_REGION":"eu-west-2","S3_ACCESS_KEY_ID":"AKIAIOSFODNN7EXAMPLE","S3_SECRET_ACCESS_KEY":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"},"now":"2026-03-01T12:00:00Z","args":["avatars/u_42.png","image/png"],"expect":{"method":"PUT","url":"https://acme-uploads.s3.eu-west-2.amazonaws.com/avatars/u_42.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20260301%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20260301T120000Z&X-Amz-Expires=900&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Signature=ad03097932fbc21972830032dbd2ed7cf5cf8b1dd5f21ad69fe611a9a39d5674","headers":{"content-type":"image/png"},"expiresAt":"2026-03-01T12:15:00Z"}},
  {"fn":"signUpload","name":"gcs: an hour-long PUT URL, a space in the key","provider":"gcs","env":{"GCS_BUCKET":"acme-uploads","GCS_HMAC_ACCESS_ID":"GOOG1EXAMPLEACCESSIDFORCONTRACTTESTS0000000000000000000000","GCS_HMAC_SECRET":"bGoa+V7g/yqDXvKRqq+JTFn4uQZbPiQJo4pf9RzJ"},"now":"2026-03-01T12:00:00Z","args":["invoices/2026/03/inv 001.pdf","application/pdf",3600],"expect":{"method":"PUT","url":"https://storage.googleapis.com/acme-uploads/invoices/2026/03/inv%20001.pdf?X-Goog-Algorithm=GOOG4-HMAC-SHA256&X-Goog-Credential=GOOG1EXAMPLEACCESSIDFORCONTRACTTESTS0000000000000000000000%2F20260301%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20260301T120000Z&X-Goog-Expires=3600&X-Goog-SignedHeaders=content-type%3Bhost&X-Goog-Signature=79eeb6e3aeb70369d33b84c1966ef8705d8c25c8bd5147bceb2d2bac750220d1","headers":{"content-type":"application/pdf"},"expiresAt":"2026-03-01T13:00:00Z"}},
  {"fn":"signUpload","name":"s3: Cloudflare R2 through S3_ENDPOINT, path-style, region auto","provider":"s3","env":{"S3_BUCKET":"acme-uploads","S3_REGION":"auto","S3_ACCESS_KEY_ID":"R2EXAMPLEACCESSKEY01","S3_SECRET_ACCESS_KEY":"r2-example-secret-for-contract-tests","S3_ENDPOINT":"https://accountid.r2.cloudflarestorage.com"},"now":"2026-03-01T12:00:00Z","args":["docs/report.csv","text/csv; charset=utf-8"],"expect":{"method":"PUT","url":"https://accountid.r2.cloudflarestorage.com/acme-uploads/docs/report.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=R2EXAMPLEACCESSKEY01%2F20260301%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20260301T120000Z&X-Amz-Expires=900&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Signature=d22dc7564b55a16b971ab319f27fb18e954c4d5c05c8014708c8069186af15e0","headers":{"content-type":"text/csv; charset=utf-8"},"expiresAt":"2026-03-01T12:15:00Z"}},
  {"fn":"signUpload","name":"s3: MinIO on localhost, a port in the host, non-ASCII in the key","provider":"s3","env":{"S3_BUCKET":"dev-bucket","S3_REGION":"us-east-1","S3_ACCESS_KEY_ID":"minioadmin","S3_SECRET_ACCESS_KEY":"minioadmin-secret","S3_ENDPOINT":"http://localhost:9000/"},"now":"2026-03-01T12:00:00Z","args":["a/b c/été.txt","text/plain",60],"expect":{"method":"PUT","url":"http://localhost:9000/dev-bucket/a/b%20c/%C3%A9t%C3%A9.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20260301%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260301T120000Z&X-Amz-Expires=60&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Signature=3711a47e1bf283e48c6760e53fda12cd5643ac335d600481c8d354f3513aa794","headers":{"content-type":"text/plain"},"expiresAt":"2026-03-01T12:01:00Z"}},
  {"fn":"signUpload","name":"s3: a bucket with a dot is path-style, a week at most","provider":"s3","env":{"S3_BUCKET":"acme.uploads","S3_REGION":"us-east-1","S3_ACCESS_KEY_ID":"AKIAIOSFODNN7EXAMPLE","S3_SECRET_ACCESS_KEY":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"},"now":"2026-03-01T12:00:00Z","args":["x.json","application/json",604800],"expect":{"method":"PUT","url":"https://s3.amazonaws.com/acme.uploads/x.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20260301%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260301T120000Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Signature=03a717125b3e71d4cb8a0aff7093935b81dd87298f20df6d341451224e9273f0","headers":{"content-type":"application/json"},"expiresAt":"2026-03-08T12:00:00Z"}},
  {"fn":"signUpload","name":"a key with .. is refused","provider":"s3","env":{"S3_BUCKET":"acme-uploads","S3_REGION":"eu-west-2","S3_ACCESS_KEY_ID":"AKIAIOSFODNN7EXAMPLE","S3_SECRET_ACCESS_KEY":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"},"now":"2026-03-01T12:00:00Z","args":["avatars/../secrets.txt","text/plain"],"expectError":"contains \"..\""},
  {"fn":"signUpload","name":"a key with a leading slash","provider":"gcs","env":{"GCS_BUCKET":"acme-uploads","GCS_HMAC_ACCESS_ID":"GOOG1EXAMPLEACCESSIDFORCONTRACTTESTS0000000000000000000000","GCS_HMAC_SECRET":"bGoa+V7g/yqDXvKRqq+JTFn4uQZbPiQJo4pf9RzJ"},"now":"2026-03-01T12:00:00Z","args":["/avatars/u.png","image/png"],"expectError":"starts with \"/\""},
  {"fn":"signUpload","name":"a key with a control character","provider":"s3","env":{"S3_BUCKET":"acme-uploads","S3_REGION":"eu-west-2","S3_ACCESS_KEY_ID":"AKIAIOSFODNN7EXAMPLE","S3_SECRET_ACCESS_KEY":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"},"now":"2026-03-01T12:00:00Z","args":["a\nb.png","image/png"],"expectError":"key contains a control character"},
  {"fn":"signUpload","name":"a key longer than 1024 bytes","provider":"gcs","env":{"GCS_BUCKET":"acme-uploads","GCS_HMAC_ACCESS_ID":"GOOG1EXAMPLEACCESSIDFORCONTRACTTESTS0000000000000000000000","GCS_HMAC_SECRET":"bGoa+V7g/yqDXvKRqq+JTFn4uQZbPiQJo4pf9RzJ"},"now":"2026-03-01T12:00:00Z","args":["ééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééééé","image/png"],"expectError":"key is longer than 1024 bytes"},
  {"fn":"signUpload","name":"a content type that is not one","provider":"s3","env":{"S3_BUCKET":"acme-uploads","S3_REGION":"eu-west-2","S3_ACCESS_KEY_ID":"AKIAIOSFODNN7EXAMPLE","S3_SECRET_ACCESS_KEY":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"},"now":"2026-03-01T12:00:00Z","args":["a.png","png"],"expectError":"contentType \"png\" is not a media type"},
  {"fn":"signUpload","name":"an expiry over a week","provider":"gcs","env":{"GCS_BUCKET":"acme-uploads","GCS_HMAC_ACCESS_ID":"GOOG1EXAMPLEACCESSIDFORCONTRACTTESTS0000000000000000000000","GCS_HMAC_SECRET":"bGoa+V7g/yqDXvKRqq+JTFn4uQZbPiQJo4pf9RzJ"},"now":"2026-03-01T12:00:00Z","args":["a.png","image/png",604801],"expectError":"expiresSeconds is a whole number from 1 to 604800"},
  {"fn":"signUpload","name":"no secret set","provider":"s3","env":{"S3_BUCKET":"acme-uploads","S3_REGION":"eu-west-2","S3_ACCESS_KEY_ID":"AKIAIOSFODNN7EXAMPLE","S3_SECRET_ACCESS_KEY":""},"now":"2026-03-01T12:00:00Z","args":["a.png","image/png"],"expectError":"S3_SECRET_ACCESS_KEY is not set"},
  {"fn":"signUpload","name":"no provider chosen","env":{"S3_BUCKET":"acme-uploads","S3_REGION":"eu-west-2","S3_ACCESS_KEY_ID":"AKIAIOSFODNN7EXAMPLE","S3_SECRET_ACCESS_KEY":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"},"now":"2026-03-01T12:00:00Z","args":["a.png","image/png"],"expectError":"STORAGE_PROVIDER is not set; set it to one of s3, gcs"},
  {"fn":"signDownload","name":"s3: AWS's documented example, reproduced exactly","provider":"s3","env":{"S3_BUCKET":"examplebucket","S3_REGION":"us-east-1","S3_ACCESS_KEY_ID":"AKIAIOSFODNN7EXAMPLE","S3_SECRET_ACCESS_KEY":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"},"now":"2013-05-24T00:00:00Z","args":["test.txt",86400],"expect":{"method":"GET","url":"https://examplebucket.s3.amazonaws.com/test.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20130524%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20130524T000000Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=aeeed9bbccd4d02ee5c0109b86d86835f995330da4c265957d157751f604d404","headers":{},"expiresAt":"2013-05-25T00:00:00Z"}},
  {"fn":"signDownload","name":"s3: saved as a file name","provider":"s3","env":{"S3_BUCKET":"acme-uploads","S3_REGION":"eu-west-2","S3_ACCESS_KEY_ID":"AKIAIOSFODNN7EXAMPLE","S3_SECRET_ACCESS_KEY":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"},"now":"2026-03-01T12:00:00Z","args":["avatars/u_42.png",300,"avatar.png"],"expect":{"method":"GET","url":"https://acme-uploads.s3.eu-west-2.amazonaws.com/avatars/u_42.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20260301%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20260301T120000Z&X-Amz-Expires=300&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3D%22avatar.png%22&X-Amz-Signature=002f60bebf51734f821bf52d990355d78170ba4b7de36a297b0777c60556cc4f","headers":{},"expiresAt":"2026-03-01T12:05:00Z"}},
  {"fn":"signDownload","name":"gcs: a GET URL, the default fifteen minutes","provider":"gcs","env":{"GCS_BUCKET":"acme-uploads","GCS_HMAC_ACCESS_ID":"GOOG1EXAMPLEACCESSIDFORCONTRACTTESTS0000000000000000000000","GCS_HMAC_SECRET":"bGoa+V7g/yqDXvKRqq+JTFn4uQZbPiQJo4pf9RzJ"},"now":"2026-03-01T12:00:00Z","args":["invoices/2026/03/inv 001.pdf"],"expect":{"method":"GET","url":"https://storage.googleapis.com/acme-uploads/invoices/2026/03/inv%20001.pdf?X-Goog-Algorithm=GOOG4-HMAC-SHA256&X-Goog-Credential=GOOG1EXAMPLEACCESSIDFORCONTRACTTESTS0000000000000000000000%2F20260301%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20260301T120000Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=c5fd196a388abc6a789abad26eb0d34d651e08104c0159591026a8cdf0f47e6d","headers":{},"expiresAt":"2026-03-01T12:15:00Z"}},
  {"fn":"signDownload","name":"gcs: a non-ASCII file name has a UTF-8 form","provider":"gcs","env":{"GCS_BUCKET":"acme-uploads","GCS_HMAC_ACCESS_ID":"GOOG1EXAMPLEACCESSIDFORCONTRACTTESTS0000000000000000000000","GCS_HMAC_SECRET":"bGoa+V7g/yqDXvKRqq+JTFn4uQZbPiQJo4pf9RzJ"},"now":"2026-03-01T12:00:00Z","args":["r.pdf",900,"résumé.pdf"],"expect":{"method":"GET","url":"https://storage.googleapis.com/acme-uploads/r.pdf?X-Goog-Algorithm=GOOG4-HMAC-SHA256&X-Goog-Credential=GOOG1EXAMPLEACCESSIDFORCONTRACTTESTS0000000000000000000000%2F20260301%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20260301T120000Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3D%22r_sum_.pdf%22%3B%20filename%2A%3DUTF-8%27%27r%25C3%25A9sum%25C3%25A9.pdf&X-Goog-Signature=963b2325d61a2a31d8835ee0d3332fa75cd61e786c547c531dde111bea2c64d8","headers":{},"expiresAt":"2026-03-01T12:15:00Z"}},
  {"fn":"signDownload","name":"s3: reserved characters in the key are encoded, the clock read in whole seconds","provider":"s3","env":{"S3_BUCKET":"acme-uploads","S3_REGION":"eu-west-2","S3_ACCESS_KEY_ID":"AKIAIOSFODNN7EXAMPLE","S3_SECRET_ACCESS_KEY":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"},"now":1772366400999,"args":["a+b&c=d.txt"],"expect":{"method":"GET","url":"https://acme-uploads.s3.eu-west-2.amazonaws.com/a%2Bb%26c%3Dd.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20260301%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20260301T120000Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=fcbc17376732aec7c1545db56590796aa72f8699e2e27a5ba3f7bb759f16a8b8","headers":{},"expiresAt":"2026-03-01T12:15:00Z"}},
  {"fn":"signDownload","name":"a file name with a quote is refused","provider":"s3","env":{"S3_BUCKET":"acme-uploads","S3_REGION":"eu-west-2","S3_ACCESS_KEY_ID":"AKIAIOSFODNN7EXAMPLE","S3_SECRET_ACCESS_KEY":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"},"now":"2026-03-01T12:00:00Z","args":["a.png",900,"a\".png"],"expectError":"filename is a plain file name"},
  {"fn":"signDownload","name":"an expiry of 0","provider":"gcs","env":{"GCS_BUCKET":"acme-uploads","GCS_HMAC_ACCESS_ID":"GOOG1EXAMPLEACCESSIDFORCONTRACTTESTS0000000000000000000000","GCS_HMAC_SECRET":"bGoa+V7g/yqDXvKRqq+JTFn4uQZbPiQJo4pf9RzJ"},"now":"2026-03-01T12:00:00Z","args":["a.png",0],"expectError":"expiresSeconds is a whole number from 1 to 604800"},
  {"fn":"signDownload","name":"an empty key","provider":"gcs","env":{"GCS_BUCKET":"acme-uploads","GCS_HMAC_ACCESS_ID":"GOOG1EXAMPLEACCESSIDFORCONTRACTTESTS0000000000000000000000","GCS_HMAC_SECRET":"bGoa+V7g/yqDXvKRqq+JTFn4uQZbPiQJo4pf9RzJ"},"now":"2026-03-01T12:00:00Z","args":[""],"expectError":"key is the object's name"},
  {"fn":"signDownload","name":"a traversal in the key","provider":"gcs","env":{"GCS_BUCKET":"acme-uploads","GCS_HMAC_ACCESS_ID":"GOOG1EXAMPLEACCESSIDFORCONTRACTTESTS0000000000000000000000","GCS_HMAC_SECRET":"bGoa+V7g/yqDXvKRqq+JTFn4uQZbPiQJo4pf9RzJ"},"now":"2026-03-01T12:00:00Z","args":["../etc/passwd"],"expectError":"contains \"..\""},
  {"fn":"signDownload","name":"an endpoint with a path is refused","provider":"s3","env":{"S3_BUCKET":"acme-uploads","S3_REGION":"eu-west-2","S3_ACCESS_KEY_ID":"AKIAIOSFODNN7EXAMPLE","S3_SECRET_ACCESS_KEY":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY","S3_ENDPOINT":"https://example.com/bucket"},"now":"2026-03-01T12:00:00Z","args":["a.png"],"expectError":"S3_ENDPOINT is an origin"},
  {"fn":"signDownload","name":"no HMAC secret set","provider":"gcs","env":{"GCS_BUCKET":"b","GCS_HMAC_ACCESS_ID":"GOOG1X"},"now":"2026-03-01T12:00:00Z","args":["a.png"],"expectError":"GCS_HMAC_SECRET is not set"},
  {"fn":"signDownload","name":"an unknown provider","env":{"S3_BUCKET":"acme-uploads","S3_REGION":"eu-west-2","S3_ACCESS_KEY_ID":"AKIAIOSFODNN7EXAMPLE","S3_SECRET_ACCESS_KEY":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY","STORAGE_PROVIDER":"azure"},"now":"2026-03-01T12:00:00Z","args":["a.png"],"expectError":"STORAGE_PROVIDER is \"azure\"; set it to one of s3, gcs"}
]