Page History

...

The examples presented in this article are based on the simple file transfer example described in the The YADE Client Command Line Interface - Tutorial 1 - Getting Started article. This tutorial describes the configuration required to download a number of files from a online server provided by the SOS GmbH and save these file files on the user's local file system. Using this server means that users can get a working example up and running with a minimum of effort. A simplified version of the configuration used in the tutorial (only specifying FTP) is available as a download: sos-berlin_demo_2_local.xml. Instructions for installing and configuring the YADE Client can be found in the YADE - Tutorials article.

The configuration provided in the download file will cause six files in the root server folder to be copied to a local /jade_demo/transfer_receive folder, generating the target folder in the user's home or profile directory if required and permissions are available. The files will be transferred by FTP and authentication for the server (user name and password) is specified in the download file.

Installing and configuring the Credential Store

KeePass 2 is has been used in the current article to implement the credential store database.  

Installing and configuring the Credential Store

The installation of and use of KeePass is described on the Keepass Web Site.

...

In addition a Master Key file (not used in the example below) can be generated using the KeePass menu Files/Change Master Key KeePass menu option and then selecting the Show expert options checkbox (shown greyed out in the following screenshot).

...

Adding Data to the Credential Store

A group named ftp is has been used for the current example along with the entry "demo on test.sos-berlin.com".

...

The following information can be retrieved from standard CS standard fields:

• Title: Target server name or IP address
  
• User name: The user identification of a user who is authenticated for the operation.
• Password: Assigned password for a user account or passphrase for a private key.
• URL: .....
• File Attachment: Files such as PGP or SSH private key files can be stored as attachments. YADE will retrieve the contents of the attached file at run-time - no intermediate or temporary files are created when reading attachments.

...

In the remainder of the current article, it is assumed that readers have made themselves familiar with the organization of the YADE Client file transfer configurations into Profiles and Fragments. This is described in the Getting Started YADE tutorial linked The YADE Client Command Line Interface - Tutorial 1 - Getting Started article mentioned above.

The following example uses the XML configuration from and adds the necessary configuration elements required to replace the "standard" authentication elements with elements stored in the Credential Store.

The following XML configuration elements configuration elements are required to specify the use of a the Credential Store:

• A Credential Store Fragments CredentialStoreFragments element at the same level in the XML hierarchy as the Protocol Fragments elements.
  A
  • This element can have one or more child Credential Store Fragment elements (described below).
• A CredentialStoreFragment element that is referenced from the Protocol Fragment ProtocolFragment. This Fragment specifies the location of and authentication required for the Credential Store.
  • Password, key file and combined password/key file authentication methods are possible.
• A CredentialStoreFragmentRef element as a child element of the Protocol Fragment element - in the current example this is the FTPFragment. 
• The values of the connection and authentication elements are modified to refer to elements stored within the Credential Store.

...

Addressing the Credential Store

Parameters stored in the example credential store Credential Store database Entry are addressed in the CredentialStoreFragment XML element as follows:

• The CSEntryPath element is used to specify the path in the Credential Store to the Credential Store Entry:
  • cs://demo_database/ftp/ (where demo_
  database/ftp/ (value corresponds with the name of the CS database and
  • database is the Database name and ftp the (optional) name of the Group, as specified above).

The Credential Store Entry parameters are accessed using the following syntax, where demo_on_test.sos-berlin.com is the Title that has been set for the Credential Store Entry. 

• Hostname: demo_on_test.sos-berlin.com@url (where @url specifies the URL element stored in the database )
• Account: test.sos-berlin.com@user (where @user specifies the URL User name element stored in the database)
• Password: test.sos-berlin.com@password (where @password specifies the URL Password element stored in the database)

...