coder
coder copied to clipboard
Workspace Insights: Mask / Hide Parameters usage
Is there an option to hide or mask coder_parameter which might be sensitive in the Workspace template insights?
Order of preference:
- option to hide
coder_parameterfrom workspace template insights - option to mask sensitive
coder_parameterin general - native user level secret management
Related to https://github.com/coder/terraform-provider-coder/issues/194
We should do this. Thanks @michaelbrewer!
I am up for any kind of solution that can be done in the short term:
ephemeralmight be a way to allow for sensitive values to be passed with without being stored, but the end-user will need to re-enter them on restarts.hiddentype of option to not include in insightsmasked/sensitiveto ensure it is never shown logs, insights etcsecretwould be ideal, but will depend on some kind of vault integration.
@michaelbrewer why do you want to use a coder_parameter for this? If its a sensitive and fixed for each user or can be fetched via an API, then a better way to do it is by using a secret management service like vault.
For insights there should at least be a way for coder_parameters to be opted out of the insights "Parameters usage", whether they are secrets or sensitive fields.
Some secrets only an end-user will know. So user level secret management would work, whether we do this via a Hashicorp value or AWS KMS or AWS Secret Manager, would be fine. Yes, the fact the end-user even needs to know a secret is probably not good. But sometimes where is no way round it, and this would be user-scoped secrets, and not service user accounts for deployments.
In some cases, integration could be handled at the provider level (like nexus) or via OpenID Connect level like Git and Artifactory.
Regarding a template:
- terraform variables is not always an option, as these are user scoped creds.
- openid connect is not always available
- coder_parameter do allow user input fields, but can't be hidden, masked or encrypted.
- template parameter that can reference secrets scoped to a user would be great
I have logged and voted for various related issues, but this feature exposes all coder_parameters in a single api call or page.
This is a great request we get pretty frequently. Will be a part of our Magic Parameters effort.
@stirby for prio.
this is now possible when used with styling = "mask_input" on coder_parameter
Docs here: https://coder.com/docs/admin/templates/extending-templates/dynamic-parameters#available-styling-options
Although the values are not actually stored securely.