For the UDMG Web Transfer Client, please refer to UDMG Web Transfer Client for Linux Installation.

Upgrading Universal Data Mover Gateway

Upgrading UDMG refers to the increase of a currently installed pre-2.0.x Version, Release, or Modification level of UDMG (1.5.x, 1.4.x, 1.3.x, 1.2.x) to UDMG 2.0.x.

As a precautionary measure, it is highly recommended that you back up the UDMG database prior to upgrading.

Upgrading from a pre-2.0 UDMG release

If you are upgrading an installation of UDMG from any release before 2.0.0.0, the following changes must be reviewed carefully.

License Key

Starting with UDMG version 2.0, a license key must be provided to enable file transfers.

Contact your Stonebranch representative or Customer Support to receive the license key before upgrading to version 2.0 or later.

Shared Account

(1) Local Accounts are converted to Shared Accounts

Before this change, a local account was only defined for a given local server and not allowed to have the same account for multiple protocols. For instance, to allow a partner to transfer files over SFTP and FTP, it was required to have both an SFTP and FTP local server, each with their own local account. Each account was then maintained independently, which created additional overhead in configuration and maintenance (password or key updates). A shared Account is created once and can be assigned to several Local Servers, sharing the same login, password, and authentication records.

A migrated account has the following characteristics:

Linked to the Local Server that owned the Local Account. The new Shared Account can later be assigned to other servers.
Member of the same Business Services as the Local Server. The Shared Account membership to Business Services can be modified later but must retain compatibility between Server memberships and Shared Account memberships
Account name is composed of the original server name and the login: <local_server name>-<local_account login>,for example, if the local account has a login of "common" and belongs to the local server "sftp", the new account name is "common-sftpr". The Share Account name can be edited later, it is only for internal use and does not affect the login that is used for authentication.
UDMG 1.5 local account

UDMG 2.0 migrated shared account

Enabled by default.

(2) New permission for Shared Account management

A new User and User Group permission, "sharedAccount", is created for the management of Shared Accounts.
The UDMG users and user groups are assigned these permissions by copying the existing server permissions. The refinement of server and sharedAccount permissions for the Users and User Groups can be done after the migration.
For example, if a UDMG user has server read and write permission, it is allowed to manage servers and local accounts. With the migration, it also obtains the sharedAccount read and write permissions to continue the management of accounts.

Start parameters

The start parameters for several services have changed.

Please review the start scripts, especially for manual installation or if the Systemd service files have been edited.
For a standard upgrade with the provided Linux packages, the service configuration is updated automatically

The following modules now require a 'start' command in server mode.

udmg-auth-proxy start -f configuration_file

udmg-agent-client start -f configuration_file

udmg-agent-server start -f configuration_file

Without it, they will only display the command line usage information.

In addition, a 'test' command allows the syntax of the configuration file to be verified without starting the server.

New configuration parameter with UDMG 2.0.0.0

Configuration Parameters

UDMG Server

Adds new database timeout option

[database]
; Threshold before warning for long-running queries, the default is 10 seconds
WarningTimeout=10s

Adds a parameter to disable the implicit assignment of Transfer Rules. Before this change, a Transfer Rule was allowed for all servers, partners, and accounts right after creation. It was only restricted after an explicit assignment (whitelisting) to at least one server, partner, or account. The prior functionality created confusion and allowed unauthorized access to files and folders for third-party accounts during the time between the rule creation and its explicit assignment. The change allows the functionality to be disabled with the new UDMG Server configuration parameter ExplicitRuleAssignment. When set to true, a Transfer Rule is only effective when it is explicitly linked with the intended target (local server, remote partner, remote or local account).

[rule]
; Disables global rules, requiring rules to be explicitly allowed to be used.
; ExplicitRuleAssignment = false

UDMG Admin UI

The recommended security settings for NGINX have been modified, with the inclusion of the following header directives. Please review the sample configuration on Installing NGINX Server page.

    # Server Banner
    server_tokens off;
 
    # DEPRECATED Security Headers
    add_header X-XSS-Protection "0";
    add_header X-Frame-Options "SAMEORIGIN";
 
    # Security Headers
    add_header Content-Security-Policy "frame-ancestors 'self'";
    add_header X-Content-Type-Options nosniff;
    add_header Referrer-Policy "strict-origin";
    add_header Strict-Transport-Security 'max-age=31536000; includeSubDomains; preload';
    add_header Permissions-Policy "geolocation=(),midi=(),sync-xhr=(),microphone=(),camera=(),magnetometer=(),gyroscope=(),fullscreen=(self),payment=()";
    add_header X-Permitted-Cross-Domain-Policies none;
 
    location /service/ {
      proxy_pass         http://udmg_auth_proxy/;
      proxy_set_header   X-Real-IP       $remote_addr;
      proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
    }

Agent Proxy Client

The section for the configuration of the target UDMG Server is renamed from [gateway] to [server].
New secure option to support HTTPS for the connection to the UDMG Server API

[server]
# UDMG Server Hostname or IP, and port
hostname = "localhost"
port = "8080"
# UDMG API protocol, set to true to select https, default is false for http
secure = false
# UDMG Server Username/Password
username = "admin"
password = "admin_password"

Upgrading from a pre-1.3 UDMG release

Note

If you are upgrading an installation of UDMG from any release before 1.3.0.0, you must uninstall the older version before installing the new version.

Migration from releases before 1.2.1.1 (0.7.1-sb.3) is not supported anymore.

The installation packages, binaries, services, and environment variables have changed, and this does not allow for a standard upgrade.

Category	Prior releases	Release 1.3
user and group	mft:mft	udmg:udmg
binaries	/usr/local/bin	/opt/udmg/bin
configuration files	/etc/mft	/opt/udmg/etc
log files	/var/opt/udmg/logs	/var/opt/udmg/logs
UDMG Admin UI assets	/opt/udmg/var/www/mft	/opt/udmg/var/www/udmg
Services	mft_waarp_gateway mft_auth_proxy nginx mft_web_transfer_client mft-agent-proxy-client mft-agent-proxy-server	udmg-server udmg-auth-proxy nginx udmg-web-transfer udmg-agent-server udmg-agent-client
Environment variables	WAARP_GATEWAY_ADDRESS MFT_AUTH_PROXY_CONFIG MFT_AGENT_PROXY_CONFIG	UDMG_SERVER_ADDRESS UDMG_AUTH_PROXY_CONFIG UDMG_AGENT_CONFIG

It may be required to modify the work and data directories ownership or access rights and to update UDMG Server transfer rules to use paths that are accessible by the 'udmg' user.

The configuration files must be reviewed and compared between the old and new locations.

Special attention is required for the AESpassphrase parameter for UDMG Server. It must be the path for the file that was used by the previous release and must be accessible by the new service user. It is recommended to set an absolute path in the configuration file.

Pre-Installation / Upgrade Backups

The installation process overwrites the current files (exception: the configuration files are kept), this may affect your modifications.

Backing up the configuration files optimizes the time it takes you to get up and running after installing or upgrading.

/opt/udmg/etc/udmg/nginx/udmg.conf
/opt/udmg/etc/udmg/agent/client.toml
/opt/udmg/etc/udmg/agent/server.toml
/opt/udmg/etc/udmg/auth-proxy/config.toml
/opt/udmg/etc/udmg/web-transfer/config.toml
/opt/udmg/etc/udmg-server/server.ini

After upgrading RPM or DEB packages, review the new configuration file templates (with the extension .rpmnew or .dpk-new) and edit the current configuration files to add new parameters or remove deprecated parameters.

Release Migration

The UDMG release version is stored in the database to ensure the data structure is compatible with the version of the UDMG components.

After upgrading the component binaries and before starting the UDMG Server, it is required to perform the release migration step.

Note

The release migration is altering the database structure and requires the database user to have the DDL privileges fore creating, altering and deleting database its own objects.

Please refer to Installing a Database section for the requires privileges for each the database vendor.

The udmg-server "migrate" command handles the necessary database updates and the setting of the internal version.

$ /opt/udmg/bin/udmg-server migrate --help
Usage:
  udmg-server [OPTIONS] migrate [migrate-OPTIONS] [version]

Help Options:
  -h, --help         Show this help message

[migrate command options]
      -c, --config=  The configuration file to use
      -d, --dry-run  Simulate the migration but does not commit the changes
      -l, --list     List Migrations
      -f, --file=    Writes the migration commands into a file instead of sending them to the database
      -v, --verbose  Show verbose debug information. Can be repeated to increase verbosity

[migrate command arguments]
  version:           The version to which the database should be migrated

The configuration file is used for the server mode, with the parameter for accessing the target database.

To get the list of supported target versions, use the list parameter. The last value is the release version of the udmg-server and the default target version. The current version of the UDMG database structure is shown with the [DATABASE] tag:

$ /opt/udmg/bin/udmg-server migrate -c /opt/udmg/etc/udmg-server/server.ini --list | tail -n 2
1.5.0 [DATABASE]
2.0.0 [DEFAULT]

It is recommended to set the verbose parameter (3 times) to follow the progress. If not specified on the command line, the target version is the latest release number.

$ /opt/udmg/bin/udmg-server migrate -c /opt/udmg/etc/udmg-server/server.ini -vvv
2024/06/10 20:01:51 [INFO    ] Migration: Starting upgrade migration from 1.5.0 to 2.0.0
2024/06/10 20:01:51 [INFO    ] Migration: Applying migration 'Drop the normalized transfer view'
2024/06/10 20:01:51 [INFO    ] Migration: Applying migration 'Add a "src_filename, dest_filename" columns to the transfers table'
2024/06/10 20:01:51 [INFO    ] Migration: Applying migration 'Add a "src_filename, dest_filename" columns to the history table'
2024/06/10 20:01:51 [INFO    ] Migration: Applying migration 'Restore and update the normalized transfer view with the new filename'
2024/06/10 20:01:51 [DEBUG   ] Migration: Skipped migration 'Check for required MySQL permissions'
2024/06/10 20:01:51 [INFO    ] Migration: Applying migration 'Add a 'local_storage' column to the 'local_accounts' table'
2024/06/10 20:01:51 [INFO    ] Migration: Applying migration 'Fix the 'sb_user_session' table'
2024/06/10 20:01:51 [INFO    ] Migration: Applying migration 'Create the 'sb_license' table'
2024/06/10 20:01:51 [INFO    ] Migration: Applying migration 'Drop the normalized transfer view'
2024/06/10 20:01:51 [INFO    ] Migration: Applying migration 'Add a 'local_agent_id' column to the 'transfers' table'
2024/06/10 20:01:51 [INFO    ] Migration: Applying migration 'Update the 'sb_generic_group_join' table'
2024/06/10 20:01:51 [INFO    ] Migration: Applying migration 'Update the 'sb_user_group_permission' table'
2024/06/10 20:01:51 [INFO    ] Migration: Applying migration 'Update the 'users' table'
2024/06/10 20:01:51 [INFO    ] Migration: Applying migration 'Create the 'sb_local_account_auth' table'
2024/06/10 20:01:52 [INFO    ] Migration: Applying migration 'Drop the 'local_agent_id' column from the 'local_accounts' table'
2024/06/10 20:01:52 [INFO    ] Migration: Applying migration 'Restore and update the normalized transfer view with the new local agent id'
2024/06/10 20:01:52 [INFO    ] Migration: Applying migration 'Create the 'sb_adhoc_share' table'
2024/06/10 20:01:52 [INFO    ] Migration: Applying migration 'Create the 'sb_adhoc_download' table'
2024/06/10 20:01:52 [INFO    ] Migration: Applying migration 'Bump database version to 2.0.0'

After the migration, the services for UDMG components can be started.

Upgrading Universal Data Mover Gateway for Linux

Upgrading with Linux Software Packages

