oauthenticator.generic

oauthenticator.generic#

Custom Authenticator to use generic OAuth2 with JupyterHub

class oauthenticator.generic.GenericOAuthenticator(**kwargs: Any)#

admin_groups c.GenericOAuthenticator.admin_groups = List()#: Groups whose members should have Jupyterhub admin privileges

admin_users c.GenericOAuthenticator.admin_users = Set()#

Set of users that will have admin rights on this JupyterHub.

Note: As of JupyterHub 2.0, full admin rights should not be required, and more precise permissions can be managed via roles.

Admin users have extra privileges:

Use the admin panel to see list of users logged in
Add / remove users in some authenticators
Restart / halt the hub
Start / stop users’ single-user servers
Can access each individual users’ single-user server (if configured)

Admin access should be treated the same way root access is.

Defaults to an empty set, in which case no user has admin access.

allowed_groups c.GenericOAuthenticator.allowed_groups = List()#: Automatically allow members of selected groups

allowed_users c.GenericOAuthenticator.allowed_users = Set()#

Set of usernames that are allowed to log in.

Use this with supported authenticators to restrict which users can log in. This is an additional list that further restricts users, beyond whatever restrictions the authenticator has in place. Any user in this list is granted the ‘user’ role on hub startup.

If empty, does not perform any additional restriction.

Changed in version 1.2: Authenticator.whitelist renamed to allowed_users

auth_refresh_age c.GenericOAuthenticator.auth_refresh_age = Int(300)#

The max age (in seconds) of authentication info before forcing a refresh of user auth info.

Refreshing auth info allows, e.g. requesting/re-validating auth tokens.

See refresh_user() for what happens when user auth info is refreshed (nothing by default).

authorize_url c.GenericOAuthenticator.authorize_url = Unicode('')#: The authenticate url for initiating oauth

auto_login c.GenericOAuthenticator.auto_login = Bool(False)#

Automatically begin the login process

rather than starting with a “Login with…” link at /hub/login

To work, .login_url() must give a URL other than the default /hub/login, such as an oauth handler or another automatic login handler, registered with .get_handlers().

New in version 0.8.

auto_login_oauth2_authorize c.GenericOAuthenticator.auto_login_oauth2_authorize = Bool(False)#

Automatically begin login process for OAuth2 authorization requests

When another application is using JupyterHub as OAuth2 provider, it sends users to /hub/api/oauth2/authorize. If the user isn’t logged in already, and auto_login is not set, the user will be dumped on the hub’s home page, without any context on what to do next.

Setting this to true will automatically redirect users to login if they aren’t logged in only on the /hub/api/oauth2/authorize endpoint.

New in version 1.5.

basic_auth c.GenericOAuthenticator.basic_auth = Bool(False)#: Whether or not to use basic authentication for access token request

blocked_users c.GenericOAuthenticator.blocked_users = Set()#

Set of usernames that are not allowed to log in.

Use this with supported authenticators to restrict which users can not log in. This is an additional block list that further restricts users, beyond whatever restrictions the authenticator has in place.

If empty, does not perform any additional restriction.

Changed in version 1.2: Authenticator.blacklist renamed to blocked_users

claim_groups_key c.GenericOAuthenticator.claim_groups_key = Union()#

Userdata groups claim key from returned json for USERDATA_URL.

Can be a string key name (use periods for nested keys), or a callable that accepts the returned json (as a dict) and returns the groups list.

client_id c.GenericOAuthenticator.client_id = Unicode('')#: No help string is provided.

client_secret c.GenericOAuthenticator.client_secret = Unicode('')#: No help string is provided.

custom_403_message c.GenericOAuthenticator.custom_403_message = Unicode('Sorry, you are not currently authorized to use this hub. Please contact the hub administrator.')#: The message to be shown when user was not allowed

delete_invalid_users c.GenericOAuthenticator.delete_invalid_users = Bool(False)#

Delete any users from the database that do not pass validation

When JupyterHub starts, .add_user will be called on each user in the database to verify that all users are still valid.

If delete_invalid_users is True, any users that do not pass validation will be deleted from the database. Use this if users might be deleted from an external system, such as local user accounts.

If False (default), invalid users remain in the Hub’s database and a warning will be issued. This is the default to avoid data loss due to config changes.

