# node-crypto-js

> Node (RSA+AES) encryption and decryption companion for hybrid-crypto-js

Latest version **1.0.3** (published 2019-05-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-crypto-js
pnpm add node-crypto-js
yarn add node-crypto-js
bun add node-crypto-js
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-05-20 |
| First published | 2019-05-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 26.4 KB |
| Known vulnerabilities | 0 (+15 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Nusrath Khan |
| Maintainers | nusrath |
| Keywords | rsa, aes, rsa+aes |

## Links

- npm: https://www.npmjs.com/package/node-crypto-js
- Repository: https://github.com/nunsie/node-crypto-js
- Homepage: https://github.com/nunsie/node-crypto-js#readme
- Issues: https://github.com/nunsie/node-crypto-js/issues
- npm.io page: https://npm.io/package/node-crypto-js

## Dependencies (1)

- [node-forge](https://npm.io/package/node-forge.md) ^0.7.1

## Recent versions

- 1.0.3 (latest) — 2019-05-20
- 1.0.2 — 2019-05-20
- 1.0.1 — 2019-05-20
- 1.0.0 — 2019-05-20

## README

# Node Crypto JS

[![NPM](https://nodei.co/npm/node-crypto-js.png?compact=true)](https://nodei.co/npm/node-crypto-js/)

## Introduction

<a name="introduction"></a>

_Node Crypto JS_ is a NodeJS (RSA+AES) encryption and decryption companion for hybrid-crypto-js. _Node Crypto JS_ combines RSA and AES encryption algorithms making it possible to efficiently encrypt and decrypt large messages. This node library is based on [hybrid-crypto-js](https://www.npmjs.com/package/hybrid-crypto-js).

## Documentation

<a name="documentation"></a>

**Getting started**

- [Introduction](#introduction)
- [Documentation](#documentation)
- [Installation](#installation)

**Features**

- [Initialization](#initialization)
- [Encryption](#encryption)
- [Decryption](#decryption)
- [Signatures](#signatures)
- [Verifying](#verifying)
- [RSA keypairs](#rsa-keypairs)

### Installation

<a name="installation"></a>

```
npm install node-crypto-js
```

### Importing

**Node.js**

```js
var RSA = require('node-crypto-js').RSA;
var Crypt = require('node-crypto-js').Crypt;
```

## Features

### Initialization

<a name="initialization"></a>

```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 });
```

### Encryption

<a name="encryption"></a>

_Node Crypto JS_ provides basic encryption function which supports also multiple RSA keys, with or without [signature](#signatures). Encrypted message is outputted as a JSON 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": "node-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

<a name="decryption"></a>

Decrypting message with _Hybrid Crypto JS_ is as easy as encrypting. Decryption function can decrypt any message which has been encrypted with keypair's public key. Decrypted message is outputted as a JSON object.

```js
var encrypted = '{"v":"node-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

<a name="signatures"></a>

_Hybrid Crypto JS_ provides simple message signing. When issuer signs a message, message receiver can be sure of the message issuer.

```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);
```

### Verifying

<a name="verifying"></a>

Message receiver needs to have message issuer's public RSA key in order to verify 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 return _true_ or _false_ depending on whether the verification was successfull.

### RSA keypairs

<a name="rsa-keypairs"></a>

_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 keypair in PEM format.

```js
// Initialize RSA-class
var rsa = new RSA();

// Generate RSA key pair, defaults on 4096 bit key
rsa.generateKeypair(function(keypair) {
  // Callback function receives new keypair as a first argument
  var publicKey = keypair.publicKey;
  var privateKey = keypair.privateKey;
});

// Generate 1024 bit RSA key pair
rsa.generateKeypair(function(keypair) {
  // Callback function receives new 1024 bit keypair as an 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,
  rsaStandard: 'RSA-OAEP' // RSA-OAEP or RSAES-PKCS1-V1_5,
});
```

---
_Source: https://npm.io/package/node-crypto-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._