快速入门：机密管理

开始使用Dapr的机密管理构建块

Dapr提供了一个专用的机密API，允许开发者从机密存储中检索机密。在本快速入门中，您将：

运行一个带有机密存储组件的微服务。
在应用程序代码中使用Dapr机密API检索机密。

在继续快速入门之前，请选择您偏好的编程语言对应的Dapr SDK。

前置条件

您需要准备以下环境：

Docker Desktop

步骤1：设置环境

克隆快速入门仓库中的示例。

git clone https://github.com/dapr/quickstarts.git

步骤2：检索机密

在终端窗口中，导航到order-processor目录。

cd secrets_management/python/sdk/order-processor

安装依赖项：

pip3 install -r requirements.txt

运行order-processor服务及其Dapr sidecar。

dapr run --app-id order-processor --resources-path ../../../components/ -- python3 app.py

注意：在Windows中，可能需要使用python app.py而不是python3 app.py。

背后的原理

order-processor服务

请注意，order-processor服务配置如下：

使用在local-secret-store.yaml组件中定义的DAPR_SECRET_STORE。
使用在secrets.json中定义的机密。

# app.py
DAPR_SECRET_STORE = 'localsecretstore'
SECRET_NAME = 'secret'
with DaprClient() as client:
    secret = client.get_secret(store_name=DAPR_SECRET_STORE, key=SECRET_NAME)
    logging.info('Fetched Secret: %s', secret.secret)

local-secret-store.yaml组件

DAPR_SECRET_STORE在local-secret-store.yaml组件文件中定义，位于secrets_management/components：

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: localsecretstore
  namespace: default
spec:
  type: secretstores.local.file
  version: v1
  metadata:
  - name: secretsFile
    value: secrets.json
  - name: nestedSeparator
    value: ":"

在YAML文件中：

metadata/name是应用程序引用组件的名称（在代码示例中称为DAPR_SECRET_STORE）。
spec/metadata定义了组件使用的机密的连接信息。

secrets.json文件

SECRET_NAME在secrets.json文件中定义，位于secrets_management/python/sdk/order-processor：

{
    "secret": "YourPasskeyHere"
}

步骤3：查看order-processor输出

如上面的应用程序代码中所示，order-processor服务通过Dapr机密存储检索机密并在控制台中显示。

Order-processor输出：

== APP == INFO:root:Fetched Secret: {'secret': 'YourPasskeyHere'}

前置条件

您需要准备以下环境：

Docker Desktop

步骤1：设置环境

克隆快速入门仓库中的示例。

git clone https://github.com/dapr/quickstarts.git

步骤2：检索机密

在终端窗口中，导航到order-processor目录。

cd secrets_management/javascript/sdk/order-processor

安装依赖项：

npm install

运行order-processor服务及其Dapr sidecar。

dapr run --app-id order-processor --resources-path ../../../components/ -- npm start

背后的原理

order-processor服务

请注意，order-processor服务配置如下：

使用在local-secret-store.yaml组件中定义的DAPR_SECRET_STORE。
使用在secrets.json中定义的机密。

// index.js
const DAPR_SECRET_STORE = "localsecretstore";
const SECRET_NAME = "secret";

async function main() {
    // ...
    const secret = await client.secret.get(DAPR_SECRET_STORE, SECRET_NAME);
    console.log("Fetched Secret: " + JSON.stringify(secret));
}

local-secret-store.yaml组件

DAPR_SECRET_STORE在local-secret-store.yaml组件文件中定义，位于secrets_management/components：

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: localsecretstore
  namespace: default
spec:
  type: secretstores.local.file
  version: v1
  metadata:
  - name: secretsFile
    value: secrets.json
  - name: nestedSeparator
    value: ":"

在YAML文件中：

metadata/name是应用程序引用组件的名称（在代码示例中称为DAPR_SECRET_STORE）。
spec/metadata定义了组件使用的机密的连接信息。

secrets.json文件

SECRET_NAME在secrets.json文件中定义，位于secrets_management/javascript/sdk/order-processor：

{
    "secret": "YourPasskeyHere"
}

步骤3：查看order-processor输出

如上面的应用程序代码中所示，order-processor服务通过Dapr机密存储检索机密并在控制台中显示。

Order-processor输出：

== APP ==
== APP == > order-processor@1.0.0 start
== APP == > node index.js
== APP ==
== APP == Fetched Secret: {"secret":"YourPasskeyHere"}

前置条件

您需要准备以下环境：

Dapr CLI和已初始化的环境。

Docker Desktop

.NET 6、.NET 8或.NET 9已安装

注意： .NET 6是此版本中Dapr .NET SDK包的最低支持版本。只有.NET 8和.NET 9将在Dapr v1.16及以后版本中得到支持。

步骤1：设置环境

克隆快速入门仓库中的示例。

git clone https://github.com/dapr/quickstarts.git

步骤2：检索机密

在终端窗口中，导航到order-processor目录。

cd secrets_management/csharp/sdk/order-processor

安装依赖项：

dotnet restore
dotnet build

运行order-processor服务及其Dapr sidecar。

dapr run --app-id order-processor --resources-path ../../../components/ -- dotnet run

背后的原理

order-processor服务

请注意，order-processor服务配置如下：

使用在local-secret-store.yaml组件中定义的DAPR_SECRET_STORE。
使用在secrets.json中定义的机密。

// Program.cs
const string DAPR_SECRET_STORE = "localsecretstore";
const string SECRET_NAME = "secret";
var client = new DaprClientBuilder().Build();

