Skip to content

Latest commit

 

History

History
149 lines (117 loc) · 9.29 KB

SECURITY.md

File metadata and controls

149 lines (117 loc) · 9.29 KB

Security & Privacy

German interface, 2.1.0

English and German interface strings are bundled locally. Language selection adds no service, permission, telemetry or text retention. Model instructions retain their existing English wording. Build 30 also widens Settings for localized labels without changing translation or paste safeguards.

Download measurement

Maintainers can read GitHub's existing release-asset counters and repository traffic aggregates. This adds no app telemetry or website tracking. Counters include repeat requests, update payloads and maintainer verification; they do not identify unique users, installations or active usage. The README's website, guide and app-catalogue links open ordinary public web pages.

Website research documents

The docs/marketing/ Reddit brief uses public community posts and synthetic example ideas. It adds no tracking, account integration, message sending or text collection. Record only owned disposable text in any eventual workflow demo.

The dated docs/seo/ package uses public search/vendor evidence and authored synthetic examples. It adds no app network requests, diagnostics or text retention. Deployable guides are maintained in the separate OneKapisch website; those routes do not add analytics or submit visitor text. Website hosting can receive ordinary request metadata. Never add private selections, support documents or actual customer messages to the research package without explicit permission.

Easy Write is designed to be private by default. This document explains exactly what it does, what permissions it needs and why, and how to report a security issue.

Data flow

  • Translation and actions run entirely on-device using Apple's Foundation Models framework. Your text is never uploaded or included in diagnostics. Only explicitly enabled history saves it locally.
  • No accounts, no API keys, no telemetry, no analytics.
  • The text you select is read from your current selection, sent to the on-device model, and the result is pasted back or shown in a popup.
  • Selection capture reads Accessibility directly and does not modify the clipboard. Temporary output pastes are restored only while owned. Output pastes are marked transient for compatible clipboard managers. Unsupported selection APIs fail without copying unrelated clipboard text.
  • Automatic replacement verifies the source process, AX window, field, selection range and text. Changed or unverifiable targets show a review card instead. The HUD reports "Paste sent", since synthetic keystrokes have no delivery acknowledgement.
  • Current source also reads WebKit selections through AXSelectedTextMarkerRange and AXStringForTextMarkerRange. Opaque marker identities stay in memory for the operation; they are not logged or serialized. Re-reading must preserve the marker identity and text, alongside the original process, window and field, before a replacement can be sent.

Network access

Easy Write's background networking is limited to checking for updates, through Sparkle, and only if you allow it (Sparkle asks on the second launch; you can change it in Settings → Updates).

  • It requests https://www.onekapisch.com/products/easy-write/appcast.xml, and downloads the update from GitHub Releases when you choose to install one.
  • The request carries the app's version in its user agent. Optional system profiling is turned off (SUEnableSystemProfiling is false). The server can still observe ordinary HTTP metadata, including the connection's IP address.
  • Updates are verified with an EdDSA signature and Apple's notarization before they're installed.
  • Nothing you write is ever part of an update check.

Source builds disable update configuration by default. Release builds use EW_ENABLE_UPDATES=1 and still request user consent for checks. Clicking a Studio, support, source or shared-action link opens an external site in the browser. Studio links include product/campaign attribution parameters, not selected text. The destination can receive normal browser network metadata.

Generated candidates in dist/ are ignored by Git. Signing alone does not make a candidate safe to distribute: Apple notarization, stapling, Gatekeeper acceptance and a matching signed update payload remain release gates. Local 2.0 build 24 has passed these static checks, including independent payload-signature verification. The owner approved public launch on 2026-10-23. Public DMG bytes and signed feed were downloaded and verified against the accepted artifacts. Publication does not verify clean-Mac installation, physical compatibility, VoiceOver or an installed Sparkle upgrade; those checks remain outstanding. Pre-Sparkle 1.x requires a manual DMG upgrade. Homebrew is not live. The first image with post-signing Finder metadata is retained under an ignored rejected/ directory and must never be distributed. Credentials and private keys stay in Keychain; local preparation does not export them.

Maintainer release tooling

Public 2.0.2 build 28 adds WebKit text-marker capture without clipboard capture, marker serialization, selected-text diagnostics or network inference. The signed/notarized public payload matches its verified candidate; see docs/notarization-2.0.2-build28.md for evidence. Canonical signed feed bytes and a user-initiated installed Sparkle upgrade to build 28 were verified on 2026-10-24 without changing consent. This does not certify unattended updates.

release.sh defaults to a read-only plan. Explicit --prepare submits only the built app and DMG to Apple, uses existing Keychain credentials, and writes a new private candidate directory. It does not export signing keys, alter source versions, delete old candidates or publish to GitHub. The signed payload is verified against the configured app public key; mounted bundles are checked before and after outer-image notarization. Previous signed feed items are retained. Failed candidates stay on disk for inspection and must not be distributed. Owner may remove obsolete local candidates deliberately after preserving needed evidence. No selected text is processed by release tooling; model checks use synthetic inputs. See release process.

What's stored on your Mac

What Where Your control
Settings, glossary, actions, per-app memory, usage counts ~/Library/Preferences/com.onekapisch.easywrite.plist Settings
Opt-in originals and results (up to 100, 1–30 days) ~/Library/Application Support/Easy Write/history.json Off by default; disable to delete, or clear manually; excluded apps

Password managers and Keychain Access are excluded from history by default. Unknown source apps are excluded too. History is unencrypted JSON with owner-only permissions (folder 0700, file 0600), not a defence against malware running as the same user. Expired entries are pruned every minute while running, after wake, on retention changes and on launch. Cleanup cannot run while the app is closed. Disabling history deletes the file, not backups or APFS snapshots. Upgrading an early 2.0 preview requires fresh explicit consent and clears implicit history.

Permissions

Permission Why it's needed
Accessibility To read AX selected text and send a target-validated paste. Apps must expose their selection; unverifiable replacement falls back to review.

Normal app use needs no full-disk access, microphone, camera, contacts, location or screen recording.

The explicit developer command --launch-assets <directory> is an exception: it uses existing Screen Recording permission to record only its own synthetic demo window with ScreenCaptureKit. It refuses to record if permission is unavailable and never requests it. No desktop display, other app window, microphone, clipboard or real history is captured. The normal app delegate and hotkeys do not start in this mode. Its throwaway settings domain is removed after export.

Shared actions

Actions can be shared as links. A shared action is someone else's instruction, so Easy Write always shows its full text before adding it, adds it without a shortcut, and starts it in popup mode so it can't replace any text until you switch it over yourself. Links with control characters or bidirectional-override characters are rejected, so what you're shown is exactly what runs.

Why it's not on the Mac App Store

Replacing selected text in arbitrary apps requires posting synthetic keystrokes, which the App Store sandbox forbids. Source builds remain supported with updates disabled by default. The notarized 2.0 build-24 DMG is publicly available for manual installation. See launch status for dated public-delivery verification.

Reporting a vulnerability

If you find a security issue, please do not open a public issue. Open a GitHub security advisory or email support@onekapisch.com. You'll get a response as quickly as possible, and credit if you'd like it.

Appearance patch, 2026-10-23

Version 2.0.1 changes local rendering and synthetic developer tests only. It adds no permissions, network services, telemetry or text retention. Opaque menu surfaces prevent background content from bleeding through; they are a readability measure, not a screen-sharing privacy feature. Signed updates preserve the existing public key and opt-in update policy.