Version 24.2.9039

• Overview
• Connector Configuration
  • Settings Tab
    • Configuration
    • Message Settings
    • Keys
    • Automation
    • Performance
  • アラートタブ
    • コネクタのE メール設定
    • サービスレベル（SLA）の設定
  • Advanced Tab
    • Advanced Settings
    • Message
    • Logging
    • Miscellaneous
• Encoding
• Decoding
• Creating Keys
• Macros
  • 例
• Common Errors
  • ERROR:

The OpenPGP connector supports encryption, decryption, signing, and verification according to the Open Pretty Good Privacy standard.

Overview

OpenPGP connectors are the primary way that CData Arc supports protecting data in a flow. OpenPGP connectors operating in Encode mode can encrypt and/or sign files, and OpenPGP connectors operating in Decode mode can decrypt files and/or verify signatures. Encryption and signature verification require a public OpenPGP key, and decryption and signing require a private OpenPGP key. These keys must be created or imported into OpenPGP keyring files (.gpg) before you can use them with the application.

Connector Configuration

This section contains all of the configurable connector properties.

Settings Tab

Configuration

Settings related to the core operation of the connector.

• コネクタId コネクタの静的な一意の識別子。
• コネクタの種類 コネクタ名とその機能の説明が表示されます。
• コネクタの説明 コネクタとフローにおけるロールについて自由形式の説明を記載するオプションのフィールド。
• Operation Whether the connector is encoding or decoding incoming files. Encoding includes encrypting and signing data, and decoding includes decrypting data and verifying signatures. The connector settings change based on this setting.

Message Settings

Settings related to creating an OpenPGP message. Only available when encoding.

• Message Security Whether the connector should create an encrypted message, a signed message, or both a signed and encrypted message.
• Compression Whether the connector should compress the message before encrypting and/or signing it.
• Encryption Algorithm The symmetric algorithm to use when encrypting.
• Signature Algorithm The hash algorithm to use when signing.
• Compression Method The compression algorithm to use when compressing.

Keys

Settings related to the OpenPGP keys used by the connector. Encryption and signing are only available when encoding, while verification and decryption are only available when decoding.

• Encryption Key The user Id identifying the public key in a public keyring to use when encrypting. Import a public keyring file to view the available user Ids.
• Signing Key The user Id identifying the private key in the secret keyring to use when signing. Import a secret keyring file to view the available user Ids.
• Verification Key The user Id identifying the public key in the public keyring to use when verifying signatures. Import a public keyring file to view the available user Ids.
• Decryption Key The user Id identifying the private key in the secret keyring to use when verifying signatures. Import a secret keyring file to view the available user Ids.
• Passphrase When encoding: the passphrase for the selected private signing key. When decoding: the passphrase for the selected private decryption key.

Automation

Settings related to the automatic processing of files by the connector.

• Send Whether messages arriving at the connector are automatically processed.

Performance

コネクタへのリソースの割り当てに関する設定。

• 最大ワーカー数 このコネクタでファイルを処理するためにスレッドプールで消費されるワーカースレッドの最大数。設定された場合、これは設定 > オートメーションページのデフォルト設定をオーバーライドします。
• 最大ファイル数 コネクタに割り当てられた各スレッドが送信するファイルの最大数。設定された場合、これは設定 > オートメーションページのデフォルト設定をオーバーライドします。

アラートタブ

アラートとサービスレベル（SLA）の設定に関連する設定。

コネクタのE メール設定

サービスレベル（SLA）を実行する前に、通知用のE メールアラートを設定する必要があります。アラートを設定をクリックすると、新しいブラウザウィンドウで設定ページが開き、システム全体のアラートを設定することができます。詳しくは、アラートを参照してください。

サービスレベル（SLA）の設定

サービスレベルでは、フロー内のコネクタが送受信すると予想される処理量を設定し、その量が満たされると予想される時間枠を設定できます。CData Arc は、サービスレベルが満たされていない場合にユーザーに警告するE メールを送信し、SLA を At Risk（危険） としてマークします。これは、サービスレベルがすぐに満たされない場合に Violated（違反） としてマークされることを意味します。これにより、ユーザーはサービスレベルが満たされていない理由を特定し、適切な措置を講じることができます。At Risk の期間内にサービスレベルが満たされなかった場合、SLA はViolated としてマークされ、ユーザーに再度通知されます。

