Prompt users when cloning Git repositories using an invalid SSH key #995

vitaliy-guliy · 2021-02-16T10:38:03Z

What does this PR do?

Allows the workspace plugin to handle events when cloning Git projects by SSH uri
When the devfile contain GIT SSH project, the workspace plugin

performs the secure login to Git repository
in case of GitHub repository, proposes the user to upload public key
proposes the user to add auto-generated key to the Git repository by hands
allows the user to use its custom certificate

Screenshot/screencast of this PR

What issues does this PR fix or reference?

eclipse-che/che#13494

HappyPath tests related on SSH

https://github.com/eclipse/che/blob/master/tests/e2e/tests/e2e/GitSsh.spec.ts

How to test this PR?

Devfile to test

---
apiVersion: 1.0.0
metadata:
  generateName: clone-ssh-
projects:
  -
    name: che-theia
    source:
      type: git
      location: "[email protected]:eclipse/che-theia.git"
  -
    name: atlascode
    source:
      type: git
      location: "[email protected]:atlassianlabs/atlascode.git"
components:
  - type: cheEditor
    alias: che-theia
    reference: https://raw.githubusercontent.com/chepullreq4/pr-check-files/master/che-theia/pr-995/che_theia_meta.yaml
    memoryLimit: 2G

PR Checklist

As the author of this Pull Request I made sure that:

Reviewers

Reviewers, please comment how you tested the PR when approving it.

Happy Path Channel

HAPPY_PATH_CHANNEL=stable

Signed-off-by: Vitaliy Gulyy <[email protected]>

che-bot · 2021-02-16T11:09:07Z

❌ E2E Happy path tests failed ❗

See Details

name	link
che-theia	docker.io/maxura/che-theia:995
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:995

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

che-bot · 2021-02-16T13:07:30Z

❌ E2E Happy path tests failed ❗

See Details

name	link
che-theia	docker.io/maxura/che-theia:995
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:995

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

Signed-off-by: Vitaliy Gulyy <[email protected]>

che-bot · 2021-02-16T17:05:31Z

❌ E2E Happy path tests failed ❗

See Details

name	link
che-theia	docker.io/maxura/che-theia:995
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:995

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

plugins/workspace-plugin/src/theia-commands.ts

plugins/workspace-plugin/src/git.ts

Co-authored-by: Eric Williams <[email protected]>

che-bot · 2021-02-17T09:49:32Z

❌ E2E Happy path tests failed ❗

See Details

name	link
che-theia	docker.io/maxura/che-theia:995
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:995

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

sunix · 2021-02-17T12:04:00Z

Upload Private Key

It is not clear that it is to upload a private key to the che workspace. What about Upload Key Pair ? to be consistant with the other commands.

Upload existing key to Github

What about Add existing key to Github ?

Signed-off-by: Vitaliy Gulyy <[email protected]>

vitaliy-guliy · 2021-02-17T12:22:54Z

Upload Private Key

It is not clear that it is to upload a private key to the che workspace. What about Upload Key Pair ? to be consistant with the other commands.

Probably yes, but as I understand, the command must upload a private key from your local machine and register it in the system(your workspace) with ssh-add.
I don't remember, have we discussed that or not, but you could want to generate a keypair on your machine and then use it in Che. You will be able to upload your private key to your workpspace and add correspodring public key to your Git account.

Upload existing key to Github

What about Add existing key to Github ?

Renamed, thanks.

che-bot · 2021-02-17T12:57:17Z

❌ E2E Happy path tests failed ❗

See Details

name	link
che-theia	docker.io/maxura/che-theia:995
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:995

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

sunix · 2021-02-17T13:06:12Z

Probably yes, but as I understand, the command must upload a private key from your local machine and register it in the system(your workspace) with ssh-add.
I don't remember, have we discussed that or not, but you could want to generate a keypair on your machine and then use it in Che. You will be able to upload your private key to your workpspace and add correspodring public key to your Git account.

Usually, you generate a private key and a public key (key pair). upload the public key to github. But they generally come together in the generation phase.

Generating public/private ed25519 key pair.

I would recommend to use the same terminology here https://docs.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.

So what about in all the commands related to view/remove/upload commands, talking about public/private key pair ?

sunix · 2021-02-17T13:11:03Z

BTW what is the difference between Generate Key pair, Create key pair, and upload private key ?

vitaliy-guliy · 2021-02-17T13:54:20Z

BTW what is the difference between Generate Key pair, Create key pair, and upload private key ?

