397 - HashiCorp Vault support for database secrets #398
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| package hashivault | ||
ilmarkerm marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| import ( | ||
| "context" | ||
| "os" | ||
| "strings" | ||
| "errors" | ||
| "net" | ||
| "net/http" | ||
| "time" | ||
|
|
||
| "github.com/prometheus/common/promslog" | ||
| vault "github.com/hashicorp/vault/api" | ||
| ) | ||
|
|
||
| //var FailedConnect = errors.New("Failed to connect to HashiCorp Vault") | ||
ilmarkerm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| var UnsupportedMountType = errors.New("Unsupported HashiCorp Vault mount type") | ||
| var RequiredKeyMissing = errors.New("Required key missing from HashiCorp Vault secret") | ||
|
|
||
| type HashicorpVaultClient struct { | ||
| client *vault.Client | ||
| } | ||
|
|
||
| func newUnixSocketVaultClient(socketPath string) (*vault.Client, error) { | ||
| // Create a custom HTTP client using the Unix socket | ||
ilmarkerm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| httpClient := &http.Client{ | ||
| Transport: &http.Transport{ | ||
| DialContext: func(_ context.Context, _, _ string) (net.Conn, error) { | ||
| return net.Dial("unix", socketPath) | ||
| }, | ||
| }, | ||
| Timeout: 10 * time.Second, | ||
| } | ||
|
|
||
| // Configure the Vault client | ||
| config := &vault.Config{ | ||
| Address: "http://unix", | ||
| HttpClient: httpClient, | ||
| Timeout: 10 * time.Second, | ||
| MinRetryWait: time.Millisecond * 1000, | ||
| MaxRetryWait: time.Millisecond * 1500, | ||
| MaxRetries: 2, | ||
| //Backoff: retryablehttp.LinearJitterBackoff, | ||
ilmarkerm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| client, err := vault.NewClient(config) | ||
ilmarkerm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return client, nil | ||
| } | ||
|
|
||
| func createVaultClient(socketPath string) (HashicorpVaultClient,error) { | ||
| /* | ||
| Connects client to Vault backend, need to handle different connection methods in the future | ||
| */ | ||
| promLogConfig := &promslog.Config{} | ||
| logger := promslog.New(promLogConfig) | ||
|
||
|
|
||
| var vaultClient HashicorpVaultClient | ||
| var err error | ||
|
|
||
| if socketPath != "" { | ||
| // Create Vault client that uses Unix Socket | ||
| vaultClient.client, err = newUnixSocketVaultClient(socketPath) | ||
| } | ||
| if err != nil { | ||
| logger.Error("Failed to connect to HashiCorp Vault", "err", err) | ||
| } | ||
| return vaultClient,err | ||
| } | ||
|
|
||
| func CreateVaultClient(socketPath string) HashicorpVaultClient { | ||
| // Public callable function that does not return an error, just exits instead. Like other vault code in this project. | ||
| c,err := createVaultClient(socketPath) | ||
| if err != nil { | ||
| os.Exit(1) | ||
ilmarkerm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
| return c | ||
| } | ||
|
|
||
| func (c HashicorpVaultClient)getVaultSecret(mountType string, mount string, path string, requiredKeys []string) (map[string]string,error) { | ||
ilmarkerm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| // Proper code that returns and error and is testable | ||
| // Currently only supports key-value stores, but it should support more in the future | ||
| promLogConfig := &promslog.Config{} | ||
| logger := promslog.New(promLogConfig) | ||
|
|
||
| result := map[string]string{} | ||
| var err error | ||
| if mountType == "kvv2" || mountType == "kvv1" { | ||
|
There was a problem hiding this comment. is there a vault const for these? There was a problem hiding this comment. No, these are just strings I made up. Vault has multiple plugins to handle secrets, "kvv1" and "kvv2" are the simplest key-value secret stores. I'll also soon work on adding the "database" secret store type. They all need slightly different SDK calls. |
||
| // Handle simple key-value secrets | ||
| var secret *vault.KVSecret | ||
| logger.Info("Making call to HashiCorp Vault", "mountType", mountType, "mountName", mount, "secretPath", path, "expectedKeys", requiredKeys) | ||
| if mountType == "kvv2" { | ||
| secret, err = c.client.KVv2(mount).Get(context.TODO(), path) | ||
| } else { | ||
| secret, err = c.client.KVv1(mount).Get(context.TODO(), path) | ||
| } | ||
| if err != nil { | ||
| logger.Error("Failed to fetch secret from HashiCorp Vault", "err", err) | ||
| return result, err | ||
| } | ||
| // Expect simple one-level JSON, remap interface{} straight to string | ||
| for key,val := range secret.Data { | ||
| result[key] = strings.TrimRight(val.(string), "\r\n") // make sure a \r and/or \n didn't make it into the secret | ||
| } | ||
| } else { | ||
| logger.Error(UnsupportedMountType.Error()) | ||
| return result, UnsupportedMountType | ||
| } | ||
| // Check that we have all required keys present | ||
| for _, key := range requiredKeys { | ||
| val, keyExists := result[key] | ||
| if !keyExists || val == "" { | ||
| logger.Error(RequiredKeyMissing.Error(), "key", key) | ||
| return result, RequiredKeyMissing | ||
| } | ||
| } | ||
| // | ||
ilmarkerm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| return result, nil | ||
| } | ||
|
|
||
| func (c HashicorpVaultClient)GetVaultSecret(mountType string, mount string, path string, requiredKeys []string) map[string]string { | ||
ilmarkerm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| // Public callable function that does not return an error, just exits instead. Like other vault code in this project. | ||
| res,err := c.getVaultSecret(mountType, mount, path, requiredKeys) | ||
| if err != nil { | ||
| os.Exit(1) | ||
ilmarkerm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
| return res | ||
| } | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.