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

Refer to Changelog for version history information.

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. For bz2 support on Linux, the following package must be installed bzip2-devel or libbz2-dev, the exact name depends on the perating system flavor and version.

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.3.0.0 and later with python options installed.
• Universal Agent for Linux Version 7.3.0.0 and later with python options installed.

Software Requirements for Universal Controller

Universal Controller Version 7.3.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.

1. This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.

2. To import the Universal Template into your Controller, follow the instructions here.

3. 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.

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.

See description of the Transfer Error Code: https://doc.waarp.org/waarp-gateway/0.7.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:

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"
            }
        ]
    }
}

An example of a Set Variable Action to fetch the decrypted file name from the Extension output with a function:

${_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.

Document References

This document references the following documents.

Changelog

ue-mft-pgp-1.1.1 (2023-02-02)

• Fix: Warning for preferred compression = Uncompressed (#31672)

ue-mft-pgp-1.1.0 (2023-01-31)

• Add: use preferred compression algorithm from public key for encryption. (#31273)
• Add: upgrade PGPy to 0.6 . (#31273)

ue-mft-pgp-1.0.2 (2023-01-12)

• Fix: Correct the handling of binary/ascii mode for GPG message content. (#31308)

ue-mft-pgp-1.0.1 (2022-08-23)

• Initial version