ICAP 端口

Version 25.3.9400


ICAP 端口


ICAP 端口支持与知行之桥中的互联网内容适配协议 (ICAP) 服务器无缝集成。此端口充当应用程序和 ICAP 兼容服务器之间的中介,从而促进内容适配服务,尤其是实时安全扫描。

关键功能

  • 实时内容适配和安全扫描
  • 支持请求修改 (REQMOD) 和响应修改 (RESPMOD) 模式
  • 支持 TLS 加密,确保安全通信
  • 可自定义 HTTP 封装,兼容旧系统
  • 灵活的身份验证选项,包括私有证书支持
  • 可用作流程中的“转换”步骤。标记为需要注意的文件会产生错误,而其他文件则照常继续执行流程。

端口配置

此部分包含所有可配置的端口属性。

设置

与端口核心配置相关的设置。

  • 端口 Id 端口的静态、唯一标识符。
  • 端口类型 显示端口类型及其用途的描述。
  • 端口描述 一个可选字段,用于提供端口及其在流中的角色的自由格式描述。
  • ICAP URI(必需)要连接的 ICAP 服务器的 ICAP 统一资源标识符 (URI)。必须采用以下格式:icap://<hostname>:<port>/<service_name>
  • ICAP 头 可选标头,用于满足特定服务器的要求。使用此选项可添加要包含在传出 ICAP 请求中的自定义 ICAP 请求标头。
  • TLS 配置 勾选此项可为 ICAP 连接启用 TLS 加密。
  • TLS 服务器证书 用于验证 TLS/SSL 服务器身份的公钥证书。仅当 ICAP 服务器启用了 TLS 时才需要此项。将其设置为 Any Certificate 可无条件信任 ICAP 服务器的身份。仅在启用TLS 配置时才相关。
  • 本地文件名格式 用于为端口输出的消息分配文件名的方案。 可以在文件名中动态使用宏来包含标识符和时间戳等信息。 有关详细信息,请参阅

高级选项卡

TLS 客户端身份验证

  • 私钥证书 选择、创建或上传用于身份验证的 TLS 证书。
  • 证书密码 访问私钥证书所需的密码。

其他设置

  • ICAP 模式 指定 ICAP 事务的类型:使用 REQMOD 进行请求修改,或使用 RESPMOD 进行响应修改。默认为 REQMOD。
  • 头中的 ArcScript 允许在发出查询之前求值标头中的 ArcScript 表达式。例如,[_ | now('yyyy-MM-dd')] 求值当前日期,[_message.header:headername] 求值输入消息上下文中的 headername 标头。
  • URL 中的 ArcScript 允许在发出查询之前求值 URL 中的 ArcScript 表达式。例如,[_ | now('yyyy-MM-dd')] 求值当前日期,[_message.header:headername] 求值输入消息上下文中的 headername 标头。
  • 预览大小 控制发送到 ICAP 服务器的消息正文预览的大小。 Automatic 选项会让客户端使用 OPTIONS 请求查询服务器,以确定最佳预览大小。或者,可以指定预览大小的确切数字(以字节为单位)。
  • 数据块大小 预览阶段后发送的每个数据块的最大大小(以字节为单位)(或对于没有预览的请求)。默认值为 16KB。
  • 超时(秒) 端口在抛出超时错误之前等待连接响应的时间(以秒为单位)。默认值为 60 秒。
  • 响应标头 以逗号分隔的 ICAP 响应标头名称列表(例如X-Infection-Found,X-Scan-Result)将被提取并作为元数据添加到已处理的消息中。
  • 启用 TLS 的协议 建立传出连接时支持的 TLS/SSL 协议列表。最佳做法是仅使用 TLS 协议。但是,某些过时的操作系统不支持 TLS 1.2。 TLS v1.3 尚未被普遍采用,如果目标服务器不支持,可能会被拒绝。

代理设置

这些是一组设置,用于识别和验证代理(AS2 连接应通过该代理进行路由)。 默认情况下,此部分在 安全设置 页面的 代理设置。 清除该复选框可提供特定于的端口的设置。

  • 代理类型 基于代理的防火墙使用的协议。
  • 代理主机 基于代理的防火墙的名称或 IP 地址。
  • 代理端口 基于代理的防火墙的 TCP 端口。
  • 代理用户 用于通过基于代理的防火墙进行身份验证的用户名。
  • 代理密码 用于对基于代理的防火墙进行身份验证的密码。
  • 身份验证方案 保留默认值 None 或选择以下身份验证方案之一:BasicDigestProprietaryNTLM

日志

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

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

特殊设置

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

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

自动化

自动化设置

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

  • 发送 到达端口的文件是否自动作为 ICAP 事务发送。

性能

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

  • 最大工作线程数 此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置,则会覆盖 高级设置 页面的 性能设置 部分的默认设置。
  • 最大文件数 分配给端口的每个线程发送的最大文件数。如果设置,则会覆盖 高级设置 页面的 性能设置 部分的默认设置。

通知选项卡

与配置通知相关的设置。

在执行服务级别协议 (SLA) 之前,需要设置电子邮件通知以接收通知。默认情况下,知行之桥使用 通知 选项卡上的全局设置。要为此端口使用其他设置,请启用覆盖全局设置

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

输入主题(必填),然后(可选)输入以逗号分隔的收件人电子邮件列表。

SLA 选项卡

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

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

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

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

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

事务

此选项卡列出了与端口关联的所有消息。使用搜索栏查找特定消息,或点击漏斗图标应用过滤器。您可以按时间、消息方向和/或状态进行过滤。

收到的响应会显示在此选项卡上。

事件

  • Response 此事件允许扩展端口解析来自 ICAP 服务器的回复的方式。默认情况下,端口会根据 ICAP 服务器的状态代码最终确定消息。但是,由于 ICAP 服务器也可以在响应标头中包含扫描详细信息,因此可以通过 Response 事件对这些标头应用自定义逻辑,以实现更精细的控制。此事件不会创建任何输出;但是,可以使用 arc:throw 关键字来阻止文件(例如,如果特定标头值指示扫描失败)。
  • Before Send 此事件在端口完全准备好文件以发送/处理文件之后,但在实际发送/处理发生之前触发。
  • After Receive 此事件在端口收到文件之后触发。

Response 事件中可用的参数如下:

  • StatusCode:ICAP 响应状态代码(例如 200、204 或 4xx)
  • _response:ICAP 响应。您可以使用 [_response.header:xxx] 获取特定的响应头。
  • _message:用于引用输入消息(响应头和正文),并将响应头添加到输出中。

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

知行之桥 支持这些宏,它们都使用以下语法:%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%:其中 vaultitemvault 中项目的名称。 例如,%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%