Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cve-filter: Add class to filter cve files #99

Merged
merged 1 commit into from
Jun 13, 2024
Merged

Conversation

mdrodrigo
Copy link
Contributor

This class is designed to filter CVEs (Common Vulnerabilities and Exposures) from CVE files. It should be used in conjunction with the cve-check class from the openembedded-core.

Steps to Use This Class

  1. Add the following lines to your distro configuration file:

    include conf/distro/include/cve-extra-exclusions.inc INHERIT += "cve-check"

  2. Inherit the cve-filter class in the image recipe.

-------- Configuration Variables ----------------------------

The cve-filter class provides several configurable variables:

CVE_FILTER_PREVIOUS_FILE: Specifies the previous version of the CVE JSON file. If no file is provided, only the current file will be considered.
Default: empty

CVE_FILTER_PREVIOUS_VERSION: Specifies the distro version of the previous CVE JSON file. The CVE_FILTER_PREVIOUS_FILE must be defined, otherwise the value 0 will be used.
Example: "1.0.0"
Default: "0.0.0"

CVE_FILTER_MARKDOWN_FILE_NAME: Specifies the name of the output Markdown file containing the list of detected CVEs. Default: "${IMAGE_NAME}.md"

CVE_FILTER_IGNORED_CVES: Lists the CVEs that should be ignored by the filter.
Example: "CVE-2017-6264 CVE-2023-1234"
Default: empty

The following files was added:
- classes/cve-filter.bbclass
- lib/ossystems/cve_filter.py
- lib/ossystems/init.py

Also, the following file was changed:
- conf/layer.conf

Signed-off-by: Rodrigo M. Duarte rodrigo.duarte@ossystems.com.br
(cherry picked from commit 8fe7cdd)

This class is designed to filter CVEs (Common Vulnerabilities
and Exposures) from CVE files. It should be used in conjunction
with the cve-check class from the openembedded-core.

Steps to Use This Class

1. Add the following lines to your distro configuration file:

   include conf/distro/include/cve-extra-exclusions.inc
   INHERIT += "cve-check"

2. Inherit the cve-filter class in the image recipe.

--------  Configuration Variables  ----------------------------

The cve-filter class provides several configurable variables:

CVE_FILTER_PREVIOUS_FILE: Specifies the previous version of
the CVE JSON file. If no file is provided, only the current
file will be considered.
Default: empty

CVE_FILTER_PREVIOUS_VERSION: Specifies the distro version of
the previous CVE JSON file. The CVE_FILTER_PREVIOUS_FILE must
be defined, otherwise the value 0 will be used.
Example: "1.0.0"
Default: "0.0.0"

CVE_FILTER_MARKDOWN_FILE_NAME: Specifies the name of the
output Markdown file containing the list of detected CVEs.
Default: "${IMAGE_NAME}.md"

CVE_FILTER_IGNORED_CVES: Lists the CVEs that should be ignored by the filter.
Example: "CVE-2017-6264 CVE-2023-1234"
Default: empty

The following files was added:
    - classes/cve-filter.bbclass
    - lib/ossystems/cve_filter.py
    - lib/ossystems/__init__.py

Also, the following file was changed:
    - conf/layer.conf

Signed-off-by: Rodrigo M. Duarte <rodrigo.duarte@ossystems.com.br>
(cherry picked from commit 8fe7cdd)
@mdrodrigo mdrodrigo requested a review from otavio June 13, 2024 12:14
@otavio otavio merged commit bb9e79d into kirkstone Jun 13, 2024
@otavio otavio deleted the topic/cve-kirkstone branch June 13, 2024 12:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants