@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

3.461.0 (2023-11-28)

Bug Fixes

• lib-storage: use correct return type for done() (#5512) (7e1e15e)

Features

• client-accessanalyzer: This release adds support for external access findings for S3 directory buckets to help you easily identify cross-account access. Updated service API, documentation, and paginators. (4feb52a)
• client-bedrock-agent-runtime: This release introduces Agents for Amazon Bedrock Runtime (428953b)
• client-bedrock-agent: This release introduces Agents for Amazon Bedrock (871dd41)
• client-bedrock-runtime: This release adds support for minor versions/aliases for invoke model identifier. (1beda07)
• client-bedrock: This release adds support for customization types, model life cycle status and minor versions/aliases for model identifiers. (7ba6ae9)
• client-connect: Added support for following capabilities: Amazon Connect's in-app, web, and video calling. Two-way SMS integrations. Contact Lens real-time chat analytics feature. Amazon Connect Analytics Datalake capability. Capability to configure real time chat rules. (2c3e7ad)
• client-customer-profiles: This release introduces DetectProfileObjectType API to auto generate object type mapping. (48d2ad9)
• client-qbusiness: Amazon Q - a generative AI powered application that your employees can use to ask questions and get answers from knowledge spread across disparate content repositories, summarize reports, write articles, take actions, and much more - all within their company's connected content repositories. (353cdd5)
• client-qconnect: Amazon Q in Connect, an LLM-enhanced evolution of Amazon Connect Wisdom. This release adds generative AI support to Amazon Q Connect QueryAssistant and GetRecommendations APIs. (75831cb)
• client-s3-control: Adds support for S3 Express One Zone, and InvocationSchemaVersion 2.0 for S3 Batch Operations. (27037e8)
• client-s3: Adds support for S3 Express One Zone. (1dcc776)
• clients: update client endpoints as of 2023-11-28 (1fb3ae3)