enable_auth_state c.GenericOAuthenticator.enable_auth_state = Bool(False)#

Enable persisting auth_state (if available).

auth_state will be encrypted and stored in the Hub’s database. This can include things like authentication tokens, etc. to be passed to Spawners as environment variables.

Encrypting auth_state requires the cryptography package.

Additionally, the JUPYTERHUB_CRYPT_KEY environment variable must contain one (or more, separated by ;) 32B encryption keys. These can be either base64 or hex-encoded.

If encryption is unavailable, auth_state cannot be persisted.

New in JupyterHub 0.8

extra_authorize_params c.GenericOAuthenticator.extra_authorize_params = Dict()#: Extra GET params to send along with the initial OAuth request to the OAuth provider.

extra_params c.GenericOAuthenticator.extra_params = Dict()#: Deprecated, use GenericOAuthenticator.token_params

http_request_kwargs c.GenericOAuthenticator.http_request_kwargs = Dict()#

Extra default kwargs passed to all HTTPRequests.

For example, to use a HTTP proxy for all requests:

c.OAuthenticator.http_request_kwargs = {“proxy_host”: “proxy.example.com”, “proxy_port”: 8080}

See the tornado.httpclient.HTTPRequest documentation for all options and limitations: https://www.tornadoweb.org/en/stable/httpclient.html#tornado.httpclient.HTTPRequest

Note that some of these are dependent on the httpclient implementation.

login_service c.GenericOAuthenticator.login_service = Unicode('OAuth 2.0')#: No help string is provided.

logout_redirect_url c.GenericOAuthenticator.logout_redirect_url = Unicode('')#: URL for logging out of Auth0

manage_groups c.GenericOAuthenticator.manage_groups = Bool(False)#

Let authenticator manage user groups

If True, Authenticator.authenticate and/or .refresh_user may return a list of group names in the ‘groups’ field, which will be assigned to the user.

All group-assignment APIs are disabled if this is True.

oauth_callback_url c.GenericOAuthenticator.oauth_callback_url = Unicode('')#: Callback URL to use. Typically https://{host}/hub/oauth_callback

post_auth_hook c.GenericOAuthenticator.post_auth_hook = Any(None)#

An optional hook function that you can implement to do some bootstrapping work during authentication. For example, loading user account details from an external system.

This function is called after the user has passed all authentication checks and is ready to successfully authenticate. This function must return the authentication dict reguardless of changes to it.

This maybe a coroutine.

Example:

import os, pwd
def my_hook(authenticator, handler, authentication):
    user_data = pwd.getpwnam(authentication['name'])
    spawn_data = {
        'pw_data': user_data
        'gid_list': os.getgrouplist(authentication['name'], user_data.pw_gid)
    }

    if authentication['auth_state'] is None:
        authentication['auth_state'] = {}
    authentication['auth_state']['spawn_data'] = spawn_data

    return authentication

c.Authenticator.post_auth_hook = my_hook

refresh_pre_spawn c.GenericOAuthenticator.refresh_pre_spawn = Bool(False)#

Force refresh of auth prior to spawn.

This forces refresh_user() to be called prior to launching a server, to ensure that auth state is up-to-date.

This can be important when e.g. auth tokens that may have expired are passed to the spawner via environment variables from auth_state.

If refresh_user cannot refresh the user auth data, launch will fail until the user logs in again.

scope c.GenericOAuthenticator.scope = List()#: The OAuth scopes to request. See the OAuth documentation of your OAuth provider for options. For GitHub in particular, you can see github_scopes.md in this repo.

tls_verify c.GenericOAuthenticator.tls_verify = Bool(True)#: Disable TLS verification on http request

token_params c.GenericOAuthenticator.token_params = Dict()#: Extra parameters for first POST request exchanging the OAuth code for an Access Token

token_url c.GenericOAuthenticator.token_url = Unicode('')#: The url retrieving an access token at the completion of oauth

async update_auth_model(auth_model)#

Updates auth_model dict if any fields have changed or additional information is available or returns the unchanged auth_model.

Returns the model unchanged by default.

Should be overridden to take into account changes like group/admin membership.

Args: auth_model - the auth model dictionary dict instead, containing:

