Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add role for creating CSI's HMAC secret key #872

Merged
merged 2 commits into from
Apr 14, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions templates/csi-daemonset.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ spec:
args:
- --endpoint=/provider/vault.sock
- --debug={{ .Values.csi.debug }}
{{- if (eq .Values.csi.hmacSecretName "") }}
- --hmac-secret-name={{- include "vault.name" . }}-csi-provider-hmac-key
{{- else }}
- --hmac-secret-name={{ .Values.csi.hmacSecretName }}
{{- end }}
{{- if .Values.csi.extraArgs }}
{{- toYaml .Values.csi.extraArgs | nindent 12 }}
{{- end }}
Expand Down
31 changes: 31 additions & 0 deletions templates/csi-role.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{{/*
Copyright (c) HashiCorp, Inc.
SPDX-License-Identifier: MPL-2.0
*/}}

{{- template "vault.csiEnabled" . -}}
{{- if .csiEnabled -}}
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
name: {{ template "vault.fullname" . }}-csi-provider-role
labels:
app.kubernetes.io/name: {{ include "vault.name" . }}-csi-provider
app.kubernetes.io/instance: {{ .Release.Name }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
rules:
- apiGroups: [""]
resources: ["secrets"]
verbs: ["get"]
resourceNames:
{{- if (eq .Values.csi.hmacSecretName "") }}
- {{ include "vault.name" . }}-csi-provider-hmac-key
{{- else }}
- {{ .Values.csi.hmacSecretName }}
{{- end }}
# 'create' permissions cannot be restricted by resource name:
# https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources
- apiGroups: [""]
resources: ["secrets"]
verbs: ["create"]
{{- end }}
24 changes: 24 additions & 0 deletions templates/csi-rolebinding.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{{/*
Copyright (c) HashiCorp, Inc.
SPDX-License-Identifier: MPL-2.0
*/}}

{{- template "vault.csiEnabled" . -}}
{{- if .csiEnabled -}}
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: {{ template "vault.fullname" . }}-csi-provider-rolebinding
labels:
app.kubernetes.io/name: {{ include "vault.name" . }}-csi-provider
app.kubernetes.io/instance: {{ .Release.Name }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: Role
name: {{ template "vault.fullname" . }}-csi-provider-role
subjects:
- kind: ServiceAccount
name: {{ template "vault.fullname" . }}-csi-provider
namespace: {{ .Release.Namespace }}
{{- end }}
19 changes: 19 additions & 0 deletions test/unit/csi-daemonset.bats
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,25 @@ load _helpers
[ "${actual}" = "--debug=true" ]
}

# HMAC secret arg
@test "csi/daemonset: HMAC secret arg is configurable" {
cd `chart_dir`
local actual=$(helm template \
--show-only templates/csi-daemonset.yaml \
--set "csi.enabled=true" \
. | tee /dev/stderr |
yq -r '.spec.template.spec.containers[0].args[2]' | tee /dev/stderr)
[ "${actual}" = "--hmac-secret-name=vault-csi-provider-hmac-key" ]

local actual=$(helm template \
--show-only templates/csi-daemonset.yaml \
--set "csi.enabled=true" \
--set "csi.hmacSecretName=foo" \
. | tee /dev/stderr |
yq -r '.spec.template.spec.containers[0].args[2]' | tee /dev/stderr)
[ "${actual}" = "--hmac-secret-name=foo" ]
}

# Extra args
@test "csi/daemonset: extra args can be passed" {
cd `chart_dir`
Expand Down
39 changes: 39 additions & 0 deletions test/unit/csi-role.bats
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
#!/usr/bin/env bats

load _helpers

@test "csi/Role: disabled by default" {
cd `chart_dir`
local actual=$( (helm template \
--show-only templates/csi-role.yaml \
. || echo "---") | tee /dev/stderr |
yq 'length > 0' | tee /dev/stderr)
[ "${actual}" = "false" ]
}

@test "csi/Role: names" {
cd `chart_dir`
local actual=$(helm template \
--show-only templates/csi-role.yaml \
--set "csi.enabled=true" \
. | tee /dev/stderr |
yq -r '.metadata.name' | tee /dev/stderr)
[ "${actual}" = "release-name-vault-csi-provider-role" ]
local actual=$(helm template \
--show-only templates/csi-role.yaml \
--set "csi.enabled=true" \
. | tee /dev/stderr |
yq -r '.rules[0].resourceNames[0]' | tee /dev/stderr)
[ "${actual}" = "vault-csi-provider-hmac-key" ]
}

@test "csi/Role: HMAC secret name configurable" {
cd `chart_dir`
local actual=$(helm template \
--show-only templates/csi-role.yaml \
--set "csi.enabled=true" \
--set 'csi.hmacSecretName=foo' \
. | tee /dev/stderr |
yq -r '.rules[0].resourceNames[0]' | tee /dev/stderr)
[ "${actual}" = "foo" ]
}
22 changes: 22 additions & 0 deletions test/unit/csi-rolebinding.bats
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#!/usr/bin/env bats

load _helpers

@test "csi/RoleBinding: disabled by default" {
cd `chart_dir`
local actual=$( (helm template \
--show-only templates/csi-role.yaml \
. || echo "---") | tee /dev/stderr |
yq 'length > 0' | tee /dev/stderr)
[ "${actual}" = "false" ]
}

@test "csi/RoleBinding: name" {
cd `chart_dir`
local actual=$(helm template \
--show-only templates/csi-rolebinding.yaml \
--set "csi.enabled=true" \
. | tee /dev/stderr |
yq -r '.metadata.name' | tee /dev/stderr)
[ "${actual}" = "release-name-vault-csi-provider-rolebinding" ]
}
4 changes: 4 additions & 0 deletions values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1025,6 +1025,10 @@ csi:
# cpu: 50m
# memory: 128Mi

# Override the default secret name for the CSI Provider's HMAC key used for
# generating secret versions.
hmacSecretName: ""

# Settings for the daemonSet used to run the provider.
daemonSet:
updateStrategy:
Expand Down