Skip to content
A distributed maintained collection of patterns that indicate that something probably is secret
Branch: master
Clone or download
Latest commit 563cce4 Oct 27, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
.npmignore chore: add .npmignore Oct 27, 2018
.travis.yml
LICENSE
README.md
index.js
package.json 1.2.1 Oct 27, 2018
test.js

README.md

is-secret

A distributed maintained collection of patterns that indicate that something probably is secret.

This is useful if you want to filter sensitive values in a data set.

This module uses a very simple algorithm that will not catch everthing. Use at your own risk.

npm Build status js-standard-style

Installation

npm install is-secret --save

Usage

var isSecret = require('is-secret')

var data = {
  username: 'watson',
  password: 'f8bY2fg8',
  card: '1234 1234 1234 1234' // credit card number
}

Object.keys(data).forEach(function (key) {
  if (isSecret.key(key) ||
      isSecret.value(data[key])) data[key] = '********'
})

console.log(data)
// {
//   username: 'watson',
//   password: '********',
//   card: '********'
// }

If you need functionality similar to what is shown in this example, I suggest you take a look at the redact-secrets module.

API

secret.key(string)

Validates the given string against a list of key names known to typically indicate secret data.

Returns true if the string is considered secret. Otherwise false.

secret.value(string)

Validates the given string against a list of patterns that indicates secret data.

Returns true if the string is considered secret. Otherwise false.

License

MIT

You can’t perform that action at this time.