the name key holding the username
the auth_state key, the dictionary of of auth state
returned by oauthenticator.OAuthenticator.build_auth_state_dict()

Called by the oauthenticator.OAuthenticator.authenticate()

user_info_to_username(user_info)#

Gets the self.username_claim key’s value from the user_info dictionary. This is equivalent to the JupyterHub username.

Should be overridden by the authenticators for which the hub username cannot be extracted this way and needs extra processing.

Parameters:: user_info – the dictionary returned by the userdata request
Returns:: user_info[“self.username_claim”] or raises an error if such value isn’t found.

Called by the oauthenticator.OAuthenticator.authenticate()

async user_is_authorized(auth_model)#

Checks if the user that is authenticating should be authorized or not and False otherwise. Should be overridden with any relevant logic specific to each oauthenticator.

Returns True by default.

Called by the oauthenticator.OAuthenticator.authenticate()

userdata_params c.GenericOAuthenticator.userdata_params = Dict()#: Userdata params to get user data login information

userdata_token_method c.GenericOAuthenticator.userdata_token_method = Unicode('header')#: Method for sending access token in userdata request. Supported methods: header, url. Default: header

userdata_url c.GenericOAuthenticator.userdata_url = Unicode('')#: The url for retrieving user data with a completed access token

username_claim c.GenericOAuthenticator.username_claim = Union()#

Userdata username key from returned json for USERDATA_URL.

Can be a string key name or a callable that accepts the returned json (as a dict) and returns the username. The callable is useful e.g. for extracting the username from a nested object in the response.

username_key c.GenericOAuthenticator.username_key = Union()#: Deprecated, use GenericOAuthenticator.username_claim

username_map c.GenericOAuthenticator.username_map = Dict()#

Dictionary mapping authenticator usernames to JupyterHub users.

Primarily used to normalize OAuth user names to local users.

username_pattern c.GenericOAuthenticator.username_pattern = Unicode('')#

Regular expression pattern that all valid usernames must match.

If a username does not match the pattern specified here, authentication will not be attempted.

If not set, allow any username.

validate_server_cert c.GenericOAuthenticator.validate_server_cert = Bool(False)#: No help string is provided.

whitelist c.GenericOAuthenticator.whitelist = Set()#: Deprecated, use Authenticator.allowed_users

class oauthenticator.generic.LocalGenericOAuthenticator(**kwargs: Any)#

A version that mixes in local system user creation

add_user_cmd c.LocalGenericOAuthenticator.add_user_cmd = Command()#

The command to use for creating users as a list of strings

For each element in the list, the string USERNAME will be replaced with the user’s username. The username will also be appended as the final argument.

For Linux, the default value is:

[‘adduser’, ‘-q’, ‘–gecos’, ‘””’, ‘–disabled-password’]

To specify a custom home directory, set this to:

[‘adduser’, ‘-q’, ‘–gecos’, ‘””’, ‘–home’, ‘/customhome/USERNAME’, ‘–disabled-password’]

This will run the command:

adduser -q –gecos “” –home /customhome/river –disabled-password river

when the user ‘river’ is created.

admin_groups c.LocalGenericOAuthenticator.admin_groups = List()#: Groups whose members should have Jupyterhub admin privileges

admin_users c.LocalGenericOAuthenticator.admin_users = Set()#

Set of users that will have admin rights on this JupyterHub.

Note: As of JupyterHub 2.0, full admin rights should not be required, and more precise permissions can be managed via roles.

Admin users have extra privileges:

Use the admin panel to see list of users logged in
Add / remove users in some authenticators
Restart / halt the hub
Start / stop users’ single-user servers
Can access each individual users’ single-user server (if configured)

Admin access should be treated the same way root access is.

Defaults to an empty set, in which case no user has admin access.

allowed_groups c.LocalGenericOAuthenticator.allowed_groups = Set()#

Allow login from all users in these UNIX groups.

If set, allowed username set is ignored.

allowed_users c.LocalGenericOAuthenticator.allowed_users = Set()#

Set of usernames that are allowed to log in.

If empty, does not perform any additional restriction.

Changed in version 1.2: Authenticator.whitelist renamed to allowed_users

auth_refresh_age c.LocalGenericOAuthenticator.auth_refresh_age = Int(300)#

