package
Signs and prepares requests using AWS Signature Version 4
npm install aws4GitHub-flavored package documentation.
Across all versions, last 30 days.
129,562,669 in 30 days
Runtime metadata.
Estimated unpacked size across 1 packages.
22.9 kB
Includes dependencies.
A small utility to sign vanilla Node.js http(s) request options using Amazon's AWS Signature Version 4.
If you want to sign and send AWS requests using fetch(), then check out aws4fetch – otherwise you can also bundle this library for use in older browsers.
The only AWS service I know of that doesn't support v4 is SimpleDB (it only supports AWS Signature Version 2).
It also provides defaults for a number of core AWS headers and request parameters, making it very easy to query AWS services, or build out a fully-featured AWS library.
var https = require('https')
var aws4 = require('aws4')
// to illustrate usage, we'll create a utility function to request and pipe to stdout
function request(opts) { https.request(opts, function(res) { res.pipe(process.stdout) }).end(opts.body || '') }
// aws4 will sign an options object as you'd pass to http.request, with an AWS service and region
var opts = { host: 'my-bucket.s3.us-west-1.amazonaws.com', path: '/my-object', service: 's3', region: 'us-west-1' }
// aws4.sign() will sign and modify these options, ready to pass to http.request
aws4.sign(opts, { accessKeyId: '', secretAccessKey: '' })
// or it can get credentials from process.env.AWS_ACCESS_KEY_ID, etc
Calculates and populates any necessary AWS headers and/or request
options on requestOptions. Returns requestOptions as a convenience for chaining.
requestOptions is an object holding the same options that the Node.js
http.request
function takes.
The following properties of requestOptions are used in the signing or
populated if they don't already exist:
hostname or host (will try to be determined from service and region if not given)method (will use 'GET' if not given or 'POST' if there is a body)path (will use '/' if not given)body (will use '' if not given)service (will try to be calculated from hostname or host if not given)region (will try to be calculated from hostname or host or use 'us-east-1' if not given)signQuery (to sign the query instead of adding an Authorization header, defaults to false)extraHeadersToIgnore (an object with lowercase header keys to ignore when signing, eg { 'content-length': true })extraHeadersToInclude (an object with lowercase header keys to include when signing, overriding any ignores)headers['Host'] (will use hostname or host or be calculated if not given)headers['Content-Type'] (will use 'application/x-www-form-urlencoded; charset=utf-8'
if not given and there is a body)headers['Date'] (used to calculate the signature date if given, otherwise new Date is used)Your AWS credentials (which can be found in your AWS console) can be specified in one of two ways:
aws4.sign(requestOptions, {
secretAccessKey: "<your-secret-access-key>",
accessKeyId: "<your-access-key-id>",
sessionToken: "<your-session-token>"
})process.env, such as this:export AWS_ACCESS_KEY_ID="<your-access-key-id>"
export AWS_SECRET_ACCESS_KEY="<your-secret-access-key>"
export AWS_SESSION_TOKEN="<your-session-token>"(will also use AWS_ACCESS_KEY and AWS_SECRET_KEY if available)
The sessionToken property and AWS_SESSION_TOKEN environment variable are optional for signing
with IAM STS temporary credentials.
With npm do:
npm install aws4Can also be used in the browser.
Thanks to @jed for his dynamo-client lib where I first committed and subsequently extracted this code.
Also thanks to the official Node.js AWS SDK for giving me a start on implementing the v4 signature.