docs: ADR-0004: authentication types and encrypted secrets #104
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Jonathan Howard <jonathan.w.howard@lmco.com>
|
Can you talk to what the user experience would be? Are you think that if a encrypted password is accessed, the user would be prompted for a decrypt key? I see the benefits of SOPS to encrypt secrets that are stored in version control or other configuration files stored outside of a deployed environment. If the intent would be for the keypair or master key is stored on the same system as the bomctl config, I think the security benefits would be negated. @eddiezane @ashearin what are your thoughts? |
|
Per working group session 8/5/24. For now leave as proposed, be reevaluated for a future release. |
ashearin
approved these changes
Nov 25, 2024
lmphil
approved these changes
Nov 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
4. Authentication types and secrets encryption
Date: 2024-07-11
Status
Proposed
Context
Additional authentication mechanisms and secure secrets storage should be supported.
Decision
Add support for additional authentication mechanisms:
Secrets provided as plain text will be encrypted with a user-provided or auto-generated key pair.
Add a config file mapping of URLs or bare hostnames to associated user credentials.
auto-generate a new key pair
Either leverage the SOPS tool as a library to perform the encryption/decryption,
or use its encrypted string expression form.
Example of proposed config file additions:
Consequences
These changes will increase flexibility for users by allowing fetching from and pushing to additional
remote endpoints that may have limited or strict options for authentication. They will also provide
enhanced security options for local storage and transmission of secrets.