cargo-audit
Audit your Rust project
Cargo Audit
Cargo Audit is a crucial tool for Rust developers to ensure the security of their projects. It scans your project's dependencies, defined in the Cargo.lock file, against the comprehensive RustSec Advisory Database to identify known vulnerabilities.
Secure Your Rust Dependencies
Maintaining a secure software supply chain is paramount. Cargo Audit helps you proactively identify and address potential security risks introduced by third-party crates. By regularly auditing your dependencies, you can prevent exploitation of known vulnerabilities.
Key Cargo Audit Commands
Here are some common ways to use Cargo Audit:
# Audit the `Cargo.lock` file for vulnerabilities using the RustSec Advisory Database
cargo audit
# Ignore a specific vulnerability using its advisory ID (e.g., RUSTSEC-YYYY-XXXX)
cargo audit --ignore RUSTSEC-YYYY-XXXX
# Produce a JSON output of the audit results for programmatic processing
cargo audit --json
# Fetch the latest vulnerability database before auditing to ensure up-to-date checks
cargo audit update && cargo audit
# Audit using a specific advisory database URL (useful for custom or local databases)
cargo audit --url https://example.com/advisory-db
# Output a warning message if there are outdated crates, prompting for updates
cargo audit --warn-outdated
# Silence all output except for critical errors, useful in automated scripts
cargo audit --quiet
# Limit the number of threads for concurrent network requests, useful for managing resources
cargo audit --jobs NUM_THREADS
Understanding Vulnerability Reports
When Cargo Audit finds a vulnerability, it provides details about the affected crate, the severity of the vulnerability, and often a link to more information. It's recommended to address high-severity vulnerabilities immediately.
Best Practices for Dependency Security
Integrate Cargo Audit into your CI/CD pipeline to automatically check for vulnerabilities on every build or commit. Regularly update your dependencies to benefit from security patches and improvements. For more information on Rust security best practices, refer to the official Rust documentation and the RustSec Advisory Database.