npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fastify-secrets-vault

v1.1.1

Published

Fastify secrets plugin for HashiCorp's Vault

Downloads

9

Readme

Fastify Secrets Vault

js-semistandard-style

Fastify secrets plugin for HashiCorp's Vault.

Install

npm install --save fastify-secrets-vault

Usage

You can register the plugin in your fastify instance and provide options for vault.

const fastify = require('fastify')();
const secretsPlugin = require('fastify-secrets-vault');

...

fastify.register(secretsPlugin, {
  secrets: {
    mongo_password: '/path/to/secret',
    redis_password: {
      path: 'path/to/secret',
      key: 'master-key' // it can support and array of keys ['key1','key2']
    }
  },
  vaultOptions: {
    token: '*****', //optional token for authenticating requests to vault
    endpoint: 'http://127.0.0.1:8200'
  }
});

await fastify.ready();

...

API

Register options

  • namespace: (optional) The plugin will add the secret values to fastify.secrets[namespace]

  • concurrency: (optional) How many concurrent secrets you can retrieve. Default value: 5

  • secrets: (required) An object representing a map of secret keys and references. It can be either in the form of:

    • redis_password: '/path/to/secret'

    or

    • If you want only a specific key
    redis_password: {
        path: '/path/to/secret/',
        key: 'main_token'
    }

    or

    • If you want to get multiple keys
    redis_password: {
        path: '/path/to/secret/',
        key: ['main_token','secondary_token']
    }

    Then you can access your secrets with fastify.secrets.main_token.

  • vaultOptions

    • secretsEngineVersion: (optional) Vault KV Secrets Engine can operate in two modes v1 and v2. Default value: v2.
    • endpoint: (optional) Endpoint for reaching vault server. Default value: http://127.0.0.1:8200.
    • token: (optional) Token to authenticate requests with.
    • authentication: (optional) This can be provided instead of token. It's a way of retrieving a token. Currently supported ldap.

Authentication

Ldap

{
   method: 'ldap',
   credentials: {
     password: '*****',
     username: 'username'
   }
}

Approle

{
   method: 'approle',
   credentials: {
     roleId: 'xxxxx-xxxxxx-xxxxxx-xxxxxx',
     secretId: 'xxxxxx-xxxxxx-xxxxxxx-xxxxxx'
   }
}

Typescript

In order to use this plugin you need to enable the flag "esModuleInterop": true in tsconfig.json.

then you can import it

import secretsPlugin from 'fastify-secrets-vault';

If you want to have the secrets values into fastify (e.g. fastify.secrets.main_token) you can create a types.ts containing

import 'fastify';

declare module 'fastify' {
    interface FastifyInstance {
        secrets: {
            mongo_password: string;
            redis_password: string;
        };
    }
}

and then import './types.' to your server.

Acknowledgements

This package follows the structure of fastify-secrets-core. There is another package for Vault published in Nearform, fastify-secrets-hashicorp.

Example

You can also check an example usage.

Issues

For any issues.

License

MIT License