Skip to content

Commit 5e76f34

Browse files
committed
Auto merge of #11761 - epage:deny, r=weihanglo
chore(ci): Enforce cargo-deny in CI With #11448, we are pulling in a wide and deep dependency tree which makes it harder for us to track what we are pulling in over time. I've been trying out [`cargo-deny`](https://github.com/EmbarkStudios/cargo-deny) on my projects and wanted to explore how useful it might be for cargo. atm I only have it configured to fail for unexpected licenses. We can also use its warnings to hunt down and remove duplicated dependencies to speed up our builds. I did also enable advisories. We ignore the failure in a way to not block PRs or even show up as failure in PRs as PR authors are not responsible for dealing with these (unless its a new dep) and it can be intimidating as a contributor to see a failure and have no idea how to resolve it (as authors generally assume CI is green and failures are there fault) I did not go too much further into what all `cargo-deny` can do; there might be more we can leverage.
2 parents 2dcdf1e + f08bcd9 commit 5e76f34

File tree

2 files changed

+303
-0
lines changed

2 files changed

+303
-0
lines changed

.github/workflows/audit.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Security audit
2+
3+
permissions:
4+
contents: read
5+
6+
on:
7+
pull_request:
8+
paths:
9+
- '**/Cargo.toml'
10+
- '**/Cargo.lock'
11+
push:
12+
branches:
13+
- master
14+
15+
jobs:
16+
cargo_deny:
17+
runs-on: ubuntu-latest
18+
strategy:
19+
matrix:
20+
checks:
21+
- advisories
22+
- bans licenses sources
23+
steps:
24+
- uses: actions/checkout@v3
25+
- uses: EmbarkStudios/cargo-deny-action@v1
26+
# Prevent sudden announcement of a new advisory from failing ci:
27+
continue-on-error: ${{ matrix.checks == 'advisories' }}
28+
with:
29+
command: check ${{ matrix.checks }}
30+
rust-version: stable

deny.toml

