Key Capabilities
- Complete OpenPGP encryption, decryption, signing, and signature verification with multiple algorithm support
- Encoding mode (encrypt/sign) and decoding mode (decrypt/verify) with compression options
- Keyring management and ASCII armor encoding for readable encrypted data transmission
Overview
OpenPGP connectors are the primary way that 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.Message Settings
Settings related to creating an OpenPGP message. Only available when encoding.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.Advanced Tab
Advanced Settings
Settings not included in the previous categories.Logging
Settings that govern the creation and storage of logs.
| Setting | Description |
|---|---|
| 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. The Weekly option (which is the default) instructs the connector to create a new subfolder each week and store all logs for the week in that folder. Leaving this setting blank 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 Transactions tab. |
Miscellaneous
Miscellaneous settings are for specific use cases.
| Setting | Description |
|---|---|
| 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. |
Automation Tab
Settings
Settings related to the automatic processing of files by the connector.Performance
Settings related to the allocation of resources to the connector.
| Setting | Description |
|---|---|
| Max Workers | The maximum number of worker threads consumed from the threadpool to process files on this connector. If set, this overrides the default setting on the Performance Settings portion of the Advanced Settings page. |
| Max Files | The maximum number of files sent by each thread assigned to the connector. If set, this overrides the default setting on the Performance Settings portion of the Advanced Settings page. |
Alerts Tab
SLAs Tab
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/OpenPGPfolder relative to the Application Directory.
Macros
Examples
Common Errors
Error: Unknown PGP Packet tag
When attempting to decode a GPG message using the OpenPGP connector, you might get the error Unknown PGP Packet tag on the Transactions 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.