Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ssh.forwardAgent setting to Connect #46798

Merged
merged 1 commit into from
Sep 24, 2024
Merged

Add ssh.forwardAgent setting to Connect #46798

merged 1 commit into from
Sep 24, 2024

Conversation

ravicious
Copy link
Member

@ravicious ravicious commented Sep 20, 2024

In gravitational/webapps#1366, we made it so that Connect always passes --forward-agent to fix #18320 – before that it was impossible to use agent forwarding in Connect.

When investigating an issue with gpg-agent, after a short discussion we decided to turn it into an opt-in config option instead.

However, technically it'd be a breaking change, so this is split into two PRs. The first one is going to add ssh.forwardAgent that defaults to true (to keep backwards compatibility) and is going to be backported to v15 and v16. The next PR (#46799) is going to change the default to false and it will be released in v17.0.0.

Fortunately thanks to the already existing ssh.noResume we have an established pattern for selecting flags to pass to tsh ssh based on the config of Connect. v14 doesn't have that config option, so I'm not backporting to v14.

changelog: Added a new config option in Teleport Connect to control SSH agent forwarding (ssh.forwardAgent); starting in Teleport Connect v17, this option will be disabled by default

Copy link

🤖 Vercel preview here: https://docs-mkb0sx1m2-goteleport.vercel.app/docs/ver/preview

@@ -478,6 +478,7 @@ Below is the list of the supported config properties.
| `keymap.openSearchBar` | `Command+K` on macOS<br/>`Ctrl+Shift+K` on Windows/Linux | Shortcut to open the search bar. |
| `headless.skipConfirm` | false | Skips the confirmation prompt for Headless WebAuthn approval and instead prompts for WebAuthn immediately. |
| `ssh.noResume` | false | Disables SSH connection resumption. |
| `ssh.forwardAgent` | true | Enables agent forwarding. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description here is different than in appConfigSchema. Was it done intentionally?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just wanted to keep it short after I saw how short it is for ssh.noResume. 🥲

@ravicious ravicious added this pull request to the merge queue Sep 24, 2024
Merged via the queue into master with commit 82adc5f Sep 24, 2024
47 checks passed
@ravicious ravicious deleted the r7s/agent-fwd branch September 24, 2024 22:14
@public-teleport-github-review-bot

@ravicious See the table below for backport results.

Branch Result
branch/v15 Failed
branch/v16 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Agent forwarding broken in Teleport Connect
4 participants