Configuring Java CAPS Environment Components for Communications Adapters

SSH Tunneling (BatchFTP Environment)

This topic provides information for configuring the SSH Tunneling properties (accessed from the Environment Explorer). If Secure FTP (FTP over SSH or FTP over SSL) is required, use the Secure FTP OTDs (BatchFTPOverSSL, BatchSFTP, and BatchSCP). SSH Tunneling is supported for compatibility purposes.

The SSH Tunneling section of the BatchFTP Environment properties contains the top-level parameters displayed in the following table.

Table 33 Environment - BatchFTP - SSH Tunneling

Name 

Description 

Required Value 

SSH Listen Host

Specifies the name of the host where the SSH support software runs, and to which the host listens. This parameter is required when and only when SSH Channel Established is set to Yes. The reason for this is, if you choose No this Listen Host will always be localhost because the SSH client will always be started from localhost. For optimum security, it is recommended that you use localhost as your choice.

The connection to the corresponding port number on this host is forwarded to the FTP server through an SSH-secure channel. 

On the listen host, the SSH support software must be configured and started with the Port-Forwarding option. 

The FTP command connection is forwarded through the secure tunnel. The corresponding SSH command uses the following model: 

ssh -L ListenPort:FtpServerHost:FtpServerPort -o BatchMode=yes SSHServer

If this host name is not localhost, the data transport between the local host and the SSH listen host is not secure. Also, your SSH support software should be configured to allow connections to other hosts (for some SSH clients, it is an option -g).

For example, on an SSH listen host, you could issue a command, such as: 

ssh -L 4567:apple:21 -o BatchMode=yes apple

or 

ssh -L 5678:orange: 21 -o BatchMode=yes apple

Regardless, the transport between the SSH listen host and the FTP server is still secure. 

The SSH listen host name. 

The configured default is localhost.

SSH Listen Port

Specifies the port number that the SSH-tunneling support software uses to check for incoming connections. This port number can be any unused port number on the SSH listen host.

The connection to this port is forwarded to the FTP server through an SSH-secure channel. This parameter is required and it must be exactly same as the ListenPort value in the SSH command you issue either inside or outside the Sun Enterprise Service Bus system. The corresponding SSH command line uses the following model:

ssh -L ListenPort:FtpServerHost:FtpServerPort -o BatchMode=yes SSHServer Required Values

An integer from 1 to 65535.

SSH User Name

Specifies an SSH user name. This parameter can be required when the setting for the SSH Channel Established parameter is No.

This parameter is required only if the SSH support software is started from within the Adapter (refer to the corresponding SSH command line). Even then, it is only required if your SSH implementation executes in an interactive way that requires you to enter a user name. Again, this requirement depends on how you specify the SSH command line and how your SSH environment is configured. 

The SSH user name. 

SSH Password

Specifies an SSH password corresponding to the user name entered under SSH User Name. This parameter can be required only when the setting for the SSH Channel Established parameter is No. For more information, see SSH User Name.

The SSH password.