How-To: Limit the secrets that can be read from secret stores

To limit the secrets to which the Dapr application has access, users can define secret scopes by augmenting existing configuration CRD with restrictive permissions.

In addition to scoping which applications can access a given component, for example a secret store component (see Scoping components), a named secret store component itself can be scoped to one or more secrets for an application. By defining allowedSecrets and/or deniedSecrets list, applications can be restricted to access only specific secrets.

Follow these instructions to define a configuration CRD.

Configure secrets access

The secrets section under the Configuration spec contains the following properties:

  1. secrets:
  2.   scopes:
  3.     - storeName: kubernetes
  4.       defaultAccess: allow
  5.       allowedSecrets: ["redis-password"]
  6.     - storeName: localstore
  7.       defaultAccess: allow
  8.       deniedSecrets: ["redis-password"]

The following table lists the properties for secret scopes:

属性数据类型描述
storeNamestringName of the secret store component. Name of the secret store component. storeName must be unique within the list
默认权限stringAccess modifier. Accepted values “allow” (default) or “deny”
允许的密钥listList of secret keys that can be accessed
被拒绝的密钥listList of secret keys that cannot be accessed

When an allowedSecrets list is present with at least one element, only those secrets defined in the list can be accessed by the application.

权限优先级

The allowedSecrets and deniedSecrets list values take priorty over the defaultAccess.

场景默认权限允许的密钥被拒绝的密钥权限
1 - 仅默认访问拒绝/允许为空为空拒绝/允许
2 - 默认拒绝允许列表拒绝[“s1”]为空只能访问”s1”
3 - 默认允许拒绝列表允许为空[“s1”]仅限”s1”无法访问
4 - 默认允许允许列表允许[“s1”]为空只能访问”s1”
5 - 默认拒绝拒绝列表拒绝为空[“s1”]拒绝
6 - 两个列表的默认拒绝/允许拒绝/允许[“s1”][“s2”]只能访问”s1”

示例

场景1：拒绝访问所有密钥仓库

In Kubernetes cluster, the native Kubernetes secret store is added to Dapr application by default. 在某些情况下，可能有必要拒绝某个应用程序访问 Dapr 密钥。 要添加此配置，请按照下面的步骤：

Define the following appconfig.yaml and apply it to the Kubernetes cluster using the command kubectl apply -f appconfig.yaml.

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Configuration
  3. metadata:
  4.   name: appconfig
  5. spec:
  6.   secrets:
  7.     scopes:
  8.       - storeName: kubernetes
  9.         defaultAccess: deny

For applications that need to be deined access to the Kubernetes secret store, follow these instructions, and add the following annotation to the application pod.

  1. dapr.io/config: appconfig

With this defined, the application no longer has access to Kubernetes secret store.

场景2：只允许访问密钥仓库中的某些密钥

To allow a Dapr application to have access to only certain secrets, define the following config.yaml:

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Configuration
  3. metadata:
  4.   name: appconfig
  5. spec:
  6.   secrets:
  7.     scopes:
  8.       - storeName: vault
  9.         defaultAccess: deny
  10.         allowedSecrets: ["secret1", "secret2"]

This example defines configuration for secret store named vault. 密钥仓库的默认访问权限是deny，而有些密钥可以通过应用程序基于allowedSecrets列表访问。 按照 这些说明 将配置应用到 sidecar。

Scenario 3: Deny access to certain senstive secrets in a secret store

定义以下 config.yaml:

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Configuration
  3. metadata:
  4.   name: appconfig
  5. spec:
  6.   secrets:
  7.     scopes:
  8.       - storeName: vault
  9.         defaultAccess: allow # this is the default value, line can be omitted
  10.         deniedSecrets: ["secret1", "secret2"]

上面的配置明确禁止从名为 vault 的密钥仓库访问 secret1 和 secret2 ，但允许访问所有其他密钥。 按照 这些说明 将配置应用到 sidecar。