/Secret-Pipes

JS Project Secrets Management and Isolation

Primary LanguageJavaScriptMIT LicenseMIT

Secret-Pipes

Application Secrets Management and Isolation

For Node.js projects, or any software accepting STDIN

As the name suggests, SECRET-PIPES is a framwork to keep, manage, and aggrigate your secrets in an evironment only accessable to an elevated user, and only pipe your secrets at runtime to keep them as ephemiral as possile on your system and in your target application.

Most of the code is just here to provide a examples and a basic starting point.
Customize it and make it your own; implement runtime generation of your secrets, pull them from from encrypted vaults, and/or set up conditions to pass different secrets for different environments.

Use git or npm to get notified of changes to best practices and security changes/vulnerabilities. Or you can completely replicate this in a few lines of code.

Benefits over ENV or uncommited JSON files

Feature Secret-Pipes ENV/.ENV Static Imports
Generate new secrets at runtime ✔️ ❌ ❌
Aggrigate External Sources ✔️ ❌ ❌
Seperate Concerns By Process ✔️ ❌ ❌
Reduce global references ✔️ ❌ ❌
Encrypt Secrets at Rest ✔️ 〰️ 〰️
Restrict files with User/Group Permissions ✔️ 〰️ 〰️
Dereference/Remove secrets from memory if no longer needed ✔️ 〰️ 〰️

ToDo:

  • Add cli entrypoint for password encrypting secrets natively
  • NPM/CLI to Init directories/permissions
  • Find a means to place the secrets into protected memory, and only pass references/pointer and read permissions.

Table of Contents

Installation

Git

	cd /some/protected/directory

	git clone https://github.com/TecnicoCorp/Secret-Pipes.git

	# Place js scripts that export your secrets in ./secure

NPM module is WIP


Usage

Secrets files

	// ./secure/secret1.js
	exports.default = {
		mySecret:'some secret text'
	}
	// ./secure/someotherSecret.js
	const newSecret = function() {
		return 'some runtime secret';
	}
	exports.default = {
		// make sure you have globally unique names for all root-
		// level objects, by aliasing if nessecary. 
		mySecret2:newSecret()
	}

Application Imports

	// main.js or server.js or index.js
	'use strict';
	const fs = require('fs');
	let envTmp = fs.readFileSync(0).toString();
	envTmp = JSON.parse(envTmp);

	const someOtherModule = {middleware:{}};
	someOtherModule.middleware.secrets = envTmp.mySecret2;
	// Clear what you can from the top-level variables.
	envTmp.mySecret2 = undefined;

Node Execution

	# NPM start
	node ..\\secret-pipes\\lib\\secret.js | node server.js
	# NPM dev - Known issues with nodemon, see known issues
	nodemon -e js --exec \"node ..\\secret-pipes\\lib\\secret.js | node server.js\"

Run in Debug

VS Code lauch.json in Windows batch
	"version": "0.2.0",
	"configurations": [
		{
			"type": "node",
			"request": "launch",
			"name": "Run DEV",
			"runtimeExecutable": "${workspaceRoot}/run.bat"
		},
	]
	ECHO OFF
	node ..\secret-pipes\secret.js | node --inspect-brk=127.0.0.1:%2 server.js
VS Code lauch.json in Linux Bash
	"version": "0.2.0",
	"configurations": [
		{
			"type": "node",
			"request": "launch",
			"name": "Run DEV",
			"runtimeExecutable": "${workspaceRoot}/run.sh"
		},
	]
	#!/bin/bash
	node ..\secret-pipes\secret.js | node --inspect-brk=127.0.0.1:%2 server.js

Known Issues

  • Nodemon: Running in Nodemon seems to cause something to get cached such that if an error is thrown to Nodemon on a reload, it returns fs module errors until it is closed and some indeterminate amount of time passes before being started again. (The issue will be linked if this assertion holds true after an initial review)