krz/domain-dig

 1# DomainDig
 2
 3[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=zerolabsco_domain-dig&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=zerolabsco_domain-dig)
 4[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=zerolabsco_domain-dig&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=zerolabsco_domain-dig)
 5
 6DomainDig is a local-first iOS domain inspection toolkit for DNS, web, ownership, monitoring, reporting, and audit workflows. The app gathers a point-in-time domain snapshot, normalizes it into a canonical `DomainReport`, and keeps user data on device unless the user exports, shares, or syncs it.
 7
 8## Current Release Target
 9
10Immediate release target: `v4.4.1`.
11
12This patch release focuses on release readiness: resolving duplicate Audit Mode implementations, aligning app/project version metadata, preserving audit persistence and backup/restore coverage, and refreshing docs for the current app surface.
13
14## Features
15
16- Domain inspection for DNS records, email security, TLS certificates, HTTP headers, redirects, IP geolocation, reachability, open ports, RDAP, ownership, subdomain discovery, and availability.
17- Canonical `DomainReport` output used by the app UI and exports.
18- History snapshots with change summaries, risk scoring, notes, and saved domain context.
19- Dashboard, watchlist, monitoring, workflows, batch results, integrations, and data portability screens.
20- Audit Mode with sessions, checklist progress, reviewer notes, findings, evidence snapshots, audit timelines, and markdown/json/pdf export.
21- Backup and restore for tracked domains, history, audit sessions, workflows, monitoring settings/logs, app settings, and local feature metadata.
22- Local-first operation with no required backend.
23- Optional local API surface for automation-compatible report output.
24
25## Data And Privacy
26
27DomainDig stores local app data in on-device persistence. Backup exports can include tracked domains, lookup history, audit sessions, workflow definitions, monitoring configuration, monitoring logs, app settings, and cached feature metadata. Imports are processed on device.
28
29Network inspection requests are made only to perform the requested domain checks or configured resolver lookups. The app does not require a hosted DomainDig backend.
30
31## Development
32
33### Requirements
34
35- Xcode with current iOS SDK support
36- iOS Simulator or physical iOS device
37- Swift/Xcode support for filesystem-synchronized groups used by the project
38
39### Getting Started
40
411. Clone the repository.
42   ```sh
43   git clone https://github.com/zerolabsco/domain-dig.git
44   ```
452. Open `DomainDig.xcodeproj` in Xcode.
463. Select the `DomainDig` scheme.
474. Build and run on a simulator or device.
48
49### Useful Checks
50
51```sh
52xcodebuild -project DomainDig.xcodeproj -scheme DomainDig -destination 'platform=iOS Simulator,name=iPhone 16' build
53```
54
55The app and local API share the canonical report pipeline through `DomainInspectionService`, `DomainReportBuilder`, and `DomainReportExporter`.
56
57## Release Planning
58
59See `RELEASE_ROADMAP.md` for the semver release plan from `v4.4.1` through the planned `v5.0.0` stabilization milestone.
60
61## Contributing
62
63Contributions are welcome. Keep changes scoped, include tests or build verification when behavior changes, and open a pull request with a clear summary of user-facing impact.
64
65## Security
66
67If you discover a security issue, see `SECURITY.md`.
68
69## License
70
71This project is licensed under GPL 3.0 or later. See `LICENSE`.
72
73## Contact
74
75Questions or feedback: hello@cleberg.net