var secret = await client.GetSecretAsync(DAPR_SECRET_STORE, SECRET_NAME);
var secretValue = string.Join(", ", secret);
Console.WriteLine($"Fetched Secret: {secretValue}");

local-secret-store.yaml组件

DAPR_SECRET_STORE在local-secret-store.yaml组件文件中定义，位于secrets_management/components：

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: localsecretstore
  namespace: default
spec:
  type: secretstores.local.file
  version: v1
  metadata:
  - name: secretsFile
    value: secrets.json
  - name: nestedSeparator
    value: ":"

在YAML文件中：

metadata/name是应用程序引用组件的名称（在代码示例中称为DAPR_SECRET_STORE）。
spec/metadata定义了组件使用的机密的连接信息。

secrets.json文件

SECRET_NAME在secrets.json文件中定义，位于secrets_management/csharp/sdk/order-processor：

{
    "secret": "YourPasskeyHere"
}

步骤3：查看order-processor输出

如上面的应用程序代码中所示，order-processor服务通过Dapr机密存储检索机密并在控制台中显示。

Order-processor输出：

== APP == Fetched Secret: [secret, YourPasskeyHere]

前置条件

您需要准备以下环境：

Dapr CLI和已初始化的环境。
Java JDK 17（或更高版本）：
- Oracle JDK，或
- OpenJDK
Apache Maven，版本3.x。

Docker Desktop

步骤1：设置环境

克隆快速入门仓库中的示例。

git clone https://github.com/dapr/quickstarts.git

步骤2：检索机密

在终端窗口中，导航到order-processor目录。

cd secrets_management/java/sdk/order-processor

安装依赖项：

mvn clean install

运行order-processor服务及其Dapr sidecar。

dapr run --app-id order-processor --resources-path ../../../components/ -- java -jar target/OrderProcessingService-0.0.1-SNAPSHOT.jar

背后的原理

order-processor服务

请注意，order-processor服务配置如下：

使用在local-secret-store.yaml组件中定义的DAPR_SECRET_STORE。
使用在secrets.json中定义的机密。

// OrderProcessingServiceApplication.java
private static final String SECRET_STORE_NAME = "localsecretstore";
// ...
    Map<String, String> secret = client.getSecret(SECRET_STORE_NAME, "secret").block();
    System.out.println("Fetched Secret: " + secret);

local-secret-store.yaml组件

DAPR_SECRET_STORE在local-secret-store.yaml组件文件中定义，位于secrets_management/components：

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: localsecretstore
  namespace: default
spec:
  type: secretstores.local.file
  version: v1
  metadata:
  - name: secretsFile
    value: secrets.json
  - name: nestedSeparator
    value: ":"

在YAML文件中：

metadata/name是应用程序引用组件的名称（在代码示例中称为DAPR_SECRET_STORE）。
spec/metadata定义了组件使用的机密的连接信息。

secrets.json文件

SECRET_NAME在secrets.json文件中定义，位于secrets_management/java/sdk/order-processor：

{
    "secret": "YourPasskeyHere"
}

步骤3：查看order-processor输出

如上面的应用程序代码中所示，order-processor服务通过Dapr机密存储检索机密并在控制台中显示。

Order-processor输出：

== APP == Fetched Secret: {secret=YourPasskeyHere}

前置条件

您需要准备以下环境：

Docker Desktop

步骤1：设置环境

克隆快速入门仓库中的示例。

git clone https://github.com/dapr/quickstarts.git

步骤2：检索机密

在终端窗口中，导航到order-processor目录。

cd secrets_management/go/sdk/order-processor

安装依赖项：

go build .

运行order-processor服务及其Dapr sidecar。

dapr run --app-id order-processor --resources-path ../../../components/ -- go run .

背后的原理

order-processor服务

请注意，order-processor服务配置如下：

使用在local-secret-store.yaml组件中定义的DAPR_SECRET_STORE。
使用在secrets.json中定义的机密。

const DAPR_SECRET_STORE = "localsecretstore"
const SECRET_NAME = "secret"
// ...
secret, err := client.GetSecret(ctx, DAPR_SECRET_STORE, SECRET_NAME, nil)
if secret != nil {
    fmt.Println("Fetched Secret: ", secret[SECRET_NAME])
}

local-secret-store.yaml组件

DAPR_SECRET_STORE在local-secret-store.yaml组件文件中定义，位于secrets_management/components：

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: localsecretstore
  namespace: default
spec:
  type: secretstores.local.file
  version: v1
  metadata:
  - name: secretsFile
    value: secrets.json
  - name: nestedSeparator
    value: ":"

在YAML文件中：

metadata/name是应用程序引用组件的名称（在代码示例中称为DAPR_SECRET_STORE）。
spec/metadata定义了组件使用的机密的连接信息。

secrets.json文件

SECRET_NAME在secrets.json文件中定义，位于secrets_management/go/sdk/order-processor：

{
    "secret": "YourPasskeyHere"
}

步骤3：查看order-processor输出

如上面的应用程序代码中所示，order-processor服务通过Dapr机密存储检索机密并在控制台中显示。

Order-processor输出：

== APP == Fetched Secret:  YourPasskeyHere

告诉我们您的想法！

我们正在不断改进我们的快速入门示例，重视您的反馈。您觉得这个快速入门有帮助吗？您有改进建议吗？

加入我们的discord频道讨论。

下一步

使用HTTP而不是SDK来使用Dapr机密管理。
- Python
- JavaScript
- .NET
- Java
- Go
了解更多关于机密管理构建块

探索Dapr教程 >>

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.