It seems Create key pair creates key pair from the content, provided by user. You have to enter content of public and private keys. @vinokurig am I right? It's pretty similar to Upload Private Key.., but creates a pair instead of uploading and registering one file.

Generate Key pair creates a new SSH key using ssh-keygen.

Upload Private Key uploads and registers your private key (without creating a key pair).

vinokurig · 2021-02-18T16:49:21Z

It will appear if you click Configure SSH. It did so intentionally to not overload the popup.

I know, I am talking about having an action to add the key to GitHub IN the notification, if the url is GitHub, instead of the list of commands. My point is that we already have a predefined SSH key so why not to use it? BTW when we added this predefined key the idea was to help unexperienced users and propose them to add the ssh key in the notification when they clone projects via SSH.

vitaliy-guliy · 2021-02-19T09:21:56Z

It will appear if you click Configure SSH. It did so intentionally to not overload the popup.

I know, I am talking about having an action to add the key to GitHub IN the notification, if the url is GitHub, instead of the list of commands. My point is that we already have a predefined SSH key so why not to use it? BTW when we added this predefined key the idea was to help unexperienced users and propose them to add the ssh key in the notification when they clone projects via SSH.

I think inexperienced user will retry cloning and then click on Configure SSH as there are no more buttons (except button to close the popup).
He could want to play a bit with SSH before uploading the key to GH, isn't he?

vitaliy-guliy · 2021-02-19T10:11:04Z

@l0rd since you requested the SSH plugin some time ago, it would be nice to see your opinion.
WDYT about having a button to upload an SSH key to the GitHub next to Configure SSH button?

We are discussing here two ways

not to overload the notification with dozen of buttons and use menu/command palette to manage SSH keys

do the same as above, but add 'Add Key To GitHub' when cloning from GH

vitaliy-guliy · 2021-02-19T11:53:18Z

@vitaliy-guliy I expect that you give a try with these different flow:

User starts a workspace with a devfile and a ssh github url
Flow#1: User wants Che to generate a new key pair and upload the public key to github
Flow#2: User wants to add his private key from his machine: upload the file(s). He has already uploaded the public key to github.
Flow#3: User wants to add his private key from his machine: copy paste to an editor. He has already uploaded the public key to github.

For flow#2 and flow#3, these are pretty similar. We have to see if keys with passphrase working in Che or not. If not, create a gh-issue to fix that.
Also flow#2 and flow#3, check that upload/add private key is enough (don't need to upload a public key?)

Uploading of private keyfile does not work as expected. In fact, the file is uploaded, but need to investigate what's going when the plugins tries to register it with ssh-add.
I see that a keypair is created, but seems it has a wrong content.

See the issue eclipse-che/che#19109 where I explained the problem and steps to reproduce.
(need additional time to fix that ^^)

BTW, when I uploaded and registered the file by hand, I was able to clone the repository. So, the flow is working. Just need to fix the bug.

SSH: Create Key... command is also not working. It creates a key from the content, provided by user, but it's not possible to clone the git repository. I think we will fix that withing fixing the bug with uploading of private key.

l0rd · 2021-02-19T12:02:20Z

@vitaliy-guliy I like the option with the "Add Key to GitHub" cc @sympatheticmoose

sunix · 2021-02-19T12:54:47Z

If someone has a git ssh url in the devfile, we expect him to understand these kind of doc: https://docs.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent

For those people, giving the list of actions to perform in case of failure is the way to go.

We can't neither be too specific to Github and cover all the flows with bitbucket or any others private or public git repos.

Signed-off-by: Vitaliy Gulyy <[email protected]>

sunix · 2021-02-19T13:33:15Z

Also, in most of the cases, Github users would get through https, not ssh.
With https urls, they would be already logged in thanks to Github Oauth to perform any push/clone to github repos even the private ones. We just need to use the right token when cloning (the same one we use to upload a ssh key anyway).

Ssh could be widely used in private git repos with onprem github/bitbucket/gitlab/other. So let's not hard coding this.

che-bot · 2021-02-19T14:39:47Z

✅ E2E Happy path tests succeed 🎉

See Details

name	link
che-theia	docker.io/maxura/che-theia:995
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:995

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

Signed-off-by: Vitaliy Gulyy <[email protected]>

che-bot · 2021-02-19T16:37:46Z

❌ E2E Happy path tests failed ❗

See Details

name	link
che-theia	docker.io/maxura/che-theia:995
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:995

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

vitaliy-guliy · 2021-02-22T09:05:49Z

[crw-ci-test]

