Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

Improve s3 keys sanitizer (#2095)

Bogdan Chadkin9af97656af2e
diff --git a/packages/asset-uploader/package.json b/packages/asset-uploader/package.json
index a9a19b61c5..eaea12d50c 100644
--- a/packages/asset-uploader/package.json
+++ b/packages/asset-uploader/package.json
@@ -15,7 +15,7 @@
},
"dependencies": {
"@aws-crypto/sha256-js": "^5.0.0",
- "@smithy/signature-v4": "^1.0.2",
+ "@smithy/signature-v4": "^2.0.2",
"@webstudio-is/fonts": "workspace:^",
"@webstudio-is/prisma-client": "workspace:^",
"@webstudio-is/trpc-interface": "workspace:^",
diff --git a/packages/asset-uploader/src/clients/s3/s3.ts b/packages/asset-uploader/src/clients/s3/s3.ts
index fea87d391d..81eecb1010 100644
--- a/packages/asset-uploader/src/clients/s3/s3.ts
+++ b/packages/asset-uploader/src/clients/s3/s3.ts
@@ -22,6 +22,8 @@ export const createS3Client = (options: S3ClientOptions): AssetClient => {
region: options.region,
service: "s3",
sha256: Sha256,
+ // should never be enabled when work with s3
+ uriEscapePath: false,
});
const uploadFile: AssetClient["uploadFile"] = async (name, type, data) => {
diff --git a/packages/asset-uploader/src/clients/s3/upload.ts b/packages/asset-uploader/src/clients/s3/upload.ts
index 7e1f347d6a..6b6315f65f 100644
--- a/packages/asset-uploader/src/clients/s3/upload.ts
+++ b/packages/asset-uploader/src/clients/s3/upload.ts
@@ -2,6 +2,7 @@ import { arrayBuffer } from "node:stream/consumers";
import type { SignatureV4 } from "@smithy/signature-v4";
import { getAssetData } from "../../utils/get-asset-data";
import { createSizeLimiter } from "../../utils/size-limiter";
+import { extendedEncodeURIComponent } from "../../utils/sanitize-s3-key";
export const uploadToS3 = async ({
signer,
@@ -30,7 +31,10 @@ export const uploadToS3 = async ({
// Also check if S3 client has an option to check the size limit
const data = await arrayBuffer(limitSize(dataStream));
- const url = new URL(`/${bucket}/${name}`, endpoint);
+ const url = new URL(
+ `/${bucket}/${extendedEncodeURIComponent(name)}`,
+ endpoint
+ );
const s3Request = await signer.sign({
method: "PUT",
diff --git a/packages/asset-uploader/src/utils/sanitize-s3-key.test.ts b/packages/asset-uploader/src/utils/sanitize-s3-key.test.ts
index 7a46a27349..4b049b9c31 100644
--- a/packages/asset-uploader/src/utils/sanitize-s3-key.test.ts
+++ b/packages/asset-uploader/src/utils/sanitize-s3-key.test.ts
@@ -1,5 +1,5 @@
import { describe, test, expect } from "@jest/globals";
-import { sanitizeS3Key } from "./sanitize-s3-key";
+import { extendedEncodeURIComponent, sanitizeS3Key } from "./sanitize-s3-key";
describe("sanitizeS3Key", () => {
test("Should replace ASCII character ranges 00–1F hex (0–31 decimal) and 7F (127 decimal)", () => {
@@ -45,3 +45,27 @@ describe("sanitizeS3Key", () => {
expect(sanitizeS3Key(path)).toMatch(path);
});
});
+
+describe("extendedEncodeURIComponent", () => {
+ const encodedValues: [string, string][] = [
+ ["!", "%21"],
+ ["'", "%27"],
+ ["(", "%28"],
+ [")", "%29"],
+ ["*", "%2A"],
+ ];
+
+ const verify = (table: [string, string][]) => {
+ test.each(table)(`encodes %s as %s`, (input, output) => {
+ expect(extendedEncodeURIComponent(input)).toStrictEqual(output);
+ });
+ };
+
+ verify(encodedValues);
+ verify([
+ encodedValues.reduce(
+ (acc, [input, output]) => [acc[0].concat(input), acc[1].concat(output)],
+ ["", ""]
+ ),
+ ]);
+});
diff --git a/packages/asset-uploader/src/utils/sanitize-s3-key.ts b/packages/asset-uploader/src/utils/sanitize-s3-key.ts
index 68c330ae4f..65da9792a7 100644
--- a/packages/asset-uploader/src/utils/sanitize-s3-key.ts
+++ b/packages/asset-uploader/src/utils/sanitize-s3-key.ts
@@ -26,3 +26,17 @@ const REPLACE_CHAR = "_";
export const sanitizeS3Key = (str: string): string => {
return allRegexps.reduce((r, reg) => r.replace(reg, REPLACE_CHAR), str);
};
+
+/**
+ * https://github.com/awslabs/smithy-typescript/blob/3d36329c52b44c48c269b962c25f2dc63cd01da6/packages/smithy-client/src/extended-encode-uri-component.ts
+ *
+ * Function that wraps encodeURIComponent to encode additional characters
+ * to fully adhere to RFC 3986.
+ *
+ * https://datatracker.ietf.org/doc/html/rfc3986
+ */
+export const extendedEncodeURIComponent = (str: string): string => {
+ return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {
+ return "%" + c.charCodeAt(0).toString(16).toUpperCase();
+ });
+};
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index a481e34c42..99f8113479 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -387,8 +387,8 @@ importers:
specifier: ^5.0.0
version: 5.0.0
'@smithy/signature-v4':
- specifier: ^1.0.2
- version: 1.0.2
+ specifier: ^2.0.2
+ version: 2.0.2
'@webstudio-is/fonts':
specifier: workspace:^
version: link:../fonts
@@ -6149,77 +6149,77 @@ packages:
size-limit: 8.2.6
dev: true
- /@smithy/[email protected]:
- resolution: {integrity: sha512-eW/XPiLauR1VAgHKxhVvgvHzLROUgTtqat2lgljztbH8uIYWugv7Nz+SgCavB+hWRazv2iYgqrSy74GvxXq/rg==}
+ /@smithy/[email protected]:
+ resolution: {integrity: sha512-PQZiKx7fMnNwx4zxcUCm82VjnqK6wV4MEHSmMy3taj5dKfXV782IjRGyaDT+8TsmNqVdZIkve5zLRAzh+7kOhA==}
dependencies:
'@aws-crypto/crc32': 3.0.0
- '@smithy/types': 1.1.1
- '@smithy/util-hex-encoding': 1.0.2
+ '@smithy/types': 2.1.0
+ '@smithy/util-hex-encoding': 2.0.0
tslib: 2.6.0
dev: false
- /@smithy/[email protected]:
- resolution: {integrity: sha512-pkyBnsBRpe+c/6ASavqIMRBdRtZNJEVJOEzhpxZ9JoAXiZYbkfaSMRA/O1dUxGdJ653GHONunnZ4xMo/LJ7utQ==}
+ /@smithy/[email protected]:
+ resolution: {integrity: sha512-z3PjFjMyZNI98JFRJi/U0nGoLWMSJlDjAW4QUX2WNZLas5C0CmVV6LJ01JI0k90l7FvpmixjWxPFmENSClQ7ug==}
engines: {node: '>=14.0.0'}
dependencies:
tslib: 2.6.0
dev: false
- /@smithy/[email protected]:
- resolution: {integrity: sha512-rpKUhmCuPmpV5dloUkOb9w1oBnJatvKQEjIHGmkjRGZnC3437MTdzWej9TxkagcZ8NRRJavYnEUixzxM1amFig==}
+ /@smithy/[email protected]:
+ resolution: {integrity: sha512-YMooDEw/UmGxcXY4qWnSXkbPFsRloluSvyXVT678YPDN/K2AS1GzKfRsvSU7fbccOB4WF8MHZf2UqcRGEltE3Q==}
engines: {node: '>=14.0.0'}
dependencies:
- '@smithy/eventstream-codec': 1.0.2
- '@smithy/is-array-buffer': 1.0.2
- '@smithy/types': 1.1.1
- '@smithy/util-hex-encoding': 1.0.2
- '@smithy/util-middleware': 1.0.2
- '@smithy/util-uri-escape': 1.0.2
- '@smithy/util-utf8': 1.0.2
+ '@smithy/eventstream-codec': 2.0.2
+ '@smithy/is-array-buffer': 2.0.0
+ '@smithy/types': 2.1.0
+ '@smithy/util-hex-encoding': 2.0.0
+ '@smithy/util-middleware': 2.0.0
+ '@smithy/util-uri-escape': 2.0.0
+ '@smithy/util-utf8': 2.0.0
tslib: 2.6.0
dev: false
- /@smithy/[email protected]:
- resolution: {integrity: sha512-tMpkreknl2gRrniHeBtdgQwaOlo39df8RxSrwsHVNIGXULy5XP6KqgScUw2m12D15wnJCKWxVhCX+wbrBW/y7g==}
+ /@smithy/[email protected]:
+ resolution: {integrity: sha512-KLsCsqxX0j2l99iP8s0f7LBlcsp7a7ceXGn0LPYPyVOsqmIKvSaPQajq0YevlL4T9Bm+DtcyXfBTbtBcLX1I7A==}
engines: {node: '>=14.0.0'}
dependencies:
tslib: 2.6.0
dev: false
- /@smithy/[email protected]:
- resolution: {integrity: sha512-lHAYIyrBO9RANrPvccnPjU03MJnWZ66wWuC5GjWWQVfsmPwU6m00aakZkzHdUT6tGCkGacXSgArP5wgTgA+oCw==}
+ /@smithy/[email protected]:
+ resolution: {integrity: sha512-/YNnLoHsR+4W4Vf2wL5lGv0ksg8Bmk3GEGxn2vEQt52AQaPSCuaO5PM5VM7lP1K9qHRKHwrPGktqVoAHKWHxzw==}
engines: {node: '>=14.0.0'}
dependencies:
- '@smithy/is-array-buffer': 1.0.2
+ '@smithy/is-array-buffer': 2.0.0
tslib: 2.6.0
dev: false
- /@smithy/[email protected]:
- resolution: {integrity: sha512-Bxydb5rMJorMV6AuDDMOxro3BMDdIwtbQKHpwvQFASkmr52BnpDsWlxgpJi8Iq7nk1Bt4E40oE1Isy/7ubHGzg==}
+ /@smithy/[email protected]:
+ resolution: {integrity: sha512-c5xY+NUnFqG6d7HFh1IFfrm3mGl29lC+vF+geHv4ToiuJCBmIfzx6IeHLg+OgRdPFKDXIw6pvi+p3CsscaMcMA==}
engines: {node: '>=14.0.0'}
dependencies:
tslib: 2.6.0
dev: false
- /@smithy/[email protected]:
- resolution: {integrity: sha512-vtXK7GOR2BoseCX8NCGe9SaiZrm9M2lm/RVexFGyPuafTtry9Vyv7hq/vw8ifd/G/pSJ+msByfJVb1642oQHKw==}
+ /@smithy/[email protected]:
+ resolution: {integrity: sha512-eCWX4ECuDHn1wuyyDdGdUWnT4OGyIzV0LN1xRttBFMPI9Ff/4heSHVxneyiMtOB//zpXWCha1/SWHJOZstG7kA==}
engines: {node: '>=14.0.0'}
dependencies:
tslib: 2.6.0
dev: false
- /@smithy/[email protected]:
- resolution: {integrity: sha512-k8C0BFNS9HpBMHSgUDnWb1JlCQcFG+PPlVBq9keP4Nfwv6a9Q0yAfASWqUCtzjuMj1hXeLhn/5ADP6JxnID1Pg==}
+ /@smithy/[email protected]:
+ resolution: {integrity: sha512-ebkxsqinSdEooQduuk9CbKcI+wheijxEb3utGXkCoYQkJnwTnLbH1JXGimJtUkQwNQbsbuYwG2+aFVyZf5TLaw==}
engines: {node: '>=14.0.0'}
dependencies:
tslib: 2.6.0
dev: false
- /@smithy/[email protected]:
- resolution: {integrity: sha512-V4cyjKfJlARui0dMBfWJMQAmJzoW77i4N3EjkH/bwnE2Ngbl4tqD2Y0C/xzpzY/J1BdxeCKxAebVFk8aFCaSCw==}
+ /@smithy/[email protected]:
+ resolution: {integrity: sha512-rctU1VkziY84n5OXe3bPNpKR001ZCME2JCaBBFgtiM2hfKbHFudc/BkMuPab8hRbLd0j3vbnBTTZ1igBf0wgiQ==}
engines: {node: '>=14.0.0'}
dependencies:
- '@smithy/util-buffer-from': 1.0.2
+ '@smithy/util-buffer-from': 2.0.0
tslib: 2.6.0
dev: false