サービスレベルを定義するには、予想処理量の条件を追加をクリックします。

• コネクタに個別の送信アクションと受信アクションがある場合は、ラジオボタンを使用してSLA に関連する方向を指定します。
• 検知基準（最小）を、処理が予想されるトランザクションの最小値（量）に設定し、毎フィールドを使用して期間を指定します。
• デフォルトでは、SLA は毎日有効です。これを変更するには、毎日のチェックをOFF にし、希望する曜日のチェックをON にします。
• 期間終了前にステータスを’At Risk’ に設定するタイミングを使用して、SLA がAt Risk としてマークされるようにします。
• デフォルトでは、通知はSLA が違反のステータスになるまで送信されません。これを変更するには、‘At Risk’ 通知を送信のチェックをON にします。

次の例は、月曜日から金曜日まで毎日1000ファイルを受信すると予想されるコネクタに対して構成されたSLA を示しています。1000ファイルが受信されていない場合、期間終了の1時間前にAt Risk 通知が送信されます。

Advanced Tab

Advanced Settings

Settings not included in the previous categories.

• ASCII Armor Whether ASCII-encoding should be applied to OpenPGP messages generated by the connector.
• Clear Signature Whether the OpenPGP signature should appear in clear text. Not applicable when encrypting messages.
• 処理の遅延 インプットフォルダに置かれたファイルの処理を遅延させる時間（秒）。これは旧式の設定です。代替として、ローカルファイルシステムの管理にはFile コネクタの使用がベストプラクティスです。
• ローカルファイルスキーム コネクタがアウトプットするメッセージにファイル名を割り当てるスキーム。ファイル名にマクロを動的に使用して、識別子やタイムスタンプなどの情報を含めることができます。詳しくは、マクロ を参照してください。

Message

• Sent フォルダに保存 チェックすると、コネクタで処理されたファイルをコネクタのSent フォルダにコピーします。
• Sent フォルダのスキーム 選択された時間間隔に従ってSent フォルダ内のメッセージをグループ化するようコネクタに指示します。例えば、Weekly オプションを選択すると、コネクタは毎週新しいサブフォルダを作成してその週のすべてのメッセージをそのフォルダに格納します。ブランクに設定すると、コネクタはすべてのメッセージをSent フォルダに直接保存します。多くのメッセージを処理するコネクタの場合、サブフォルダを使用するとメッセージが整理されてパフォーマンスが向上します。

Logging

• Log Level The verbosity of logs generated by the connector. When you request support, set this to Debug.
• Log Subfolder Scheme Instructs the connector to group files in the Logs folder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all logs for the week in that folder. The blank setting tells the connector to save all logs directly in the Logs folder. For connectors that process many transactions, using subfolders helps keep logs organized and improves performance.
• Log Messages Check this to have the log entry for a processed file include a copy of the file itself. If you disable this, you might not be able to download a copy of the file from the Input or Output tabs.

Miscellaneous

Miscellaneous settings are for specific use cases.

• Other Settings Enables you to configure hidden connector settings in a semicolon-separated list (for example, setting1=value1;setting2=value2). Normal connector use cases and functionality should not require the use of these settings.

Encoding

When encoding files, configure each of the settings under Message Settings. These determine how the file is encoded.

If encryption is required, specify a public encryption key in the Encryption Key field. If signing is required, specify a private signing key in the Signing Key field. To select a key in a keyring, import the keyring file then use the dropdown to choose a user Id. To sign with a private key, provide the Passphrase required to access the private key.

You can enable the ASCII Armor option on the Advanced tab to ASCII-encode encrypted data so that it remains readable. You can use the Clear Signature option if the signature should appear in clear text (not possible when encrypting files).

Once you set these options, files sent to the input directory of the OpenPGP connector are automatically encoded.

Decoding

