Repository navigation
Security
Controller administrator identities can authorise pairing changes. Recovery defaults on for newly added devices. Verified administrator credentials are retained while setup or enabled recovery needs them.
- Import independently obtained administrator credentials and accessory identity through the local administrator form. Builds containing native irestore support also accept keychain JSON; see format and build support. The irestore importer discards deleted records and unrelated categories/groups before retaining normalized HAP credentials; keep the source dump private. Use HTTPS to encrypt credentials in transit. If HA is behind a proxy, configure it to preserve the real client address so local-access checks work correctly.
- Raw exports are processed transiently and are never retained in flow state, logs, diagnostics or storage. Only normalized HAP credentials stay in the administrator-owned flow’s memory until consumed or cleared on flow removal. Standard HA forms accept pasted exports or manual credentials; the manual private-key field is masked.
- Credentials and recovery state are stored in
.storage/homepod_sensor_link/data.json, with directory permissions 0700 and file permissions 0600. Writes are atomic. Identity, key or permission mismatches block pairing changes. - The integration uses its own regular User controllers. It does not read credentials from, authenticate through, recover or reload native HomeKit entries. User permission is not an accessory-enforced “temperature-only” capability. Administrator credentials are used for provisioning and recovery of the integration’s own controllers.
- Recovery restores only the integration’s missing dedicated controller pairing and preserves existing pairings. It requires confirmed authentication failures and verifies fresh sensor reports afterward. Repair limits and blocked states persist across restarts.
- Removing a device deletes its owned credentials and recovery history. Removing the integration deletes all owned credentials, pending imports and history. On-device pairings, native sensors and external backups/exports remain. Delete unnecessary export copies separately.
- Disable other recovery engines before using HomePod Sensor Link.
- Review diagnostics before sharing. Keep keys, exports, backups and HA storage private. The integration’s diagnostics use anonymous device numbers and controlled status/error categories.
The optional macOS extraction wizard builds the repository's Swift helper against Apple frameworks before any security changes. It signs and runs the helper only after confirmation. SIP/AMFI changes, NVRAM writes and restarts are manual; restore SIP and the original boot arguments immediately after extraction, including after a failure.
After verifying restoration, the wizard reads its private dump and creates JSON automatically from the numbered selections. Keys are never printed or requested as terminal input. It syncs and reads back the JSON, records the completed output, and then deletes only the temporary key dump. Failed writes or verification retain the dump; interrupted cleanup can resume without copying keys again. Signing certificates and original HomeKit keychain records are retained. After HA setup succeeds, delete the JSON or move it to secure encrypted storage, and clear copied credentials from the clipboard.
Use GitHub issues for general support. For security concerns, request a private reporting channel before sharing details. Never post vulnerability details, credentials or complete HA storage/diagnostics in public issues.