Implement SSH key file path env substitution #3769

hifi · 2019-11-02T11:15:57Z

People usually want their SSH key file path to be relative to $HOME which helps transferring database between multiple systems with different local users. Automatic path pickup will use an absolute path but you can manually change it to use a tilde or any combination of environment variables.

For example the following key file paths work on Linux/Mac/BSD:

~/.ssh/id_rsa
$HOME/.ssh/id_rsa

Following hypothetical path should work on Windows:

%HOMEDRIVE%%HOMEPATH%\.ssh\id_rsa

This work has been kindly supported by my employer, Vincit.

Type of change

✅ New feature (non-breaking change which adds functionality)

Description and Context

Fixes #3523

Testing strategy

Tests are implemented for env substition. Manually tested with the GUI on Linux.

Checklist:

✅ I have read the CONTRIBUTING document. [REQUIRED]
✅ My code follows the code style of this project. [REQUIRED]
✅ All new and existing tests passed. [REQUIRED]
✅ I have added tests to cover my changes.

schlimmchen · 2019-11-07T10:09:21Z

Could you maybe move the function that expands the tilde and environment variables in a path string to a shared source file? I wanted exactly this functionality for KeeShare path settings.

hifi · 2019-11-07T18:35:51Z

Moved KeeAgentSettings::envSubst() to Tools::envSubst() for more generic use as per request. This also removed an extra test step as the tools already had a test runner. Rebased on top of current develop.

Edit: Also ran clang-format on refactored code.

droidmonkey · 2020-01-27T22:48:16Z

I rebased this onto the agent refactor.

Supports all platforms, including Windows with %FOO% syntax. Fixes keepassxreboot#3523

