JupyterLab Security Utilities
Project description
jupysec
JupyterLab Security Utilities
Security utilities for Jupyter environments. This extension evaluates the security posture of the environment by comparing configuration values with best practices.
This extension is under active development and pre-alpha release.
Function
Run the extension to generate an HTML report of the security configuration of your Jupyter instance and other Jupyter instances on your host.
Configurations will be compared against these rules.
These rules currently evaluate:
- Whether there are any executables in your ipython startup directories
- What lines of your configuration are nonstandard with known malicious uses
- Whether your servers require tokens for authentication
- Whether your server and client are communicating over HTTPS
- Whether you are serving Jupyter to a broader domain than just localhost
- If silent commands have been run against your kernels
Some of these categories may have false-positives depending on your environment and use-case. However, users should monitor their environments and be aware of their security posture and any changes.
Matches against the rules are referred to as "Findings" and displayed in the Report Card.
Requirements
- JupyterLab >= 3.0
Getting Started
To install the extension, execute:
pip install jupysec
After starting jupyterlab, your launcher window should now have a "Security" section with a widget for generating your findings. This will launch and index page with a list of all findings, color-coded by category. Click into findings for more details.
Uninstall
To remove the extension, execute:
pip uninstall jupysec
Troubleshoot
If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:
jupyter server extension list
If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:
jupyter labextension list
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for jupysec_extension-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 094a44ba066d057db6c179fc6ddadb595e9e9396b59d5e3701249a6bbda617f1 |
|
MD5 | c7ac94b454ef1d46d44f4cca0938d84d |
|
BLAKE2b-256 | 6c32e2333ae3115641c8171cbd81aaccfa91ebc2a4671755a9528e659b0b840b |