node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org »

safe-env

safe-env

Returns all environment variables with sensitive values hidden, great for logs

NPM

Build status semantic-release js-standard-style

When you start the server, and something does not work, are you sure that all expected environment variables were set correctly? Can you quickly dump them to a console or send them to the logging service? Can you hide the sensitive information, like passwords or tokens?

Example

const safeEnv = require('safe-env')
const sensitive = ['TOKEN', 'API-KEY']
console.log(safeEnv(sensitive))
/*
{
  FOO: 'foo value',
  BAR: 'bar value',
  TOKEN: '<hidden>'
}
*/

Seems we forgot to set API-KEY!

Options

You can pass an object to be filtered instead of using process.env

const result = safeEnv(sensitive, myObject)

Details

  • Only all uppercase keys from process.env are printed, filtering out lots of noise, like npm_... keys.
  • There is a default list of sensitive keys, if you do not pass any.
  • Only top level properties are replaced

Custom predicate function

You can pass a custom predicate function that returns true based on the property name to filter custom values. For example to hide all properties with string 'token' in them

const o = {
  foo: 42,
  myToken: 'secret',
  'another-token': 'very secret'
}
const tokenName = (key) => key.toLowerCase().indexOf('token') !== -1
const out = safeEnv(tokenName, o)
// out has both 'myToken' and 'another-token' values replaced 
// with '<hidden>' 

Small print

Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2016

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2016 Gleb Bahmutov <gleb.bahmutov@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.