From 8d2c4ef7bede4881d45419f317df7c4b03550c1d Mon Sep 17 00:00:00 2001 From: Kazuhiko Kikuchi Date: Sat, 14 May 2022 09:57:43 +0900 Subject: [PATCH 1/7] add deny.toml this file created by 'cargo deny init' --- deny.toml | 205 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 205 insertions(+) create mode 100644 deny.toml diff --git a/deny.toml b/deny.toml new file mode 100644 index 00000000..c9017d66 --- /dev/null +++ b/deny.toml @@ -0,0 +1,205 @@ +# This template contains all of the possible sections and their default values + +# 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 + +# 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. + #{ 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://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" +# The url(s) of the advisory databases to use +db-urls = ["https://github.com/rustsec/advisory-db"] +# The lint level for security vulnerabilities +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 +notice = "warn" +# 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 +# will still output a note when they are encountered. +# * None - CVSS Score 0.0 +# * Low - CVSS Score 0.1 - 3.9 +# * Medium - CVSS Score 4.0 - 6.9 +# * High - CVSS Score 7.0 - 8.9 +# * Critical - CVSS Score 9.0 - 10.0 +#severity-threshold = + +# This section is considered when running `cargo deny check licenses` +# More documentation for the licenses section can be found here: +# 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 explicitly allowed licenses +# See https://spdx.org/licenses/ for list of possible licenses +# [possible values: any SPDX 3.11 short identifier (+ optional exception)]. +allow = [ + #"MIT", + #"Apache-2.0", + #"Apache-2.0 WITH LLVM-exception", +] +# List of explicitly disallowed licenses +# See https://spdx.org/licenses/ for list of possible licenses +# [possible values: any SPDX 3.11 short identifier (+ optional exception)]. +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 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 +# 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. +# To see how to mark a crate as unpublished (to the official registry), +# visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field. +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://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" +# Lint level for when a crate version requirement is `*` +wildcards = "allow" +# The graph highlighting used when creating dotgraphs for crates +# with multiple versions +# * lowest-version - The path to the lowest versioned duplicate is highlighted +# * simplest-path - The path to the version with the fewest edges is highlighted +# * all - Both lowest-version and simplest-path are used +highlight = "all" +# List of crates that are allowed. Use with care! +allow = [ + #{ name = "ansi_term", version = "=0.11.0" }, +] +# List of crates to deny +deny = [ + # Each entry the name of a crate and a version range. If version is + # not specified, all versions will be matched. + #{ name = "ansi_term", version = "=0.11.0" }, + # + # Wrapper crates can optionally be specified to allow the crate when it + # is a direct dependency of the otherwise banned crate + #{ name = "ansi_term", version = "=0.11.0", wrappers = [] }, +] +# Certain crates/versions that will be skipped when doing duplicate detection. +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 +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://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 +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 +unknown-git = "warn" +# 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 = [] + +[sources.allow-org] +# 1 or more github.com organizations to allow git sources for +github = [""] +# 1 or more gitlab.com organizations to allow git sources for +gitlab = [""] +# 1 or more bitbucket.org organizations to allow git sources for +bitbucket = [""] From bfac9117203ec1dab386554ae11ae70f4cb3e981 Mon Sep 17 00:00:00 2001 From: Kazuhiko Kikuchi Date: Sat, 14 May 2022 10:25:08 +0900 Subject: [PATCH 2/7] allow Licenses MIT, Apache, BSD3 add git source https://github.com/laysakura/simple-server --- deny.toml | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/deny.toml b/deny.toml index c9017d66..c0010cab 100644 --- a/deny.toml +++ b/deny.toml @@ -70,8 +70,9 @@ unlicensed = "deny" # See https://spdx.org/licenses/ for list of possible licenses # [possible values: any SPDX 3.11 short identifier (+ optional exception)]. allow = [ - #"MIT", - #"Apache-2.0", + "MIT", + "Apache-2.0", + "BSD-3-Clause", #"Apache-2.0 WITH LLVM-exception", ] # List of explicitly disallowed licenses @@ -194,12 +195,12 @@ unknown-git = "warn" # 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 = [] +allow-git = ["https://github.com/laysakura/simple-server"] [sources.allow-org] # 1 or more github.com organizations to allow git sources for -github = [""] +# github = [""] # 1 or more gitlab.com organizations to allow git sources for -gitlab = [""] +# gitlab = [""] # 1 or more bitbucket.org organizations to allow git sources for -bitbucket = [""] +# bitbucket = [""] From fe83a5164ec79a5e50d821eed209778477b0ac17 Mon Sep 17 00:00:00 2001 From: Kazuhiko Kikuchi Date: Sat, 14 May 2022 12:52:57 +0900 Subject: [PATCH 3/7] add cargo-deny install to CI --- .github/workflows/ci.yml | 23 +++++++++++++++++++ .../workflows/scripts/crates.io-script.bash | 5 ++++ 2 files changed, 28 insertions(+) create mode 100644 .github/workflows/scripts/crates.io-script.bash diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0fdfe010..a0e17fd2 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -76,6 +76,15 @@ jobs: steps: - uses: actions/checkout@v2 + - name: Check versions on crates.io + id: dep-versions + run: | + # load helper script + source .github/workflows/scripts/crates.io-script.bash + # get latest version from crates.io + echo "::set-output name=cargo-deny_version::$(get_crate_version cargo-deny)" + # add other dependencies versions here + - name: Install Rust ${{ matrix.rust }} if: ${{ ! matrix.make.rust-free }} uses: actions-rs/toolchain@v1 @@ -98,6 +107,20 @@ jobs: ${{ env.CACHE_RESET_KEY }}-${{ runner.os }}-${{ matrix.rust }}-cargo-${{ matrix.make.task }}- ${{ env.CACHE_RESET_KEY }}-${{ runner.os }}-${{ matrix.rust }}-cargo- + - name: Cache install cargo-deny + id: cache-cargo-deny + uses: actions/cache@v2 + continue-on-error: false + with: + path: | + ~/.cargo/bin/cargo-deny + key: ${{env.CACHE_RESET_KEY}}-${{ runner.os }}-${{ matrix.rust }}-cargo-deny-${{ steps.dep-versions.outputs.cargo-deny_version }} + + - name: Install cargo-deny + if: ${{ steps.cache-cargo-deny.outputs.cache-hit == false }} + run: | + cargo install cargo-deny + - name: Install cargo-make env: BASE_URL: https://github.com/sagiegurari/cargo-make/releases/download diff --git a/.github/workflows/scripts/crates.io-script.bash b/.github/workflows/scripts/crates.io-script.bash new file mode 100644 index 00000000..31fcb607 --- /dev/null +++ b/.github/workflows/scripts/crates.io-script.bash @@ -0,0 +1,5 @@ +function get_crate_version() { + curl -L https://crates.io/api/v1/crates/$1/versions | jq -r '.versions[] | select( .yanked == false) | .num' | sort --version-sort | tail -n 1 +} + +export -f get_crate_version \ No newline at end of file From 499e1c86a767a071b31c9711d15536a17576b752 Mon Sep 17 00:00:00 2001 From: Kazuhiko Kikuchi Date: Sat, 14 May 2022 13:10:46 +0900 Subject: [PATCH 4/7] cargo-deny install on stable only --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a0e17fd2..670b50cc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -117,7 +117,7 @@ jobs: key: ${{env.CACHE_RESET_KEY}}-${{ runner.os }}-${{ matrix.rust }}-cargo-deny-${{ steps.dep-versions.outputs.cargo-deny_version }} - name: Install cargo-deny - if: ${{ steps.cache-cargo-deny.outputs.cache-hit == false }} + if: ${{ steps.cache-cargo-deny.outputs.cache-hit == false && matrix.rust == 'stable' }} run: | cargo install cargo-deny From 5d2f31937d8a0a10153ee53ff7530cc3caf2bbfb Mon Sep 17 00:00:00 2001 From: Kazuhiko Kikuchi Date: Sat, 14 May 2022 13:21:12 +0900 Subject: [PATCH 5/7] add check-dependencies task to makefile --- Makefile.toml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Makefile.toml b/Makefile.toml index 12738027..25dc0c27 100644 --- a/Makefile.toml +++ b/Makefile.toml @@ -28,11 +28,19 @@ script = [''' RUSTFLAGS='-D warnings' cargo clippy --workspace --all-targets --all-features '''] +[tasks.check-dependencies] +condition = { rust_version = { min = "1.56.1" } } # cargo-deny 0.11.4 : supports rust 1.56.1 later +script = [''' +#!/usr/bin/env bash -eux +cargo deny check +'''] + [tasks.build] script = [''' #!/usr/bin/env bash -eux RUSTFLAGS='-D warnings' cargo build --workspace --all-targets --all-features '''] +dependencies=["check-dependencies"] [tasks.test] script = [''' From c7d51620aff46c0fcaa59bf1e3e810670ec2ec58 Mon Sep 17 00:00:00 2001 From: Kazuhiko Kikuchi Date: Sat, 14 May 2022 13:37:37 +0900 Subject: [PATCH 6/7] run check-dependencies task --- .github/workflows/ci.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 670b50cc..91346656 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -22,6 +22,10 @@ jobs: task: format os: ubuntu-latest rust: stable + - make: + task: check-dependencies + os: ubuntu-latest + rust: stable - make: task: lint os: ubuntu-latest From 15adc1c031e2d5db8f41c389df0c86cf3936db46 Mon Sep 17 00:00:00 2001 From: Kazuhiko Kikuchi Date: Wed, 18 May 2022 07:57:59 +0900 Subject: [PATCH 7/7] refactor: apply review rename get_crate_version to get_crate_latest_version --- .github/workflows/ci.yml | 4 ++-- .github/workflows/scripts/crates.io-script.bash | 12 ++++++++++-- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 91346656..9e651a56 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -86,7 +86,7 @@ jobs: # load helper script source .github/workflows/scripts/crates.io-script.bash # get latest version from crates.io - echo "::set-output name=cargo-deny_version::$(get_crate_version cargo-deny)" + echo "::set-output name=cargo-deny_version::$(get_crate_latest_version cargo-deny)" # add other dependencies versions here - name: Install Rust ${{ matrix.rust }} @@ -121,7 +121,7 @@ jobs: key: ${{env.CACHE_RESET_KEY}}-${{ runner.os }}-${{ matrix.rust }}-cargo-deny-${{ steps.dep-versions.outputs.cargo-deny_version }} - name: Install cargo-deny - if: ${{ steps.cache-cargo-deny.outputs.cache-hit == false && matrix.rust == 'stable' }} + if: ${{ steps.cache-cargo-deny.outputs.cache-hit == false && matrix.rust == 'stable'}} run: | cargo install cargo-deny diff --git a/.github/workflows/scripts/crates.io-script.bash b/.github/workflows/scripts/crates.io-script.bash index 31fcb607..c1495437 100644 --- a/.github/workflows/scripts/crates.io-script.bash +++ b/.github/workflows/scripts/crates.io-script.bash @@ -1,5 +1,13 @@ -function get_crate_version() { + +# function: get_crate_latest_version +# arg#1: crate name +# returns: latest version number on crates.io +# +# this calls crates.io REST api via curl, that listing all versions of specified crate. +# `jq` query filter for not yanked and extract version number. +# sort semver and takes last one. +function get_crate_latest_version() { curl -L https://crates.io/api/v1/crates/$1/versions | jq -r '.versions[] | select( .yanked == false) | .num' | sort --version-sort | tail -n 1 } -export -f get_crate_version \ No newline at end of file +export -f get_crate_latest_version \ No newline at end of file