Add: Add a standalone plugin for checking correct file extensions

[ghost]

What

Add a standalone plugin that checks that all files in a given directory and subdirectories have only valid .nasl or .inc file extensions.

Why

Files with invalid extensions make it into the feed.
Invalid: foo.nasl.nasl, foo, codespell.exclusion
Valid: foo.nasl, foo.inc

References

VTOPS-198

Checklist

• Tests

nhargarter@gb-ho-10 ~/g/troubadix (file_extensions)> poetry run troubadix-file-extensions -d ~/gb/vulnerability-tests/nasl
Files with unwanted file extension were found:
/home/nhargarter/gb/vulnerability-tests/nasl/README.md
/home/nhargarter/gb/vulnerability-tests/nasl/21.04/.git-keep
/home/nhargarter/gb/vulnerability-tests/nasl/common/bad_rsa_ssh_host_keys.txt
/home/nhargarter/gb/vulnerability-tests/nasl/common/bad_dsa_ssh_host_keys.txt
/home/nhargarter/gb/vulnerability-tests/nasl/common/2023/wordpress-plugins/gb_wordpress_woocommerce-gutenberg-products-block_xss_vuln_nov23.nasl.nasl
/home/nhargarter/gb/vulnerability-tests/nasl/common/2023/wordpress-plugins/gb_wordpress_better_font_awesome_xss_vuln_jan23.nasl.nasl
/home/nhargarter/gb/vulnerability-tests/nasl/common/2022/discourse/gb_discourse_rce_vuln_sep22.nasl.nasl
/home/nhargarter/gb/vulnerability-tests/nasl/22.04/.git-keep

[github-actions]

Conventional Commits Report

Type	Number
Changed	5
Added	4

🚀 Conventional commits found.

[codecov]

Codecov Report

Attention: Patch coverage is 94.00000% with 3 lines in your changes are missing coverage. Please review.

Project coverage is 79.06%. Comparing base (d9d6eb9) to head (ffc9b71).

❗ Current head ffc9b71 differs from pull request most recent head 792a7e8. Consider uploading reports for the commit 792a7e8 to get more accurate results

Files	Patch %	Lines
troubadix/standalone_plugins/file_extensions.py	95.91%	1 Missing and 1 partial ⚠️
troubadix/standalone_plugins/changed_oid.py	0.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #687      +/-   ##
==========================================
+ Coverage   78.76%   79.06%   +0.30%     
==========================================
  Files          81       82       +1     
  Lines        2736     2785      +49     
  Branches      577      589      +12     
==========================================
+ Hits         2155     2202      +47     
- Misses        440      441       +1     
- Partials      141      142       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[cfi-gb]

For these we would need to have an exclusion possibility (no exclusion of .txt or .md files in general, only for these specific file names) as these are valid and shouldn't be reported:

nasl/README.md
nasl/21.04/.git-keep
nasl/common/bad_rsa_ssh_host_keys.txt
nasl/common/bad_dsa_ssh_host_keys.txt
nasl/22.04/.git-keep

The .git-keep is TBD, as both folders (21.04 and 22.04) are not empty we might also want to just drop it but not sure if this could cause problems during feed deployment / QA.

[ghost]

For these we would need to have an exclusion possibility (no exclusion of .txt or .md files in general, only for these specific file names) as these are valid and shouldn't be reported:

nasl/README.md
nasl/21.04/.git-keep
nasl/common/bad_rsa_ssh_host_keys.txt
nasl/common/bad_dsa_ssh_host_keys.txt
nasl/22.04/.git-keep

The .git-keep is TBD, as both folders (21.04 and 22.04) are not empty we might also want to just drop it but not sure if this could cause problems during feed deployment / QA.

Should the exclusion be for the specific file in the specific folder starting with /nasl/, or should it be a general exclusion for files with that specific name?

exclusion: common/bad_dsa_ssh_host_keys.txt vs bad_dsa_ssh_host_keys.txt

[cfi-gb]

For these we would need to have an exclusion possibility (no exclusion of .txt or .md files in general, only for these specific file names) as these are valid and shouldn't be reported:

nasl/README.md
nasl/21.04/.git-keep
nasl/common/bad_rsa_ssh_host_keys.txt
nasl/common/bad_dsa_ssh_host_keys.txt
nasl/22.04/.git-keep

The .git-keep is TBD, as both folders (21.04 and 22.04) are not empty we might also want to just drop it but not sure if this could cause problems during feed deployment / QA.

Should the exclusion be for the specific file in the specific folder starting with /nasl/, or should it be a general exclusion for files with that specific name?

exclusion: common/bad_dsa_ssh_host_keys.txt vs bad_dsa_ssh_host_keys.txt

Personally i would make it as strict as possible (e.g. some one might have copied the file wrongly to e.g. common/2024):

common/bad_dsa_ssh_host_keys.txt

with an option to also allow something like e.g. the following (if that is ever required to overwrite the file in different feeds) in the future:

21.04/bad_dsa_ssh_host_keys.txt
22.04/bad_dsa_ssh_host_keys.txt

[mbrinkhoff]

troubadix/pyproject.toml

Line 78 in 81f8c02

[tool.poetry.scripts]

There is also an requirement to add this to the pyproject.toml file, so it can be run as a cmd tool