Installing and Configuring the Components
UDMG Admin UI
The following steps require root privilege, make sure that you have the correct access before continuing.
Extract the distribution file for UDMG Admin UI, under the directory web server root directory, see the NGINX Service configuration above.
# unzip -d /srv/www/udmg/ udmg_admin_ui-<VERSION>.zip
- Validate that the service is working properly:
# curl http://localhost:8080 -I
HTTP/1.1 200 OK
Server: nginx/1.21.6
Date: Mon, 06 Jun 2022 17:33:19 GMT
Content-Type: text/html
Content-Length: 7788
Last-Modified: Fri, 03 Jun 2022 14:07:05 GMT
Connection: keep-alive
ETag: "629a1589-1e6c"
Accept-Ranges: bytes
UDMG User setup
Create a dedicated user for running the UDMG modules and to be the owner of the files that will be transferred by UDMG.
# groupadd udmg
# useradd -g udmg udmg
UDMG Server
Create the configuration file
/etc/udmg/udmg_server
/server.ini
with the following parameters:
# mkdir -p /etc/udmg/udmg_server
# vi /etc/
udmg/udmg_server
/server.ini
Note
The lines starting with a colon ';' or a hash '#' are comments, describing the option or showing the default value.
The parameters must be adapted to your environment, in particular:
- global: GatewayHome
- log: LogLevel, LogTo, LogPath
- admin: Host, Port
- database: Type, Address, Name, User, Password
[global]
; The name given to identify this gateway instance. If the the database is shared between multiple gateways, this name MUST be unique across these gateways.
GatewayName = udmg
; Default OS permission for created files
; FilePermissions = 700
; Default OS permission for created directories
; DirPermissions = 750
[paths]
; The root directory of the gateway. By default, it is the working directory of the process.
GatewayHome = /home/udmg
; 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 DEBUG, INFO, WARNING, ERROR and CRITICAL.
Level = DEBUG
; 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 detailled log feature is disabled.
; LogPath = /var/opt/udmg/logs
[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 =
; 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]
; Name of the RDBMS used for the gateway database. Possible values: sqlite, mysql, postgresql
Type = postgresql
; Address of the database
Address = localhost
; 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.
; TLSCert =
; Path of the key of the TLS certificate file.
; TLSKey =
; The path to the file containing the passphrase used to encrypt account passwords using AES
; AESPassphrase = passphrase.aes
; Max Database Connections
; MaxConnections = 0
[controller]
; The frequency at which the database will be probed for new transfers
Delay = 300s
; 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
[sftp]
; Set to true to allow legacy and weak cipher algorithms: 3des-cbc, aes128-cbc, arcfour, arcfour128, arcfour256
; AllowLegacyCiphers = false
Note
AESPassphrase file is generated on first run if it does not exist.
Make sure to set verify the file location during upgrade and to have a backup. Without the correct AESPassphrase file, the passwords, the keys and the certificates will not be usable.
- Install the binaries under
/usr/local/bin:
# install -m 755 udmg-client /usr/local/bin
# install -m 755 udmg-server /usr/local/bin
UDMG Authentication Proxy
Create a directory under
/etc/udmg/:
# mkdir -p /etc/
udmg
/auth_proxy
- Create a configuration file for the service:
# vi /etc/
udmg
/auth_proxy/config.toml
# Proxy Configuration
[proxy]
# Port, default "5000"
port = "5000"
# Network interface, default "0.0.0.0"
inet = "127.0.0.1"
# 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:
List of origins that may access the resource. Optional. Default value "*"# domain
= "*"
# Enable Request Track ID, default truetracker = true
# Enable Request Logger, 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
# Enable CSRF tokencsrf = false
#
# Service 'local' with direct authentication on the
UDMG Server
[service.local]
# UDMG Server Listen Protocol
protocol = "http"
[[service.local.targets]]
# UDMG Server Hostname or IP
hostname = "localhost"
#
UDMG Server
Portport = 18080
Please refer to Authentication Methods for the LDAP and SSO authentication options.
- Install the binary under
/usr/local/bin:
# install -m 755 udmg-auth-proxy /usr/local/bin
UDMG Agent Proxy
Create a directory under
/etc/mft:
# mkdir -p /etc/udmg/agent_proxy
- Install the binaries under
/usr/local/bin:
# install -m 755
udmg-agent-proxy-client
/usr/local/bin# install -m 755
udmg-agent-proxy-
server /usr/local/bin
Agent Proxy Server Configuration
Generate a SSH Key for the service:
# ssh-keygen -t rsa -q -N "" -f /etc/udmg/agent_proxy/agent
# ssh-keygen -t rsa -q -N "" -f /etc/udmg/agent_proxy/client
- Change the agent key permissions:
# chmod 755 /etc/udmg/agent_proxy/agent /etc/udmg/agent_proxy/agent.pub
- Create a configuration file as
/etc/udmg/agent_proxy/agent.toml:
# vi /etc/udmg/agent_proxy/agent.toml
[agent]
# UDMG Agent Proxy Hostname or IP, and port
hostname = "0.0.0.0"
port = "2222"
# path to the SSH private key file
ssh_key = "/etc/
udmg
/agent_proxy/agent"# path to the SSH public key file
ssh_key_pub = "/etc/
udmg
/agent_proxy/agent.pub"
# Agent Service User and password
username = "mft"
password = "61ee8b5601a84d5154387578466c8998848ba089"
The password key will be used for the client authentication.
Agent Proxy Client Configuration
Create a configuration file as
/etc/
udmg
/agent_proxy/client.toml:
# vi /etc/udmg/agent_proxy/client.toml
[client]
# Target UDMG Agent Proxy Hostname or IP, and port
hostname = "localhost"
port = "2222"
# path to the SSH private key file
ssh_key = "/etc/udmg/agent_proxy/client"
# path to the SSH public key file
ssh_key_pub = "/etc/
udmg
/agent_proxy/client.pub"
# Agent Service User and password
username = "mft"
password = "61ee8b5601a84d5154387578466c8998848ba089"
# Default TTL to Connection Retry
ttl="5s"
[client.api]
# Administrative API port
port="2280"
[gateway]
#
UDMG Server
Hostname or IP, and port hostname = "localhost"
port = "18080"
# UDMG Server Username/Password
username = "admin"
password = "admin_password"
The password key will be used for the client authentication.
Setup the Systemd Services
UDMG Server
Create a new service definition:
# 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
/udmg-server server -c /etc/udmg/udmg-server/server.ini' Restart=on-failure [Install] WantedBy=multi-user.target
- Enable the new service:
# systemctl enable
udmg-server
.serviceCreated 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
●
.service - UDMG serverudmg-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 /usr/local/bin/
udmg-server
server -c /etc/udmg/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:
# vi /etc/systemd/system/
.serviceudmg-auth-proxy
[Unit]
Description=UDMG Auth Proxy server
[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
Environment="UDMG_AUTH_PROXY_CONFIG=/etc/udmg/auth_proxy/config.toml"
ExecStart=/bin/sh -c 'exec /usr/local/bin/
'udmg-auth-proxy
Restart=on-failure
[Install]
WantedBy=multi-user.target
- Enable the new service:
# systemctl enable
.serviceudmg-auth-proxy
Created symlink /etc/systemd/system/multi-user.target.wants/
.service → /etc/systemd/system/udmg-auth-proxy
.service.udmg-auth-proxy
- Start the service and check the status:
# systemctl start
udmg-auth-proxy
# systemctl status
udmg-auth-proxy
●
.service - UDMG Auth Proxy serverudmg-auth-proxy
Loaded: loaded ( /etc/systemd/system/
.service; enabled; vendor preset: disabled)udmg-auth-proxy
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/
.serviceserviceudmg-auth-proxy
└─25008 /usr/local/bin/
udmg-auth-proxy
Make sure that the listen port and network interface is reachable by NGINX Server.
UDMG Agent Proxy
Agent Proxy Server Service
Create a new service definition:
# vi /etc/systemd/system/udmg-agent-proxy-server.service
[Unit]
Description=UDMG Agent Proxy server
[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
Environment="UDMG_AGENT_PROXY_CONFIG=/etc/udmg/agent/server.toml"
ExecStart=/bin/sh -c 'exec /usr/local/bin/udmg-agent-proxy-server'
Restart=on-failure
[Install]
WantedBy=multi-user.target
- Enable the new service:
# systemctl enable udmg-agent-proxy-server
Created symlink /etc/systemd/system/multi-user.target.wants/udmg-agent-proxy-server.service → /etc/systemd/system/udmg-agent-proxy-server.service.
- Start the service and check the status:
# systemctl start udmg-agent-proxy-server
# systemctl status udmg-agent-proxy-server
● udmg-agent-proxy-server.service - UDMG Agent Proxy Server
Loaded: loaded ( /etc/systemd/system/udmg-agent-proxy-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-proxy-server)
Tasks: 5 (limit: 3509)
CPU: 5ms
CGroup: /system.slice/udmg-agent-proxy-server.service
└─25444 /usr/local/bin/udmg-agent-proxy-server
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:
# vi /etc/systemd/system/udmg-agent-proxy-client.service
[Unit]
Description=UDMG Agent Proxy Client
[Service]
Type=simple
User=udmg
Group=
udmg
WorkingDirectory=/home/
udmg
Environment="UDMG_AGENT_PROXY_CONFIG=/etc/
udmg
/agent_proxy/client.toml"ExecStart=/bin/sh -c 'exec /usr/local/bin/
udmg-
agent-proxy-client'Restart=on-failure
[Install]
WantedBy=multi-user.target
- Enable the new service:
# systemctl enable
udmg-agent-proxy-client
.serviceCreated symlink /etc/systemd/system/multi-user.target.wants/
udmg-agent-proxy-client
.service → /etc/systemd/system/udmg-agent-proxy-client
.service.
- Start the service and check the status:
# systemctl start
udmg-agent-proxy-client
# systemctl status
udmg-agent-proxy-client
●
.service - UDMG Agent Proxy Clientudmg-agent-proxy-client
Loaded: loaded ( /etc/systemd/system/
udmg-agent-proxy-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-proxy-client
)Tasks: 5 (limit: 3509)
CPU: 6ms
CGroup: /system.slice/
udmg-agent-proxy-client
.service└─25445 /usr/local/bin/
udmg-agent-proxy-client
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=[]
Component Ports
Make sure that all the ports needed are open under your firewall configuration.
Using UDMG with SELinux
- Modify the file label so that NGINX (as a process labeled with the
httpd_t
context) can access the configuration file
# restorecon /etc/nginx/conf.d/*
- Modify the file label so that NGINX (as a process labeled with the
httpd_t
context) can access the asset files
# semanage fcontext -a -t httpd_sys_content_t '/srv/www(/.*)?'
# restorecon -Rv /srv/www/
- Allow NGINX to reverse proxy through the authentication proxy by setting the
httpd_can_network_connect
boolean
# setsebool -P httpd_can_network_connect 1
References
This document references the following documents.
Name | Location |
---|---|
Systemd | |
NGINX with SELinux | |
PostgreSQL Client Authentication | |
PostgreSQL Password Authentication |