docs: add get key permission requirement for Azure Key Vault when version is omitted#2122
Open
Hanashiko wants to merge 1 commit intogetsops:mainfrom
Open
docs: add get key permission requirement for Azure Key Vault when version is omitted#2122Hanashiko wants to merge 1 commit intogetsops:mainfrom
Hanashiko wants to merge 1 commit intogetsops:mainfrom
Conversation
Contributor
felixfontein
left a comment
There was a problem hiding this comment.
Thanks for your contribution! Please note that you must sign-off your commits, otherwise this cannot be merged. Thanks.
| $ az keyvault key show --name sops-key --vault-name $keyvault_name --query key.kid | ||
|
|
||
| https://sops.vault.azure.net/keys/sops-key/some-string | ||
| .. note:: |
Contributor
There was a problem hiding this comment.
Suggested change
| .. note:: | |
| .. note:: |
|
|
||
| https://sops.vault.azure.net/keys/sops-key/some-string | ||
| .. note:: | ||
| The ``get`` key permission is required when the key version is ommited (i.e the URL ends with a trailing slash). In that case SOPS calls the Azure Key Vault API to resolve the latest key version, which requires the ``get`` permission. If you specifty an explicit key version in the URL you can omit ``get``, but this means you will need to update your configuration every time the key is rotated. |
Contributor
There was a problem hiding this comment.
Suggested change
| The ``get`` key permission is required when the key version is ommited (i.e the URL ends with a trailing slash). In that case SOPS calls the Azure Key Vault API to resolve the latest key version, which requires the ``get`` permission. If you specifty an explicit key version in the URL you can omit ``get``, but this means you will need to update your configuration every time the key is rotated. | |
| The ``get`` key permission is required when the key version is ommited (for example if the URL ends with a trailing slash). In that case SOPS calls the Azure Key Vault API to resolve the latest key version, which requires the ``get`` permission. If you specifty an explicit key version in the URL you can omit ``get``, but this means you will need to update your configuration every time the key is rotated. |
Contributor
|
CI failures are unrelated, see #2123. |
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
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.
Summary
Fixes #2112
When the key version is omitted from the Azure Key Vault URL (trailing slash), SOPS resolves the latest key version via the Azure Key Vault API. This requires the
getkey permission in addition toencryptanddecrypt, which was not mentioned in the documentation.Changes:
gettot he recommendedaz keyvault set-policy --key-permissionscommandgetis needed and the trade-off with explicit versioning