Version 24.3.9111

• 概述
• 端口配置
  • 设置页面
    • 配置
    • 消息设置
    • 密钥
    • 自动化设置
    • 性能
  • 通知
    • 端口邮件设置
    • 服务等级协议 (SLA) 配置
  • 高级设置
    • 高级设置
    • 消息
    • 日志
    • 特殊设置
• 编码
• 解码
• 创建密钥
• 宏
  • 示例
• 常见错误
  • 错误:

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

概述

OpenPGP 端口是知行之桥支持保护工作流中数据的主要方式。运行在编码模式下的 OpenPGP 端口可以加密／签名文件，运行在解码模式下的 OpenPGP 端口可以解密文件／验证签名。加密和签名验证需要一个公共的 OpenPGP 密钥，解密和签名需要一个私有的 OpenPGP 密钥。在与应用程序一起使用之前这些密钥必须导入到 OpenPGP 密钥文件（.gpg）中。

端口配置

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

设置页面

配置

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

• 端口 Id 端口的静态、唯一标识符。
• 端口类型 显示端口类型及其用途的描述。
• 端口描述 一个可选字段，用于提供端口及其在流中的角色的自由格式描述。
• 操作 端口是对输入文件进行编码或解码。编码包括加密和签名数据，解码包括解密数据和验证签名。端口的可用设置将根据操作方式的不同而变化。

消息设置

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

• 消息安全性 端口是否应创建加密消息、签名消息或签名和加密消息。
• 压缩 端口是否应该在加密／签名之前压缩消息。
• 加密算法 加密时使用的对称算法。
• 签名算法 签名时使用的哈希算法。
• 压缩方式 压缩时使用的压缩算法。

密钥

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

• 加密密钥 标识加密时要使用的公共密钥中的公钥用户标识。导入公钥文件以查看可用的用户标识。
• 签名密钥 标识签名时要使用的密钥中的私钥的用户标识。导入私钥文件以查看可用的用户标识。
• 验证密钥 标识公钥中公钥的用户标识，用于验证签名。导入公钥文件以查看可用的用户标识。
• 解密密钥 在验证签名时，标识密钥中的私钥的用户标识。导入密钥文件以查看可用的用户标识。
• 密码 编码时，所选私有签名密钥的密码。解码时，所选私有解密密钥的密码。

自动化设置

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

• 发送 到达端口的消息是否会被自动处理。

性能

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

• 最大线程数 从线程池中消耗用于处理此端口上的文件的最大工作线程数。 如果设置，这将覆盖 设置 > 自动化 页面上的默认设置。
• 最大文件数 分配给端口的每个线程发送的最大文件数。 如果设置，这将覆盖 设置 > 自动化 页面上的默认设置。

通知

与配置警报和服务等级协议 (SLA) 相关的设置。

端口邮件设置

在执行 SLA 之前，需要设置电子邮件警报以获取通知。 单击 配置通知 将打开一个新的浏览器窗口，转到 系统设置，可以在其中设置系统范围的警报。 有关详细信息，请参阅通知。

服务等级协议 (SLA) 配置

SLA 能够配置期望工作流中的端口发送或接收的数量，并设置期望满足该数量的时间范围。 知行之桥在不满足 SLA 时发送电子邮件警告用户，并将 SLA 标记为 有风险，这意味着如果很快不满足 SLA，则会将其标记为 已违反。 这使用户有机会介入并确定未满足 SLA 的原因，并采取适当的措施。 如果在风险时间段结束时仍未满足 SLA，则将 SLA 标记为违反，并再次通知用户。

要定义 SLA，请单击 添加预期数量条件。

• 如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 所属的方向。
• 将 期待至少 设置为期望处理的最小交易数量（交易量），然后使用 每 字段指定时间范围。
• 默认情况下，SLA 每天都有效。 要更改此设置，请取消选中每日，然后选中想要的一周中的几天的框。
• 使用 将状态设置为“有风险” 来指示何时应将 SLA 标记为存在风险。
• 默认情况下，在违反 SLA 之前不会发送通知。 要更改此设置，请选中 发送“有风险”通知。

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

高级设置

高级设置

设置不包括在以前的类别中。

• ASCII Armor 是否应对端口生成的 OpenPGP 消息应用 ASCII 编码。
• 明文签名 OpenPGP 签名是否应该以明文形式出现。加密消息时不适用。
• 延迟处理 放置在输入文件夹中的文件的处理延迟的时间量（以秒为单位）。 这是一个遗留设置。 最佳实践是使用 File 端口 来管理本地文件系统，而不是此设置。
• 本地文件名格式 用于为端口输出的消息分配文件名的方案。 可以在文件名中动态使用宏来包含标识符和时间戳等信息。 有关详细信息，请参阅宏。

