Repository navigation
fix: security policy, and fixes from a full audit #23
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
Merged
Merged
Changes from all commits
Commits
Show all changes
33 commits
Select commit
Hold shift + click to select a range
c14e0af
docs: add security policy
RealDoc06 2d39e07
fix(core): only fetch BeaconSync releases for real version strings
RealDoc06 775306d
fix(hub): check passwords without holding the database lock
RealDoc06 7736939
fix(hub): limit wrong password attempts per account
RealDoc06 218f048
fix(core): write token files owner-only from the start
RealDoc06 30ddb47
fix(deps): update zip to 9
RealDoc06 c8ccb65
fix(deps): update rusqlite to 0.43
RealDoc06 6f60c96
fix(cli): Windows backups leave out other backups and the retention rule
RealDoc06 a781ba7
fix(hub): bound Argon2 work and throttle unknown usernames too
RealDoc06 2c941c0
fix(cli): restores only clear a folder directly inside the server
RealDoc06 d1e5b34
fix(core): atomic writes use a unique, exclusively created temp file
RealDoc06 e7c0843
fix(core): release versions must start with a digit and have no empty…
RealDoc06 f66fde0
fix(hub): throttle case-insensitively and bound waiting sign ins
RealDoc06 03fbbc6
fix(cli): validate the world before a full restore deletes anything
RealDoc06 d0d6fc4
fix(core): remove temp files after failed writes and reject trailing …
RealDoc06 d281601
fix(hub): take the Argon2 queue slot before counting a sign in
RealDoc06 b64f73a
fix(cli): restores stop if the world can't be cleared and put the tok…
RealDoc06 cf2c538
fix(core): only clean up a temp file this write created
RealDoc06 00e980d
fix(hub): count a sign in attempt inside the Argon2 job
RealDoc06 e42c0e2
fix(cli): harden the full restore token write and clean up failed bac…
RealDoc06 bcb1bc8
fix: run every restore check before deleting, and cancel dropped Argo…
RealDoc06 d26cc3a
fix: check the token's real parent folder, refuse broken backups up f…
RealDoc06 95f3bb6
fix(cli): check the gzip checksum and token links before a full resto…
RealDoc06 bd19d3d
fix(cli): refused restores change nothing, so the agent no longer rol…
RealDoc06 cbd3972
fix(cli): the agent checks a restore before stopping Minecraft
RealDoc06 2693a09
fix(cli): restore the archive that was checked, and never lose a worl…
RealDoc06 2d36d3e
fix(cli): nested world folders restore again, and deploys check their…
RealDoc06 1f7d49e
fix(cli): only clear a world the backup holds, through real folders
RealDoc06 f642fbe
fix(cli): refuse a full restore only when the archive lacks a world t…
RealDoc06 af921f2
Revert "fix(cli): refuse a full restore only when the archive lacks a…
RealDoc06 782cf3a
Revert "fix(cli): only clear a world the backup holds, through real f…
RealDoc06 1a6d45f
fix(cli): trim the round 12-14 restore guards back to the reviewed core
RealDoc06 1b674e0
fix: final council nits
RealDoc06 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Security policy | ||
|
|
||
| ## Supported versions | ||
|
|
||
| BeaconSync is in alpha. Only the latest `0.1.0-alpha` release gets security fixes; update to it | ||
| before reporting. | ||
|
|
||
| ## Reporting a vulnerability | ||
|
|
||
| Please report privately, not in a public issue: open the repo's **Security** tab and choose | ||
| **Report a vulnerability** (GitHub private vulnerability reporting). | ||
|
|
||
| Include what is affected, the version, and how to reproduce it. | ||
|
|
||
| ## What to expect | ||
|
|
||
| - An acknowledgement within 7 days. | ||
| - An assessment and, if confirmed, a fix plan shortly after. Serious issues are fixed in a new | ||
| release first and disclosed in a GitHub security advisory once it is out. | ||
| - Credit in the advisory, unless you'd rather stay anonymous. | ||
|
|
||
| ## Scope | ||
|
|
||
| - The `beacon` CLI and server agent (`crates/cli`, `crates/core`) | ||
| - The desktop app (`apps/desktop`) | ||
| - The companion mods (`mods/`) | ||
| - The hub server (`crates/hub`) and the public hub at `beaconsync.realdoc06.it` | ||
|
|
||
| Out of scope: denial of service by flooding the public hub, issues in Minecraft, mod loaders, | ||
| Prism Launcher, Modrinth or CurseForge themselves, and mods a pack owner chose to ship (a pack | ||
| runs its mods' code by design). | ||
|
|
||
| Please test against your own hub (`beacon-hub`), not the public one. | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Enable private vulnerability reporting, or name a working private channel.
Lines 10-11 send reporters to a private reporting option. That option is disabled for this repository, so the policy has no working private channel. Enable private vulnerability reporting in the repository settings. A user with admin rights can also run
gh api -X PUT repos/RealDoc06/beaconsync/private-vulnerability-reporting. If the maintainers choose a different private channel, change lines 10-11 to name that channel.