> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kasoftware.com/llms.txt
> Use this file to discover all available pages before exploring further.
# AES 连接器
> AES 连接器设置
export const NameDescription = ({extraRows}) =>
| 设置 |
描述 |
| 端口 Id |
端口的静态、唯一标识符。 |
| 端口类型 |
显示端口类型及其用途的描述。 |
| 端口描述 |
一个可选字段，用于提供端口及其在流中的角色的自由格式描述。 |
{extraRows}
;
export const SlasTab = ({siteName = "知行之桥"}) => <>
与配置服务级别协议 (SLA) 相关的设置。
SLA 允许配置预期流程中端口发送或接收的数据量，并设置预期达到该数据量的时间范围。当 SLA 未达到时，{siteName} 会发送电子邮件警告用户，并将 SLA 标记为 存在风险，这意味着如果 SLA 未能尽快达到，则会被标记为 已违反。这让用户有机会介入并确定 SLA 未达到的原因，并采取适当的措施。如果在风险时间段结束时仍未达到 SLA，则会将 SLA 标记为已违反，并再次通知用户。
要定义 SLA，请启用 预期数据量，然后点击 设置 选项卡。
- 如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 适用的方向。
- 在窗口的 预计至少 部分中：
- 设置预计处理的最小事务数量（交易量）
- 使用 每个 字段指定时间范围
- 指示 SLA 生效的时间。如果选择 开始于，请填写日期和时间字段。
- 勾选希望 SLA 生效的星期几对应的复选框。如有必要，请使用下拉菜单选择 每天。
- 在窗口的 将状态设置为“有风险” 部分中，指定应将 SLA 标记为有风险的时间。
- 默认情况下，只有在违反 SLA 的情况下才会发送通知。要更改此设置，请勾选 发送“有风险”通知。
以下示例显示了为端口配置的 SLA，该端口预计在周一至周五每天接收 1000 个文件。如果尚未收到 1000 个文件，则会在时间段结束前 1 小时发送风险通知。
如果有必要，可以关闭 SLA 通知。这在维护窗口期间非常有用。点击导航栏上的 设置，然后跳转到 通知 > 通用通知。点击平板和铅笔图标进行编辑，并取消勾选 SLA 通知 设置。
;
export const AlertsTab = ({siteNameShort = "知行之桥"}) => <>
与配置通知相关的设置。
在执行服务级别协议 (SLA) 之前，需要设置电子邮件通知以接收通知。默认情况下，{siteNameShort} 使用 通知 选项卡上的全局设置。要为此端口使用其他设置，请启用 覆盖全局设置。
默认情况下，错误通知处于启用状态，这意味着每当出现错误时都会发送电子邮件。要关闭错误通知，请取消选中 启用 复选框。
输入 主题（必填）。勾选允许在主题中使用 {siteNameShort}Script，即可在主题字段中使用 {siteNameShort}Script。选中后会显示 {siteNameShort}Script 编辑器按钮（
）。
（可选）输入以逗号分隔的收件人电子邮件地址列表。
;
export const Message = () => <>
消息设置确定端口如何搜索消息并在处理后管理它们。
注意：以下设置已弃用，默认处于隐藏状态。只有先前已启用这些设置或将其配置为非默认值的端口才会显示它们。若要保留成功处理的文件副本，请在工作流中右键单击该端口，选择显示成功路径，然后将成功路径连接到 File 端口。
| 设置 | 描述 |
|---|
| 保存到已发送文件夹（已弃用） |
将端口处理的文件复制到 Sent 文件夹。默认禁用。保存到 Sent 文件夹中的文件不受静态加密保护。 |
| 已发送文件夹方案（已弃用） |
按所选时间间隔对 Sent 文件夹中的文件进行分组。仅在启用保存到已发送文件夹时适用。 |
;
export const MiscConnector = () => <>
特殊设置适用于特定用例。
| 设置 |
描述 |
| 其他设置 |
允许在以分号分隔的列表中配置隐藏的端口设置，例如 setting1=value1;setting2=value2。正常的端口用例和功能不需要使用这些设置。 |
;
export const Logging = () => <>
用于管理日志创建和存储的设置。
| 设置 |
描述 |
| 日志级别 |
指定要记录在端口日志目录中的信息类型：
- None - 不创建任何日志。
- Error - 仅当端口遇到错误时才创建日志。
- Warning - 仅当端口发出警告时才创建日志。
- Info - 记录工作流的一般信息，包括任何错误和警告（如果适用）。
- Debug - 记录成功和失败工作流的详细调试信息。
- Trace - 记录成功和失败工作流的详细跟踪信息。
请注意：Debug 和 Trace 级别的日志可能会记录敏感信息，包括消息内容和 SSL 证书。尽管连接属性（例如密码）被屏蔽了，但在与您的组织外部共享它们之前，请查看此级别的日志以避免泄漏敏感信息。 |
| 日志文件夹结构 |
指示端口根据选定的时间间隔将日志文件夹中的文件分组。例如，Weekly 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在日志文件夹中。对于处理许多事务的端口，使用子文件夹有助于保持日志的有序性并提高性能。 |
| 保留消息副本 |
指示端口在日志目录中保存最新消息副本的切换。请注意，端口每个子文件夹只保留一个消息，并且端口在再次运行时会覆盖以前保存的消息。 |
;
export const MacrosExamples = ({extraMacros = []}) => <>
某些宏（例如 %Ext% 和 %ShortDate%）不需要参数，但其他宏则需要。所有带有参数的宏都使用以下语法：%Macro:argument%
以下是带有参数的宏的一些示例：
- %Header:headername%：其中
headername 是消息上消息头的名称。
- %Header:mycustomheader% 解析为输入消息上设置的
mycustomheader 消息头的值。
- %Header:ponum% 解析为输入消息上设置的
ponum 消息头的值。
- %RegexFilename:pattern%：其中
pattern 是正则表达式模式。例如，%RegexFilename:^([\w][A-Za-z]+)% 匹配并解析为文件名中的第一个单词，并且不区分大小写（test_file.xml 解析为 test）。
- %Vault:vaultitem%：其中
vaultitem 是 vault 中项目的名称。例如，%Vault:companyname% 解析为存储在保管库中的 companyname 项的值。
- %DateFormat:format%：其中
format 是可接受的日期格式（有关详细信息，请参阅 示例日期格式）。例如，%DateFormat:yyyy-MM-dd-HH-mm-ss-fff% 解析为文件上的日期和时间戳。
{extraMacros.filter(item => item.example).map(item => - {item.example}
)}
还可以创建更复杂的宏，如以下示例所示：
- 将多个宏组合在一个文件名中：
%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%
- 包括宏之外的文本：
MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%
- 在宏中包含文本：
%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%
;
export const MacrosTable = ({siteName = "知行之桥", extraMacros = []}) => <>
在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。通过将宏合并到文件名中，可以动态地包含相关信息，例如标识符、时间戳和消息头信息，从而为每个文件提供有价值的上下文。这有助于确保文件名反映对组织重要的详细信息。
{siteName} 支持这些宏，它们都使用以下语法：%Macro%。
| 宏 | 描述 |
|---|
| ConnectorID | 替换为端口的 ConnectorID。 |
| ConnectorName | 替换为端口名称。可用于在文件名或路径中包含连接名称，例如按生成备份文件的数据库连接标记文件。 |
| Ext | 替换为端口当前正在处理的文件的文件扩展名。 |
| Filename | 替换为端口当前正在处理的文件的文件名（包括扩展名）。 |
| FilenameNoExt | 替换为端口当前正在处理的文件的文件名（不带扩展名）。 |
| MessageId | 计算端口输出的消息的 MessageId。 |
| RegexFilename:pattern | 将正则表达式模式应用于端口当前正在处理的文件的文件名。 |
| Header:headername | 替换为端口正在处理的当前消息的目标消息头（headername）的值。 |
| LongDate | 以常规格式计算系统的当前日期时间（例如，2024 年 1 月 24 日星期三）。 |
| ShortDate | 以 yyyy-MM-dd 格式计算系统的当前日期时间（例如 2024-01-24）。 |
| DateFormat:format | 以指定格式（format）计算系统的当前日期时间。有关可用的日期时间格式，请参阅 示例日期格式。 |
| Vault:vaultitem | 计算指定保管库项目的值。 |
{extraMacros.map(item =>
| {item.name} |
{item.description} |
)}
;
export const Performance = () => <>
与端口资源分配相关的设置。
| 设置 |
描述 |
| 最大工作线程数 |
此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖 高级设置 页面的 性能设置 部分的默认设置。 |
| 最大文件数 |
分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖 高级设置 页面的 性能设置 部分的默认设置。 |
;
export const siteName = "知行之桥";
AES 连接器使用高级加密标准（AES）对文件进行原生加密和解密。
## 主要功能
* 支持 AES-GCM、AES-CBC、AES-CTR、AES-CFB、AES-OFB、AES-CTS 和旧版 AES-ECB
* 支持基于密码的密钥派生、静态密钥和从消息头读取密钥
* 可配置随机盐、Nonce/IV、认证标签和关联数据
* 与 OpenSSL AES-CBC 的加盐格式兼容
## 概述
AES 连接器支持以下操作：
* **Encrypt**：使用配置的密钥和密码参数加密输入文件
* **Decrypt**：解密由 AES 连接器或兼容系统生成的文件
连接器会自动遮蔽密码、密钥及其他敏感配置值。
## 设置
### 配置
* **Operation**：选择 **Encrypt** 或 **Decrypt**。
### 密钥
| 设置 | 说明 |
| ------------------------- | ------------------------------------------------------------ |
| **Key Source** | 密钥来源：**Password-Based KDF**、**Static Key** 或 **Header Key**。 |
| **Password** | 用于派生密钥的 UTF-8 密码。 |
| **Key Size** | AES 密钥长度：128、192 或 256 位。默认值为 256 位。 |
| **KDF** | 密钥派生函数：PBKDF2-HMAC-SHA256 或 PBKDF2-HMAC-SHA512。 |
| **Iterations** | PBKDF2 迭代次数。默认值为 600000。 |
| **Password Salt** | 盐的来源：**Auto-Generate**、**Static** 或 **Header**。 |
| **Generated Salt Output** | 自动生成的盐写入加密数据（**Included**）或消息头（**Header**）。 |
使用 **Static Key** 或 **Header Key** 时，密钥可以是以 `0x` 开头的十六进制值，也可以是 Base64 值。解码后的密钥必须为 16、24 或 32 字节。选择 **Header Key** 时，连接器从指定消息头读取密钥；二进制头值应使用 Base64 编码。
使用静态盐时，解码后的盐必须恰好为 16 字节。使用消息头盐时，还必须指定包含盐值的消息头名称。
### 密码
| 设置 | 说明 |
| ----------------------------- | ----------------------------------------------------------------- |
| **Mode** | 加密模式。**GCM** 是默认值及推荐值；还支持 CBC、ECB、CFB、OFB、CTS 和 CTR。ECB 仅用于兼容旧系统。 |
| **Padding** | CBC 和 ECB 的填充方式：PKCS7、Zeros、None、ANSIX923 或 ISO10126。 |
| **Nonce/IV** | Nonce 或初始化向量的来源：**Auto-Generate**、**Static** 或 **Header**。 |
| **Generated Nonce/IV Output** | 自动生成的 Nonce/IV 写入加密数据（**Included**）或消息头（**Header**）。 |
GCM 使用 12 字节 Nonce；除 ECB 外的其他模式使用 16 字节 IV。ECB 不使用 IV。除非兼容旧系统，否则不建议使用静态 Nonce 或 IV。
解密时，如果 **Nonce/IV** 设置为 **Auto-Generate**，连接器会从输入数据中读取先前包含的值。
### 身份验证
以下设置仅适用于 GCM：
| 设置 | 说明 |
| --------------------------------- | ----------------------------------------- |
| **Authentication Tag** | 认证标签写入加密数据（**Included**）或消息头（**Header**）。 |
| **Tag Length** | 认证标签长度。默认值为 128 位；还支持 120、112、104 和 96 位。 |
| **Additional Authenticated Data** | 不使用 AAD（**None**）或从消息头读取 AAD（**Header**）。 |
| **AAD Header Encoding** | AAD 消息头按十六进制或 UTF-8 解码。 |
### 高级设置
* **Processing Delay**：连接器处理文件前等待的时间。
* **Local File Scheme**：连接器在本地文件名中使用的方案。
## 自动化
**Automation** 选项卡包含：
* **Send**：启用后，连接器自动处理 Input 选项卡中的文件。
### 性能
### 告警
### SLA
## 包含式负载格式
当生成的值配置为 **Included** 时，加密负载按以下顺序组成：
```text theme={null}
salt || nonce/IV || ciphertext || authentication tag
```
只有当前配置所使用的值才会包含在负载中。
## 默认消息头
| 值 | 默认消息头 |
| ----------------------------- | ---------------------- |
| Password Salt | `Crypto-Password-Salt` |
| AES Key | `Crypto-Key` |
| Nonce/IV | `Crypto-Nonce` |
| Authentication Tag | `Crypto-Auth-Tag` |
| Additional Authenticated Data | `Crypto-AAD` |
## 宏
### 示例