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

Create SECURITY.md #751

Merged
merged 5 commits into from
Jan 23, 2024
Merged

Create SECURITY.md #751

merged 5 commits into from
Jan 23, 2024

Conversation

juhoinkinen
Copy link
Member

@juhoinkinen juhoinkinen commented Dec 11, 2023

It is a good practice to inform how to report vulnerabilities, which is what SECURITY.md file is for.

I have worded this in SECURITY.md file:
> However, the dependencies of a given Annif release are pinned only on minor version level

But this is actually not true; [Edited this part to include a true statement.]
There are the following patch level version pinnings:

  • connexion 2.14.2
  • fasttext 0.9.2
  • lmdb 1.4.1
  • yake 0.4.5

Right now I don't remember why they are pinned to patch level. Need to check that. It would be good that all (security) patches of dependencies could be applied without the need to update Annif version. Does some of these dependencies have such a backward compatibility policy that conflicts with Annif's policy?

Also reword the bottom list. [Done.]

Also at the moment Annif repo has Security advisories enabled (I enabled it when looking at this security reporting a while ago), which allows anyone to give a report via navigating to the Security tab in this repo. Having two reporting ways (finto-posti email and this reporting) can be confusing, so maybe the Security advisories functionality should be disabled.

@juhoinkinen
Copy link
Member Author

I don't see a reason to have patch-level pinning of dependencies. I propose to pin only the minor version levels:

  • connexion 2.14.2 -> 2.14.*

  • fasttext 0.9.2 -> 0.9.*

  • lmdb 1.4.1 -> 1.4.*

  • yake 0.4.5 -> 0.4.*

This should be done in a separate PR/issue, possibly with the issue #747.

@juhoinkinen
Copy link
Member Author

Gunicorn is about to set up a security policy too, either via SECURITY.md or the Security advisories / Private Vulnerability Reporting: benoitc/gunicorn#3106

We could wait and see what their solution will be.

Copy link

codecov bot commented Jan 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a501e53) 99.67% compared to head (f4046c2) 99.67%.
Report is 5 commits behind head on main.

❗ Current head f4046c2 differs from pull request most recent head 058fd63. Consider uploading reports for the commit 058fd63 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #751   +/-   ##
=======================================
  Coverage   99.67%   99.67%           
=======================================
  Files          89       89           
  Lines        6404     6404           
=======================================
  Hits         6383     6383           
  Misses         21       21           

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

@juhoinkinen
Copy link
Member Author

I asked for a review from ChatGPT and addressed the good comments.

But this is actually not true; there are the following patch level version pinnings:

  • connexion 2.14.2
  • fasttext 0.9.2
  • lmdb 1.4.1
  • yake 0.4.5

For this, I reworded the relevant part: "...note that most of the dependencies of a given Annif release are pinned only on minor version level...".

@juhoinkinen juhoinkinen marked this pull request as ready for review January 22, 2024 15:05
Copy link

sonarcloud bot commented Jan 23, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@juhoinkinen juhoinkinen merged commit b7ecfd2 into main Jan 23, 2024
10 of 11 checks passed
@juhoinkinen juhoinkinen deleted the add-security-md branch January 23, 2024 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant