summaryrefslogtreecommitdiff
path: root/cspell.json
diff options
context:
space:
mode:
authorMarc A. Paradise <marc.paradise@gmail.com>2021-06-24 14:15:28 -0400
committerMarc A. Paradise <marc.paradise@gmail.com>2021-07-07 17:05:56 -0400
commita0dccdfc0f6de92c18e2b733bca8efb2f8319c91 (patch)
tree61ddc4271792a1c32d97cc048eb1fbfd2052826a /cspell.json
parentf06e01da751ee8b963c4aab5f0a4c31fdc18ebcc (diff)
downloadchef-a0dccdfc0f6de92c18e2b733bca8efb2f8319c91.tar.gz
Add 'secret' to the Chef DSL
This is a proposed addition of a 'secret' helper to the Chef DSL, where a 'secret' is private data stored within a secrets management service. Usage would look like the following working example: ``` # The included ':example' secrets provider # requires that it be configured with a hash of secrets my_config = { "secret1" => "a hidden door" } file "/tmp/the-secret" do content secret(name: "secret1", service: :example, config: my_config) end ``` Initial constraints: * minimal-to-no abstraction over how services handle inputs, outputs, and errors. Each of these services has well-defined interfaces already, and there is much more different than the same across services. We may revisit this as we begin implementing a range of specific secrets fetchers. * no caching of results. * avoid 'provider' nomenclature. That's already well-used within Chef Infra. That's why a secrets 'service' has a SecretFetcher implementation and not a SecretProvider. Security Concerns: Because we don't provide an abstraction around the returned secret (there is not a specific single type of returned data we can rely on), if a secrets fetcher does not take steps to hide its own data from incidental output (logs, debug output, exceptions) then there is a risk of exposing this data to people and systems that have the ability to view the output. Signed-off-by: Marc A. Paradise <marc.paradise@gmail.com>
Diffstat (limited to 'cspell.json')
-rw-r--r--cspell.json1
1 files changed, 1 insertions, 0 deletions
diff --git a/cspell.json b/cspell.json
index 614bb8f06d..751a40e597 100644
--- a/cspell.json
+++ b/cspell.json
@@ -1434,6 +1434,7 @@
"secoption",
"secopts",
"secp",
+ "secretkey",
"securerandom",
"SECURITYPOLICY",
"secvalue",