ContextQMD
Back to Telegraf

Javascript Object Signing and Encryption Secret Store Plugin

plugins/secretstores/jose/README.md

1.39.01.9 KB
Original Source

Javascript Object Signing and Encryption Secret Store Plugin

This plugin allows to read local secrets from files protected by the Javascript Object Signing and Encryption algorithm.

⭐ Telegraf v1.25.0 🏷️ system 💻 all

Usage <!-- @/docs/includes/secret_usage.md -->

Secrets defined by a store are referenced with @{<store-id>:<secret_key>} the Telegraf configuration. Only certain Telegraf plugins and options of support secret stores. To see which plugins and options support secrets, see their respective documentation (e.g. plugins/outputs/influxdb/README.md). If the plugin's README has the Secret store support section, it will detail which options support secret store usage.

Configuration

toml
# Read secrets from Javascript Object Signing and Encryption file
[[secretstores.jose]]
  ## Unique identifier for the secret store.
  ## This id can later be used in plugins to reference the secrets
  ## in this secret store via @{<id>:<secret_key>} (mandatory)
  id = "secretstore"

  ## Directory for storing the secrets
  path = "/etc/telegraf/secrets"

  ## Password to access the secrets.
  ## If no password is specified here, Telegraf will prompt for it at startup time.
  # password = ""

Each secret is stored in an individual file in the subdirectory specified using the path parameter. To access the secrets, a password is required. This password can be specified using the password parameter containing a string, an environment variable or as a reference to a secret in another secret store. If password is not specified in the config, you will be prompted for the password at startup.

[!NOTE] All secrets in this secret store are encrypted using the same password. If you need individual passwords for each secret, please use multiple instances of this plugin.