# pseudonimizr > Pseudo-anonymizer of different formats Latest version **1.0.1** (published 2018-06-26) · MIT license · 0 weekly downloads ## Install ```sh npm install pseudonimizr pnpm add pseudonimizr yarn add pseudonimizr bun add pseudonimizr ``` ## 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.1 | | Published | 2018-06-26 | | First published | 2017-12-11 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 8 | | Unpacked size | 54.8 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Ivan Vokhmin | | Maintainers | cabalbl4 | | Keywords | anonymity | ## Links - npm: https://www.npmjs.com/package/pseudonimizr - Repository: https://github.com/Cabalbl4/pseudonimizr - Homepage: https://github.com/Cabalbl4/pseudonimizr#readme - Issues: https://github.com/Cabalbl4/pseudonimizr/issues - npm.io page: https://npm.io/package/pseudonimizr ## Dependencies (8) - [chai](https://npm.io/package/chai.md) ^4.1.2 - [jsdom](https://npm.io/package/jsdom.md) ^11.3.0 - [mocha](https://npm.io/package/mocha.md) ^4.0.1 - [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.2 - [express](https://npm.io/package/express.md) ^4.16.2 - [threads](https://npm.io/package/threads.md) ^0.8.1 - [readline](https://npm.io/package/readline.md) ^1.3.0 - [JSONStream](https://npm.io/package/JSONStream.md) ^1.3.2 ## Recent versions - 1.0.1 (latest) — 2018-06-26 - 1.0.0 — 2018-05-25 - 0.3.6 — 2018-05-25 - 0.3.5 — 2018-05-25 - 0.3.4 — 2018-05-25 - 0.3.3 — 2018-05-25 - 0.3.2 — 2018-05-25 - 0.3.1 — 2018-05-25 - 0.3.0 — 2018-05-25 - 0.2.3 — 2018-05-25 - 0.1.3 — 2018-03-15 - 0.1.2 — 2018-03-15 - 0.1.1 — 2018-03-15 - 0.1.0 — 2018-03-15 - 0.0.2 — 2017-12-11 - … 1 more at https://npm.io/package/pseudonimizr/versions ## README # Pseudonimizr ## A tool to make smart anonymization. This tool intelligently anonymizes data by matching the common used words in selected languages with ones given in input This help to anonymize all the data which is sensetive, and leave common messages (Errors etc) untouched ## Disclaimer This is a prototype. It can misbehave and ruin HTML/CSV structure, please check the output before processing it! ### Before you start Populate *dicts/* folder with dictionaries (or specify path to them in `extraDicts`). Dictionary is a newline-separated list of words with the name of a country like DE, GB etc ### Requires *Node.js must be >=v6!* This is due to: * *cherio* html parser asks for it * ~~JS v5, please die already~~ # Config *config.json* ``` { // Fuzzy search level. Describes how much a given word can derive from its analogs. 0 - no fuzzy search, 1+ adds more fuzziness "fuzzyLevel" : 0, // Remove inline script instead of randomizing it "html_remove_script" : false, // Will use words from language instead of random sequences in substitution treeRandomize: true, // Extra path to search for dictionary files. All of them should exist at program start "extraDicts" : ["./path/to/extra/dictionaries", "another/path"], server: { // Port for service mode port: 7766 } } ``` # Usage as a module # install ``` npm install --save pseudonimizr ``` Current module interface: ``` module.exports = { standalone: function() {}, Service: null, //TODO ServiceConnector: null, // TODO }; ``` ## Standalone usage ``` // This OPTIONAL config will override values of built-in config.json const optionalConfig = { fuzzyLevel: 0 } const pseudonimizr = require('pseudonimizr').standalone(optionalConfig); // or just .standalone() pseudonimizr.process('DE', 'html', 'TEST').then((data) => { console.log('got anonymized string', data); }).catch(e=>console.warn(e)); ``` ### Standalone interface functions and parameters #### addDictionaryFromString(lang, stringData) Add dictionary to memory from a newline separated string ``` pseudonimizr.addDictionaryFromString('RU', 'один\nдва\nтри\n....'); ``` #### addDictionaryFromFile(lang, filePath) Add dictionary from file. Same as `addDictionaryFromString`, but you specify a path as second parameter #### process(langs, mode, input) Main async function. Accepts: ##### langs a string of comma-separated languages, or array of language strings, or 'AUTO' keyword, or undefined/null ``` 'DE' 'DE,GB' 'DE,RU,CZ' ['NL','HU'] ``` Null/undefined parameter or 'AUTO' keyword will launch function in language detect mode ##### mode one of supported format modes. Currently supported are 'text', 'html', 'csv'. Must be explicitly one of those ##### input utf8 text string with data needed to anonymize This function returns a promise, which either gives anonymized string or is rejected with error #### supportetDicts() Show array of dictionaries currently available, like: `['DE','GB','ZZ']` # Usage as stand-alone tool From pseudonimizr folder ``` node tool.js LANGS format input output ``` *Where:* * LANGS - comma separated list of one or more languages for this dump. Relevant dictionary must be present in dicts folder. * format - format of input. Right now can be one of *csv*, *html*, *text* * input - path to unput file * output - path to output file #### Examples ``` node tool.js DE html index.html anon-index.html node tool.js DE,GB,ES csv data.csv anon-data.csv ``` Note. There is an empty dictionary *ZZ*. If you use it as the only language in LANGS, all words will be shredded regardless to their relevance # Usage as a service ``` node service.js ``` Will listen to port, specified in config. Will keep dictionaries in cache for faster access. ### Requires: #### Headers: **languages** - same as LANGS param, missing header will be treated as AUTO **mode** - same as *format* param Body is the desired data to anonymize Successful call will return anonymised document and status 200; Non 200 status means error (400 - bad parameters, 500 - other problems) --- _Source: https://npm.io/package/pseudonimizr · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._