The max age (in seconds) of authentication info before forcing a refresh of user auth info.

Refreshing auth info allows, e.g. requesting/re-validating auth tokens.

See refresh_user() for what happens when user auth info is refreshed (nothing by default).

authorize_url c.LocalGenericOAuthenticator.authorize_url = Unicode('')#: The authenticate url for initiating oauth

auto_login c.LocalGenericOAuthenticator.auto_login = Bool(False)#

Automatically begin the login process

rather than starting with a “Login with…” link at /hub/login

To work, .login_url() must give a URL other than the default /hub/login, such as an oauth handler or another automatic login handler, registered with .get_handlers().

New in version 0.8.

auto_login_oauth2_authorize c.LocalGenericOAuthenticator.auto_login_oauth2_authorize = Bool(False)#

Automatically begin login process for OAuth2 authorization requests

Setting this to true will automatically redirect users to login if they aren’t logged in only on the /hub/api/oauth2/authorize endpoint.

New in version 1.5.

basic_auth c.LocalGenericOAuthenticator.basic_auth = Bool(False)#: Whether or not to use basic authentication for access token request

blocked_users c.LocalGenericOAuthenticator.blocked_users = Set()#

Set of usernames that are not allowed to log in.

If empty, does not perform any additional restriction.

Changed in version 1.2: Authenticator.blacklist renamed to blocked_users

claim_groups_key c.LocalGenericOAuthenticator.claim_groups_key = Union()#

Userdata groups claim key from returned json for USERDATA_URL.

Can be a string key name (use periods for nested keys), or a callable that accepts the returned json (as a dict) and returns the groups list.

client_id c.LocalGenericOAuthenticator.client_id = Unicode('')#: No help string is provided.

client_secret c.LocalGenericOAuthenticator.client_secret = Unicode('')#: No help string is provided.

create_system_users c.LocalGenericOAuthenticator.create_system_users = Bool(False)#

If set to True, will attempt to create local system users if they do not exist already.

Supports Linux and BSD variants only.

custom_403_message c.LocalGenericOAuthenticator.custom_403_message = Unicode('Sorry, you are not currently authorized to use this hub. Please contact the hub administrator.')#: The message to be shown when user was not allowed

delete_invalid_users c.LocalGenericOAuthenticator.delete_invalid_users = Bool(False)#

Delete any users from the database that do not pass validation

When JupyterHub starts, .add_user will be called on each user in the database to verify that all users are still valid.

If delete_invalid_users is True, any users that do not pass validation will be deleted from the database. Use this if users might be deleted from an external system, such as local user accounts.

If False (default), invalid users remain in the Hub’s database and a warning will be issued. This is the default to avoid data loss due to config changes.

enable_auth_state c.LocalGenericOAuthenticator.enable_auth_state = Bool(False)#

Enable persisting auth_state (if available).

auth_state will be encrypted and stored in the Hub’s database. This can include things like authentication tokens, etc. to be passed to Spawners as environment variables.

Encrypting auth_state requires the cryptography package.

Additionally, the JUPYTERHUB_CRYPT_KEY environment variable must contain one (or more, separated by ;) 32B encryption keys. These can be either base64 or hex-encoded.

If encryption is unavailable, auth_state cannot be persisted.

New in JupyterHub 0.8

extra_authorize_params c.LocalGenericOAuthenticator.extra_authorize_params = Dict()#: Extra GET params to send along with the initial OAuth request to the OAuth provider.

extra_params c.LocalGenericOAuthenticator.extra_params = Dict()#: Deprecated, use GenericOAuthenticator.token_params

group_whitelist c.LocalGenericOAuthenticator.group_whitelist = Set()#: DEPRECATED: use allowed_groups

http_request_kwargs c.LocalGenericOAuthenticator.http_request_kwargs = Dict()#

Extra default kwargs passed to all HTTPRequests.

For example, to use a HTTP proxy for all requests:

c.OAuthenticator.http_request_kwargs = {“proxy_host”: “proxy.example.com”, “proxy_port”: 8080}

See the tornado.httpclient.HTTPRequest documentation for all options and limitations: https://www.tornadoweb.org/en/stable/httpclient.html#tornado.httpclient.HTTPRequest

