Repository navigation
Add offline BMP capture decoder and release 0.6.1 - #17
Draft
nuclearcat wants to merge 6 commits into
Draft
nuclearcat wants to merge 6 commits into
nuclearcat wants to merge 6 commits into
Conversation
There was a problem hiding this comment.
🔵 Needs a closer look
It adds a large new ~3.7k-line protocol decoder plus release/packaging and Cargo.lock dependency changes whose built artifacts and release wiring warrant final human verification.
1 open issue
What changed in this PR
This PR introduces netom-bmpdump, a self-contained offline BMP/BGP/EVPN decoder for PCAP and PCAPNG captures, added as a new, isolated workspace member (tools/bmpdump) that does not link against the Netom daemon. It reassembles TCP streams, decodes BMP/BGP/EVPN messages, and renders them as readable/colorized text or newline-delimited JSON with filtering, summaries, and stable per-frame message ordinals. The PR also wires the new binary into DEB/RPM packaging, runtime images, man pages, docs, and CI, and bumps the workspace to release 0.6.1.
Changes:
- New
netom-bmpdumptool: capture parsing (capture.rs), TCP reassembly (stream.rs), protocol decoding (protocol.rs), rendering (display.rs), CLI (cli.rs/main.rs), with an extensive 30-test integration suite. - Packaging/CI integration: build all three binaries,
cargo deb --package netom, RPM spec, smoke tests, and a dedicated CI test step; workspacemembers/default-membersupdated. - Release 0.6.1: version bumps in
Cargo.toml/Cargo.lock, docs (README.md,docs/, man page), andChangelog.md.
| File | Description |
|---|---|
| tools/bmpdump/src/capture.rs | PCAP/PCAPNG parsing, link-type/IP/TCP extraction, timestamp resolution. |
| tools/bmpdump/src/stream.rs | TCP reassembly with wrap/overlap handling and BMP framing/limits. |
| tools/bmpdump/src/protocol.rs | BMP/BGP/EVPN message decoding and ADD-PATH negotiation. |
| tools/bmpdump/src/display.rs | Readable/colorized rendering, UTC timestamps, control-char escaping. |
| tools/bmpdump/src/cli.rs | Argument parsing, run loop, filters, summaries, diagnostics, exit codes. |
| tools/bmpdump/src/main.rs | Entry point with broken-pipe handling. |
| tools/bmpdump/src/lib.rs | Module declarations for the library crate. |
| tools/bmpdump/tests/decoder.rs | Comprehensive fixtures and CLI/decoder regression tests. |
| tools/bmpdump/Cargo.toml, README.md, rustfmt.toml | New package manifest, readme, formatting config (edition 2024). |
| Cargo.toml, Cargo.lock | Workspace members, 0.6.1 bump, deb assets, terminal_size + transitive lock updates. |
| pkg/build-package.sh, rpm/netom.spec, test-scripts/*.sh | Build/package/smoke-test the new binary and its man page/docs. |
| .github/workflows/ci.yml | Added a netom-bmpdump test step. |
| doc/netom-bmpdump.1, docs/bmpdump.md, docs/index.md, docs/releases.md, README.md, TESTING.md, Changelog.md | Documentation, man page, and 0.6.1 references. |
Review effort: Balanced
| let source: Box<dyn Read> = if args.read.as_os_str() == "-" { | ||
| Box::new(io::stdin()) | ||
| } else { | ||
| Box::new(File::open(&args.read)?) |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add
netom-bmpdump, a standalone offline BMP/BGP/EVPN decoder for PCAP and PCAPNG captures. It reassembles TCP streams and prints filtered route records as readable text or JSON, including EVPN ARP/ND flags, PMSI ingress-replication endpoints, full UTC capture timestamps, and stable message references within frames.Include the decoder in DEB/RPM packages and runtime images, add documentation and CI coverage, and bump the workspace version to 0.6.1. The six commits are based directly on main and contain no automatic BMP reconciliation changes.
Validation: all 30 decoder tests passed, including the full reference-capture regression; all six release metadata checks passed;
git diff --checkpassed. Decoder source and packaging match the previously tested implementation. Full package/image builds were not rerun for this split.