...

...

...

...

Disclaimer

...

Refer to Changelog for version history information.

Software Requirements

This integration requires a Universal Agent and a Python runtime to execute the 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.

...

• Universal Agent for Windows x64 Version 7.13.0.0 and later with python options installed.
• Universal Agent for Linux Version 7.13.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.13.0.0 and later.

Network and Connectivity Requirements

...

Example for encrypting a file:

...

Image Added

The configuration on UDMG for the public key:

...

Image Added

Decrypt a file

Example for decrypting a file:

...

Image Added

The configuration on UDMG for the private key:

...

Image Added

Task Output

Output Only Fields

...

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

...

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')}

Image Added

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.

...

This document references the following documents.

Anchor
Changelog Changelog

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