js-crypto-rsa0.5.0 • Public • Published
WARNING: At this time this solution should be considered suitable for research and experimentation, further code and security review is needed before utilization in a production application.
Introduction and Overview
This library is designed to 'universally' provide an RSA cryptographic functions, i.e., it works both on most modern browsers and on Node.js just by importing from NPM/source code. The original specification is given in RFC5869 (https://tools.ietf.org/html/rfc5869). Note that in the design principle, the library fully utilizes native APIs like WebCrypto API to accelerate its operation if available. This library provides APIs to employ RSA-OAEP, RSA-PSS/RSASSA-PKCS1-v1_5 and their key generation, i.e.,
At your project directory, do either one of the following.
- From npm/yarn:$ npm install --save js-crypto-rsa // npm$ yarn add js-crypto-rsa // yarn
- From GitHub:$ git clone https://github.com/junkurihara/jscu.git$ cd js-crypto-utils/packages/js-crypto-rsa& yarn build
Then you should import the package as follows.
import rsa from 'js-crypto-rsa'; //
The bundled file is also given as
js-crypto-rsa/dist/jscrsa.bundle.js for a use case where the module is imported as a
window.jscrsa object via
Sign and verify
const publicJwk = kty: 'RSA' n: '...' e: '...'; // public keyconst privateJwk = kty: 'RSA' n: '...' e: '...' p: '...' q: '...' dp: '...' dq: '...' qi: '...'; // paired private keyconst msg = ...; // Uint8Array// signrsa;
Encrypt and decrypt
const publicJwk = kty: 'RSA' n: '...' e: '...'; // public keyconst privateJwk = ktyp: 'RSA' n: 'P-256' e: '...' p: '...' q: '...' dp: '...' dq: '...' qi: '...'; // paired private keyconst msg = ...; // Uint8Array// signrsa;
This library has the following limitations at this point.
Node.js must be >= v10.12.0 to generate RSA keys.
Some functions does not work in legacy browsers like MS Edge and IE11. In particular, RSA-PSS scheme does not work due to lack of native implementation in IE, and the label for RSA-OAEP encryption cannot be employed since IE does not support it. Also MS Edge is incompatible with RSA-OAEP and more and more. This library heavily relies on the native (but standardized) implementation of RSA cryptographic modules in browsers and Node.js and it does not employ pure-JS RSA implementations for compatibility yet. Currently, we strongly recommend you to use this library in more modern environments, and, honestly, you should discard the IE and Edge ASAP.
Licensed under the MIT license, see