easy-jose

easy-jose
=========


> Javascript Object Signing and Encryption standard

Straightforward encryption/decryption utility based on [node-jose] by Cisco

Getting Started
------------

Install via NPM

``bash
$ npm install --save easy-jose

`

Basic Usage
------------

Require the library, then initialize.

`js
const easyJose = require('easy-jose');
easyJose.init();

`

$3

Example:
`js
const keys = easyJose.generateKeys("EC", 4096);

`

$3

Required Arguments:
- public_key
- payload: data to encrypt

Optional Argument
- isKeyEncoded: boolean, tell easyJose if you're using a base64 encoded public_key

Example:
`js
const encrypted = easyJose.encryptContent(public_key, payload);

`

$3

Required Arguments:
- private_key
- payload: data to decrypt

Optional Argument
- isPayloadEncoded: boolean, tell easyJose if you're using a base64 encoded payload

Example:
`js
const decrypted = easyJose.decryptContent(private_key, encrypted);

`

$3

`js
const easyJose = require('easy-jose');
const somedata = {
txt: 'hello'
};

(async () => {
easyJose.init();
const { private_key, public_key } = await easyJose.generateKeys();
console.log(private_key);
console.log(public_key);

const encrypted = await easyJose.encryptContent(public_key, somedata);
console.log(encrypted);

const decrypted = await easyJose.decryptContent(private_key, encrypted);
console.log(decrypted);
})();
`

Utilities
------------

$3

`js
const encoded = easyJose.encode(raw);

`

$3

`js
const decoded = easyJose.decode(base64EncodedString);

`

$3

`js
const u8a = easyJose.convertToU8A(data);

`

$3

`js
const data = easyJose.convertU8A(arrayBufferData);

``

Thanks
------

easy-jose* © 2018, Fernan de Dios. Released under the [MIT License].

> fernandedios.com  · 
> GitHub @fernandedios  · 
> Twitter @fernan_de_dios

[MIT License]: http://mit-license.org/
[node-jose]: https://github.com/cisco/node-jose