> ## 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.

# OpenPGP 端口

> 知行之桥OpenPGP 端口的配置和使用指南，该端口支持符合 Open Pretty Good Privacy 标准的加密、解密、签名和验证。

OpenPGP 端口支持符合 Open Pretty Good Privacy 标准的加密、解密、签名和验证。

## 核心功能

* 完整的 OpenPGP 加密、解密、签名及签名验证，支持多种算法
* 提供编码模式（加密/签名）和解码模式（解密/验证），并支持压缩选项
* 具备密钥环管理功能，支持 ASCII Armor 编码以实现可读的加密数据传输

## 概述

OpenPGP 端口是 知行之桥 支持保护工作流中数据的主要方式。以 **Encode** 模式运行的 OpenPGP 端口可以加密和/或签名文件；以 **Decode** 模式运行的 OpenPGP 端口可以解密文件和/或验证签名。加密和签名验证需要公共 OpenPGP 密钥，解密和签名需要私有 OpenPGP 密钥。使用这些密钥前，必须先[创建](#创建密钥)这些密钥，或将其导入 OpenPGP 密钥环文件（`.gpg`）。

## 端口配置

本节包含所有可配置的端口属性。

### 设置选项卡

#### 配置

*与端口核心操作相关的设置。*

| 设置 | 说明 |
| - | - |
| **端口 ID** | 端口的静态唯一标识符。 |
| **端口类型** | 显示端口名称及其功能说明。 |
| **端口说明** | 可选字段，用于自由描述该端口及其在工作流中的作用。 |
| **操作** | 端口是编码还是解码传入文件。编码包括加密和签名数据，解码包括解密数据和验证签名。端口设置会根据此设置变化。 |

#### 消息设置

*与创建 OpenPGP 消息相关的设置。仅在编码时可用。*

| 设置 | 说明 |
| - | - |
| **消息安全性** | 端口应创建加密消息、签名消息，还是同时创建签名并加密的消息。 |
| **压缩** | 端口是否应在加密和/或签名前压缩消息。 |
| **加密算法** | 加密时使用的对称算法。 |
| **签名算法** | 签名时使用的哈希算法。 |
| **压缩方式** | 压缩时使用的压缩算法。 |

#### 密钥

*与端口使用的 OpenPGP 密钥相关的设置。加密和签名仅在编码时可用，验证和解密仅在解码时可用。*

| 设置 | 说明 |
| - | - |
| **加密密钥** | 标识公共密钥环中用于加密的公钥的用户 ID。导入公共密钥环文件以查看可用的用户 ID。 |
| **签名密钥** | 标识私密密钥环中用于签名的私钥的用户 ID。导入私密密钥环文件以查看可用的用户 ID。 |
| **验证密钥** | 标识公共密钥环中用于验证签名的公钥的用户 ID。导入公共密钥环文件以查看可用的用户 ID。 |
| **解密密钥** | 标识私密密钥环中用于解密的私钥的用户 ID。导入私密密钥环文件以查看可用的用户 ID。 |
| **密码短语** | 编码时：所选私有签名密钥的密码短语。解码时：所选私有解密密钥的密码短语。 |

### 高级选项卡

#### 高级设置

*先前类别中未包含的设置。*

| 设置 | 说明 |
| - | - |
| **ASCII Armor** | 是否应对端口生成的 OpenPGP 消息应用 ASCII 编码。 |
| **明文签名** | OpenPGP 签名是否应以明文显示。加密消息时不适用。 |
| **处理延迟** | 放入**交易**选项卡的文件延迟处理的时长（秒）。这是一个旧版设置。最佳实践是[使用 File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/flows/designing-a-flow.md#与本地文件系统交互)管理本地文件系统，而不是使用此设置。 |
| **本地文件方案** | 为端口输出的消息分配文件名的方案。可以在文件名中使用宏，动态包含标识符和时间戳等信息。有关更多信息，请参见[宏](#宏)。 |

#### 消息

*消息设置确定端口如何搜索消息并在处理后管理它们。*

**注意：**以下设置已弃用，默认处于隐藏状态。只有先前已启用这些设置或将其配置为非默认值的端口才会显示它们。若要保留成功处理的文件副本，请在工作流中右键单击该端口，选择**显示成功路径**，然后将成功路径连接到 [File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/file.md)。

<table><thead><tr><th>设置</th><th>描述</th></tr></thead>
<tbody><tr><td>**保存到已发送文件夹**（已弃用）</td>
<td>将端口处理的文件复制到 Sent 文件夹。默认禁用。保存到 Sent 文件夹中的文件不受[静态加密](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/encryption-at-rest.md)保护。</td></tr>
<tr><td>**已发送文件夹方案**（已弃用）</td>
<td>按所选时间间隔对 **Sent** 文件夹中的文件进行分组。仅在启用**保存到已发送文件夹**时适用。</td></tr></tbody></table>

#### 日志

*用于管理日志创建和存储的设置。*

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**日志级别**</td>
<td>指定要记录在端口日志目录中的信息类型：
<ul><li>**None** - 不创建任何日志。</li>
<li>**Error** - 仅当端口遇到错误时才创建日志。</li>
<li>**Warning** - 仅当端口发出警告时才创建日志。</li>
<li>**Info** - 记录工作流的一般信息，包括任何错误和警告（如果适用）。</li>
<li>**Debug** - 记录成功和失败工作流的详细调试信息。</li>
<li>**Trace** - 记录成功和失败工作流的详细跟踪信息。</li></ul>
\*\*请注意：\*\***Debug** 和 **Trace** 级别的日志可能会记录敏感信息，包括消息内容和 SSL 证书。尽管连接属性（例如密码）被屏蔽了，但在与您的组织外部共享它们之前，请查看此级别的日志以避免泄漏敏感信息。</td></tr>
<tr><td>**日志文件夹结构**</td>
<td>指示端口根据选定的时间间隔将日志文件夹中的文件分组。例如，**Weekly** 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在日志文件夹中。对于处理许多事务的端口，使用子文件夹有助于保持日志的有序性并提高性能。</td></tr>
<tr><td>**保留消息副本**</td>
<td>指示端口在日志目录中保存最新消息副本的切换。请注意，端口每个子文件夹只保留一个消息，并且端口在再次运行时会覆盖以前保存的消息。</td></tr></tbody></table>

#### 其他设置

*特殊设置适用于特定用例。*

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**其他设置**</td>
<td>允许在以分号分隔的列表中配置隐藏的端口设置，例如 `setting1=value1;setting2=value2`。正常的端口用例和功能不需要使用这些设置。</td></tr></tbody></table>

### 自动化选项卡

#### 设置

*与端口自动处理文件相关的设置。*

| 设置 | 说明 |
| - | - |
| **发送自动化** | 到达端口的消息是否会被自动处理。 |

#### 性能

*与端口资源分配相关的设置。*

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**最大工作线程数**</td>
<td>此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖 [高级设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/advanced-settings.md) 页面的 [性能设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/performance-settings.md) 部分的默认设置。</td></tr>
<tr><td>**最大文件数**</td>
<td>分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖 [高级设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/advanced-settings.md) 页面的 [性能设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/performance-settings.md) 部分的默认设置。</td></tr></tbody></table>

### 告警选项卡

*与配置通知相关的设置。*

在执行服务级别协议 (SLA) 之前，需要设置电子邮件通知以接收通知。默认情况下，知行之桥 使用 [通知](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/alerts.md) 选项卡上的全局设置。要为此端口使用其他设置，请启用 **覆盖全局设置**。

默认情况下，错误通知处于启用状态，这意味着每当出现错误时都会发送电子邮件。要关闭错误通知，请取消选中 **启用** 复选框。

输入 **主题**（必填）。勾选**允许在主题中使用 ArcScript**，即可在**主题**字段中使用 ArcScript。选中后会显示 **ArcScript 编辑器**按钮（![ArcScript 编辑器按钮](https://docs.kasoftware.com/26.4/images/rest_arcscript_editor.png)）。

（可选）输入以逗号分隔的**收件人**电子邮件地址列表。

### SLA 选项卡

*与配置服务级别协议 (SLA) 相关的设置。*

SLA 允许配置预期流程中端口发送或接收的数据量，并设置预期达到该数据量的时间范围。当 SLA 未达到时，知行之桥 会发送电子邮件警告用户，并将 SLA 标记为 *存在风险*，这意味着如果 SLA 未能尽快达到，则会被标记为 *已违反*。这让用户有机会介入并确定 SLA 未达到的原因，并采取适当的措施。如果在风险时间段结束时仍未达到 SLA，则会将 SLA 标记为已违反，并再次通知用户。

SLA 转换为 *存在风险* 或 *已违反* 状态时，也会写入[应用程序日志](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/activity.md#应用程序日志)，这意味着应用性能监控 (APM) 和日志采集工具也可以针对这些状态发出警报。

要定义 SLA，请启用 **预期数据量**，然后点击 **设置** 选项卡。

![SLA Empty](https://docs.kasoftware.com/26.4/images/sla_empty.png)
<ul><li>如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 适用的方向。</li>
<li>在窗口的 **预计至少** 部分中：
<ul><li>设置预计处理的最小事务数量（交易量）</li>
<li>使用 **每个** 字段指定时间范围</li>
<li>指示 SLA 生效的时间。如果选择 **开始于**，请填写日期和时间字段。</li>
<li>勾选希望 SLA 生效的星期几对应的复选框。如有必要，请使用下拉菜单选择 **每天**。</li></ul></li>
<li>在窗口的 **将状态设置为“有风险”** 部分中，指定应将 SLA 标记为有风险的时间。
<ul><li>默认情况下，只有在违反 SLA 的情况下才会发送通知。要更改此设置，请勾选 **发送“有风险”通知**。</li></ul></li></ul>

以下示例显示了为端口配置的 SLA，该端口预计在周一至周五每天接收 1000 个文件。如果尚未收到 1000 个文件，则会在时间段结束前 1 小时发送风险通知。

![SLA Configuration Example](https://docs.kasoftware.com/26.4/images/sla_defined.png)

> [!NOTE]
>
> 如果有必要，可以关闭 SLA 通知。这在维护窗口期间非常有用。点击导航栏上的 **设置**，然后跳转到 **通知 > 通用通知**。点击平板和铅笔图标进行编辑，并取消勾选 **SLA 通知** 设置。

## 编码

编码文件时，请配置**消息设置**下的各项设置。这些设置决定文件的编码方式。

如果需要加密，请在**加密密钥**字段中指定公共加密密钥。如果需要签名，请在**签名密钥**字段中指定私有签名密钥。若要选择密钥环中的密钥，请导入密钥环文件，然后使用下拉列表选择用户 ID。若要使用私钥签名，请提供访问私钥所需的**密码短语**。

可以在[高级选项卡](#高级选项卡)上启用 **ASCII Armor** 选项，对加密数据进行 ASCII 编码以保持可读。如果签名应以明文显示，可以使用**明文签名**选项（加密文件时不可用）。

设置这些选项后，发送到 OpenPGP 端口输入目录的文件会自动编码。

## 解码

解码文件时，端口会自动尝试确定应用了哪些加密和/或签名算法，因此无需为特定算法配置端口。

如果需要解密，请在**解密密钥**字段中指定私有解密密钥（提供与用于加密的公钥对应的私钥）。如果需要验证签名，请在**验证密钥**字段中指定公共验证密钥（提供与用于签名的私钥对应的公钥）。若要选择密钥环中的密钥，请导入密钥环文件，然后使用下拉列表选择用户 ID。若要使用私钥解密，请提供访问私钥所需的**密码短语**。

设置这些选项后，发送到 OpenPGP 端口输入目录的文件会自动解码：加密文件会被解密，签名文件会被验证。

## 创建密钥

若要创建密钥：

* 选择 **Import/Export > Create Key** 开始创建新的 OpenPGP 密钥对：
  * 如果端口处于 **Encode** 模式，此项位于**签名密钥**旁边。
  * 如果端口处于 **Decode** 模式，此项位于**解密密钥**旁边。
* 输入以下信息：
  * **User Id**：至少提供 **First Name** 或 **Email** 以创建密钥。密钥的 User Id 由密钥创建向导中的名字、姓氏和电子邮件字段组成。
  * **Passphrase**：输入密码短语以保护私钥。密码短语用于解密、加密和签名操作。
  * **Key Encryption Algorithm** 和 **Key Signature Algorithm**：选择与所需加密强度对应的加密算法。选择与消息哈希所需长度对应的签名算法。
* 单击 **Create Key**。密钥会创建在相对于应用程序目录的 `data/~Profiles/OpenPGP` 文件夹中。

## 宏

在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。通过将宏合并到文件名中，可以动态地包含相关信息，例如标识符、时间戳和消息头信息，从而为每个文件提供有价值的上下文。这有助于确保文件名反映对组织重要的详细信息。

知行之桥 支持这些宏，它们都使用以下语法：`%Macro%`。

<table><thead><tr><th>宏</th><th>描述</th></tr></thead>
<tbody><tr><td>ConnectorID</td><td>替换为端口的 ConnectorID。</td></tr>
<tr><td>ConnectorName</td><td>替换为端口名称。可用于在文件名或路径中包含连接名称，例如按生成备份文件的数据库连接标记文件。</td></tr>
<tr><td>Ext</td><td>替换为端口当前正在处理的文件的文件扩展名。</td></tr>
<tr><td>Filename</td><td>替换为端口当前正在处理的文件的文件名（包括扩展名）。</td></tr>
<tr><td>FilenameNoExt</td><td>替换为端口当前正在处理的文件的文件名（不带扩展名）。</td></tr>
<tr><td>MessageId</td><td>计算端口输出的消息的 MessageId。</td></tr>
<tr><td>RegexFilename:*pattern*</td><td>将正则表达式模式应用于端口当前正在处理的文件的文件名。</td></tr>
<tr><td>Header:*headername*</td><td>替换为端口正在处理的当前消息的目标消息头（`headername`）的值。</td></tr>
<tr><td>LongDate</td><td>以常规格式计算系统的当前日期时间（例如，2024 年 1 月 24 日星期三）。</td></tr>
<tr><td>ShortDate</td><td>以 yyyy-MM-dd 格式计算系统的当前日期时间（例如 2024-01-24）。</td></tr>
<tr><td>DateFormat:*format*</td><td>以指定格式（`format`）计算系统的当前日期时间。有关可用的日期时间格式，请参阅 [示例日期格式](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/value-formatters/date-formatters.md#date-formats-with-literal-characters)。</td></tr>
<tr><td>Vault:*vaultitem*</td><td>计算指定保管库项目的值。</td></tr></tbody></table>

### 示例

某些宏（例如 %Ext% 和 %ShortDate%）不需要参数，但其他宏则需要。所有带有参数的宏都使用以下语法：`%Macro:argument%`

以下是带有参数的宏的一些示例：

<ul><li>%Header:headername%：其中 `headername` 是消息上消息头的名称。</li>
<li>%Header:mycustomheader% 解析为输入消息上设置的 `mycustomheader` 消息头的值。</li>
<li>%Header:ponum% 解析为输入消息上设置的 `ponum` 消息头的值。</li>
<li>%RegexFilename:pattern%：其中 `pattern` 是正则表达式模式。例如，`%RegexFilename:^([\w][A-Za-z]+)%` 匹配并解析为文件名中的第一个单词，并且不区分大小写（`test_file.xml` 解析为 `test`）。</li>
<li>%Vault:vaultitem%：其中 `vaultitem` 是 [vault](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/global-settings-vault.md) 中项目的名称。例如，`%Vault:companyname%` 解析为存储在保管库中的 `companyname` 项的值。</li>
<li>%DateFormat:format%：其中 `format` 是可接受的日期格式（有关详细信息，请参阅 [示例日期格式](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/value-formatters/date-formatters.md#sample-date-formats)）。例如，`%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%` 解析为文件上的日期和时间戳。</li></ul>

还可以创建更复杂的宏，如以下示例所示：

<ul><li>将多个宏组合在一个文件名中：`%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%`</li>
<li>包括宏之外的文本：`MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%`</li>
<li>在宏中包含文本：`%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%`</li></ul>

## 常见错误

### 错误：Unknown PGP Packet tag

尝试使用 OpenPGP 端口解码 GPG 消息时，可能会在**交易**选项卡和日志中看到错误 **Unknown PGP Packet tag**。

**原因**

该 GPG 消息已使用 AEAD 密码加密。AEAD 是一种[仍处于草案阶段](https://datatracker.ietf.org/doc/html/draft-ietf-openpgp-crypto-refresh-04#section-5.16)的密码，知行之桥 尚不支持。

**解决方案**

在 GPG 2.3.0 及更高版本中，使用 GPG 2.3.0 及更高版本创建的密钥加密的 GPG 消息，需要使用以下选项进行加密以禁用该密码：

`--force-mdc --rfc2440 --encrypt`

早期版本中加密的 GPG 数据包，或在 GPG 2.3.0 及更高版本中使用早期版本创建的密钥加密的 GPG 数据包，不受影响。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.