jupyter-sshd-proxy-taha1506 0.3.1

Run sshd under jupyter

jupyter-sshd-proxy

Enable sshing into a remote Jupyter Server.

Primarily for use with remote JupyterHubs, so users can access them via ssh. Enables everything one would normally do with ssh - copy files, run interactive commands, use the proprietary VSCode Remote Development functionality, etc!

Usage

For this document, we will assume you are running inside a containerized JupyterHub enviornment (such as kubernetes or docker). jupyter-sshd-proxy itself does not require containerization - this is simply to make instructions easier.

Server pre-requisities

The following packages must be present in the container:

• openssh. The sshd binary may be bundled with the openssh package (e.g. on conda-forge) or the openssh-server package (e.g. on Ubuntu).
• jupyter-sshd-proxy itself must be pre-installed in the container - you can not dynamically install it with !pip after you start the container.

The docker image quay.io/yuvipanda/pangeo-jupyter-sshd-proxy:latest can be used for testing purposes. It it is based on the pangeo-notebook docker image, and has the pre-requisites required pre-installed. You can find the source Dockerfile for it in this repository.

Client pre-requisites

websocat must be installed on the client machine. brew install websocat works on Mac OS, and pre-built binaries are available for all other operating systems.

Start your server

jupyter-sshd-proxy only works after you start your JupyterHub server. So, start your server!

Create a JupyterHub Token

We will need to create a JupyterHub token for authentication.

1. Go to the JupyterHub control panel. You can access it via File -> Hub control panel in JupyterLab, or directly going to https://<your-hub-url>/hub/home.

2. In the top bar, select Token.

3. Create a new Token, and keep it safe. Treat this like you would treat a password to your JupyterHub instance! It is recommended you set an expiry date for this.

Setup your local ~/.ssh/config

We will set up our ssh config file to tell ssh how to connect to our JupyterHub. Add an entry that looks like this to the end of your ~/.ssh/config file (create it if it does not exist).

Host <YOUR-JUPYTERHUB-DOMAIN>
    User <YOUR-JUPYTERHUB-CONTAINER-USER-NAME>
    ProxyCommand websocat --binary -H="Authorization: token <YOUR-JUPYTERHUB-TOKEN>" asyncstdio: wss://%h/user/<YOUR-JUPYTERHUB-USERNAME>/sshd/

replace:

• <YOUR-JUPYTERHUB-DOMAIN> with your hub domain (for example, hub.openveda.cloud)
• <YOUR-JUPYTERHUB-TOKEN> with the token you generated earlier
• <YOUR-JUPYTERHUB-USERNAME> with your jupyterhub username
• <YOUR-JUPYTERHUB-CONTAINER-USERNAME> is the name of the unix user created inside your JupyterHub container. This is most commonly jovyan. You can verify this by running whoami or id in the terminal in your JupyterHub.

Here's an example:

Host hub.openveda.cloud
    User jovyan
    ProxyCommand websocat --binary -H="Authorization: token a56ff59c93f64fb587f46b06af9422ee" asyncstdio: wss://%h/user/yuvipanda/sshd/
    IdentitiesOnly yes # Don't use password auth

Note that if you are connecting to your JupyterHub in a VSCode fork that uses the open-remote-ssh extension, such as VSCodium, Cursor, or Positron, you need to make sure the value of the -H argument ("Authorization: token xxxx") is enclosed in double quotes and not single quotes, or the connection will fail.

We're almost there!

Setup ssh keys on your JupyterHub server

There are still two levels of authentication - your JupyterHub token, as well as some ssh keys. You need to put some ssh public keys in ~/.ssh/authorized_keys after you start your JupyterHub server, and have the private keys available in your ssh client machine.

The simplest way to do this is to rely on your GitHub public keys!

1. After you start your JupyterHub server, open a terminal in JupyterLab

2. Run the following commands:

   mkdir -p ~/.ssh
   wget https://github.com/<YOUR-GITHUB-USERNAME>.keys -O ~/.ssh/authorized_keys
   chmod 0600 ~/.ssh/authorized_keys
   

   replacing <YOUR-GITHUB-USERNAME> with your github username.

With that, we are ready to go!

ssh into your JupyterHub!

After all this is setup, you're now able to ssh in! Try:

ssh <YOUR-JUPYTERHUB-DOMAIN>

and it should just work! You can also use this with the proprietary Visual Studio code Remote SSH feature, use sftp to copy files over (although it will be slow), create tunnels, etc!