@kevboutin/azure-middy-keyvault-secrets NPM

azure-middy-keyvault-secrets

Azure Key Vault Secrets middleware for the azure-middy framework, the Node.js middleware engine for Azure functions.

Install

To install the this middleware, you can use NPM:

npm install --save @kevboutin/azure-middy-keyvault-secrets

Prerequisites

Node.js >= 18
An Azure Function App
An Azure Key Vault instance
Proper Azure credentials configured (using DefaultAzureCredential)

Usage

The middleware provides Azure Key Vault secrets management for your Azure Functions:

const { app } = require("@azure/functions");
const middy = require("@kevboutin/azure-middy-core");
const {
    keyvaultSecretsMiddleware,
} = require("@kevboutin/azure-middy-keyvault-secrets");

// Your handler
const baseHandler = async (req, context) => {
    // Your business logic here
    // Secrets are available in req.internal
    return {
        body: JSON.stringify({ message: "Success" }),
    };
};

// Wrap handler with middy
const handler = middy(baseHandler).use(
    keyvaultSecretsMiddleware({
        vaultUrl: "https://your-vault.vault.azure.net",
        fetchData: {
            apiKey: "api-key-secret-name",
            dbPassword: "db-password-secret-name",
        },
        cacheExpiry: 300000, // Cache for 5 minutes (optional)
    }),
);

module.exports = { handler };

app.http("yourFunction", {
    route: "your-route",
    methods: ["GET"],
    authLevel: "anonymous",
    handler: handler,
});

API

keyvaultSecretsMiddleware(opts = {})

Creates a middleware instance with the following options:

opts.vaultUrl (required): The URL of your Azure Key Vault (e.g., "https://your-vault.vault.azure.net")
opts.fetchData (required): Object mapping of local names to Key Vault secret names
opts.cacheKey (optional): Custom cache key for storing secrets (default: "secrets")
opts.cacheExpiry (optional): How long to cache secrets in milliseconds (default: 0, no cache)