JWA implementation (supports all JWS algorithms). 

JWA implementation (supports all JWS algorithms)

brianloveswords

omsmith

stenington

var bufferEqual = require('buffer-equal-constant-time');

var Buffer = require('safe-buffer').Buffer;

var formatEcdsa = require('ecdsa-sig-formatter');

var MSG_INVALID_ALGORITHM = '"%s" is not a valid algorithm.\n  Supported algorithms are:\n  "HS256", "HS384", "HS512", "RS256", "RS384", "RS512", "PS256", "PS384", "PS512", "ES256", "ES384", "ES512" and "none".'

var MSG_INVALID_SECRET = 'secret must be a string or buffer';

var MSG_INVALID_VERIFIER_KEY = 'key must be a string or a buffer';

var MSG_INVALID_SIGNER_KEY = 'key must be a string, a buffer or an object';

var supportsKeyObjects = typeof crypto.createPublicKey === 'function';

  MSG_INVALID_VERIFIER_KEY += ' or a KeyObject';

  MSG_INVALID_SECRET += 'or a KeyObject';

    throw typeError(MSG_INVALID_VERIFIER_KEY);

  if (typeof key.asymmetricKeyType !== 'string') {

  if (typeof key.export !== 'function') {

  throw typeError(MSG_INVALID_SIGNER_KEY);

  var padding = 4 - base64url.length % 4;

  var match = algorithm.match(/^(RS|PS|ES|HS)(256|384|512)$|^(none)$/i);

  var match = algorithm.match(/^(RS|PS|ES|HS)(256|384|512)$|^(none)$/);

    throw typeError(MSG_INVALID_ALGORITHM, algorithm);

  var algo = (match[1] || match[3]).toLowerCase();

    verify: verifierFactories[algo](bits),

  "description": "JWA implementation (supports all JWS algorithms)",

    "buffer-equal-constant-time": "1.0.1",

    "url": "git://github.com/brianloveswords/node-jwa.git"

  "author": "Brian J. Brennan <brianloveswords@gmail.com>",

# node-jwa [![Build Status](https://travis-ci.org/brianloveswords/node-jwa.svg?branch=master)](https://travis-ci.org/brianloveswords/node-jwa)

[JSON Web Algorithms](http://tools.ietf.org/id/draft-ietf-jose-json-web-algorithms-08.html)

implementation focusing (exclusively, at this point) on the algorithms necessary for

[JSON Web Signatures](http://self-issued.info/docs/draft-ietf-jose-json-web-signature.html).

This library supports all of the required, recommended and optional cryptographic algorithms for JWS:

alg Parameter Value | Digital Signature or MAC Algorithm

----------------|----------------------------

HS256 | HMAC using SHA-256 hash algorithm

HS384 | HMAC using SHA-384 hash algorithm

HS512 | HMAC using SHA-512 hash algorithm

RS256 | RSASSA using SHA-256 hash algorithm

RS384 | RSASSA using SHA-384 hash algorithm

RS512 | RSASSA using SHA-512 hash algorithm

PS256 | RSASSA-PSS using SHA-256 hash algorithm

PS384 | RSASSA-PSS using SHA-384 hash algorithm

PS512 | RSASSA-PSS using SHA-512 hash algorithm

ES256 | ECDSA using P-256 curve and SHA-256 hash algorithm

ES384 | ECDSA using P-384 curve and SHA-384 hash algorithm

ES512 | ECDSA using P-521 curve and SHA-512 hash algorithm

none | No digital signature or MAC value included

Please note that PS* only works on Node 6.12+ (excluding 7.x).

In order to run the tests, a recent version of OpenSSL is

required. **The version that comes with OS X (OpenSSL 0.9.8r 8 Feb

2011) is not recent enough**, as it does not fully support ECDSA

keys. You'll need to use a version > 1.0.0; I tested with OpenSSL 1.0.1c 10 May 2012.

This will generate a bunch of keypairs to use in testing. If you want to

generate new keypairs, do `make clean` before running `npm test` again.

I spawn `openssl dgst -sign` to test OpenSSL sign → JS verify and

`openssl dgst -verify` to test JS sign → OpenSSL verify for each of the

Creates a new `jwa` object with `sign` and `verify` methods for the

algorithm. Valid values for algorithm can be found in the table above

(`'HS256'`, `'HS384'`, etc) and are case-insensitive. Passing an invalid

(`'HS256'`, `'HS384'`, etc) and are case-sensitive. Passing an invalid

algorithm value will throw a `TypeError`.

Sign some input with either a secret for HMAC algorithms, or a private

If input is not already a string or buffer, `JSON.stringify` will be

For the HMAC algorithm, `secretOrPrivateKey` should be a string or a

buffer. For ECDSA and RSA, the value should be a string representing a

Output [base64url](http://en.wikipedia.org/wiki/Base64#URL_applications)

formatted. This is for convenience as JWS expects the signature in this

format. If your application needs the output in a different format,

[please open an issue](https://github.com/brianloveswords/node-jwa/issues). In

[brianloveswords/base64url](https://github.com/brianloveswords/base64url)

As of nodejs *v0.11.8*, SPKAC support was introduce. If your nodeJs

version satisfies, then you can pass an object `{ key: '..', passphrase: '...' }`

## jwa#verify(input, signature, secretOrPublicKey)

Verify a signature. Returns `true` or `false`.

`signature` should be a base64url encoded string.

For the HMAC algorithm, `secretOrPublicKey` should be a string or a

buffer. For ECDSA and RSA, the value should be a string represented a

const signature = hmac.sign(input, secret);

hmac.verify(input, signature, secret) // === true

hmac.verify(input, signature, 'trickery!') // === false

const privateKey = fs.readFileSync(__dirname + '/ecdsa-p521-private.pem');

const publicKey = fs.readFileSync(__dirname + '/ecdsa-p521-public.pem');

const signature = ecdsa.sign(input, privateKey);

ecdsa.verify(input, signature, publicKey) // === true

Permission is hereby granted, free of charge, to any person obtaining a

copy of this software and associated documentation files (the

"Software"), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

The above copyright notice and this permission notice shall be included

in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE

LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION

OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

		@@ -242,3 +242,3 @@ var bufferEqual = require('buffer-equal-constant-time');
		}
		var match = algorithm.match(/^(RS\|PS\|ES\|HS)(256\|384\|512)$\|^(none)$/i);
		var match = algorithm.match(/^(RS\|PS\|ES\|HS)(256\|384\|512)$\|^(none)$/);
		if (!match)
		@@ -245,0 +245,0 @@ throw typeError(MSG_INVALID_ALGORITHM, algorithm);

		{
		"name": "jwa",
		"version": "1.4.1",
		"version": "2.0.0",
		"description": "JWA implementation (supports all JWS algorithms)",
		@@ -5,0 +5,0 @@ "main": "index.js",

		@@ -58,3 +58,3 @@ # node-jwa [![Build Status](https://travis-ci.org/brianloveswords/node-jwa.svg?branch=master)](https://travis-ci.org/brianloveswords/node-jwa)
		algorithm. Valid values for algorithm can be found in the table above
		(`'HS256'`, `'HS384'`, etc) and are case-insensitive. Passing an invalid
		(`'HS256'`, `'HS384'`, etc) and are case-sensitive. Passing an invalid
		algorithm value will throw a `TypeError`.
		@@ -61,0 +61,0 @@

Worsened metrics