Nacho Pizza Marinade

    @sagacify/hush

    1.0.2 • Public • Published

    Hush

    CircleCI Coverage Status npm version Dependency Status

    Description

    Hush is a package meant to simplify secrets management in applications. It reads secrets injected via docker inside containers.

    Installation

    $ npm install @sagacify/hush

    Usage

    Import in your project

    const { readSecret } = require('@sagacify/hush');
    
    // Read secret AWS_ACCESS_KEY in the default docker secret injection folder
    const secret = readSecret('AWS_ACCESS_KEY');
    
    // Read secret AWS_ACCESS_KEY in a custom secret folder
    const secret = readSecret('AWS_ACCESS_KEY', 'path/to/my/custom/secret/folder/');

    API

    readSecret(fileName, secretsPath = '/run/secrets/')

    Arguments

    • fileName: the name of the file inside the secretsPath
    • secretsPath: path to the folder containing the secrets

    Returns

    • If the secret is empty or the file existing: returns null
    • Else: returns the secret

    Npm scripts

    Running code formating

    $ npm run format

    Running tests

    $ npm test

    Running lint tests

    $ npm run test:lint

    Running coverage tests

    $ npm run test:cover

    This will create a coverage folder with all the report in coverage/index.html

    Running all tests

    $ npm run test:all

    Note: that's the one you want to use most of the time

    Reporting bugs and contributing

    If you want to report a bug or request a feature, please open an issue. If want to help us improve hush, fork and make a pull request. Please use commit format as described here. And don't forget to run npm run format before pushing commit.

    Repository

    License

    The MIT License (MIT)

    Copyright (c) 2020 Sagacify

    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.

    Keywords

    Install

    npm i @sagacify/hush

    DownloadsWeekly Downloads

    1

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    6.01 kB

    Total Files

    4

    Last publish

    Collaborators

    • sagacify