npmpackage.info

Gathering detailed insights and metrics for @aws-sdk/s3-request-presigner

Gathering detailed insights and metrics for @aws-sdk/s3-request-presigner

@aws-sdk/s3-request-presigner - 3.842.0 | npmpackage.info

@aws-sdk/s3-request-presigner

Modularized AWS SDK for JavaScript.

3.842.0

3,349

Apache-2.0

TypeScript

21.93 kB

283,033,216 4.6

Installations

npm install @aws-sdk/s3-request-presigner

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=18.0.0

Node Version

18.20.6

NPM Version

10.9.2

Score

95.7

Supply Chain

100

Quality

96.6

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

28

Total

3,913

Closed

762

Merged

3,123

Issues

Open

180

Total

2,858

Closed

2,678

Releases

1,032

v3.843.0

Updated on Jul 03, 2025

v3.842.0

Updated on Jul 02, 2025

v3.841.0

Updated on Jul 01, 2025

v3.840.0

Updated on Jun 30, 2025

v3.839.0

Updated on Jun 27, 2025

v3.838.0

Updated on Jun 26, 2025

View All 1,032 releases

Languages

11

TypeScript

Java

JavaScript

Gherkin

Starlark

Objective-C

Ruby

Shell

Handlebars

Smithy

Makefile

TypeScript (99.65%)

Java (0.23%)

JavaScript (0.1%)

Gherkin (0.01%)

Developer

aws

Download Statistics

Total Downloads

283,033,216

Last Day

148,497

Last Week

3,145,689

Last Month

13,537,597

Last Year

132,479,923

GitHub Statistics

Apache-2.0 License

3,349 Stars

9,551 Commits

619 Forks

42 Watchers

12 Branches

167 Contributors

Updated on Jul 04, 2025

Bundle Size

71.36 kB

Minified

21.93 kB

Minified + Gzipped

Bundlephobia

Maintainers

2

View All 167 Contributors

Package Meta Information

Latest Version

3.842.0

Package Id

@aws-sdk/s3-request-presigner@3.842.0

Unpacked Size

33.74 kB

Size

9.52 kB

File Count

16

NPM Version

10.9.2

Node Version

18.20.6

Published on

Jul 02, 2025

Total Downloads

Cumulative downloads

Total Downloads

283,033,216

Last Day

5.5%

148,497

Compared to previous day

Last Week

-6.8%

3,145,689

Compared to previous week

Last Month

1.1%

13,537,597

Compared to previous month

Last Year

61.5%

132,479,923

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

8

@aws-sdk/signature-v4-multi-region @aws-sdk/types @aws-sdk/util-format-url @smithy/middleware-endpoint @smithy/protocol-http @smithy/smithy-client @smithy/types tslib

Dev Dependencies

8

@aws-sdk/client-s3 @smithy/hash-node @tsconfig/recommended @types/node concurrently downlevel-dts rimraf typescript

@aws-sdk/s3-request-presigner

This package provides a presigner based on signature V4 that will attempt to generate signed url for S3.

Get Presigned URL with Client and Command

You can generated presigned url from S3 client and command. Here's the example:

1import { getSignedUrl } from "@aws-sdk/s3-request-presigner";
2import { S3Client, GetObjectCommand } from "@aws-sdk/client-s3";
3const client = new S3Client(clientParams);
4const command = new GetObjectCommand(getObjectParams);
5const url = await getSignedUrl(client, command, { expiresIn: 3600 });

You can get signed URL for other S3 operations too, like PutObjectCommand. expiresIn config from the examples above is optional. If not set, it's default at 900.

If you already have a request, you can pre-sign the request following the section bellow.

Get Presigned URL from an Existing Request

