The server had no read/write/idle timeouts, so slowloris connections held goroutines and file descriptors forever, and the default address bound all interfaces, exposing the API to the network unintentionally. Defaults now match the tool's local-search use case; add timeouts and cap header size. |
||
|---|---|---|
| internal | ||
| .gitignore | ||
| go.mod | ||
| go.sum | ||
| main.go | ||
| README.md | ||
subidx
subidx is your own copy of crt.name. It watches public Certificate Transparency logs (public records of every HTTPS certificate issued), collects every website name it sees, and lets you search them by domain.
Status: the live pipeline works end to end. A four minute run against the live firehose collected about 470,000 names from 21 logs.
Quick start
go build -o subidx .
./subidx tail -store ./data # collect names (runs forever, Ctrl-C to stop)
./subidx serve -store ./data -addr :8099 # search what you collected
Then:
curl "http://localhost:8099/v1/search?apex=letsencrypt.org"
How it works
- Log discovery. Every hour, subidx fetches three log lists (Chrome's main list, Chrome's full list including rejected logs, and Apple's current list) and merges them by log ID. Logs marked pending, qualified, or usable are tailed live. Old and rejected logs hold years of history; use
-no-drainif you do not want to pull all of that. - Tailing. For each log, subidx checks the tree size every few seconds and downloads only the new entries, up to 1000 per request. It tracks how far it got per log (a watermark) so it can resume after a restart, and it never moves that marker backwards even if a log misbehaves.
- Parsing. Each entry is decoded just long enough to read the SAN list (the part of a certificate that names the domains it covers). Both ordinary certificates and precertificates are handled. Everything else about the certificate is thrown away.
- Normalizing. Names are lowercased, trailing dots and wildcard prefixes (
*.) are stripped, reserved names like.localare rejected, and each name is assigned to its registered domain (apex) using the Public Suffix List. - Storing. One writer process inserts into a pebble key-value store, keyed by domain plus subdomain. If a name shows up again, only the earliest date is kept. Nothing is ever deleted.
- Serving. A small HTTP API answers searches, with rate limiting and health checks.
Commands
| Command | What it does |
|---|---|
tail |
Watch CT logs and store names. Runs until you stop it. |
serve |
Serve the search API. Add -no-tail to serve without collecting. |
stats |
Print total records and the top 10 domains. -recount fixes the counters with a full scan if they ever drift. |
version |
Print the version. |
Useful flags:
| Flag | Default | Meaning |
|---|---|---|
-store |
./data |
Where the database lives |
-addr |
127.0.0.1:8080 |
Listen address for serve (binds localhost by default; use :8080 to expose) |
-poll-interval |
3s |
How often each log is checked for new entries |
-window |
512 |
Entries fetched per request while catching up |
-no-drain |
off | Skip old and rejected logs (they hold years of history, terabytes) |
-rate-limit |
1000 |
Search requests allowed per IP per rolling 24 hours |
-max-results |
100000 |
Max results buffered per search query (newest-collected first) |
-trusted-proxy-hops |
0 |
How many proxies in front of you. 0 means X-Forwarded-For is ignored |
Only one process can use a store directory at a time. The database takes an exclusive lock.
The API
GET /v1/search?apex=example.com returns one name per line. This matches crt.name exactly, including the odd parts:
| Case | Response |
|---|---|
| Known domain | 200, one name per line, in collection order |
| Unknown domain | 200, empty body (not 404) |
Not a bare domain (www.example.com, _bad.com) |
400, plain text reason |
Missing apex parameter |
400, missing apex parameter |
Add &dates=1 |
Each line gets a TAB and the first-seen date |
Add &format=json |
JSON array of {"sub":"..."} objects |
| Add both | Objects become {"first_seen":"...","sub":"..."}, date can be null |
| HEAD requests | 405 |
Also served: /healthz (process is up) and /readyz (store is open and usable). Both skip the rate limit.
What gets stored
Three facts per name: the domain (apex, the registered domain like example.com), the full subdomain, and first_seen, the earliest date the name appeared in any log we watched. Multi-level names are kept whole, so ap.www.sandbox.namecheap.com is one record under namecheap.com.