krz/domain-dig

an ios app for DNS & SSL analysis

clone: git clone https://gitbay.org/krz/domain-dig.git

v4.8.2: README.md · raw

 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
 6[![App Store Badge](https://zerolabs.sh/storebutton.svg)](https://apps.apple.com/us/app/domaindig/id6760368004)
 7
 8DomainDig 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.
 9
10## Features
11
12- Domain inspection for DNS records, email security, TLS certificates, HTTP headers, redirects, IP geolocation, reachability, open ports, RDAP, ownership, subdomain discovery, and availability.
13- Canonical `DomainReport` output used by the app UI and exports.
14- History snapshots with change summaries, risk scoring, notes, and saved domain context.
15- Dashboard, watchlist, monitoring, workflows, batch results, integrations, and data portability screens.
16- Audit Mode with sessions, checklist progress, reviewer notes, findings, evidence snapshots, audit timelines, and markdown/json/pdf export.
17- Backup and restore for tracked domains, history, audit sessions, workflows, monitoring settings/logs, app settings, and local feature metadata.
18- Local-first operation with no required backend.
19- Optional local API surface for automation-compatible report output.
20
21## Data And Privacy
22
23DomainDig 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.
24
25Network inspection requests are made only to perform the requested domain checks or configured resolver lookups. The app does not require a hosted DomainDig backend.
26
27## Development
28
29### Requirements
30
31- Xcode with current iOS SDK support
32- iOS Simulator or physical iOS device
33- Swift/Xcode support for filesystem-synchronized groups used by the project
34
35### Getting Started
36
371. Clone the repository.
38   ```sh
39   git clone https://github.com/zerolabsco/domain-dig.git
40   ```
412. Open `DomainDig.xcodeproj` in Xcode.
423. Select the `DomainDig` scheme.
434. Build and run on a simulator or device.
44
45### Useful Checks
46
47```sh
48xcodebuild -project DomainDig.xcodeproj -scheme DomainDig -destination 'platform=iOS Simulator,name=iPhone 16' build
49```
50
51The app and local API share the canonical report pipeline through `DomainInspectionService`, `DomainReportBuilder`, and `DomainReportExporter`.
52
53## Release Planning
54
55See `RELEASE_ROADMAP.md` for the semver release plan from `v4.4.1` through the planned `v5.0.0` stabilization milestone.
56
57## Contributing
58
59Contributions 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.
60
61## Security
62
63If you discover a security issue, see `SECURITY.md`.
64
65## License
66
67This project is licensed under GPL 3.0 or later. See `LICENSE`.
68
69## Contact
70
71Questions or feedback: hello@cleberg.net