@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.130.0 (2022-07-14)

Bug Fixes

• codegen: fix error code parsing when it's a number (#3371) (c2d8522)
• signature-v4: allow empty string as canonical header value (#3797) (0dd60ed)

Features

• client-athena: This release updates data types that contain either QueryExecutionId, NamedQueryId or ExpectedBucketOwner. Ids must be between 1 and 128 characters and contain only non-whitespace characters. ExpectedBucketOwner must be 12-digit string. (a22c328)
• client-codeartifact: This release introduces Package Origin Controls, a mechanism used to counteract Dependency Confusion attacks. Adds two new APIs, PutPackageOriginConfiguration and DescribePackage, and updates the ListPackage, DescribePackageVersion and ListPackageVersion APIs in support of the feature. (ac9d765)
• client-config-service: Update ResourceType enum with values for Route53Resolver, Batch, DMS, Workspaces, Stepfunctions, SageMaker, ElasticLoadBalancingV2, MSK types (58d673a)
• client-ec2: This release adds flow logs for Transit Gateway to allow customers to gain deeper visibility and insights into network traffic through their Transit Gateways. (57b3f71)
• client-fms: Adds support for strict ordering in stateful rule groups in Network Firewall policies. (b6f9a9f)
• client-glue: This release adds an additional worker type for Glue Streaming jobs. (f47fa13)
• client-inspector2: This release adds support for Inspector V2 scan configurations through the get and update configuration APIs. Currently this allows configuring ECR automated re-scan duration to lifetime or 180 days or 30 days. (36bccb8)
• client-kendra: This release adds AccessControlConfigurations which allow you to redefine your document level access control without the need for content re-indexing. (b1c43cf)
• client-nimble: Amazon Nimble Studio adds support for IAM-based access to AWS resources for Nimble Studio components and custom studio components. Studio Component scripts use these roles on Nimble Studio workstation to mount filesystems, access S3 buckets, or other configured resources in the Studio's AWS account (bae6c59)
• client-outposts: This release adds the ShipmentInformation and AssetInformationList fields to the GetOrder API response. (cf80140)
• client-sagemaker: This release adds support for G5, P4d, and C6i instance types in Amazon SageMaker Inference and increases the number of hyperparameters that can be searched from 20 to 30 in Amazon SageMaker Automatic Model Tuning (4d43eac)
• clients: update client endpoints as of 2022-07-14 (93c74f4)