Python¶
Tunnel supports three types of Python package managers: pip, Pipenv and Poetry.
The following scanners are supported for package managers.
| Package manager | SBOM | Vulnerability | License |
|---|---|---|---|
| pip | ✓ | ✓ | ✓ |
| Pipenv | ✓ | ✓ | - |
| Poetry | ✓ | ✓ | - |
| uv | ✓ | ✓ | - |
In addition, Tunnel supports three formats of Python packages: egg, wheel and conda.
The following scanners are supported for Python packages.
| Packaging | SBOM | Vulnerability | License |
|---|---|---|---|
| Egg | ✓ | ✓ | ✓ |
| Wheel | ✓ | ✓ | ✓ |
| Conda | ✓ | - | - |
The following table provides an outline of the features Tunnel offers.
| Package manager | File | Transitive dependencies | Dev dependencies | Dependency graph | Position | Detection Priority |
|---|---|---|---|---|---|---|
| pip | requirements.txt | - | Include | - | ✓ | ✓ |
| Pipenv | Pipfile.lock | ✓ | Include | - | ✓ | Not needed |
| Poetry | poetry.lock | ✓ | Exclude | ✓ | - | Not needed |
| uv | uv.lock | ✓ | Exclude | ✓ | - | Not needed |
| Packaging | Dependency graph |
|---|---|
| Egg | ✓ |
| Wheel | ✓ |
These may be enabled or disabled depending on the target. See here for the detail.
Package managers¶
Tunnel parses your files generated by package managers in filesystem/repository scanning.
pip¶
Dependency detection¶
By default, Tunnel only parses version specifiers with == comparison operator and without .*.
Using the --detection-priority comprehensive option ensures that the tool establishes a minimum version, which is particularly useful in scenarios where identifying the exact version is challenging.
In such case Tunnel parses specifiers >=,~= and a trailing .*.
keyring >= 4.1.1 # Minimum version 4.1.1
Mopidy-Dirble ~= 1.1 # Minimum version 1.1
python-gitlab==2.0.* # Minimum version 2.0.0
pip-compile tool (which doesn't install the packages)
or call pip freeze from the virtual environment where the requirements are already installed.
$ cat requirements.txt
boto3~=1.24.60
click>=8.0
json-fix==0.5.*
$ pip install -r requirements.txt
...
$ pip freeze > requirements.txt
$ cat requirements.txt
boto3==1.24.96
botocore==1.27.96
click==8.1.7
jmespath==1.0.1
json-fix==0.5.2
python-dateutil==2.8.2
s3transfer==0.6.2
setuptools==69.0.2
six==1.16.0
urllib3==1.26.18
wheel==0.42.0
requirements.txt files usually contain only the direct dependencies and not contain the transitive dependencies.
Therefore, Tunnel scans only for the direct dependencies with requirements.txt.
To detect transitive dependencies as well, you need to generate requirements.txt that contains them.
Like described above, tou can do it with pip freeze or pip-compile.
$ cat requirements.txt # it will only find `requests@2.28.2`.
requests==2.28.2
$ pip install -r requirements.txt
...
$ pip freeze > requirements.txt
$ cat requirements.txt # it will also find the transitive dependencies of `requests@2.28.2`.
certifi==2022.12.7
charset-normalizer==3.1.0
idna==3.4
PyJWT==2.1.0
requests==2.28.2
urllib3==1.26.15
pip freeze also helps to resolve extras(optional) dependencies (like package[extras]=0.0.0).
requirements.txt files don't contain information about dependencies used for development.
Tunnel could detect vulnerabilities on the development packages, which not affect your production environment.
License detection¶
requirements.txt files don't contain information about licenses.
Therefore, Tunnel checks METADATA files from lib/site-packages directory.
Tunnel uses 3 ways to detect site-packages directory:
- Checks
VIRTUAL_ENVenvironment variable. - Detects path to
python1 binary and checks../lib/pythonX.Y/site-packagesdirectory. - Detects path to
python1 binary and checks../../lib/site-packagesdirectory.
Pipenv¶
Tunnel parses Pipfile.lock.
Pipfile.lock files don't contain information about dependencies used for development.
Tunnel could detect vulnerabilities on the development packages, which not affect your production environment.
License detection is not supported for Pipenv.
Poetry¶
Tunnel uses poetry.lock to identify dependencies and find vulnerabilities.
To build the correct dependency graph, pyproject.toml also needs to be present next to poetry.lock.
License detection is not supported for Poetry.
By default, Tunnel doesn't report development dependencies. Use the --include-dev-deps flag to include them.
uv¶
Tunnel uses uv.lock to identify dependencies and find vulnerabilities.
License detection is not supported for uv.
By default, Tunnel doesn't report development dependencies. Use the --include-dev-deps flag to include them.
Packaging¶
Tunnel parses the manifest files of installed packages in container image scanning and so on. See here for the detail.
Egg¶
Tunnel looks for *.egg-info, *.egg-info/PKG-INFO, *.egg and EGG-INFO/PKG-INFO to identify Python packages.
Wheel¶
Tunnel looks for .dist-info/META-DATA to identify Python packages.