JupyterHub for 11.0 by connersaeli · Pull Request #2046 · ubccr/xdmod

connersaeli · 2025-05-28T17:03:13Z

This PR adds authentication to and from XDMoD via JSON Web Tokens (JWTs). This is necessary for an instance of XDMoD to communicate with an instance of JupyterHub. This PR also contains UI elements to redirect to an instance of JupyterHub.

Description

These changes include the following additions:

A JsonWebToken class with encode() and decode() static functions to encode and decode JWTs
A new dependency for handling JWTs in PHP
A new method authenticateJSONWebToken() for the Tokens class that accepts a JWT and returns an XDMoD user if it is a valid JWT
A new endpoint for the AuthenticationControllerProvider class called jwt-redirect that sets a cookie named xdmod_jwt with a valid JWT and redirects to a URL specified in the endpoint's parameter
A new button to redirect to an instance of JupyterHub that only appears if XDMoD is configured with JupyterHub

The authenticateToken method in the Tokens class is also updated to handle both API tokens and JSON Web Tokens.

Motivation and Context

The changes in this PR are necessary to allow communication between instances of XDMoD and JupyterHub.

Tests performed

Checklist:

The pull request description is suitable for a Changelog entry
The milestone is set correctly on the pull request
The appropriate labels have been added to the pull request

classes/Models/Services/Tokens.php

classes/Models/Services/JsonWebToken.php

html/gui/images/icon_jupyter.png

classes/Models/Services/JsonWebToken.php

html/index.php

libraries/utilities.php

classes/Models/Services/Tokens.php

html/index.php

tests/integration/lib/TokenAuthTest.php

classes/Models/Services/Tokens.php

classes/Rest/Controllers/AuthenticationControllerProvider.php

html/gui/js/CCR.js

* Removing window.focus() * Wrapping decode() in proper html error status exception

ryanrath · 2025-06-30T21:06:59Z

Just a heads up, when I check out the repo and attempt to composer install I get an error:

$ composer install
Installing dependencies from lock file (including require-dev)
Verifying lock file contents can be installed on current platform.
- Required package "firebase/php-jwt" is not present in the lock file.
This usually happens when composer files are incorrectly merged or the composer.json file is manually edited.
Read more about correctly resolving merge conflicts https://getcomposer.org/doc/articles/resolving-merge-conflicts.md
and prefer using the "require" command over editing the composer.json file directly https://getcomposer.org/doc/03-cli.md#require-r

just a quick composer require firebase/php-jwt I think should fix it.

ryanrath

~~After fixing the missing private static property in JsonWebToken I've run into the following:~~

2025-06-30 21:14:31 [error] Exception Code: 0
2025-06-30 21:14:31 [error] Message: OpenSSL unable to sign data
2025-06-30 21:14:31 [error] Origin: /usr/share/xdmod/vendor/firebase/php-jwt/src/JWT.php (line 256)
2025-06-30 21:14:31 [error] Trace:
#0 /usr/share/xdmod/vendor/firebase/php-jwt/src/JWT.php(219): Firebase\JWT\JWT::sign()
#1 /usr/share/xdmod/classes/Models/Services/JsonWebToken.php(34): Firebase\JWT\JWT::encode()
#2 /usr/share/xdmod/classes/Rest/Controllers/AuthenticationControllerProvider.php(139): Models\Services\JsonWebToken::encode()
#3 /usr/share/xdmod/vendor/symfony/http-kernel/HttpKernel.php(169): Rest\Controllers\AuthenticationControllerProvider->redirectWithJwt()
#4 /usr/share/xdmod/vendor/symfony/http-kernel/HttpKernel.php(81): Symfony\Component\HttpKernel\HttpKernel->handleRaw()
#5 /usr/share/xdmod/vendor/silex/silex/src/Silex/Application.php(496): Symfony\Component\HttpKernel\HttpKernel->handle()
#6 /usr/share/xdmod/vendor/silex/silex/src/Silex/Application.php(477): Silex\Application->handle()
#7 /usr/share/xdmod/html/rest/index.php(25): Silex\Application->run()
#8 {main}

~~I'm guessing there's some setup steps that need to be done maybe?~~

Edit: I just needed to run the following:

ssh-keygen -t rsa -b 4096 -m PEM -f /etc/xdmod/keys/xdmod-private.pem

maybe it could be added to bootstrap.sh?

classes/Models/Services/JsonWebToken.php

classes/Rest/Controllers/AuthenticationControllerProvider.php

classes/Models/Services/Tokens.php

classes/Rest/Controllers/AuthenticationControllerProvider.php

html/gui/js/Viewer.js

classes/Rest/Controllers/AuthenticationControllerProvider.php

html/gui/js/Viewer.js

