Files
reverse-engineering-anything/docs/elf-notes.md
T
Aniket Rawatandmorluto dd1bb43db3 feat(elf): decode FDO packaging and dlopen note metadata (#7237)
* feat(elf): decode FDO packaging and dlopen note metadata

Name FDO notes within their owner's namespace: type 0xcafe1a7e is
fdo_packaging_metadata and 0x407c0c0a is fdo_dlopen_metadata. One
elfNoteTypeName(owner, type) replaces the GNU-only gnuNoteTypeName.

Each entry gains an fdo field next to gnu. metadata holds the descriptor's
JSON object (packaging) or array (dlopen) when it is NUL-terminated UTF-8
JSON followed only by NUL padding; otherwise metadata is null and issue
names the broken rule, without failing the inspection. Each descriptor
range is decoded once and its retained JSON text is charged to the shared
note text budget per repeated entry. A limitation marks the metadata as a
producer declaration.

Fixes #7235

* fix(elf): key FDO note decoding by note type

The FDO decode cache was keyed by descriptor range only, but the note
type selects the required JSON shape. Overlapping PT_NOTE and SHT_NOTE
tables can give one descriptor range a packaging note and a dlopen note,
and the second reused the first note's verdict. Include the type name in
the key.

Refs #7235

* fix(elf): bound FDO note decoding before parsing JSON

The FDO decoder charged only descriptor source bytes before JSON.parse,
but a dense JSON value such as [{},{},...] decodes to about 50 times its
source size in heap before the service and Evidence copy it again. A
16 MiB descriptor took about 790 MiB of heap; one near the default
64 MiB file budget could exhaust the Node heap. Leave descriptors above
64 KiB undecoded with an issue naming the limit; real FDO notes are a
few hundred bytes.

Refs #7235

* fix(elf): share one FDO decode allowance across the report

The 64 KiB FDO decode bound applied to each descriptor, so raising
max_entries to 256 admitted 256 distinct dense 64 KiB notes: a 16 MiB
file added about 700 MiB of heap before Evidence copied it again.
Charge each distinct descriptor's size to one 64 KiB allowance per
report; a range repeated by another table reuses its decode, and notes
past the allowance keep their entry with an issue.

Refs #7235

* test(desktop): exercise the shared JSON depth guard in the heap suite

---------

Co-authored-by: morluto <76467478+morluto@users.noreply.github.com>
2026-11-19 06:01:39 +00:00

6.9 KiB
Raw Blame History

ELF note tables

inspect_elf_notes / inspect-elf-notes answers whether one selected local ELF32/ELF64 image declares PT_NOTE program headers or SHT_NOTE sections, which note owners and types those tables store, and which supported fields those notes carry. It reads the file without executing it and does not require a disassembler, debug package, or package catalog.

rea inspect-elf-notes /absolute/path/to/program --json

The CLI resolves relative paths against the caller's working directory. MCP requires an absolute filesystem path and preserves that exact selection:

{
  "name": "inspect_elf_notes",
  "arguments": { "path": "/artifacts/program" }
}

Observations

The inline Evidence result contains the artifact path, SHA-256, and byte length. tables lists each declared note program header or section, including the section name when a string table is present. Zlib- and Zstandard-compressed section-name tables are decompressed within the selected file-size budget. An unsupported compression type leaves section names unknown and adds a limitation; note bytes remain independently examined. Each entries[] item reports owner, type, descriptor SHA-256, and a hex preview for descriptors of 64 bytes or less.

A section name also stays null when its offset is outside the declared string table or its bytes lack a NUL terminator. A limitation explains that missing name. Note coverage remains complete when all declared note tables and entries were examined; an unavailable section name does not erase those note facts.

For GNU notes, gnu.build_id_hex, gnu.abi_tag, or gnu.gold_version are filled when the descriptor matches that type. Other owners keep gnu null.

For Linux CORE notes, core.prpsinfo, core.file, core.siginfo, or core.auxv are decoded for process arguments and status (NT_PRPSINFO), mapped file memory regions and paths (NT_FILE), fault signal and code (NT_SIGINFO), and auxiliary vectors (NT_AUXV) across 32-bit and 64-bit images. Other owners or unparsed notes keep core null.

An NT_FILE descriptor with nonzero bytes after its declared filenames retains its raw note evidence and leaves core null.

Linux CORE decoding requires System V/unspecified (0) or GNU/Linux (3) OSABI with ABI version zero. An unspecified OSABI alone does not establish Linux origin. An explicitly different OSABI or ABI version leaves core null and its Linux-specific type_name unknown, with a limitation explaining the profile. Owner/type numbers, descriptor ranges and hashes, GNU-owned notes, and complete table-examination coverage remain available.

For Android NT_ANDROID_TYPE_IDENT (.note.android.ident, owner Android, type 1) notes, android.android_api is decoded from both legacy 4-byte descriptors (where ndk_version and ndk_build_number remain null) and modern 132-byte or extended NDK descriptors, which also populate android.ndk_version and ndk_build_number when their 64-byte slots hold NUL-padded printable ASCII. Truncated or non-ASCII Android descriptors degrade android to null while preserving the raw descriptor digest and preview, and other owners keep android null.

Freedesktop FDO notes can declare package metadata (.note.package, type 0xcafe1a7e) and dlopen metadata (.note.dlopen, type 0x407c0c0a). Package metadata is a JSON object and dlopen metadata is an array of JSON objects. fdo.metadata holds the producer’s declaration with unknown fields preserved. The tool does not verify installed packages, libraries, or loader behavior.

The decoder requires a NUL-terminated UTF-8 payload with only NUL padding, unique object keys, and JSON numbers it can represent exactly. An invalid or over-budget descriptor keeps its raw range and digest, leaves fdo.metadata null, and reports the reason in fdo.issue. Other note types keep fdo null. Table coverage describes the notes examined and includes entries whose FDO metadata could not be decoded.

PT_NOTE and SHT_NOTE are examined independently. The same file range may appear twice when both tables declare it.

A missing table list is observed absence of those declarations. It is not proof the image never carried notes in another container or overlay.

Limits and failures

The selected file is limited to 64 MiB by default (512 MiB maximum). At most 128 note entries are examined by default across every table (256 maximum), which admits distribution glibc builds and their SystemTap probe notes. Retained note names, section names, GNU descriptor text, core dump string representations, and Android ident strings share a scan budget based on the source bytes plus any decoded section-name table, capped at max_file_bytes. The raw source and decoded table must also fit together within that ceiling. If admission fails, the error reports the required max_file_bytes; raising it can admit the decoded table up to the operation's 512 MiB maximum. Once admitted, raising that setting does not increase the scan budget for the same source and decoded names. Repeated table ranges count again. Each descriptor range is hashed once, and each GNU version's trailing NUL run is scanned once; neither walk may exceed that byte ceiling. Malformed ELF headers, truncated header tables, declared note tables that extend past the file, and truncated note entries fail without partial success. ELF extended numbering (PN_XNUM, including a section count stored when e_shnum is 0) is unsupported and returns an unsupported-target outcome rather than invalid-input recovery. A direct section count of 0xff00 or greater in e_shnum is malformed. Compressed section-name tables require zero or a power of two for the decoded alignment. A zlib stream must consume its full declared payload.

FDO decoding separately admits up to 64 KiB of distinct recognized descriptor bytes and up to 64 KiB of projected metadata JSON per report. A repeated descriptor consumes projected bytes for each entry that includes it. Metadata that would exceed the Evidence JSON nesting allowance is also left undecoded.

Zstandard section-name tables also use a 128 MiB decoder window limit.

SHF_COMPRESSED note sections return unsupported_target before their payload is interpreted or decompressed. Their compression header is storage metadata, not a note header. The current result requires physical file offsets for each note and descriptor, which decoded compressed notes cannot provide. This refusal does not label compressed note storage as malformed or allocate its declared decoded size. Compressed section-name tables remain supported within the limits above. Inspect a separately decompressed copy when these notes are needed, retaining the original artifact for provenance.

This workflow does not execute the image or verify GNU build-id uniqueness against package catalogs.