Documentation
For polinrider 3.0.x latest
Everything polinrider does, in the order you will need it.
1Install and run
- Quick start
Download, verify and run one program that checks this computer, a folder, a GitHub account or an organization for PolinRider.
- Verifying this repository
How to check that polinrider came from this repository: signed commits, attested releases and SHA256SUMS on every release.
- Verifying releases from before 3.0
Releases up to 2.3.0 were built when the repository was called polinrider-cleaner. How to check one of them is genuine now that it is polinrider-scanner.
- Quick start
2Read the result
- Exit codes
What each polinrider exit code means for scripts and CI: 0 clean, 1 review, 2 compromised and 3 could not run, and what to do after each one.
- False positives you will see
Scanner matches that look alarming but are harmless, each one confirmed during a real PolinRider cleanup, why they match and what to do about them.
- Exit codes
3Clean up, in this order
- Order matters
Why PolinRider comes back after a cleanup, and the order that stops it: machines, credentials, repositories, then every future push.
- The full checklist
Every step of a PolinRider cleanup on one checklist: infected computers, credentials, GitHub repositories and npm, and the checks still done by hand.
- A machine
Check macOS, Linux or Windows for PolinRider with one read-only program, before you touch GitHub: infected files, persistence and an installed implant.
- A personal GitHub account
Check every branch and tag of every repository you own for PolinRider, see who pushed what from GitHub's push record, then restore or clean what was hit.
- An organization
Check every repository, branch and tag in a GitHub organization for PolinRider, see who pushed what, then restore or clean every repository that was hit.
- Order matters
4Keep it out
The project
- Contributing
How to report a missed PolinRider detection or a false positive, and how to propose a change to the scanner's code or to its indicator set.
- Reporting a vulnerability
How to report a vulnerability in the PolinRider scanner privately through GitHub Security Advisories, and where to report an infection instead.
- What this does not promise
Read before running: an independent open source project by one person, not a commercial product, and what that means for you.
- Contributing
Last updated: