# hybrid-crypto-js > Hybrid (RSA+AES) encryption and decryption toolkit for JavaScript Latest version **0.2.4** (published 2020-09-16) · MIT license · 0 weekly downloads ## Install ```sh npm install hybrid-crypto-js pnpm add hybrid-crypto-js yarn add hybrid-crypto-js bun add hybrid-crypto-js ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.2.4 | | Published | 2020-09-16 | | First published | 2017-12-07 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Unpacked size | 1.3 MB | | Known vulnerabilities | 0 (+27 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 144 | | Author | Juho Enala | | Maintainers | juhoenala | | Keywords | rsa, aes, rsa+aes, react, node, react-native | ## Links - npm: https://www.npmjs.com/package/hybrid-crypto-js - Repository: https://github.com/juhoen/hybrid-crypto-js - Issues: https://github.com/juhoen/hybrid-crypto-js/issues - npm.io page: https://npm.io/package/hybrid-crypto-js ## Dependencies (1) - [node-forge](https://npm.io/package/node-forge.md) ^0.8.5 ## Alternatives - [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads - [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads - [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads - [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads - [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads ## Recent versions - 0.2.4 (latest) — 2020-09-16 - 0.1.1 (beta) — 2017-12-08 - 0.2.3 — 2020-07-27 - 0.2.2 — 2019-09-06 - 0.2.1 — 2019-08-21 - 0.2.0 — 2019-08-20 - 0.1.7 — 2019-05-05 - 0.1.6 — 2018-02-09 - 0.1.5 — 2018-02-09 - 0.1.4 — 2018-02-09 - 0.1.3 — 2018-01-22 - 0.1.2 — 2017-12-18 - 0.1.0 — 2017-12-07 ## README # Hybrid Crypto JS [![NPM](https://nodei.co/npm/hybrid-crypto-js.png)](https://nodei.co/npm/hybrid-crypto-js/) ## Introduction _Hybrid Crypto JS_ is a hybrid (RSA+AES) encryption and decryption toolkit for JavaScript. _Hybrid Crypto JS_ combines RSA and AES encryption algorithms, making it possible to encrypt and decrypt large messages efficiently. This cross-platform library is based on [Forge](https://github.com/digitalbazaar/forge). _Hybrid Crypto JS_ can be used in browsers, Node.js, or React Native. ## Documentation **Getting started** - [Introduction](#introduction) - [Documentation](#documentation) - [Installation](#installation) **Features** - [Initialization](#initialization) - [Encryption](#encryption) - [Decryption](#decryption) - [Signatures](#signatures) - [Verifying](#verifying) - [RSA key pairs](#rsa-key-pairs) ### Installation ``` npm install hybrid-crypto-js ``` ### Importing **Node.js** ```js var RSA = require('hybrid-crypto-js').RSA; var Crypt = require('hybrid-crypto-js').Crypt; ``` **React Native** ```js import { Crypt, RSA } from 'hybrid-crypto-js'; ``` **Web** Download minified _hybrid-crypto.min.js_ file [here](https://raw.githubusercontent.com/juhoen/hybrid-crypto-js/master/web/hybrid-crypto.min.js). ```html ``` ## Features ### Initialization ```js // Basic initialization var crypt = new Crypt(); var rsa = new RSA(); // Increase amount of entropy var entropy = 'Random string, integer or float'; var crypt = new Crypt({ entropy: entropy }); var rsa = new RSA({ entropy: entropy }); // Select default message digest var crypt = new Crypt({ md: 'sha512' }); // Select AES or RSA standard var crypt = new Crypt({ // Default AES standard is AES-CBC. Options are: // AES-ECB, AES-CBC, AES-CFB, AES-OFB, AES-CTR, AES-GCM, 3DES-ECB, 3DES-CBC, DES-ECB, DES-CBC aesStandard: 'AES-CBC', // Default RSA standard is RSA-OAEP. Options are: // RSA-OAEP, RSAES-PKCS1-V1_5 rsaStandard: 'RSA-OAEP', }); // Alternate AES keysize (some AES algorithms requires specific key size) var crypt = new Crypt({ aesKeySize: 192, // Defaults to 256 }); ``` ### Encryption _Hybrid Crypto JS_ provides basic encryption function that also supports multiple RSA keys, with or without [signature](#signatures). An encrypted message is a JSON formatted string. ```js var message = 'Hello world!'; // Encryption with one public RSA key var encrypted = crypt.encrypt(publicKey, message); // Function also supports encryption with multiple RSA public keys var encrypted = crypt.encrypt([publicKey1, publicKey2, publicKey3], message); // Encryption with signature var encrypted = crypt.encrypt(publicKey, message, signature); ``` **Pretty-printed sample output** ```js { "v": "hybrid-crypto-js_0.1.2", // Current package version "iv": "CmtyaZTyzoAp1mTNUTztic0v1...", // Initialization vector "keys": { // Encrypted AES keys by RSA fingerprints "85:3d:10:e1:56...": "bHaTF9...", "d3:48:6a:e9:13...": "t9eds3..." }, "cipher": "+iwVFsC2dECBQvwcm9DND..." // Actual encrypted message "signature": "sdL93kfdm12feds3C2..." // Signature (optional) } ``` ### Decryption Decrypting message with _Hybrid Crypto JS_ is as easy as encrypting. Decrypt function can decrypt any message which has been encrypted with key pair's public key. The decrypted message is a JSON object containing a message and an optional signature. ```js var encrypted = '{"v":"hybrid-crypto-js_0.1.0","iv":"CmtyaZTyzoAp1mTN...'; // Decrypt encryped message with private RSA key var decrypted = crypt.decrypt(privateKey, encrypted); // Get decrypted message var message = decrypted.message; ``` **Sample output** ```js { message: "Hello world!", // Actual decrypted message signature: "sdL93kfdm12feds3C2..." // Signature (optional) } ``` ### Signatures _Hybrid Crypto JS_ provides simple message signing. The encrypted message can be signed with the issuer's private key. ```js var message = 'Hello world!'; // Create a signature with ISSUER's private RSA key var signature = crypt.signature(issuerPrivateKey, message); // Encrypt message with RECEIVERS public RSA key and attach the signature var encrypted = crypt.encrypt(receiverPublicKey, message, signature); // Select default message digest var crypt = new Crypt({ md: 'sha512', // Options: sha1, sha256, sha384, sha512, and md5 }); ``` ### Verifying The message receiver needs to have a message issuer's public RSA key in order to verify the message issuer. ```js // Encrypted message with signature var encrypted = '{"v":"hybri... ..."signature":"sdL93kfd...'; // Decrypt message with own (RECEIVER) private key var decrypted = crypt.decrypt(receiverPrivateKey, encrypted); // Verify message with ISSUER's public key var verified = crypt.verify( issuerPublicKey, decrypted.signature, decrypted.message, ); ``` Verification function returns _true_ or _false_ depending on whether the verification was successful. ### RSA key pairs _Hybrid Crypto JS_ RSA key generation function is based in [Forge](https://github.com/digitalbazaar/forge#rsa) key pair generation function. As a difference, _Hybrid Crypto JS_ returns key pair in PEM format. ```js // Initialize RSA-class var rsa = new RSA(); // Generate RSA key pair, default key size is 4096 bit rsa.generateKeyPair(function(keyPair) { // Callback function receives new key pair as a first argument var publicKey = keyPair.publicKey; var privateKey = keyPair.privateKey; }); // ... or: rsa.generateKeyPairAsync().then(keyPair => { var publicKey = keyPair.publicKey; var privateKey = keyPair.privateKey; }); // Generate 1024 bit RSA key pair rsa.generateKeyPair(function(keyPair) { // Callback function receives new 1024 bit key pair as a first argument var publicKey = keyPair.publicKey; var privateKey = keyPair.privateKey; }, 1024); // Key size // RSA can be also initialized with options var rsa = new RSA({ keySize: 4096, }); ``` --- _Source: https://npm.io/package/hybrid-crypto-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._