Skip to content

Latest commit

 

History

History
78 lines (63 loc) · 3.86 KB

elf-notes.md

File metadata and controls

78 lines (63 loc) · 3.86 KB

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 GNU build-id or ABI-tag 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.

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 32 note entries are examined by default across every table. Retained note names, section names, and GNU descriptor text 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.

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.