docs: add security policy#18
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Added a repository security policy that documents supported versions, the private vulnerability reporting channel, required report details, response targets, and coordinated disclosure expectations. Added a Security section to the README linking to the policy.
Why
The repository had no documented process for reporting vulnerabilities, despite project guidance requiring private disclosure. GitHub private vulnerability reporting is enabled, so contributors now have a clear and functional confidential channel.
Testing
npm run build- passed.npm test- passed; 62 tests passed.npm run lint- passed.npm run prepublishOnly- passed; build succeeded and 62 tests passed.node bin/opk scan src/cli --json- passed with 0 findings.npm run scan- exited 1 with the existing 18 errors and 33 warnings from repository fixtures and rule definitions.npm pack --dry-run --json- passed with 43 package files.SECURITY.md.Risks
The response targets are maintainer goals rather than service-level guarantees. Supported-version declarations must be updated when the next minor version is released.
Follow-up
Update the supported versions table when OpenPolicyKit 0.4.0 is released.