@trust/jwk
v0.3.3
Published
JSON Web Key for JavaScript
Downloads
10
Readme
JWK (@trust/jwk)
JSON Web Key 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 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.
Table of Contents
Security
TBD
Install
$ npm install @trust/jwk --save
Usage
Node.js
const { JWK, JWKSet } = require('@trust/jwk')
Browser
TBD
Develop
Install
$ git clone [email protected]:anvilresearch/jwk.git
$ cd jwk
$ npm install
Test
$ npm test // Node.js
$ npm run karma // Karma (browser)
API
Full documentation available here.
Examples
TBD
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
- ES6
- Standard JavaScript
- jsdocs
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
- @trust/jwk follows the Contributor Covenant Code of Conduct.
Contributors
- Christian Smith @christiansmith
- Greg Linklater @EternalDeiwos
- Dmitri Zagidulin @dmitrizagidulin
- Ioan Budea @johnny90
MIT License
Copyright (c) 2016 Anvil Research, Inc.