Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: 'Getting Started' added

Table of Contents
outlinh1. true
outlinh1. true
1printablefalse
2stylh1. none
3indent20px

...

Introduction

  • The "Password Safe" (Credential Store, CS) offers possibilities to store encrypted connection data and any other data to be encrypted and stored securely and independently of an the application(i.e. YADE)s) such as.YADE that use this data. Access to the CS is only possible with access methods such as an SSH key or password.
  • Currently CS is using "KeePass" and "KeePassX" with the db version 1.0, thus CS can be used on most popular OS platforms.
  • The advantage of using CS is that CS stores the credentials (and other information/parameters) into a standardized, secure and encrypted database, i.e. Keepass. YADE will access the CS database using a standard interface. The CS database can only be accessed using password, encryption-key file (ppk) or a combination of both. The CS password is used to encrypt the contents stored in the CS database with AES.
  • CS can be used to securely store information or parameters, database connection URL, runtime decryption key and other access data.

Scope

This article describes the use of the Credential Store with the YADE Client via the client's command line interface.

A description of the use of the Credential Store with the YADE JITL job can be found in the Jobs JADEJob & JADE4DMZJob article.

Getting Started

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 on the user's local file system. The configuration used in the tutorial us available as a download. Instructions for installing and configuring the YADE Client can be found in the YADE - Tutorials article.


The following information can be retrieved from CS standard fields:

  • Feature: UserID : The user identification of the user who is authorized for the operation.
  • Feature: Password : Assigned password for the user.
  • Feature: Server-Name : Target server name or IP address
  • Feature: Notes : In the notes section of the CS other parameters/options can be stored, i.e. YADE parameters, database connection URL etc. The extra options are defined in a similarly way as used on the command line.
  • Feature: File-Attachment : Any files Files such as PGP files, or SSH private key files can be stored in the CS as attachments. Applications will retrieve the attached file at run-time and will delete the file immediately once operation is completed.

Parameter used by SOSCredentialStoreSOS Credential Store

Panel
titlh1. List of parameter
titlh1. List of parameter
1borderStyledashed
2borderColoh1. #ccc
3bgColor#fff

Name

Title

Mandatory

Default

CredentialStore_ProcessNotesParams

Process additional parameters from "notes" filed

false

false

CredentialStore_OverwriteExportedFile

CredentialStore_OverwriteExportedFile

false

true

CredentialStore_Permissions4ExportedFile

CredentialStore_Permissions4ExportedFile

false

600

CredentialStore_DeleteExportedFileOnExit

Delete Attachment On Exit of Application

false

true

CredentialStore_ExportAttachment

Export attached file to disc

false

false

CredentialStore_ExportAttachment2FileName

Name of the extracted attachment file

false

 

CredentialStore_KeyFileName

Name of the File containing the private Key

false

 

CredentialStore_password

Password for CS

false

 

CredentialStore_AuthenticationMethod

Authentication Method for the CS

true

privatekey

CredentialStore_StoreType

The Type of the crendential store application

false

KeePass

CredentialStore_KeyPath

Path and Key for the credentials

true

 

CredentialStore_FileName

Name of Credential Database

true

 

use_credential_Store

use credential store for authentication

false

false

...