Step 1	Contact your Stonebranch representative or Customer Support to receive the software package for the intended operating system.
Step 2	Perform the recommended backup of configuration files.
Step 3	Stop the components services. The exact steps depend on the system architecture and the deployed components, for example: On the main UDMG host: `sudo systemctl stop nginx sudo systemctl stop udmg-auth-proxy sudo systemctl stop udmg-agent-clientsudo systemctl stop udmg-server` On the Proxy host: `sudo systemctl stop udmg-agent-server`
Step 4	Upgrade the UDMG packages (RPM or DEB). For RPM based Linux: On the main UDMG host: `sudo rpm -Uvh udmg-agent-2.0.0.3.build.6.x86_64.rpm` `sudo rpm -Uvh udmg-admin-ui-2.0.0.5.build.3.x86_64.rpm` `sudo rpm -Uvh udmg-admin-ui-nginx-2.0.0.5.build.3.x86_64.rpm` `sudo rpm -Uvh udmg-auth-proxy-2.0.0.3.build.6.x86_64.rpm` `sudo rpm -Uvh --force udmg-server-2.0.0.6.build.18.x86_64.rpm` On the Proxy host: `sudo rpm -Uvh udmg-agent-2.0.0.3.build.6.x86_64.rpm` For Debian based Linux: On the main UDMG host: `dpkg --install udmg-agent-2.0.0.3.build.6.x86_64.deb` `dpkg --install udmg-admin-ui-2.0.0.5.build.3.x86_64.deb` `dpkg --install udmg-admin-ui-nginx-2.0.0.5.build.3.x86_64.deb` `dpkg --install udmg-auth-proxy-2.0.0.3.build.6.x86_64.deb` `dpkg --install udmg-server-2.0.0.6.build.18.x86_64.deb` On the Proxy host: `dpkg --install udmg-agent-2.0.0.3.build.6.x86_64.deb`
Step 5	Review the component configuration files. Refer to each component installation section below for the list of parameters. On the main UDMG host: `/opt/udmg/etc/udmg/nginx/udmg.conf` `/opt/udmg/etc/udmg/agent/client.toml` `/opt/udmg/etc/udmg/auth-proxy/config.toml` `/opt/udmg/etc/udmg-server/server.ini` On the Proxy host: `/opt/udmg/etc/udmg/agent/server.toml` Note that new configuration file templates (with the extension .rpmnew or .dpk-new) that contain all the allowed parameters are added during the software package upgrade. Note The default upstream port to reach the UDMG Authentication Proxy is set to 5775 in `/opt/udmg/etc/udmg/nginx/udmg.conf` starting from version 1.5.0.1. Please review and make sure that the same port (either 5000 or 5775) is also defined in `/opt/udmg/etc/udmg/auth-proxy/config.toml` .
Step 6	Perform the release migration.
Step 7	Review the component service configuration files. For instance, the UDMG Authentication Proxy service file (`/etc/systemd/system/udmg-auth-proxy.service`) was installed with these parameters in version 1.5 udmg-auth-proxy.service (Version 1.5) [Unit] Description=Stonebranch UDMG Authentication Proxy [Service] Type=simple User=udmg Group=udmg WorkingDirectory=/home/udmg Environment="UDMG_AUTH_PROXY_CONFIG=/opt/udmg/etc/udmg/auth-proxy/config.toml" ExecStart=/bin/sh -c 'exec /opt/udmg/bin/udmg-auth-proxy' Restart=on-failure SyslogIdentifier=udmg-auth-proxy SyslogFacility=local0 [Install] WantedBy=multi-user.target Note the addition of the `start` command on the `ExecStart` directive in the version 2.0: udmg-auth-proxy.service (Version 2.0) [Unit] Description=Stonebranch UDMG Authentication Proxy [Service] Type=simple User=udmg Group=udmg WorkingDirectory=/home/udmg Environment="UDMG_AUTH_PROXY_CONFIG=/opt/udmg/etc/udmg/auth-proxy/config.toml" ExecStart=/bin/sh -c 'exec /opt/udmg/bin/udmg-auth-proxy start' Restart=on-failure SyslogIdentifier=udmg-auth-proxy SyslogFacility=local0 [Install] WantedBy=multi-user.target The same applies for the other components: `/etc/systemd/system/udmg-auth-proxy.service` `/etc/systemd/system/udmg-agent-client.service` `/etc/systemd/system/udmg-agent-server.service`
Step 8	Start the components services. The exact steps depend on the system architecture and the deployed components, for example: On the Proxy host: `sudo systemctl start udmg-agent-server` On the main UDMG host: `sudo systemctl start udmg-server sudo systemctl start udmg-agent-clientsudo systemctl start udmg-auth-proxy sudo systemctl start nginx`
Step 9	Verify or apply the license; see UDMG Licensing.

Upgrading a Manual Installation

Step 1	Contact your Stonebranch representative or Customer Support to receive the software package for the intended operating system.
Step 2	Perform the recommended backup of configuration files.
Step 3	Stop the components services. The exact steps depend on the system architecture and the deployed components, for example: On the main UDMG host: `sudo systemctl stop nginx sudo systemctl stop udmg-server sudo systemctl stop udmg-auth-proxy sudo systemctl stop udmg-agent-client` On the Proxy host:`sudo systemctl stop udmg-agent-server`
Step 4	Replace the component binaries: `sudo cp udmg-server.bin /opt/udmg/bin/udmg-server sudo cp udmg-client.bin /opt/udmg/bin/udmg-client sudo cp udmg-auth-proxy.bin /opt/udmg/bin/udmg-auth-proxy` Change ownership/permissions on new files: `sudo chown -R root:udmg /opt/udmg/bin/ sudo chmod -R 750 /opt/udmg/bin/` Upgrade the Admin UI: `sudo mv /opt/udmg/var/www/udmg mv /opt/udmg/var/www/udmg_BACKUP` `sudo unzip -d /opt/udmg/var/www/udmg 'udmg-admin-ui-2.0.0.3.build.21.zip'` `sudo chown -R root:udmg /opt/udmg/var/www/udmg`
Step 5	Review the component configuration files. Refer to each component installation section below for the list of parameters. `/opt/udmg/etc/udmg/nginx/udmg.conf` `/opt/udmg/etc/udmg/agent/client.toml` `/opt/udmg/etc/udmg/agent/server.toml` `/opt/udmg/etc/udmg/auth-proxy/config.toml` `/opt/udmg/etc/udmg-server/server.ini`
Step 6	Perform the release migration.
Step 7	Review the component service configuration files. For instance, the UDMG Authentication Proxy service file (`/etc/systemd/system/udmg-auth-proxy.service`) was installed with these parameters in version 1.5 udmg-auth-proxy.service (Version 1.5) [Unit] Description=Stonebranch UDMG Authentication Proxy [Service] Type=simple User=udmg Group=udmg WorkingDirectory=/home/udmg Environment="UDMG_AUTH_PROXY_CONFIG=/opt/udmg/etc/udmg/auth-proxy/config.toml" ExecStart=/bin/sh -c 'exec /opt/udmg/bin/udmg-auth-proxy' Restart=on-failure SyslogIdentifier=udmg-auth-proxy SyslogFacility=local0 [Install] WantedBy=multi-user.target Note the addition of the `start` command on the `ExecStart` directive in the version 2.0: udmg-auth-proxy.service (Version 2.0) [Unit] Description=Stonebranch UDMG Authentication Proxy [Service] Type=simple User=udmg Group=udmg WorkingDirectory=/home/udmg Environment="UDMG_AUTH_PROXY_CONFIG=/opt/udmg/etc/udmg/auth-proxy/config.toml" ExecStart=/bin/sh -c 'exec /opt/udmg/bin/udmg-auth-proxy start' Restart=on-failure SyslogIdentifier=udmg-auth-proxy SyslogFacility=local0 [Install] WantedBy=multi-user.target The same applies for the other components: `/etc/systemd/system/udmg-auth-proxy.service` `/etc/systemd/system/udmg-agent-client.service` `/etc/systemd/system/udmg-agent-server.service`
Step 8	Start the components services. The exact steps depend on the system architecture and the deployed components, for example: On the Proxy host: `sudo systemctl start udmg-agent-server` On the main UDMG host: `sudo systemctl start udmg-server sudo systemctl start udmg-auth-proxy sudo systemctl start udmg-agent-clientsudo systemctl start nginx`
Step 9	Verify or apply the license; see UDMG Licensing.

