Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing warning when no authorizer in found ZMQ handlers #744

Merged
merged 2 commits into from Mar 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 2 additions & 12 deletions jupyter_server/auth/decorator.py
Expand Up @@ -2,7 +2,6 @@
"""
# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.
import warnings
from functools import wraps
from typing import Callable
from typing import Optional
Expand All @@ -12,6 +11,7 @@
from tornado.web import HTTPError

from .utils import HTTP_METHOD_TO_AUTH_ACTION
from .utils import warn_disabled_authorization


def authorized(
Expand Down Expand Up @@ -63,17 +63,7 @@ def inner(self, *args, **kwargs):

# Handle the case where an authorizer wasn't attached to the handler.
if not self.authorizer:
warnings.warn(
"The Tornado web application does not have an 'authorizer' defined "
"in its settings. In future releases of jupyter_server, this will "
"be a required key for all subclasses of `JupyterHandler`. For an "
"example, see the jupyter_server source code for how to "
"add an authorizer to the tornado settings: "
"https://github.com/jupyter-server/jupyter_server/blob/"
"653740cbad7ce0c8a8752ce83e4d3c2c754b13cb/jupyter_server/serverapp.py"
"#L234-L256",
FutureWarning,
)
warn_disabled_authorization()
return method(self, *args, **kwargs)

# Only return the method if the action is authorized.
Expand Down
15 changes: 15 additions & 0 deletions jupyter_server/auth/utils.py
Expand Up @@ -4,6 +4,21 @@
# Distributed under the terms of the Modified BSD License.
import importlib
import re
import warnings


def warn_disabled_authorization():
warnings.warn(
"The Tornado web application does not have an 'authorizer' defined "
"in its settings. In future releases of jupyter_server, this will "
"be a required key for all subclasses of `JupyterHandler`. For an "
"example, see the jupyter_server source code for how to "
"add an authorizer to the tornado settings: "
"https://github.com/jupyter-server/jupyter_server/blob/"
"653740cbad7ce0c8a8752ce83e4d3c2c754b13cb/jupyter_server/serverapp.py"
"#L234-L256",
FutureWarning,
)


HTTP_METHOD_TO_AUTH_ACTION = {
Expand Down
6 changes: 5 additions & 1 deletion jupyter_server/base/zmqhandlers.py
Expand Up @@ -21,6 +21,7 @@
from tornado.websocket import WebSocketHandler

from .handlers import JupyterHandler
from jupyter_server.auth.utils import warn_disabled_authorization


def serialize_binary_message(msg):
Expand Down Expand Up @@ -320,7 +321,10 @@ def pre_get(self):
raise web.HTTPError(403)

# authorize the user.
if not self.authorizer.is_authorized(self, user, "execute", "kernels"):
if not self.authorizer:
# Warn if there is not authorizer.
warn_disabled_authorization()
elif not self.authorizer.is_authorized(self, user, "execute", "kernels"):
raise web.HTTPError(403)

if self.get_argument("session_id", False):
Expand Down
7 changes: 6 additions & 1 deletion jupyter_server/terminal/handlers.py
Expand Up @@ -8,6 +8,7 @@
from ..base.handlers import JupyterHandler
from ..base.zmqhandlers import WebSocketMixin
from jupyter_server._tz import utcnow
from jupyter_server.auth.utils import warn_disabled_authorization

AUTH_RESOURCE = "terminals"

Expand All @@ -28,7 +29,11 @@ def get(self, *args, **kwargs):
if not user:
raise web.HTTPError(403)

if not self.authorizer.is_authorized(self, user, "execute", self.auth_resource):
# authorize the user.
if not self.authorizer:
# Warn if there is not authorizer.
warn_disabled_authorization()
elif not self.authorizer.is_authorized(self, user, "execute", self.auth_resource):
raise web.HTTPError(403)

if not args[0] in self.term_manager.terminals:
Expand Down