SFTP

Note:
Since ImageMaster 9.8.1 only SFTP is supported and FTP is deprecated! If FTP is still in use, this must be replaced by SFTP!

The underlying file archive in an ImageMaster environment can be based on SFTP, i.e. any server which supports SFTP can be used as storage. The typical connection parameters for SFTP have to be set up such as host, port, path, and parameters for authentication. See table Archives – SFTP below for further details.

SFTP archive authentication

For SFTP authentication, there are two options depending on what you choose as “authentication type”:

  • authentication with a username / password combination

  • authentication using a keystore with public / private key pairs

    • Figure 87: Archives – SFTP archive properties

SFTP parameter overview

Parameter

Mandatory

Description

Host

Yes

The host name or IP address of the host where the file server runs

Port

Yes

The port number at which the file server is listening for requests

Path

Yes

The root path of the file system that is to be used for storing files

User

Depends

Username in case of password authentication

A username / password combination must be provided in one of the two possible scenarios for SFTP.

With SFTP you can use keystore authentication as an alternative and provide a credential string instead (see the entry below).

Authentication Type

Yes

The authentication type for SFTP access

There are two options available:

  • “PASSWORD” – authentication by password

  • “PKEY” – authentication by keystore

Password Alias

Yes

An alias used for authentication

Here you can only select an existing alias that must be specified beforehand via the ImageMaster password manager (Managing passwords). Depending on the authentication type, it refers to a password or a key.

In case of a key, the alias refers to the filename of the private key which has been registered in the ImageMaster keystore on the application server. For related details see Security configuration in the installation manual [IM ImageMaster].

Check of Host Key

No

Verify the validity of the host key

This improves security but also requires additional administrative action on the application server, where the key must be declared in the known_hosts file.

Mark Files Read Only

No

If this option is active, all written files are marked as read-only in the file system.

Table 26: Archives – SFTP