Scan your uv.lock file for dependencies with known vulnerabilities.
This tool will scan PyPi dependencies listed in your uv.lock files (or uv generated requirements.txt files) and check for known vulnerabilities listed against those packages and versions in the PyPi json API. Since it is making network requests for each PyPi package this can be a relatively slow tool to run, and it will only work in test environments with access to the PyPi API. Currently only packages sourced from PyPi are tested - there's no support for custom packages or packages stored in private PyPi servers. See roadmap below for my plans for future enhancements.
I don't intend uv-secure to ever create virtual environments or do dependency resolution - the plan is to leave that all to uv since it does that so well and just target lock files and fully pinned and dependency resolved requirements.txt files). If you want a tool that does dependency resolution on requirements.txt files for first order and unpinned dependencies I recommend using pip-audit instead.
This tool is still in an alpha phase and although it's unlikely to lose functionality arguments may get changed with no deprecation warning. I'm still in the process of refining the command line arguments and configuration behaviour.
I recommend installing uv-secure as a uv tool or with pipx as it's intended to be used as a CLI tool, and it probably only makes sense to have one version installed globally.
Installing with uv tool as follows:
uv tool install uv-secureor with pipx:
pipx install uv-secureyou can optionally install uv-secure as a development dependency in a virtual environment.
uv-secure uses highly asynchronous code to request multiple API responses or file opens concurrently. You can install uvloop on Linux/Mac or winloop on Windows to speed up the asynchronous event loop (at the expense of debuggability if you want to develop uv-secure yourself). Also note, winloop is a relatively young package and may give you some stability issues on particular versions of Python
If you want to install the optional dependency with uv do it like this:
uv tool install uv-secure --with uvloopor with pipx like this:
pipx install uv-secure
pipx inject uv-secure winloopuv-secure will automatically use uvloop or winloop if it finds them in the same environment as itself.
After installation, you can run uv-secure --help to see the options.
>> uv-secure --help
Usage: run.py [OPTIONS] [FILE_PATHS]...
Parse uv.lock files, check vulnerabilities, and display summary.
╭─ Arguments ──────────────────────────────────────────────────────────────────────────╮
│ file_paths [FILE_PATHS]... Paths to the uv.lock or uv generated │
│ requirements.txt files or a single project root │
│ level directory (defaults to working directory if │
│ not set) │
│ [default: None] │
╰──────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────────────╮
│ --aliases Flag whether to include vulnerability aliases │
│ in the vulnerabilities table │
│ --desc Flag whether to include vulnerability │
│ detailed description in the vulnerabilities │
│ table │
│ --disable-cache Flag whether to disable caching for │
│ vulnerability http requests │
│ --forbid-yanked Flag whether disallow yanked package versions │
│ from being dependencies │
│ --max-age-days INTEGER Maximum age threshold for packages in days │
│ [default: None] │
│ --ignore -i TEXT Comma-separated list of vulnerability IDs to │
│ ignore, e.g. VULN-123,VULN-456 │
│ [default: None] │
│ --config PATH Optional path to a configuration file │
│ (uv-secure.toml, .uv-secure.toml, or │
│ pyproject.toml) │
│ [default: None] │
│ --version Show the application's version │
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to │
│ copy it or customize the installation. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────╯
>> uv-secure
Checking dependencies for vulnerabilities...
╭───────────────────────────────╮
│ No vulnerabilities detected! │
│ Checked: 160 dependencies │
│ All dependencies appear safe! │
╰───────────────────────────────╯
uv-secure can read configuration from a toml file specified with the config option. E.g.
ignore_vulnerabilities = ["VULN-123"]
aliases = true # Defaults to false
desc = true # Defaults to false
[cache_settings]
cache_path = "~/.uv-secure" # Defaults to ~/.cache/uv-secure if not set
ttl_seconds = 60.0 # Defaults to one day (86400 seconds) if not set
disable_cache = false # Defaults to false if not set
[maintainability_criteria]
# max_package_age takes numeric seconds or an ISO8601 duration string
max_package_age = "P1000D" # Defaults to None if not set (no age limit)
forbid_yanked = true # Defaults to false (allow yanked package dependencies) if not set[tool.uv-secure]
ignore_vulnerabilities = ["VULN-123"]
aliases = true # Defaults to false
desc = true # Defaults to false
[tool.uv-secure.cache_settings]
cache_path = "~/.uv-secure" # Defaults to ~/.cache/uv-secure if not set
ttl_seconds = 60.0 # Defaults to one day (86400 seconds) if not set
disable_cache = false # Defaults to false if not set
[tool.uv-secure.maintainability_criteria]
# max_package_age takes numeric seconds or an ISO8601 duration string
max_package_age = "P1000D" # Defaults to None (no max age) if not set
forbid_yanked = true # Defaults to false (allow yanked package dependencies) if not setFile caching is enabled by default to speed up subsequent runs of uv-secure. By default, cache results are saved to:
~/.cache/uv-secureor on Windows
%USERPROFILE%\.cache\uv-secureThis can be configured to another location if you wish.
I'm unsure about other operating systems, but I found on Windows unless I excluded the cache directory from the Virus & threat protection settings the file caching only made a minimal performance improvement on subsequent runs (whereas it can speed up subsequent runs over 50% if you add the cache directory as an exclusion).
If the ignore and config options are left unset uv-secure will search for configuration files above each uv.lock file and use the deepest found pyproject.toml, uv-secure.toml, or .uv-secure.toml for the configuration when processing that specific uv.lock file. uv-secure tries to follow Ruff's configuration file discovery strategy
Similar to Ruff, pyproject.toml files that don't contain uv-secure configuration are ignored. Currently, if multiple uv-secure configuration files are defined in the same directory upstream from a uv.lock file the configurations are used in this precedence order:
- .uv-secure.toml
- uv-secure.toml
- pyproject.toml (assuming it contains uv-secure configuration)
So .uv-secure.toml files are used first, then uv-secure.toml files, and last pyproject.toml files with uv-secure config (only if you define all three in the same directory though - which would be a bit weird - I may make this a warning or error in future).
Like Ruff configuration files aren't hierarchically combined, just the nearest / highest precedence configuration is used. If you set a specific configuration file that will take precedence and hierarchical configuration file discovery is disabled. If you do specify a configuration options directly, e.g. pass the --ignore option that will overwrite the ignore_vulnerabilities setting of all found or manually specified configuration files.
uv-secure can be run as a pre-commit hook by adding this configuration to your .pre-commit-config.yaml file:
- repo: https://github.com/owenlamont/uv-secure
rev: 0.8.0
hooks:
- id: uv-secureYou should run:
pre-commit autoupdateOr manually check the latest release and update the rev value accordingly.
Below are some ideas (in no particular order) I have for improving uv-secure:
- Package for conda on conda-forge
- Integrate with GitHub / GitLab / BitBucket for additional maintenance metrics
- Add rate limiting on how hard the PyPi json API is hit to query package vulnerabilities (this hasn't been a problem yet, but I suspect may be for uv.lock files with many dependencies)
- Add support for other lock file formats beyond uv.lock
- Support some of the other output file formats pip-audit does
- Consider adding support for scanning dependencies from the current venv
- Add a severity threshold option for reporting vulnerabilities against
- Add an autofix option for updating package versions with known vulnerabilities if there is a more recent fixed version
- Investigate supporting private PyPi repos
- Add translations to support languages beyond English (not sure of the merits of this given most vulnerability reports appear to be only in English but happy to take feedback on this)
Running uv-secure as a developer is pretty straight-forward if you have uv installed. Just check out the repo and from a terminal in the repo root directory run:
uv sync --devTo create and sync the virtual environment.
You can run the tests with:
uv run pytestOr run the package entry module directly with:
uv run src/uv_secure/run.py . --aliasesIf you want to run and debug uv-secure in an IDE like PyCharm or VSCode select the virtual environment in the local .venv directory uv would have created after calling uv sync.
With PyCharm debugging relies on pip and setuptools being installed which aren't installed by default, so I request PyCharm Install packaging tool in the Python Interpreter settings (I may just add these in future are dev dependencies to reduce the friction if this causes others too much pain). I have also encountered some test failures on Windows if you use winloop with setuptools and pip - so you probably do want to remove winloop if debugging in that environment if you added it.
Given uv-secure is often IO bound waiting on API responses or file reads I've tried to make it as asynchronous as I can. uv-secure also uses uvloop and winloop if installed which should be more performant than the vanilla asyncio event loop - but they don't play nice with Python debuggers. If you intend to do debugging I suggest leaving them out of the virtual environment. By default, winloop or uvloop won't be installed the repo venv unless you explicitly add them.
I created this package as I wanted a dependency vulnerability scanner, but I wasn't completely happy with the options that were available. I use uv and wanted something that works with uv.lock files but neither of the main package options I found were as frictionless as I had hoped:
- pip-audit uv-secure is very much based on doing the same vulnerability check that pip-audit does using PyPi's json API. pip-audit however only works with requirements.txt so to make it work with uv projects you need additional steps to convert your uv.lock file to a requirements.txt then you need to run pip-audit with the --no-deps and/or --no-pip options to stop pip-audit trying to create a virtual environment from the requirements.txt file. In short, you can use pip-audit instead of uv-secure albeit with a bit more friction for uv projects. I hope to add extra features beyond what pip-audit does or optimise things better (given the more specialised case of only needing to support uv.lock files) in the future.
- safety also doesn't work with uv.lock file out of the box, it does apparently work statically without needing to build a virtual environment but it does require you to create an account on the safety site. They have some limited free account but require a paid account to use seriously. If you already have a safety account though there is a uv-audit package that wraps safety to support scanning uv.lock files.
- Python Security PyCharm Plugin Lastly I was inspired by Anthony Shaw's Python Security plugin - which does CVE dependency scanning within PyCharm.
I build uv-secure because I wanted a CLI tool I could run with pre-commit. Statically analyse the uv.lock file without needing to create a virtual environment, and finally doesn't require you to create (and pay for) an account with any service.
Please raise issues for any bugs you discover with uv-secure. If practical and not too sensitive sharing the problem uv.lock file would help me reproduce and fix these issues.
I welcome PRs for minor fixes and documentation tweaks. If you'd like to make more substantial contributions please reach out by email / social media / or raise an improvement issue to discuss first to make sure our plans are aligned before creating any large / time-expensive PRs.
See the contributing guide for more details on contributing to uv-secure
