...
Download KeePassX and create kdb file
- JADE YADE Credential Store (CS) supports KeePassX DB version 1.0
- One can download the KeePassX desktop utility from https://www.keepassx.org/downloads/
...
- Open the KeePassX utility
- Choose password as Master Key
- Assign password to KeePass DB and click OK
JADE YADE will use the Master Key, i.e. the password specified during the creation process as access password of the KeePassX database.
...
- Create new top group i.e.
sos - Create new sub group i.e.
server - Create new entry
wilma.sosfor settings- Title : Will be used as key in the hierarchy to access the credentials.
- Username : Field is used to specify the username, i.e. FTP, SFTP user name
- Password : Field is used to specify the password, user can use the KeePassX's password generation feature to specify strong passwords or can provide existing password.
- Comment : Can contain extra parameters for JADE YADE along with credentials, any JADE YADE parameter can be specified in the comment section.
- Expires : Expiry date is used to enforce a password and SSH key expiration policy. The user can define the expirarion period, e.g. 90 days, or check option
never. JADE YADE will raise an error if a KeePassX DB entry is expired. - Attachment : Can contain private key file used for file transfer
...
Create Credential Store entry for SFTP server
...
YADE profiles with Credential Store
Set-up global Credential Store profile
Define a global profile containing all the parameters concerning Credential Store. JADE YADE can reuse any profile defined in same jade_settings.ini file.
It 's is recommended to create profile fragments and reuse them in profiles.
Alternatively a user can define multiple KeePassX DB files, e.g. Test, Integration, Production, and create corresponding profiles for the different environments.
...
| Code Block |
|---|
; Global Profile for KeePassX Database With Public Key [Keepass_DataBase_WithPublicKey] use_credential_Store = true CredentialStore_FileName = C:\sos-berlin.com\jade\credential-store\keepassX-test.kdb CredentialStoreAuthenticationMethod = privatekey CredentialStore_KeyFileName = C:\sos-berlin.com\jade\config\jade_cs_rsa.ppk |
Set-up
...
YADE profile for FTP
In this example we are including Credential Store settings from a global KeePassX database profile Keepass_DataBase_WithPassword .
JADE YADE then will open the KeePassX DB and refer to the entry sos/server/wilma.sos that has previously been defined in the KeePassX DB:
source_CredentialStore_KeyPath: JADE YADE will refer to the entry from KeePassX DB.
...
| Code Block |
|---|
[ReceiveUsingKeePass]
source_include = Keepass_DataBase_WithPassword
source_CredentialStore_KeyPath = sos/server/8of9.sos
source_dir = /tmp/test/jade/out
source_make_dirs = true
source_transfer_mode = ascii
target_protocol = local
target_dir = ${TEMP}/jade/in
operation = copy
file_spec = \.txt$
transfer_mode = ascii
|
Set-up
...
YADE profile for SFTP
| Code Block |
|---|
[ReceiveUsingKeePassSourceSFTP]
operation = copy
file_spec = \.txt$
;;
source_include = Keepass_DataBase_WithPassword
source_CredentialStore_KeyPath = sos/server/8of9.sftp.sos
source_dir = /tmp/test/jade/out
source_protocol = SFTP
source_ssh_auth_method = password
;;
target_protocol = local
target_dir = ${TEMP}/jade/in
|
...
- Using Credential Store to securely store authentication, connection and other parameters]
- For information about the JADE YADE parameters see the JADE YADE - Reference Documentation - Parameter Reference Documentation