将配置和密钥与Edge函数结合使用

了解如何通过edgeFunctions.yaml将非敏感的​ 配置 ​和敏感的​ 密钥 ​传递给AEM Edge函数，并在代码中读取它们。

配置和密钥

configs和secrets都是您向AEM Edge函数公开的键/值对。

不同之处在于价值存在的地方，以及它的敏感程度。

声明配置和机密的位置

在edgeFunctions.yaml中的data下将两者声明为functions的同级。 它们不会嵌套在单个函数下。

# config/edgeFunctions.yaml
kind: "EdgeFunctions"
version: "1"
data:
  functions:
    - name: my-edge-function
  configs:
    - key: TRIPS_API_BASE_URL
      value: "https://api.example.com/trips"
    - key: ADVENTURE_CACHE_TTL_SECONDS
      value: "300"
  secrets:
    - key: TRIPS_API_TOKEN
      value: ${{WKND_TRIPS_API_TOKEN}}

键名称区分大小写。 您在此处声明的key与代码在运行时读取的名称相同。

有关所有支持的属性，请参阅声明函数。

使用配置

配置包含的非敏感值会因环境而异。 配置值始终为字符串，因此，当您需要数字或布尔值时，请强制转换这些值。

读取代码中的配置

打开config_default存储，然后使用您声明的键调用get()。 调用是同步的。

// src/index.js or handler file
import { ConfigStore } from "fastly:config-store";

const config = new ConfigStore("config_default");

// read a config value (always a string)
const apiBaseUrl = config.get("TRIPS_API_BASE_URL");

// cast to a number, with a fallback if the key is missing
const ttlSeconds = Number(config.get("ADVENTURE_CACHE_TTL_SECONDS") || "300");

使用密钥

密钥包含敏感值，例如API令牌。 值将保留在Cloud Manager密码中。 您的edgeFunctions.yaml使用${{SECRET_NAME}}语法引用它，因此该值从不出现在Git中。

涉及两个名字，它们在目的上有所不同。

此示例使用一个密钥和一个密钥，即AEM as a Cloud Service的模式。 在Edge Delivery Services上，每个站点重复一次此模式，因为一个配置管道可为所有三个站点提供服务。

在AEM as a Cloud Service中添加密钥

定义Cloud Manager密钥并运行配置管道，然后再将其用于AEM Edge函数。 每个环境(RDE、Dev、Stage、Prod)都有自己的“配置”选项卡，因此，添加到开发环境的密码在添加到暂存或Prod中之前并不存在。

在Edge Delivery Services中添加密钥

Edge Delivery Services的每个项目都有一个配置管道，而不是每个站点都有一个配置管道。 它将为整个项目部署单个edgeFunctions.yaml，由每个站点共享，而不是为每个站点部署单独的文件。

开发、暂存和生产站点都共享该管道，因此您不能使用三个不同的值三次添加同一变量名称，也不能依赖特定于分支的edgeFunctions.yaml来选择正确的变量名称。

为每个变量名称添加前缀，以使三个站点绝不冲突，例如DEV_TRIPS_API_TOKEN、STAGE_TRIPS_API_TOKEN和MAIN_TRIPS_API_TOKEN。 在同一个edgeFunctions.yaml中声明所有三个，然后让您的代码在运行时选择正确的一个。

# config/edgeFunctions.yaml
secrets:
  - key: TRIPS_API_TOKEN_DEV
    value: ${{DEV_TRIPS_API_TOKEN}}
  - key: TRIPS_API_TOKEN_STAGE
    value: ${{STAGE_TRIPS_API_TOKEN}}
  - key: TRIPS_API_TOKEN_MAIN
    value: ${{MAIN_TRIPS_API_TOKEN}}

AEM Edge函数必须根据它当前提供的网站，决定在运行时读取哪个键。 下一部分将显示查找。

读取代码中的密钥

在运行时通过样板在src/lib/config.js中提供的SecretStoreManager帮助程序读取密码。 它从secret_default存储中读取。 虽然调用在两种平台上都是异步调用，但查找的键值有所不同。

在AEM as a Cloud Service​上，密钥是固定的，因为每个环境在相同的密钥名称后面都有自己的密钥：

// src/index.js or handler file
import { SecretStoreManager } from "./lib/config";

const token = await SecretStoreManager.getSecret("TRIPS_API_TOKEN");
if (!token) {
  throw new Error("TRIPS_API_TOKEN is not configured");
}

在Edge Delivery Services​上，首先从当前站点生成密钥，因为一个共享的edgeFunctions.yaml为每个站点声明了一个单独的密钥：

// src/index.js or handler file
import { SecretStoreManager } from "./lib/config";

const site = getCurrentSite(); // for example, "DEV", "STAGE", or "MAIN" based on the origin header
const token = await SecretStoreManager.getSecret(`TRIPS_API_TOKEN_${site}`);
if (!token) {
  throw new Error(`TRIPS_API_TOKEN_${site} is not configured`);
}

获得令牌后，可在两种平台上以相同的方式将其用于出站请求：

// use the token in an outbound request, never in a response to the client
const request = new Request("https://api.example.com/trips", {
  headers: { Authorization: `Bearer ${token}` },
});

保守秘密AEM Edge函数。 请勿将其返回给客户端或进行记录。

准则

其他资源