Skip to content

Commit e0fea37

Browse files
committed
ci: add cargo audit and deny configs
1 parent 7e4861b commit e0fea37

File tree

3 files changed

+278
-3
lines changed

3 files changed

+278
-3
lines changed

.cargo/audit.toml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# All of the options which can be passed via CLI arguments can also be
2+
# permanently specified in this file.
3+
4+
[advisories]
5+
6+
ignore = [""]
7+
informational_warnings = ["unmaintained"]
8+
severity_threshold = "medium"
9+
10+
# Advisory Database Configuration
11+
[database]
12+
path = ".cargo/advisory-db" # Path where advisory git repo will be cloned
13+
url = "https://github.com/RustSec/advisory-db.git" # URL to git repo
14+
fetch = true # Perform a `git fetch` before auditing (default: true)
15+
stale = false # Allow stale advisory DB (i.e. no commits for 90 days, default: false)
16+
17+
# Output Configuration
18+
[output]
19+
deny = [] # exit on error if unmaintained dependencies are found
20+
format = "terminal" # "terminal" (human readable report) or "json"
21+
quiet = false # Only print information on error
22+
show_tree = false # Show inverse dependency trees along with advisories (default: true)
23+
24+
# Target Configuration
25+
[target]
26+
os = "linux"
27+
# arch = "x86_64"
28+
29+
[yanked]
30+
enabled = true # Warn for yanked crates in Cargo.lock (default: true)
31+
update_index = true # Auto-update the crates.io index (default: true)

.cargo/deny.toml

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

.github/workflows/dependency_analysis.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ jobs:
3939
run: cargo-deny deny check license --deny license-not-encountered
4040
working-directory: fhevm-engine
4141

42-
# - name: Security issue whitelist
43-
# run: cargo-audit audit
44-
# working-directory: fhevm-engine
42+
- name: Security issue whitelist
43+
run: cargo-audit audit
44+
working-directory: fhevm-engine
4545

4646
permissions:
4747
contents: read

0 commit comments

Comments
 (0)