ci: refuse to commit reMarkable's libqsgepaper.so - #27
Open
m4ndolore wants to merge 1 commit into
Open
Conversation
quill/ is a clean-room MIT implementation that links against reMarkable's libqsgepaper.so, but that library is theirs. Users extract it from a device they own (quill/build.sh fetches it over SSH); we never redistribute it. .gitignore covers quill/vendor/ and quill/build/, but that protection does not survive `git add -f`, a renamed blob, or a downstream repository that copies quill/ without the ignore rules. This adds the backstop: - scripts/ci/check-no-vendor-blob.sh — filename, path, and ELF content scan over tracked and staged files - scripts/ci/install-hooks.sh — pre-commit hook, so a leak is stopped before it enters history rather than after - .github/workflows/no-vendor-blob.yml — the same check on every push and PR, plus a full-history scan for the library by name and size - scripts/ci/README.md — what it catches and what to do when it fires Documentation under quill/vendor/ stays allowed; that directory legitimately holds a README explaining how to fetch the library. The library is matched by name and content, not by location. Verified: passes a clean tree and a vendor README; fails the blob committed by name, renamed elsewhere in the tree, and quill/build/ output; the hook blocks the commit; full history is clean. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
quill links against reMarkable's vendor display library. The library itself is reMarkable's property and must be extracted from a device the user owns — it must never be redistributed in this repository.
This PR adds:
scripts/ci/check-no-vendor-blob.sh— filename, path, and ELF-content scan over tracked and staged filesscripts/ci/install-hooks.sh— pre-commit hook.github/workflows/no-vendor-blob.yml— same check on push/PR, plus a full-history scanNo app, UX, or rM2-port changes.
.gitignorealready coversquill/vendor/andquill/build/; this is the backstop forgit add -f, a renamed blob, or a downstream copy that forgets the ignore rule.See
quill/README.mdandquill/CLEANROOM.mdfor the clean-room boundary this protects.