PHPackages gbhorwood/redactem - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. gbhorwood/redactem ActiveLibrary[Utility & Helpers](/categories/utility) gbhorwood/redactem ================== A json redaction utility 1.0.0(2y ago)4712MITPHPPHP ^8.1 Since Nov 27Pushed 1y ago1 watchersCompare [ Source](https://github.com/gbhorwood/Redactem)[ Packagist](https://packagist.org/packages/gbhorwood/redactem)[ RSS](/packages/gbhorwood-redactem/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (1)Dependencies (3)Versions (3)Used By (0) Redactem ======== [](#redactem) [![License](https://camo.githubusercontent.com/6723217cb50a061927786acd562583607edafdb432c51a530f4483327ba4082a/687474703a2f2f706f7365722e707567782e6f72672f6762686f72776f6f642f726564616374656d2f6c6963656e7365)](https://packagist.org/packages/gbhorwood/redactem)[![Version](https://camo.githubusercontent.com/fd4ddf58bbaedccc97cd74dfac7b98856cf850d8d4d4de3d83394ab7cea8f7bb/687474703a2f2f706f7365722e707567782e6f72672f6762686f72776f6f642f726564616374656d2f76657273696f6e)](https://packagist.org/packages/gbhorwood/redactem)[![PHP Version Require](https://camo.githubusercontent.com/534973dc0d5833ec22f7aa2142610ecfe316834261a83176ff3a6d21389a532c/687474703a2f2f706f7365722e707567782e6f72672f6762686f72776f6f642f726564616374656d2f726571756972652f706870)](https://packagist.org/packages/gbhorwood/redactem) Redactem is php package for redacting values from json. If you need to scrub out passwords or credit card numbers, or the value of any key/value pair identified by key or regular expression, from a string of json before writing it to disk or db, Redactem can do that. Redactem was developed as an internal-use tool for [fruitbat studios](https://fruitbat.studio)/cloverhitch technologies/kludgetastic implementations. Install ------- [](#install) Redactem is installed via composer: ``` composer require gbhorwood/redactem ``` Then, in your script, require and use: ``` require __DIR__ . '/vendor/autoload.php'; use Gbhorwood\Redactem\Redact; ``` Features -------- [](#features) Redactem finds and replaces values in json with a chosen or default redaction text. Replacements are done to an arbitrary depth in nested strucutres. Valid json stored as strings is also processed. Finding values to redact can be done by key name, case sensitive or insensitive, or by regular expression matches on values. Redactem offers convenience methods to redact passwords, credit card number, or emails, but also allows you to write your own rulesets. Before basic password redaction: ``` { "password": "redactme", "somearray": { "password": "redactme" }, "somestring": "{\"password\": \"redactme\"}" } ``` After: ``` { "password": "*****", "somearray": { "password": "*****" }, "somestring": "{\"password\":\"*****\"}" } ``` Redacting passwords ------------------- [](#redacting-passwords) Redacting passwords can be done with the `passwords()` convenience method: ``` $redactedJson = \Gbhorwood\Redactem\Redact::passwords($originalJson); ``` This method redacts all values keyed with the following: - `pwd` - `pass` - `psswd` - `password` - `pwd_repeat` - `repeat_pwd` - `pass_repeat` - `repeat_pass` - `passwd_repeat` - `repeat_passwd` - `password_repeat` - `repeat_password` If you have password data that is keyed with a different key than listed, you can use the `byKey()` method. Password values are replaced by default with '`*****`' (five asterisks). If you would like to set a custom redaction text, `passwords()` takes a redaction text as an optional second argument. ``` $redactedJson = \Gbhorwood\Redactem\Redact::passwords($originalJson, 'REDACTED'); ``` Redacting credit card numbers ----------------------------- [](#redacting-credit-card-numbers) Redacting credit card numbers can be done with the `creditcards()` convenience method: ``` $redactedJson = \Gbhorwood\Redactem\Redact::creditcards($originalJson); ``` Credit card numbers are identified by a regular expression that matches major credit card vendor's patterns. Credit card values are replaced with a redaction text of asterisks the length of the credit card number. If you would like to set a custom redaction text, `creditcards()` takes a redaction text as an optional second argument. ``` $redactedJson = \Gbhorwood\Redactem\Redact::creditcards($originalJson, 'REDACTED'); ``` Redacting emails ---------------- [](#redacting-emails) Redacting email addresses can be done with the `emails()` convenience method: ``` $redactedJson = \Gbhorwood\Redactem\Redact::emails($originalJson); ``` Email address are matched using php's `filter_var()` function with `FILTER_VALIDATE_EMAIL`. Email values are replaced with a partial redaction of the email, allowing it to be recognized by readers that already know the email address. For instance, the email address `gbhorwood@example.ca` would be redacted as `gb*****od@ex***le.ca`. If you would like to set a custom redaction text, `emails()` takes a redaction text as an optional second argument. ``` $redactedJson = \Gbhorwood\Redactem\Redact::emails($originalJson, 'REDACTED'); ``` Custom redactions by key ------------------------ [](#custom-redactions-by-key) Redactions can be done by specifying a key of a key/value pair to redact: ``` $redactedJson = \Gbhorwood\Redactem\Redact::byKey($originalJson, 'somekey'); ``` By default, keys are treated as *case insensitive*. If you wish to enable case sensitivity, pass true as an optional third argument ``` $redactedJson = \Gbhorwood\Redactem\Redact::byKey($originalJson, 'SomeKey', true); ``` The default behaviour is to redact values with the default redaction text of `*****` (five asterisks). A custom redaction text can be supplied as an optional fourth argument ``` $redactedJson = \Gbhorwood\Redactem\Redact::byKey($originalJson, 'somekey', true, 'REDACTED'); ``` Redactions can be done for multiple keys by calling `byKeys` and passing an array of keys: ``` $redactedJson = \Gbhorwood\Redactem\Redact::byKeys($originalJson, ['somekey', 'otherkey'], true, 'REDACTED'); ``` The `byKeys` method behaves identically to the `byKey` method, the only difference being the second argument is an array of keys. Custom redactions by regex -------------------------- [](#custom-redactions-by-regex) Redactions can be done by supplying a regular expression to match values to redact ``` $redactedJson = \Gbhorwood\Redactem\Redact::byRegex($originalJson, '/someregex/'); ``` Regular expressions supplied to `byRegex()` are matched against values using php's `preg_match()`. The default behaviour is to redact values with the default redaction text of `*****` (five asterisks). A custom redaction text can be supplied as an optional third argument ``` $redactedJson = \Gbhorwood\Redactem\Redact::byRegex($originalJson, '/someregex/', 'REDACTED'); ``` Writing custom redaction rules ------------------------------ [](#writing-custom-redaction-rules) Redactem's behaviour can be customized by using the base function `redact()`. The `redact()` function accepts three arguments: - `$json` A string of the json to redact - `$shouldRedact` A callable that accepts two arguments, the `$key` and the `$value` of the key/value pair to test for redaction, and returns a boolean. A return value of `true` means the value should be redacted. - `$redactionText` A callable that accepts one argument, the `$value` of the key/value pair, and returns a string. The returned string is the redaction text to put in place of the value. A usage example is: ``` /** * A function to test if a key/value pair should be redacted * Here, if the key is equal to 'secret' and the value is only digits. * @param String|Int $k The key of a key/value pair * @param String|Int $v The value of a key/value pair * @return bool */ $shouldRedact = fn ($k, $v) => (bool)($k == 'secret' && preg_match('/^[0-9]*$/', (string)$v)); /** * A function to build the redaction text for a value * Here, a string of exclamation marks the length of the string being redacted * @param String|Int $v The value of a key/value pair * @return String */ $redactionText = fn ($v) => join(array_fill(0, strlen((string)$v), '!')); $redactedJson = Redact::redact($originalJson, $shouldRedact, $redactionText); ``` This example will accept input of json that looks like: ``` { "name": "jasvinder", "secret": "astring", "somearray": { "secret": 1234 } } ``` And return: ``` { "name": "jasvinder", "secret": "astring", "somearray": { "secret": "!!!!" } } ``` ### Health Score 28 — LowBetter than 54% of packages Maintenance27 Infrequent updates — may be unmaintained Popularity15 Limited adoption so far Community9 Small or concentrated contributor base Maturity52 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 897d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/7f7dcdf4177429b5fe58779020bf49ec7531bfa9e48d2431d591ec9ca4d61485?d=identicon)[gbhorwood](/maintainers/gbhorwood) --- Top Contributors [![gbhorwood](https://avatars.githubusercontent.com/u/4615659?v=4)](https://github.com/gbhorwood "gbhorwood (19 commits)") ### Code Quality TestsPHPUnit Static AnalysisPHPStan Type Coverage Yes ### Embed Badge ![Health badge](/badges/gbhorwood-redactem/health.svg) ``` [![Health](https://phpackages.com/badges/gbhorwood-redactem/health.svg)](https://phpackages.com/packages/gbhorwood-redactem) ``` ### Alternatives [richardhj/contao-backup-manager Wrapper extension for backup-manager. 1412.9k](/packages/richardhj-contao-backup-manager) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)