Black lives matter.
We stand in solidarity with the Black community.
Racism is unacceptable.
It conflicts with the core values of the Kubernetes project and our community does not tolerate it.
We stand in solidarity with the Black community.
Racism is unacceptable.
It conflicts with the core values of the Kubernetes project and our community does not tolerate it.
本页展示了如何配置秘钥管理服务—— Key Management Service (KMS) 提供商和插件以启用数据加密。
你必须拥有一个 Kubernetes 的集群,同时你的 Kubernetes 集群必须带有 kubectl 命令行工具。 如果你还没有集群,你可以通过 Minikube 构建一 个你自己的集群,或者你可以使用下面任意一个 Kubernetes 工具构建:
要获知版本信息,请输入kubectl version
.
Kubernetes v1.12 [beta]
KMS 加密提供商使用封套加密模型来加密 etcd 中的数据。数据使用数据加密秘钥(DEK)加密;每次加密都生成一个新的 DEK。这些 DEK 经一个秘钥加密秘钥(KEK)加密后在一个远端的 KMS 中存储和管理。KMS 提供商使用 gRPC 与一个特定的 KMS 插件通信。这个 KMS 插件作为一个 gRPC 服务器被部署在 Kubernetes 主服务器的同一个主机上,负责与远端 KMS 的通信。
为了在 API 服务器上配置 KMS 提供商,在加密配置文件中的提供商数组中加入一个类型为 kms
的提供商,并设置下列属性:
name
: KMS 插件的显示名称。endpoint
: gRPC 服务器(KMS 插件)的监听地址。该端点是一个 UNIX 的套接字。cachesize
: 以明文缓存的数据加密秘钥(DEKs)的数量。一旦被缓存,就可以直接使用 DEKs 而无需另外调用 KMS;而未被缓存的 DEKs 需要调用一次 KMS 才能解包。timeout
: 在返回一个错误之前,kube-apiserver 等待 kms-plugin 响应的时间(默认是 3 秒)。参见 理解静态数据加密配置
为实现一个 KMS 插件,您可以开发一个新的插件 gRPC 服务器或启用一个由您的云服务提供商提供的 KMS 插件。您可以将这个插件与远程 KMS 集成,并把它部署到 Kubernetes 的主服务器上。
有关启用云服务提供商特定的 KMS 插件的说明,请咨询您的云服务提供商。
您可以使用 Go 语言的存根文件开发 KMS 插件 gRPC 服务器。对于其他语言,您可以用 proto 文件创建可以用于开发 gRPC 服务器代码的存根文件。
然后使用存根文件中的函数和数据结构开发服务器代码。
注意:
v1beta1
作为对过程调用 Version 的响应,兼容的 KMS 插件应把 v1beta1 作为 VersionResponse.version 返回
v1beta1
所有来自 KMS 提供商的消息都把 version 字段设置为当前版本 v1beta1
unix
)gRPC 服务器应监听 UNIX 域套接字
KMS 插件可以用任何受 KMS 支持的协议与远程 KMS 通信。 所有的配置数据,包括 KMS 插件用于与远程 KMS 通信的认证凭据,都由 KMS 插件独立地存储和管理。KMS 插件可以用额外的元数据对密文进行编码,这些元数据是在把它发往 KMS 进行解密之前可能要用到的。
确保 KMS 插件与 Kubernetes 主服务器运行在同一主机上。
为了加密数据:
kms
提供商的相应的属性创建一个新的加密配置文件:kind: EncryptionConfiguration
apiVersion: apiserver.config.k8s.io/v1
resources:
- resources:
- secrets
providers:
- kms:
name: myKmsPlugin
endpoint: unix:///tmp/socketfile.sock
cachesize: 100
timeout: 3s
- identity: {}
--encryption-provider-config
参数指向配置文件的位置。注意:
在 1.13 之前的加密功能的 alpha 版本需要一个带有 kind: EncryptionConfig
和 apiVersion: v1
的配置文件,并使用 --experimental-encryption-provider-config
标志。
写入 etcd 时数据被加密。重启 kube-apiserver 后,任何新建或更新的秘密信息在存储时应该已被加密。要验证这点,您可以用 etcdctl 命令行程序获取秘密信息内容。
kubectl create secret generic secret1 -n default --from-literal=mykey=mydata
ETCDCTL_API=3 etcdctl get /kubernetes.io/secrets/default/secret1 [...] | hexdump -C
其中 [...]
是用于连接 etcd 服务器的额外参数。
k8s:enc:kms:v1:
开头的,这表明 kms
提供商已经对结果数据加密。kubectl describe secret secret1 -n default
应该符合 mykey: mydata
格式
因为秘密信息是在写入时被加密的,所以在更新秘密信息时会加密该内容。
下列命令读取所有秘密信息并更新他们以便应用服务器端加密。如果因为写入冲突导致错误发生,请重试此命令。对较大的集群,您可能希望根据命名空间或脚本更新去细分秘密内容。
kubectl get secrets --all-namespaces -o json | kubectl replace -f -
为了从本地加密提供商切换到 kms
提供商并重新加密所有秘密内容:
kms
提供商作为第一个条目,如下列样例所示kind: EncryptionConfiguration
apiVersion: apiserver.config.k8s.io/v1
resources:
- resources:
- secrets
providers:
- kms:
name : myKmsPlugin
endpoint: unix:///tmp/socketfile.sock
cachesize: 100
- aescbc:
keys:
- name: key1
secret: <BASE 64 ENCODED SECRET>
kms
提供商强制重新加密所有秘密信息。kubectl get secrets --all-namespaces -o json| kubectl replace -f -
要禁用静态数据加密:
identity
提供商作为配置文件中的第一个条目:kind: EncryptionConfiguration
apiVersion: apiserver.config.k8s.io/v1
resources:
- resources:
- secrets
providers:
- identity: {}
- kms:
name : myKmsPlugin
endpoint: unix:///tmp/socketfile.sock
cachesize: 100
kubectl get secrets --all-namespaces -o json | kubectl replace -f -