Add HashiCorp Vault key manager plugin to SPIRE server #5500
+3,887
−28
Conversation
This file contains 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: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
…e#5058) Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
InverseIntegral
requested review from
evan2645 and
amartinezfayo
as code owners
InverseIntegral
requested review from
azdagron,
MarcosDY and
rturner3
as code owners
Signed-off-by: Matteo Kamm <[email protected]>
Signed-off-by: Matteo Kamm <[email protected]>
InverseIntegral
force-pushed
the
main
branch
from
77f7ce0
to
42bc673
Compare
There was a problem hiding this comment.
Hi @InverseIntegral, thank you very much for this contribution.
I'm still going over this PR, but the first high-level comment that I wanted to provide is that we will need integration tests that exercise this plugin. It should be a new suite added to our integration test framework: https://github.com/spiffe/spire/tree/main/test/integration
I'll be adding more comments as I make progress with the review :) Thank you again for this contribution!
| | client_key_path | string | | Path to a client private key file. Only PEM format is supported. | `${VAULT_CLIENT_KEY}` | | ||
|
|
||
| ```hcl | ||
| UpstreamAuthority "vault" { |
There was a problem hiding this comment.
Suggested change
| UpstreamAuthority "vault" { | |
| KeyManager "hashicorp_vault" { |
| | token | string | | Token string to set into "X-Vault-Token" header | `${VAULT_TOKEN}` | | ||
|
|
||
| ```hcl | ||
| UpstreamAuthority "vault" { |
There was a problem hiding this comment.
Suggested change
| UpstreamAuthority "vault" { | |
| KeyManager "hashicorp_vault" { |
| | approle_secret_id | string | | A credential of AppRole | `${VAULT_APPROLE_SECRET_ID}` | | ||
|
|
||
| ```hcl | ||
| UpstreamAuthority "vault" { |
There was a problem hiding this comment.
Suggested change
| UpstreamAuthority "vault" { | |
| KeyManager "hashicorp_vault" { |
| | token_path | string | ✔ | Path to the Kubernetes Service Account Token to use authentication with the Vault | | | ||
|
|
||
| ```hcl | ||
| UpstreamAuthority "vault" { |
There was a problem hiding this comment.
Suggested change
| UpstreamAuthority "vault" { | |
| KeyManager "hashicorp_vault" { |
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.
Pull Request check list
Affected functionality
This MR introduces a new SPIRE server key manager plugin that uses HashiCorp Vault to manage keys.
Description of change
This change adds a new key manager plugin to SPIRE server named
hashicorp_vault. It uses a transit secrets engine within HashiCorp Vault to manage keys and sign data. The client is largely based on the existing upstream authority plugin for HashiCorp Vault which was introduced in #1611 by @hiyosi.Which issue this PR fixes
This PR fixes #5058
Note that this is my first time implementing such a plugin and I expect there to be a lot of open questions and expected changes. I'm really looking forward to any feedback! ❤️