vitaliy-guliy · 2021-02-22T09:10:14Z

[crw-ci-test --rebuild]

che-bot · 2021-02-22T10:09:39Z

✅ E2E Happy path tests succeed 🎉

See Details

name	link
che-theia	docker.io/maxura/che-theia:995
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:995

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

Signed-off-by: Vitaliy Gulyy <[email protected]>

codecov · 2021-02-23T12:19:12Z

Codecov Report

❗ No coverage uploaded for pull request base (master@af8b33d). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master     #995   +/-   ##
=========================================
  Coverage          ?   57.93%           
=========================================
  Files             ?       45           
  Lines             ?     2028           
  Branches          ?      333           
=========================================
  Hits              ?     1175           
  Misses            ?      843           
  Partials          ?       10

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 af8b33d...b006e8b. Read the comment docs.

che-bot · 2021-02-23T12:51:35Z

✅ E2E Happy path tests succeed 🎉

See Details

name	link
che-theia	docker.io/maxura/che-theia:995
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:995

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

vinokurig · 2021-02-23T15:13:10Z

I confirm that the ssh notifications buttons work as expected.

plugins/workspace-plugin/src/theia-commands.ts

* Improve the UX when cloning Git projects with SSH uri Signed-off-by: Vitaliy Gulyy <[email protected]>

che-bot · 2021-04-19T16:13:06Z

❌ E2E Happy path tests failed ❗

See Details

name	link
che-theia	quay.io/crw_pr/che-theia:995
che-theia-endpoint-runtime-binary	quay.io/crw_pr/che-theia-endpoint-runtime-binary:995

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

vitaliy-guliy added 6 commits February 2, 2021 12:35

Use ssh plugin to upload ssh keys to GitHub

d05fe33

Signed-off-by: Vitaliy Gulyy <[email protected]>

Merge branch 'master' into gh-13494-test

83f84b6

Signed-off-by: Vitaliy Gulyy <[email protected]>

Merge branch 'master' into gh-13494-test

dbf922c

Signed-off-by: Vitaliy Gulyy <[email protected]>

Merge branch 'master' into gh-13494-test

bf7718a

Signed-off-by: Vitaliy Gulyy <[email protected]>

Allow to clone projects with SSH uri

e6e67e5

Signed-off-by: Vitaliy Gulyy <[email protected]>

Merge branch 'master' into gh-13494-test

58abc59

Signed-off-by: Vitaliy Gulyy <[email protected]>

Display SSH commands to resolve errors

9e8f3a0

Signed-off-by: Vitaliy Gulyy <[email protected]>

ericwill reviewed Feb 16, 2021

View reviewed changes

plugins/workspace-plugin/src/theia-commands.ts Outdated Show resolved Hide resolved

plugins/workspace-plugin/src/git.ts Outdated Show resolved Hide resolved

vitaliy-guliy and others added 2 commits February 17, 2021 11:15

Update plugins/workspace-plugin/src/theia-commands.ts

8d57d06

Co-authored-by: Eric Williams <[email protected]>

Update plugins/workspace-plugin/src/git.ts

baf1b9f

Co-authored-by: Eric Williams <[email protected]>

vitaliy-guliy marked this pull request as ready for review February 17, 2021 09:45

vitaliy-guliy requested review from azatsarynnyy, benoitf, RomanNikitenko, sunix, svor, tsmaeder, vinokurig and vzhukovs as code owners February 17, 2021 09:45

Fix command label

7b91c2e

Signed-off-by: Vitaliy Gulyy <[email protected]>

Allow to pick the key from the list when adding it to GitHub

4a9194f

Signed-off-by: Vitaliy Gulyy <[email protected]>

vitaliy-guliy added 2 commits February 19, 2021 17:33

Use theia.TextDocumentContentProvider to open public keys

550b10b

Signed-off-by: Vitaliy Gulyy <[email protected]>

Allow to add public key to GitHub by clicking a notification button

0ccb05c

Signed-off-by: Vitaliy Gulyy <[email protected]>

Update adding key to GitHub when cloning git project with git->clone

b006e8b

Signed-off-by: Vitaliy Gulyy <[email protected]>

vinokurig approved these changes Feb 23, 2021

View reviewed changes

vitaliy-guliy mentioned this pull request Feb 23, 2021

Prompt users to provide an SSH key pair if using Git with SSH in a devfile eclipse-che/che#19133

Closed

vitaliy-guliy merged commit 88ead27 into master Feb 23, 2021

vitaliy-guliy deleted the gh-13494-test branch February 23, 2021 15:57

