docs(security): self-contained disclosure channel + document GitHub-native scanning - #163
Merged
dev-fani merged 2 commits intoAug 30, 2026
Conversation
…GitHub-native scanning The disclosure instructions previously pointed only to "the FaniLab organization contact in the smart contract repository's SECURITY.md" — a reporter had to locate and trust a different repository to find any way to reach the maintainers, and CODE_OF_CONDUCT.md's Enforcement section inherited the same gap. Reporting a Vulnerability now leads with GitHub private vulnerability reporting for this repository (the Report a vulnerability form / Security tab), a direct in-repo channel that needs no email address and no other repository. The smart-contract cross-reference stays as supplementary context. CODE_OF_CONDUCT.md needs no change — its pointer to this file now resolves to a real channel. Also documents the two GitHub-native, free-for-public-repos features under a new Automated Security Tooling section: Dependabot security updates (advisory -driven PRs, distinct from the weekly version-update schedule) and secret scanning. closes fanilabs#123 closes fanilabs#124
|
@hartz0 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
2 participants
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.
Summary
Two documentation gaps in the security policy, both in
docs/SECURITY.md.1. No self-contained contact channel — closes #123
The entire disclosure instruction was "email the maintainers (see the FaniLab organization contact in the smart contract repository's
SECURITY.md)". A researcher who finds this repo directly had no in-repository way to know who to contact or how — they had to locate and trust a sibling repository first.CODE_OF_CONDUCT.md's Enforcement section, which points at "the contact listed in the project'sSECURITY.md", inherited the same dead end.Change: Reporting a Vulnerability now leads with GitHub private vulnerability reporting for this repository — the
Report a vulnerabilitybutton under the Security tab /https://github.com/fanilabs/backend/security/advisories/new. That is a direct, in-repo channel needing no email address and no other repository. The smart-contract cross-reference is kept as supplementary context, not the sole mechanism.CODE_OF_CONDUCT.mdneeds no edit — its pointer now resolves to a real channel (noted explicitly in the section).2. GitHub-native scanning undocumented — closes #124
Added an Automated Security Tooling (GitHub-native) section documenting:
.github/dependabot.ymlThis PR is the documentation half. For the docs to be accurate, a repo admin must, under Settings → Code security:
Report a vulnerabilityform this PR links actually exists)Verification (per the issues): re-run
gh api repos/fanilabs/backend --jq '.security_and_analysis'after the settings change and confirmsecret_scanninganddependabot_security_updatesboth report"enabled".Testing
Documentation-only change. Prose reviewed; internal references (
CODE_OF_CONDUCT.md,.github/dependabot.yml, the Secrets section) verified to resolve.