Address existing issues involving paths in S3 and Signature usages (#104

) * Activate signature's URIencoding as a default for S3Client * Ensure the Endpoint type is also exposed by the aws.js bundle * Add leading slash to request path when signing and presiging * Update build files * Apply pull request review suggestions * Update build files
grafana · May 14, 2024 · 5073f0a · 5073f0a
1 parent bdc2d53
commit 5073f0a
Show file tree

Hide file tree

Showing 25 changed files with 39 additions and 23 deletions.
diff --git a/dist/aws.js b/dist/aws.js
diff --git a/dist/aws.js.map b/dist/aws.js.map
diff --git a/dist/event-bridge.js b/dist/event-bridge.js
diff --git a/dist/event-bridge.js.map b/dist/event-bridge.js.map
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/kinesis.js b/dist/kinesis.js
diff --git a/dist/kinesis.js.map b/dist/kinesis.js.map
diff --git a/dist/kms.js b/dist/kms.js
diff --git a/dist/kms.js.map b/dist/kms.js.map
diff --git a/dist/lambda.js b/dist/lambda.js
diff --git a/dist/lambda.js.map b/dist/lambda.js.map
diff --git a/dist/s3.js b/dist/s3.js
diff --git a/dist/s3.js.map b/dist/s3.js.map
diff --git a/dist/secrets-manager.js b/dist/secrets-manager.js
diff --git a/dist/secrets-manager.js.map b/dist/secrets-manager.js.map
diff --git a/dist/signature.js b/dist/signature.js
diff --git a/dist/signature.js.map b/dist/signature.js.map
diff --git a/dist/sqs.js b/dist/sqs.js
diff --git a/dist/sqs.js.map b/dist/sqs.js.map
diff --git a/dist/ssm.js b/dist/ssm.js
diff --git a/dist/ssm.js.map b/dist/ssm.js.map
diff --git a/src/index.ts b/src/index.ts
@@ -3,6 +3,7 @@ export { InvalidSignatureError } from './internal/signature'
 export { AWSConfig, InvalidAWSConfigError } from './internal/config'
 export { AMZ_CONTENT_SHA256_HEADER, UNSIGNED_PAYLOAD } from './internal/constants'
 export { KMSClient, KMSDataKey, KMSServiceError } from './internal/kms'
+export { Endpoint } from './internal/endpoint'
 export { SignatureV4 } from './internal/signature'
 export { S3Bucket, S3Client, S3Object, S3ServiceError } from './internal/s3'
 export {

diff --git a/src/internal/s3.ts b/src/internal/s3.ts
@@ -28,7 +28,12 @@ export class S3Client extends AWSClient {
                 secretAccessKey: this.awsConfig.secretAccessKey,
                 sessionToken: this.awsConfig.sessionToken,
             },
-            uriEscapePath: false,
+
+            // S3 requires the URI path to be escaped
+            uriEscapePath: true,
+
+            // Signing S3 requests requires the payload to be hashed
+            // and the checksum to be included in the request headers.
             applyChecksum: true,
         })
     }

diff --git a/src/internal/signature.ts b/src/internal/signature.ts
@@ -163,6 +163,11 @@ export class SignatureV4 {
         // If a request path was provided, add it to the URL
         let url = request.endpoint.href
         if (request.path) {
+            // Ensure there is a trailing slash at the end of the URL
+            // so that appending the path does not result in a malformed URL.
+            url = url.endsWith('/') ? url : url + '/'
+
+            // Append the path to the URL
             url += request.path
         }
 
@@ -266,6 +271,11 @@ export class SignatureV4 {
         // If a request path was provided, add it to the URL
         let url = request.endpoint.href
         if (request.path) {
+            // Ensure there is a trailing slash at the end of the URL
+            // so that appending the path does not result in a malformed URL.
+            url = url.endsWith('/') ? url : url + '/'
+
+            // Append the path to the URL
             url += request.path
         }