Skip to content

Add an unsigned_payload option to put #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
toots wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add an unsigned_payload option to put #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion aws-s3/aws.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ module Make(Io : Types.Io) = struct
in
Pipe.create_reader ~f:(transfer initial_signature Digestif.SHA256.empty 0 [] None)

let make_request ~(endpoint: Region.endpoint) ?connect_timeout_ms ?(expect=false) ~sink ?(body=Body.Empty) ?(credentials:Credentials.t option) ~headers ~meth ~path ~query () =
let make_request ~(endpoint: Region.endpoint) ?connect_timeout_ms ?(expect=false) ?(unsigned_payload=false) ~sink ?(body=Body.Empty) ?(credentials:Credentials.t option) ~headers ~meth ~path ~query () =
let (date, time) = Unix.gettimeofday () |> Time.iso8601_of_time in

(* Create headers structure *)
Expand All @@ -108,8 +108,11 @@ module Make(Io : Types.Io) = struct
| (`PUT | `POST), Body.Empty -> Some "0"
| _ -> None
in
(* A chunked body is signed chunk by chunk, so [unsigned_payload] only has
anything to say about a string body. *)
let payload_sha = match body with
| Body.Empty -> empty_sha
| Body.String _ when unsigned_payload -> "UNSIGNED-PAYLOAD"
| Body.String body -> Authorization.hash_sha256 body |> Authorization.to_hex
| Body.Chunked _ -> "STREAMING-AWS4-HMAC-SHA256-PAYLOAD"
in
Expand Down
1 change: 1 addition & 0 deletions aws-s3/aws.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ module Make(Io : Types.Io) : sig
endpoint:Region.endpoint ->
?connect_timeout_ms:int ->
?expect:bool ->
?unsigned_payload:bool ->
sink:string Io.Pipe.writer ->
?body:Body.Make(Io).t ->
?credentials:Credentials.t ->
Expand Down
8 changes: 4 additions & 4 deletions aws-s3/s3.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ module Make(Io : Types.Io) = struct
Deferred.return (Error (Unknown (code, resp.code)))


let put_common ?credentials ?connect_timeout_ms ?(confirm_requester_pays=false) ~endpoint ?content_type ?content_encoding ?acl ?cache_control ?expect ?(meta_headers=[]) ~bucket ~key ~body () =
let put_common ?credentials ?connect_timeout_ms ?(confirm_requester_pays=false) ?unsigned_payload ~endpoint ?content_type ?content_encoding ?acl ?cache_control ?expect ?(meta_headers=[]) ~bucket ~key ~body () =
let path = sprintf "/%s/%s" bucket key in
let headers =
(
Expand All @@ -297,7 +297,7 @@ module Make(Io : Types.Io) = struct
in
let sink = Body.null () in
let cmd () =
Aws.make_request ~endpoint ?expect ?credentials ?connect_timeout_ms ~headers ~meth:`PUT ~path ~sink ~body ~query:[] ()
Aws.make_request ~endpoint ?expect ?credentials ?connect_timeout_ms ?unsigned_payload ~headers ~meth:`PUT ~path ~sink ~body ~query:[] ()
in

do_command ~endpoint cmd >>=? fun headers ->
Expand Down Expand Up @@ -342,9 +342,9 @@ module Make(Io : Types.Io) = struct
end
(* End streaming module *)

let put ?credentials ?connect_timeout_ms ?confirm_requester_pays ~endpoint ?content_type ?content_encoding ?acl ?cache_control ?expect ?meta_headers ~bucket ~key ~data () =
let put ?credentials ?connect_timeout_ms ?confirm_requester_pays ~endpoint ?unsigned_payload ?content_type ?content_encoding ?acl ?cache_control ?expect ?meta_headers ~bucket ~key ~data () =
let body = Body.String data in
put_common ?credentials ?connect_timeout_ms ?confirm_requester_pays ?content_type ?content_encoding ?acl ?cache_control ?expect ?meta_headers ~endpoint ~bucket ~key ~body ()
put_common ?credentials ?connect_timeout_ms ?confirm_requester_pays ?unsigned_payload ?content_type ?content_encoding ?acl ?cache_control ?expect ?meta_headers ~endpoint ~bucket ~key ~body ()

let get ?credentials ?connect_timeout_ms ?confirm_requester_pays ~endpoint ?range ~bucket ~key () =
let body, data = string_sink () in
Expand Down
7 changes: 6 additions & 1 deletion aws-s3/s3.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,14 @@ module Make(Io : Types.Io) : sig
arguments are expected to be a list of key-value pairs, the keys will be
prefixed with "x-amz-meta-".
@see https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingMetadata.html#UserMetadata
@param unsigned_payload If true, the request is signed with
UNSIGNED-PAYLOAD instead of the sha256 of [data], which saves a full pass
over the body but leaves the payload out of the signature, so it should
only be used over https.
*)
val put :
(?content_type:string ->
(?unsigned_payload:bool ->
?content_type:string ->
?content_encoding:string ->
?acl:string ->
?cache_control:string ->
Expand Down