Commit Graph

27 Commits

Author SHA1 Message Date
Min RK
8aac18c96d More documentation for 3.0 role/scope changes
a few more outdated `versionchanged` notes
2022-08-02 14:39:03 +02:00
Min RK
78438bdfcc Begin 3.0 changelog
had to manually remove already-backported PRs
2022-08-02 14:29:16 +02:00
Min RK
e4e4bf5ff4 next release is 3.0, not 2.4 2022-07-29 15:35:08 +02:00
Min RK
225ace636a call client-allowed scopes JUPYTERHUB_OAUTH_CLIENT_ALLOWED_SCOPES 2022-07-08 10:18:59 -07:00
Min RK
62b38934e5 store scopes on oauth clients, too
rather than roles, matching tokens

because oauth clients are mostly involved with issuing tokens,
they don't have roles themselves (their owners do).

This deprecates the `oauth_roles` config on Spawners and Services, in favor of `oauth_allowed_scopes`.

The ambiguously named `oauth_scopes` is renamed to `oauth_access_scopes`.
2022-06-08 12:26:48 +02:00
Min RK
b6210dc225 add !service and !server scope filters
allows oauth clients to issue scopes that only grant access to the issuing service

e.g. access:service!service or access:servers!server

especially useful with custom scopes
2022-04-08 20:10:23 +02:00
Min RK
66ecaf472a fix some outdated references to 'all' metascope
it is called 'inherit', but not all docs were updated
2022-03-24 14:06:05 +01:00
Min RK
9a87b59e84 improve custom scope docstrings 2022-03-16 08:44:52 +01:00
Min RK
fdf23600c0 allow custom scopes
defined with

    c.JupyterHub.custom_scopes = {
        'custom:scope': {'description': "text shown on oauth confirm"}
    }

Allows injecting custom scopes to roles,
allowing extension of granular permissions to service-defined custom scopes.

Custom scopes:

- MUST start with `custom:`
- MUST only contain ascii lowercase, numbers, colon, hyphen, asterisk, underscore
- MUST define a `description`
- MAY also define `subscopes` list(s), each of which must also be explicitly defined

HubAuth can be used to retrieve and check for custom scopes to authorize requests.
2022-03-11 11:37:26 +01:00
Min RK
8603723dbb add list:users|groups|services scopes
and govern GET /users|groups|services endpoints with these

Greatly simplifies filtering and pagination,
because these filters can be expressed in db filters,
unlike the potentially complex `read:users`.

Now the query itself will never return a model that should be excluded.

While writing the tests, I added more cleanup between tests.
We now ensure cleanup of all users and groups after each test,
which required updating some group tests which relied on this state leaking
2021-08-24 13:56:11 +02:00
IvanaH8
024e8fca30 Add !user filter explanation 2021-06-22 17:16:06 +02:00
IvanaH8
eb0f995886 Add scope hierarchy duplicates explanation 2021-06-22 16:22:51 +02:00
0mar
7a3b237bb3 Refactored scope names and updated docs to reflect this 2021-06-15 13:00:15 +02:00
Min RK
8eaed91f79 Merge pull request #3444 from minrk/oauth-details
Oauth details docs
2021-06-07 11:56:49 +00:00
Min RK
d39673eea2 Flesh out oauth details doc
adress review, add emoji, expand details, examlpes, and add discussion of caching and revocation.
2021-05-26 12:28:59 +02:00
IvanaH8
7914c01099 Call scope table generation in makefile and include in scopes.md 2021-05-20 14:52:28 +02:00
Min RK
a2b76bceb9 minor copy-editing, TODOs in rbac docs 2021-04-22 13:39:36 +02:00
IvanaH8
5a95681853 Add %TODO: flag for generating the table in docs/source/rbac/scopes.md 2021-04-16 17:26:19 +02:00
IvanaH8
0638783939 Synchronize docs/rest-api.yml with Available scopes table in docs/source/rbac/scopes.md 2021-04-16 17:11:46 +02:00
IvanaH8
b0f4548753 Add read:users(services):roles scopes to docs/source/rbac/scopes.md 2021-04-16 16:49:15 +02:00
IvanaH8
c6e3e06af9 Add Upgrade section to docs/source/rbac/upgrade.md 2021-04-16 16:31:01 +02:00
IvanaH8
649524d357 Add available scopes table in docs/source/rbac/scopes.md 2021-04-08 16:03:17 +02:00
IvanaH8
f5bbe78dbd Resolve merge conflicts with rbac 2021-04-08 11:32:41 +02:00
IvanaH8
949ec5cc75 Add and update scopes, roles, charts and text in docs/source/rbac docs 2021-04-08 09:39:01 +02:00
IvanaH8
8064cda47a Update RBAC docs implementing review suggestions 2021-03-17 17:13:09 +01:00
IvanaH8
bc1e370d7d updated tech implementation section 2021-02-19 12:37:20 +01:00
IvanaH8
7d1b6a2021 split the docs in docs/source/rbac folder 2021-02-15 16:19:13 +01:00