Configuring an SFTP server

You can configure an SFTP server that can be used by an SFTP exchange profile. Use Servers to create and configure a new SFTP server.

To configure an SFTP server:

1. Log in to B2B Advanced Communications as a user with the permissions to configure an SFTP server.
2. Click Systems Management > Servers.
3. On the Servers page, click New > SFTP.
4. On the Create Server page, specify values for the applicable fields as follows:

   Associated organization

   An owner organization with which the SFTP server is associated. Click Select to select the organization.

   Host Key

   A key that is used to identity the SFTP server to the client and ensure that the server is known and trusted. The host key prevents man-in-the-middle attacks.

   The host key is loaded from the SFTP server by the client when the client accesses the server for the first time. When the client accesses the server again, the host key ensures the client that the server is the same server that the client accessed earlier. The host key must be sent by the server to the client when the client requests the host key.

   To create a host key, click New Host Key. For more information, see Adding an SSH private and public host key pair.

   Name

   The unique name for the SFTP server.

   Description

   Optional: The description of the SFTP server.

   Port

   The port number specifies the service available on the SFTP server. When you assign a port number to the SFTP server, the number must not conflict with the default port number of a service that is available on the SFTP server.

   Virtual file system

   Optional: The virtual file system that is associated with the SFTP server

   Important: The virtual file system to which the SFTP server points must be on a filesystem that supports extended custom file attributes.

   You can use an absolute path or a path that is relative to your home directory. If you do not configure a base directory, a base directory is created in the install_dir\Members\Operational\usr\servers\Operational directory. However, if the base directory is not available, the SFTP server cannot start.

   Thread pool

   Select a thread pool (collection of threads) from the list.

   A thread pool manages the threads in the pool to process the tasks. To handle large volumes of files or large files, you can create a thread pool with more number of threads and associate the thread pool to the SFTP server. A thread pool can be shared among multiple SFTP servers.

   Authentication Type

   The type of authentication that is used to access an SFTP server that is used by an exchange profile. The password or public key credentials for the authentication are specified in the exchange profile.

   Password only

   Use a user ID and password to connect to the SFTP server.

   Public key only

   Use a public key and a private key to connect to the SFTP server.

   Password and public key

   Use both a user ID and a password and a public key and a private key to connect to the SFTP server.

   Password or public key

   Use either a user ID and a password or a public key and a private key to connect to the SFTP server.

5. Click Advanced Properties to specify values for the following fields:

   Authentication Idle Timeout (ms)

   The number of milliseconds that the authentication prompt can be idle before the server disables authentication.

   Idle Timeout (ms)

   The number of milliseconds that a client TCP connection can be idle before the server closes the connection.

   Maximum Packet Size (bytes)

   The maximum size of read or write requests that are sent over SFTP by the client.

   Maximum Failed Authentication Attempts

   The number of authentication attempts that are allowed before authentication is disabled.

   Maximum Concurrent Sessions Per User (-1 is unlimited)

   The maximum number of concurrent inbound connections from trading partners to the SFTP server. The default value of -1 allows unlimited concurrent inbound connections.

   Window Size (bytes)

   The size of the channel window through which SFTP packets travel.

   SSH Rekey Timeout (ms)

   The amount of time in milliseconds that can elapse in a session before a repeat key exchange (rekey) is initiated.

   SSH Rekey Byte Limit

   The amount of data in bytes that can flow in either direction of the SSH channel before a rekey is initiated.

   File Part Extention

   You can add file extensions for partially uploaded files in File Part Extension so that the system recognizes that files with such extensions are only a part of an upload in progress. Default file extension is .filepart.

   You can add and remove partial file extensions. Click Add New to add a new partial file extension. To remove a partial file extension, click the "X" next to the name of the extension.

6. Click Save to save the SFTP server configuration. The SFTP server is automatically started when you save the configuration.