Skip to content

Commit dd22e94

Browse files
uilianriesAbrilRBS
andauthored
[audit] Add severity level information for conan audit scan (#4080)
* Add severity level for audit Signed-off-by: Uilian Ries <[email protected]> * Improve description Signed-off-by: Uilian Ries <[email protected]> * Update devops/audit.rst Co-authored-by: Abril Rincón Blanco <[email protected]> --------- Signed-off-by: Uilian Ries <[email protected]> Co-authored-by: Abril Rincón Blanco <[email protected]>
1 parent fa98a85 commit dd22e94

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

devops/audit.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,17 @@ which will look something like:
108108
:align: center
109109
:alt: Conan audit report
110110

111+
The scan also has the threshold option ``--severity-level``, which allows you to set a minimum severity level for the vulnerabilities.
112+
In case the threshold value is surpassed by any of the vulnerabilities found, the command will return a non-zero exit code.
113+
By default, it's set to 9.0 (Critical), but you can set it to a lower value to include lower severity vulnerabilities in the report.
114+
To disable the threshold, set it to 100.0.
115+
116+
.. code-block::
117+
118+
$ conan audit scan . --severity-level=5.0
119+
...
120+
The package openssl/1.1.1w has a CVSS score 5.3 and exceeded the threshold severity level 5.0.
121+
111122
.. _devops_audit_private_providers:
112123

113124
Adding private providers
@@ -136,7 +147,7 @@ with the following command:
136147
token in the shell history, you can authenticate with the provider using an environment
137148
variable. Set the ``CONAN_AUDIT_PROVIDER_TOKEN_<PROVIDER_NAME>`` environment variable
138149
with the token value, replacing `<PROVIDER_NAME>` with the provider name in uppercase
139-
and using underscores (`_`) instead of hyphens (`-`).
150+
and using underscores (`_`) instead of hyphens (`-`).
140151

141152
For example, for `myprovider`, use: ``CONAN_AUDIT_PROVIDER_TOKEN_MYPROVIDER=<token>``.
142153

0 commit comments

Comments
 (0)