When decoding files, the connector automatically attempts to determine what encryption and/or signature algorithms were applied, so you do not need to configure the connector for specific algorithms.

If decryption is required, specify a private decryption key in the Decryption Key field (supply the private key that corresponds to the public key that was used to encrypt). If signature verification is required, specify a public verification key in the Verification Key field (supply the public key that corresponds to the private key used to sign). To select a key in a keyring, import the keyring file then use the dropdown to choose a user Id. To decrypt with a private key, provide the Passphrase required to access the private key.

Once you set these options, files sent to the input directory of the OpenPGP connector are automatically decoded: encrypted files are decrypted, and signed files are verified.

Creating Keys

To create a key:

• Select Import/Export > Create Key to begin creating a new OpenPGP key pair:
  • If the connector is in Encode mode, this is next to Signing Key.
  • If the connector is in Decode mode, this is next to Decryption Key.
• Enter the following information:
  • User Id: Provide at least First Name or Email to create a key. The User Id for the key is comprised of the first name, last name, and email fields in the key creation wizard.
  • Passphrase: Enter a passphrase to protect the private key. The passphrase is used in the decrypt, encrypt, and sign operations.
  • Key Encryption Algorithm and Key Signature Algorithm: Select the encryption algorithm that corresponds to the desired strength of your encryption. Select the signature algorithm that corresponds to the desired length of the hash of the message.
• Click Create Key. Keys are created in the data/~Profiles/OpenPGP folder relative to the Application Directory.

Macros

ファイルの命名規則にマクロを使用することで、組織の効率とデータの文脈的理解を高めることができます。マクロをファイル名に組み込むことで、識別子、タイムスタンプ、ヘッダー情報などの関連情報を動的に含めることができ、各ファイルに有益なコンテキストを付与できます。これにより、組織にとって重要な詳細をファイル名に反映させることができます。

CData Arc はこれらのマクロをサポートしており、すべて次の構文を使用します：%Macro%

Macro	説明
ConnectorID	コネクタのConnectorID を返します。
Ext	コネクタが処理中のファイルの拡張子を返します。
Filename	コネクタが処理中のファイルのファイル名（拡張子を含む）を返します。
FilenameNoExt	コネクタが処理中のファイルのファイル名（拡張子なし）を返します。
MessageId	コネクタがアウトプットするメッセージのMessageId を返します。
RegexFilename:pattern	コネクタで処理中のファイルのファイル名にRegEx パターンを適用します。
Header:headername	コネクタが処理中のメッセージのヘッダー（headername）の値を返します。
LongDate	システムの現在の日時を長い形式（例：Wednesday, January 24, 2024）で返します。
ShortDate	システムの現在の日時をyyyy-MM-dd 形式（例：2024-01-24）で返します。
DateFormat:format	システムの現在の日時を指定されたフォーマット（format）で返します。使用可能な日付フォーマットについては、サンプル日付フォーマット を参照してください。
Vault:vaultitem	指定されたvault 項目の値を返します。

例

%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% はVault に保存されているcompanyname アイテムの値を返します。
• %DateFormat:format%：format は使用可能な日付フォーマットです（詳細はサンプル日付フォーマット を参照してください）。例えば、%DateFormat:yyyy-MM-dd-HH-mm-ss-fff% はファイルの日付とタイムスタンプを返します。

以下の例に示すように、より詳細なマクロを作成することもできます。

• 複数のマクロを1つのファイル名にまとめる：%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%

Common Errors

ERROR:

When attempting to decode a GPG message using the OpenPGP connector, you might get the error Unknown PGP Packet tag on the Input tab and in the logs.

Cause

The GPG message has been encrypted with the AEAD cipher. AEAD is a cipher that is still in draft, and Arc does not yet support it.

Resolution

GPG messages encrypted in GPG 2.3.0 and later using keys created in GPG 2.3.0 and later need to be encrypted using the following options to disable the cipher:

--force-mdc --rfc2440 --encrypt

GPG packets encrypted in earlier releases or encrypted in GPG 2.3.0 or later using keys created in prior releases are not affected.