Uninstall Mac apps with every file they leave behind, and see why each belongs. Free up space, fine-tune macOS, and set up Terminal.
Swift cache-cleanercleanerclideveloper-toolsdisk-cleanupdisk-spaceduplicate-finderhomebrewliquid-glassmac-cleanermacosmacos-appmacos-golden-gatemacos-tahoemacos-tweaksswiftswiftuiterminal-themesuninstalluninstaller
Bring README, PRIVACY, and SECURITY up to date
Țugui Dragoș6666f67de2fa
diff --git a/PRIVACY.md b/PRIVACY.mdindex 4c0766ef..27663777 100644--- a/PRIVACY.md+++ b/PRIVACY.md@@ -6,14 +6,15 @@Settings > Privacy shows what Peel sends and every address it or Homebrew may contact.-Peel sends no analytics and has no account. On its own, it goes online only to check your apps for updates, and you can-turn that off.+Peel sends no analytics and has no account. On its own, it goes online only to check your apps, and itself, for+updates, and you can turn that off.-Each check asks one app's own update feed about that app alone, or the App Store about an app bought there, and says-only that Peel is asking, with the country of your Mac's region for the App Store, whose answer depends on it: not which-version, not your macOS, and not your languages. Every check uses https, and a feed that sends it elsewhere is followed-only to another https address. Each check asks about one app, but taken together, the checks show the App Store which of-its apps you have, and GitHub which of your apps update through it.+Each check asks one app's own update feed about that app alone, or the App Store about an app from the App Store. It+says only that Peel is asking, and tells the App Store the country of your Mac's region, since its answer depends on+it. It sends no version, of the app or of Peel, and nothing about your macOS or your languages. Every check uses+HTTPS, and a feed that sends it elsewhere is followed only to another HTTPS address. Each check asks about one app, but+taken together, the checks show the App Store which of its apps you have, and GitHub which of your apps update through+it.For an update that waits, Peel also reads the page of release notes the app's feed names, and the app's own feed whenHomebrew found the update, once per version, and keeps the notes so they show with no connection. When the feed names@@ -25,15 +26,16 @@ Homebrew goes online only when you ask it to: to update, to upgrade, to repair irepository whether its main branch was renamed, or to scan for vulnerabilities. That scan, which Homebrew runs as`brew vulns`, is the one time a list of what is installed leaves your Mac all at once: for each formula it checks,where its code comes from (the address of its source repository and the release tag, or a package's name) and its-version, sent to `api.osv.dev`. Your own Homebrew settings (a `brew.env` file) can change what Homebrew does, and the-Homebrew page then says what they change.+version, sent to `api.osv.dev`. Peel runs Homebrew with its analytics turned off. Your own Homebrew settings (a+`brew.env` file) can change what Homebrew does, analytics included, and the Homebrew page then says what they change.-Peel checks for its own updates with Sparkle: it reads Peel's signed feed on GitHub over https, saying only that Peel+Peel checks for its own updates with Sparkle: it reads Peel's signed feed on GitHub over HTTPS, saying only that Peelis asking, and downloads a new version only when you choose to install it, then checks that it is signed as Peel'sbefore installing it.-Turn off Check for app updates in Settings, and Peel contacts nothing on its own; the `peel updates` command still-checks whenever you run it, whatever that switch says.+Turn off Check for app updates in Settings, and Peel contacts nothing on its own. Check for Updates in the Peel menu+still asks about Peel when you choose it, and the `peel updates` command still checks whenever you run it, whatever+that switch says.Report an Issue, in the Help menu, opens GitHub's form for a new issue with Peel's version, your macOS version, andwhether your Mac has Apple silicon or Intel already filled in. They are in the address the browser opens, so GitHub sees@@ -43,9 +45,10 @@ them as the page loads, and they are posted only if you send the issue.| Address | Why ||---|---|-| `itunes.apple.com` | The latest version of an app bought from the App Store. No other app is ever asked about. |-| `github.com` | Peel's own update feed, release feeds of apps that update through GitHub, and wherever GitHub sends the download. Homebrew also updates itself and its taps from here when you ask it to, Repair Taps included. |+| `itunes.apple.com` | The latest version of an app from the App Store. No other app is ever asked about. |+| `github.com` | Peel's own update feed, release feeds of apps that update through GitHub, and wherever GitHub sends the download. Homebrew also updates itself and its taps from here when you ask it to, Repair Taps included, and a tap you added from another address from there. |+| `api.github.com` | When you ask Homebrew to update or upgrade, it first asks here whether Homebrew itself, and each tap kept on GitHub, has changed. || `formulae.brew.sh` | Homebrew's list of packages, when you ask Homebrew to update or upgrade. |-| `ghcr.io` | Where Homebrew downloads the packages it upgrades. A cask comes from its maker's own address. |+| `ghcr.io` | Where Homebrew downloads the packages it upgrades, and wherever it redirects. A package with no ready-made build for your Mac downloads its source from the address its formula names, and a cask comes from its maker's own address. || `api.osv.dev` | The database of known vulnerabilities that Homebrew's scan checks your formulae against. || Each app's own update feed | The address written inside the app, such as a Sparkle feed, and wherever it redirects. For an update that waits, also the page of release notes the feed names, once per version. |diff --git a/README.md b/README.mdindex 083dbf5b..aac1081f 100644--- a/README.md+++ b/README.md@@ -54,9 +54,11 @@ why it starts at macOS 26 and won't open on an older one.brew install --cask tuguidragos/tap/peel```-Homebrew also puts the `peel` command on your path.+Homebrew also puts the `peel` command on your path, with its manual page and shell completions.-To update Peel, choose Check for Updates… in the Peel menu. While Check for app updates is on, Peel also looks once a+### Updates++To update Peel, choose Check for Updates in the Peel menu. While Check for app updates is on, Peel also looks once aday, and About Peel says when a new version is out. Peel shows what is new and installs the update only when youchoose, once it has checked that the update is signed as Peel's. A copy Homebrew installed updates the same way, and`brew upgrade --cask peel` updates it too.@@ -92,14 +94,16 @@ does, what Peel asks for and why, and how to remove Peel.A cleaner should never cost you something you wanted. Peel is built around that.- **The Trash, never deletion.** Everything Peel removes goes to the Trash, and History puts it back where it was.- Four things can't be undone that way, and Peel says so before you confirm them: Homebrew's own uninstall and clean- ups, resetting an app's privacy permissions, and Force Quit for an app that won't quit.+ Remove Downloads in iCloud Drive only frees this Mac's copy of a file, which stays in iCloud. Four things can't be+ undone that way, and Peel says so before you confirm them: Homebrew's own uninstall, its cleanups, resetting an+ app's privacy permissions, and Force Quit for an app that won't quit.[SAFETY.md](SAFETY.md#what-peel-changes-besides-moving-files) lists everything else Peel changes besides movingfiles.-- **Protected places stay protected.** Peel refuses to move iCloud Drive, keychains, your SSH and signing keys, the- keys of crypto wallets, Mail, Messages, Safari, Contacts, Calendars, Notes, photo and music libraries, iPhone and- iPad backups, and the Desktop, Documents, and Downloads folders themselves. No selection can override it. A- browser profile with a wallet extension Peel knows, such as MetaMask, stays too.+- **Protected places stay protected.** Peel refuses to move iCloud Drive and anything else that syncs to your other+ devices, keychains, your SSH and signing keys, the keys of crypto wallets, Mail, Messages, Safari, Contacts,+ Calendars, Notes, photo and music libraries, iPhone and iPad backups, and the Desktop, Documents, and Downloads+ folders themselves. No selection can override it. A browser profile with a wallet extension Peel knows, such as+ MetaMask, stays too.- **Nothing shared, nothing unknown.** A file another app also uses is never selected for you. A folder Peelcouldn't measure or read is shown as unknown, never as empty, and never selected for you either.- **Every decision explained.** When Peel holds a file back, the row says why, and each item is checked once more@@ -117,7 +121,7 @@ every address Peel or Homebrew may contact.The command ships inside the app. Settings > General shows the Terminal command that puts it on your path, and aHomebrew install puts it there for you. [GUIDE.md](GUIDE.md#the-peel-command) says how it asks before it moves-anything, and `man peel` lists every option.+anything, and `peel help <command>` lists every option. With a Homebrew install, `man peel` does too.<details><summary>All commands</summary>@@ -162,9 +166,8 @@ and choose Uninstall with Peel, once the Finder extension is on in System SettinPeel moves files to the Trash instead of deleting them, and History can put them back while they are still there(it keeps the latest 20,000 items). What can't be undone, such as Homebrew's own uninstall, Peel names before you-confirm it. Peel selects for you only what it matched by the app's identifier, its name, or its installer's-receipt, never a file another app uses, and refuses to touch places like iCloud Drive, your keychains, Mail,-Messages, and photo libraries.+confirm it. Peel selects for you only what it is sure, or nearly sure, belongs to the app, never a file another app+uses, and refuses to touch places like iCloud Drive, your keychains, Mail, Messages, and photo libraries.</details>@@ -173,9 +176,9 @@ Messages, and photo libraries.<br>-No. Peel has no analytics and no account. It goes online only to check your apps for updates, which you can turn-off, and when you ask Homebrew to do something. [PRIVACY.md](PRIVACY.md) says what each of those sends, and-where.+No. Peel has no analytics and no account. It goes online only to check your apps, and itself, for updates, which+you can turn off, to download a new Peel when you choose to install it, and when you ask Homebrew to do something.+[PRIVACY.md](PRIVACY.md) says what each of those sends, and where.</details>@@ -197,10 +200,9 @@ macOS 26 and every version since.<br>macOS keeps a background item's approval by its developer and its identifier, so a record left by an earlier copy-of Peel can keep the helper waiting even while Login Items & Extensions in System Settings shows Peel turned on.-First choose Uninstall Helper in Peel's Settings > Helper, then Install Helper. If it still waits, run this in-Terminal, then restart your Mac, as [Apple's deployment guide](https://support.apple.com/guide/deployment/depdca572563/web)-recommends:+of Peel can keep the helper waiting even while Login Items & Extensions in System Settings shows Peel turned on. If+Peel's Settings > Helper still asks you to allow Peel, run this in Terminal, then restart your Mac, as+[Apple's deployment guide](https://support.apple.com/guide/deployment/depdca572563/web) recommends:```bashsudo sfltool resetbtm@@ -215,12 +217,14 @@ again.You need macOS Tahoe 26 or later, Xcode 27 (Swift 6.4), and a team to sign with, even a free one. First build Sparkle,which updates Peel, from its source with `zsh Scripts/build_sparkle.sh`. Then open `Peel.xcodeproj`, choose your team-for the four targets under Signing & Capabilities, and run the Peel scheme. Or, from Terminal, with your own team ID:+for Peel, PeelHelper, PeelFinder, and PeelCLI under Signing & Capabilities, and run the Peel scheme. Or, from Terminal,+with your own team ID:```bashzsh Scripts/build_sparkle.sh-xcodebuild -project Peel.xcodeproj -scheme Peel -configuration Debug -derivedDataPath build/DerivedData DEVELOPMENT_TEAM=YOUR_TEAM_ID build-swift test --package-path Packages/PeelCore+xcodebuild -project Peel.xcodeproj -scheme Peel -configuration Debug -derivedDataPath build/DerivedData \+ DEVELOPMENT_TEAM=YOUR_TEAM_ID build+swift test --package-path Packages/PeelCore -Xswiftc -warnings-as-errors```The helper starts only as the team named in `Support/com.tuguidragos.Peel.Helper.plist`, so to install the helper@@ -231,7 +235,8 @@ you build, put your team there as well. [ARCHITECTURE.md](ARCHITECTURE.md) explaBug reports, ideas, and pull requests are welcome.-- Found a bug or have an idea? [Open an issue](https://github.com/TuguiDragos/Peel/issues/new/choose).+- Found a bug? [Report it](https://github.com/TuguiDragos/Peel/issues/new/choose). Have an idea? Suggest it in+ [Discussions](https://github.com/TuguiDragos/Peel/discussions/new?category=ideas).- Want to change Peel? [CONTRIBUTING.md](CONTRIBUTING.md) says how to start, and [AGENTS.md](AGENTS.md) holds therules every change follows. Working with a coding assistant? Give it AGENTS.md first.- Found a security problem? Please report it privately, as [SECURITY.md](SECURITY.md) describes, and not in adiff --git a/SECURITY.md b/SECURITY.mdindex 77803bbf..80618e79 100644--- a/SECURITY.md+++ b/SECURITY.md@@ -5,8 +5,9 @@ protects, and how, has a page of its own: [SAFETY.md](SAFETY.md).## Reporting a security problem-Report it privately on GitHub, with [Report a vulnerability](https://github.com/TuguiDragos/Peel/security/advisories/new)-on the repository's Security tab, or email **[email protected]** with "Peel security" in the subject line.+Report it privately on GitHub, with+[Report a vulnerability](https://github.com/TuguiDragos/Peel/security/advisories/new) on the repository's Security+tab, or email **[email protected]** with "Peel security" in the subject line.Do not open a public issue, a discussion, or a pull request for a security bug. Do not post itanywhere public until the fix ships or 90 days have passed since your report, whichever comes first,@@ -16,9 +17,9 @@ Please include, as much as you have:- The version of Peel and the build number, from About.- Your macOS version and whether the Mac is Apple silicon or Intel.-- Which component: the app, the privileged helper, the Finder extension, or the `peel` CLI.+- Which component: the app, the privileged helper, the Finder extension, the `peel` command, or Sparkle.- What an attacker gains, and what they need to start with. State plainly whether the attack- needs a local unprivileged process, an admin account, or a user action.+ needs a local unprivileged process, an administrator account, or a user action.- Steps to reproduce, and a proof of concept if you have one. A short script or a small sampleapp is worth more than a description.- Anything you want credited, or that you would rather stay anonymous.@@ -33,7 +34,7 @@ point of failure.| Stage | Target || --- | --- |-| Acknowledgment that the mail arrived | 2 working days |+| Acknowledgment that your report arrived | 2 working days || First assessment: confirmed, not confirmed, or need more detail | 7 days || Fix released for a confirmed high-severity issue | 30 days || Fix released for anything else confirmed | 90 days |@@ -79,13 +80,15 @@ are out of scope.## ScopePeel is not sandboxed and is distributed outside the Mac App Store. Releases are signed with a Developer ID and-notarized by Apple. It has four pieces:+notarized by Apple. It has four pieces of its own, and carries Sparkle, which updates it:- **Peel.app**: the interface, running as you.- **com.tuguidragos.Peel.Helper**: a system daemon registered with `SMAppService`, running as**root**, reachable only over an XPC Mach service.- **PeelFinder**: a sandboxed Finder Sync extension that opens `peel://open?path=`.-- **peel**: a command line tool inside `Peel.app/Contents/Helpers`. It never talks to the helper.+- **peel**: a command-line tool inside `Peel.app/Contents/Helpers`. It never talks to the helper.+- **Sparkle**: the framework in `Peel.app/Contents/Frameworks`, with its programs Autoupdate and Updater.app,+ which install an update of Peel once the person chooses it.### In scope@@ -112,8 +115,10 @@ have, and anything that destroys data that cannot be recovered.- Argument injection or unexpected behavior in the operation that runs `launchctl` for a launchdaemon (bootstrap, bootout, kickstart, enable, and disable), or in the one that moves the helper'sown ledger to the Trash for Remove Peel.-- Anything that leaves a root daemon installed, running, or reachable after Peel is removed, or- that lets a non-admin install or replace it.+- Anything that leaves a root daemon installed, running, or reachable after Remove Peel, or that+ lets an account that is not an administrator install, replace, or remove it. A Peel dragged to+ the Trash leaves its helper registered, as [GUIDE.md](GUIDE.md#uninstall-peel) says, until it is+ put back and removed with Remove Peel.**Destruction of data.**@@ -134,7 +139,7 @@ have, and anything that destroys data that cannot be recovered.from the Finder extension, from any other process on the Mac, or from a web page, and throughPeel's other ways in: an app dropped on it or opened with it, and the actions it gives Shortcuts.- A sandbox escape in the Finder Sync extension.-- Hijacking the `peel` CLI, or getting it to perform an operation that should require the helper.+- Hijacking the `peel` command, or getting it to perform an operation that should require the helper.- Update-feed handling: Peel fetches update feeds whose addresses come out of each scanned app, aSparkle feed in its `Info.plist` or an Electron app's `app-update.yml`, and for an update thatwaits, the page of release notes the feed names, which it reads as HTML, Markdown, or plain text.@@ -142,31 +147,40 @@ have, and anything that destroys data that cannot be recovered.code execution, or that leaks data off the Mac, is in scope.- Leaking the list of a user's installed apps, file paths, or scan results off the Mac, beyond what[PRIVACY.md](PRIVACY.md) describes.-- Peel's own updates: getting Peel to install, or to offer, an update that is not signed with Peel's- update key, one older than the copy installed, or one from anywhere but its signed feed. Peel- updates itself with Sparkle, so a flaw in Sparkle that reaches Peel is in scope too, and it is- passed on to the Sparkle project.+- Peel's own updates: getting Peel to install, or to offer, an update that is not signed as Peel's+ (with Peel's update key, or, as Sparkle allows when that key changes, in a disk image signed with+ Peel's Developer ID), one older than the copy installed, or one from anywhere but its signed feed.+ Peel updates itself with Sparkle, so a flaw in Sparkle that reaches Peel is in scope too, and it+ is passed on to the Sparkle project.**What Peel reads, runs, and writes.**-- Files from apps and disks Peel doesn't trust, which it reads to decide what is what: other apps'- property lists, the headers of their programs (Mach-O), and the directory of a ZIP archive, read- without extracting it. One that causes memory corruption, an exploitable crash, or a wrong answer- about what may be removed is in scope.+- Files from apps, projects, and disks Peel doesn't trust, which it reads to decide what is what:+ other apps' property lists and product files (`product-info.json`, `product.json`), the headers of+ their programs (Mach-O), the directory of a ZIP archive, read without extracting it, the first line+ of a crash report, a Git repository's index, a launch job's file, a browser's native messaging+ manifest, and the package definitions Homebrew and its taps give, whose paths an uninstall lists.+ One that causes memory corruption, an exploitable crash, or a wrong answer about what may be+ removed is in scope.- The programs Peel runs with what a scan found: `defaults`, `launchctl`, `tccutil`, `pkgutil`, and`pluginkit`, given an app's, a package's, or an extension's identifier, a launch job's label, or apath, and `brew`, including one chosen in Settings. Getting one to run with arguments an attackerchose, or getting Peel to run another program, is in scope.-- What Peel writes besides moving files: the Tweaks, which also restart the Dock, Finder, Control- Center, or Window Manager with `killall`, and the settings the Terminal page writes for Terminal,- the shell, ssh, and Git. Getting either to write anything but the setting the user chose, or to- write it anywhere else, such as through a link, is in scope.--**Peel's website.**--- peel.tuguidragos.com, which GitHub Pages serves from this repository's `docs/` folder. A way to- change what it shows, or to send its downloads anywhere but this repository's releases, is in- scope.+- What Peel writes besides moving files, each listed in+ [SAFETY.md](SAFETY.md#what-peel-changes-besides-moving-files): the Tweaks, which also restart the+ Dock, Finder, Control Center, or Window Manager with `killall`; the settings the Terminal page+ writes for Terminal, the shell, ssh, and Git; the Dock's lists, when an uninstall takes an app's+ icon out; the preference domains it forgets with `defaults delete`; the copies of an app's settings+ a reset saves and puts back; and the Time Machine mark Build Artifacts sets. Getting any of them to+ write anything but what the user chose, or to write it anywhere else, such as through a link, is+ in scope.++**Peel's website and Homebrew tap.**++- peel.tuguidragos.com, which GitHub Pages serves from this repository's `docs/` folder, and the+ Homebrew tap, `TuguiDragos/homebrew-tap`, which `brew install --cask tuguidragos/tap/peel` reads. A+ way to change what either shows or installs, or to send its downloads anywhere but this+ repository's releases, is in scope.### Out of scope@@ -175,11 +189,12 @@ Not because they do not matter, but because they are not bugs in Peel.- **Anything that needs root to begin with.** If the attacker is already root, they can do all ofthis without Peel.- **Anything an administrator can already do on macOS.** `/Applications` is writable by any- admin by design. An admin who can already delete an app has gained nothing by using Peel to- delete it. Escalation from *admin* to *root without an authentication prompt* is in scope, beyond- what the helper does for an administrator by design once it is approved: moving items in the- folders `PrivilegedPathPolicy` allows to the Trash and back, and running `launchctl` for another- developer's launch daemon. Admin doing admin things is not.+ administrator by design. An administrator who can already delete an app has gained nothing by+ using Peel to delete it. Escalation from *administrator* to *root without an authentication+ prompt* is in scope, beyond what the helper does for an administrator by design once it is+ approved: moving items in the folders `PrivilegedPathPolicy` allows to the Trash and back, and+ running `launchctl` for another developer's launch daemon. An administrator doing what+ administrators do is not.- **Peel deleting what the user told it to delete.** The confirmation, the preselection rules, andthe Trash are the safety net. A user who selects a checkbox and confirms is not a vulnerability. Abug that makes Peel select the checkbox *for* them, or that removes something not shown, is.@@ -234,13 +249,12 @@ This safe harbor is adapted from the disclose.io model terms, which are publishe## Advisories and CVEs-Fixed issues are written up as an advisory in the release notes.+Each fixed issue gets a GitHub security advisory, and the release notes link to it.-If an issue warrants one, a CVE will be requested. Once the source repository is public on-GitHub, that goes through GitHub Security Advisories: GitHub is a CVE Numbering Authority for-open source projects hosted on GitHub. You are welcome to request the CVE yourself instead, and-to be named in the record; say so in your report. If you would rather not wait, MITRE also takes-requests directly.+If an issue warrants one, a CVE will be requested through GitHub Security Advisories: GitHub is a+CVE Numbering Authority for open source projects hosted on GitHub. You are welcome to request the+CVE yourself instead, and to be named in the record; say so in your report. If you would rather not+wait, MITRE also takes requests directly.## Contact