From 0f214ba59c20c0c9c7ba841ecc3683f863965312 Mon Sep 17 00:00:00 2001 From: Nigel Tao Date: Thu, 3 Sep 2026 08:31:06 +1000 Subject: [PATCH] lib/suitar: add trailing EOF blocks Both /usr/bin/tar and the Go standard library don't seem to need this, but some other TAR readers might expect it. --- doc/spec/suitar-spec.md | 8 ++++---- lib/suitar/suitar.go | 22 ++++++++++++++++++++-- test/data/archive.dense.suitar | Bin 17920 -> 18944 bytes test/data/archive.sparse.suitar | Bin 12288 -> 13312 bytes 4 files changed, 24 insertions(+), 6 deletions(-) diff --git a/doc/spec/suitar-spec.md b/doc/spec/suitar-spec.md index 3497930b..1dca8933 100644 --- a/doc/spec/suitar-spec.md +++ b/doc/spec/suitar-spec.md @@ -30,8 +30,7 @@ BZIP2", etc. A separate compression step wrapping SUITAR is feasible, just like wrapping TAR, but is out of scope of this document. Like TAR, SUITAR files are a sequence of independent entries (files or -directories). Independent means that the concatenation of two valid SUITAR -files is itself a valid SUITAR file. Like JSON map keys, duplicate names are +directories). Independent means that, like JSON map keys, duplicate names are valid, although some decoders may choose to reject them. A file's entry does not need to be preceded by explicit entries for that file's @@ -97,8 +96,9 @@ and transform Shift-JIS encoded names to equivalent and valid UTF-8. ## File Structure -SUITAR files are a sequence of independent entries and each entry occupies an -integer number of 512-byte blocks: +SUITAR files are a sequence of entries, followed by a 1024-byte "End Of File" +marker. The EOF marker's bytes are all NUL. Each entry occupies an integer +number of 512-byte blocks: - 1 `GNUTYPE_LONGNAME` header block. - 1 or more payload blocks containing the file or directory name. diff --git a/lib/suitar/suitar.go b/lib/suitar/suitar.go index 0de12fb7..6055806c 100644 --- a/lib/suitar/suitar.go +++ b/lib/suitar/suitar.go @@ -471,6 +471,11 @@ func (w *Writer) Close() error { if err := w.flush(); err != nil { return err } + clear(w.nameBuf[:1024]) + if _, err := w.w.Write(w.nameBuf[:1024]); err != nil { + w.err = err + return err + } w.err = errClosed return nil } @@ -503,9 +508,23 @@ func (r *Reader) Next() (Header, error) { } } - if _, err := io.ReadFull(r.r, r.block[:]); err != nil { + if _, err := readFullNoEOF(r.r, r.block[:]); err != nil { r.err = err return Header{}, r.err + } else if r.block[0x09C] == 0 { + // SUITAR ends with 2 blocks (1024 bytes) of zeroes. + if !isAllZeroes(r.block[:]) { + r.err = errBadHeader + return Header{}, r.err + } else if _, err := readFullNoEOF(r.r, r.block[:]); err != nil { + r.err = err + return Header{}, r.err + } else if !isAllZeroes(r.block[:]) { + r.err = errBadHeader + return Header{}, r.err + } + r.err = io.EOF + return Header{}, r.err } nameLenInclNul, err := parseBlock0(&r.block) @@ -545,7 +564,6 @@ func (r *Reader) Next() (Header, error) { Mode: mode, ModTime: time.Unix(modTime, 0), }, nil - } func parseBlock0(b *block) (uint64, error) { diff --git a/test/data/archive.dense.suitar b/test/data/archive.dense.suitar index c69ee7c1c8eb9e544d2dd48bcb8df20985578828..eaaf9f38c781445c743dc8795aa9e44211506285 100644 GIT binary patch delta 21 ZcmZqZVQiSfxWH|*0>=YJFfmcV0RUE~2XX)a delta 8 PcmZpe!r0KmxWEkn4pRdO diff --git a/test/data/archive.sparse.suitar b/test/data/archive.sparse.suitar index 72ec23da838407c36c65fa67c6f19c57b92ef176..ceff1330eb7f757e51487cddb18e7fb56c237913 100644 GIT binary patch delta 19 XcmZojXvkP#uvvlQ0V9~0sNetqOiBj= delta 6 NcmZq3Xh>LK000S|0+|2+