| Panel | |
|---|---|
|
...
| Template Name | Extension Name | Extension Version |
|---|---|---|
| UDMG OpenPGP | ue-udmg-openpgp | 1.0.0 |
Refer to Changelog for version history information.
...
Modifications of this integration, applied by users or customers, before or after import, might affect the supportability of this integration. For more information refer to Integration Modifications.
Configure Universal Task
...
| Field | Input type | Default value | Type | Description |
|---|---|---|---|---|
| Action | Required | Encrypt | Choice | Action performed upon the task execution. Available actions:
|
| Armor | Optional | true | Boolean | Encode using ASCII Armor format. Only for Action Encrypt |
| UDMG Server | Required | - | Text | UDMG Server URL. For example: http://localhost:18080/api |
| UDMG Credentials | Required | - | Credentials | UDMG Server Credentials. The Credentials definition should be as follows.
|
| File | Required | - | Text | The name of the input file |
| Output File | Optional | - | Text | The name of the output file. If not provided, the file is extracted in the Runtime Directory and the name is constructed as:
|
| Public Key | Required | - | Text | Name of the PGP key record on UDMG keystore that contains the public key. Dynamic Choice field populated with the list of public PGP keys accessible to this UDMG user. Only for Action Encrypt |
| Private Key | Required | - | Text | Name of the PGP key record on UDMG keystore that contains the private key and passphrase. Dynamic Choice field populated with the list of private PGP keys accessible to this UDMG user. Only for Action Decrypt |
| Post Action | Optional | -- None-- | Choice | Action performed upon the task execution. Available actions:
|
| Archive Path | Required | - | Text | Archive directory where the input file is moved to after processing Only for Post Action Archive |
| Sign | Optional | false | Boolean | Sign the document with a private PGP key. Only for Action Encrypt |
| Private Signing Key | Optional | - | Dynamic Choice | Name of the PGP key record on UDMG keystore that contains the private key for the signing. Dynamic Choice field populated with the list of private PGP keys accessible to this UDMG user. Only if Sign is selected |
| Verify | Optional | false | Boolean | Verify the signature with a public PGP key. Only for Action Decrypt |
| Public Verification Key | Optional | - | Dynamic Choice | Name of the PGP key record on UDMG keystore that contains the public key for the signature verification. Dynamic Choice field populated with the list of public PGP keys accessible to this UDMG user. Only if Verify is selected |
Task Examples
...
| Attribute | Type | Description |
|---|---|---|
| encrypted_file | string | The name of the file that is encrypted, the input file for Decrypt action, the output file for Encrypt action |
| decrypted_file | string | The name of the file that is not encrypted, the output file for Decrypt action, the input file for Encrypt action |
| embedded_filename | string | The original filename that is embedded in the gpg pgp message, if any |
An example of the Extension Output for file encryption is presented below.
...
${_outputJsonPath('EXTENSION', '$.result.files[0].decrypted_file')}
See Creating a Set Variable Action within a Task or Workflow and Functions.
STDOUT and STDERR
STDOUT and STDERR provide additional information to User. The populated content can be changed in future versions of this extension without notice. Backward compatibility is not guaranteed.
...
Integration Modifications
Modifications applied by users or customers, before or after import, might affect the supportability of this integration. The following modifications are discouraged to retain the support level as applied for this integration.
Python code modifications should not be done.
Template Modifications
General Section
"Name", "Extension", "Variable Prefix", and "Icon" should not be changed.
Universal Template Details Section
"Template Type", "Agent Type", "Send Extension Variables", and "Always Cancel on Force Finish" should not be changed.
Result Processing Defaults Section
Success and Failure Exit codes should not be changed.
Success and Failure Output processing should not be changed.
Fields Restriction Section
The setup of the template does not impose any restrictions, However with respect to the "Exit Code Processing Fields" section.Success/Failure exit codes need to be respected.
In principle, as STDERR and STDOUT outputs can change in follow-up releases of this integration, they should not be considered as a reliable source for determining the success or failure of a task.
Event Template configuration related to “Metric Label Attributes” & “Optional Metric Labels” is allowed. However, administrators should be cautious of high cardinality scenarios that might occur
Users and customers are encouraged to report defects, or feature requests at Stonebranch Support Desk.
Document References
This document references the following documents.
...
Deprecation: ue-mft-pgp (UDMG PGP) is deprecated and replaced by ue-udmg-openpgp (UDMG OpenPGP)
Enhancements
Add: Ability to sign message during encryption. (#32816)Add: Ability to verify message’s signature during decryption. (#32816)Add: Use preferred cipher algorithm from public key for encryption. (#31295)Changed: PGP key template fields from text to dynamic choice. (#32908)
ue-mft-pgp-1.1.1 (2023-02-02)
...
Fix: Correct the handling of binary/ascii mode for GPG message content. (#31308)
ue-mft-pgp-1.0.1 (2022-08-23)
...