Skip to content

Add /oauth/inspect endpoint #12446

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 5, 2022
Merged

Add /oauth/inspect endpoint #12446

merged 1 commit into from
Sep 5, 2022

Conversation

jeanp413
Copy link
Member

@jeanp413 jeanp413 commented Aug 26, 2022

Description

Add /oauth/inspect endpoint

Related Issue(s)

Related #12254

How to test

Release Notes

NONE

Werft options:

  • /werft with-preview

@akosyakov akosyakov requested review from geropl and mustard-mh August 29, 2022 08:24
@AlexTugarev AlexTugarev added aspect: security Anything related to preventing vulnerabilities aspect: authorization labels Aug 31, 2022
@@ -175,6 +176,17 @@ export class OAuthController {
}
});

router.get("/oauth/inspect", async (req: express.Request, res: express.Response) => {
const clientId = req.query.client as string;
if (typeof clientId !== "string" || !Object.keys(inMemoryDatabase.clients).includes(clientId)) {
Copy link
Member

Choose a reason for hiding this comment

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

this definitely has the potential to provide an unguarded endpoint to scan for random clientIds.

tagging as security relevant.

Copy link
Member

Choose a reason for hiding this comment

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

everything is already available in this repo? 🤔

Copy link
Member Author

Choose a reason for hiding this comment

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

yeah client ids are already public

Copy link
Member

Choose a reason for hiding this comment

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

I think the point Alex is making is that this allows you to enumerate all client IDs we may have. Therefore, you can estimate how big of an installation of gitpod this is, how many users it has and which exact IDs exist in the system.

There's a difference between the client ID being public and knowing exactly how many client IDs there are.

Copy link
Member

Choose a reason for hiding this comment

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

What would be an alternative? cc @geropl

Copy link
Member

@akosyakov akosyakov Sep 5, 2022

Choose a reason for hiding this comment

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

Therefore, you can estimate how big of an installation of gitpod this is, how many users it has and which exact IDs exist in the system.

I'm not sure how you can do it though. You can only ask whether Gitpod installation supports installing ssh keys or not. You cannot get any other information from this endpoint.

Copy link
Member

Choose a reason for hiding this comment

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

Would you be able to provide a use-case this is looking to solve? Is it to discover my own ClientID?

Copy link
Member

@akosyakov akosyakov Sep 5, 2022

Choose a reason for hiding this comment

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

Please have a look at this RFC It is a work around for how we do auth now. Also this internal Slack thread: https://gitpod.slack.com/archives/C01KGM9BH54/p1661371894310039

Copy link
Member

Choose a reason for hiding this comment

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

@mikenikles @AlexTugarev I think there is a misunderstanding here: Clients !== API clients.

Client is a possible kind of clients we support as defined here.

everything is already available in this repo?

☝️ Enumerating those is fine I think. 🙂

@akosyakov
Copy link
Member

@jeanp413 Let's open it for review?

Copy link
Contributor

@mustard-mh mustard-mh left a comment

Choose a reason for hiding this comment

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

/hold

hold to squash commits

Code LGTM, tested in browser

Copy link
Member

@geropl geropl left a comment

Choose a reason for hiding this comment

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

LGTM. Thx @jeanp413 ! 👍

@jeanp413
Copy link
Member Author

jeanp413 commented Sep 5, 2022

/unhold

@werft-gitpod-dev-com
Copy link

started the job as gitpod-build-jp-oauth-inspect.7 because the annotations in the pull request description changed
(with .werft/ from main)

@roboquat roboquat merged commit f693d41 into main Sep 5, 2022
@roboquat roboquat deleted the jp/oauth-inspect branch September 5, 2022 17:27
@roboquat roboquat added deployed: webapp Meta team change is running in production deployed Change is completely running in production labels Sep 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aspect: authorization aspect: security Anything related to preventing vulnerabilities deployed: webapp Meta team change is running in production deployed Change is completely running in production release-note-none size/S team: webapp Issue belongs to the WebApp team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants