You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 1382073
Browse filesBrowse the repository at this point in the historyBrowse files
docs(library): keep the first example compilable on v0.10.0 (#226)
The first Scan snippet printed r.Internal, which v0.10.0 does not have,
so go get plus copy-paste failed to compile. Drop it from the snippet
and describe Takeover and Internal in prose, tagging Internal as
unreleased. Also tag RatePerResolver and document it, list the NS, MX
and TXT record types, note AutoRate's six-step floor before the guard
applies, and cover the newer Stats fields in Accounting.
Fixes#226
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
`Takeover` is a lead to check by hand: `dangling`, `provider:<name>` or `dangling:<name>` for a CNAME, or `dangling-ns` for a delegation to a name server that does not resolve. `Internal`{% include unreleased.html library="Internal" %} names the non-public scope (`private`, `loopback`, `link-local`, `cgnat`, `unspecified`) of an address a public name answers with, and is empty when every address is public.
38
+
37
39
Every zero value in `Config` takes the same default as the CLI, so `Config{Domain: "example.com"}` is a complete configuration that uses the bundled 5,000-word list.
38
40
39
41
## Run: a stream of events
@@ -81,15 +83,16 @@ The result is sorted and duplicate-free, and names that are not valid in DNS are
81
83
|`Words`|`DefaultWords()`| Labels to try, or dotted paths such as `api.eu`. |
82
84
|`Resolver`|`8.8.8.8:53`| Trusted server: `ip:port`, `tls://host`, or `https://host/path`. |
83
85
|`ResolverPool`| none | Extra plain-UDP resolvers. Every hit is re-checked against `Resolver`. |
86
+
|`RatePerResolver`{% include unreleased.html library="RatePerResolver" %} | unlimited | Queries per second to each `ResolverPool` member. `Rate` still caps the total, so the stricter limit wins. |
84
87
|`Concurrency`|`100`| Workers looking up names at once. |
85
88
|`Timeout`|`1s`| Bound on one lookup of one record type. |
86
89
|`Attempts`|`1`| Tries per name. Only failures are retried, never NXDOMAIN. |
87
90
|`Rate`| unlimited | Queries per second on the wire, counting every type, retry and probe. |
88
-
|`Types`|`A`, `AAAA`| Record types. `CNAME`populates`Result.Takeover`. |
91
+
|`Types`|`A`, `AAAA`| Record types: `A`, `AAAA`, `CNAME`, and on main also `NS`, `MX` and `TXT`. `CNAME`and `NS` populate`Result.Takeover`. |
89
92
|`Recursive`, `Depth`| off, `1`| Enumerate again under each name found. |
90
93
|`MaxQueries`| unlimited | Cap on candidate names tested. |
91
94
|`MaxDuration`{% include unreleased.html library="MaxDuration" %} | unlimited | Time budget from the start of `Run`. Then no new names are tested and the rest are counted in `Stats.Skipped`, with `Stats.Expired` set. |
92
-
|`AutoRate`{% include unreleased.html library="AutoRate" %} | false | When over a fifth of the last 200 lookups fail, halve the rate and keep going (a `NoticeRate` event says so), and raise it again once lookups succeed, instead of letting the reliability guard abort. `Stats.RateBackoffs` and `Stats.FinalRate` report it. |
95
+
|`AutoRate`{% include unreleased.html library="AutoRate" %} | false | When over a fifth of the last 200 lookups fail, halve the rate and keep going (a `NoticeRate` event says so), and raise it again once lookups succeed. It halves up to six times and not below 5 per second; only when it can slow down no further does the reliability guard apply. `Stats.RateBackoffs` and `Stats.FinalRate` report it. |
93
96
|`TakeoverProviders`{% include unreleased.html library="TakeoverProviders" %} | built-in list | Extra takeover-prone services (`{Suffix: ".example-cdn.net", Name: "example-cdn"}`) for `provider:` hints, added to the built-in list; a `Name` of `-` removes a suffix. `TakeoverProvidersOnly` uses them alone. |
94
97
|`RetryInconclusive`{% include unreleased.html library="RetryInconclusive" %} | false | Once every candidate is tried, look up each name that timed out, was refused or failed once more against `Resolver`. Names it resolves are reported but not expanded by `Recursive`. `Stats.Retried` and `Stats.Recovered` count the pass; `Stats.Inconclusive` lists the names still without an answer. |
95
98
|`Exclude`| none | Out-of-scope names and `*.parent` branches, never queried. |
@@ -100,7 +103,7 @@ The result is sorted and duplicate-free, and names that are not valid in DNS are
100
103
101
104
## Accounting
102
105
103
-
`Stats` puts each candidate name into exactly one outcome: `Found`, `NXDomain`, `Timeout`, `Refused`, `Other` or `WildcardFiltered`. Alongside are `QueriesSent`, `Skipped` (left untested by `MaxQueries`), `Excluded`, and the resolver-pool counters `PoolHits`, `Confirmed` and `Unconfirmed`. `Aborted` means the reliability guard stopped the scan, so the negatives mean nothing.
106
+
`Stats` puts each candidate name into exactly one outcome: `Found`, `NXDomain`, `Timeout`, `Refused`, `Other` or `WildcardFiltered`. Alongside are `QueriesSent`, `Skipped` (left untested by `MaxQueries` or `MaxDuration`, with `Expired` set for the latter), `Excluded`, the result counters `Takeover`and `Internal`, and the resolver-pool counters `PoolHits`, `Confirmed` and `Unconfirmed`. `Aborted` means the reliability guard stopped the scan, so the negatives mean nothing. `Wildcard` and `WildcardFingerprint` describe a wildcard zone. `RetryInconclusive` fills `Retried`, `Recovered` and `Inconclusive` (the names still without an answer), and `AutoRate` fills `RateBackoffs` and `FinalRate`. `Total()` sums the outcomes.
0 commit comments