Installing and Configuring the Components

Note

Starting with UDMG version 2.0, a license key must be provided to enable file transfers.

Contact your Stonebranch representative or Customer Support to receive the license key before installing version 2.0 or later.

Installing with Linux Software Packages

Step 1	Contact your Stonebranch representative or Customer Support to receive the software package for the intended operating system.
Step 2	Install the UDMG packages (RPM or DEB). For RPM based Linux: On the main UDMG host: `sudo rpm -ivh udmg-agent-2.0.0.3.build.6.x86_64.rpm` `sudo rpm -ivh udmg-admin-ui-2.0.0.5.build.3.x86_64.rpm` `sudo rpm -ivh udmg-admin-ui-nginx-2.0.0.5.build.3.x86_64.rpm` `sudo rpm -ivh udmg-auth-proxy-2.0.0.3.build.6.x86_64.rpm` `sudo rpm -ivh udmg-server-2.0.6.build.18.x86_64.rpm` On the Proxy host: `sudo rpm -ivh udmg-agent-2.0.0.3.build.6.x86_64.rpm` For Debian based Linux: On the main UDMG host: `dpkg --install udmg-agent-2.0.0.3.build.6.x86_64.deb` `dpkg --install udmg-admin-ui-2.0.0.5.build.3.x86_64.deb` `dpkg --install udmg-admin-ui-nginx-2.0.0.5.build.3.x86_64.deb` `dpkg --install udmg-auth-proxy-2.0.0.3.build.6.x86_64.deb` `dpkg --install udmg-server-2.0.0.6.build.18.x86_64.deb` On the Proxy host: `dpkg --install udmg-agent-2.0.0.3.build.6.x86_64.deb`
Step 3	Review the component configuration files. Refer to each component installation section below for the list of parameters. On the main UDMG host: `/opt/udmg/etc/udmg/nginx/udmg.conf` `/opt/udmg/etc/udmg/agent/client.toml` `/opt/udmg/etc/udmg/auth-proxy/config.toml` `/opt/udmg/etc/udmg-server/server.ini` On the Proxy host: `/opt/udmg/etc/udmg/agent/server.toml` Note that the UDMG Agent Server requires an SSH key prior to start, the default location is under /data and it can be created with the following commands: `ssh-keygen -t rsa -q -N "" -f /data/agent_key chmod 755 /data/agent_key /data/agent_key.pub` The location and file names can be adjusted with the ssh_key and ssh_key_pub configuration parameters.
Step 4	Start the components services. The exact steps depend on the system architecture and the deployed components, for example: On the Proxy host: `sudo systemctl start udmg-agent-server` On the main UDMG host: `sudo systemctl start udmg-server sudo systemctl start udmg-auth-proxy sudo systemctl start udmg-agent-clientsudo systemctl start nginx`

Performing a manual installation

Note

Starting with UDMG version 2.0, a license key must be provided to enable file transfers.

Contact your Stonebranch representative or Customer Support to receive the license key before installing version 2.0 or later.

UDMG User Setup

Create a dedicated user for running the UDMG modules and to be the owner of the files that are transferred by UDMG.

# sudo groupadd udmg

# sudo useradd -g udmg udmg

UDMG Server

Create the configuration file /opt/udmg/etc/udmg-server/server.ini with the following parameters:

# sudo mkdir -p /opt/udmg/etc/udmg-server
# sudo vi /opt/udmg/etc/udmg-server/server.ini

Note

The lines starting with a semicolon ';' or a hash '#' are comments, either describing the option or showing the default value.

The parameters must be adapted to your environment, in particular:

"paths" section: GatewayHome
"log" section: LogLevel, LogTo, LogPath
"admin" section: Host, Port
"database" section: Type, Address, Name, User, Password

Note

About the log section:

The DEBUG and TRACE log levels are not recommended for production environments.
The detailed log feature (distinct log file for each transfer) is disabled when the log level is set to ERROR or CRITICAL.

Note

About the global section: the requested OS file and directory creation permissions are applied after the umask of the OS user that is running the UDMG Server process.

