sops-decoder
v0.10.3
Published
SOPS Decoder for JavaScript (Node)
Downloads
6,144
Readme
SOPS Decoder for JavaScript (Node)
This is a decoder for SOPS encoded files. This lightweight encoder makes it easy to embed in your AWS Lambda functions or Docker images without having to bring along the whole Go package.
Note: The decodeFile()
method only supports JSON input.
Installation
npm install --save sops-decoder
Quick Start
const sopsDecode = require('sops-decoder');
try {
const data = await sopsDecode.decodeFile('secure.enc.json');
// do something with the data
console.log(JSON.stringify(data, undefined, 2));
} catch (err) {
// Handle the error (SopsException)
console.log(err);
}
API
interface Tree {
[key: string]: any;
}
//
// Take the given path as JSON and read the file contents and then call decode on the result
//
decodeFile(path: string): Promise<Tree>
//
// Run the given tree through the SOPS decoder and return a "plaintext" version of the
// result
//
decode(tree: Tree): Promise<Tree>
TODO
- [ ] Unit Testing
- [ ] PGP Key support
- [ ] GCP Support
- [ ] Azure support