Repository navigation
Releases
v0.4.2
Date: 2026-11-16
Previous release: v0.4.1
No library code changes.
Changed
- Built on go-iec61850 v1.23.1 (was v1.23.0), go-mms v1.11.1 (was v1.11.0), go-cotp v1.4.2 (was v1.4.1) and go-tpkt v1.2.2 (was v1.2.1) (go-iec61850 RELEASE.md, v1.23.1; go-mms RELEASE.md, v1.11.1; go-cotp RELEASE.md, v1.4.2; go-tpkt RELEASE.md, v1.2.2). With them fewer allocations per COTP data segment and TPKT packet (a segment of at most 8192 octets and a packet of at most 8196 octets reuse the buffer of the previous one, and a TSDU of one segment is returned without a copy); nothing changes on the wire or in the API.
- CI: the documentation check runs docsync v0.4.0 (was v0.3.x).
v0.4.1
Date: 2026-11-15
Previous release: v0.4.0
mmstracectl is built on go-mms-trace v0.4.0 (was v0.3.5), with go-mms v1.11.0 and go-iec61850 v1.23.0. The library is unchanged from v0.4.0.
mmstracectl
- Names of a capture are written as printable text. In text and CSV output every control character of a name (the C0 set, DEL, the C1 set) and every byte that is not UTF-8 is written as
\xNN; JSON output escapes DEL and the C1 set as\u007fto\u009fbesides what it escaped before. A name is one cell of one row in every format. Output without such characters is the same as before; to get a name's exact value, read JSON. A CSV cell that starts with=,+,-or@is written as it is. --max-bytes(MMSTRACECTL_MAX_BYTES): the most bytes of a capture read, after decompression; 0 is the library's default of 16 GiB. A capture past the limit is printed up to it, then the command exits 3, like a damaged one.--status uncertain, anduncertainin the listings and counts.info:uncompressed_bytesandbad_timestampsin JSON; in text the size line of a gzip capture readsgzip, N bytes (M uncompressed), and abad timestampsline appears when there are any.- Everything the library changed in v0.4.0 now applies to the command: the pairing and framing across capture loss, the limits with their defaults, and the cause kept in read errors (see v0.4.0 below).
v0.4.0
Date: 2026-11-14
Previous release: v0.3.7
The analysis takes what a capture lost into account when it frames and pairs, bounds the input as a whole, and keeps the cause of a read error in the error it returns. The exported API grows: Options.MaxBytes, Options.MaxInterfaces, Options.MaxSections and Options.MaxAssembly with their Default… constants, ErrLimit, StatusUncertain, File.UncompressedBytes and File.BadTimestamps. Nothing exported is removed or changed.
Breaking
No exported identifier breaks. The behaviour below changes; each entry says how to keep the previous behaviour where that is possible.
- A response paired across a capture loss has the status
uncertain. A response is paired with the held request of its invoke ID asok,errororrejectonly when the capture holds everything the two sides sent between the two. It isuncertain(StatusUncertain) when bytes or PDUs of the requesting direction were lost in between, or the responder had acknowledged bytes of the requester that the capture does not hold, or bytes of the responding direction were lost that the requester had not acknowledged when it sent the request: the response may then answer a later request with the same invoke ID that was not captured (API.md, ARCHITECTURE.md section 5).Request,Response, the times and the frames are set as before. Code that switches onTransaction.Statussees a seventh value. To classify as before: mapuncertainbyResponse.Kind(confirmed-responsetook,confirmed-errortoerror,rejecttoreject). None of the committed captures has such a pair. - The capture read is bounded: 16 GiB, counted after decompression (
Options.MaxBytes,DefaultMaxBytes). A capture that goes on past it ends the analysis with the result so far and an error wrapping the newErrLimit, which is notErrCorrupt. To read without a bound:Options{MaxBytes: math.MaxInt64}. - A pcapng input is bounded to 65,536 interfaces and 65,536 sections (
Options.MaxInterfaces,Options.MaxSections). A further interface is skipped with the packets captured on it (File.SkippedBlocks); a further section ends the analysis withErrLimit. To read without these bounds: set both tomath.MaxInt. The reader also keeps at most 16 MiB of interface and section option text, which theResultnever held. - Incomplete TPKT frames and TSDUs are bounded to 64 MiB over all connections (
Options.MaxAssembly). Beyond it the direction that has waited longest gives up what it holds: its TSDU counts inTSDUErrors, the bytes of its frame inTPKTResync. To hold without this bound:Options{MaxAssembly: math.MaxInt}. A TSDU that passesMaxTSDUis let go when it passes the limit and counted when it ends, as before. - TPKT framing where a direction is not synchronised (after a gap, after bytes that are no TPKT header, at the start of a stream captured from its middle): a TPKT header is accepted when the COTP TPDU behind it decodes, and otherwise costs one byte, so that a frame inside the bytes it claims is found. On such captures PDUs are found that were passed over,
Counters.TPKTResyncis higher andCounters.COTPErrorslower:COTPErrorsnow counts frames of a synchronised direction only. Of the committed captures, 16 public ones (the ITI "MMS specific commands") change in these two counters only (for examplecotp_errors2 to 0,tpkt_resync17 to 36); no association, transaction or report of any committed capture changes. There is no option for the previous framing. - GOOSE state numbers at the top of their range: retransmissions of the state with stNum 4294967295 are no state change, and the step from 4294967295 to 1 is one (
Changes), notstNum decreased. Streams that do not reach that number are reported as before. - A pcapng time that does not fit in 64 bits of nanoseconds (after 2262-04-11 or before 1677-09-21, with the interface's resolution and offset) leaves its packet without a time, counted in
File.BadTimestamps; its transactions and reports have time 0. - IP fragments: every fragment of a datagram lies within the length its last fragment gives. A last fragment that ends before fragments already held is counted as
fragment_bad, and its datagram is given up.
Added
Options.MaxBytes,Options.MaxInterfaces,Options.MaxSections,Options.MaxAssembly;DefaultMaxBytes,DefaultMaxInterfaces,DefaultMaxSections,DefaultMaxAssembly;ErrLimit;StatusUncertain;File.UncompressedBytes(the size of the capture as read, after decompression) andFile.BadTimestamps.- A limits table with the reason for each default, the bytes the pipeline holds when every limit is reached, and the work a packet costs (ARCHITECTURE.md section 2); the memory a result takes for each byte of capture, measured (SECURITY.md).
- Fuzz targets for the stages that keep state between packets, fed with sequences:
FuzzDefragSequence(IP fragments, checked against the reassembly rule),FuzzSegments(TCP segments),FuzzFramer(the ISO framing with pieces, holes and other bytes).FuzzAnalyzeand the reader targets check what they return. - A test for every limit that measures allocation, live heap or counted steps against a budget, boundary tables for the numeric fields, the contract test matrix, and benchmarks of
Analyze, the reader and the TCP stage (TESTING.md sections 5 to 7). - A nightly workflow: every fuzz target for 5 minutes, the tests of both modules on linux/386,
TestOnePacketLossover every packet of the committed captures, the benchmarks once.
Changed
- go-mms v1.11.0 (was v1.10.0) and go-iec61850 v1.23.0 (was v1.22.0). The decoding of captures is unchanged: the new releases change servers, clients and the ISO transport, which this module does not use, and every committed capture gives the same result.
- The error of
Analyzekeeps its cause: an error wrappingErrCorruptalso wraps what the reader reported (the error of the caller'sio.Reader,gzip.ErrChecksum), and a read error before the format is known wrapsErrFormatand that error. Moreerrors.Ismatches; none is removed. ERRORS.md says when an error is worth another read. Options.MaxPacketabove the 32 bits a record length has bounds nothing (the reader takes it as the largest length).- The caller owns the
Resultand everything reachable from it (API.md):Association.CallingTSAPandCalledTSAPare copies. - Memory and work: a record or block is read in steps, so a length the input does not hold is not allocated; a held TCP segment is let go when it is delivered; the scratch of a GOOSE stream (every pair of numbers seen, a count per second) is let go before
Analyzereturns; the connection that gives up a hole at the total out-of-order budget is chosen in a number of steps that does not depend on the connections tracked; TCP sequence distances are compared as 32-bit numbers on every platform. - AGENTS.md names the otfabric-policy version CI runs (v1.6.1).
v0.3.7
Date: 2026-11-14
Previous release: v0.3.6
No API change.
Changed
- go-mms v1.10.0 (was v1.9.3), go-iec61850 v1.22.0 (was v1.20.2), go-cotp v1.4.1 (was v1.3.0) and go-tpkt v1.2.1 (was v1.1.0). Decoding is stricter: go-mms v1.10.0 decodes Data to at most 64 nesting levels, limits a Write request's listOfData to 65,536 elements and refuses an object identifier subidentifier with a leading 0x80 octet, and go-iec61850 v1.22.0 refuses an SV
svIDordatSetlonger than 129 octets. A TSDU or SV frame outside these bounds is now counted inTSDUErrorsorSVErrors; the server, client and SCL limits of the new releases are not used by this module. mmstracectlis built on go-mms-trace v0.3.5, go-mms v1.10.0 and go-iec61850 v1.22.0.
v0.3.6
Date: 2026-11-14
Previous release: v0.3.5
No API change.
Changed
- go-mms v1.9.3 (was v1.9.2) and go-iec61850 v1.20.2 (was v1.20.1). go-mms v1.9.3 bounds counts, indexes and REAL exponents when they are decoded (go-mms RELEASE.md, v1.9.3); the go-iec61850 library code is unchanged.
mmstracectlis built on go-mms-trace v0.3.5, go-mms v1.9.3 and go-iec61850 v1.20.2.
v0.3.5
Date: 2026-11-14
Previous release: v0.3.4
No API change.
Changed
- go-iec61850 v1.20.1 (was v1.19.4). v1.20.0 added the sender address of R-GOOSE and R-SV frames (
rsession.Transport.RecvFrom); the library code of v1.20.1 is the same as v1.20.0. mmstracectlis built on go-mms-trace v0.3.4 (was v0.3.3), go-mms v1.9.2 and go-iec61850 v1.20.1.- CI: otfabric/engineering policy 1.6 and the shared workflows v3.8.0. Releases now run the API compatibility gate before tagging.
v0.3.4
Date: 2026-11-12
Previous release: v0.3.3
No API change.
Changed
- go-mms v1.9.2 and go-iec61850 v1.19.4 (were v1.9.1 and v1.19.1). go-mms v1.9.2 makes the
iso.WithDialerdialer follow thenet.Dialercontract. mmstracectlis built on go-mms-trace v0.3.3, go-mms v1.9.2 and go-iec61850 v1.19.4.
v0.3.3
Date: 2026-11-12
Previous release: v0.3.2
Changed
mmstracectlis built on go-mms-trace v0.3.2 (was v0.3.0).
v0.3.2
Date: 2026-11-12
Previous release: v0.3.1
Changed
- Built on go-mms v1.9.1 and go-iec61850 v1.19.1 (were v1.9.0 and v1.19.0), in the library and in
mmstracectl: range-checked integer conversions and Close-race fixes upstream. The decoding of captures is unchanged. - CI: shared workflows otfabric/.github v3.6.0 (were v3.3.0 and v3.5.0), otfabric-policy v1.5.0 (was v1.4.2), and golangci-lint v2.15.0 instead of the shared default v2.1.6.
v0.3.1
Date: 2026-11-11
Previous release: v0.3.0
Changed
mmstracectlis built on go-mms-trace v0.3.0 (was v0.2.0).