UDMG PGP
Disclaimer
Your use of this download is governed by Stonebranch’s Terms of Use, which are available at https://www.stonebranch.com/integration-hub/Terms-and-Privacy/Terms-of-Use/
Overview
UDMG (Universal Data Mover Gateway) is a business-to-business MFT (Managed File Transfer) Solution. It provides the capabilities to securely manage File transfers with external business partners (i.e. Customers or Suppliers), and between any endpoint in today’s Hybrid-IT infrastructure, on-premises, or in the cloud (public and or private). It also comes up with a keystore for PGP public and private keys.
This Universal Extension provides the capability to perform OpenGPG encryption and decryption on a file while keeping the PGP keys in the UDMG keystore.
Version Information
Template Name | Extension Name | Extension Version |
---|---|---|
UDMG PGP | ue-mft-pgp | 1.0.1 |
Software Requirements
This integration requires a Universal Agent and a Python runtime to execute the Universal Task.
Software Requirements for Universal Template and Universal Task
Requires Python 3.7.0 or higher.
Requires _bz2 python library and the cryptography and cffi python modules.
Tested with the Universal Agent bundled Python distribution which provides all required dependencies.
Software Requirements for Universal Agent
Both Windows and Linux agents are supported.
- Universal Agent for Windows x64 Version 7.1.0.0 and later with python options installed.
- Universal Agent for Linux Version 7.1.0.0 and later with python options installed.
Note: For Debian Linux, the Agent software package may not contain all dependencies. For versions below 7.1.0.3 and 7.2.0.2, it is required to install both the Agent bundled Python and the Debian system Python 3.7.
Software Requirements for Universal Controller
Universal Controller Version 7.1.0.0 and later.
Network and Connectivity Requirements
Universal Agent requires connectivity towards the UDMG server REST API.
Key Features
This Universal Extension provides the following key features:
- Actions
- Encrypt a file.
- Decrypt a file.
- File Management
- Source file can be deleted after processing.
- Source file can be archived to a specific after processing.
- Key Management
- PGP keys are retrieved online from UDMG without keeping them in files or keyrings.
- Other
- Binary or ASCII armored format.
- Internal encryption without the need for GPG tool.
Import Universal Template
To use the Universal Template, you first must perform the following steps.
This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.
To import the Universal Template into your Controller, follow the instructions here.
When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.
Configure Universal Task
For a new Universal Task, create a new task, and enter the required input fields.
Input Fields
The input fields for this Universal Extension are described below.
Field | Input type | Default value | Type | Description |
---|---|---|---|---|
Action | Required | Encrypt | Choice | Action performed upon the task execution. Available actions:
|
Armor | Optional | true | Boolean | Only for Action Encrypt |
MFT Server | Required | - | Text | UDMG Server URL. For example: http://localhost:8080/api |
MFT 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. Only for Action Encrypt |
Private Key | Required | - | Text | Name of the PGP key record on UDMG keystore that contains the private key and passphrase. 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 |
Task Examples
Encrypt a file
Example for encrypting a file:
The configuration on UDMG for the public key:
Decrypt a file
Example for decrypting a file:
The configuration on UDMG for the private key:
Task Output
Output Only Fields
N/A
Exit Codes
The exit codes for this Universal Extension are described below.
Exit Code | Status Classification Code | Status Classification Description | Status Description |
---|---|---|---|
0 | SUCCESS | Successful Execution | SUCCESS |
1 | FAIL | Failed Execution | FAIL: < Error Description > |
2 | AUTHENTICATION_ERROR | Bad credentials | AUTHENTICATION_ERROR: Account cannot be authenticated. |
3 | AUTHORIZATION_ERROR | Insufficient Permissions | AUTHORIZATION_ERROR: Account is not authorized to perform the requested action. |
10 | CONNECTION_ERROR | Bad connection data or connection timed out | CONNECTION_ERROR: < Error Description > |
11 | CONNECTION_ERROR | Extension specific connection error | CONNECTION_ERROR: 404 page not found |
20 | DATA_VALIDATION_ERROR | Input fields Validation Error | DATA_VALIDATION_ERROR: 400 bad request: |
21 | PGP_ERROR | PGP processing error | PGP_ERROR: general error during processing: [] |
22 | PGP_ERROR | PGP processing Error | PGP_ERROR: error during encryption: [] |
23 | PGP_ERROR | PGP processing Error | PGP_ERROR: error during decryption: [] |
30 | PGP_ERROR | PGP processing Error | PGP_ERROR: SSL cipher not supported: [] |
31 | PGP_ERROR | PGP processing Error | PGP_ERROR: insecure cipher not allowed: [] |
32 | PGP_ERROR | PGP processing Error | PGP_ERROR: not implemented feature: [] |
See description of the Transfer Error Code: https://doc.waarp.org/waarp-gateway/0.5.1/fr/reference/errorcodes.html
Extension Output
In the context of a workflow, subsequent tasks can rely on the information provided by this integration as Extension Output.
Attribute changed
is populated as follows"
- false, in case no file was processed.
- true, in case the file was processed.
The Extension output contains attribute result
. Attribute result
contains the following sub-attributes:
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 message, if any |
An example of the Extension Output for file encryption is presented below.
{
"exit_code": 0,
"status_description": "SUCCESS: MFT Encrypt executed successfully!",
"changed": true,
"invocation": {
"extension": "ue-mft-pgp",
"version": "1.0.0",
"fields": {
"action": "Encrypt",
"mft_server": "http://localhost:9180/api",
"credentials_username": "****",
"credentials_password": "****",
"input_file": "/atests/testdata/export.md",
"output_file": "",
"private_key_name": null,
"public_key_name": "test1.pub",
"post_action": null,
"archive_path": null,
"armor": true,
"use_embedded_filename": true
}
},
"result": {
"files": [
{
"encrypted_file": "/atests/testdata/export.md.asc",
"decrypted_file": "/atests/testdata/export.md",
"embedded_filename": null
}
]
}
}
An example of the Extension Output for file decryption is presented below.
{
"exit_code": 0,
"status_description": "SUCCESS: MFT Decrypt executed successfully!",
"changed": true,
"invocation": {
"extension": "ue-mft-pgp",
"version": "1.0.0",
"fields": {
"action": "Decrypt",
"mft_server": "http://localhost:9180/api",
"credentials_username": "****",
"credentials_password": "****",
"input_file": "/atests/testdata/export.md.asc",
"output_file": "export.txt",
"private_key_name": "test1.key",
"public_key_name": null,
"post_action": "Delete",
"archive_path": null,
"armor": false,
"use_embedded_filename": true
}
},
"result": {
"files": [
{
"encrypted_file": "/atests/testdata/export.md.asc",
"decrypted_file": "export.txt",
"embedded_filename": "export.md"
}
]
}
}
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.
Document References
This document references the following documents.
Document Link | Description |
---|---|
Universal Templates | User documentation for creating, working with and understanding Universal Templates and Integrations. |
Universal Tasks | User documentation for creating Universal Tasks in the Universal Controller user interface. |
Credentials | User documentation for creating and working with credentials. |
Resolvable Credentials Permitted Property | User documentation for Resolvable Credentials Permitted Property. |
PGP Key Management (UDMG Server CLI) | Management of PGP keys with the command line interface |
PGP Key Management (UDMG Server Web Services) | Management of PGP keys with the web services |