Introducing a new way to review your PRs.

Read the announcement

lockfale / osint-framework

OSINT Framework

View on GitHub

8 documents · Updated Nov 16, 2026

docs / osint-resource-data

OSINT Resource Data

Overview

The OSINT catalog's runtime source of truth is public/arf.json. It is a nested tree rooted at {"name":"OSINT Framework","type":"folder","children":[...]}. Interior nodes are folder objects with children; clickable resources are leaf objects with type: "url", name, url, and optional enrichment metadata. The browser loads this file directly with d3.json("arf.json") from public/…/arf.js, builds a d3.hierarchy, collapses top-level branches, and treats any node with data.url as a searchable/openable tool.

Tool enrichment fields in public/arf.json drive the details panel in public/…/arf.js: description, status, pricing, bestFor, input, output, opsec, opsecNote, api, invitationOnly, deprecated, and region are rendered as badges or text. Booleans such as localInstall, googleDork, registration, and editUrl are catalog-maintenance metadata/conventions even when the current panel does not display all of them. The client tolerates sparse records: entries like VerifyEmail (R$) may only have name, type, and url, in which case the panel shows placeholder/unknown values.

THE-127-domain-enrichment-batch1.md and enrichment-batch4-domains.json are maintenance inputs for enriching the Domain Name branch of public/arf.json; they are not fetched by the site. THE-127-domain-enrichment-batch1.md is a human-readable batch with one JSON block per researched domain tool plus a summary. enrichment-batch4-domains.json is machine-shaped staging data under a top-level enrichments object keyed by tool display name; each value uses the same metadata vocabulary as public/arf.json but generally omits name, type, and url because it is intended to be merged into existing catalog entries.

Routing / Ownership

Coupling

  • If public/arf.json changes shape, verify public/…/arf.js: it expects children for folders, url for tool leaves, and searchable name/description strings. Malformed nesting or non-object children can prevent the hierarchy from loading or make tools disappear from search.
  • If adding enrichment fields to enrichment-batch4-domains.json or THE-127-domain-enrichment-batch1.md, also update the corresponding public/arf.json records; the runtime only fetches public/arf.json, so staged batch files alone do not affect the site.
  • Preserve the existing metadata enums used by public/…/arf.js: status is styled for live, down, or degraded; pricing for free, freemium, or paid; opsec for passive or active. Other values render as unknown styling.
  • Preserve display-name suffix conventions in public/arf.json: public/…/arf.js parses (T), (D), (R), and (M) from name for badges while keeping the cleaned name for display. Batch enrichment keyed by tool name should account for these suffixes when matching records.
  • Keep url values browser-safe absolute HTTP(S) URLs when a resource should be clickable. public/…/arf.js replaces missing or non-HTTP(S) URLs with #, so nonstandard schemes or placeholders will not open from the details panel.
  • Do not assume every leaf has full enrichment metadata. The client intentionally falls back to placeholders for missing descriptions and unknown badges for missing status/pricing/opsec; maintenance scripts should preserve sparse entries rather than fabricating uncertain metadata.