No project description provided
A bundle of Jupyterhub Authenticators. For now includes a Remote-User auth, Dummy auth and support for passing additional information to the jupyter user. This includes a Mount header.
Installation from pypi:
pip install jhub-authenticators
Installation from local git repository:
cd jhub-authenticators pip install .
You should edit your jupyterhub_config.py config file to set the authenticator class:
c.JupyterHub.authenticator_class = 'jhubauthenticators.RemoteUserAuthenticator'
You should be able to start jupyterhub. The “/login” resource will look for the authenticated user name in the HTTP header “Remote-User”. If found, and not blank, you will be logged in as that user.
Alternatively, you can use RemoteUserLocalAuthenticator:
c.JupyterHub.authenticator_class = 'jhubauthenticators.RemoteUserLocalAuthenticator'
This provides the same authentication functionality but is derived from LocalAuthenticator and therefore provides features such as the ability to add local accounts through the admin interface if configured to do so.
Provides an option for testing JupyterHub authentication with a dummy authenticator that can have a global preset password for any account:
c.JupyterHub.authenticator_class = 'jhubauthenticators.DummyAuthenticator' c.DummyAuthenticator.password = 'password'
Note! Don’t use in production.
Remote User Authentication extended with Mount capability
Provides the capability to supply the jupyterhub user with additional state information via the /mount path, it accepts a stringified dictionary with a mount key that can later be used to mount that particular user’s homedrive, the extended authenticator can be activated by setting the following option in the jupyterhub config file:
c.JupyterHub.authenticator_class = 'jhubauthenticators.MountRemoteUserAuthenticator'
Beyond providing the Mount header possibility, the authenticator also by default encodes the Remote-User header with ‘b32encode’. The authenticator therefore also provides the possibility of storing the actual value for debugging purposes in the user.real_name variable via the jupyterhub auth_state mechanism of passing information to the spawner as noted on Authenticators.
This adds two base request paths to the jupyterhub web application:
'/login' -> requires a non empty Remote-User header '/mount' -> requires both a non empty Remote-User and Mount header
The expected format of the Mount header is that the passed string can be evaluated to a python dictionary via:
try: mount_header_dict = literal_eval(mount_header)
The internal format of the Mount header is not evaluated, this is dependent on the underlying mount implementation and should be verified there.
Upon successful parsing of the header, the active jupyterhub user instance is appended with a ‘mount’ property that contains the accepted dictionary header.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size jhub_authenticators-0.0.9-py3-none-any.whl (5.8 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size jhub-authenticators-0.0.9.tar.gz (5.2 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for jhub_authenticators-0.0.9-py3-none-any.whl
Hashes for jhub-authenticators-0.0.9.tar.gz