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
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions components/server/src/oauth-server/oauth-controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import { inject, injectable } from "inversify";
import { URL } from "url";
import { Config } from "../config";
import { clientRepository, createAuthorizationServer } from "./oauth-authorization-server";
import { inMemoryDatabase } from "./db";

@injectable()
export class OAuthController {
Expand Down Expand Up @@ -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. 🙂

return res.sendStatus(400);
}

const client = inMemoryDatabase.clients[clientId];
const scopes = client.scopes.map((s) => s.name);
return res.send(scopes);
});

return router;
}
}