Files
my-rook-config/pkg/daemon/ceph/osd/kms/envs.go
T
Sébastien Han ea1d71cbfb ceph: add vault kms support for osd encryption
When the Ceph cluster runs on PVC and the OSDs are encrypted we can
store LUKS's Key Encryption Key inside a Key Management System. Today,
Rook only supports HashiCorp Vault: https://www.vaultproject.io/

The CephCluster has now a new "security" field which will plug onto the
KMS. Here is an example:

security:
  kms:
    tokenSecretName: <name of the secret containing a Vault token, used
    to authenticate>
    connectionDetails: < a map of strings containing connection
    information>

Refer to the ceph-cluster-crd documentation to lear more.

Closes: https://github.com/rook/rook/issues/6105
Signed-off-by: Sébastien Han <seb@redhat.com>
2020-10-30 16:16:33 +01:00

101 lines
3.0 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 (
"os"
"path"
"strings"
"github.com/hashicorp/vault/api"
cephv1 "github.com/rook/rook/pkg/apis/ceph.rook.io/v1"
"github.com/rook/rook/pkg/daemon/ceph/client"
v1 "k8s.io/api/core/v1"
)
var (
knownKMSPrefix = []string{"VAULT_"}
)
// VaultTokenEnvVarFromSecret returns the kms token secret value as an env var
func vaultTokenEnvVarFromSecret(tokenSecretName string) v1.EnvVar {
return v1.EnvVar{
Name: api.EnvVaultToken,
ValueFrom: &v1.EnvVarSource{
SecretKeyRef: &v1.SecretKeySelector{
LocalObjectReference: v1.LocalObjectReference{
Name: tokenSecretName,
},
Key: KMSTokenSecretNameKey,
},
},
}
}
// vaultTLSEnvVarFromSecret translates TLS env var which are set to k8s secret name to their actual path on the fs once mounted as volume
// See: TLSSecretVolumeAndMount() for more details
func vaultTLSEnvVarFromSecret(kmsConfig map[string]string) []v1.EnvVar {
vaultTLSEnvVar := []v1.EnvVar{}
for _, tlsOption := range vaultTLSConnectionDetails {
tlsSecretName := GetParam(kmsConfig, tlsOption)
if tlsSecretName != "" {
vaultTLSEnvVar = append(vaultTLSEnvVar, v1.EnvVar{Name: tlsOption, Value: path.Join(EtcVaultDir, tlsSecretPath(tlsOption))})
}
}
return vaultTLSEnvVar
}
// VaultConfigToEnvVar populates the kms config as env variables
func VaultConfigToEnvVar(spec cephv1.ClusterSpec) []v1.EnvVar {
envs := []v1.EnvVar{}
for k, v := range spec.Security.KeyManagementService.ConnectionDetails {
// Skip TLS and token env var to avoid env being set multiple times
toSkip := append(vaultTLSConnectionDetails, api.EnvVaultToken)
if client.StringInSlice(k, toSkip) {
continue
}
envs = append(envs, v1.EnvVar{Name: k, Value: v})
}
// Add the VAULT_TOKEN
envs = append(envs, vaultTokenEnvVarFromSecret(spec.Security.KeyManagementService.TokenSecretName))
// Add TLS env if any
envs = append(envs, vaultTLSEnvVarFromSecret(spec.Security.KeyManagementService.ConnectionDetails)...)
logger.Debugf("kms envs are %v", envs)
return envs
}
// ConfigEnvsToMapString returns all the env variables in map from a known KMS
func ConfigEnvsToMapString() map[string]string {
envs := make(map[string]string)
for _, e := range os.Environ() {
pair := strings.SplitN(e, "=", 2)
for _, knownKMS := range knownKMSPrefix {
if strings.HasPrefix(pair[0], knownKMS) || pair[0] == Provider {
envs[pair[0]] = os.Getenv(pair[0])
}
}
}
return envs
}