# # (c) Copyright 2024 Stonebranch, Inc., All rights reserved. # # Stonebranch, Inc. # Universal Data Mover Gateway Server Configuration File # # This configuration file specifies global options for the # udmg-server program. # # The configuration file is organized with the grouping of options under # different section that are marked by brackets: [section_name] # This organization should be maintained when modifying the file. # # The file syntax is: # # - Lines starting with a # or a ; are comments. # - Blank lines are ignored. # - Option lines are 'keyword = value' format. # - keywords are not case sensitive. # - keywords can start in any column. # - Case sensitivity of the value depends on the value being specified. # For example, a yes or no option is not case sensitive, but a file # or directory name is. # - Values must be enclosed in quotations marks (") or apostrophes (') # if the value contains a space or tab. # - File or folder path on Windows platform must be written with one of the following syntaxes: # LogPath = "C:/UDMG/UDMG Server/logs" # LogPath = "C://UDMG//UDMG Server//logs" # LogPath = "C:\\UDMG\\UDMG Server\\logs" # LogPath = C:\UDMG\UDMG Server\logs # LogPath = C:/UDMG/UDMG Server/logs # #####################################################################

[global]
; The name given to identify this gateway instance. If the database is shared between multiple gateways, this name MUST be unique across these gateways.
GatewayName = sb-mft-01

; Default OS permission for created files
; FilePermissions = 770

; Default OS permission for created directories
; DirPermissions = 770

[paths]

; The root directory of the gateway. By default, it is the working directory of the process.
GatewayHome = /home/udmg/udmg-server

; The directory for all incoming files.
; DefaultInDir = in

; The directory for all outgoing files.
; DefaultOutDir = out

; The directory for all running transfer files.
; DefaultTmpDir = tmp

[log]
; All messages with a severity above this level will be logged. Possible values are TRACE, DEBUG, INFO, WARNING, ERROR and CRITICAL.
Level = INFO

; The path to the file where the logs must be written. Special values 'stdout' and 'syslog' log respectively to the standard output and to the syslog daemon.
; LogTo = stdout

; If LogTo is set on 'syslog', the logs will be written to this facility.
; SyslogFacility = local0

; The directory for the log files of the local servers, partners, and transfers.

; No default, if not provided then the detailed log feature is disabled. If not present, the directory is created with DirPermissions.

LogPath = /var/opt/udmg/logs ; Set to true to have a distinct log file for each local server and remote partner. The file is <LogPath>/<agent name>.<hostname>.log. The default is false to disable the feature. LogAgent = false

[admin]
; The address used by the admin interface.
Host = 0.0.0.0

; The port used by the admin interface. If the port is 0, a free port will automatically be chosen.
Port = 18080

; Path of the TLS certificate for the admin interface.
; TLSCert =

; Path of the key of the TLS certificate.
; TLSKey =

; Password for the key of the TLS Certificate (if key is encrypted).
; TLSPassphrase =

; API rate limiter: number of allowed requests per client IP, per second. After that HTTP code 429 is returned. Disabled if 0 or not provided.; RateLimit = 0

[database]

; Type of the RDBMS used for the UDMG Server database. Possible values: sqlite, mysql (default), postgresql, oracle, mssql
Type = postgresql

; Address (URL:port) of the database. The default port depends on the type of database used (PostgreSQL: 5432, MySQL: 3306, MS SQL: 1433, Oracle: 1521, SQLite: none).
Address = localhost:5432

; The name of the database
Name = udmg

; The name of the gateway database user
User = udmg_user

; The password of the gateway database user
Password = udmg_password

; Path of the database TLS certificate file (only supported for mysql, postgresql).
; TLSCert =

; Path of the key of the TLS certificate file (only supported for mysql, postgresql).
; TLSKey =

; The path to the file containing the passphrase used to encrypt account passwords using AES. Recommended to be a full absolute path, if the file does not exist, a new passphrase is generated the first time.
AESPassphrase = /opt/udmg/etc/udmg-server/passphrase.aes

; Maximum number of database connections, the default is 0 (unlimited); MaxConnections = 0

; Maximum number of transactions retries, the default is 3.
; MaxRetries = 3

; Delay in milliseconds between retries, the default is 100.
; MaxRetriesWait = 100

; Threshold before warning for long-running queries, the default is 10 seconds

WarningTimeout=10s

[controller]
; The frequency at which the database will be probed for new transfers
; Delay = 5s

; The maximum number of concurrent incoming transfers allowed on the gateway (0 = unlimited).
; MaxTransferIn = 0

; The maximum number of concurrent outgoing transfers allowed on the gateway (0 = unlimited).
; MaxTransferOut = 0

; The frequency at which the heartbeat will be updated
; Heartbeat = 10s

; The deadline to determine if this instance will be active
; Deadline = 5m0s

[sftp]
; Set to true to allow legacy and weak cipher algorithms: 3des-cbc, aes128-cbc, arcfour, arcfour128, arcfour256
; AllowLegacyCiphers = false

[tasks]
; Set to true to disable the COPY task.
DisableCopy = false

; Set to true to disable the MOVE task.
DisableMove = false

; Set to true to disable the COPYRENAME task.
DisableCopyRename = false

; Set to true to disable the MOVERENAME task.
DisableMoveRename = false

; Set to true to disable the DELETE task.
DisableDelete = false

; Set to true to disable the RENAME task.
DisableRename = false

; Set to true to disable the CHECKREGEX task.
DisableCheckRegex = false

; Set to true to disable the PUBLISHEVENT task.
DisablePublishEvent = false

; Set to true to disable the ICAP task.
DisableIcap = false

; Set to true to disable the TRANSFER task.
DisableTransfer = false

; Set to true to disable the EXECMOVE task.
DisableExecMove = false

; Set to true to disable the EXECOUTPUT task.
DisableExecOutput = false

; Set to true to disable the EXEC task.
DisableExec = true

[rule]
; Disables global rules, requiring rules to be explicitly allowed to be used.
; ExplicitRuleAssignment = false

Note

The AESPassphrase file is generated on the first run if it does not exist. It is recommended to set an absolute path, otherwise it is created in the current directory.

Make sure to verify the file location during an upgrade and to have a backup.

Without the correct AESPassphrase file, the passwords, keys, and certificates are not usable.
The use of an incorrect passphrase file is reported with the error:

cannot decrypt password: cipher: message authentication failed

Install the binaries under /opt/udmg/bin:

# sudo install -m 755 udmg-client /opt/udmg/bin
# sudo install -m 755 udmg-server /opt/udmg/bin

UDMG Authentication Proxy

Create a directory under /etc/udmg/:

