References
Notes
This element includes the parameters for access to a secure store with credentials
for file transfer operations.
If you want to store secure access data, i.e. account, password, SSH key, database
connection strings,
in an encrypted database, then configure access to a CredentialStore accordingly.
A CredentialStore is a KeePass database that stores secure access data.
Such credentials can be referenced from YADE configuration items instead of being
exposed in plain text.
Any number of CredentialStores can be configured. They are distinguished by their name attribute.
References to a CredentialStore use the value of the name attribute to identify the respective
CredentialStore.
Use by configuration items
Credentials can be referenced from a CredentialStore by the following configuration items:
Any number of credential store fragments can be configured and are distinguished
by YADE according to their name attribute.
A fragment is referenced by a transfer Profile
using the value of the CredentialStoreFragmentRef ref attribute.
Support for KeePass versions 1 and 2.
Note: Availability starting with YADE-464.
Referencing CredentialStore fields.
Note: Availability starting with YADE-481.
Referencing a field in the CredentialStore is effected by the following syntax:
cs://[entry_path]@entry_field
where
-
cs://
is a constant prefix that is used by YADE to identify this setting to be a
reference to a CredentialStore.
-
entry_path
specifies the path to an entry within the CredentialStore database.
Folders (groups) within a path are separated by a slash "/".
This setting is optional. If ommitted then the value of the CSEntryPath configuration item is used.
-
entry_field
is one of the standard fields available in a CredentialStore:
-
title
-
user
-
password
-
url
-
notes
-
attachment
or the custom fields.
<Hostname>
element:
- Usage like the examples below.
- If the entry field value is defined with host:port, YADE sets the <Hostname> and <Port> automatically.
Examples
- Examples for fully specified entry path:
-
<Domain>, <Hostname>, <Account>, <Password>, <Passphrase> elements:
-
cs://sos/mft_server/srv001@title
-
cs://sos/mft_server/srv001@user
-
cs://sos/mft_server/srv001@password
-
cs://sos/mft_server/srv001@url
-
cs://sos/mft_server/srv001@notes
-
cs://sos/mft_server/srv001@my_custom_field
- <AuthenticationFile> element:
-
cs://sos/mft_server/srv001@attachment
- the first attachment
-
cs://sos/mft_server/srv001@my_custom_field
- a specified attachment
- Examples without fully specified entry path:
-
<Domain>, <Hostname>, <Account>, <Password>, <Passphrase> elements:
-
cs://@title
-
cs://@user
-
cs://@password
-
cs://@url
-
cs://@notes
-
cs://@my_custom_field
- <AuthenticationFile> element:
-
cs://@attachment
- the first attachment
-
cs://@my_custom_field
- a specified attachment