@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.616.0 (2024-07-18)

Bug Fixes

• lib-storage: location in upload result should include custom port (#6282) (9d3cbb6)
• middleware-sdk-s3: set consistent dependency versions (#6287) (207cd84)

Features

• client-acm-pca: Fix broken waiters for the acm-pca client. Waiters broke in version 1.13.144 of the Boto3 SDK. (a867f6e)
• client-connect: Amazon Connect expands search API coverage for additional resources. Search for hierarchy groups by name, ID, tag, or other criteria (new endpoint). Search for agent statuses by name, ID, tag, or other criteria (new endpoint). Search for users by their assigned proficiencies (enhanced endpoint) (226e9c6)
• client-ec2: Amazon VPC IP Address Manager (IPAM) now supports Bring-Your-Own-IP (BYOIP) for IP addresses registered with any Internet Registry. This feature uses DNS TXT records to validate ownership of a public IP address range. (337c43d)
• client-firehose: This release 1) Add configurable buffering hints for Snowflake as destination. 2) Add ReadFromTimestamp for MSK As Source. Firehose will start reading data from MSK Cluster using offset associated with this timestamp. 3) Gated public beta release to add Apache Iceberg tables as destination. (9a36c7e)
• client-medialive: AWS Elemental MediaLive now supports the SRT protocol via the new SRT Caller input type. (91134df)
• client-sagemaker: SageMaker Training supports R5, T3 and R5D instances family. And SageMaker Processing supports G5 and R5D instances family. (709db60)
• client-taxsettings: Set default endpoint for aws partition. Requests from all regions in aws partition will be forward to us-east-1 endpoint. (7927892)
• clients: update client endpoints as of 2024-07-18 (ac3e31b)