Added AuthKey Authentication

Author: jwindgassen

jupyter_trame_proxy/__init__.py

@@ -1,37 +1,54 @@
 import os
+import secrets
+from tempfile import mkstemp
 import logging
 
+
 logger = logging.getLogger(__name__)
-logger.setLevel('INFO')
+logger.setLevel("INFO")
 
 HERE = os.path.dirname(os.path.abspath(__file__))
 
 
 def _trame_mappath(path):
+    # Append authKey to URL if we are at the base-url
+    if path in ("/", "/index.html"):
+        path += f"?secret={_auth_key}"
+
     return path
 
 
 def setup_trame():
-    """ Setup commands and and return a dictionary compatible
-        with jupyter-server-proxy.
-    """
+    # Generate authKey
+    global _auth_key
+    _auth_key = secrets.token_urlsafe(32)
+
+    # Write authKey to tempfile
+    tempfile, temppath = mkstemp()
+    logger.info(f"Created tempfile with secure password for trame at {temppath}")
 
-    # create command
+    with open(tempfile, "w") as file:
+        file.write(_auth_key)
+
+    # Create command
     cmd = [
-        os.path.join(HERE, 'share/launch_trame.sh'), "{port}"
+        os.path.join(HERE, "share/launch_trame.sh"),
+        "{port}",
+        "--authKeyFile",
+        temppath,
     ]
-    
-    logger.info('Command: ' + ' '.join(cmd))
+
+    logger.info(f"jupyter-trame-proxy command: {' '.join(cmd)}")
 
     return {
-        'command': cmd,
-        'mappath': _trame_mappath,
-        'absolute_url': False,
-        'timeout': 90,
-        'new_browser_tab': True,
-        'launcher_entry': {
-            'enabled': True,
-            'icon_path': os.path.join(HERE, 'icons/logo.svg'),
-            'title': 'ParaView trame',
+        "command": cmd,
+        "mappath": _trame_mappath,
+        "absolute_url": False,
+        "timeout": 90,
+        "new_browser_tab": True,
+        "launcher_entry": {
+            "enabled": True,
+            "icon_path": os.path.join(HERE, "icons/logo.svg"),
+            "title": "ParaView trame",
         },
     }

jupyter_trame_proxy/share/launch_trame.sh

@@ -1,7 +1,11 @@
 #!/bin/bash
+# ================================================================
+#  Launches ParaView trame after loading the required Modules
+# 
+#  Usage: launch_trame.sh PORT [args]
+# ================================================================
 
 # If you need to modify the envoronment before you launch pv_visualizer, do it here!
-
 # Example:
 # module purge
 # module load Stages/2022
@@ -10,4 +14,8 @@
 # module load trame
 # module load ParaView/5.10.1-EGL
 
-python -c "from pv_visualizer.app.main import main; main(port=$1, open_browser=False, timeout=0)"
+# Pop Port from the Arguments
+port=$1
+shift
+
+python -c "from pv_visualizer.app.main import main; main(port=$port, open_browser=False, timeout=0)" "$@"

requirements.txt

@@ -1,3 +1,4 @@
 jupyter-server-proxy>=1.5
 trame
 pv-visualizer>=0.1.2
+pv-server>=2.6.0