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# If 1 or more target triples (and optionally, target_features) are specified,
13# only the specified targets will be checked when running `cargo deny check`.
14# This means, if a particular package is only ever used as a target specific
15# dependency, such as, for example, the `nix` crate only being used via the
16# `target_family = "unix"` configuration, that only having windows targets in
17# this list would mean the nix crate, as well as any of its exclusive
18# dependencies not shared by any other crates, would be ignored, as the target
19# list here is effectively saying which targets you are building for.
20targets = [
21    # The triple can be any string, but only the target triples built in to
22    # rustc (as of 1.40) can be checked against actual config expressions
23    #{ triple = "x86_64-unknown-linux-musl" },
24    # You can also specify which target_features you promise are enabled for a
25    # particular target. target_features are currently not validated against
26    # the actual valid features supported by the target architecture.
27    #{ triple = "wasm32-unknown-unknown", features = ["atomics"] },
28]
29
30# This section is considered when running `cargo deny check advisories`
31# More documentation for the advisories section can be found here:
32# https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html
33[advisories]
34# The path where the advisory database is cloned/fetched into
35db-path = "~/.cargo/advisory-db"
36# The url(s) of the advisory databases to use
37db-urls = ["https://github.com/rustsec/advisory-db"]
38# The lint level for security vulnerabilities
39vulnerability = "deny"
40# The lint level for unmaintained crates
41unmaintained = "warn"
42# The lint level for crates that have been yanked from their source registry
43yanked = "warn"
44# The lint level for crates with security notices. Note that as of
45# 2019-12-17 there are no security notice advisories in
46# https://github.com/rustsec/advisory-db
47notice = "warn"
48# A list of advisory IDs to ignore. Note that ignored advisories will still
49# output a note when they are encountered.
50ignore = [
51    # criterion 0.4.0 depends on a version of atty w/unaligned reads
52]
53# Threshold for security vulnerabilities, any vulnerability with a CVSS score
54# lower than the range specified will be ignored. Note that ignored advisories
55# will still output a note when they are encountered.
56# * None - CVSS Score 0.0
57# * Low - CVSS Score 0.1 - 3.9
58# * Medium - CVSS Score 4.0 - 6.9
59# * High - CVSS Score 7.0 - 8.9
60# * Critical - CVSS Score 9.0 - 10.0
61#severity-threshold =
62
63# If this is true, then cargo deny will use the git executable to fetch advisory database.
64# If this is false, then it uses a built-in git library.
65# Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support.
66# See Git Authentication for more information about setting up git authentication.
67#git-fetch-with-cli = true
68
69# This section is considered when running `cargo deny check licenses`
70# More documentation for the licenses section can be found here:
71# https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html
72[licenses]
73# The lint level for crates which do not have a detectable license
74unlicensed = "deny"
75unused-allowed-license = "allow"
76# List of explicitly allowed licenses
77# See https://spdx.org/licenses/ for list of possible licenses
78# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
79allow = [
80    "MIT",
81    "Apache-2.0",
82    "Apache-2.0 WITH LLVM-exception",
83    "BSD-3-Clause",
84    "BSD-2-Clause",
85    "ISC",
86    "Unicode-DFS-2016",
87    "OpenSSL",
88    "Unlicense"
89]
90# List of explicitly disallowed licenses
91# See https://spdx.org/licenses/ for list of possible licenses
92# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
93deny = [
94    #"Nokia",
95]
96# Lint level for licenses considered copyleft
97copyleft = "warn"
98# Blanket approval or denial for OSI-approved or FSF Free/Libre licenses
99# * both - The license will be approved if it is both OSI-approved *AND* FSF
100# * either - The license will be approved if it is either OSI-approved *OR* FSF
101# * osi-only - The license will be approved if is OSI-approved *AND NOT* FSF
102# * fsf-only - The license will be approved if is FSF *AND NOT* OSI-approved
103# * neither - This predicate is ignored and the default lint level is used
104allow-osi-fsf-free = "neither"
105# Lint level used when no other predicates are matched
106# 1. License isn't in the allow or deny lists
107# 2. License isn't copyleft
108# 3. License isn't OSI/FSF, or allow-osi-fsf-free = "neither"
109default = "deny"
110# The confidence threshold for detecting a license from license text.
111# The higher the value, the more closely the license text must be to the
112# canonical license text of a valid SPDX license file.
113# [possible values: any between 0.0 and 1.0].
114confidence-threshold = 0.8
115# Allow 1 or more licenses on a per-crate basis, so that particular licenses
116# aren't accepted for every possible crate as with the normal allow list
117exceptions = [
118    # Each entry is the crate and version constraint, and its specific allow
119    # list
120    #{ allow = ["Zlib"], name = "adler32", version = "*" },
121]
122
123# Some crates don't have (easily) machine readable licensing information,
124# adding a clarification entry for it allows you to manually specify the
125# licensing information
126#[[licenses.clarify]]
127# The name of the crate the clarification applies to
128#name = "ring"
129# The optional version constraint for the crate
130#version = "*"
131# The SPDX expression for the license requirements of the crate
132#expression = "MIT AND ISC AND OpenSSL"
133# One or more files in the crate's source used as the "source of truth" for
134# the license expression. If the contents match, the clarification will be used
135# when running the license check, otherwise the clarification will be ignored
136# and the crate will be checked normally, which may produce warnings or errors
137# depending on the rest of your configuration
138#license-files = [
139    # Each entry is a crate relative path, and the (opaque) hash of its contents
140    #{ path = "LICENSE", hash = 0xbd0eed23 }
141#]
142
143[[licenses.clarify]]
144name = "ring"
145version = "*"
146expression = "MIT AND ISC AND OpenSSL"
147license-files = [
148    # Each entry is a crate relative path, and the (opaque) hash of its contents
149    { path = "LICENSE", hash = 0xbd0eed23 }
150]
151
152[licenses.private]
153# If true, ignores workspace crates that aren't published, or are only
154# published to private registries.
155# To see how to mark a crate as unpublished (to the official registry),
156# visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field.
157ignore = true
158# One or more private registries that you might publish crates to, if a crate
159# is only published to private registries, and ignore is true, the crate will
160# not have its license(s) checked
161registries = [
162    #"https://sekretz.com/registry
163]
164
165# This section is considered when running `cargo deny check bans`.
166# More documentation about the 'bans' section can be found here:
167# https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html
168[bans]
169# Lint level for when multiple versions of the same crate are detected
170multiple-versions = "allow"
171# Lint level for when a crate version requirement is `*`
172wildcards = "allow"
173# The graph highlighting used when creating dotgraphs for crates
174# with multiple versions
175# * lowest-version - The path to the lowest versioned duplicate is highlighted
176# * simplest-path - The path to the version with the fewest edges is highlighted
177# * all - Both lowest-version and simplest-path are used
178highlight = "all"
179# List of crates that are allowed. Use with care!
180allow = [
181    #{ name = "ansi_term", version = "=0.11.0" },
182]
183# List of crates to deny
184deny = [
185    # Each entry the name of a crate and a version range. If version is
186    # not specified, all versions will be matched.
187    #{ name = "ansi_term", version = "=0.11.0" },
188    #
189    # Wrapper crates can optionally be specified to allow the crate when it
190    # is a direct dependency of the otherwise banned crate
191    #{ name = "ansi_term", version = "=0.11.0", wrappers = [] },
192]
193# Certain crates/versions that will be skipped when doing duplicate detection.
194skip = [
195    #{ name = "ansi_term", version = "=0.11.0" },
196]
197# Similarly to `skip` allows you to skip certain crates during duplicate
198# detection. Unlike skip, it also includes the entire tree of transitive
199# dependencies starting at the specified crate, up to a certain depth, which is
200# by default infinite
201skip-tree = [
202    #{ name = "ansi_term", version = "=0.11.0", depth = 20 },
203]
204
205# This section is considered when running `cargo deny check sources`.
206# More documentation about the 'sources' section can be found here:
207# https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html
208[sources]
209# Lint level for what to happen when a crate from a crate registry that is not
210# in the allow list is encountered
211unknown-registry = "warn"
212# Lint level for what to happen when a crate from a git repository that is not
213# in the allow list is encountered
214unknown-git = "warn"
215# List of URLs for allowed crate registries. Defaults to the crates.io index
216# if not specified. If it is specified but empty, no registries are allowed.
217allow-registry = ["https://github.com/rust-lang/crates.io-index"]
218# List of URLs for allowed Git repositories
219allow-git = []