Fixup template (#120)

* Move template to root
* Add missing fields, add some example values
* Use links to mdbook docs

resources/template.toml → deny.template.toml

@@ -3,29 +3,33 @@
 # Note that all fields that take a lint level have these possible values:
 # * deny - An error will be produced and the check will fail
 # * warn - A warning will be produced, but the check will not fail
-# * allow - No warning or error will be produced, though in some cases a note will be
+# * allow - No warning or error will be produced, though in some cases a note
+# will be
 
-# If 1 or more target triples (and optionally, target_features) are specified, only
-# the specified targets will be checked when running `cargo deny check`. This means,
-# if a particular package is only ever used as a target specific dependency, such
-# as, for example, the `nix` crate only being used via the `target_family = "unix"`
-# configuration, that only having windows targets in this list would mean the nix
-# crate, as well as any of its exclusive dependencies not shared by any other
-# crates, would be ignored, as the target list here is effectively saying which
-# targets you are building for.
+# The values provided in this template are the default values that will be used
+# when any section or field is not specified in your own configuration
+
+# If 1 or more target triples (and optionally, target_features) are specified,
+# only the specified targets will be checked when running `cargo deny check`.
+# This means, if a particular package is only ever used as a target specific
+# dependency, such as, for example, the `nix` crate only being used via the
+# `target_family = "unix"` configuration, that only having windows targets in
+# this list would mean the nix crate, as well as any of its exclusive
+# dependencies not shared by any other crates, would be ignored, as the target
+# list here is effectively saying which targets you are building for.
 targets = [
     # The triple can be any string, but only the target triples built in to
     # rustc (as of 1.40) can be checked against actual config expressions
     #{ triple = "x86_64-unknown-linux-musl" },
-    # You can also specify which target_features you promise are enabled for a particular
-    # target. target_features are currently not validated against the actual valid
-    # features supported by the target architecture.
+    # You can also specify which target_features you promise are enabled for a
+    # particular target. target_features are currently not validated against
+    # the actual valid features supported by the target architecture.
     #{ triple = "wasm32-unknown-unknown", features = ["atomics"] },
 ]
 
 # This section is considered when running `cargo deny check advisories`
 # More documentation for the advisories section can be found here:
-# https://github.com/EmbarkStudios/cargo-deny#the-advisories-section
+# https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html
 [advisories]
 # The path where the advisory database is cloned/fetched into
 db-path = "~/.cargo/advisory-db"
@@ -35,14 +39,19 @@ db-url = "https://github.com/rustsec/advisory-db"
 vulnerability = "deny"
 # The lint level for unmaintained crates
 unmaintained = "warn"
+# The lint level for crates that have been yanked from their source registry
+yanked = "warn"
 # The lint level for crates with security notices. Note that as of
-# 2019-12-17 there are no security notice advisories in https://github.com/rustsec/advisory-db
+# 2019-12-17 there are no security notice advisories in
+# https://github.com/rustsec/advisory-db
 notice = "warn"
-# A list of advisory IDs to ignore. Note that ignored advisories will still output
-# a note when they are encountered.
-ignore = []
+# A list of advisory IDs to ignore. Note that ignored advisories will still
+# output a note when they are encountered.
+ignore = [
+    #"RUSTSEC-0000-0000",
+]
 # Threshold for security vulnerabilities, any vulnerability with a CVSS score
-# lower than the range specified will be ignored. Note that ignored advisories 
+# lower than the range specified will be ignored. Note that ignored advisories
 # will still output a note when they are encountered.
 # * None - CVSS Score 0.0
 # * Low - CVSS Score 0.1 - 3.9
@@ -53,36 +62,85 @@ ignore = []
 
 # This section is considered when running `cargo deny check licenses`
 # More documentation for the licenses section can be found here:
-# https://github.com/EmbarkStudios/cargo-deny#the-licenses-section
+# https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html
 [licenses]
 # The lint level for crates which do not have a detectable license
 unlicensed = "deny"
 # List of explictly allowed licenses
 # See https://spdx.org/licenses/ for list of possible licenses
 # [possible values: any SPDX 3.7 short identifier (+ optional exception)].
-allow = []
+allow = [
+    #"MIT",
+    #"Apache-2.0",
+    #"Apache-2.0 WITH LLVM-exception",
+]
 # List of explictly disallowed licenses
 # See https://spdx.org/licenses/ for list of possible licenses
 # [possible values: any SPDX 3.7 short identifier (+ optional exception)].
-deny = []
-# The lint level for licenses considered copyleft
+deny = [
+    #"Nokia",
+]
+# Lint level for licenses considered copyleft
 copyleft = "warn"
 # Blanket approval or denial for OSI-approved or FSF Free/Libre licenses
-# * both - The license will only be approved if it is both OSI-approved *AND* FSF/Free
-# * either - The license will be approved if it is either OSI-approved *OR* FSF/Free
-# * osi-only - The license will be approved if is OSI-approved *AND NOT* FSF/Free
-# * fsf-only - The license will be approved if is FSF/Free *AND NOT* OSI-approved
-# * neither - The license will be denied if is FSF/Free *OR* OSI-approved
+# * both - The license will be approved if it is both OSI-approved *AND* FSF
+# * either - The license will be approved if it is either OSI-approved *OR* FSF
+# * osi-only - The license will be approved if is OSI-approved *AND NOT* FSF
+# * fsf-only - The license will be approved if is FSF *AND NOT* OSI-approved
+# * neither - This predicate is ignored and the default lint level is used
 allow-osi-fsf-free = "neither"
+# Lint level used when no other predicates are matched
+# 1. License isn't in the allow or deny lists
+# 2. License isn't copyleft
+# 3. License isn't OSI/FSF, or allow-osi-fsf-free = "neither"
+default = "deny"
 # The confidence threshold for detecting a license from license text.
-# The higher the value, the more closely the license text must be to the 
+# The higher the value, the more closely the license text must be to the
 # canonical license text of a valid SPDX license file.
 # [possible values: any between 0.0 and 1.0].
 confidence-threshold = 0.8
+# Allow 1 or more licenses on a per-crate basis, so that particular licenses
+# aren't accepted for every possible crate as with the normal allow list
+exceptions = [
+    # Each entry is the crate and version constraint, and its specific allow
+    # list
+    #{ allow = ["Zlib"], name = "adler32", version = "*" },
+]
+
+# Some crates don't have (easily) machine readable licensing information,
+# adding a clarification entry for it allows you to manually specify the
+# licensing information
+#[[licenses.clarify]]
+# The name of the crate the clarification applies to
+#name = "ring"
+# THe optional version constraint for the crate
+#version = "*"
+# The SPDX expression for the license requirements of the crate
+#expression = "MIT AND ISC AND OpenSSL"
+# One or more files in the crate's source used as the "source of truth" for
+# the license expression. If the contents match, the clarification will be used
+# when running the license check, otherwise the clarification will be ignored
+# and the crate will be checked normally, which may produce warnings or errors
+# depending on the rest of your configuration
+#license-files = [
+    # Each entry is a crate relative path, and the (opaque) hash of its contents
+    #{ path = "LICENSE", hash = 0xbd0eed23 }
+#]
+
+[licenses.private]
+# If true, ignores workspace crates that aren't published, or are only
+# published to private registries
+ignore = false
+# One or more private registries that you might publish crates to, if a crate
+# is only published to private registries, and ignore is true, the crate will
+# not have its license(s) checked
+registries = [
+    #"https://sekretz.com/registry
+]
 
 # This section is considered when running `cargo deny check bans`.
 # More documentation about the 'bans' section can be found here:
-# https://github.com/EmbarkStudios/cargo-deny#crate-bans-cargo-deny-check-ban
+# https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html
 [bans]
 # Lint level for when multiple versions of the same crate are detected
 multiple-versions = "warn"
@@ -106,23 +164,26 @@ deny = [
 skip = [
     #{ name = "ansi_term", version = "=0.11.0" },
 ]
-# Similarly to `skip` allows you to skip certain crates during duplicate detection,
-# unlike skip, it also includes the entire tree of transitive dependencies starting at
-# the specified crate, up to a certain depth, which is by default infinite
+# Similarly to `skip` allows you to skip certain crates during duplicate 
+# detection. Unlike skip, it also includes the entire tree of transitive 
+# dependencies starting at the specified crate, up to a certain depth, which is
+# by default infinite
 skip-tree = [
     #{ name = "ansi_term", version = "=0.11.0", depth = 20 },
 ]
 
-
 # This section is considered when running `cargo deny check sources`.
 # More documentation about the 'sources' section can be found here:
-# https://github.com/EmbarkStudios/cargo-deny#crate-sources-cargo-deny-check-sources
+# https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html
 [sources]
-# Lint level for what to happen when a crate from a crate registry that is not in the allow list is encountered
+# Lint level for what to happen when a crate from a crate registry that is not
+# in the allow list is encountered
 unknown-registry = "warn"
-# Lint level for what to happen when a crate from a git repository that is not in the allow list is encountered
+# Lint level for what to happen when a crate from a git repository that is not
+# in the allow list is encountered
 unknown-git = "warn"
-# List of URLs for allowed crate registries, by default https://github.com/rust-lang/crates.io-index is included
-#allow-registry = []
+# List of URLs for allowed crate registries. Defaults to the crates.io index
+# if not specified. If it is specified but empty, no registries are allowed.
+allow-registry = ["https://github.com/rust-lang/crates.io-index"]
 # List of URLs for allowed Git repositories
 allow-git = []

src/cargo-deny/init.rs

@@ -13,7 +13,7 @@ pub struct Args {
     config: PathBuf,
 }
 
-const CONTENTS: &[u8] = include_bytes!("../../resources/template.toml");
+const CONTENTS: &[u8] = include_bytes!("../../deny.template.toml");
 
 pub fn cmd(args: Args, context_dir: PathBuf) -> Result<(), Error> {
     let cfg_file = make_absolute_path(args.config, &context_dir);

src/licenses/cfg.rs

@@ -63,7 +63,7 @@ pub struct Private {
     #[serde(default)]
     pub ignore: bool,
     /// One or more private registries that you might publish crates to, if
-    /// a crate it only published to private registries, and ignore is true
+    /// a crate is only published to private registries, and ignore is true
     /// the crate will not have its license checked
     #[serde(default)]
     pub registries: Vec<String>,