summaryrefslogtreecommitdiff
path: root/README.nfo
blob: 3b26ee72e2e21af30c98a491e357e5a8904292f6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
┌──────────────────────────────────────────────────────────────┐
│  D O M A I N D I G                         [ KRZ ]   krz.sh  │
└──────────────────────────────────────────────────────────────┘

WHAT
  local-first ios domain inspection toolkit. dns, web, ownership,
  monitoring, reporting, audit. takes a point-in-time snapshot of a
  domain, normalizes it into a DomainReport, and keeps data on device
  unless you export, share, or sync it.

DOES
  - inspects dns records, email security, tls certs, http headers,
    redirects, ip geolocation, reachability, open ports, rdap,
    ownership, subdomains, availability
  - DomainReport output used by the ui and exports
  - history snapshots with change summaries, risk scoring, notes
  - dashboard, watchlist, monitoring, workflows, batch results,
    integrations, data portability
  - audit mode: sessions, checklists, reviewer notes, findings,
    evidence snapshots, timelines, markdown/json/pdf export
  - backup and restore for tracked domains, history, audit sessions,
    workflows, monitoring, settings, feature metadata
  - optional local api for automation-compatible output

PRIVACY
  app data lives in on-device storage. network requests go out only
  to run the checks you asked for or the resolver you configured. no
  hosted backend required.

BUILD
  needs xcode with a current ios sdk and a simulator or device.

      git clone https://github.com/krazywarez/domain-dig.git

  open DomainDig.xcodeproj, pick the DomainDig scheme, build and run.

  build check:

      xcodebuild -project DomainDig.xcodeproj -scheme DomainDig \
        -destination 'platform=iOS Simulator,name=iPhone 16' build

TESTS
  deterministic core coverage lives in DomainDigTests:

      xcodebuild test -project DomainDig.xcodeproj -scheme DomainDig \
        -destination 'platform=iOS Simulator,name=iPhone 16' \
        -only-testing:DomainDigTests

  the scheme's test action also runs the DomainDigUITests
  accessibility audit.

      ./Scripts/audit-a11y.sh          # oldest supported + newest
      ./Scripts/audit-a11y.sh floor    # oldest only (~85s)

  findings are reported, not enforced. optional pre-push hook:

      git config core.hooksPath .githooks

DOCS
  local api:      Docs/local-api.txt
  data migration: Docs/data-migration.txt
  accessibility:  Docs/ACCESSIBILITY.txt
  releases:       RELEASE_ROADMAP.txt  (v4.4.1 -> v5.0.0)
  security:       SECURITY.txt

LICENSE
  0bsd. see LICENSE.

CONTACT
  [email protected]

┌──────────────────────────────────────────────────────────────┐
│  krz.sh                                                      │
└──────────────────────────────────────────────────────────────┘