classes/Rest/Controllers/AuthenticationControllerProvider.php

Review comments addressed

JupyterHub for 11.0

1d95773

connersaeli added this to the 11.0.2 milestone Jun 24, 2025

connersaeli added 10 commits June 26, 2025 12:07

Merge branch 'xdmod11.0' into jupyterhub-11.0

2d91709

Removing unused import.

bd4a91c

Changing function to private.

ed7a460

Removing unused file.

28ba73b

Linting

8699e30

More linting.

e2b710e

More linting.

55180c4

Linting

491fca1

Linting

8a0b5e9

Updating lock file.

eb6a79c

connersaeli force-pushed the jupyterhub-11.0 branch from 8739438 to eb6a79c Compare June 27, 2025 18:04

connersaeli marked this pull request as ready for review June 27, 2025 18:54

connersaeli self-assigned this Jun 27, 2025

connersaeli added new feature New functionality dependencies Pull requests that update a dependency file Category: Data Analytics Framework labels Jun 27, 2025

connersaeli requested a review from aaronweeden June 27, 2025 19:04

Simplifying button code.

529dca3

connersaeli force-pushed the jupyterhub-11.0 branch from bb33622 to 529dca3 Compare June 27, 2025 19:27

aaronweeden requested changes Jun 30, 2025

View reviewed changes

connersaeli added 3 commits June 30, 2025 12:10

Updating for review comments.

97827f2

Updating for review comments.

426c9c6

Removing unused variable.

9c02bef

aaronweeden requested changes Jun 30, 2025

View reviewed changes

jpwhite4 reviewed Jun 30, 2025

View reviewed changes

classes/Models/Services/Tokens.php Outdated Show resolved Hide resolved

Updating for Aaron's review comments.

76b0fa6

jpwhite4 reviewed Jun 30, 2025

View reviewed changes

classes/Rest/Controllers/AuthenticationControllerProvider.php Outdated Show resolved Hide resolved

jpwhite4 reviewed Jun 30, 2025

View reviewed changes

html/gui/js/CCR.js Outdated Show resolved Hide resolved

connersaeli added 3 commits June 30, 2025 16:24

Addressing review comments.

21cb421

* Removing window.focus() * Wrapping decode() in proper html error status exception

Linting

e07aeca

Fixing syntax error.

21fbd06

ryanrath previously requested changes Jun 30, 2025

View reviewed changes

classes/Models/Services/JsonWebToken.php Outdated Show resolved Hide resolved

aaronweeden reviewed Jun 30, 2025

View reviewed changes

classes/Models/Services/JsonWebToken.php Outdated Show resolved Hide resolved

jpwhite4 previously requested changes Jul 1, 2025

View reviewed changes

classes/Rest/Controllers/AuthenticationControllerProvider.php Outdated Show resolved Hide resolved

aaronweeden reviewed Jul 1, 2025

View reviewed changes

classes/Models/Services/Tokens.php Outdated Show resolved Hide resolved

Adding JWT library.

1081b8d

aaronweeden requested changes Jul 7, 2025

View reviewed changes

connersaeli and others added 3 commits July 7, 2025 11:20

Merge branch 'xdmod11.0' into jupyterhub-11.0

551bbf3

Addressing review comments.

f51000d

Adding line back in.

ed13a75

aaronweeden reviewed Jul 7, 2025

View reviewed changes

classes/Rest/Controllers/AuthenticationControllerProvider.php Outdated Show resolved Hide resolved

aaronweeden reviewed Jul 7, 2025

View reviewed changes

html/gui/js/Viewer.js Outdated Show resolved Hide resolved

Addressing review comments.

a8fdc0f

connersaeli mentioned this pull request Jul 7, 2025

Jupyterhub for main #2060

Merged

3 tasks

aaronweeden and others added 2 commits July 8, 2025 13:59

Add more error handling for encoding/decoding.

db8a3d8

Merge branch 'xdmod11.0' into jupyterhub-11.0

7ab5150

aaronweeden reviewed Jul 8, 2025

View reviewed changes

classes/Rest/Controllers/AuthenticationControllerProvider.php Outdated Show resolved Hide resolved

aaronweeden and others added 2 commits July 8, 2025 14:02

Add period to end of error message.

2402052

Adding self to properly references constants.

00c519d

aaronweeden approved these changes Jul 8, 2025

View reviewed changes

connersaeli merged commit 3a0070c into ubccr:xdmod11.0 Jul 8, 2025
4 checks passed

Conversation

connersaeli commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

Tests performed

Checklist:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ryanrath commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ryanrath left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

connersaeli commented May 28, 2025 •

edited

Loading

ryanrath commented Jun 30, 2025 •

edited

Loading

ryanrath left a comment •

edited

Loading