Note that some of these are dependent on the httpclient implementation.

login_service c.LocalGenericOAuthenticator.login_service = Unicode('OAuth 2.0')#: No help string is provided.

logout_redirect_url c.LocalGenericOAuthenticator.logout_redirect_url = Unicode('')#: URL for logging out of Auth0

manage_groups c.LocalGenericOAuthenticator.manage_groups = Bool(False)#

Let authenticator manage user groups

If True, Authenticator.authenticate and/or .refresh_user may return a list of group names in the ‘groups’ field, which will be assigned to the user.

All group-assignment APIs are disabled if this is True.

oauth_callback_url c.LocalGenericOAuthenticator.oauth_callback_url = Unicode('')#: Callback URL to use. Typically https://{host}/hub/oauth_callback

post_auth_hook c.LocalGenericOAuthenticator.post_auth_hook = Any(None)#

An optional hook function that you can implement to do some bootstrapping work during authentication. For example, loading user account details from an external system.

This function is called after the user has passed all authentication checks and is ready to successfully authenticate. This function must return the authentication dict reguardless of changes to it.

This maybe a coroutine.

Example:

import os, pwd
def my_hook(authenticator, handler, authentication):
    user_data = pwd.getpwnam(authentication['name'])
    spawn_data = {
        'pw_data': user_data
        'gid_list': os.getgrouplist(authentication['name'], user_data.pw_gid)
    }

    if authentication['auth_state'] is None:
        authentication['auth_state'] = {}
    authentication['auth_state']['spawn_data'] = spawn_data

    return authentication

c.Authenticator.post_auth_hook = my_hook

refresh_pre_spawn c.LocalGenericOAuthenticator.refresh_pre_spawn = Bool(False)#

Force refresh of auth prior to spawn.

This forces refresh_user() to be called prior to launching a server, to ensure that auth state is up-to-date.

This can be important when e.g. auth tokens that may have expired are passed to the spawner via environment variables from auth_state.

If refresh_user cannot refresh the user auth data, launch will fail until the user logs in again.

scope c.LocalGenericOAuthenticator.scope = List()#: The OAuth scopes to request. See the OAuth documentation of your OAuth provider for options. For GitHub in particular, you can see github_scopes.md in this repo.

tls_verify c.LocalGenericOAuthenticator.tls_verify = Bool(True)#: Disable TLS verification on http request

token_params c.LocalGenericOAuthenticator.token_params = Dict()#: Extra parameters for first POST request exchanging the OAuth code for an Access Token

token_url c.LocalGenericOAuthenticator.token_url = Unicode('')#: The url retrieving an access token at the completion of oauth

uids c.LocalGenericOAuthenticator.uids = Dict()#: Dictionary of uids to use at user creation time. This helps ensure that users created from the database get the same uid each time they are created in temporary deployments or containers.

userdata_params c.LocalGenericOAuthenticator.userdata_params = Dict()#: Userdata params to get user data login information

userdata_token_method c.LocalGenericOAuthenticator.userdata_token_method = Unicode('header')#: Method for sending access token in userdata request. Supported methods: header, url. Default: header

userdata_url c.LocalGenericOAuthenticator.userdata_url = Unicode('')#: The url for retrieving user data with a completed access token

username_claim c.LocalGenericOAuthenticator.username_claim = Union()#

Userdata username key from returned json for USERDATA_URL.

username_key c.LocalGenericOAuthenticator.username_key = Union()#: Deprecated, use GenericOAuthenticator.username_claim

username_map c.LocalGenericOAuthenticator.username_map = Dict()#

Dictionary mapping authenticator usernames to JupyterHub users.

Primarily used to normalize OAuth user names to local users.

username_pattern c.LocalGenericOAuthenticator.username_pattern = Unicode('')#

Regular expression pattern that all valid usernames must match.

If a username does not match the pattern specified here, authentication will not be attempted.

If not set, allow any username.

validate_server_cert c.LocalGenericOAuthenticator.validate_server_cert = Bool(False)#: No help string is provided.

whitelist c.LocalGenericOAuthenticator.whitelist = Set()#: Deprecated, use Authenticator.allowed_users

oauthenticator.generic

Contents

oauthenticator.generic#