feat: Add Device Authentication flow support #260

RomanNikitenko · 2023-07-24T10:16:16Z

What does this PR do?

Adds Github: Device Authentication command
Adds Github: Remove Device Authentication Token command
Stores Device Authentication token to a separate secret
Resolves a problem when there are few tokens in the .git-credential/credentials file, see Error: Invalid character in header content ["Authorization"] when sign in using GitHub eclipse-che/che#22433.

device.auth.mp4

Adds a logger to the Eclipse Che API and Che Github Authentication extensions, so logs are available in the corresponding channels of the Output view

What issues does this PR fix?

eclipse-che/che#22139

How to test this PR?

Use case 1 - an extension authorization

Start a workspace
Install an extension for testing that requires Device Authentication flow for authorization
F1 => Device Authentication => follow the flow
Reload the window to clean up cached sessions
Sign In
Try to use the extension

Use case 2 - Git related operations should work correctly when a Device Authentication token is used

Steps from the use case 1
F1 => Git Clone => follow the flow
check that a project is cloned successfully

Use case 3 - Git related operations should work correctly after removing a Device Authentication token

Steps from the use case 1
F1 => Github: Remove Device Authentication Token
Click the button Accounts on the left panel => Github Sign Out
Try to test use case 2 - the Git Clone command should work correctly, using a token from the .git-credential/credentials file (if it's present)

Use case 4 - the changes should fix `Error: Invalid character in header content` problem when there are few tokens

Create a workspace from the gitlab repo - the gitlab token should be added to the .git-credential/credentials file
Stop the workspace ^.
Create a workspace from the github repo - the github token should be added to the .git-credential/credentials file
Check that .git-credential/credentials file contains both tokens
F1 => Git Clone => follow the flow
check that a project is cloned successfully
so, the following issue should be fixed Error: Invalid character in header content ["Authorization"] when sign in using GitHub eclipse-che/che#22433

Use case 5 - Device Authentication flow can be used for authentication when there is no git-credential secrets/tokens

Delete all git-credential secrets
Start a workspace without authentication on the Github at the starting workspace step
Check that the .git-credential/credentials file is empty
F1 => Git Clone => follow the flow => you should get an error - there is no token
F1 => Device Authentication => follow the flow
Try to use F1 => Git Clone again - now the Github Service should use Device Authentication token and the operation should be completed successfully

github-actions · 2023-07-24T10:16:27Z

Click here to review and test in web IDE:

github-actions · 2023-08-11T12:13:04Z

Pull Request images published ✨
image: quay.io/che-incubator-pull-requests/che-code:pr-260-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-260-dev-amd64

github-actions · 2023-08-14T17:53:05Z

Pull Request images published ✨
image: quay.io/che-incubator-pull-requests/che-code:pr-260-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-260-dev-amd64

github-actions · 2023-08-14T22:00:40Z

Pull Request images published ✨
image: quay.io/che-incubator-pull-requests/che-code:pr-260-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-260-dev-amd64

github-actions · 2023-08-15T07:51:20Z

Pull Request images published ✨
image: quay.io/che-incubator-pull-requests/che-code:pr-260-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-260-dev-amd64

github-actions · 2023-08-15T10:56:19Z

Pull Request images published ✨
image: quay.io/che-incubator-pull-requests/che-code:pr-260-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-260-dev-amd64

github-actions · 2023-08-15T12:24:23Z

Pull Request images published ✨
image: quay.io/che-incubator-pull-requests/che-code:pr-260-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-260-dev-amd64

github-actions · 2023-09-12T14:55:57Z

Pull Request images published ✨
image: quay.io/che-incubator-pull-requests/che-code:pr-260-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-260-dev-amd64

github-actions · 2023-09-19T08:45:53Z

Pull Request images published ✨
image: quay.io/che-incubator-pull-requests/che-code:pr-260-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-260-dev-amd64

github-actions · 2023-10-13T11:38:54Z

Pull Request images published ✨
image: quay.io/che-incubator-pull-requests/che-code:pr-260-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-260-dev-amd64

github-actions · 2023-10-13T12:28:07Z

Pull Request images published ✨
image: quay.io/che-incubator-pull-requests/che-code:pr-260-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-260-dev-amd64

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

github-actions · 2023-10-21T07:08:41Z

Pull Request images published ✨
image: quay.io/che-incubator-pull-requests/che-code:pr-260-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-260-dev-amd64

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

github-actions · 2023-10-25T15:12:18Z

Pull Request images published ✨
image: quay.io/che-incubator-pull-requests/che-code:pr-260-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-260-dev-amd64

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

github-actions · 2023-10-25T16:06:58Z

Pull Request images published ✨
image: quay.io/che-incubator-pull-requests/che-code:pr-260-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-260-dev-amd64

github-actions · 2023-10-25T16:10:02Z

Pull Request images published ✨
image: quay.io/che-incubator-pull-requests/che-code:pr-260-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-260-dev-amd64

github-actions · 2023-10-25T19:48:06Z

Pull Request images published ✨
image: quay.io/che-incubator-pull-requests/che-code:pr-260-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-260-dev-amd64

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

github-actions · 2023-10-26T06:11:12Z

Pull Request images published ✨
image: quay.io/che-incubator-pull-requests/che-code:pr-260-amd64
Dev image: quay.io/che-incubator-pull-requests/che-code-dev:pr-260-dev-amd64

devstudio-release · 2023-10-27T23:04:18Z

Build 3.11 :: get-sources-rhpkg-container-build_3.x/4958: Console, Changes, Git Data

devstudio-release · 2023-10-27T23:14:09Z

Build 3.11 :: push-latest-container-to-quay_3.x/3535: Console, Changes, Git Data

devstudio-release · 2023-10-27T23:21:42Z

Build 3.11 :: get-sources-rhpkg-container-build_3.x/4958:

devspaces-operator-bundle : 3.x :: Build 56580126 : quay.io/devspaces/devspaces-operator-bundle:3.11-3
SUCCESS; copied to quay; /DS_CI/push-latest-container-to-quay_3.x/3535 triggered;
Bundle CSV related images:
- quay.io/devspaces/code-rhel8:3.11-2
- quay.io/devspaces/configbump-rhel8:3.11-1
- quay.io/devspaces/dashboard-rhel8:3.11-5
- quay.io/devspaces/devfileregistry-rhel8:3.11-6
- quay.io/devspaces/devspaces-rhel8-operator:3.11-1
- quay.io/devspaces/idea-rhel8:3.11-1
- quay.io/devspaces/pluginregistry-rhel8:3.11-1
- quay.io/devspaces/server-rhel8:3.11-1
- quay.io/devspaces/traefik-rhel8:3.11-1
- quay.io/devspaces/udi-rhel8:3.11-1
= registry.redhat.io/openshift4/ose-kube-rbac-proxy:v4.12.0-202310170157.p0.g94f3fde.assembly.stream
= registry.redhat.io/openshift4/ose-oauth-proxy:v4.12.0-202310170157.p0.g03e5b13.assembly.stream
= registry.redhat.io/rhscl/mongodb-36-rhel7:1-50
= registry.redhat.io/ubi8/ubi-minimal:8.8-1072.1697626218

devstudio-release · 2023-10-27T23:21:46Z

Build 3.11 :: sync-to-downstream_3.x/5110:

Build container: devspaces-operator-bundle synced; /DS_CI/get-sources-rhpkg-container-build_3.x/4958 triggered; /job/DS_CI/job/dsc_3.x triggered;

devstudio-release · 2023-10-27T23:21:47Z

Build 3.11 :: operator-bundle_3.x/2228:

Upstream sync done; /DS_CI/sync-to-downstream_3.x/5110 triggered

devstudio-release · 2023-10-27T23:21:48Z

Build 3.11 :: copyIIBsToQuay/2021: Console, Changes, Git Data

devstudio-release · 2023-10-27T23:24:08Z

Build 3.11 :: update-digests_3.x/4716:

Detected new images: rebuild operator-bundle
* devfileregistry; /DS_CI/operator-bundle_3.x/2228 triggered

devstudio-release · 2023-10-27T23:25:52Z

Build 3.11 :: dsc_3.x/1494: Console, Changes, Git Data

RomanNikitenko · 2023-10-28T07:16:39Z

Did you forget to regen yarn.lock? Or do we need to use a newer version of node than v18.15.0 ?

I see such error from time to time and usually restarting of build helps.

devstudio-release · 2023-10-29T12:00:45Z

Build 3.11 :: code_3.x/965: Console, Changes, Git Data

devstudio-release · 2023-10-29T12:05:57Z

Build 3.11 :: sync-to-downstream_3.x/5124: Console, Changes, Git Data

devstudio-release · 2023-10-29T13:46:59Z

Build 3.11 :: get-sources-rhpkg-container-build_3.x/4976: Console, Changes, Git Data

devstudio-release · 2023-10-29T13:55:09Z

Build 3.11 :: push-latest-container-to-quay_3.x/3553: Console, Changes, Git Data

devstudio-release · 2023-10-29T13:55:52Z

Build 3.11 :: get-sources-rhpkg-container-build_3.x/4976:

code : 3.x :: Build 56596831 : quay.io/devspaces/code-rhel8:3.11-3
SUCCESS; copied to quay; /DS_CI/push-latest-container-to-quay_3.x/3553 triggered

devstudio-release · 2023-10-29T13:55:53Z

Build 3.11 :: update-digests_3.x/4738: Console, Changes, Git Data

devstudio-release · 2023-10-29T13:55:58Z

Build 3.11 :: code_3.x/965:

Upstream sync done; /DS_CI/sync-to-downstream_3.x/5124 triggered

devstudio-release · 2023-10-29T13:56:36Z

Build 3.11 :: operator-bundle_3.x/2233: Console, Changes, Git Data

devstudio-release · 2023-10-29T14:08:26Z

Build 3.11 :: sync-to-downstream_3.x/5128: Console, Changes, Git Data

devstudio-release · 2023-10-29T14:13:48Z

Build 3.11 :: get-sources-rhpkg-container-build_3.x/4978: Console, Changes, Git Data

devstudio-release · 2023-10-29T14:21:57Z

Build 3.11 :: push-latest-container-to-quay_3.x/3555: Console, Changes, Git Data

devstudio-release · 2023-10-29T14:25:06Z

Build 3.11 :: copyIIBsToQuay/2029: Console, Changes, Git Data

devstudio-release · 2023-10-29T14:26:14Z

Build 3.11 :: get-sources-rhpkg-container-build_3.x/4978:

devspaces-operator-bundle : 3.x :: Build 56596909 : quay.io/devspaces/devspaces-operator-bundle:3.11-8
SUCCESS; copied to quay; /DS_CI/push-latest-container-to-quay_3.x/3555 triggered;
Bundle CSV related images:
- quay.io/devspaces/code-rhel8:3.11-3
- quay.io/devspaces/configbump-rhel8:3.11-2
- quay.io/devspaces/dashboard-rhel8:3.11-6
- quay.io/devspaces/devfileregistry-rhel8:3.11-8
- quay.io/devspaces/devspaces-rhel8-operator:3.11-2
- quay.io/devspaces/idea-rhel8:3.11-2
- quay.io/devspaces/pluginregistry-rhel8:3.11-2
- quay.io/devspaces/server-rhel8:3.11-2
- quay.io/devspaces/traefik-rhel8:3.11-2
- quay.io/devspaces/udi-rhel8:3.11-3
= registry.redhat.io/openshift4/ose-kube-rbac-proxy:v4.12.0-202310170157.p0.g94f3fde.assembly.stream
= registry.redhat.io/openshift4/ose-oauth-proxy:v4.12.0-202310170157.p0.g03e5b13.assembly.stream
= registry.redhat.io/rhscl/mongodb-36-rhel7:1-50
= registry.redhat.io/ubi8/ubi-minimal:8.8-1072.1697626218

devstudio-release · 2023-10-29T14:26:18Z

Build 3.11 :: sync-to-downstream_3.x/5128:

Build container: devspaces-operator-bundle synced; /DS_CI/get-sources-rhpkg-container-build_3.x/4978 triggered; /job/DS_CI/job/dsc_3.x triggered;

devstudio-release · 2023-10-29T14:26:20Z

Build 3.11 :: operator-bundle_3.x/2233:

Upstream sync done; /DS_CI/sync-to-downstream_3.x/5128 triggered

devstudio-release · 2023-10-29T14:26:24Z

Build 3.11 :: dsc_3.x/1499: Console, Changes, Git Data

devstudio-release · 2023-10-29T14:28:29Z

Build 3.11 :: update-digests_3.x/4738:

Detected new images: rebuild operator-bundle
* code; /DS_CI/operator-bundle_3.x/2233 triggered

devstudio-release · 2023-10-29T15:16:22Z

Build 3.11 :: copyIIBsToQuay/2029:

3.11
arches = x86_64, s390x, ppc64le;
  * LATEST DS OPERATOR BUNDLE = <a href=https://quay.io/repository/devspaces/devspaces-operator-bundle?tab=tags>registry-proxy.engineering.redhat.com/rh-osbs/devspaces-operator-bundle:3.11-8
  * LATEST DWO OPERATOR BUNDLE = <a href=https://quay.io/repository/devworkspace/devworkspace-operator-bundle?tab=tags>registry-proxy.engineering.redhat.com/rh-osbs/devworkspace-operator-bundle:0.21-7
+ s390x-rhel8 IIB(s) copied:
  + quay.io/devspaces/iib:3.11-v4.14-610912-533291-s390x
  + quay.io/devspaces/iib:3.11-v4.14-s390x
  + quay.io/devspaces/iib:latest-v4.14-s390x
  + quay.io/devspaces/iib:3.11-v4.13-610911-533286-s390x
  + quay.io/devspaces/iib:3.11-v4.12-610910-533281-s390x
  + quay.io/devspaces/iib:3.11-v4.11-610908-533277-s390x
+ ppc64le-rhel8 IIB(s) copied:
  + quay.io/devspaces/iib:3.11-v4.14-610912-533291-ppc64le
  + quay.io/devspaces/iib:3.11-v4.14-ppc64le
  + quay.io/devspaces/iib:latest-v4.14-ppc64le
  + quay.io/devspaces/iib:3.11-v4.13-610911-533286-ppc64le
  + quay.io/devspaces/iib:3.11-v4.12-610910-533281-ppc64le
  + quay.io/devspaces/iib:3.11-v4.11-610908-533277-ppc64le
+ x86_64-rhel8 IIB(s) copied:
  + quay.io/devspaces/iib:3.11-v4.14-610912-533291-x86_64
  + quay.io/devspaces/iib:3.11-v4.13-610911-533286-x86_64
  + quay.io/devspaces/iib:3.11-v4.12-610910-533281-x86_64
  + quay.io/devspaces/iib:3.11-v4.11-610908-533277-x86_64

RomanNikitenko force-pushed the device-code-flow branch from 1aa2f55 to 60a47be Compare August 11, 2023 10:25

RomanNikitenko changed the title ~~Add Device Activation flow support~~ Add Device Authentication flow support Aug 12, 2023

RomanNikitenko force-pushed the device-code-flow branch from 60a47be to 04b37d4 Compare August 14, 2023 16:11

RomanNikitenko force-pushed the device-code-flow branch from 0a3d1d4 to 52c26a7 Compare September 12, 2023 12:42

RomanNikitenko force-pushed the device-code-flow branch from 52c26a7 to 6e44b26 Compare September 19, 2023 06:30

RomanNikitenko force-pushed the device-code-flow branch from 6e44b26 to af6b2c8 Compare October 13, 2023 10:29

feat: Add Device Authentication flow support

ae3bdab

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

RomanNikitenko force-pushed the device-code-flow branch from af6b2c8 to ae3bdab Compare October 20, 2023 16:12

RomanNikitenko added 2 commits October 25, 2023 16:54

Change approach for storing Device Authentication token

6e2d799

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

Handle error at removing Device Auth token

e74d10e

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

Handle errors at the Device Authentication flow

dd0bd2d

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

Add logs

c2ec159

Signed-off-by: Roman Nikitenko <rnikiten@redhat.com>

RomanNikitenko marked this pull request as ready for review October 26, 2023 08:00

l0rd linked an issue Oct 31, 2023 that may be closed by this pull request

Support Device Authentication flow for VS Code editor eclipse-che/che#22139

Closed

This was referenced Oct 31, 2023

Error: Invalid character in header content ["Authorization"] when sign in using GitHub eclipse-che/che#22433

Closed

fix: Allow GitHub clone when credentials file contains several tokens #277

Closed

feat: Add Device Authentication flow support #260

feat: Add Device Authentication flow support #260

Conversation

RomanNikitenko commented Jul 24, 2023 • edited Loading

What does this PR do?

What issues does this PR fix?

How to test this PR?

Use case 1 - an extension authorization

Use case 2 - Git related operations should work correctly when a Device Authentication token is used

Use case 3 - Git related operations should work correctly after removing a Device Authentication token

Use case 4 - the changes should fix Error: Invalid character in header content problem when there are few tokens

Use case 5 - Device Authentication flow can be used for authentication when there is no git-credential secrets/tokens

github-actions bot commented Jul 24, 2023 • edited Loading

github-actions bot commented Aug 11, 2023

github-actions bot commented Aug 14, 2023

github-actions bot commented Aug 14, 2023

github-actions bot commented Aug 15, 2023

github-actions bot commented Aug 15, 2023

github-actions bot commented Aug 15, 2023

github-actions bot commented Sep 12, 2023

github-actions bot commented Sep 19, 2023

github-actions bot commented Oct 13, 2023

github-actions bot commented Oct 13, 2023

github-actions bot commented Oct 21, 2023

github-actions bot commented Oct 25, 2023

github-actions bot commented Oct 25, 2023

github-actions bot commented Oct 25, 2023

github-actions bot commented Oct 25, 2023

github-actions bot commented Oct 26, 2023

devstudio-release commented Oct 27, 2023

devstudio-release commented Oct 27, 2023

devstudio-release commented Oct 27, 2023

devstudio-release commented Oct 27, 2023

devstudio-release commented Oct 27, 2023

devstudio-release commented Oct 27, 2023

devstudio-release commented Oct 27, 2023

devstudio-release commented Oct 27, 2023

RomanNikitenko commented Oct 28, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

devstudio-release commented Oct 29, 2023

RomanNikitenko commented Jul 24, 2023 •

edited

Loading

Use case 4 - the changes should fix `Error: Invalid character in header content` problem when there are few tokens

github-actions bot commented Jul 24, 2023 •

edited

Loading