-
Notifications
You must be signed in to change notification settings - Fork 91
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fetch JupyterHub roles from Keycloak
- Loading branch information
1 parent
3ab3cf9
commit 62e527d
Showing
5 changed files
with
198 additions
and
21 deletions.
There are no files selected for viewing
128 changes: 128 additions & 0 deletions
128
...etes_services/template/modules/kubernetes/services/jupyterhub/files/jupyterhub/04-auth.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| import json | ||
| import os | ||
| import urllib | ||
| from functools import reduce | ||
|
|
||
| from jupyterhub.traitlets import Callable | ||
| from oauthenticator.generic import GenericOAuthenticator | ||
| from traitlets import Unicode, Union | ||
|
|
||
|
|
||
| class KeyCloakOAuthenticator(GenericOAuthenticator): | ||
| """ | ||
| Since `oauthenticator` 16.3 `GenericOAuthenticator` supports group management. | ||
| This subclass adds role management on top of it, building on the new `manage_roles` | ||
| feature added in JupyterHub 5.0 (https://github.com/jupyterhub/jupyterhub/pull/4748). | ||
| """ | ||
|
|
||
| claim_roles_key = Union( | ||
| [Unicode(os.environ.get("OAUTH2_ROLES_KEY", "groups")), Callable()], | ||
| config=True, | ||
| help="""As `claim_groups_key` but for roles.""", | ||
| ) | ||
|
|
||
| realm_api_url = Unicode( | ||
| config=True, help="""The keycloak REST API URL for the realm.""" | ||
| ) | ||
|
|
||
| service_account_user_id = Unicode(config=True, help="""service_account_user_id.""") | ||
|
|
||
| async def update_auth_model(self, auth_model): | ||
| auth_model = await super().update_auth_model(auth_model) | ||
| user_info = auth_model["auth_state"][self.user_auth_state_key] | ||
| user_roles = self._get_user_roles(user_info) | ||
| auth_model["roles"] = user_roles | ||
| return auth_model | ||
|
|
||
| async def load_managed_roles(self): | ||
| if not self.manage_roles: | ||
| raise ValueError( | ||
| "Managed roles can only be loaded when `manage_roles` is True" | ||
| ) | ||
| token = await self._get_token() | ||
|
|
||
| # Get the clients list to find the "id" of "jupyterhub" client. | ||
| clients_data = await self._fetch_api(endpoint="clients/", token=token) | ||
| jupyterhub_clients = [ | ||
| client for client in clients_data if client["clientId"] == "jupyterhub" | ||
| ] | ||
| assert len(jupyterhub_clients) == 1 | ||
| jupyterhub_client_id = jupyterhub_clients[0]["id"] | ||
|
|
||
| # Includes roles like "jupyterhub_admin", "jupyterhub_developer", "dask_gateway_developer" | ||
| client_roles = await self._fetch_api( | ||
| endpoint=f"clients/{jupyterhub_client_id}/roles", token=token | ||
| ) | ||
| # Includes roles like "default-roles-nebari", "offline_access", "uma_authorization" | ||
| realm_roles = await self._fetch_api(endpoint="roles", token=token) | ||
| roles = { | ||
| role["name"]: {"name": role["name"], "description": role["description"]} | ||
| for role in [*realm_roles, *client_roles] | ||
| } | ||
| # we could use either `name` (e.g. "developer") or `path` ("/developer"); | ||
| # since the default claim key returns `path`, it seems preferable. | ||
| group_name_key = "path" | ||
| for realm_role in realm_roles: | ||
| role_name = realm_role["name"] | ||
| role = roles[role_name] | ||
| # fetch role assignments to groups | ||
| groups = await self._fetch_api(f"roles/{role_name}/groups", token=token) | ||
| role["groups"] = [group[group_name_key] for group in groups] | ||
| # fetch role assignments to users | ||
| users = await self._fetch_api(f"roles/{role_name}/users", token=token) | ||
| role["users"] = [user["username"] for user in users] | ||
| for client_role in client_roles: | ||
| role_name = client_role["name"] | ||
| role = roles[role_name] | ||
| # fetch role assignments to groups | ||
| groups = await self._fetch_api( | ||
| f"clients/{jupyterhub_client_id}/roles/{role_name}/groups", token=token | ||
| ) | ||
| role["groups"] = [group[group_name_key] for group in groups] | ||
| # fetch role assignments to users | ||
| users = await self._fetch_api( | ||
| f"clients/{jupyterhub_client_id}/roles/{role_name}/users", token=token | ||
| ) | ||
| role["users"] = [user["username"] for user in users] | ||
|
|
||
| return list(roles.values()) | ||
|
|
||
| def _get_user_roles(self, user_info): | ||
| if callable(self.claim_roles_key): | ||
| return set(self.claim_roles_key(user_info)) | ||
| try: | ||
| return set(reduce(dict.get, self.claim_roles_key.split("."), user_info)) | ||
| except TypeError: | ||
| self.log.error( | ||
| f"The claim_roles_key {self.claim_roles_key} does not exist in the user token" | ||
| ) | ||
| return set() | ||
|
|
||
| async def _get_token(self) -> str: | ||
| http = self.http_client | ||
|
|
||
| body = urllib.parse.urlencode( | ||
| { | ||
| "client_id": self.client_id, | ||
| "client_secret": self.client_secret, | ||
| "grant_type": "client_credentials", | ||
| } | ||
| ) | ||
| response = await http.fetch( | ||
| self.token_url, | ||
| method="POST", | ||
| body=body, | ||
| ) | ||
| data = json.loads(response.body) | ||
| return data["access_token"] # type: ignore[no-any-return] | ||
|
|
||
| async def _fetch_api(self, endpoint: str, token: str): | ||
| response = await self.http_client.fetch( | ||
| f"{self.realm_api_url}/{endpoint}", | ||
| method="GET", | ||
| headers={"Authorization": f"Bearer {token}"}, | ||
| ) | ||
| return json.loads(response.body) | ||
|
|
||
|
|
||
| c.JupyterHub.authenticator_class = KeyCloakOAuthenticator |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 4 additions & 2 deletions
6
...tages/kubernetes_services/template/modules/kubernetes/services/keycloak-client/outputs.tf
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,14 @@ | ||
| output "config" { | ||
| description = "configuration credentials for connecting to openid client" | ||
| value = { | ||
| client_id = keycloak_openid_client.main.client_id | ||
| client_secret = keycloak_openid_client.main.client_secret | ||
| client_id = keycloak_openid_client.main.client_id | ||
| client_secret = keycloak_openid_client.main.client_secret | ||
| service_account_user_id = keycloak_openid_client.main.service_account_user_id | ||
|
|
||
| authentication_url = "https://${var.external-url}/auth/realms/${var.realm_id}/protocol/openid-connect/auth" | ||
| token_url = "https://${var.external-url}/auth/realms/${var.realm_id}/protocol/openid-connect/token" | ||
| userinfo_url = "https://${var.external-url}/auth/realms/${var.realm_id}/protocol/openid-connect/userinfo" | ||
| realm_api_url = "https://${var.external-url}/auth/admin/realms/${var.realm_id}" | ||
| callback_urls = var.callback-url-paths | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters