ci: add cargo-deny check

This commit is contained in:
Manuthor 2024-05-05 20:47:00 +02:00 committed by Manuthor
parent 37b8c2d772
commit d3b22f5b3a
14 changed files with 268 additions and 99 deletions

View file

@ -1,45 +0,0 @@
#
# All of the options which can be passed via CLI arguments can also be
# permanently specified in this file.
[advisories]
# Security check
# Failing because mysql has some dependencies with problems but cannot be upgraded
# because new versions of bitvec/funty are incompatible with some of our crypto dependencies.
# All the 2023 are open SSl related but cannot be easily fixed by simply upgrading dependencies
ignore = [
"RUSTSEC-2020-0071", # crate time in 2 versions (one not upgradable)...
"RUSTSEC-2023-0006", # openssl-src
"RUSTSEC-2023-0007", # openssl-src
"RUSTSEC-2023-0009", # openssl-src
"RUSTSEC-2023-0010", # openssl-src
"RUSTSEC-2023-0018", # openssl-src
"RUSTSEC-2023-0034", # openssl-src
"RUSTSEC-2023-0071", # rsa
"RUSTSEC-2023-0079", # pqc-kyber
]
# informational_warnings = ["unmaintained"] # warn for categories of informational advisories
# severity_threshold = "low" # CVSS severity ("none", "low", "medium", "high", "critical")
# # Advisory Database Configuration
# [database]
# path = "~/.cargo/advisory-db" # Path where advisory git repo will be cloned
# url = "https://github.com/RustSec/advisory-db.git" # URL to git repo
# fetch = true # Perform a `git fetch` before auditing (default: true)
# stale = false # Allow stale advisory DB (i.e. no commits for 90 days, default: false)
# # Output Configuration
# [output]
# deny = ["unmaintained"] # exit on error if unmaintained dependencies are found
# format = "terminal" # "terminal" (human readable report) or "json"
# quiet = false # Only print information on error
# show_tree = true # Show inverse dependency trees along with advisories (default: true)
# # Target Configuration
# [target]
# arch = "x86_64" # Ignore advisories for CPU architectures other than this one
# os = "linux" # Ignore advisories for operating systems other than this one
# [yanked]
# enabled = true # Warn for yanked crates in Cargo.lock (default: true)
# update_index = true # Auto-update the crates.io index (default: true)

View file

@ -10,14 +10,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: dtolnay/rust-toolchain@stable
- uses: actions/cache@v3
with:
path: ~/.cargo/bin
key: ${{ runner.os }}-cargo-audit-v0.15.2
- uses: rustsec/audit-check@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
- uses: EmbarkStudios/cargo-deny-action@v1
cargo-lint:
uses: ./.github/workflows/clippy.yml

View file

@ -16,14 +16,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: dtolnay/rust-toolchain@stable
- uses: actions/cache@v3
with:
path: ~/.cargo/bin
key: ${{ runner.os }}-cargo-audit-v0.15.2
- uses: rustsec/audit-check@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
- uses: EmbarkStudios/cargo-deny-action@v1
cargo-lint:
uses: ./.github/workflows/clippy.yml

View file

@ -10,14 +10,14 @@
exclude: crate/cli/test_data|documentation/pandoc|documentation/overrides|enclave|crate/server/src/tests/test_utils.rs|crate/cli/src/tests/utils/test_utils.rs|crate/client/src/lib.rs|crate/cli/src/tests/certificates/openssl.rs|crate/client/src/kms_rest_client.rs|.pre-commit-config.yaml|crate/server/src/routes/google_cse/jwt.rs|crate/server/src/routes/google_cse/python/openssl|documentation/docs/google_cse
repos:
- repo: https://github.com/compilerla/conventional-pre-commit
rev: v2.1.1
rev: v3.2.0
hooks:
- id: conventional-pre-commit
stages: [commit-msg]
args: [] # optional: list of Conventional Commits types to allow e.g. [feat, fix, ci, chore, test]
- repo: https://github.com/pre-commit/mirrors-prettier
rev: v3.0.0-alpha.4
rev: v4.0.0-alpha.8
hooks:
- id: prettier
stages: [commit]
@ -27,7 +27,7 @@ repos:
exclude: documentation/theme_overrides/assets
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.32.2
rev: v0.40.0
hooks:
- id: markdownlint-fix
args:
@ -50,27 +50,27 @@ repos:
- id: markdown-toc
- repo: https://github.com/tcort/markdown-link-check
rev: v3.11.2
rev: v3.12.1
hooks:
- id: markdown-link-check
args: [-q]
exclude: documentation/docs/ms_dke/ms_dke.md
- repo: https://github.com/jumanjihouse/pre-commit-hook-yamlfmt
rev: 0.2.2
rev: 0.2.3
hooks:
- id: yamlfmt
args: [--mapping, "2", --sequence, "4", --offset, "2"]
exclude: ansible
- repo: https://github.com/crate-ci/typos
rev: v1.13.1
rev: v1.21.0
hooks:
- id: typos
exclude: documentation/docs/images/google_cse.drawio.svg|crate/test_server/src/test_jwt.rs|crate/pkcs11/documentation/veracrypt_ckms.svg|crate/client/test_data/configs/kms.bad|crate/test_server/certificates/|crate/client/test_data/configs/|crate/server/src/tests/google_cse/|crate/pkcs11/sys/src/
- repo: https://github.com/Lucas-C/pre-commit-hooks
rev: v1.3.1
rev: v1.5.5
hooks:
- id: forbid-crlf
- id: remove-crlf
@ -80,7 +80,7 @@ repos:
exclude: ^.git/
- repo: https://github.com/sirosen/texthooks
rev: 0.4.0
rev: 0.6.6
hooks:
- id: fix-smartquotes
- id: fix-ligatures
@ -94,7 +94,7 @@ repos:
- id: shellcheck
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
rev: v4.6.0
hooks:
- id: check-added-large-files
- id: check-ast
@ -128,30 +128,12 @@ repos:
exclude: crate/kmip/src/kmip/extra/x509_extensions.rs
- repo: https://github.com/psf/black
rev: 22.10.0
rev: 24.4.2
hooks:
- id: black
# avoid clash with `double-quote-string-fixer`
args: [--skip-string-normalization]
- repo: https://github.com/Cube707/mkdocs
rev: e8733d1373c1543d6052925d3272b2ff51dbb140
hooks:
- id: mkdocs-build
additional_dependencies:
- mkdocs-plugin-progress
- mkdocs-kroki-plugin
- mkdocs-material
- mkdocs-meta-descriptions-plugin
- markdown-katex
entry: bash -c 'cd documentation && mkdocs build --strict'
- repo: https://github.com/cisagov/pre-commit-packer
rev: v0.0.2
hooks:
- id: packer_fmt
- id: packer_validate
- repo: https://github.com/Cosmian/git-hooks.git
rev: v1.0.25
hooks:

4
Cargo.lock generated
View file

@ -2821,9 +2821,9 @@ dependencies = [
[[package]]
name = "ordered-multimap"
version = "0.7.1"
version = "0.7.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a4d6a8c22fc714f0c2373e6091bf6f5e9b37b1bc0b1184874b7e0a4e303d318f"
checksum = "49203cdcae0030493bad186b28da2fa25645fa276a51b6fec8010d281e02ef79"
dependencies = [
"dlv-list",
"hashbrown",

View file

@ -26,7 +26,8 @@ authors = [
"Emmanuel Coste <emmanuel.coste@cosmian.com>",
"Hugo Rosenkranz-Costa <hugo.rosenkranz@cosmian.com>"
]
license = "Business Source License 1.1"
license = "BUSL-1.1" # "Business Source License 1.1"
license-file = "LICENSE"
repository = "https://github.com/Cosmian/kms"
[profile.release]

View file

@ -6,7 +6,6 @@ edition.workspace = true
license.workspace = true
repository.workspace = true
rust-version.workspace = true
license-file = "../../LICENSE"
description = "CLI used to manage the Cosmian KMS."
[[bin]]

View file

@ -6,7 +6,6 @@ edition.workspace = true
license.workspace = true
repository.workspace = true
rust-version.workspace = true
license-file = "../../LICENSE"
[lib]
# doc test linking as a separate binary is extremely slow

View file

@ -6,7 +6,6 @@ edition.workspace = true
license.workspace = true
repository.workspace = true
rust-version.workspace = true
license-file = "../../LICENSE"
[lib]
# doc test linking as a separate binary is extremely slow

View file

@ -6,7 +6,6 @@ edition.workspace = true
license.workspace = true
repository.workspace = true
rust-version.workspace = true
license-file = "../../LICENSE"
[dependencies]
tracing = { workspace = true }

View file

@ -6,7 +6,6 @@ edition.workspace = true
license.workspace = true
repository.workspace = true
rust-version.workspace = true
license-file = "../../LICENSE"
[lib]
crate-type = ["cdylib"]

View file

@ -6,7 +6,6 @@ edition.workspace = true
license.workspace = true
repository.workspace = true
rust-version.workspace = true
license-file = "../../LICENSE"
description = "Cosmian Key Management Service"
[[bin]]

View file

@ -6,7 +6,6 @@ edition.workspace = true
license.workspace = true
repository.workspace = true
rust-version.workspace = true
license-file = "../../LICENSE"
[lib]
# doc test linking as a separate binary is extremely slow

252
deny.toml Normal file
View file

@ -0,0 +1,252 @@
# 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
# Root options
# The graph table configures how the dependency graph is constructed and thus
# which crates the checks are performed against
[graph]
# 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
#"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"] },
]
# When creating the dependency graph used as the source of truth when checks are
# executed, this field can be used to prune crates from the graph, removing them
# from the view of cargo-deny. This is an extremely heavy hammer, as if a crate
# is pruned from the graph, all of its dependencies will also be pruned unless
# they are connected to another crate in the graph that hasn't been pruned,
# so it should be used with care. The identifiers are [Package ID Specifications]
# (https://doc.rust-lang.org/cargo/reference/pkgid-spec.html)
#exclude = []
# If true, metadata will be collected with `--all-features`. Note that this can't
# be toggled off if true, if you want to conditionally enable `--all-features` it
# is recommended to pass `--all-features` on the cmd line instead
all-features = false
# If true, metadata will be collected with `--no-default-features`. The same
# caveat with `all-features` applies
no-default-features = false
# If set, these feature will be enabled when collecting metadata. If `--features`
# is specified on the cmd line they will take precedence over this option.
#features = []
# The output table provides options for how/if diagnostics are outputted
[output]
# When outputting inclusion graphs in diagnostics that include features, this
# option can be used to specify the depth at which feature edges will be added.
# This option is included since the graphs can be quite large and the addition
# of features from the crate(s) to all of the graph roots can be far too verbose.
# This option can be overridden via `--feature-depth` on the cmd line
feature-depth = 1
# 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 databases are cloned/fetched into
#db-path = "$CARGO_HOME/advisory-dbs"
# The url(s) of the advisory databases to use
#db-urls = ["https://github.com/rustsec/advisory-db"]
# A list of advisory IDs to ignore. Note that ignored advisories will still
# output a note when they are encountered.
ignore = [
"RUSTSEC-2020-0071", # crate time in 2 versions (one not upgradable)...
"RUSTSEC-2023-0006", # openssl-src
"RUSTSEC-2023-0007", # openssl-src
"RUSTSEC-2023-0009", # openssl-src
"RUSTSEC-2023-0010", # openssl-src
"RUSTSEC-2023-0018", # openssl-src
"RUSTSEC-2023-0034", # openssl-src
"RUSTSEC-2023-0071", # rsa
"RUSTSEC-2023-0079", # pqc-kyber
#{ id = "RUSTSEC-0000-0000", reason = "you can specify a reason the advisory is ignored" },
#"a-crate-that-is-yanked@0.1.1", # you can also ignore yanked crate versions if you wish
#{ crate = "a-crate-that-is-yanked@0.1.1", reason = "you can specify why you are ignoring the yanked crate" },
]
# If this is true, then cargo deny will use the git executable to fetch advisory database.
# If this is false, then it uses a built-in git library.
# Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support.
# See Git Authentication for more information about setting up git authentication.
#git-fetch-with-cli = true
# 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]
# 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",
"OpenSSL",
"ISC",
"Zlib",
"MPL-2.0",
"BSD-2-Clause",
"BSD-3-Clause",
"Unicode-DFS-2016",
"CC0-1.0",
"BUSL-1.1",
]
# 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"], crate = "adler32" },
]
# 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 package spec the clarification applies to
crate = "ring"
# 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"
# The default lint level for `default` features for crates that are members of
# the workspace that is being checked. This can be overridden by allowing/denying
# `default` on a crate-by-crate basis if desired.
workspace-default-features = "allow"
# The default lint level for `default` features for external crates that are not
# members of the workspace. This can be overridden by allowing/denying `default`
# on a crate-by-crate basis if desired.
external-default-features = "allow"
# List of crates that are allowed. Use with care!
allow = [
#"ansi_term@0.11.0",
#{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is allowed" },
]
# List of crates to deny
deny = [
#"ansi_term@0.11.0",
#{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is banned" },
# Wrapper crates can optionally be specified to allow the crate when it
# is a direct dependency of the otherwise banned crate
#{ crate = "ansi_term@0.11.0", wrappers = ["this-crate-directly-depends-on-ansi_term"] },
]
# List of features to allow/deny
# Each entry the name of a crate and a version range. If version is
# not specified, all versions will be matched.
#[[bans.features]]
#crate = "reqwest"
# Features to not allow
#deny = ["json"]
# Features to allow
#allow = [
# "rustls",
# "__rustls",
# "__tls",
# "hyper-rustls",
# "rustls",
# "rustls-pemfile",
# "rustls-tls-webpki-roots",
# "tokio-rustls",
# "webpki-roots",
#]
# If true, the allowed features must exactly match the enabled feature set. If
# this is set there is no point setting `deny`
#exact = true
# Certain crates/versions that will be skipped when doing duplicate detection.
skip = [
#"ansi_term@0.11.0",
#{ crate = "ansi_term@0.11.0", reason = "you can specify a reason why it can't be updated/removed" },
]
# 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 = [
#"ansi_term@0.11.0", # will be skipped along with _all_ of its direct and transitive dependencies
#{ crate = "ansi_term@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 = [""]