Skip to content

[vnet] feat: automatic SSH client configuration#55923

Merged
nklaassen merged 6 commits intomasterfrom
nklaassen/vnet-ssh-autoconfig
Jun 25, 2025
Merged

[vnet] feat: automatic SSH client configuration#55923
nklaassen merged 6 commits intomasterfrom
nklaassen/vnet-ssh-autoconfig

Conversation

@nklaassen
Copy link
Copy Markdown
Contributor

@nklaassen nklaassen commented Jun 20, 2025

This commit adds a function that automatically adds Include $TELEPORT_HOME/tsh/vnet_ssh_config to the user's ~/.ssh/config file when they run the new command tsh vnet-ssh-autoconfig.

A follow-up PR will add a button to call this from Connect.

The changes in lib/vnet/diag/ssh.go are mechanical, I just factored SSHConfigChecker out of SSHDiag.

@nklaassen nklaassen added no-changelog Indicates that a PR does not require a changelog entry vnet labels Jun 20, 2025
@github-actions github-actions Bot requested review from kiosion and probakowski June 20, 2025 01:13
@github-actions github-actions Bot added size/md tsh tsh - Teleport's command line tool for logging into nodes running Teleport. labels Jun 20, 2025
@nklaassen nklaassen force-pushed the nklaassen/vnet-ssh-autoconfig branch 4 times, most recently from de4d430 to 5cd4600 Compare June 20, 2025 17:36
@nklaassen nklaassen mentioned this pull request Jun 20, 2025
Merged
probakowski
probakowski approved these changes Jun 24, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@probakowski probakowski left a comment

Choose a reason for hiding this comment

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

Overall LGTM, small comment

