# mongoose-plugin-rsa

> [![npm version](https://img.shields.io/npm/v/mongoose-plugin-rsa.svg)](https://www.npmjs.com/package/mongoose-plugin-rsa) [![license](https://img.shields.io/github/license/mgcrea/mongoose-plugin-rsa.svg?style=flat)](https://tldrlegal.com/license/mit-licen

Latest version **1.0.2** (published 2017-11-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install mongoose-plugin-rsa
pnpm add mongoose-plugin-rsa
yarn add mongoose-plugin-rsa
bun add mongoose-plugin-rsa
```

## 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.2 |
| Published | 2017-11-03 |
| First published | 2017-06-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+16 in 1 direct dependencies) |
| Install scripts | no |
| Author | Olivier Louvignes |
| Maintainers | mgcrea |

## Links

- npm: https://www.npmjs.com/package/mongoose-plugin-rsa
- Repository: https://github.com/mgcrea/mongoose-plugin-rsa
- Homepage: https://github.com/mgcrea/mongoose-plugin-rsa#readme
- Issues: https://github.com/mgcrea/mongoose-plugin-rsa/issues
- npm.io page: https://npm.io/package/mongoose-plugin-rsa

## Dependencies (3)

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

## Recent versions

- 1.0.2 (latest) — 2017-11-03
- 1.0.1 — 2017-06-23

## README

# mongoose-plugin-rsa

[![npm version](https://img.shields.io/npm/v/mongoose-plugin-rsa.svg)](https://www.npmjs.com/package/mongoose-plugin-rsa)
[![license](https://img.shields.io/github/license/mgcrea/mongoose-plugin-rsa.svg?style=flat)](https://tldrlegal.com/license/mit-license)
[![build status](http://img.shields.io/travis/mgcrea/mongoose-plugin-rsa/master.svg?style=flat)](http://travis-ci.org/mgcrea/mongoose-plugin-rsa)
[![dependencies status](https://img.shields.io/david/mgcrea/mongoose-plugin-rsa.svg?style=flat)](https://david-dm.org/mgcrea/mongoose-plugin-rsa)
[![devDependencies status](https://img.shields.io/david/dev/mgcrea/mongoose-plugin-rsa.svg?style=flat)](https://david-dm.org/mgcrea/mongoose-plugin-rsa#info=devDependencies)
[![Codacy Badge_Grade](https://api.codacy.com/project/badge/Grade/99844d4bed38450f9ec9e03650d19954)](https://www.codacy.com/app/olivier_5/mongoose-plugin-rsa?utm_source=github.com&utm_medium=referral&utm_content=mgcrea/mongoose-plugin-rsa&utm_campaign=Badge_Grade) [![Codacy Badge_Coverage](https://api.codacy.com/project/badge/Coverage/99844d4bed38450f9ec9e03650d19954)](https://www.codacy.com/app/olivier_5/mongoose-plugin-rsa?utm_source=github.com&utm_medium=referral&utm_content=mgcrea/mongoose-plugin-rsa&utm_campaign=Badge_Coverage)
[![npm downloads](https://img.shields.io/npm/dm/mongoose-plugin-rsa.svg)](https://www.npmjs.com/package/mongoose-plugin-rsa)

Automatic RSA keyPair generation on document creation.

## Quickstart

- Load the plugin inside your schema

```js
import {Schema} from 'mongoose';
import rsaPlugin from 'mongoose-plugin-rsa';

const schema = new Schema({
  name: {type: String, required: true},
  content: {type: Object, default: {}}
});

// Add RSA keypair generation
schema.plugin(rsaPlugin, {bits: 2048});

export default schema;
```

## Testing

- You can quickly start hacking around

```bash
git clone -o github git@github.com:mgcrea/mongoose-plugin-rsa.git
cd mongoose-plugin-rsa
npm i
npm test
```

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