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