Skip to content
forked from tivac/aws-sig

๐Ÿ” AWS sigv4, optimized for size

License

Notifications You must be signed in to change notification settings

kiquetal/aws-sig

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

72 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ” aws-sig NPM Version NPM License NPM Downloads Build Status

Teeny-tiny library for signing requests to Amazon Web Services using the signature v4 signing algorithm.

No serious, it's really small!

Bundle Size Gzipped Bundle Size

๐Ÿ™‹ Why?

I wanted something small. Really, really small. Couldn't find a small AWS v4 signing library that worked in a browser using rollup for bundling so... here we are. ยฏ\_(ใƒ„)_/ยฏ

โš™๏ธ How?

import sign from "aws-sig";

const config = {
    accessKeyId     : "AKIDEXAMPLE",
    secretAccessKey : "wJalrXUtnFEMI/K7MDENG+bPxRfiCYEXAMPLEKEY",

    // sessionTokens are optional, but correctly supported
    sessionToken    : "..."
};

const request = {
    // These can be part of the config object or the request object
    region  : "us-east-1",
    service : "service",
    
    method : "GET",
    url    : "https://my.aws.url.that.i.need.to.hit/look/it-has/a-path-in-it-as-well",
    
    // Headers are optional
    headers : {
        // Single header value
        "X-Amz-Date" : "20150830T123600Z",
        
        // Multiple headers
        "X-Multiple" : [ "one", "two", "three" ]
    }
    // Body is optional, should be a string
    body : "..."
};

const signed = sign(request, config);

๐Ÿ› What?

Supports query params, date overrides via X-Amz-Date or Date headers, multiple header values, and probably some other features.

Tested against API Gateway so far. Your results may vary for other services, S3 seems especially fraught with peril. ๐Ÿ’€

About

๐Ÿ” AWS sigv4, optimized for size

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%