Lines changed: 273 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,273 @@
1+
# This template contains all of the possible sections and their default values
2+
3+
# Note that all fields that take a lint level have these possible values:
4+
# * deny - An error will be produced and the check will fail
5+
# * warn - A warning will be produced, but the check will not fail
6+
# * allow - No warning or error will be produced, though in some cases a note
7+
# will be
8+
9+
# The values provided in this template are the default values that will be used
10+
# when any section or field is not specified in your own configuration
11+
12+
# Root options
13+
14+
# If 1 or more target triples (and optionally, target_features) are specified,
15+
# only the specified targets will be checked when running `cargo deny check`.
16+
# This means, if a particular package is only ever used as a target specific
17+
# dependency, such as, for example, the `nix` crate only being used via the
18+
# `target_family = "unix"` configuration, that only having windows targets in
19+
# this list would mean the nix crate, as well as any of its exclusive
20+
# dependencies not shared by any other crates, would be ignored, as the target
21+
# list here is effectively saying which targets you are building for.
22+
targets = [
23+
# The triple can be any string, but only the target triples built in to
24+
# rustc (as of 1.40) can be checked against actual config expressions
25+
#{ triple = "x86_64-unknown-linux-musl" },
26+
# You can also specify which target_features you promise are enabled for a
27+
# particular target. target_features are currently not validated against
28+
# the actual valid features supported by the target architecture.
29+
#{ triple = "wasm32-unknown-unknown", features = ["atomics"] },
30+
]
31+
# When creating the dependency graph used as the source of truth when checks are
32+
# executed, this field can be used to prune crates from the graph, removing them
33+
# from the view of cargo-deny. This is an extremely heavy hammer, as if a crate
34+
# is pruned from the graph, all of its dependencies will also be pruned unless
35+
# they are connected to another crate in the graph that hasn't been pruned,
36+
# so it should be used with care. The identifiers are [Package ID Specifications]
37+
# (https://doc.rust-lang.org/cargo/reference/pkgid-spec.html)
38+
#exclude = []
39+
# If true, metadata will be collected with `--all-features`. Note that this can't
40+
# be toggled off if true, if you want to conditionally enable `--all-features` it
41+
# is recommended to pass `--all-features` on the cmd line instead
42+
all-features = false
43+
# If true, metadata will be collected with `--no-default-features`. The same
44+
# caveat with `all-features` applies
45+
no-default-features = false
46+
# If set, these feature will be enabled when collecting metadata. If `--features`
47+
# is specified on the cmd line they will take precedence over this option.
48+
#features = []
49+
# When outputting inclusion graphs in diagnostics that include features, this
50+
# option can be used to specify the depth at which feature edges will be added.
51+
# This option is included since the graphs can be quite large and the addition
52+
# of features from the crate(s) to all of the graph roots can be far too verbose.
53+
# This option can be overridden via `--feature-depth` on the cmd line
54+
feature-depth = 1
55+
56+
# This section is considered when running `cargo deny check advisories`
57+
# More documentation for the advisories section can be found here:
58+
# https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html
59+
[advisories]
60+
# The path where the advisory database is cloned/fetched into
61+
db-path = "~/.cargo/advisory-db"
62+
# The url(s) of the advisory databases to use
63+
db-urls = ["https://github.com/rustsec/advisory-db"]
64+
# The lint level for security vulnerabilities
65+
vulnerability = "deny"
66+
# The lint level for unmaintained crates
67+
unmaintained = "warn"
68+
# The lint level for crates that have been yanked from their source registry
69+
yanked = "warn"
70+
# The lint level for crates with security notices. Note that as of
71+
# 2019-12-17 there are no security notice advisories in
72+
# https://github.com/rustsec/advisory-db
73+
notice = "warn"
74+
# A list of advisory IDs to ignore. Note that ignored advisories will still
75+
# output a note when they are encountered.
76+
ignore = [
77+
#"RUSTSEC-0000-0000",
78+
]
79+
# Threshold for security vulnerabilities, any vulnerability with a CVSS score
80+
# lower than the range specified will be ignored. Note that ignored advisories
81+
# will still output a note when they are encountered.
82+
# * None - CVSS Score 0.0
83+
# * Low - CVSS Score 0.1 - 3.9
84+
# * Medium - CVSS Score 4.0 - 6.9
85+
# * High - CVSS Score 7.0 - 8.9
86+
# * Critical - CVSS Score 9.0 - 10.0
87+
#severity-threshold =
88+
89+
# If this is true, then cargo deny will use the git executable to fetch advisory database.
90+
# If this is false, then it uses a built-in git library.
91+
# Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support.
92+
# See Git Authentication for more information about setting up git authentication.
93+
#git-fetch-with-cli = true
94+
95+
# This section is considered when running `cargo deny check licenses`
96+
# More documentation for the licenses section can be found here:
97+
# https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html
98+
[licenses]
99+
# The lint level for crates which do not have a detectable license
100+
unlicensed = "deny"
101+
# List of explicitly allowed licenses
102+
# See https://spdx.org/licenses/ for list of possible licenses
103+
# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
104+
allow = [
105+
"MIT",
106+
"MIT-0",
107+
"Apache-2.0",
108+
"BSD-3-Clause",
109+
"MPL-2.0",
110+
"Unicode-DFS-2016",
111+
"CC0-1.0",
112+
]
113+
# List of explicitly disallowed licenses
114+
# See https://spdx.org/licenses/ for list of possible licenses
115+
# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
116+
deny = [
117+
#"Nokia",
118+
]
119+
# Lint level for licenses considered copyleft
120+
copyleft = "warn"
121+
# Blanket approval or denial for OSI-approved or FSF Free/Libre licenses
122+
# * both - The license will be approved if it is both OSI-approved *AND* FSF
123+
# * either - The license will be approved if it is either OSI-approved *OR* FSF
124+
# * osi-only - The license will be approved if is OSI-approved *AND NOT* FSF
125+
# * fsf-only - The license will be approved if is FSF *AND NOT* OSI-approved
126+
# * neither - This predicate is ignored and the default lint level is used
127+
allow-osi-fsf-free = "neither"
128+
# Lint level used when no other predicates are matched
129+
# 1. License isn't in the allow or deny lists
130+
# 2. License isn't copyleft
131+
# 3. License isn't OSI/FSF, or allow-osi-fsf-free = "neither"
132+
default = "deny"
133+
# The confidence threshold for detecting a license from license text.
134+
# The higher the value, the more closely the license text must be to the
135+
# canonical license text of a valid SPDX license file.
136+
# [possible values: any between 0.0 and 1.0].
137+
confidence-threshold = 0.8
138+
# Allow 1 or more licenses on a per-crate basis, so that particular licenses
139+
# aren't accepted for every possible crate as with the normal allow list
140+
exceptions = [
141+
# Each entry is the crate and version constraint, and its specific allow
142+
# list
143+
#{ allow = ["Zlib"], name = "adler32", version = "*" },
144+
]
145+
146+
# Some crates don't have (easily) machine readable licensing information,
147+
# adding a clarification entry for it allows you to manually specify the
148+
# licensing information
149+
#[[licenses.clarify]]
150+
# The name of the crate the clarification applies to
151+
#name = "ring"
152+
# The optional version constraint for the crate
153+
#version = "*"
154+
# The SPDX expression for the license requirements of the crate
155+
#expression = "MIT AND ISC AND OpenSSL"
156+
# One or more files in the crate's source used as the "source of truth" for
157+
# the license expression. If the contents match, the clarification will be used
158+
# when running the license check, otherwise the clarification will be ignored
159+
# and the crate will be checked normally, which may produce warnings or errors
160+
# depending on the rest of your configuration
161+
#license-files = [
162+
# Each entry is a crate relative path, and the (opaque) hash of its contents
163+
#{ path = "LICENSE", hash = 0xbd0eed23 }
164+
#]
165+
166+
[licenses.private]
167+
# If true, ignores workspace crates that aren't published, or are only
168+
# published to private registries.
169+
# To see how to mark a crate as unpublished (to the official registry),
170+
# visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field.
171+
ignore = false
172+
# One or more private registries that you might publish crates to, if a crate
173+
# is only published to private registries, and ignore is true, the crate will
174+
# not have its license(s) checked
175+
registries = [
176+
#"https://sekretz.com/registry
177+
]
178+
179+
# This section is considered when running `cargo deny check bans`.
180+
# More documentation about the 'bans' section can be found here:
181+
# https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html
182+
[bans]
183+
# Lint level for when multiple versions of the same crate are detected
184+
multiple-versions = "warn"
185+
# Lint level for when a crate version requirement is `*`
186+
wildcards = "allow"
187+
# The graph highlighting used when creating dotgraphs for crates
188+
# with multiple versions
189+
# * lowest-version - The path to the lowest versioned duplicate is highlighted
190+
# * simplest-path - The path to the version with the fewest edges is highlighted
191+
# * all - Both lowest-version and simplest-path are used
192+
highlight = "all"
193+
# The default lint level for `default` features for crates that are members of
194+
# the workspace that is being checked. This can be overriden by allowing/denying
195+
# `default` on a crate-by-crate basis if desired.
196+
workspace-default-features = "allow"
197+
# The default lint level for `default` features for external crates that are not
198+
# members of the workspace. This can be overriden by allowing/denying `default`
199+
# on a crate-by-crate basis if desired.
200+
external-default-features = "allow"
201+
# List of crates that are allowed. Use with care!
202+
allow = [
203+
#{ name = "ansi_term", version = "=0.11.0" },
204+
]
205+
# List of crates to deny
206+
deny = [
207+
# Each entry the name of a crate and a version range. If version is
208+
# not specified, all versions will be matched.
209+
#{ name = "ansi_term", version = "=0.11.0" },
210+
#
211+
# Wrapper crates can optionally be specified to allow the crate when it
212+
# is a direct dependency of the otherwise banned crate
213+
#{ name = "ansi_term", version = "=0.11.0", wrappers = [] },
214+
]
215+
216+
# List of features to allow/deny
217+
# Each entry the name of a crate and a version range. If version is
218+
# not specified, all versions will be matched.
219+
#[[bans.features]]
220+
#name = "reqwest"
221+
# Features to not allow
222+
#deny = ["json"]
223+
# Features to allow
224+
#allow = [
225+
# "rustls",
226+
# "__rustls",
227+
# "__tls",
228+
# "hyper-rustls",
229+
# "rustls",
230+
# "rustls-pemfile",
231+
# "rustls-tls-webpki-roots",
232+
# "tokio-rustls",
233+
# "webpki-roots",
234+
#]
235+
# If true, the allowed features must exactly match the enabled feature set. If
236+
# this is set there is no point setting `deny`
237+
#exact = true
238+
239+
# Certain crates/versions that will be skipped when doing duplicate detection.
240+
skip = [
241+
#{ name = "ansi_term", version = "=0.11.0" },
242+
]
243+
# Similarly to `skip` allows you to skip certain crates during duplicate
244+
# detection. Unlike skip, it also includes the entire tree of transitive
245+
# dependencies starting at the specified crate, up to a certain depth, which is
246+
# by default infinite.
247+
skip-tree = [
248+
#{ name = "ansi_term", version = "=0.11.0", depth = 20 },
249+
]
250+
251+
# This section is considered when running `cargo deny check sources`.
252+
# More documentation about the 'sources' section can be found here:
253+
# https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html
254+
[sources]
255+
# Lint level for what to happen when a crate from a crate registry that is not
256+
# in the allow list is encountered
257+
unknown-registry = "warn"
258+
# Lint level for what to happen when a crate from a git repository that is not
259+
# in the allow list is encountered
260+
unknown-git = "warn"
261+
# List of URLs for allowed crate registries. Defaults to the crates.io index
262+
# if not specified. If it is specified but empty, no registries are allowed.
263+
allow-registry = ["https://github.com/rust-lang/crates.io-index"]
264+
# List of URLs for allowed Git repositories
265+
allow-git = []
266+
267+
[sources.allow-org]
268+
# 1 or more github.com organizations to allow git sources for
269+
github = []
270+
# 1 or more gitlab.com organizations to allow git sources for
271+
gitlab = []
272+
# 1 or more bitbucket.org organizations to allow git sources for
273+
bitbucket = []

0 commit comments

Comments
 (0)