Tutorial - Creating an SFTP Partner

Click New. The Server Details displays.

• In the Server Name field, enter rebex
• In the Protocol field, enter SFTP
• In the IP Address field, enter test.rebex.net
• In the Port field, enter 22

Additional details can be attached to the partner. 

• Description
• Primary Contact Name
• Primary Contact Phone
• Primary Contact Email
• Secondary Contact Name
• Secondary Contact Phone
• Secondary Contact Email
• Customized fields

Go to the Details tab on the local server pane.

Click the Save button.

The account is created and shows in the account list.

To verify that the targeted host is the correct one, SFTP protocol uses server host key(s).

To continue with the partner configuration, at least one of the public SSH keys of the the remote server must be stored.

The public keys

• can be provided by the business partner itself,
• or can be added by UDMG with adhoc retrieval,
• or can be retrieved with external tools.

For example, here is how to get the RSA key with the ssh-keyscan utility:

$ ssh-keyscan -t rsa test.rebex.net > rebex.ssh-rsa
# test.rebex.net:22 SSH-2.0-RebexSSH_5.0.8062.0
$ cat rebex.ssh-rsa
test.rebex.net ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAkRM6RxDdi3uAGogR3nsQMpmt43X4WnwgMzs8VkwUCqikewxqk4U7EyUSOUeT3CoUNOtywrkNbH83e6/yQgzc3M8i/eDzYtXaNGcKyLfy3Ci6XOwiLLOx1z2AGvvTXln1RXtve+Tn1RTr1BhXVh2cUYbiuVtTWqbEgErT20n4GWD4wv7FhkDbLXNi8DX07F9v7+jH67i0kyGm+E3rE+SaCMRo3zXE6VO+ijcm9HdVxfltQwOYLfuPXM2t5aUSfa96KJcA0I4RCMzA/8Dl9hXGfbWdbD2hK1ZQ1pLvvpNPPyKKjPZcMpOznprbg+jIlsZMWIHt7mq2OJXSdruhRrGzZw==

Click the Configuration tab on the Partner detail panel. The list of certificate record displays and is empty.

To manually add a key that was given by the partner or retrieved with a tool, click the Add Certificate button. The Certificate Details displays.

• In the Name field, enter ssh-rsa
• In the Public Key field, copy the key that was determined in the previous step.

Click Save

The certificate record appears in the list.

UDMG also provides the ability to fetch and store the remote server host keys during the partner configuration.

Click the Show Host Keys button.

The Host Keys displays with the list of SSH public keys that were scanned from the remote server.

To automatically store all the retrieved host keys, click the Save Host Keys button. The confirmation window displays.

Click Confirm to save the keys.

The records are stored with unique names as "date_partner_type" where 

• date is the current time in YYYYMMDD
• partner is the value from the IP Address field
• type is the SSH key type or algorithm

For example: 20230516113741_test.rebex.net_ecdsa-sha2-nistp256

To disable a key without deleting it, clike the Revoke button (the stop icon).

Here the sha2-nistp keys are disabled:

A revoked key can be enabled again with the Authorize button .

To see more details about a specific host key, click the View button (the eye icon).

The Certificate Details displays, showing the following:

• algorithm
• bits: size of the key, only for RSA
• comment, if any is stored in the Public Key field
• the MD5 fingerprint
• the SHA256 fingerprint
• a clean authorized keyline, without any comment or host specification

The Rule tab allows to configure the transfer rules that define the local and remote paths.

To download from the "pub/example" directory, a Receive rule is needed to specify the remote directory.

From the UDMG navigation pane, select Management > Rules. The Rules list displays.

Click New. The Rule Details displays.

• In the Rule Name field, enter rebex_receive_example
• In the Direction field, enter Receive
• In the Description field, enter any value or leave it empty
• In the Path field, enter rebex_receive_example
• In the Local Directory field, leave it empty (it will use the default directory)
• In the Remote Directory field, enter pub/example
• In the Temp Directory field, leave it empty (it will use the default directory)

The rule is created and appears on the Rules list

From the UDMG navigation pane, select Management > Partners. The Partner list displays.

Select the rebex partner and click on the Rules tab. The green dot on the tab shows that a rule is now assigned to this server.

To restrict the use of this rule and this virtual path to only the rebex partner, you have to assign the rule to that partner.

Select the  rebex partner and click on the Rules tab

Pick the rule rebex_receive_example from the drop-down list

and click on Authorize Rule button

The rule is now whitelisted for this server and does not appear anymore for the other servers:

Initiate a file transfer to download the file pocketftp.png

Use the Command Line Interface to register the transfer:

$ udmg-client transfer add -p rebex -l demo  -w receive -r rebex_receive_example -f pocketftp.png
The transfer of file pocketftp.png was successfully added.

From the UDMG navigation pane, select Activity> History. The Transfer History list displays.

The download is completed successfully and the file is received in the default input directory 'in' under the MFT server home directory, configured here as '/atest/work'