# jwa

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

A [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).

## Requirements

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.

## Testing

To run the tests, do

```bash
$ npm test
```

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.

### Methodology

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 RSA and ECDSA algorithms.

## Usage

### jwa(algorithm)

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 algorithm value will throw a `TypeError`.

### jwa#sign(input, secretOrPrivateKey)

Sign some input with either a secret for HMAC algorithms, or a private key for RSA and ECDSA algorithms.

If input is not already a string or buffer, `JSON.stringify` will be called on it to attempt to coerce it.

For the HMAC algorithm, `secretOrPrivateKey` should be a string or a buffer. For ECDSA and RSA, the value should be a string representing a PEM encoded **private** key.

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 the meantime, you can use [brianloveswords/base64url](https://github.com/brianloveswords/base64url) to decode the signature.

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 PEM encoded **public** key.

## Example

HMAC

```js
const jwa = require('jwa');

const hmac = jwa('HS256');
const input = 'super important stuff';
const secret = 'shhhhhh';

const signature = hmac.sign(input, secret);
hmac.verify(input, signature, secret) // === true
hmac.verify(input, signature, 'trickery!') // === false
```

With keys

```js
const fs = require('fs');
const jwa = require('jwa');
const privateKey = fs.readFileSync(__dirname + '/ecdsa-p521-private.pem');
const publicKey = fs.readFileSync(__dirname + '/ecdsa-p521-public.pem');

const ecdsa = jwa('ES512');
const input = 'very important stuff';

const signature = ecdsa.sign(input, privateKey);
ecdsa.verify(input, signature, publicKey) // === true
```

### License

MIT

```
Copyright (c) 2013 Brian J. Brennan

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 following conditions:

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.
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mediamagic.dev/product-docs/services/graphql-gateway/node_modules/jwa.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.