Correctly hiding database credentials Correctly hiding database credentials mongoose mongoose

Correctly hiding database credentials


...I have my db connection file and another "protected" file, where my credentials are, and this file is included in .gitignore. I import it and reach the data..

The correct way to do it is to use envrironmental variables.

Use environmental variables

Environmental variables are set on the environment, i.e your local development machine or the remote production server.Then, within your app, you read the environment variables and use them appropriately.

There's (at least) a couple reasons it's usually done like this:

  • The credentials don't exist in a file that can be read by someone viewing the repository contents. Someone cloning the repository doesn't need to know your database credentials.
  • The credentials are likely different between environments. You are likely using a different database on your local development machine and a different database in your remote production server.

Here's how you set environment variables (this is for Linux, other OS's might be different):

$ export MONGO_DB_USERNAME=foo$ export MONGO_DB_PASSWORD=bar

and here's how you read them within Node.js:

console.log(process.env.MONGO_DB_USERNAME) // logs 'foo'console.log(process.env.MONGO_DB_PASSWORD) // logs 'bar'

or pass variables to the process when starting up

Alternatively, you can pass variables when starting up the process like so:

$ MONGO_DB_USERNAME=foo MONGO_DB_PASSWORD=bar node app.js

However that's generally discouraged since you're most probably starting your process through the npm start script. Since package.json, where the npm start command is defined, is always committed to the repository it defeats the whole purpose of hiding the credentials.


Like you mentioned along lines, using environment variables is more like security through obfuscation.

I would try to have the credentials in a separate configuration file. With a bit of design, encrypt this file and store those keys in secure enclaves or TPMs.

Check this thread.