# sudo mkdir -p /opt/udmg/etc/udmg

Create a configuration file for the service:

# sudo vi /opt/udmg/etc/udmg/auth_proxy/config.toml

####################################
# The proxy section configures the
# UDMG Authentication Proxy
####################################
[proxy]
# Port, default "5775"
port = "5775"
# Network interface, default "0.0.0.0"
inet = "0.0.0.0"
#############################################
# Fine-tuning parameters,
# beware that this can affect the security or the performance
#############################################
# Enable recover on panic, default true, should be true for production environment
recover = true
# Enable Cross-Origin Resource Sharing (CORS), should be true for production environment
cors = true
# CORS domain: List of origins that may access the resource. Optional. Default value "*"
domain = "*"
# Enable CSRF protection, default false (set to true only if NGINX uses SSL/TLS)
csrf = false
# Enable request Track ID, default true
tracker = true
# Enable request logguer, default true
logger = true
# Rate limit IP request over 1 second, default 0 (unlimited)
limit = 0
# Enable the Prometheus metric endpoint '/metric', default false
metrics = false

####################################
# The [service.*] subsections define the different services
# and authentication provider for target udmg-servers.
# There must be at least 1 service.
# The local authentication provided is enabled for all services.
# The service name is displayed on UDMG Admin UI login page.
# It is implicitily defined by the section titles:
# [service.SERVICE_NAME]
# [[service.SERVICE_NAME.targets]]
# [service.SERVICE_NAME.settings]
# [service.SERVICE_NAME.auth.ldap]
# [service.SERVICE_NAME.auth.credentials]
# [service.SERVICE_NAME.auth.google]
# [service.SERVICE_NAME.auth.saml]
# [service.SERVICE_NAME.auth.openid]
# [service.SERVICE_NAME.auth.oauth]
####################################
# Example of a service configuration for local authentication
####################################
[service.udmg]
# protocol for the UDMG Server REST API, either http or https
protocol = "http"
# switchover policy, only if several udmg-server instances can be reached by the authentication proxy instance
policy = "failover"

[[service.udmg.targets]]
# address of a target udmg-server instance, note the double square brackets
hostname = "localhost"
port = 18080

[service.udmg.settings]
#############################################
# Service Settings - this affects the UDMG Admin UI display
# The property name "udmg.xxx" must be enclosed in double quotes
#############################################
# Name of the system or environment
"udmg.system_identifier" = "UDMG"
# Color of the banner background, as HTML color name ("Brown"), RGB code ("rgb(165,42,42)"), or hexadecimal code ("#A52A2A")
"udmg.banner.background_color" = "transparent"
# Company logo, optional picture to display next to the system identifier, the path is relative to web server root directory
#"udmg.banner.logo" = "/assets/logo.png

####################################
# Example of a service configuration for SSO
####################################
#[service.udmg_sso]
#protocol = "http"
#policy = "failover"
#
#[[service.udmg_sso.targets]]
#hostname = "localhost"
#port = 18080
#
# Google SSO Provider
#[service.udmg_sso.auth.google]
#file = "/path/to/config.json"
#
# SAML SSO Provider
#[service.udmg_sso.auth.saml]
#file = "/path/to/config.json"
#
# OpenID SSO Provider
#[service.udmg_sso.auth.openid]
#file = "/path/to/config.json"
#
# OAuth2 SSO Provider
#[service.udmg_sso.auth.oauth]
#file = "/path/to/config.json"

####################################
# Example of a service configuration for LDAP
####################################
#[service.udmg_ldap]
#protocol = "http"
#policy = "failover"
#
#[service.udmg_ldap.credential]
#username = "ldap_sync"
#password = "ldap_password"
#
#[[service.udmg_ldap.targets]]
#hostname = "localhost"
#port = 18080
#
#[service.udmg_ldap.auth.ldap]
#file = "udmg-ldap-config.json"

Please refer to Authentication Methods for the LDAP and SSO authentication options.

Verify the configuration file with the 'test' command:

In case of syntax error, a verbose message will indicate the line and the issue:

$ udmg-auth-proxy test -f /opt/udmg/etc/udmg/auth_proxy/config.toml
level=info TS=2024-05-06T10:37:30.263799884Z Configuration="Loading configuration file: /opt/udmg/etc/udmg/auth_proxy/config.toml."
level=warn TS=2024-05-06T10:37:30.699063132Z Configuration=File Error="toml: line 83 (last key \"service.udmg\"): Key 'service.udmg.settings' has already been defined."
level=error TS=2024-05-06T10:37:30.699096632Z Configuration="Error reading the configuration file." err="configuration file invalid structure"

Install the binary under /opt/udmg/bin:

# sudo install -m 755 udmg-auth-proxy /opt/udmg/bin

UDMG Admin UI

The following steps require root privilege, so make sure that you have the correct access before continuing.

Extract the distribution files for UDMG Admin UI, under the directory that was configured as the web server root directory during the NGINX Server configuration, The standard value is/opt/udmg/var/www/udmg.

# sudo unzip -d /opt/udmg/var/www/udmg/ udmg-admin-ui-<VERSION>.zip

The zip file can now be deleted.
If SELinux is enabled on the host, proceed with the steps in the section below: Using UDMG with SELinux
Validate that the service is working properly, for example with the 'curl' command:

# curl http://localhost:80 -I
HTTP/1.1 200 OK
Server: nginx
Date: Tue, 08 Oct 2024 08:47:51 GMT
Content-Type: text/html
Content-Length: 467
Last-Modified: Tue, 08 Oct 2024 18:36:50 GMT
Connection: keep-alive
ETag: "67057bc2-1d3"
X-XSS-Protection: 0
X-Frame-Options: SAMEORIGIN
Content-Security-Policy: frame-ancestors 'self'
X-Content-Type-Options: nosniff
Referrer-Policy: strict-origin
Strict-Transport-Security: max-age=31536000; includeSubDomains; preload
Permissions-Policy: geolocation=(),midi=(),sync-xhr=(),microphone=(),camera=(),magnetometer=(),gyroscope=(),fullscreen=(self),payment=()
X-Permitted-Cross-Domain-Policies: none
Accept-Ranges: bytes

or with the browser:

UDMG Agent Proxy

