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.

Sign up for GitHub

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

Setting to disable redirect file browser launch #4999

Merged
merged 3 commits into from
Oct 31, 2019
Merged

Setting to disable redirect file browser launch #4999

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fa12f4b
Setting to disable redirect file browser launch
betteridiot Oct 23, 2019
4fe631a
Changes from code review comments
betteridiot Oct 29, 2019
0a1fff1
Removing unneeded tornado setting
betteridiot Oct 31, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 18 additions & 31 deletions notebook/notebookapp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -540,20 +540,6 @@ def start(self):
_("Allow the notebook to be run from root user.")
)

flags['use_redirect_file']=(
{'NotebookApp' : {'use_redirect_file' : True}},
"""Disable launching browser by redirect file

For some environments (like Windows Subsystem for Linux (WSL) and Chromebooks),
launching a browser using a redirect file (introduced in notebook versions
> 5.7.2) can lead the browser failing to load. This is because of the
difference in file structures/paths between the runtime and the browser.

Disabling this setting will by setting to False will disable this behavior,
allowing the browser to launch by using a URL and visible token (as before).
"""
)

# Add notebook manager flags
flags.update(boolean_flag('script', 'FileContentsManager.save_script',
'DEPRECATED, IGNORED',
Expand Down Expand Up @@ -663,13 +649,18 @@ def _default_log_format(self):
use_redirect_file = Bool(True, config=True,
help="""Disable launching browser by redirect file

For some environments (like Windows Subsystem for Linux (WSL) and Chromebooks),
launching a browser using a redirect file (introduced in notebook versions
> 5.7.2) can lead the browser failing to load. This is because of the
difference in file structures/paths between the runtime and the browser.
For versions of notebook > 5.7.2, a security feature measure was added that
prevented the authentication token used to launch the browser from being visible.
This feature makes it difficult for other users on a multi-user system from
running code in your Jupyter session as you.

However, some environments (like Windows Subsystem for Linux (WSL) and Chromebooks),
launching a browser using a redirect file can lead the browser failing to load.
This is because of the difference in file structures/paths between the runtime and
the browser.

Disabling this setting will by setting to False will disable this behavior,
allowing the browser to launch by using a URL and visible token (as before).
Disabling this setting to False will disable this behavior, allowing the browser
to launch by using a URL and visible token (as before).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed language regarding the security risk if the setting is disabled

"""
)

Expand Down Expand Up @@ -1839,7 +1830,7 @@ def launch_browser(self):
if self.token:
uri = url_concat(uri, {'token': self.token})

elif self.file_to_run:
if self.file_to_run:
if not os.path.exists(self.file_to_run):
self.log.critical(_("%s does not exist") % self.file_to_run)
self.exit(1)
Expand All @@ -1854,17 +1845,13 @@ def launch_browser(self):
else:
open_file = self.browser_open_file

if not self.use_redirect_file:
if browser:
b = lambda: browser.open(url_path_join(self.connection_url, uri),
new=self.webbrowser_open_new)
threading.Thread(target=b).start()

if self.use_redirect_file:
assembled_url = urljoin('file:', pathname2url(open_file))
else:
b = lambda: browser.open(
urljoin('file:', pathname2url(open_file)),
new=self.webbrowser_open_new)
threading.Thread(target=b).start()
assembled_url = url_path_join(self.connection_url, uri)

b = lambda: browser.open(assembled_url, new=self.webbrowser_open_new)
threading.Thread(target=b).start()

def start(self):
""" Start the Notebook server app, after initialization
Expand Down