# jupysec
_JupyterLab Security Utilities_
Security utilities for Jupyter environments. This set of rules and JupyerLab extension evaluates the security posture of the environment by comparing configuration values with best practices.
## 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](https://github.com/JosephTLucas/jupysec/blob/dev/jupysec/rules.py).
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](https://github.com/JosephTLucas/jupysec/blob/dev/jupysec/rules.py) are referred to as "Findings" and displayed in the Report Card.
## Requirements
- JupyterLab >= 3.0
## Getting Started
To install the rules in cli mode, execute:
```bash
pip install jupysec
```
Then in your python environment:
```python
from jupysec.rules import Rules
Rules().get_findings()
```
Or install the JupyterLab extension with
```bash
pip install jupysec[jupyterlab]
```
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/JosephTLucas/jupysec",
"name": "jupysec-extension",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "Jupyter,JupyterLab,JupyterLab3",
"author": "Joe Lucas",
"author_email": "joe@joetl.com",
"download_url": "",
"platform": "Linux",
"description": "# jupysec\n\n\n\n_JupyterLab Security Utilities_\n\nSecurity utilities for Jupyter environments. This set of rules and JupyerLab extension evaluates the security posture of the environment by comparing configuration values with best practices.\n\n## Function\n\n\n\nRun the extension to generate an HTML report of the security configuration of your Jupyter instance and other Jupyter instances on your host.\n\nConfigurations will be compared against [these rules](https://github.com/JosephTLucas/jupysec/blob/dev/jupysec/rules.py).\n\nThese rules currently evaluate:\n\n- Whether there are any executables in your ipython startup directories\n- What lines of your configuration are nonstandard with known malicious uses\n- Whether your servers require tokens for authentication\n- Whether your server and client are communicating over HTTPS\n- Whether you are serving Jupyter to a broader domain than just localhost\n- If silent commands have been run against your kernels\n\nSome 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.\n\nMatches against [the rules](https://github.com/JosephTLucas/jupysec/blob/dev/jupysec/rules.py) are referred to as \"Findings\" and displayed in the Report Card.\n\n\n\n## Requirements\n\n- JupyterLab >= 3.0\n\n## Getting Started\n\nTo install the rules in cli mode, execute:\n\n```bash\npip install jupysec\n```\n\nThen in your python environment:\n\n```python\nfrom jupysec.rules import Rules\n\nRules().get_findings()\n```\n\nOr install the JupyterLab extension with\n\n```bash\npip install jupysec[jupyterlab]\n```\n\nAfter 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.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "JupyterLab Security Utilities",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/JosephTLucas/jupysec"
},
"split_keywords": [
"jupyter",
"jupyterlab",
"jupyterlab3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c128919082f6f4853c7866a5b5104bae740a1f942a2d79c6757a1fa4b43abe3e",
"md5": "e8767be8dfa7a337175677b61294f67e",
"sha256": "6ac90617ef6b456d44259539e4bec859fe4595079d998f10361490a2d3fc113c"
},
"downloads": -1,
"filename": "jupysec_extension-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e8767be8dfa7a337175677b61294f67e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 74540,
"upload_time": "2023-06-02T17:37:25",
"upload_time_iso_8601": "2023-06-02T17:37:25.786369Z",
"url": "https://files.pythonhosted.org/packages/c1/28/919082f6f4853c7866a5b5104bae740a1f942a2d79c6757a1fa4b43abe3e/jupysec_extension-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-02 17:37:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JosephTLucas",
"github_project": "jupysec",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "jupysec-extension"
}
JSON
