whiliang / http-hmac-javascript

An implementation of the HTTP HMAC Spec in JavaScript. -- [Created 2016-01-12 by ynx aka [e-mail] via github.acquia.com]

HTTP HMAC Signer for JavaScript

HMAC Request Signer is a JavaScript library that implements the version 2.0 of the HTTP HMAC Spec to sign RESTful Web API requests and verify responses.

Please note the 1.0 Spec is not supported.

Development Prerequisites

Before further development, please ensure the following tools are installed on your computer.

• Git
• Node.js (with NPM)

You can use the following commands to check if you already have those tools:

git --version
node -v
npm -v

Files

• demo/ - Visit get.html and post.html to see the demo in action.
• lib/ - Library files.
  • es5/ - Transpiled ES5 version, polyfilled to IE 5.5.
  • es6/ - ES6 version.
• src/ - Source files. Code changes should be made here.
  • demo/ - Demo files to show how the library can be used.
  • hmac.js - The source file of the library.

Build

• Run npm install to install all dependencies.
• Make code changes in src/ directory.
• In root directory, run gulp build-demo. Alternatively, you can run gulp to keep gulp on watch to automatically compile/transpile all file changes.

Tests

• Run npm install to install all dependencies.
• In root directory, run gulp test to see the current test results. Alternatively, you can go to the qunit/hmac.html page in your browser.

Submitting PR

• PR welcomed!
• Please run gulp build-demo and submit along all resulting file updates.