Add ssh_host_key router by iQQBot · Pull Request #8295 · gitpod-io/gitpod

iQQBot · 2022-02-18T03:01:54Z

Description

This PR add a router for ssh_host_key, router URL is workspaceURL/_ssh/host_keys it will show all hostkeys

Related Issue(s)

How to test

Open a workspace
Use curl workspaceURL/_ssh/host_keys to test, it will contain all available public hostkey and type

Release Notes

NONE

Documentation

codecov · 2022-02-18T03:16:44Z

Codecov Report

Merging #8295 (ae5f486) into main (6497329) will decrease coverage by 2.20%.
The diff coverage is 86.20%.

@@            Coverage Diff             @@
##             main    #8295      +/-   ##
==========================================
- Coverage   31.23%   29.02%   -2.21%     
==========================================
  Files          39       39              
  Lines        5910     3335    -2575     
==========================================
- Hits         1846      968     -878     
+ Misses       3923     2313    -1610     
+ Partials      141       54      -87

Flag	Coverage Δ
components-gitpod-cli-app	`11.17% <ø> (ø)`
components-installer-raw-app	`5.62% <ø> (?)`
components-local-app-app-darwin-amd64	`?`
components-local-app-app-darwin-arm64	`?`
components-local-app-app-linux-amd64	`?`
components-local-app-app-linux-arm64	`?`
components-local-app-app-windows-386	`?`
components-local-app-app-windows-amd64	`?`
components-local-app-app-windows-arm64	`?`
components-supervisor-app	`?`
components-ws-proxy-app	`68.63% <86.20%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
components/ws-proxy/pkg/proxy/routes.go	`82.97% <84.61%> (ø)`
components/ws-proxy/pkg/proxy/proxy.go	`24.65% <100.00%> (ø)`
components/supervisor/pkg/terminal/service.go
components/supervisor/pkg/ports/ports-config.go
components/supervisor/pkg/terminal/ring-buffer.go
components/supervisor/pkg/supervisor/tasks.go
components/supervisor/pkg/ports/slirp4netns.go
components/local-app/pkg/auth/pkce.go
...mponents/supervisor/pkg/supervisor/notification.go
components/supervisor/pkg/ports/served-ports.go
... and 34 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6497329...ae5f486. Read the comment docs.

princerachit · 2022-02-18T04:54:13Z

Hi, Do you have any associated issue for this PR to get more context on the changes?

iQQBot · 2022-02-18T05:01:33Z

@princerachit just created one #8296
this is the first part of this issue, the second part is add API to Gateway plugin

iQQBot · 2022-02-18T05:02:44Z

@princerachit see internal thread

csweichel · 2022-02-18T09:03:43Z


+	// if host key is not empty, we use /__ws_proxy/ssh_host_key to provider public host key
+	if len(hostKeyList) > 0 {
+		routes.HandleSSHHostKeyRoute(r.Path("/__ws_proxy/ssh_host_key"), hostKeyList)


Do we want to introduce more component specific routes? Considering this is essentially API, what other cases for ws-proxy provided values do we see?

Want to get a wsProxyRouter like iderouter?

I observed that other routers have specific domain rules, and we just want to put it under ideDomain

@csweichel Do you mean to match path for __ws_proxy and have subroute for it?

I meant not tying it to ws-proxy, e.g. calling it __ssh or something like that. Just so that if we ever move this functionality elsewhere, we're not left with a misnomer we can't move away from.

why does this path use two _ ?

Let's go with one :) I thought we are using two for supervisor, but it is one there as well.

@csweichel Could you have a look again please? 🙏

akosyakov · 2022-02-18T12:33:48Z

I verified that it works with JB plugin hooks. @csweichel @kylos101 good to merge and deploy?

akosyakov · 2022-02-18T17:36:20Z

Here is a PR for GW plugin: #8317 to auto validate host keys based on changes on this PR.

csweichel

works as advertised

csweichel · 2022-02-21T11:09:07Z

+	}
+	byt, err := json.Marshal(shk)
+	if err != nil {
+		log.WithError(err).Error("ssh_host_key router setup failed")


this would produce a subtle failure mode: we'd get this error message once, but SSH access would be broken.

Not a reason not to merge, but maybe a follow up. Instead of just logging, we could bubble up the error and exit.

roboquat added do-not-merge/work-in-progress do-not-merge/release-note-label-needed release-note-none size/M and removed do-not-merge/release-note-label-needed labels Feb 18, 2022

iQQBot force-pushed the pd/ssh-hostkey branch from 47f97dc to 31eee3d Compare February 18, 2022 03:07

iQQBot force-pushed the pd/ssh-hostkey branch 2 times, most recently from d9a962e to 1befbf3 Compare February 18, 2022 03:38

iQQBot marked this pull request as ready for review February 18, 2022 03:40

iQQBot requested a review from a team February 18, 2022 03:40

roboquat removed the do-not-merge/work-in-progress label Feb 18, 2022

github-actions Bot added the team: workspace Issue belongs to the Workspace team label Feb 18, 2022

iQQBot commented Feb 18, 2022

View reviewed changes

Comment thread components/ws-proxy/pkg/proxy/routes.go Outdated

Comment thread components/ws-proxy/pkg/proxy/routes.go Outdated

akosyakov reviewed Feb 18, 2022

View reviewed changes

Comment thread components/ws-proxy/pkg/proxy/routes_test.go

akosyakov reviewed Feb 18, 2022

View reviewed changes

Comment thread components/ws-proxy/pkg/proxy/routes.go

iQQBot force-pushed the pd/ssh-hostkey branch from 1befbf3 to b79520d Compare February 18, 2022 08:53

roboquat added size/L and removed size/M labels Feb 18, 2022

csweichel reviewed Feb 18, 2022

View reviewed changes

add ssh_host_key router

ae5f486

iQQBot force-pushed the pd/ssh-hostkey branch from b79520d to ae5f486 Compare February 21, 2022 09:45

akosyakov assigned iQQBot Feb 21, 2022

csweichel approved these changes Feb 21, 2022

View reviewed changes

roboquat merged commit 8fa98f9 into main Feb 21, 2022

roboquat deleted the pd/ssh-hostkey branch February 21, 2022 11:13

roboquat added deployed: workspace Workspace team change is running in production deployed Change is completely running in production labels Feb 24, 2022

loujaybee added the team: IDE label Mar 7, 2022

Conversation

iQQBot commented Feb 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue(s)

How to test

Release Notes

Documentation

Uh oh!

codecov Bot commented Feb 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

princerachit commented Feb 18, 2022

Uh oh!

iQQBot commented Feb 18, 2022

Uh oh!

iQQBot commented Feb 18, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

akosyakov commented Feb 18, 2022

Uh oh!

akosyakov commented Feb 18, 2022

Uh oh!

csweichel left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

iQQBot commented Feb 18, 2022 •

edited

Loading

codecov Bot commented Feb 18, 2022 •

edited

Loading