Files
my-rook-config/pkg/daemon/ceph/osd/kms/vault.go
T
Arun Kumar Mohan 65d16bfc94 ceph: manual changes needed for kubernetes api updates
Fetched latest lib-bucket-provisioner changes as well.

Signed-off-by: Arun Kumar Mohan <amohan@redhat.com>
2020-11-18 21:14:01 +05:30

226 lines
7.3 KiB
Go

/*
Copyright 2020 The Rook Authors. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package kms
import (
"context"
"io/ioutil"
"strings"
"github.com/hashicorp/vault/api"
"github.com/libopenstorage/secrets"
"github.com/libopenstorage/secrets/vault"
"github.com/pkg/errors"
"github.com/rook/rook/pkg/clusterd"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
const (
// EtcVaultDir is vault config dir
EtcVaultDir = "/etc/vault"
)
var (
vaultMandatoryConnectionDetails = []string{api.EnvVaultAddress}
vaultTLSConnectionDetails = []string{api.EnvVaultCACert, api.EnvVaultClientCert, api.EnvVaultClientKey}
)
/* VAULT API INTERNAL VALUES
// Refer to https://pkg.golangclub.com/github.com/hashicorp/vault/api?tab=doc#pkg-constants
const EnvVaultAddress = "VAULT_ADDR"
const EnvVaultAgentAddr = "VAULT_AGENT_ADDR"
const EnvVaultCACert = "VAULT_CACERT"
const EnvVaultCAPath = "VAULT_CAPATH"
const EnvVaultClientCert = "VAULT_CLIENT_CERT"
const EnvVaultClientKey = "VAULT_CLIENT_KEY"
const EnvVaultClientTimeout = "VAULT_CLIENT_TIMEOUT"
const EnvVaultSRVLookup = "VAULT_SRV_LOOKUP"
const EnvVaultSkipVerify = "VAULT_SKIP_VERIFY"
const EnvVaultNamespace = "VAULT_NAMESPACE"
const EnvVaultTLSServerName = "VAULT_TLS_SERVER_NAME"
const EnvVaultWrapTTL = "VAULT_WRAP_TTL"
const EnvVaultMaxRetries = "VAULT_MAX_RETRIES"
const EnvVaultToken = "VAULT_TOKEN"
const EnvVaultMFA = "VAULT_MFA"
const EnvRateLimit = "VAULT_RATE_LIMIT"
*/
// InitVault inits the secret store
func InitVault(context *clusterd.Context, namespace string, config map[string]string) (secrets.Secrets, error) {
c := make(map[string]interface{})
// So that we don't alter the content of c.config for later iterations
// We just want to swap the name of the TLS config secret name --> file name for the kms lib
oriConfig := make(map[string]string)
for k, v := range config {
oriConfig[k] = v
}
// Populate TLS config
newConfigWithTLS, err := configTLS(context, namespace, oriConfig)
if err != nil {
return nil, errors.Wrap(err, "failed to initialize vault tls configuration")
}
// Populate TLS config
for key, value := range newConfigWithTLS {
c[key] = string(value)
}
// Initialize Vault
v, err := vault.New(c)
if err != nil {
return nil, errors.Wrap(err, "failed to initialize vault secret store")
}
return v, nil
}
func configTLS(clusterdContext *clusterd.Context, namespace string, config map[string]string) (map[string]string, error) {
ctx := context.TODO()
for _, tlsOption := range vaultTLSConnectionDetails {
tlsSecretName := GetParam(config, tlsOption)
if tlsSecretName == "" {
continue
}
// If the string already has the correct path /etc/vault, we are in provisioner code and all the envs have been populated by the op already
if !strings.Contains(tlsSecretName, EtcVaultDir) {
secret, err := clusterdContext.Clientset.CoreV1().Secrets(namespace).Get(ctx, tlsSecretName, v1.GetOptions{})
if err != nil {
return nil, errors.Wrapf(err, "failed to fetch tls k8s secret %q", tlsSecretName)
}
// Generate a temp file
file, err := ioutil.TempFile("", "")
if err != nil {
return nil, errors.Wrapf(err, "failed to generate temp file for k8s secret %q content", tlsSecretName)
}
// Write into a file
err = ioutil.WriteFile(file.Name(), secret.Data[tlsSecretKeyToCheck(tlsOption)], 0444)
if err != nil {
return nil, errors.Wrapf(err, "failed to write k8s secret %q content to a file", tlsSecretName)
}
logger.Debugf("replacing %q current content %q with %q", tlsOption, config[tlsOption], file.Name())
// update the env var with the path
config[tlsOption] = file.Name()
} else {
logger.Debugf("value of tlsOption %q tlsSecretName is already correct %q", tlsOption, tlsSecretName)
}
}
return config, nil
}
func put(v secrets.Secrets, secretName, secretValue string, keyContext map[string]string) error {
// Build Secret
data := make(map[string]interface{})
data[secretName] = secretValue
// #nosec G104 Write the encryption key in Vault
err := v.PutSecret(secretName, data, keyContext)
if err != nil {
return errors.Wrapf(err, "failed to put secret %q in vault", secretName)
}
return nil
}
func get(v secrets.Secrets, secretName string, keyContext map[string]string) (string, error) {
// #nosec G104 Write the encryption key in Vault
s, err := v.GetSecret(secretName, keyContext)
if err != nil {
return "", errors.Wrapf(err, "failed to get secret %q in vault", secretName)
}
return s[secretName].(string), nil
}
func delete(v secrets.Secrets, secretName string, keyContext map[string]string) error {
// #nosec G104 Write the encryption key in Vault
err := v.DeleteSecret(secretName, keyContext)
if err != nil {
return errors.Wrapf(err, "failed to delete secret %q in vault", secretName)
}
return nil
}
func buildKeyContext(config map[string]string) map[string]string {
// Key context is just the Vault namespace, available in the enterprise version only
keyContext := map[string]string{secrets.KeyVaultNamespace: config[api.EnvVaultNamespace]}
vaultNamespace, ok := config[api.EnvVaultNamespace]
if !ok || vaultNamespace == "" {
keyContext = nil
}
return keyContext
}
// IsVault determines whether the configured KMS is Vault
func (c *Config) IsVault() bool {
return c.Provider == "vault"
}
func validateVaultConnectionDetails(clusterdContext *clusterd.Context, ns string, kmsConfig map[string]string) error {
ctx := context.TODO()
for _, option := range vaultMandatoryConnectionDetails {
if GetParam(kmsConfig, option) == "" {
return errors.Errorf("failed to find connection details %q", option)
}
}
// We do not support a directory with multiple CA since we fetch a k8s Secret and read its content
// So we operate with a single CA only
if GetParam(kmsConfig, api.EnvVaultCAPath) != "" {
return errors.Errorf("failed to validate TLS connection details. %q is not supported. use %q instead", api.EnvVaultCAPath, api.EnvVaultCACert)
}
// Validate potential TLS configuration
for _, tlsOption := range vaultTLSConnectionDetails {
tlsSecretName := GetParam(kmsConfig, tlsOption)
if tlsSecretName != "" {
// Fetch the secret
s, err := clusterdContext.Clientset.CoreV1().Secrets(ns).Get(ctx, tlsSecretName, v1.GetOptions{})
if err != nil {
return errors.Errorf("failed to find TLS connection details k8s secret %q", tlsOption)
}
// Check the Secret key and its content
keyToCheck := tlsSecretKeyToCheck(tlsOption)
cert, ok := s.Data[keyToCheck]
if !ok || len(cert) == 0 {
return errors.Errorf("failed to find TLS connection key %q for %q in k8s secret %q", keyToCheck, tlsOption, tlsSecretName)
}
}
}
return nil
}
func tlsSecretKeyToCheck(tlsOption string) string {
if tlsOption == api.EnvVaultCACert || tlsOption == api.EnvVaultClientCert {
return vaultCACertSecretKeyName
} else if tlsOption == api.EnvVaultClientKey {
return vaultKeySecretKeyName
}
return ""
}