消息

• 保存至 Sent 文件夹 选中此选项可将端口处理的文件复制到端口的已发送文件夹中。
• 已发送文件夹方案 指示端口根据选定的时间间隔对已发送文件夹中的消息进行分组。 例如，Weekly 选项指示端口每周创建一个新的子文件夹，并将该周的所有消息存储在该文件夹中。 空白设置告诉端口将所有消息直接保存在“已发送”文件夹中。 对于处理许多消息的端口，使用子文件夹有助于保持消息的组织性并提高性能。

日志

• 日志级别 端口生成的日志的详细程度。 当端口请求支持时，请将其设置为 Debug。
• 日志子文件夹方案 指端口根据选定的时间间隔对日志文件夹中的文件进行分组。 例如，Weekly 选项表示端口每周创建一个新子文件夹并将该周的所有日志存储在该文件夹中。 空白设置告诉端口将所有日志直接保存在 Logs 文件夹中。 对于处理大量事务的端口，使用子文件夹有助于保持日志井井有条并提高性能。
• 保留消息副本 选中此项可使已处理文件的日志条目包含文件本身的副本。 如果禁用此功能，端口可能无法从 输入 或 输出 选项卡下载文件的副本。

特殊设置

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

• 其他设置 允许在以分号分隔的列表中配置隐藏的端口设置，例如setting1=value1;setting2=value2。 正常的端口用例和功能不需要使用这些设置。

编码

编码文件时，应配置消息设置下的每个配置，这些决定了文件的编码方式。

如果需要加密，则必须使用公共加密密钥指定“加密密钥”。 如果需要签名，则必须使用私有签名密钥指定“签名密钥”。 要选择密钥环中的特定密钥，请导入密钥环文件，然后使用下拉菜单选择适当的 UserId。 要使用私钥签名，还必须使用访问私钥所需的密码来设置 密码 设置。

可以启用 ASCII Armor 高级选项对加密数据进行 ASCII 编码，以保持其可读性。如果签名应该以明文显示，则可以启用明文签名高级选项（请注意，加密文件时不支持）。

一旦设置了这些选项，发送到 OpenPGP 端口输入目录的文件将根据上述设置自动编码。

解码

解码文件时，端口将自动尝试确定应用了什么加密／签名算法，因此没有必要为特定算法配置端口。

如果需要解密，则必须使用私有解密密钥（对应于用于加密的公钥的私有密钥）指定“解密密钥”。 如果需要签名验证，Verification Key必须指定验证公钥（公钥对应于用于签名的私钥）。 要选择密钥环中的特定密钥，请导入密钥环文件，然后使用下拉菜单选择适当的 UserId。 要使用私钥解密，还必须使用访问私钥所需的密码来设置 密码 设置。

一旦设置了这些选项，发送到 OpenPGP 端口输入目录的文件将被自动解码：如果它被加密，它将被解密，如果它被签名，签名将被验证。

创建密钥

创造密钥：

• 选择导入／导出 -> 创建密钥去开始创建一个新的 OpenPGP 密钥对
  • 如果端口处于编码模式，这可以在签名密钥旁边找到
  • 如果端口处于解码模式，这可以在解密密钥旁边找到
• 输入以下信息
  • 用户标识： 至少选择一个名字或邮箱来创建一个密钥。密钥的用户标识由密钥创建向导中的名字、姓氏和邮箱选项组成。
  • 密码： 输入密码以保护私钥。密码用于解密、加密和签名操作。
  • 密钥加密算法和密钥签名算法： 选择与所需加密强度相对应的加密算法。选择与消息哈希的所需长度相对应的签名算法。
• 单击创建密钥。密钥在与应用程序目录相关的data/~Profiles/OpenPGP 文件夹中创建。

宏

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

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

宏	描述
ConnectorID	替换为端口的 ConnectorID。
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	计算指定保管库项目的值。

示例

某些宏（例如 %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%解析为文件上的日期和时间戳。

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

• 将多个宏组合在一个文件名中：%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%

常见错误

错误:

当尝试使用 OpenPGP 端口解码 GPG 消息时，错误 Unknown PGP Packet tag 会出现在 输入 选项卡和端口日志中。

原因

AEAD加密已经被用于 GPG 消息了。AEAD是一种 仍在草案中 的新密码{:target=”_blank”}，知行之桥尚不支持。

解决方案

在 GPG 2.3.0 或更高版本中使用在 GPG 2.3.0 或更高版本中创建的密钥加密的 GPG 消息时，将需要使用以下选项加密以禁用加密:

--force-mdc --rfc2440 --encrypt

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