/ deny.toml
deny.toml
  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 = 0
 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/advisory-db"
 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      { id = "RUSTSEC-2024-0370", reason = "TODO" },
 74      { id = "RUSTSEC-2024-0388", reason = "TODO" },
 75      { id = "RUSTSEC-2023-0071", reason = "TODO: fix unreleased" },
 76  ]
 77  # If this is true, then cargo deny will use the git executable to fetch advisory database.
 78  # If this is false, then it uses a built-in git library.
 79  # Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support.
 80  # See Git Authentication for more information about setting up git authentication.
 81  #git-fetch-with-cli = true
 82  
 83  # This section is considered when running `cargo deny check licenses`
 84  # More documentation for the licenses section can be found here:
 85  # https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html
 86  [licenses]
 87  # List of explicitly allowed licenses
 88  # See https://spdx.org/licenses/ for list of possible licenses
 89  # [possible values: any SPDX 3.11 short identifier (+ optional exception)].
 90  allow = [
 91      "Apache-2.0",
 92      "Apache-2.0 WITH LLVM-exception",
 93      "MIT",
 94      "MPL-2.0",
 95      "BSD-3-Clause",
 96      "ISC",
 97      "CC0-1.0",
 98      "Unlicense",
 99      "MITNFA",
100      "Unicode-3.0",
101      "Zlib",
102      "OpenSSL"
103  ]
104  # The confidence threshold for detecting a license from license text.
105  # The higher the value, the more closely the license text must be to the
106  # canonical license text of a valid SPDX license file.
107  # [possible values: any between 0.0 and 1.0].
108  confidence-threshold = 0.8
109  # Allow 1 or more licenses on a per-crate basis, so that particular licenses
110  # aren't accepted for every possible crate as with the normal allow list
111  exceptions = [
112      { allow = [
113          "Zlib",
114      ], name = "tinyvec" },
115      { allow = [
116          "Zlib",
117      ], name = "slotmap" },
118      { allow = [
119          "Unicode-DFS-2016",
120      ], name = "unicode-ident" },
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 package spec the clarification applies to
128  #crate = "ring"
129  # The SPDX expression for the license requirements of the crate
130  #expression = "MIT AND ISC AND OpenSSL"
131  # One or more files in the crate's source used as the "source of truth" for
132  # the license expression. If the contents match, the clarification will be used
133  # when running the license check, otherwise the clarification will be ignored
134  # and the crate will be checked normally, which may produce warnings or errors
135  # depending on the rest of your configuration
136  #license-files = [
137  # Each entry is a crate relative path, and the (opaque) hash of its contents
138  #{ path = "LICENSE", hash = 0xbd0eed23 }
139  #]
140  
141  [[licenses.clarify]]
142  crate = "ring"
143  expression = "MIT AND ISC AND OpenSSL"
144  license-files = [
145      { path = "LICENSE", hash = 0xbd0eed23 }
146  ]
147  
148  [licenses.private]
149  # If true, ignores workspace crates that aren't published, or are only
150  # published to private registries.
151  # To see how to mark a crate as unpublished (to the official registry),
152  # visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field.
153  ignore = false
154  # One or more private registries that you might publish crates to, if a crate
155  # is only published to private registries, and ignore is true, the crate will
156  # not have its license(s) checked
157  registries = [
158      #"https://sekretz.com/registry
159  ]
160  
161  # This section is considered when running `cargo deny check bans`.
162  # More documentation about the 'bans' section can be found here:
163  # https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html
164  [bans]
165  # Lint level for when multiple versions of the same crate are detected
166  multiple-versions = "allow"
167  # Lint level for when a crate version requirement is `*`
168  wildcards = "allow"
169  # The graph highlighting used when creating dotgraphs for crates
170  # with multiple versions
171  # * lowest-version - The path to the lowest versioned duplicate is highlighted
172  # * simplest-path - The path to the version with the fewest edges is highlighted
173  # * all - Both lowest-version and simplest-path are used
174  highlight = "all"
175  # The default lint level for `default` features for crates that are members of
176  # the workspace that is being checked. This can be overridden by allowing/denying
177  # `default` on a crate-by-crate basis if desired.
178  workspace-default-features = "allow"
179  # The default lint level for `default` features for external crates that are not
180  # members of the workspace. This can be overridden by allowing/denying `default`
181  # on a crate-by-crate basis if desired.
182  external-default-features = "allow"
183  # List of crates that are allowed. Use with care!
184  allow = [
185      #"ansi_term@0.11.0",
186      #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is allowed" },
187  ]
188  # List of crates to deny
189  deny = [
190      #"ansi_term@0.11.0",
191      #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is banned" },
192      # Wrapper crates can optionally be specified to allow the crate when it
193      # is a direct dependency of the otherwise banned crate
194      #{ crate = "ansi_term@0.11.0", wrappers = ["this-crate-directly-depends-on-ansi_term"] },
195  ]
196  
197  # List of features to allow/deny
198  # Each entry the name of a crate and a version range. If version is
199  # not specified, all versions will be matched.
200  #[[bans.features]]
201  #crate = "reqwest"
202  # Features to not allow
203  #deny = ["json"]
204  # Features to allow
205  #allow = [
206  #    "rustls",
207  #    "__rustls",
208  #    "__tls",
209  #    "hyper-rustls",
210  #    "rustls",
211  #    "rustls-pemfile",
212  #    "rustls-tls-webpki-roots",
213  #    "tokio-rustls",
214  #    "webpki-roots",
215  #]
216  # If true, the allowed features must exactly match the enabled feature set. If
217  # this is set there is no point setting `deny`
218  #exact = true
219  
220  # Certain crates/versions that will be skipped when doing duplicate detection.
221  skip = [
222      #"ansi_term@0.11.0",
223      #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason why it can't be updated/removed" },
224  ]
225  # Similarly to `skip` allows you to skip certain crates during duplicate
226  # detection. Unlike skip, it also includes the entire tree of transitive
227  # dependencies starting at the specified crate, up to a certain depth, which is
228  # by default infinite.
229  skip-tree = [
230      #"ansi_term@0.11.0", # will be skipped along with _all_ of its direct and transitive dependencies
231      #{ crate = "ansi_term@0.11.0", depth = 20 },
232  ]
233  
234  # This section is considered when running `cargo deny check sources`.
235  # More documentation about the 'sources' section can be found here:
236  # https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html
237  [sources]
238  # Lint level for what to happen when a crate from a crate registry that is not
239  # in the allow list is encountered
240  unknown-registry = "warn"
241  # Lint level for what to happen when a crate from a git repository that is not
242  # in the allow list is encountered
243  unknown-git = "warn"
244  # List of URLs for allowed crate registries. Defaults to the crates.io index
245  # if not specified. If it is specified but empty, no registries are allowed.
246  allow-registry = ["https://github.com/rust-lang/crates.io-index"]
247  # List of URLs for allowed Git repositories
248  allow-git = []
249  
250  [sources.allow-org]
251  # github.com organizations to allow git sources for
252  github = []
253  # gitlab.com organizations to allow git sources for
254  gitlab = []
255  # bitbucket.org organizations to allow git sources for
256  bitbucket = []