{"id":24558090,"url":"https://github.com/rse/nebulize","last_synced_at":"2025-03-16T19:21:48.269Z","repository":{"id":57309659,"uuid":"135046237","full_name":"rse/nebulize","owner":"rse","description":"Nebulize Security-Sensitive Information","archived":false,"fork":false,"pushed_at":"2021-01-09T13:32:39.000Z","size":19,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-10T10:46:46.459Z","etag":null,"topics":["data","dsgvo","gdpr","information","nebulize","security","sensitive"],"latest_commit_sha":null,"homepage":"http://npmjs.com/nebulize","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rse.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-27T12:55:19.000Z","updated_at":"2021-01-09T13:32:37.000Z","dependencies_parsed_at":"2022-09-09T02:31:24.741Z","dependency_job_id":null,"html_url":"https://github.com/rse/nebulize","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rse%2Fnebulize","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rse%2Fnebulize/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rse%2Fnebulize/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rse%2Fnebulize/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rse","download_url":"https://codeload.github.com/rse/nebulize/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243918629,"owners_count":20368745,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data","dsgvo","gdpr","information","nebulize","security","sensitive"],"created_at":"2025-01-23T05:47:22.527Z","updated_at":"2025-03-16T19:21:48.243Z","avatar_url":"https://github.com/rse.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\nNebulize\n========\n\nNebulize Security-Sensitive Information\n\n\u003cp/\u003e\n\u003cimg src=\"https://nodei.co/npm/nebulize.png?downloads=true\u0026stars=true\" alt=\"\"/\u003e\n\n\u003cp/\u003e\n\u003cimg src=\"https://david-dm.org/rse/nebulize.png\" alt=\"\"/\u003e\n\nAbout\n-----\n\nNebulize is a small JavaScript library, providing the capability to\nnebulize security-sensitive information in data by anonymization\n(replacing with random-based UUID version 4), pseudonymization\n(replacing with hash-based UUID version 5), blacking (replacing with `#`\ncharacters) or substitution (replacing with custom characters). This\nnebulization approach is especially intended to support applications in\ntheir filtering of log messages from sensitive information in order to\nbe compliant to the EU [General Data Protection Regulation (GDPR)](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation).\n\nInstallation\n------------\n\n```shell\n$ npm install nebulize\n```\n\nUsage\n-----\n\n```js\nconst Nebulize = require(\"nebulize\")\nconst expect   = require(\"chai\").expect\n\nlet ds = new Nebulize()\nds.filter(\"**\", \"foo\", \"bar\")\nexpect(ds.nebulize(\"foo\")).to.be.equal(\"bar\")\n\nlet data = {\n    foo: \"foo\", bar: 42, baz: true,\n    quux: [ \"foo\", 42, true ],\n    username: \"example\",\n    password: \"secret\"\n}\n```\n\nApplication Programming Interface (API)\n---------------------------------------\n\n- `new Nebulize(): Nebulize`:\u003cbr/\u003e\n  Create a new Nebulize context.\n\n- `Nebulize#filter(pathMatch: string|function,\n  dataMatch: RegExp|string|number|boolean|function,\n  dataReplace: string|number|boolean|function): Nebulize`:\u003cbr/\u003e\n  Add a filter to the context, based on tree parameters:\n\n    - `pathMatch`:\u003cbr/\u003e\n      either a Unix glob pattern string or a callback\n      function of signature `(path: string) =\u003e boolean`.\n      The callback function receives the path from the root of the `data`\n      object (as passed to method `nebulize()`) to\n      the current nebulized leaf object as a dot-separated\n      path and has to return `true` when the `dataMatch` and\n      `dataReplace` should be applied.\n\n    - `dataMatch`:\u003cbr/\u003e\n      FIXME\n\n    - `dataReplace`:\u003cbr/\u003e\n      FIXME\n\n- `Nebulize#nebulize(data: any): any`:\u003cbr/\u003e\n  Nebulize arbitrary data based on filters in context.\n  The `data` is recursively traversed and all filters\n  applied to all leaf data.\n\nLicense\n-------\n\nCopyright (c) 2018-2021 Dr. Ralf S. Engelschall (http://engelschall.com/)\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be included\nin all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frse%2Fnebulize","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frse%2Fnebulize","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frse%2Fnebulize/lists"}