1import { S3RequestPresigner } from "@aws-sdk/s3-request-presigner";
2import { Sha256 } from "@aws-crypto/sha256-browser";
3import { Hash } from "@aws-sdk/hash-node";
4const signer = new S3RequestPresigner({
5  region: regionProvider,
6  credentials: credentialsProvider,
7  sha256: Hash.bind(null, "sha256"), // In Node.js
8  //sha256: Sha256 // In browsers
9});
10const presigned = await signer.presign(request);

To avoid redundant construction parameters when instantiating the s3 presigner, you can simply spread the configuration of an existing s3 client and supply it to the presigner's constructor.

1//s3 is instantiated from S3Client from @aws-sdk/client-s3-* packages
2const signer = new S3RequestPresigner({
3  ...s3.config,
4});

Get Presigned URL with headers that cannot be signed

By using the getSignedUrl with a S3Client you are able to sign your headers, improving the security of presigned url. Importantly, if you want to sign any x-amz-* headers (like the ChecksumSHA256 header in this example), you need to provide those headers to the set of unhoistableHeaders in the getSignedUrl params which will force those headers to be present in the upload request.

1import { PutObjectCommand, S3Client } from "@aws-sdk/client-s3";
2import { getSignedUrl } from "@aws-sdk/s3-request-presigner";
3
4const s3Client = new S3Client({ region: "us-east-1" });
5const command = new PutObjectCommand({
6  Bucket: bucket,
7  Key: key,
8  ChecksumSHA256: sha,
9});
10
11const presigned = getSignedUrl(s3Client, command, {
12  expiresIn: expiration,
13  // Set of all x-amz-* headers you wish to have signed
14  unhoistableHeaders: new Set(["x-amz-checksum-sha256"]),
15});

Get Presigned URL with headers that should be signed

For headers that are not x-amz-* you are able to add them to the set of signableHeaders to be enforced in the presigned urls request.

1import { PutObjectCommand, S3Client } from "@aws-sdk/client-s3";
2import { getSignedUrl } from "@aws-sdk/s3-request-presigner";
3
4const s3Client = new S3Client({ region: "us-east-1" });
5const command = new PutObjectCommand({
6  Bucket: bucket,
7  Key: key,
8  ContentType: contentType,
9});
10
11const presigned = getSignedUrl(s3Client, command, {
12  signableHeaders: new Set(["content-type"]),
13  expiresIn: expiration,
14});

PutObject with use of `hoistableHeaders`

hoistableHeaders overrides the default behavior of not hoisting any headers that begin with x-amz-*.

1// example: Server Side Encryption headers
2import { getSignedUrl } from "@aws-sdk/s3-request-presigner";
3import { S3Client, PutObjectCommand } from "@aws-sdk/client-s3";
4
5const params = {
6  Key: "...",
7  Bucket: "...",
8  ServerSideEncryption: "aws:kms",
9  SSEKMSKeyId: "arn:aws:kms:us-west-2:0000:key/abcd-1234-abcd",
10};
11const s3Client = new S3Client();
12const command = new PutObjectCommand(params);
13
14const preSignedUrl = await getSignedUrl(s3Client, command, {
15  hoistableHeaders: new Set(["x-amz-server-side-encryption", "x-amz-server-side-encryption-aws-kms-key-id"]),
16});

Empty State

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

License

Determines if the project has defined a license.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Security-Policy

Determines if the project has published a security policy.

10

SAST

Determines if the project uses static code analysis.

8

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/closed-issue-message.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/closed-issue-message.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codegen-ci.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/codegen-ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codegen-ci.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/codegen-ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/commit-message-lint.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/commit-message-lint.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/commit-message-lint.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/commit-message-lint.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/git-sync.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/git-sync.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/handle-stale-discussions.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/handle-stale-discussions.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/issue-regression-labeler.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/issue-regression-labeler.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/lock.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/lock.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-commit-hooks.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/pre-commit-hooks.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-commit-hooks.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/pre-commit-hooks.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/stale_issues.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/stale_issues.yml/main?enable=pin
Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 6 third-party GitHubAction dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.6

/10

Last Scanned on 2025-06-30

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.