The UDMG Agent Proxy client is installed inside the LAN, typically on the same host as UDMG Server.
The UDMG Agent Proxy Server is installed on the Proxy host, typically in the DMZ.

Agent Proxy Server Configuration

Create a directory under /opt/udmg/etc/udmg:

# sudo mkdir -p /opt/udmg/etc/udmg/agent/

Install the binary under /opt/udmg/bin:

# sudo install -m 755 udmg-agent-server /opt/udmg/bin

Generate a SSH Key for the service:

# ssh-keygen -t rsa -q -N "" -f /opt/udmg/etc/udmg/agent/agent_key

Change the agent key permissions:

# chmod 755 /opt/udmg/etc/udmg/agent/agent_key /opt/udmg/etc/udmg/agent/agent_key.pub

Create a configuration file as /opt/udmg/etc/udmg/agent/server.toml:

# sudo vi /opt/udmg/etc/udmg/agent/server.toml

[agent]
# UDMG Agent Server Hostname or IP, and port
hostname = "0.0.0.0"
port = "2222"
# path to the SSH private key file
ssh_key = "/opt/udmg/etc/udmg/agent/agent_key"
# path to the SSH public key file
ssh_key_pub = "/opt/udmg/etc/udmg/agent/agent_key.pub"

# Agent Service User and password
username = "udmg"
password = "61ee8b5601a84d5154387578466c8998848ba089"

The username and password keys are used for the UDMG Agent Client authentication to the UDMG Agent Server.

Agent Proxy Client Configuration

Create a directory under /opt/udmg/etc/udmg:

# sudo mkdir -p /opt/udmg/etc/udmg/agent/

Install the binary under /opt/udmg/bin:

# sudo install -m 755 udmg-agent-client /opt/udmg/bin

Create a configuration file as /etc/udmg/agent_proxy/client.toml:

# sudo vi /opt/udmg/etc/udmg/agent/client.toml

[client]
##########################################################################################
# Configuration for the tunnel between UDMG Agent Proxy Client and UDMG Agent Proxy Server
##########################################################################################
# Target UDMG Agent Proxy Server Hostname or IP, and port
hostname = "udmg-agent-server"
port = "2222"

# UDMG Agent Service User and password
username = "udmg"
password = "61ee8b5601a84d5154387578466c8998848ba089"

# 'ttl' is the interval between connection attempts to the UDMG Agent Server, default is 15 seconds.
ttl="15s"

# 'idle_timeout' is the amount of time that the Agent Proxy will allow a connection to exist
# with no upstream or downstream activity. The default idle timeout if not otherwise specified is 10 minutes.
idle_timeout = "10m"

[client.api]
##########################################################################################
# Configuration for the Admin API of the UDMG Agent Proxy Client: http://0.0.0.0:port/api
##########################################################################################
# port number, no default
port = "2280"
# API basic authentication credentials, no default
username = "api_user"
password = "api_password"
# 'debug_port', when specified, will enable the HEAP Profile dump export.
# This is provided for monitoring and troubleshooting and is not recommended for production.
# When enabled the head profile dump can be generated at http://127.0.0.1:debug_port/dump
#debug_port = 6060

[server]
##########################################################################################
# Configuration for accessing the UDMG Server Admin API
# UDMG Agent Proxy will list the available local servers to setup the forwarding services.
# The API user must have 'Servers read' permission
##########################################################################################
# UDMG Server Hostname or IP, and port
hostname = "localhost"
port = "18080"
# UDMG API protocol, set to true to select https, default is false for http
secure = false
# UDMG Server API user credentials
username = "admin"
password = "admin_password"

The username and password keys in the '[client]' section are used for the UDMG Agent Client authentication to the UDMG Agent Server.

Setup the Systemd Services

Note

If you are upgrading an installation of UDMG from any release before 2.0.0.0, the start parameters for several services have changed.

Please review them carefully, especially for manual installation or if the Systemd service files have been edited.
The service configuration is updated automatically for a standard upgrade with the provided Linux packages.

The following modules now require a 'start' command in server mode.

udmg-auth-proxy start -f configuration_file

udmg-web-transfer start -f configuration_file

udmg-agent-client start -f configuration_file

udmg-agent-server start -f configuration_file

Without it, they will only display the command line usage information.

In addition, a 'test' command allows the syntax of the configuration file to be verified without starting the server.

UDMG Server

Create a new service definition:

# sudo vi /etc/systemd/system/udmg-server.service

[Unit]
Description=UDMG Server

