JSPM

@solid/jose

0.5.0

ESM via JSPM
ES Module Entrypoint
Export Map
Keywords
License
Repository URL
TypeScript Types
README

Created 7 years ago
Published 6 years ago
Downloads 525
Score
MPQF
License MIT

JSON Object Signing and Encryption

Package Exports

@solid/jose

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@solid/jose) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

JSON Object Signing and Encryption (JOSE)

Planned Features

Based on Webcrypto API
CryptoKey as expected key argument
Isomorphic (Node.js and Browser)
Extensible JWT/JWS/JWE classes

Dependencies

This package is a work in progress, dependent on other ongoing projects. Code contained herein will be completed when the following dependencies are ready to release:

anvilresearch/webcrypto

The current contents of the repository should be considered a "sketch".

Scope of implementation

JWA – RFC7518
- Cryptographic Algorithms for Digital Signatures and MACs
- Cryptographic Algorithms for Key Management
- Cryptographic Algorithms for Content Encryption
JWK – RFC7517
- JSON Web Key (JWK) Format
- JWK Set Format
- JSON Web Key (JWK) Thumbprint (RFC7638)
- Conversion from JWK to PEM and PEM to JWK
JWT – RFC7519
JWS – RFC7515
JWE – RFC7516

Usage in 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>

Running tests

Nodejs

$ npm test

Browser (karma)

$ npm run karma

MIT License

The MIT License