docs: link the roadmap, add a CT helper script, and state known limitations - #146
Merged
Conversation
…ations The README carried a growing table of completed issues that duplicated ROADMAP.md and pushed usage information further down the page. It now links to the roadmap instead, and gains a Known limitations section covering what the tool deliberately does not do: resolution is A and AAAA only, classification is first-match-wins over the configured patterns, wildcard detection cannot separate a real host from a catch-all sharing its addresses, and a takeover candidate requires an actual CNAME. The certificate-transparency one-liner in the README was easy to mistype and silently produced a partial list when crt.sh was unavailable, which it often is. It is now helper/crtsh_domains.sh, which retries, fails loudly rather than emitting partial output, strips wildcard prefixes, de-duplicates, and keeps only valid hostnames — crt.sh also returns certificate common names such as "as207960 test intermediate - example.com", which are not hostnames. Verified against a live query; shellcheck clean. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation and one small helper script. No behaviour change.
Roadmap moved out of the README
The README carried a growing table of completed issues that duplicated
ROADMAP.mdand pushed usage information down the page. It now links to the roadmap, the review that drives it, and the per-item plans.Known limitations, stated plainly
A new section says what the tool deliberately does not do, so nobody has to infer it from behaviour:
unknownrather than guessed at;helper/crtsh_domains.shThe certificate-transparency one-liner in the README was long, easy to mistype, and silently produced a partial list whenever crt.sh was unavailable — which it frequently is (it returned 502s repeatedly while this was being written).
The script retries, then fails with a clear message rather than emitting partial output. It also strips wildcard prefixes, de-duplicates, and keeps only valid hostnames: crt.sh returns certificate common names too, so entries like
as207960 test intermediate - example.comcome back and are not hostnames.Verified against a live query, and
shellcheckclean.204 passed, ruff clean, all internal README links resolve.
Part of the review roadmap (item PR-G) — see
ROADMAP.md.