Added - Custom Light and Dark themes [#4110, #4769, #4791, #4796, #4892, #4915] - Compact mode to use classic Group and Entry line height [#4910] - View menu to quickly switch themes, compact mode, and toggle UI elements [#4910] - Search for groups and scope search to matched groups [#4705] - Save Database Backup feature [#4550] - Sort entries by "natural order" and move lines up/down [#4357] - Option to launch KeePassXC on system startup/login [#4675] - Caps Lock warning on password input fields [#3646] - Add "Size" column to entry view [#4588] - Browser-like tab experience using Ctrl+[Num] (Alt+[Num] on Linux) [#4063, #4305] - Password Generator: Define additional characters to choose from [#3876] - Reports: Database password health check (offline) [#3993] - Reports: HIBP online service to check for breached passwords [#4438] - Auto-Type: DateTime placeholders [#4409] - Browser: Show group name in results sent to browser extension [#4111] - Browser: Ability to define a custom browser location (macOS and Linux only) [#4148] - Browser: Ability to change root group UUID and inline edit connection ID [#4315, #4591] - CLI: `db-info` command [#4231] - CLI: Use wl-clipboard if xclip is not available (Linux) [#4323] - CLI: Incorporate xclip into snap builds [#4697] - SSH Agent: Key file path env substitution, SSH_AUTH_SOCK override, and connection test [#3769, #3801, #4545] - SSH Agent: Context menu actions to add/remove keys [#4290] Changed - Complete replacement of default database icons [#4699] - Complete replacement of application icons [#4066, #4161, #4203, #4411] - Complete rewrite of documentation and manpages using Asciidoctor [#4937] - Complete refactor of config files; separate between local and roaming [#4665] - Complete refactor of browser integration and proxy code [#4680] - Complete refactor of hardware key integration (YubiKey and OnlyKey) [#4584, #4843] - Significantly improve performance when saving and opening databases [#4309, #4833] - Remove read-only detection for database files [#4508] - Overhaul of password fields and password generator [#4367] - Replace instances of "Master Key" with "Database Credentials" [#4929] - Change settings checkboxes to positive phrasing for consistency [#4715] - Improve UX of using entry actions (focus fix) [#3893] - Set expiration time to Now when enabling entry expiration [#4406] - Always show "New Entry" in context menu [#4617] - Issue warning before adding large attachments [#4651] - Improve importing OPVault [#4630] - Improve AutoOpen capability [#3901, #4752] - Check for updates every 7 days even while still running [#4752] - Improve Windows installer UI/UX [#4675] - Improve config file handling of portable distribution [#4131, #4752] - macOS: Hide dock icon when application is hidden to tray [#4782] - Browser: Use unlock dialog to improve UX of opening a locked database [#3698] - Browser: Improve database and entry settings experience [#4392, #4591] - Browser: Improve confirm access dialog [#2143, #4660] - KeeShare: Improve monitoring file changes of shares [#4720] - CLI: Rename `create` command to `db-create` [#4231] - CLI: Cleanup `db-create` options (`--set-key-file` and `--set-password`) [#4313] - CLI: Use stderr for help text and password prompts [#4086, #4623] - FdoSecrets: Display existing secret service process [#4128] Fixed - Fix changing focus around the main window using tab key [#4641] - Fix search field clearing while still using the application [#4368] - Improve search help widget displaying on macOS and Linux [#4236] - Return keyboard focus after editing an entry [#4287] - Reset database path after failed "Save As" [#4526] - Use SHA256 Digest for Windows code signing [#4129] - Improve handling of ccache when building [#4104, #4335] - macOS: Properly re-hide application window after browser integration and Auto-Type usage [#4909] - Auto-Type: Fix crash when performing on new entry [#4132] - Browser: Send legacy HTTP settings to recycle bin [#4589] - Browser: Fix merging browser keys [#4685] - CLI: Fix encoding when exporting database [#3921] - SSH Agent: Improve reliability and underlying code [#3833, #4256, #4549, #4595] - FdoSecrets: Fix crash when editing settings before service is enabled [#4332]

hifi added the feature: SSH agent label Nov 2, 2019

hifi added this to the v2.6.0 milestone Nov 2, 2019

hifi added the new feature label Nov 5, 2019

hifi force-pushed the feature/ssh-agent-env-subst branch from 973c6c7 to b99f3e8 Compare November 7, 2019 18:33

hifi force-pushed the feature/ssh-agent-env-subst branch 3 times, most recently from b111590 to 6faf444 Compare November 12, 2019 15:44

droidmonkey force-pushed the feature/ssh-agent-env-subst branch from 6faf444 to 1105ee1 Compare November 18, 2019 03:49

droidmonkey approved these changes Jan 27, 2020

View reviewed changes

droidmonkey force-pushed the feature/ssh-agent-env-subst branch 3 times, most recently from eeb407a to 849ab2a Compare January 27, 2020 22:47

Implement SSH key file path env substitution

96bb405

Supports all platforms, including Windows with %FOO% syntax. Fixes keepassxreboot#3523

droidmonkey force-pushed the feature/ssh-agent-env-subst branch from 849ab2a to 96bb405 Compare January 28, 2020 02:03

droidmonkey merged commit 6fc7be7 into keepassxreboot:develop Jan 28, 2020

phoerious added pr: new feature Pull request that adds a new feature and removed new feature labels Nov 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement SSH key file path env substitution #3769

Implement SSH key file path env substitution #3769

hifi commented Nov 2, 2019 •

edited

Loading

schlimmchen commented Nov 7, 2019

hifi commented Nov 7, 2019 •

edited

Loading

droidmonkey commented Jan 27, 2020

Implement SSH key file path env substitution #3769

Implement SSH key file path env substitution #3769

Conversation

hifi commented Nov 2, 2019 • edited Loading

Type of change

Description and Context

Testing strategy

Checklist:

schlimmchen commented Nov 7, 2019

hifi commented Nov 7, 2019 • edited Loading

droidmonkey commented Jan 27, 2020

hifi commented Nov 2, 2019 •

edited

Loading

hifi commented Nov 7, 2019 •

edited

Loading