@aws-sdk/middleware-signing

What is @aws-sdk/middleware-signing?

The @aws-sdk/middleware-signing package is part of the AWS SDK for JavaScript (v3). It provides middleware for signing requests made to AWS services. This is crucial for authenticating requests by automatically including secure signatures in API calls. The package ensures that AWS service requests are transmitted securely and are authenticated using the appropriate AWS credentials.

What are @aws-sdk/middleware-signing's main functionalities?

Request Signing

This code demonstrates how to add the AWS authentication middleware to an S3 client instance in the AWS SDK. It ensures that the PutObjectCommand is signed correctly before being sent to AWS.

import { S3Client, PutObjectCommand } from '@aws-sdk/client-s3';
import { awsAuthMiddleware } from '@aws-sdk/middleware-signing';

const client = new S3Client({});
client.middlewareStack.add(awsAuthMiddleware(), {
  step: 'finalizeRequest',
  name: 'awsAuthMiddleware',
  tags: { SET_CONTEXT: true },
  override: true
});

const command = new PutObjectCommand({ Bucket: 'example-bucket', Key: 'example-object', Body: 'Hello, world!' });
client.send(command);

Other packages similar to @aws-sdk/middleware-signing

aws4

The aws4 package is a lightweight utility that signs requests using AWS Signature Version 4. It can be used independently of the AWS SDK. Unlike @aws-sdk/middleware-signing, which is integrated within the AWS SDK v3, aws4 can be used with any HTTP request tool, providing more flexibility but requiring manual integration.

amazon-cognito-identity-js

This package includes functionality for signing in users and handling tokens with Amazon Cognito. While it is focused on authentication like @aws-sdk/middleware-signing, its scope is specifically tied to Amazon Cognito and does not provide general request signing capabilities for other AWS services.

README

@aws-sdk/signer-middleware

Changelog

1.0.0-rc.7 (2020-11-20)

Bug Fixes

• abort-controller: make AbortSignal WHATWG Spec compliant (#1699) (723ec4d)
• codegen: add aws-iam-traits dependency (#1686) (d6fb1f6)
• fetch-http-handler: omit body for HEAD/GET methods (#1698) (778b305)
• node-http-handler: throw TimeoutError for Node.js timeouts (#1693) (96f61bb)
• change paginators to export paginateOperationName (#1692) (6d02935)

Features

• update clients as of 11/18/2020 (#1700) (8adfed1)
• api-reference: add typedoc plugins for api reference (#1694) (2cb016f)
• ci: add GitHub Action to test codegen (#1684) (41e9359)
• node-http-handler: update timeout code and tests (#1691) (9e58bbb)
• service-error-classification: add 429 response as Throttling (#1690) (9a62c0a)

BREAKING CHANGES

• change paginators to export paginateOperationName to be consistent with verb nouns across AWS