Product Knowledge Base

Space shortcuts

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

Introduction

This article builds on the Simple File Transfer with Basic Authentication article, concentrating on the configuration aspects introduced with use of SSH authentication.

Note:

  • On our JADE - XML Configuration - Sample Files page there is complete configuration file available for download that uses SSH public/private key authentication. This configuration is a working example that comes with the necessary private key authentication file and will download files from the online SOS Demo server to a local file system.
  • The transfer configuration is described here and in the download example just mentioned uses the XML-based configuration introduced with Release 1.11 of JADE. A similar example using the Settings parameters configuration that was implemented for releases before 1.11 can be found our JADE Tutorials.

Features of SSH Authenticated File Transfer

Authentication

The main features of SSH authenticated file transfer in JADE are:

  • SSH authentication can be carried out with an account name and either password or public/private key verification.
  • SSH authentication requires that SFTP protocol is used. 
  • SSH authentication is required when a jump host transfer is carried out.

As with all file transfer protocols, any number of SFTP file transfer configurations in the form of ProtocolFragments can be preconfigured and selected as required.

If public/private key verification is used, the SSH password parameter can be used to provide additional protection for the authentication file.

File Transfer Protocol

SSH Authentication requires that the SFTP protocol is used for the transfer operation.

Configuration of SSH Authenticated File Transfer 

The configuration of a file transfer with SSH authentication follows the steps already described described in the Simple File Transfer with Basic Authentication article.

In the download example with SSH authentication mentioned in the introduction there are two differences to the Simple File Transfer with Basic Authentication example:

  • the use of SSH Authentication instead of BasicAuthentication
  •  SFTP protocol is used instead of FTP as FTP cannot support SSH authentication

Both examples are otherwise kept as simple as possible for clarity. More complex file transfer scenarios will be described later.

Procedure Overview

The configuration procedure involves 3 steps:

  1. Configuration of the Fragments - i.e. the protocol, connection and authentication methods to be used for the source and target parts of the operation.
  2. Configuration of the Profile - i.e. the operation to be carried out (e.g. copy or move), the fragments to be used for the source and target parts of the transfer and any specific directories that are to be used.
    • Note that the Profile can also be used to specify other elements such as any notifications to be made or preprocessing that is to be carried out. These will be described later on.
  3. Calling the Configuration and Profile from the command line, a batch file or via the JADE API.

Specification of SFTP File Transfer Elements

The use of SSH authentication requires that the SFTP protocol (or a jump host) is specified. This done by specifying a Profile element that calls a suitably configured SFTPFragment. This Profile will then be called when JADE is started. The SFTPFragment will contain at least the specification of a BasicConnection element and the SSHAuthentication element.

  • Profile
    • Operation
      • Copy
        • CopySource
          • CopySourceFragmentRef
            • Ref -> SFTPFragment (Ref=Name)
  • Fragments
    • ProtocolFragments
      • SFTPFragment (identified by Name Attribute)
        • BasicConnection
        • SSHAuthentication

SSH Authentication requires specification of:

  • an Account (i.e. a user name, required)
  • either an AuthenticationMethodPassword element, which in turn requires a Password to be specified
    OR an AuthenticationMethodPublickey element which requires that an AuthenticationFile and optional Passphrase are specified

More information about the specification of SSHAuthentication can be found in:

Further Information

 

Pages

 
 

Navigation

 

  • No labels