npm

Join us for the "JavaScript Supply Chain Security" tech talk, presented by VP of Security, Adam Baldwin. 6/20 at 10am PT.Sign up here »

@trust/jose

0.4.0 • Public • Published

JOSE (@trust/jose)

standard-readme compliant

JSON Object Signing and Encryption for Node.js and Browsers

The JOSE suite of specifications standardizes various mechanisms required for integrity protection and encryption of data structured and serialized as JSON. This package implements JWT, JWD, JWS, JWE (in progress), JWA, JWK, and JWK Set for use in JavaScript applications.

Underlying cryptography is provided by W3C Web Cryptography API, available natively in browsers and via npm in Node.js. Additionally, JSON Schema is used for object initialization and validation with JWT and JWD.

Table of Contents

Security

TBD

Install

$ npm install @trust/jose --save

Usage

Node.js

const { JWT, JWD, JWA, JWKSet } = require('@trust/jose')

Browser

If you npm install jose as a dependency, the Webpack'd minified bundle will be available in the dist/ directory as jose.min.js.

If you're actively developing/testing this lib, you can npm run dist, and the bundle will be rebuilt.

To use in the browser, simply import the bundle in a <script> tag, and the lib will be loaded into the window.JOSE global variable.

Example test.html file, to illustrate:

<html>
<head>
  <script src="dist/jose.min.js"></script> 
  <script>
    // You can now start using the library
    let jwt = new JOSE.JWT({
      header: { alg: 'HS256' },
      payload: { iss: 'https://forge.anvil.io' }
    })
  </script> 
</head>
<body>
Sample usage of JOSE lib in a browser.
</body>
</html>

Develop

Install

$ git clone git@github.com:anvilresearch/jose.git
cd jose
$ npm install

Test

$ npm test        // Node.js
$ npm run karma   // Karma (browser)

API

JWK

new JWK()

(static) importKey()

JWKSet

new JWKSet()

(static) importKeys()

JWT

new JWT()

(static) decode(token) → {JWT}

(static) encode(…data) → {Promise.<SerializedToken>}

(static) from(data) → {JWT}

(static) fromCompact(data) → {JWT}

(static) fromFlattened(data) → {JWT}

(static) fromGeneral(data) → {JWT}

(static) sign() → {Promise.<SerializedToken>}

(static) verify(…data) → {Promise.<JWT>}

encode(…data) → {Promise.<SerializedToken>}

isJWE()

resolveKeys()

serialize() → {SerializedToken}

sign(…data) → {Promise.<SerializedToken>}

toCompact()

toFlattened()

toGeneral()

toJWD() → {JWD}

verify(…data) → {Promise.<(Boolean|Object)>}

JWD

JWD inherits from JWT.

new JWD()

(static) decode(token) → {JWD}

(static) fromDocumentFlattened(data) → {JWD}

(static) fromDocumentGeneral(data) → {JWD}

serialize() → {SerializedToken}

toDocumentFlattened()

toDocumentGeneral()

toJWT() → {JWT}

Contribute

Issues

  • please file issues :)
  • for bug reports, include relevant details such as platform, version, relevant data, and stack traces
  • be sure to check for existing issues before opening new ones
  • read the documentation before asking questions
  • it's strongly recommended to open an issue before hacking and submitting a PR
  • we reserve the right to close an issue for excessive bikeshedding

Pull requests

Policy

  • we're not presently accepting unsolicited pull requests
  • create an issue to discuss proposed features before submitting a pull request
  • create an issue to propose changes of code style or introduce new tooling
  • ensure your work is harmonious with the overall direction of the project
  • ensure your work does not duplicate existing effort
  • keep the scope compact; avoid PRs with more than one feature or fix
  • code review with maintainers is required before any merging of pull requests
  • new code must respect the style guide and overall architecture of the project
  • be prepared to defend your work

Style guide

Code reviews

  • required before merging PRs
  • reviewers SHOULD run the code under review

Collaborating

Weekly project meeting

  • Thursdays from 1:00 PM to 2:00 Eastern US time at [TBD]
  • Join remotely with Google Hangouts

Pair programming

  • Required for new contributors
  • Work directly with one or more members of the core development team

Code of conduct

Contributors

MIT License

Copyright (c) 2016 Anvil Research, Inc.

Keywords

none

install

npm i @trust/jose

Downloadsweekly downloads

247

version

0.4.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability