aboutsummaryrefslogtreecommitdiffstats
path: root/docs/specs
AgeCommit message (Collapse)AuthorFilesLines
13 hoursfix: strip the envelope recipient in every shape the grammar allowsDanilo M.1-0/+31
The for-clause rule anchored on the clause terminator, which is strictly stronger than RFC 5321 4.4: For sits inside Opt-info, so With, ID, Via or a CFWS comment may legitimately follow it, and its ABNF is 1*( Path / Mailbox ) where Mailbox carries no angle brackets. Only the tidiest shape was stripped. Four ordinary ones published the victim's address in the one header a report reproduces verbatim, including "for <a@b> (envelope-from <c@d>);", which is routine Exim and Sendmail output. Anchored on the address instead. The envelope SENDER survives the cut, since that is what the report is about, and the leftover whitespace, orphan separator and emptied comment are tidied because the line is published to a third party verbatim. Table-driven over all five shapes; reverting the regex fails six of nine tests in the class. Two accepted disclosures are now named in the spec's "Where the headers come from" rather than living in a test comment: our own relay's hostname, which the by and authserv-id clauses carry by construction, and attacker-controlled free text in Subject and the From display name, which the whitelist does not and should not filter. The second is asserted as a documented limit so it reads as deliberate, and the manifest assertion now bars the obfuscated you%40example.org spelling alongside the plain one. case.create() seeds an empty headers block so an unparsed case has the same shape as a parsed one. Additive, so FORMAT_VERSION is unchanged. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Xj1ayFRSUQ2u7cwb3S4axE
13 hoursdocs: settle the report specDanilo M.1-0/+412
Settles the three questions the umbrella design left open for report: the X-ARF schema, which fields the reporting identity fills, and the plain-text alternative. The message is not attached. RFC 5965's text/rfc822-headers carries a whitelist of headers instead, and parse stores that whitelist in the manifest so report never opens source.eml, which is the first property applied one level down. Also settles destination grouping per abuse address, an explicit unreportable list, and a freeze rule: any sent destination freezes the whole case, marked by a write-once field, with body integrity checked by content hash rather than mtime. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Xj1ayFRSUQ2u7cwb3S4axE
14 hoursdocs: document the queried key, mark server as unbuiltDanilo M.1-4/+21
The contacts spec's manifest example carried a "server" field that no code ever wrote, while resolve() writes a "queried" key the spec never defined. They are not the same fact under two names: "queried" is what was asked about, the name the label walk landed on, and "server" is who was asked, the RDAP endpoint the bootstrap selected. Document "queried" as shipped, and record "server" as specified but not built, with the condition that would earn it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Xj1ayFRSUQ2u7cwb3S4axE
22 hoursdocs: correct the Accept header and the dependency claimDanilo M.1-5/+10
The spec named a strict Accept: application/rdap+json while the plan, and so the code, sends application/rdap+json with application/json at q=0.9. A spec review caught the disagreement. The wider header is the right behaviour, since some registries serve plain application/json and a strict header would lose a contact that was published, so the spec moves to match the code and now records why. Both documents also claimed requirements.txt stays empty. There is no requirements.txt in this repository and there never has been, so the claim was true only vacuously. They now say the tool declares no dependencies, which is the thing actually being promised. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Wrfqr2xqQfhtXCscU7zrdz
23 hoursdocs: spec the contacts subcommandDanilo M.1-0/+345
Settles what the umbrella design left open for this part: RDAP bootstrap, caching policy, and what happens for a netblock that publishes no abuse contact. Scope is IPs and domains, with a URL contributing only its host. The bootstrap files are fetched from IANA and cached with a long TTL, while responses are cached in memory for one run only: a stale bootstrap merely misses, but a stale abuse address sends a report into a dead mailbox silently. The registrable domain is found by walking up the labels and asking the registry rather than by bundling a Public Suffix List, which would be a transcribed table that goes stale weekly. Address extraction is a strict abuse-role match with no fallback. In particular it never constructs abuse@<domain>, because for a phishing domain that mailbox belongs to the attacker and mailing it would confirm both the catch and that the address is live. Adds a fourth non-negotiable property: a query carries a bare host or IP and never a URL. Property 1 governs what is published, and a query is a disclosure that appears in no report, so a path segment that parse deliberately flags rather than redacts would otherwise leak. Transport is urllib with an injected fetch, so requirements.txt stays empty and the suite keeps passing with sockets raising, for the whole suite rather than for everything except contacts. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Wrfqr2xqQfhtXCscU7zrdz
43 hoursplan: implementation plan for init and parseDanilo M.1-2/+82
Thirteen tasks, TDD throughout, stdlib only. parse is pure and offline: the trusted-relay boundary arrives as an argument rather than a config read, so the whole extractor is testable against fixtures with no setup. The plan carries three checks that are not ordinary unit tests. The Received-chain task has a mutation step, because walking one hop too far reports an innocent third party named in a header the attacker wrote, and a test that cannot fail would not protect against it. The URL task runs the suite with sockets refused, so the never-fetch rule is verified rather than read. And every fixture is asserted to leave no recipient address anywhere in the manifest. init exists because parse refuses to guess the trust boundary. It asks for CIDRs, offers a static table of known provider ranges, or reads the chain of a known-good sample and lets the user pick their own hops. A pure builder with the prompts and the flags as two front ends over it, so --non-interactive covers agent-driven setup and the config writing is tested without a terminal. Re-running shows what is already configured and asks; either route backs the old file up first and preserves sections this run does not set, so a later init cannot silently drop a MISP key. The prompts themselves are hand-tested rather than driven from stdin: a test there would assert the wording it was written against and break on a rewording that improved it. Task 12 is the checklist, weighted towards wrong answers. Redirect chains were missing from the first draft of the plan and are now specified: a parameter whose value is itself a URL is recovered as an indicator while every other value stays redacted, which resolves the conflict between reporting the destination and never publishing a tracking token. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KphFXTc2QajxXsHWyvGJ4R
43 hoursspec: retry deferred destinations from cron, not by handDanilo M.1-12/+123
A rate limit tells us when, not merely that: a 429 carries Retry-After or the vendor's reset headers. Recording the deadline and asking the user to run submit again throws that away and relies on them remembering. So `abusectl retry` scans every case for destinations whose retry_after has passed and sends only those, as one unattended cron line beside mailsync.sh. No inline retry: submit never sleeps waiting for a window, because a daily quota resets in hours and a process killed while sleeping is back to the user remembering. One mechanism, not two. Unattended retry makes three properties load-bearing, since a retry that re-sends is a duplicate abuse report and cannot be withdrawn. Status is written before the attempt, so a crash mid-send leaves in-flight, which is honest, rather than looking like it never happened; retry never touches in-flight. Attempts are capped, so a dead abuse mailbox stops being retried. A soft failure with no server deadline gets exponential backoff. deferred and failed are separate statuses: deferred means the tool will handle it, failed means the user must. Collapsing them either strands a rate-limited report forever or retries a dead mailbox indefinitely. The qtmaildir dialog accordingly grows no retry button. A deferred destination belongs to cron, and a button beside it would race the scheduled run. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KphFXTc2QajxXsHWyvGJ4R
43 hoursInitial commit: umbrella design for abusectlDanilo M.1-0/+423
An abuse reporting sidecar for phishing mail: parse a flagged message, extract its indicators, resolve abuse contacts, and file the result to a MISP instance and to public abuse channels. This is the umbrella spec, agreed in one design session. Each part gets its own spec before it is built; this settles what the parts share and what would be expensive to change later: the case directory and its manifest format, the redaction rule, the ordering between MISP and the vendors, and how partial failure is recorded. It exists as a separate tool because qtmaildir does no network protocol work by design, and this needs RDAP, three vendor APIs and mail to abuse desks. qtmaildir invokes it by name the way it invokes mailsync.sh, and hosts the review dialog; the two are coupled only by the manifest format and a command name in config. Two properties are recorded as safety properties rather than preferences. Recipient identifiers are never captured, at extraction rather than at submission, so the tool cannot disclose an identifier it was never given; tracking tokens inside URLs are covered, since a parameter value is frequently the recipient's address. And nothing remote is fetched while parsing, because following a link confirms the address is live and fires the tracker. parse is the first part to build: stdlib only, no network, no config, and its output is the format every other part reads. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KphFXTc2QajxXsHWyvGJ4R