Also in the app Edgely Console: Documentation tab, Credentials, Passwords from a Password Manager
A password credential can keep its password in 1Password, Bitwarden, KeePassXC or HashiCorp Vault instead of in the Edgely vault. The vault then holds only a reference (which item, which entry, which path), and Edgely reads the password each time a connection signs in. Change the password in the manager and the next login uses the new one.
The password is read when the connection signs in and is held in memory for that login only. It is never written to the vault, to an export or to the log.
Setting It Up
- Open the credential editor (New Credential, or Edit on a password credential).
- Keep the type Password and fill in the Username.
- In Password from, choose the manager. This vault keeps the password in Edgely, as before.
- Fill in the fields the manager needs (below).
- Click Test: Edgely reads the password once, as a login would, and says whether it worked. The password itself is never shown.
- Click Create or Save.
The vault manager lists such a credential as Password from 1Password (or the manager's name).
1Password
| Field | Example |
|---|---|
| Secret reference | op://Servers/web1/password |
Edgely runs the 1Password command line program, op read, which you install yourself (1password.com/downloads/command-line). In the 1Password app, turn on Settings > Developer > Integrate with 1Password CLI and keep the app unlocked: the first read then asks you to approve it in the app (Touch ID or Windows Hello). Copy a reference from the app with Copy Secret Reference on a field.
On a computer without the 1Password app, a service account works instead: create one in 1Password (Developer > Service accounts) with read access to the vault, and start Edgely with its token in the OP_SERVICE_ACCOUNT_TOKEN environment variable. op then reads with that token and nothing is asked.
If the CLI is not signed in, the login says so and names both ways to sign in.
Edgely looks for op, bw and keepassxc-cli on the PATH and where their installers put them, since an app started from the Dock or the Start menu does not get a terminal's PATH.
Bitwarden
| Field | Example |
|---|---|
| Item (name or id) | web1, or the item's id |
| Field (optional) | password when empty; username, totp, notes, or the name of a custom field |
Edgely runs the Bitwarden command line program, bw, which you install yourself (bitwarden.com/help/cli). Sign in once in a terminal with bw login (bw config server first for a self-hosted server). The first time a connection needs Bitwarden in a run of Edgely, it asks your master password. bw unlock turns it into a session that Edgely keeps in memory until it quits or the vault locks. The master password itself is never kept.
Each login runs bw sync before it reads, so a change made in another Bitwarden app is picked up. When two items share a name, Bitwarden cannot tell which one you mean: use the item's id.
KeePassXC
| Field | Example |
|---|---|
| Database file | /home/me/servers.kdbx (click Choose the database) |
| Entry (Group/Entry) | Servers/web1 |
| Field (optional) | Password when empty; any attribute of the entry, such as UserName |
Edgely runs keepassxc-cli, which comes with KeePassXC. The first time a connection needs a database in a run of Edgely, it asks the database's password. Edgely keeps it in memory until it quits or the vault locks, and hands it to keepassxc-cli on its input, never on its command line. A database opened with a key file or a YubiKey is not supported yet.
When the database's own password changes while Edgely runs, the next login says so and forgets the old one; the login after it asks the new password. A wrong password is said in the prompt, and an entry or a field the database does not have is named at the login.
HashiCorp Vault
| Field | Example |
|---|---|
| Vault address | https://vault.example.com:8200 |
| Secret path | secret/servers/web1, as the vault kv get command writes it |
| Field (optional) | password when empty |
| Token (API client credential) | An API client credential of the vault |
Create the API client credential first. Put the Vault token in its API Token field. For an AppRole, leave the token empty and fill in Client ID (the role id) and Client Secret (the secret id); Edgely signs in with them at each read. KV secrets engines of version 1 and 2 are both read, and the version is found by asking Vault.
A sealed Vault, a wrong or expired token, or a path the token may not read is said by name at the login.
When a Read Fails
The login stops and says why, with the manager's name: the program is not installed, the CLI is not signed in, the item does not exist, the database password was wrong, the Vault is sealed. Nothing is read from anywhere else in its place.
Moving Credentials
A credential that reads its password from a manager travels in the encrypted exports (.evlt, and .econ or .efull with credentials) as its reference, never with a password. On the other computer, the manager's program and its sign-in are needed there too. Sync never carries credentials, references included.