https://github.com/rap2hpoutre/mongodb-anonymizer

Anonymize MongoDB database with a NodeJS CLI
https://github.com/rap2hpoutre/mongodb-anonymizer

anonymization database hacktoberfest javascript mongo mongodb nodejs

Last synced: about 1 month ago
JSON representation

Anonymize MongoDB database with a NodeJS CLI

• Host: GitHub
• URL: https://github.com/rap2hpoutre/mongodb-anonymizer
• Owner: rap2hpoutre
• License: mit
• Created: 2021-07-07T07:33:26.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-07-09T14:54:34.000Z (over 3 years ago)
• Last Synced: 2024-09-13T22:36:25.190Z (2 months ago)
• Topics: anonymization, database, hacktoberfest, javascript, mongo, mongodb, nodejs
• Language: TypeScript
• Homepage: https://raph.site
• Size: 67.4 KB
• Stars: 12
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
mongodb-anonymizer

==================

MongoDB anonymzer tool.

Export your MongoDB database anonymized from source to target. Replace all sensitive data thanks to `faker`.

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/mongodb-anonymizer.svg)](https://npmjs.org/package/mongodb-anonymizer)

[![License](https://img.shields.io/npm/l/mongodb-anonymizer.svg)](https://github.com/rap2hpoutre/mongodb-anonymizer/blob/main/package.json)

## Usage

Run this command by giving a source URI and target URI (no need to install first thanks to `npx`):

```bash

npx mongodb-anonymizer \

  --uri=mongodb://localhost:27017/source \

  --targetUri=mongodb://localhost:27017/anonymized

```

☝️ Be careful, since target collections will be removed.

### Specify list of fields to anonymize

Use `--list` option with a comma separated list of column name:

```bash

npx mongodb-anonymizer  \

  --uri=mongodb://localhost:27017/source \

  --targetUri=mongodb://localhost:27017/anonymized

  --list=email,firstName,lastName,phone

```

Specifying another list via `--list` replace the default automatically anonymized values:

```csv

email,name,description,address,city,country,phone,comment,birthdate

```

You can also specify replacements for a specific collection:

```csv

users.email,products.price

```

#### Customize replacements 

You can also choose which faker function you want to use to replace data (default is `faker.random.word`):

```bash

npx mongodb-anonymizer  \

  --uri=mongodb://localhost:27017/source \

  --targetUri=mongodb://localhost:27017/anonymized

  --list=firstName:faker.name.firstName,lastName:faker.name.lastName

```

:point_right: You don't need to specify faker function since the command will try to find correct function via column name.

You can use plain text too for static replacements:

```bash

npx mongodb-anonymizer  \

  --uri=mongodb://localhost:27017/source \

  --targetUri=mongodb://localhost:27017/anonymized

  --list=textcol:hello,jsoncol:{},intcol:12

```