Comment thread lib/vnet/opensshconfig.go Outdated
// AutoConfigureOpenSSH adds an Include directive to the default user OpenSSH
// config file (~/.ssh/config) to include the vnet_ssh_config file found under
// profilePath.
func AutoConfigureOpenSSH(ctx context.Context, profilePath string, overrideUserSSHConfigPath ...string) (err error) {
Copy link
Copy Markdown
Contributor

@probakowski probakowski Jun 24, 2025

Choose a reason for hiding this comment

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

I don't love the idea of parameter used only in tests but couldn't figure out a better way.
We should at least mention in the godoc what it does and why (or maybe even change its name to make sure it won't be used outside of tests?)

Copy link
Copy Markdown
Contributor Author

@nklaassen nklaassen Jun 24, 2025

Choose a reason for hiding this comment

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

I made it a functional option with unexported types so that callers outside this package can't use it

@nklaassen nklaassen force-pushed the nklaassen/vnet-ssh-autoconfig branch from 5cd4600 to 58246e1 Compare June 24, 2025 17:06
@nklaassen
Copy link
Copy Markdown
Contributor Author

nklaassen commented Jun 24, 2025

friendly ping @kiosion

@nklaassen nklaassen force-pushed the nklaassen/vnet-ssh-autoconfig branch from 58246e1 to 3acfc10 Compare June 24, 2025 21:49
zmb3
zmb3 reviewed Jun 25, 2025
View reviewed changes
Comment thread lib/vnet/diag/ssh.go Outdated
Comment thread lib/vnet/diag/ssh.go Outdated
Comment thread lib/vnet/diag/ssh.go
@public-teleport-github-review-bot public-teleport-github-review-bot Bot removed the request for review from kiosion June 25, 2025 19:08
@nklaassen nklaassen enabled auto-merge June 25, 2025 19:32
@nklaassen nklaassen added this pull request to the merge queue Jun 25, 2025
Merged via the queue into master with commit 3ed650d Jun 25, 2025
39 checks passed
@nklaassen nklaassen deleted the nklaassen/vnet-ssh-autoconfig branch June 25, 2025 20:14
nklaassen added a commit that referenced this pull request Jun 25, 2025
@nklaassen
[v18][vnet] feat: automatic SSH client configuration
fffa153 
Backport #55923 to branch/v18
nklaassen added a commit that referenced this pull request Jun 25, 2025
@nklaassen
[v17][vnet] feat: automatic SSH client configuration
70c6cbf 
Backport #55923 to branch/v17
github-merge-queue Bot pushed a commit that referenced this pull request Jul 22, 2025
@nklaassen @ravicious @gzdunek
[v17][vnet] feat: VNet SSH (#55313)
37b7e9b 
* [v17][vnet] feat: TCP dial to SSH targets

Backport #55087 to branch/v17

* [v17][vnet] feat: accept incoming SSH connections

Backport #55155 to branch/v17

* [v17][vnet] feat: forward SSH connections to target

Backport #55156 to branch/v17

* [v17][vnet] feat: write VNet SSH keys to TELEPORT_HOME

Backport #55228 to branch/v17

* [v17][vnet] feat: write OpenSSH-compatible config file for VNet SSH

Backport #55239 to branch/v17

* [v17][vnet] fix: support <hostname>.<leaf-cluster> for VNet SSH

Backport #55688 to branch/v17

* fix BlockUntil API for backport

* [v17][vnet] feat: add "Connect with VNet" button to SSH servers

Backport #55623 to branch/v17

* [v17][vnet] feat: support VNet SSH when cluster name does not match proxy public addr

Backport #55655 to branch/v17

* [v17][vnet] feat: add SSH configuration diagnostic

Backport #55594 to branch/v17

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>

* [v17][vnet] feat: show SSH status in VNet slider

Backport #55755 to branch/v17

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>

* [v17][vnet] feat: support proxy recording mode with VNet SSH

Backport #55788 to branch/v17

* [v17][vnet] feat: support diag checks on windows

Backport #55856 to branch/v17

* [v17] fix: data race in vnet.TestSSH

Backport #55980 to branch/v17

* [v17][vnet] feat: mention SSH on VNet info page

Backport #55973 to branch/v17

* [v17][vnet] feat: serve DNS on IPv4

Backport #55539 to branch/v17

* [v17][vnet] fix: close proxied channel only after data and requests are complete

Backport #56020 to branch/v17

* [v17][vnet] feat: automatic SSH client configuration

Backport #55923 to branch/v17

* VNet docs: Provide clear instructions for getting debug logs (#56068)

* VNet diag notification: Do not show button to open report if there's no workspace selected (#56067)

* VNet diag report: Don't show button in notification if there's no workspace

* Replace deprecated MutableRefObject with RefObject

* Make openReport not depend on value of rootClusterUri

Otherwise the effect that uses setInterval re-runs whenever the user
switches to another workspace.

* [v17][vnet] feat: automatic SSH client configuration in Connect

Backport #55924 to branch/v17

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>
Co-authored-by: Grzegorz Zdunek <grzegorz.zdunek@goteleport.com>

* [v17][vnet] fix: avoid empty host matchers in generated SSH config

Backport #56103 to branch/v17

* avoid t.Context() pre go1.24

* fix cspell lint

* [v17][docs] VNet SSH

Backport #56147 to branch/v17

* [v17][vnet] feat: SSH usage reporting

Backport #56537 to branch/v17

* [v17][vnet] fix: mask default IP route on windows

Backport #56957 to branch/v17

---------

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>
Co-authored-by: Grzegorz Zdunek <grzegorz.zdunek@goteleport.com>
github-merge-queue Bot pushed a commit that referenced this pull request Jul 22, 2025
@nklaassen @ravicious @gzdunek
[v18][vnet] feat: VNet SSH (#55311)
dbaeee7 
* [v18][vnet] feat: TCP dial to SSH targets

Backport #55087 to branch/v18

* [v18][vnet] feat: accept incoming SSH connections

Backport #55155 to branch/v18

* [v18][vnet] feat: forward SSH connections to target

Backport #55156 to branch/v18

* [v18][vnet] feat: write VNet SSH keys to TELEPORT_HOME

Backport #55228 to branch/v18

* [v18][vnet] feat: write OpenSSH-compatible config file for VNet SSH

Backport #55239 to branch/v18

* [v18][vnet] fix: support <hostname>.<leaf-cluster> for VNet SSH

Backport #55688 to branch/v18

* [v18][vnet] feat: add "Connect with VNet" button to SSH servers

Backport #55623 to branch/v18

* fix test in backport

* [v18][vnet] feat: support VNet SSH when cluster name does not match proxy public addr

Backport #55655 to branch/v18

* [v18][vnet] feat: add SSH configuration diagnostic

Backport #55594 to branch/v18

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>

* [v18][vnet] feat: show SSH status in VNet slider

Backport #55755 to branch/v18

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>

* [v18][vnet] feat: support proxy recording mode with VNet SSH

Backport #55788 to branch/v18

* [v18][vnet] feat: support diag checks on windows

Backport #55856 to branch/v18

* [v18] fix: data race in vnet.TestSSH

Backport #55980 to branch/v18

* [v18][vnet] feat: mention SSH on VNet info page

Backport #55973 to branch/v18

* [v18][vnet] feat: serve DNS on IPv4

Backport #55539 to branch/v18

* [v18][vnet] fix: close proxied channel only after data and requests are complete

Backport #56020 to branch/v18

* [v18][vnet] feat: automatic SSH client configuration

Backport #55923 to branch/v18

* VNet diag notification: Do not show button to open report if there's no workspace selected (#56067)

* VNet diag report: Don't show button in notification if there's no workspace

* Replace deprecated MutableRefObject with RefObject

* Make openReport not depend on value of rootClusterUri

Otherwise the effect that uses setInterval re-runs whenever the user
switches to another workspace.

* [v18][vnet] feat: automatic SSH client configuration in Connect

Backport #55924 to branch/v18

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>
Co-authored-by: Grzegorz Zdunek <grzegorz.zdunek@goteleport.com>

* [v18][vnet] fix: avoid empty host matchers in generated SSH config

Backport #56103 to branch/v18

* [v18][docs] VNet SSH

Backport #56147 to branch/v18

* [v18][docs] add VNet warnings

Backport #56601 to branch/v18

* [v18][vnet] feat: SSH usage reporting

Backport #56537 to branch/v18

* [v18][vnet] fix: mask default IP route on windows

Backport #56957 to branch/v18

---------

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>
Co-authored-by: Grzegorz Zdunek <grzegorz.zdunek@goteleport.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@probakowski probakowski probakowski approved these changes

@zmb3 zmb3 zmb3 approved these changes

Assignees

No one assigned

Labels

no-changelog Indicates that a PR does not require a changelog entry size/md tsh tsh - Teleport's command line tool for logging into nodes running Teleport. vnet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@nklaassen @probakowski @zmb3