Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

  • On our JADE - XML Configuration - Sample Files page there is a 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 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 along with a configuration download file.

...

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.

...

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

There are, however, two differences to the Simple File Transfer with Basic Authentication example:

...

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  name Attribute)
        • BasicConnection
        • SSHAuthentication

 

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

Specification of SSH Authentication

...

  • an Account (i.e. a user name, required)
  • either an AuthenticationMethodPassword element, which in turn requires a Password to be specified
    OR 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