che-bot added this to the 7.27 milestone Feb 23, 2021

RomanNikitenko reviewed Feb 24, 2021

View reviewed changes

plugins/workspace-plugin/src/theia-commands.ts Show resolved Hide resolved

monaka pushed a commit to PizzaFactory/che-theia that referenced this pull request Mar 6, 2021

Clone Git projects with SSH URI (eclipse-che#995)

6f6bf30

* Improve the UX when cloning Git projects with SSH uri Signed-off-by: Vitaliy Gulyy <[email protected]>

l0rd changed the title ~~Clone Git projects with SSH URI~~ Better support when git cloning using SSH URI Apr 19, 2021

l0rd changed the title ~~Better support when git cloning using SSH URI~~ Better support when git cloning using SSH UR Apr 19, 2021

l0rd changed the title ~~Better support when git cloning using SSH UR~~ Prompt users when cloning Git repositories using an invalid SSH key Apr 19, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prompt users when cloning Git repositories using an invalid SSH key #995

Prompt users when cloning Git repositories using an invalid SSH key #995

vitaliy-guliy commented Feb 16, 2021 •

edited

Loading

che-bot commented Feb 16, 2021

che-bot commented Feb 16, 2021

che-bot commented Feb 16, 2021

che-bot commented Feb 17, 2021

sunix commented Feb 17, 2021 •

edited

Loading

vitaliy-guliy commented Feb 17, 2021

che-bot commented Feb 17, 2021

sunix commented Feb 17, 2021 •

edited

Loading

sunix commented Feb 17, 2021

vitaliy-guliy commented Feb 17, 2021

vinokurig commented Feb 18, 2021 •

edited

Loading

vitaliy-guliy commented Feb 19, 2021

vitaliy-guliy commented Feb 19, 2021

vitaliy-guliy commented Feb 19, 2021

l0rd commented Feb 19, 2021

sunix commented Feb 19, 2021 •

edited

Loading

sunix commented Feb 19, 2021 •

edited

Loading

che-bot commented Feb 19, 2021

che-bot commented Feb 19, 2021

vitaliy-guliy commented Feb 22, 2021

vitaliy-guliy commented Feb 22, 2021

che-bot commented Feb 22, 2021

codecov bot commented Feb 23, 2021 •

edited

Loading

che-bot commented Feb 23, 2021

vinokurig commented Feb 23, 2021

che-bot commented Apr 19, 2021

Prompt users when cloning Git repositories using an invalid SSH key #995

Prompt users when cloning Git repositories using an invalid SSH key #995

Conversation

vitaliy-guliy commented Feb 16, 2021 • edited Loading

What does this PR do?

Screenshot/screencast of this PR

What issues does this PR fix or reference?

HappyPath tests related on SSH

How to test this PR?

PR Checklist

Reviewers

Happy Path Channel

che-bot commented Feb 16, 2021

che-bot commented Feb 16, 2021

che-bot commented Feb 16, 2021

che-bot commented Feb 17, 2021

sunix commented Feb 17, 2021 • edited Loading

vitaliy-guliy commented Feb 17, 2021

che-bot commented Feb 17, 2021

sunix commented Feb 17, 2021 • edited Loading

sunix commented Feb 17, 2021

vitaliy-guliy commented Feb 17, 2021

vinokurig commented Feb 18, 2021 • edited Loading

vitaliy-guliy commented Feb 19, 2021

vitaliy-guliy commented Feb 19, 2021

vitaliy-guliy commented Feb 19, 2021

l0rd commented Feb 19, 2021

sunix commented Feb 19, 2021 • edited Loading

sunix commented Feb 19, 2021 • edited Loading

che-bot commented Feb 19, 2021

che-bot commented Feb 19, 2021

vitaliy-guliy commented Feb 22, 2021

vitaliy-guliy commented Feb 22, 2021

che-bot commented Feb 22, 2021

codecov bot commented Feb 23, 2021 • edited Loading

Codecov Report

che-bot commented Feb 23, 2021

vinokurig commented Feb 23, 2021

che-bot commented Apr 19, 2021

vitaliy-guliy commented Feb 16, 2021 •

edited

Loading

sunix commented Feb 17, 2021 •

edited

Loading

sunix commented Feb 17, 2021 •

edited

Loading

vinokurig commented Feb 18, 2021 •

edited

Loading

sunix commented Feb 19, 2021 •

edited

Loading

sunix commented Feb 19, 2021 •

edited

Loading

codecov bot commented Feb 23, 2021 •

edited

Loading