https://github.com/mogthesprog/jwtauthenticator

A Token Authenticator for JupyterHub
https://github.com/mogthesprog/jwtauthenticator

Last synced: 3 months ago
JSON representation

A Token Authenticator for JupyterHub

• Host: GitHub
• URL: https://github.com/mogthesprog/jwtauthenticator
• Owner: mogthesprog
• License: apache-2.0
• Created: 2017-06-21T20:09:58.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-04-15T07:40:37.000Z (almost 4 years ago)
• Last Synced: 2024-10-02T02:50:51.530Z (4 months ago)
• Language: Python
• Size: 25.4 KB
• Stars: 54
• Watchers: 7
• Forks: 62
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-jupyter-resources - GitHub - 52% open · ⏱️ 13.02.2019): (JupyterHub认证)

README

        
# JupyterHub tokenauthenticator - A JWT Token Authenticator for JupyterHub

Authenticate to Jupyterhub using a query parameter for the JSONWebToken, or by an authenticating proxy that can set the Authorization header with the content of a JSONWebToken.

## Installation

This package can be installed with pip:

```

pip install jupyterhub-jwtauthenticator

```

Alternately, you can clone this repository and run:

```

cd jwtauthenticator

pip install -e .

```

## Configuration

You should edit your :file:`jupyterhub_config.py` to set the authenticator class, the JSONWebTokenLocalAuthenticator provides features such as local user creation. If you already have local users then you may use the JSONWebTokenAuthenticator authenticator class:

##### For authentication and local user creation

```

c.JupyterHub.authenticator_class = 'jwtauthenticator.jwtauthenticator.JSONWebTokenLocalAuthenticator'

```

This class 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.

##### For authentication of the token only

```

c.JupyterHub.authenticator_class = 'jwtauthenticator.jwtauthenticator.JSONWebTokenAuthenticator'

```

##### Required configuration

You'll also need to set some configuration options including the location of the signing certificate (in PEM format), field containing the userPrincipalName or sAMAccountName/username, and the expected audience of the JSONWebToken. This last part is optional, if you set audience to an empty string then the authenticator will skip the validation of that field.

```

# one of "secret" or "signing_certificate" must be given.  If both, then "secret" will be the signing method used.

c.JSONWebTokenAuthenticator.secret = ''            # The secrect key used to generate the given token

# -OR-

c.JSONWebTokenAuthenticator.signing_certificate = '/foo/bar/adfs-signature.crt'    # The certificate used to sign the incoming JSONWebToken, must be in PEM Format

c.JSONWebTokenAuthenticator.username_claim_field = 'upn'                           # The claim field contianing the username/sAMAccountNAme/userPrincipalName

c.JSONWebTokenAuthenticator.expected_audience = 'https://myApp.domain.local/'               # This config option should match the aud field of the JSONWebToken, empty string to disable the validation of this field.

#c.JSONWebLocalTokenAuthenticator.create_system_users = True                       # This will enable local user creation upon authentication, requires JSONWebTokenLocalAuthenticator

#c.JSONWebTokenAuthenticator.header_name = 'Authorization'                         # default value

```

You should be able to start jupyterhub. :)

## Issues

If you have any issues or bug reports, all are welcome in the issues section. I'll do my best to respond quickly.

## Contribution

If you want to fix the bugs yourself then raise a PR and I'll take a look :)