log-redacter

log-redacter is a small command line utility (~500kb) that lets you redact logs coming from stdin. It is useful in situations where you can't deploy a more wide scale log redaction solution.

Originally this was written in nodejs/bun, and I still have the build files and implementation under node and bun, respectively. However I found that quickjs produced smaller and faster binaries, so that's the implementation I recommend.

Example Usage

echo "AbacdeoPqRsi" | log-redacter
# <REDACTED 3.585>
echo "111-11-1111" | log-redacter
# <REDACTED Social Security Number>

Config

To use the config, pass in a js file as the first argument with the default export being the config. Example:

test-config.mjs

export default {
  customPatterns: {
    "Phone Number": /\d{3}-\d{3}-\d{4}/,
  },
};

echo "123-456-8901" | log-redacter test-config.mjs
# <REDACTED PATTERN Phone Number>

Name	Description	Type	Default
entropyTolerance	Minimum "randomness"/entropy allowed. Only strings above this threshold will be shown.	`number`	`3.4`
highEntropyRedaction	How high entropy text should be redacted	`(entropyLevel: string) => string`	(entropyLevel: string) => `<REDACTED ENTROPY ${entropyLevel}>`
splitLinesPattern	How lines should be split before calculating the text's entropy.	`RegExp \| string`	`/(\s+\|(?=[A-Z][a-z]{4,})\|\_\|\.\|\/\|-)/`
disableDefaultPatterns	Disable the default redaction patterns, which can be found here	`boolean`	`false`
customPatterns	Custom patterns that you'd like to redact against	`{[patternName: string]: string \| RegExp;}`	`{}`
patternMatchedRedaction	How high entropy text should be redacted	`(patternName: string) => string`	(entropyLevel: string) => `<REDACTED ENTROPY ${entropyLevel}>`

nickdeis/log-redacter

ErrorLooks like something went wrong!

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Languages

Error
Looks like something went wrong!

Packages