[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
ExecStart=/bin/sh -c '/usr/local/bin/udmg-server server -c /opt/udmg/etc/udmg-server/server.ini' 
Restart=on-failure 

[Install] WantedBy=multi-user.target

Enable the new service:

# sudo systemctl enable udmg-server.service
Created symlink /etc/systemd/system/multi-user.target.wants/udmg-server.service → /etc/systemd/system/udmg-server.service.

Start the service and check the status:

# systemctl start udmg-server
# systemctl status udmg-server
● udmg-server.service - UDMG server
Loaded: loaded ( /etc/systemd/system/udmg-server.service; enabled; vendor preset: disabled)
Active: active (running) since Tue 2022-06-07 16:43:16 -03; 10s ago
Main PID: 24888 (udmg-server)
Tasks: 6 (limit: 3509)
CPU: 11ms
CGroup: /system.slice/udmg-server.service
└─24888 /opt/udmg/bin/udmg-server server -c /opt/udmg/etc/udmg-server/server.ini

Make sure that the listen port and network interface is reachable by UDMG Authentication Proxy and UDMG Agent Client.

UDMG Authentication Proxy

Create a new service definition:

# sudo vi /etc/systemd/system/udmg-auth-proxy.service

[Unit]
Description=Stonebranch UDMG Auth Proxy server

[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
Environment="UDMG_AUTH_PROXY_CONFIG=/opt/udmg/etc/udmg/auth_proxy/config.toml"
ExecStart=/bin/sh -c 'exec /opt/udmg/bin/udmg-auth-proxy start'
Restart=on-failure

[Install]
WantedBy=multi-user.target

Enable the new service:

# sudo systemctl enable udmg-auth-proxy.service
Created symlink /etc/systemd/system/multi-user.target.wants/udmg-auth-proxy.service → /etc/systemd/system/udmg-auth-proxy.service.

Start the service and check the status:

# systemctl start udmg-auth-proxy
# systemctl status udmg-auth-proxy
● udmg-auth-proxy.service - Stonebranch UDMG Auth Proxy server
Loaded: loaded ( /etc/systemd/system/udmg-auth-proxy.service; enabled; vendor preset: disabled)
Active: active (running) since Tue 2022-06-07 16:58:48 -03; 21s ago
Main PID: 25008 (udmg-auth-proxy)
Tasks: 3 (limit: 3509)
CPU: 4ms
CGroup: /system.slice/udmg-auth-proxy.service
└─25008 /opt/udmg/bin/udmg-auth-proxy start

Make sure that the listen port and network interface are reachable by NGINX Server.

UDMG Agent Proxy

Agent Proxy Server Service

Create a new service definition:

# sudo vi /etc/systemd/system/udmg-agent-server.service

[Unit]

Description=Stonebranch UDMG Agent Proxy server 

[Service] 
Type=simple 
User=udmg 
Group=udmg 
WorkingDirectory=/home/udmg 
Environment="UDMG_AGENT_CONFIG=/opt/udmg/etc/udmg/agent/server.toml" 
ExecStart=/bin/sh -c 'exec /opt/udmg/bin/udmg-agent-server start' 
Restart=on-failure 

[Install] 
WantedBy=multi-user.target

Enable the new service:

# sudo systemctl enable udmg-agent-server
Created symlink /etc/systemd/system/multi-user.target.wants/udmg-agent-server.service → /etc/systemd/system/udmg-agent-server.service.

Start the service and check the status:

# systemctl start udmg-agent-server
# systemctl status udmg-agent-server
● udmg-agent-server.service - Stonebranch UDMG Agent Proxy Server
Loaded: loaded ( /etc/systemd/system/udmg-agent-server.service; enabled; vendor preset: disabled)
Active: active (running) since Tue 2022-06-07 16:26:53 -03; 2s ago
Main PID: 25444 (udmg-agent-server)
Tasks: 5 (limit: 3509)
CPU: 5ms
CGroup: /system.slice/udmg-agent-server.service
└─25444 /opt/udmg/bin/udmg-agent-server start

Jun 07 16:26:53 localhost.localdomain systemd[1]: Started UDMG Agent Proxy Server.
Jun 07 16:26:53 localhost.localdomain sh[25444]: level=info TS=2022-06-07T19:26:53.624296821Z HostKey=Ok Path=/data/agent

Be sure that the listen port and network interface is reachable by UDMG Agent Client.

Agent Proxy Client Service

Create a new service definition:

# sudo vi /etc/systemd/system/udmg-agent-client.service

[Unit]
Description=Stonebranch UDMG Agent Proxy Client

[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
Environment="UDMG_AGENT_CONFIG=/opt/udmg/etc/udmg/agent/client.toml"
ExecStart=/bin/sh -c 'exec /opt/udmg/bin/udmg-agent-client start'
Restart=on-failure

[Install]
WantedBy=multi-user.target

Enable the new service:

# sudo systemctl enable udmg-agent-client.service
Created symlink /etc/systemd/system/multi-user.target.wants/udmg-agent-client.service → /etc/systemd/system/udmg-agent-client.service.

Start the service and check the status:

# systemctl start udmg-agent-client
# systemctl status udmg-agent-client
● udmg-agent-client.service - Stonebranch UDMG Agent Proxy Client
Loaded: loaded ( /etc/systemd/system/udmg-agent-client.service; enabled; vendor preset: disabled)
Active: active (running) since Tue 2022-06-07 17:26:53 -03; 2s ago
Main PID: 25445 (udmg-agent-client)
Tasks: 5 (limit: 3509)
CPU: 6ms
CGroup: /system.slice/udmg-agent-client.service
└─25445 /opt/udmg/bin/udmg-agent-client start

Jun 07 17:26:53 localhost.localdomain systemd[1]: Started UDMG Agent Proxy Client.
Jun 07 17:26:53 localhost.localdomain sh[25445]: level=info TS=2022-06-07T20:26:53.624296821Z Servers=[]

License application

Once the UDMG Server and UDMG Admin UI are up and running, the license can be applied; see UDMG Licensing.

Ports Configuration

See Network Requirements

Using UDMG with SELinux

Security-Enhanced Linux (SELinux) is enabled by default on modern RHEL and CentOS servers. Each operating system object (process, file descriptor, file, etc.) is labeled with an SELinux context that defines the permissions and operations the object can perform. In RHEL 6.6/CentOS 6.6 and later, NGINX is labeled with the httpd_t context.

When SELinux is enabled, the UDMG Admin UI shows "403 access denied" and "404 page not found" errors on the landing page, and permission errors are reported in the NGINX log files:

... 2023/09/19 12:51:38 [error] 108236#108236: *1 "/opt/udmg/var/www/udmg/index.html" is forbidden (13: Permission denied), client: 127.0.0.1, server: localhost, request: "GET / HTTP/1.1", host: "localhost ...

Verify whether SELinux is enforced with the getenforce command. A result of "Enforcing" means that is is enabled and that the steps below are required.

$ getenforceEnforcing

Modify the file labels so that NGINX (as a process labeled with the httpd_t context) can access the configuration files.

# sudo restorecon /etc/nginx/conf.d/*

Modify the file labels so that NGINX (as a process labeled with the httpd_t context) can access the UDMG Admin UI asset files.

# sudo semanage fcontext -a -t httpd_sys_content_t '/opt/udmg/var/www(/.*)?'
# sudo restorecon -Rv /opt/udmg/var/www

Allow NGINX to reverse proxy through the UDMG Authentication Proxy by setting the httpd_can_network_connect boolean.

# sudo setsebool -P httpd_can_network_connect 1

References

This document references the following documents.

Name	Location
Systemd	Understanding and Using Systemd - Linux.com
NGINX with SELinux	Modifying SELinux Settings for Full NGINX and NGINX Plus Functionality
PostgreSQL Client Authentication	21.1. The pg_hba.conf File
PostgreSQL Password Authentication	21.6. Password Authentication

Browser not supported