{"id":15524186,"url":"https://github.com/leocavalcante/redact-sensitive","last_synced_at":"2025-05-07T14:31:28.256Z","repository":{"id":62516825,"uuid":"377647066","full_name":"leocavalcante/redact-sensitive","owner":"leocavalcante","description":"🙈 A Monolog processor that protects sensitive data from miss logging","archived":false,"fork":false,"pushed_at":"2024-10-01T22:05:38.000Z","size":32,"stargazers_count":27,"open_issues_count":2,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-31T11:01:41.693Z","etag":null,"topics":["grpd","lgpd","logging","monolog","monolog-processor","senstive-logging"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leocavalcante.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-16T22:52:32.000Z","updated_at":"2025-03-29T00:07:31.000Z","dependencies_parsed_at":"2023-01-27T18:31:26.838Z","dependency_job_id":"4503e66a-939a-4242-8451-8c9afbd51a3f","html_url":"https://github.com/leocavalcante/redact-sensitive","commit_stats":{"total_commits":23,"total_committers":6,"mean_commits":"3.8333333333333335","dds":"0.34782608695652173","last_synced_commit":"d11e1f68f1ffb5107a3cbadfeeeb30ef76800a75"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leocavalcante%2Fredact-sensitive","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leocavalcante%2Fredact-sensitive/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leocavalcante%2Fredact-sensitive/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leocavalcante%2Fredact-sensitive/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leocavalcante","download_url":"https://codeload.github.com/leocavalcante/redact-sensitive/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252756747,"owners_count":21799546,"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":["grpd","lgpd","logging","monolog","monolog-processor","senstive-logging"],"created_at":"2024-10-02T10:49:34.587Z","updated_at":"2025-05-07T14:31:28.227Z","avatar_url":"https://github.com/leocavalcante.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Redact Sensitive [![CI](https://github.com/leocavalcante/redact-sensitive/actions/workflows/ci.yml/badge.svg)](https://github.com/leocavalcante/redact-sensitive/actions/workflows/ci.yml)\n\n🙈 A Monolog processor that protects sensitive data from miss logging.\n\nAvoids logging something like `{\"api_key\":\"mysupersecretapikey\"}` by masking partially or completely sensitive data:\n```text\nReadme.INFO: Hello, World! {\"api_key\":\"mysu***************\"} []\n```\n\n## Install\n```shell\ncomposer require leocavalcante/redact-sensitive\n```\n\n## Usage\n\n### 1. Prepare your sensitive keys\n\nIt is a map of key names and how much of it can be displayed, for example:\n```php\n$sensitive_keys = [\n    'api_key' =\u003e 4,\n];\n```\nShows the first 4 characters of the `api_key`.\n\n#### If you want to display the last chars, you can use negative values like `['api_key' =\u003e -4]`, then it will display the last 4 characters.\n\n### 2. Create a Processor using the keys\n\nYou can now create a new Processor with the given keys:\n\n```php\nuse RedactSensitive\\RedactSensitiveProcessor;\n\n$sensitive_keys = ['api_key' =\u003e 4];\n\n$processor = new RedactSensitiveProcessor($sensitive_keys);\n```\n\n### 3. Set the Processor to a Monolog\\Logger\n\n```php\nuse RedactSensitive\\RedactSensitiveProcessor;\n\n$sensitive_keys = ['api_key' =\u003e 4];\n\n$processor = new RedactSensitiveProcessor($sensitive_keys);\n\n$logger = new \\Monolog\\Logger('Readme');\n$logger-\u003epushProcessor($processor);\n```\n\n## Examples\n\n```php\nuse Monolog\\Handler\\StreamHandler;\nuse RedactSensitive\\RedactSensitiveProcessor;\n\n$sensitive_keys = ['api_key' =\u003e 4];\n\n$processor = new RedactSensitiveProcessor($sensitive_keys);\n\n$logger = new \\Monolog\\Logger('Readme', [new StreamHandler(STDOUT)]);\n$logger-\u003epushProcessor($processor);\n\n$logger-\u003einfo('Hello, World!', ['api_key' =\u003e 'mysupersecretapikey']);\n```\n```text\nReadme.INFO: Hello, World! {\"api_key\":\"mysu***************\"} []\n```\n\n### Completely hidden\n\nYou can hide it completely by passing `0` to the key.\n\n```php\nuse Monolog\\Handler\\StreamHandler;\nuse RedactSensitive\\RedactSensitiveProcessor;\n\n$sensitive_keys = ['you_know_nothing' =\u003e 0];\n\n$processor = new RedactSensitiveProcessor($sensitive_keys);\n\n$logger = new \\Monolog\\Logger('Example', [new StreamHandler(STDOUT)]);\n$logger-\u003epushProcessor($processor);\n\n$logger-\u003einfo('Completely hidden', ['you_know_nothing' =\u003e 'John Snow']);\n```\n```text\nExample.INFO: Completely hidden {\"you_know_nothing\":\"*********\"} []\n```\n\n### Custom format\n\nFeel free to customize a replacement character `*` and/or provide your own template.\n\n```php\nuse Monolog\\Handler\\StreamHandler;\nuse RedactSensitive\\RedactSensitiveProcessor;\n\n$sensitive_keys = ['secret' =\u003e 2];\n\n$processor = new RedactSensitiveProcessor($sensitive_keys, template: '%s(redacted)');\n\n$logger = new \\Monolog\\Logger('Example', [new StreamHandler(STDOUT)]);\n$logger-\u003epushProcessor($processor);\n\n$logger-\u003einfo('Sensitive', ['secret' =\u003e 'my_secret_value']);\n```\n```text\nExample.INFO: Sensitive {\"secret\":\"my*************(redacted)\"} []\n```\n\nCustom template allows to discard the masked characters altogether:\n```php\nuse Monolog\\Handler\\StreamHandler;\nuse RedactSensitive\\RedactSensitiveProcessor;\n\n$sensitive_keys = ['secret' =\u003e 2];\n\n$processor = new RedactSensitiveProcessor($sensitive_keys, template: '...');\n\n$logger = new \\Monolog\\Logger('Example', [new StreamHandler(STDOUT)]);\n$logger-\u003epushProcessor($processor);\n\n$logger-\u003einfo('Sensitive', ['secret' =\u003e 'my_secret_value']);\n```\n```text\nExample.INFO: Sensitive {\"secret\":\"my...\"} []\n```\n\n### Length limit\n\nUse `lengthLimit` to truncate redacted sensitive information, such as lengthy tokens.\n\n```php\nuse Monolog\\Handler\\StreamHandler;\nuse RedactSensitive\\RedactSensitiveProcessor;\n\n$sensitive_keys = ['access_token' =\u003e 0];\n\n$processor = new RedactSensitiveProcessor($sensitive_keys, lengthLimit: 5);\n\n$logger = new \\Monolog\\Logger('Example', [new StreamHandler(STDOUT)]);\n$logger-\u003epushProcessor($processor);\n\n$logger-\u003einfo('Truncated secret', ['access_token' =\u003e 'Very long JWT ...']);\n```\n```text\nExample.INFO: Truncated secret {\"access_token\":\"*****\"} []\n```\n\n### Right to left\n\nAnd, as said before, you can mask the value from right to left using negative values.\n\n```php\nuse Monolog\\Handler\\StreamHandler;\nuse RedactSensitive\\RedactSensitiveProcessor;\n\n$sensitive_keys = ['credit_card' =\u003e -4];\n\n$processor = new RedactSensitiveProcessor($sensitive_keys);\n\n$logger = new \\Monolog\\Logger('Example', [new StreamHandler(STDOUT)]);\n$logger-\u003epushProcessor($processor);\n\n$logger-\u003einfo('You are not storing credit cards, right?', ['credit_card' =\u003e '4111111145551142']);\n```\n```text\nExample.INFO: You are not storing credit cards, right? {\"credit_card\":\"************1142\"} []\n```\n\n### Nested values\n\nIt should work with nested objects and arrays as well.\n\n```php\nuse Monolog\\Handler\\StreamHandler;\nuse RedactSensitive\\RedactSensitiveProcessor;\n\n$sensitive_keys = [\n    'nested' =\u003e [\n        'arr' =\u003e [\n            'value' =\u003e 3,\n            'or_obj' =\u003e ['secret' =\u003e -3],\n        ],\n    ]\n];\n\n$processor = new RedactSensitiveProcessor($sensitive_keys);\n\n$logger = new \\Monolog\\Logger('Example', [new StreamHandler(STDOUT)]);\n$logger-\u003epushProcessor($processor);\n\n$nested_obj = new stdClass();\n$nested_obj-\u003esecret = 'donttellanyone';\n\n$logger-\u003einfo('Nested', [\n    'nested' =\u003e [\n        'arr' =\u003e [\n            'value' =\u003e 'abcdfg',\n            'or_obj' =\u003e $nested_obj,\n        ],\n    ],\n]);\n```\n```text\nExample.INFO: Nested {\"nested\":{\"arr\":{\"value\":\"abc***\",\"or_obj\":{\"stdClass\":{\"secret\":\"***********one\"}}}}} []\n```\n\n## Thanks\nFeel free to open any issues or PRs.\n\n---\nMIT \u0026copy; 2021\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleocavalcante%2Fredact-sensitive","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleocavalcante%2Fredact-sensitive","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleocavalcante%2Fredact-sensitive/lists"}