| # RustSec: `rustsec` crate |
| |
| [![Latest Version][crate-image]][crate-link] |
| [![Docs][docs-image]][docs-link] |
| [![Build Status][build-image]][build-link] |
| [![Safety Dance][safety-image]][safety-link] |
| ![MSRV][rustc-image] |
| ![Apache 2.0 OR MIT licensed][license-image] |
| [![Project Chat][chat-image]][chat-link] |
| |
| Client library for accessing the [RustSec Security Advisory Database]: |
| fetches the [advisory-db] (or other compatible) git repository and |
| audits `Cargo.lock` files against it. |
| |
| [Documentation] |
| |
| ## About |
| |
| The `rustsec` crate is primarily intended to be used by the [cargo-audit] crate |
| for the purposes of identifying vulnerable crates in Cargo.lock files. |
| |
| However, it may be useful if you would like to consume the RustSec advisory |
| database in other capacities. |
| |
| ## Minimum Supported Rust Version |
| |
| Rust **1.67** or higher. |
| |
| Minimum supported Rust version can be changed in the future, but it will be |
| done with a minor version bump. |
| |
| ## License |
| |
| Licensed under either of: |
| |
| - Apache License, Version 2.0 ([LICENSE-APACHE] or <https://www.apache.org/licenses/LICENSE-2.0>) |
| - MIT license ([LICENSE-MIT] or <https://opensource.org/licenses/MIT>) |
| |
| at your option. |
| |
| ### Contribution |
| |
| Unless you explicitly state otherwise, any contribution intentionally submitted |
| for inclusion in the work by you shall be dual licensed as above, without any |
| additional terms or conditions. |
| |
| [//]: # (badges) |
| |
| [crate-image]: https://buildstats.info/crate/rustsec |
| [crate-link]: https://crates.io/crates/rustsec |
| [docs-image]: https://docs.rs/rustsec/badge.svg |
| [docs-link]: https://docs.rs/rustsec/ |
| [build-image]: https://github.com/RustSec/rustsec/actions/workflows/rustsec.yml/badge.svg |
| [build-link]: https://github.com/RustSec/rustsec/actions/workflows/rustsec.yml |
| [safety-image]: https://img.shields.io/badge/unsafe-forbidden-success.svg |
| [safety-link]: https://github.com/rust-secure-code/safety-dance/ |
| [rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg |
| [license-image]: https://img.shields.io/badge/license-Apache2.0%2FMIT-blue.svg |
| [chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg |
| [chat-link]: https://rust-lang.zulipchat.com/#narrow/stream/146229-wg-secure-code/ |
| |
| [//]: # (general links) |
| |
| [RustSec Security Advisory Database]: https://rustsec.org/ |
| [advisory-db]: https://github.com/RustSec/advisory-db |
| [Documentation]: https://docs.rs/rustsec/ |
| [cargo-audit]: https://github.com/rustsec/cargo-audit |
| [LICENSE-APACHE]: https://github.com/RustSec/rustsec-crate/blob/main/LICENSE-APACHE |
| [LICENSE-MIT]: https://github.com/RustSec/rustsec-crate/blob/main/LICENSE-MIT |
