JupyterHub自定义权限范围与服务配置详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01087/article/details/148441824

JupyterHub自定义权限范围与服务配置详解

jupyterhub Multi-user server for Jupyter notebooks 项目地址: https://gitcode.com/gh_mirrors/ju/jupyterhub

概述

在JupyterHub项目中，权限管理是一个非常重要的功能，它决定了不同用户能够访问哪些资源以及执行哪些操作。本文将深入解析如何通过配置文件实现自定义权限范围(scope)和服务配置，以满足特定场景下的权限控制需求。

核心概念

1. 自定义权限范围(Scope)

权限范围是JupyterHub中控制访问权限的基本单位。默认情况下，JupyterHub提供了一些内置的权限范围，但有时我们需要定义自己的权限范围来满足特定需求。

2. 服务(Service)

JupyterHub允许定义外部服务，这些服务可以与JupyterHub集成，并通过OAuth进行认证和授权。

3. 角色(Role)

角色是权限的集合，可以分配给用户或组，简化权限管理。

配置详解

1. 定义外部服务

c.JupyterHub.services = [
    {
        'name': 'grades',  # 服务名称
        'url': 'http://127.0.0.1:10101',  # 服务URL
        'command': [sys.executable, './grades.py'],  # 启动命令
        'oauth_client_allowed_scopes': [  # 该服务允许请求的权限范围
            'custom:grades:write',
            'custom:grades:read',
        ],
    },
]

这个配置定义了一个名为"grades"的服务，它运行在本地的10101端口，使用Python执行grades.py脚本。该服务被授权可以请求两种自定义权限范围。

2. 自定义权限范围定义

c.JupyterHub.custom_scopes = {
    "custom:grades:read": {
        "description": "read-access to all grades",  # 权限描述
    },
    "custom:grades:write": {
        "description": "Enter new grades",
        "subscopes": ["custom:grades:read"],  # 包含的子权限
    },
}

这里定义了两个自定义权限范围：

custom:grades:read: 允许读取成绩
custom:grades:write: 允许写入成绩，并且自动包含读取权限

3. 角色配置

c.JupyterHub.load_roles = [
    {
        "name": "user",
        "scopes": ["access:services", "self"],  # 所有用户都能访问服务和自身信息
    },
    {
        "name": "grader",
        "scopes": ["custom:grades:write"],  # 评分者可以写入成绩
        "users": ["grader"],  # 分配给特定用户
    },
    {
        "name": "instructor",
        "scopes": ["custom:grades:read"],  # 教师可以读取成绩
        "users": ["instructor"],
    },
]

定义了三种角色：

user: 基础角色，所有用户都拥有
grader: 评分者角色，可以写入成绩
instructor: 教师角色，可以读取成绩

4. 其他配置

c.JupyterHub.allowed_users = {"instructor", "grader", "student"}  # 允许的用户列表
c.JupyterHub.authenticator_class = 'dummy'  # 测试用的虚拟认证器
c.JupyterHub.spawner_class = 'simple'  # 测试用的简单生成器
c.JupyterHub.ip = '127.0.0.1'  # 本地运行
c.JupyterHub.log_level = 10  # 详细日志