Skip to content

Hide secret parameters in workspace creation and template insights #13472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
michaelbrewer opened this issue Jun 4, 2024 · 6 comments
Open

Comments

@michaelbrewer
Copy link
Contributor

michaelbrewer commented Jun 4, 2024

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_parameter from workspace template insights
  • option to mask sensitive coder_parameter in general
  • native user level secret management
@coder-labeler coder-labeler bot added feature waiting-for-info The issue creator is asked to provide more information. labels Jun 4, 2024
@michaelbrewer
Copy link
Contributor Author

Related to coder/terraform-provider-coder#194

@kylecarbs
Copy link
Member

We should do this. Thanks @michaelbrewer!

@michaelbrewer
Copy link
Contributor Author

michaelbrewer commented Jun 5, 2024

I am up for any kind of solution that can be done in the short term:

  • ephemeral might 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.
  • hidden type of option to not include in insights
  • masked / sensitive to ensure it is never shown logs, insights etc
  • secret would be ideal, but will depend on some kind of vault integration.

@matifali
Copy link
Member

matifali commented Jun 5, 2024

@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.

@michaelbrewer
Copy link
Contributor Author

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.

@matifali matifali removed the waiting-for-info The issue creator is asked to provide more information. label Jun 6, 2024
@matifali matifali removed the feature label Oct 14, 2024
@stirby stirby changed the title Workspace Insights: Mask / Hide Parameters usage Hide secret parameters from form and template insights Oct 25, 2024
@stirby stirby mentioned this issue Oct 25, 2024
8 tasks
@stirby
Copy link
Collaborator

stirby commented Oct 25, 2024

This is a great request we get pretty frequently. Will be a part of our Magic Parameters effort.

@stirby stirby changed the title Hide secret parameters from form and template insights Hide secret parameters in workspace creation form and template insights Oct 25, 2024
@stirby stirby changed the title Hide secret parameters in workspace creation form and template insights Hide secret parameters in workspace creation and template insights Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants