Support ssh public keys configuration #10573

mustard-mh · 2022-06-10T07:09:32Z

Description

This PR works on allowing users to upload their own ssh public key to Gitpod, make copy-paste ssh connect more conventional, and make sharing of ssh connect command more safety

Link of Figma

TODO

‼️ Find out how to setup db-sync
‼️ Merge PR [ws-proxy, ws-manager] support user upload ssh public key #10617
‼️ Deploy previous PR [ws-proxy, ws-manager] support user upload ssh public key #10617
Dashboard ssh copy-paste improve
Make copy-paste ways can be switched
Properly content for users

~~Functions for late used time?~~

Related Issue(s)

Relate #9932

How to test

Modal of ssh copy-paste always shows SSH Key as the default selection, if the user has no public key uploaded, it will show a warning in this section.

Start a workspace in prev env
Wait until the workspace is ready
Connect with ssh copy-paste, get conn A
- Failed with ssh key conn
- Success with access token conn
add a public key via setting -> ssh keys
Connect with ssh copy-paste use ssh key, get conn B
Delete that public key you set in the settings
Connection B should still work
A new conn C which use the same command like conn B, will not works - ask a password

Release Notes

Allow users to add and remove SSH public keys in settings
Change UX of SSH copy-paste to support ssh key connection

Documentation

TODO

Werft options:

/werft with-preview

mustard-mh · 2022-06-15T17:38:33Z

/hold

werft-gitpod-dev-com · 2022-06-15T17:40:18Z

started the job as gitpod-build-hw-ssh-keys-s.30 because the annotations in the pull request description changed
(with .werft/ from main)

werft-gitpod-dev-com · 2022-06-15T17:40:30Z

started the job as gitpod-build-hw-ssh-keys-s.31 because the annotations in the pull request description changed
(with .werft/ from main)

werft-gitpod-dev-com · 2022-06-15T17:41:19Z

started the job as gitpod-build-hw-ssh-keys-s.32 because the annotations in the pull request description changed
(with .werft/ from main)

mustard-mh · 2022-06-15T17:42:38Z

I'll not change the description anymore until one build success, since werft is crazy now... 😱

geropl

Nice, LGTM! 👍

akosyakov · 2022-06-27T05:53:38Z

/werft run

👍 started the job as gitpod-build-hw-ssh-keys-s.45
(with .werft/ from main)

akosyakov · 2022-06-27T06:18:09Z

@mustard-mh wanted to check out UI, but werft fails

gtsiolis · 2022-06-27T11:40:07Z

/werft run

👍 started the job as gitpod-build-hw-ssh-keys-s.46
(with .werft/ from main)

mustard-mh · 2022-06-28T03:44:51Z

Resolved merge conflict

/werft run with-clean-slate-deployment=true

👍 started the job as gitpod-build-hw-ssh-keys-s.48
(with .werft/ from main)

gtsiolis · 2022-06-28T14:29:16Z

@mustard-mh Could you clean deploy another preview environment or delete some users because we've reached the limit of 10 users and no new users can sign up.

mustard-mh · 2022-06-28T14:44:49Z

@mustard-mh Could you clean deploy another preview environment or delete some users because we've reached the limit of 10 users and no new users can sign up.

@gtsiolis Rebased to main again, since some commits may fix this problem (db have only two builtin users)

mustard-mh · 2022-06-28T14:54:15Z

/werft run

👍 started the job as gitpod-build-hw-ssh-keys-s.50
(with .werft/ from main)

mustard-mh · 2022-06-28T15:11:54Z

works now @gtsiolis

gtsiolis

Looks great, @mustard-mh! 🔮

Took another look at this and left a few more comments below. 👀

gtsiolis · 2022-06-28T15:07:19Z

components/dashboard/src/settings/SSHKeys.tsx

+                <a href="/docs/configure/ssh" target="gitpod-ssh-doc" className="gp-link">
+                    Learn more
+                </a>


thought: Do we need this help link here? Asking because we also link below to the same page.

I think we can keep that, they are different part link

components/gitpod-db/src/typeorm/user-db-impl.ts

gtsiolis · 2022-06-28T15:14:46Z

components/gitpod-protocol/src/protocol.ts

+        try {
+            getData(value);
+        } catch (e) {
+            return "Key is invalid. You must supply a key in OpenSSH public key format.";


issue(non-blocking): While we catch some cases, we still allow users adding invalid keys. Is this known? If needed, let's open a follow-up issue to resolve this.

components/dashboard/src/settings/SSHKeys.tsx

components/dashboard/src/workspaces/ConnectToSSHModal.tsx

gtsiolis · 2022-06-28T15:40:44Z

components/dashboard/src/workspaces/ConnectToSSHModal.tsx

+                )}
+                {!hasSSHKey && selectSSHKey && (
+                    <Alert type="warning" className="whitespace-normal">
+                        You don't have any public SSH keys in your Gitpod account. You can{" "}


issue: When you don't have an SSH key in place, you still see an SSH command below to connect, which asks for a password. Should we drop (hide) the SSH command below?

If we should allow to copy it always. If a user adds keys following a warning then they can use it immediately. Otherwise they need to reopen the dialog

If we should allow to copy it always. If a user adds keys following a warning then they can use it immediately. Otherwise they need to reopen the dialog

Ah, I see. Then the warning dialog becomes obsolete or no longer relevant after adding a key, right?

Maybe it's not worth doing so, but what do you think of rephrasing the copy then to the following when there are no keys in place:

BEFORE

The following shell command can be used to SSH into this workspace with a ssh key.

AFTER

The following shell command can be used to SSH into this workspace with a ssh key, once you add an SSH key.

Otherwise, let's leave this as is and ignore the comment above in #10573 (comment). ✔️

I'm fine with both. I think they will read a warning when prompted for a password.

DEAL—Let's go with any option for now.

akosyakov · 2022-06-29T06:45:29Z

UI looks good, but then I try first time user flow I cannot connect:

i start a workspace
then go to dashboard and select connect to SSH
it tells me that I don't have public keys
i generate a new key on my machine under ~/.ssh/test_rsa
i go to setting and add this key
i go back to dialog, copy a command, paste it with -i ~/.ssh/test_rsa
it asks me for password

Is it because newly installed keys are not automatically propagated to workspaces? Hm it does not work after restart either.

iQQBot · 2022-06-29T09:43:22Z

for me it works good @akosyakov Did your really upload correct public key? public key file name should be end with .pub

could your use ssh -vvv ..... command and provider logs?

akosyakov · 2022-06-29T09:49:27Z

@iQQBot I did everything again and it worked now. So probably some mistake on my side.

Oh, I know why, I did not exit another ssh session 😆 so I was in Gitpod container.

Co-authored-by: George Tsiolis <[email protected]>

iQQBot · 2022-07-05T05:33:51Z

rebase to main and double-checked everything, now we are in gen51 it's time to merge

/unhold

roboquat added do-not-merge/work-in-progress do-not-merge/release-note-label-needed size/XL labels Jun 10, 2022

mustard-mh force-pushed the hw/ssh-keys-s branch 2 times, most recently from d69e014 to 2b2c8da Compare June 10, 2022 07:57

mustard-mh changed the title ~~Hw/ssh keys s~~ Add protocol and implement for ssh public keys Jun 10, 2022

roboquat added size/XXL and removed size/XL labels Jun 13, 2022

mustard-mh changed the title ~~Add protocol and implement for ssh public keys~~ Support ssh public keys configuration Jun 13, 2022

mustard-mh force-pushed the hw/ssh-keys-s branch 4 times, most recently from 56aa88c to 461e496 Compare June 14, 2022 19:27

roboquat added release-note and removed do-not-merge/release-note-label-needed labels Jun 14, 2022

mustard-mh force-pushed the hw/ssh-keys-s branch 4 times, most recently from a8855a4 to b465867 Compare June 15, 2022 17:30

roboquat added the do-not-merge/hold label Jun 15, 2022

gitpod-io deleted a comment from werft-gitpod-dev-com bot Jun 15, 2022

mustard-mh marked this pull request as ready for review June 15, 2022 17:42

geropl approved these changes Jun 24, 2022

View reviewed changes

mustard-mh force-pushed the hw/ssh-keys-s branch from 6edd014 to fef5040 Compare June 28, 2022 03:44

loujaybee mentioned this pull request Jun 28, 2022

Gitpod Remote extension overrides remote.SSH.configFile setting #5889

Closed

mustard-mh force-pushed the hw/ssh-keys-s branch from fef5040 to 725c071 Compare June 28, 2022 14:43

gtsiolis reviewed Jun 28, 2022

View reviewed changes

iQQBot force-pushed the hw/ssh-keys-s branch from ba4cb92 to 4fed544 Compare June 28, 2022 17:24

iQQBot force-pushed the hw/ssh-keys-s branch from 4fed544 to c30716d Compare June 29, 2022 08:46

mustard-mh and others added 4 commits July 4, 2022 15:41

[server,db,protocol] support ssh public key

f23c2bb

Co-authored-by: George Tsiolis <[email protected]>

Add test cases ssh public keys namespace

e35e372

[dashboard] ssh keys setting support

c5178fa

[dashboard] support ssh copy-paste with ssh keys

4bcdbbd

iQQBot force-pushed the hw/ssh-keys-s branch from c30716d to 4bcdbbd Compare July 4, 2022 15:41

roboquat removed the do-not-merge/hold label Jul 5, 2022

roboquat merged commit 924b20e into main Jul 5, 2022

roboquat deleted the hw/ssh-keys-s branch July 5, 2022 05:34

roboquat added deployed: webapp Meta team change is running in production deployed Change is completely running in production labels Jul 5, 2022

loujaybee mentioned this pull request Jul 6, 2022

Epic: Upload users SSH keys to Gitpod #9932

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support ssh public keys configuration #10573

Support ssh public keys configuration #10573

mustard-mh commented Jun 10, 2022 •

edited by iQQBot

Loading

mustard-mh commented Jun 15, 2022

werft-gitpod-dev-com bot commented Jun 15, 2022

werft-gitpod-dev-com bot commented Jun 15, 2022

werft-gitpod-dev-com bot commented Jun 15, 2022

mustard-mh commented Jun 15, 2022 •

edited

Loading

geropl left a comment

akosyakov commented Jun 27, 2022 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov commented Jun 27, 2022

gtsiolis commented Jun 27, 2022 •

edited by werft-gitpod-dev-com bot

Loading

mustard-mh commented Jun 28, 2022 •

edited by werft-gitpod-dev-com bot

Loading

gtsiolis commented Jun 28, 2022

mustard-mh commented Jun 28, 2022

mustard-mh commented Jun 28, 2022 •

edited by werft-gitpod-dev-com bot

Loading

mustard-mh commented Jun 28, 2022

gtsiolis left a comment

gtsiolis Jun 28, 2022

iQQBot Jun 28, 2022

gtsiolis Jun 28, 2022

gtsiolis Jun 28, 2022

akosyakov Jun 29, 2022

gtsiolis Jun 29, 2022 •

edited

Loading

akosyakov Jun 30, 2022

gtsiolis Jun 30, 2022

akosyakov commented Jun 29, 2022 •

edited

Loading

iQQBot commented Jun 29, 2022

akosyakov commented Jun 29, 2022 •

edited

Loading

iQQBot commented Jul 5, 2022

Support ssh public keys configuration #10573

Support ssh public keys configuration #10573

Conversation

mustard-mh commented Jun 10, 2022 • edited by iQQBot Loading

Description

TODO

Related Issue(s)

How to test

Release Notes

Documentation

Werft options:

mustard-mh commented Jun 15, 2022

werft-gitpod-dev-com bot commented Jun 15, 2022

werft-gitpod-dev-com bot commented Jun 15, 2022

werft-gitpod-dev-com bot commented Jun 15, 2022

mustard-mh commented Jun 15, 2022 • edited Loading

geropl left a comment

Choose a reason for hiding this comment

akosyakov commented Jun 27, 2022 • edited by werft-gitpod-dev-com bot Loading

akosyakov commented Jun 27, 2022

gtsiolis commented Jun 27, 2022 • edited by werft-gitpod-dev-com bot Loading

mustard-mh commented Jun 28, 2022 • edited by werft-gitpod-dev-com bot Loading

gtsiolis commented Jun 28, 2022

mustard-mh commented Jun 28, 2022

mustard-mh commented Jun 28, 2022 • edited by werft-gitpod-dev-com bot Loading

mustard-mh commented Jun 28, 2022

gtsiolis left a comment

Choose a reason for hiding this comment

gtsiolis Jun 28, 2022

Choose a reason for hiding this comment

iQQBot Jun 28, 2022

Choose a reason for hiding this comment

gtsiolis Jun 28, 2022

Choose a reason for hiding this comment

gtsiolis Jun 28, 2022

Choose a reason for hiding this comment

akosyakov Jun 29, 2022

Choose a reason for hiding this comment

gtsiolis Jun 29, 2022 • edited Loading

Choose a reason for hiding this comment

BEFORE

AFTER

akosyakov Jun 30, 2022

Choose a reason for hiding this comment

gtsiolis Jun 30, 2022

Choose a reason for hiding this comment

akosyakov commented Jun 29, 2022 • edited Loading

iQQBot commented Jun 29, 2022

akosyakov commented Jun 29, 2022 • edited Loading

iQQBot commented Jul 5, 2022

mustard-mh commented Jun 10, 2022 •

edited by iQQBot

Loading

mustard-mh commented Jun 15, 2022 •

edited

Loading

akosyakov commented Jun 27, 2022 •

edited by werft-gitpod-dev-com bot

Loading

gtsiolis commented Jun 27, 2022 •

edited by werft-gitpod-dev-com bot

Loading

mustard-mh commented Jun 28, 2022 •

edited by werft-gitpod-dev-com bot

Loading

mustard-mh commented Jun 28, 2022 •

edited by werft-gitpod-dev-com bot

Loading

gtsiolis Jun 29, 2022 •

edited

Loading

akosyakov commented Jun 29, 2022 •

edited

Loading

akosyakov commented Jun 29, 2022 •

edited

Loading