Skip to content

[vnet] feat: write VNet SSH keys to TELEPORT_HOME#55228

Merged
nklaassen merged 1 commit intomasterfrom
nklaassen/vnet-ssh-keys
Jun 1, 2025
Merged

[vnet] feat: write VNet SSH keys to TELEPORT_HOME#55228
nklaassen merged 1 commit intomasterfrom
nklaassen/vnet-ssh-keys

Conversation

@nklaassen
Copy link
Copy Markdown
Contributor

@nklaassen nklaassen commented May 28, 2025

This PR is the next step in the implementation of VNet SSH (RFD).

In this PR the VNet service sends its host CA public key to the client application which writes it to ${TELEPORT_HOME}/vnet_known_hosts so that third-party SSH clients can trust it. It then reads or generates ${TELEPORT_HOME}/id_vnet(.pub) which SSH clients should be configured to use for connections to VNet SSH. id_vnet.pub is sent back to the VNet service and trusted for incoming connections from third-party SSH clients. This is as described at https://github.com/gravitational/teleport/blob/master/rfd/0207-vnet-ssh.md#ssh-client-configuration

With this PR in place connections through VNet SSH fully work. The only thing that's needed is manual configuration of the SSH client so that the correct keys are used, an example is included below. In the following PR this configuration will be automatically generated.

$ cat ./connect_dev_vnet_ssh_config
Host *.one.private
  IdentityFile "/Users/nic/Library/Application Support/Electron/tsh/id_vnet"
  GlobalKnownHostsFile "/Users/nic/Library/Application Support/Electron/tsh/vnet_known_hosts"
  UserKnownHostsFile /dev/null
  StrictHostKeyChecking yes
  IdentitiesOnly yes
$ ssh -F ./connect_dev_vnet_ssh_config node-iot.one.private
Nics-MacBook-Pro:~ nic$ date
Wed May 28 12:15:40 PDT 2025
Nics-MacBook-Pro:~ nic$ exit
logout
Connection to node-iot.one.private closed.
$ ssh -F ./connect_dev_vnet_ssh_config two-auth.two-prod.one.private
Nics-MacBook-Pro:~ nic$ logout
Connection to two-auth.two-prod.one.private closed.

Parent PR: #55156
Child PR: #55239

Comment thread lib/client/keystore.go Outdated
Comment thread proto/teleport/lib/vnet/v1/client_application_service.proto
Comment thread lib/vnet/opensshconfig.go Outdated
Comment thread api/utils/keypaths/keypaths.go
Comment thread lib/vnet/opensshconfig.go Outdated
Comment thread lib/vnet/opensshconfig.go Outdated
@nklaassen nklaassen force-pushed the nklaassen/vnet-ssh-forward branch from 77dfb59 to 6f0f5a2 Compare May 29, 2025 17:53
@nklaassen nklaassen force-pushed the nklaassen/vnet-ssh-keys branch from 2281ea6 to 173b1e6 Compare May 29, 2025 18:10
@nklaassen nklaassen force-pushed the nklaassen/vnet-ssh-forward branch from 6f0f5a2 to 93a4920 Compare May 30, 2025 17:56
@nklaassen nklaassen force-pushed the nklaassen/vnet-ssh-keys branch 2 times, most recently from 72c85d2 to dd08608 Compare May 30, 2025 18:47
Comment on lines +82 to +84
// vnetKnownHosts is the file name of the known_hosts file trusted by
// third-party SSH clients connecting to VNet SSH.
vnetKnownHosts = "vnet_known_hosts"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggestion: maybe move the constant within the VNetKnownHostsPath function if it's not intended to be consumed outside of the function?

Comment thread lib/vnet/opensshconfig.go Outdated
Comment thread lib/vnet/opensshconfig.go Outdated
@nklaassen nklaassen force-pushed the nklaassen/vnet-ssh-forward branch from bb7d9ec to 6fc6076 Compare May 31, 2025 04:16
@nklaassen nklaassen force-pushed the nklaassen/vnet-ssh-keys branch from 14b7aa3 to 5e753a8 Compare May 31, 2025 04:16
@nklaassen nklaassen force-pushed the nklaassen/vnet-ssh-forward branch from 6fc6076 to 5f37bd7 Compare May 31, 2025 16:03
Base automatically changed from nklaassen/vnet-ssh-forward to master May 31, 2025 16:44
@nklaassen nklaassen force-pushed the nklaassen/vnet-ssh-keys branch from 5e753a8 to 5fb42ce Compare June 1, 2025 05:29
@nklaassen nklaassen enabled auto-merge June 1, 2025 05:35
@nklaassen nklaassen added this pull request to the merge queue Jun 1, 2025
Merged via the queue into master with commit 3a3099e Jun 1, 2025
42 checks passed
@nklaassen nklaassen deleted the nklaassen/vnet-ssh-keys branch June 1, 2025 06:11
nklaassen added a commit that referenced this pull request Jun 1, 2025
nklaassen added a commit that referenced this pull request Jun 1, 2025
github-merge-queue Bot pushed a commit that referenced this pull request Jul 22, 2025
* [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
* [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

Labels

no-changelog Indicates that a PR does not require a changelog entry size/md vnet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants