Skip to content

Commit 5fb8918

Browse files
AllanZhengYPAllanZhengYP
authored
feat(s3-presigned-post): support S3 object post (#1642)
* feat(s3-presigned-post): support S3 object post * chore(s3-presigned-post): address formatting issues
1 parent 79f25ca commit 5fb8918

11 files changed

+636
-0
lines changed

‎packages/s3-presigned-post/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎packages/s3-presigned-post/README.md

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# @aws-sdk/s3-resigned-post
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/s3-presigned-post/rc.svg)](https://www.npmjs.com/package/@aws-sdk/s3-presigned-post)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/s3-presigned-post/rc.svg)](https://www.npmjs.com/package/@aws-sdk/s3-presigned-post)
5+
6+
This package provide a function generating URL and fields. Users without AWS credentials can use the URL and fields to
7+
to make a POST request to S3. The documentation for the server side feature can be found in [S3 API Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-UsingHTTPPOST.html). Please read related sections for more context.
8+
9+
### Import
10+
11+
JavaScript Example:
12+
13+
```javascript
14+
const { createPresignedPost } = require("@aws-sdk/s3-presigned-post");
15+
const { S3Client } = require("@aws-sdk/client-s3");
16+
```
17+
18+
ES6 Example
19+
20+
```javascript
21+
import { createPresignedPost } from "@aws-sdk/s3-presigned-post";
22+
import { S3Client } from "@aws-sdk/client-s3";
23+
```
24+
25+
### Create a POST Policy
26+
27+
You can optionally attach a policy to a presigned post. It specifies a list of conditions that the request must meet.
28+
For example:
29+
30+
```typescript
31+
const Conditions = [{ acl: "public-read" }, { bucket: "johnsmith" }, ["starts-with", "$key", "user/eric/"]];
32+
```
33+
34+
Visit [S3 POST documentation](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-HTTPPOSTConstructPolicy.html)
35+
for supported policy elements. If you include a condition, you must specify the valid value in the `Fields` parameter
36+
as well. A value will not be added automatically to the fields dictionary according to the conditions.
37+
38+
### Generate a Presigned Post
39+
40+
Users can generate required url and fields for POST request:
41+
42+
```typescript
43+
const client = new S3Client({ region: "us-west-2" });
44+
const Bucket = "johnsmith";
45+
const Key = "user/eric/1";
46+
const Fields = {
47+
acl: "public-read",
48+
};
49+
const { url, fields } = await createPresignedPost({
50+
Bucket,
51+
Key,
52+
Conditions,
53+
Fields,
54+
Expires: 600, //Seconds before the presigned post expires. 3600 by default.
55+
});
56+
```
57+
58+
The `Bucket`, `Key` and other values in `Fields` must meet the conditions specified in `Conditions`. The `Key` can also
59+
contain `${filename}` that will be automatically replaced by the name of the file provided. See [the S3 reference](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-HTTPPOSTForms.html#sigv4-HTTPPOSTFormFields)
60+
for more information.
61+
62+
### Post File using HTML Form
63+
64+
You can also post a file with HTML form:
65+
66+
```html
67+
<html>
68+
<head>
69+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
70+
</head>
71+
<body>
72+
<!-- Copy the 'url' value returned by createPresignedPost() -->
73+
<form action="URL_VALUE" method="post" enctype="multipart/form-data">
74+
<!-- Copy the 'fields' key:values returned by S3Client.generate_presigned_post() -->
75+
<input type="hidden" name="key" value="VALUE" />
76+
<input type="hidden" name="AWSAccessKeyId" value="VALUE" />
77+
<input type="hidden" name="policy" value="VALUE" />
78+
<input type="hidden" name="signature" value="VALUE" />
79+
File:
80+
<input type="file" name="file" /> <br />
81+
<input type="submit" name="submit" value="Upload to Amazon S3" />
82+
</form>
83+
</body>
84+
</html>
85+
```
86+
87+
### Post File using FormData in Node.js
88+
89+
In Node.js, use `form-data` package to post a file:
90+
91+
```typescript
92+
const { createReadStream } = require("fs");
93+
const FormData = require("form-data");
94+
95+
const form = new FormData();
96+
Object.entries(fields).forEach(([field, value]) => {
97+
form.append(field, value);
98+
});
99+
form.append("file", createReadStream("path/to/a/file"));
100+
form.submit(url, (err, res) => {
101+
//handle the response
102+
});
103+
```

‎packages/s3-presigned-post/jest.config.js

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
const base = require("../../jest.config.base.js");
2+
3+
module.exports = {
4+
...base,
5+
};

‎packages/s3-presigned-post/package.json

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"name": "@aws-sdk/s3-presigned-post",
3+
"version": "1.0.0-rc.3",
4+
"scripts": {
5+
"prepublishOnly": "yarn build:cjs && yarn build:es",
6+
"pretest": "yarn build:cjs",
7+
"build:cjs": "tsc -p tsconfig.cjs.json",
8+
"build:es": "tsc -p tsconfig.es.json",
9+
"build": "yarn build:es && yarn build:cjs",
10+
"test": "jest"
11+
},
12+
"main": "./dist/cjs/index.js",
13+
"module": "./dist/es/index.js",
14+
"types": "./dist/cjs/index.d.ts",
15+
"author": {
16+
"name": "AWS SDK for JavaScript Team",
17+
"url": "https://aws.amazon.com/javascript/"
18+
},
19+
"license": "Apache-2.0",
20+
"dependencies": {
21+
"@aws-sdk/signature-v4": "1.0.0-rc.3",
22+
"@aws-sdk/types": "1.0.0-rc.3",
23+
"@aws-sdk/util-format-url": "1.0.0-rc.3",
24+
"@aws-sdk/util-hex-encoding": "1.0.0-rc.3",
25+
"tslib": "^1.8.0"
26+
},
27+
"devDependencies": {
28+
"@aws-sdk/client-s3": "1.0.0-rc.3",
29+
"@aws-sdk/hash-node": "1.0.0-rc.3",
30+
"@aws-sdk/protocol-http": "1.0.0-rc.3",
31+
"@types/jest": "^26.0.4",
32+
"@types/node": "^12.0.2",
33+
"jest": "^26.1.0",
34+
"typescript": "~4.0.2"
35+
},
36+
"engines": {
37+
"node": ">= 10.0.0"
38+
},
39+
"homepage": "https://github.com/aws/aws-sdk-js-v3/tree/master/packages/s3-presigned-post",
40+
"repository": {
41+
"type": "git",
42+
"url": "https://github.com/aws/aws-sdk-js-v3.git",
43+
"directory": "packages/s3-presigned-post"
44+
}
45+
}

‎packages/s3-presigned-post/src/constants.ts

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
export const ALGORITHM_QUERY_PARAM = "X-Amz-Algorithm";
2+
export const CREDENTIAL_QUERY_PARAM = "X-Amz-Credential";
3+
export const AMZ_DATE_QUERY_PARAM = "X-Amz-Date";
4+
export const TOKEN_QUERY_PARAM = "X-Amz-Security-Token";
5+
export const SIGNATURE_QUERY_PARAM = "X-Amz-Signature";
6+
7+
export const ALGORITHM_IDENTIFIER = "AWS4-HMAC-SHA256";

0 commit comments

Comments
 (0)