SSH Tectia

ssh-convert-ftp (EFT Expansion Pack on Unix)

ssh-convert-ftp — Convert unsecured FTP connections to secured SFTP

Synopsis

ssh-convert-ftp [options...] COMMAND [arguments...]

Description

ssh-convert-ftp is a component of SSH Tectia Client with EFT Expansion Pack on Unix.

The ssh-convert-ftp command runs the specified command with the given arguments. The command and its child processes will have automatic FTP-SFTP conversion and FTP tunneling enabled. Depending on the filter rules configured for the SSH Tectia Connection Broker, the connections may then be automatically converted from FTP to SFTP, or automatically tunneled.

Options

The following options are available:

-D, --debug=LEVEL

Sets the debug level string to LEVEL. The following debug levels can be used:

  • 1 - includes information about fatal errors

  • 3 - includes initialization messages

  • 5 - includes information about the TCP connections

  • 7 - includes information about DNS resolving, and other more detailed debugging information.

-F, --fallback

Falls back to plaintext connection mode if a secure connection cannot be established (default: no fallback).

-h, --help

Displays a short summary of command-line options and exits.

Examples

Start an FTP session to ftp.example.org with FTP-SFTP conversion enabled:

$ ssh-convert-ftp ftp ftp.example.org

Start an FTP session to ftp.example.org and allow the fallback to plaintext FTP in case the secure SFTP connection cannot be established:

$ ssh-convert-ftp -F ftp ftp.example.org

Start a bash shell session with FTP-SFTP conversion enabled for all commands:

$ ssh-convert-ftp bash

The SSH Tectia Client software includes an example configuration for filter rules that enable FTP-SFTP conversion for any FTP connections (to port 21). See the ssh-broker-config-example-ftp-sftp.xml configuration file in the /etc/ssh2 directory.

Exit Values

If a command was invoked, ssh-convert-ftp returns the exit status of that command. Typically, the exit value shows the success of the command:

  • If an error occurred when executing the command, the exit value is non-zero. The exact value depends on the operating system.

  • If an error occurred when parsing the command line arguments, an error message is output to stderr and the exit value is 1.

  • If the platform is unsupported, an error message is output to stderr and the exit value is 2.

  • If no errors occurred, the exit value is whatever the given command returns. So in this case the exit value may be nonzero even if the command succeeds. This means that the exit value alone does not provide exact information about how the command succeeded.