summaryrefslogtreecommitdiff
path: root/SECURITY.md
diff options
context:
space:
mode:
Diffstat (limited to 'SECURITY.md')
-rw-r--r--SECURITY.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 0000000..6d26796
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,38 @@
+# Security
+
+This repository is **public**. It must never contain Apple ID credentials or
+iCloud session material.
+
+## What stays local only
+
+All auth state is under XDG config (default `~/.config/icloud-notes/`):
+
+| Path | Contents |
+|---|---|
+| `browser-profile/` | Chromium user-data (cookies, local storage) |
+| `storage-state.json` | Playwright-era cookie export (if present) |
+| `session.ok` | Login marker |
+
+These paths are gitignored. Mode should stay private (`700` on the config dir,
+`600` on session files).
+
+## What is in this repo
+
+- Source code that **drives** `icloud.com/notes` after *you* sign in locally
+- Docs / tests / skill text
+- **No** Apple passwords, 2FA codes, cookies, or account identifiers
+
+## Agent / operator rules
+
+- Never commit, paste, or upload `~/.config/icloud-notes/**`
+- Never put an Apple ID or password in `SKILL.md`, issues, or commit messages
+- `icloud-note login` opens a local browser for you to authenticate; the session
+ stays on disk under that XDG path
+
+## If session material were ever committed
+
+1. Treat it as compromised: sign out other sessions / change Apple ID password /
+ revoke app-specific passwords as appropriate.
+2. Remove the files from git history (filter-repo / BFG) and force-push only with
+ explicit operator approval.
+3. Delete the local profile and run `icloud-note login` again.