aws4-sign
AWS Signature Version 4 for node.js and browser.
Notice: this project is rewrote from aws4 by ES6 for using on demand.
Installation
npm install aws4-sign --save# or yarn add aws4-sign
Example
Use in browser
Use in Node.js
const http = ;const sign RequestSigner = ; const opts = host: 'sqs.us-east-1.amazonaws.com' path: '/?Action=ListQueues';// assumes AWS credentials are available in process.env;console;/*{ host: 'sqs.us-east-1.amazonaws.com', path: '/?Action=ListQueues', headers: { Host: 'sqs.us-east-1.amazonaws.com', 'X-Amz-Date': '20121226T061030Z', Authorization: 'AWS4-HMAC-SHA256 Credential=ABCDEF/20121226/us-east-1/sqs/aws4_request, ...' }}*/ // we can now use this to query AWS using the standard node.js http APIhttp; // Generate CodeCommit Git access passwordconst signer = service: 'codecommit' host: 'git-codecommit.us-east-1.amazonaws.com' method: 'GIT' path: '/v1/repos/MyAwesomeRepo';const password = signer + 'Z' + signer;
API
aws4.sign(requestOptions, [credentials])
This calculates and populates the Authorization
header of requestOptions
,
and any other necessary AWS headers and/or request options. 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:
name | default |
---|---|
hostname/host | will be determined from service and region |
method | GET |
path | / |
body | '' |
service | will be calculated from hostname or host |
region | 'us-east-1' |
domain | 'amazonaws.com' |
headers['Host'] |
will use hostname or host or be calculated if not given |
headers['Content-Type'] |
'application/x-www-form-urlencoded; charset=utf-8' |
headers['Date'] |
new Date() |
Your AWS credentials (which can be found in your AWS console) can be specified in one of two ways:
credentials
You can config credentials
, like below:
aws4;
Or you can attach them to process.env
using
dotenv, create .env
file in your project
root, then put below code before you use aws4 sign
;
The sessionToken
property and AWS_SESSION_TOKEN
environment constiable are
optional for signing with
IAM STS temporary credentials.