Skip to content
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

Allow username to be specified in persistence secrets #601

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

dcaputo-harmoni
Copy link

What was changed

This commit allows the username to be specified alongside the password in persistence credentials secrets.

Why?

Many dynamic database creds generation / rotation systems (such as Hashicorp Vault) generate both the username and password dynamically, which is more secure than just generating / rotating passwords. The functionality has been updated to allow either or both of these to be optionally set via a secret with any or both of username and password keys.

@dcaputo-harmoni dcaputo-harmoni requested a review from a team as a code owner October 26, 2024 13:55
@robholland
Copy link
Contributor

This is a backwards incompatible change. While we can consider optionally storing the username in a secret, I don't want to force that.

@robholland robholland added the needs revision Team has requested some changes label Nov 5, 2024
@dcaputo-harmoni
Copy link
Author

@robholland There are two commits that are part of this PR, in the second one I added username to server-secret.yaml (in the same manner as password) - does that not make it backwards compatible such that if password is specified directly it will be included in the secret? If not, let me know what you're looking for here and I'd be happy to revise it.

@4FunAndProfit
Copy link

I can confirm that it would be great to have this! It blocks me too so it must block quite a few :)

@robholland
Copy link
Contributor

I mean I'm not sure everyone wants their username in a secret. While I can see a use case for that when credentials are being rotated, I think it's unusual to put usernames into a secret. Is their prior art for this in other charts?

@dcaputo-harmoni
Copy link
Author

@robholland the necessity for the username to be part of the secret is that in systems that make use of advanced security / identity and access management, database creds are automatically and frequently rotated, with usernames rotating as well. Rotating usernames greatly increases security, because a threat would not know the username to be able to try passwords, and if they did gain access to a username it would only be valid for a limited time.

The best-in-class security frameworks such as Hashicorp Vault use this principle, here is a reference to vault's database creds rotation engine.

And here is a reference that shows how creds (both usernames and passwords) are automatically rotated in a kubernetes environment using VaultDynamciSecrets, which generate kubernetes secrets with the credentials.

There are plenty of other enterprise apps with helm deployments that support this architecture, a couple that come to mind which we use are grafana and jenkins, the latter actually has a pretty unique way of doing it where you annotate the secrets to specify which field contains the username and which contains the password, but that's likely overkill for this application as in their case they built it to manage a large number of credentials, whereas here we only have a couple to manage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs revision Team has requested some changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants