fix(cli): stream encrypt instead of buffering the whole payload - #3938
fix(cli): stream encrypt instead of buffering the whole payload#3938dmihalcik-virtru wants to merge 2 commits into
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: ASSERTIVE Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Benchmark Statistics
Bulk Benchmark Results
TDF3 Benchmark Results:
|
3baa798 to
dbffca5
Compare
b28dc50 to
c9b8343
Compare
X-Test Failure Report |
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Benchmark Statistics
Bulk Benchmark Results
TDF3 Benchmark Results:
|
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Benchmark Statistics
Bulk Benchmark Results
TDF3 Benchmark Results:
|
c9b8343 to
eb523f9
Compare
dbffca5 to
ccd3513
Compare
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Benchmark Statistics
Bulk Benchmark Results
TDF3 Benchmark Results:
|
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Benchmark Statistics
Bulk Benchmark Results
TDF3 Benchmark Results:
|
ccd3513 to
47342fb
Compare
eb523f9 to
3750b81
Compare
X-Test Failure Report |
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Benchmark Statistics
Bulk Benchmark Results
TDF3 Benchmark Results:
|
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Benchmark Statistics
Bulk Benchmark Results
TDF3 Benchmark Results:
|
Adds otdfctl/pkg/streamio, holding the input and output plumbing that the
streaming encrypt and decrypt work needs, and migrates `inspect` onto it so
nothing is left calling the buffered helpers it supersedes.
This is groundwork with one user-visible consequence: `inspect` no longer
reads the whole TDF into memory. Everything else is a move.
Why a new package rather than pkg/cli. The helpers in pkg/cli/pipe.go call
ExitWithError -- which calls os.Exit -- from inside the read, so they cannot
be used from anywhere that wants to handle the failure itself, and they read
the entire input into memory. streamio returns errors and leaves the decision
to exit with the command layer.
What moved in:
- PipeReader establishes whether stdin is a non-empty pipe with a one-byte
Peek instead of a read, so the payload still reaches the caller.
- Spool copies a pipe to a temporary file and rewinds it. A TDF's manifest
sits at the end of the archive, so decrypt and inspect have to seek and
cannot consume a pipe directly.
- OpenSeekable resolves "file argument or piped stdin" to one seekable
handle, reporting ErrNoInput for the shared "nothing to read" case.
- OutputFile writes to a temporary sibling of the destination and renames it
into place on Commit, so a failed run leaves no partial output. The temp
file is a sibling so the rename stays atomic rather than degrading to a
cross-filesystem copy.
Per review feedback on #3921:
- readPipedStdin now delegates its detection to streamio.PipeReader rather
than answering "is there piped input?" a second way. Its read is still
unbounded; the callers that must stop buffering are changed separately.
- pkg/cli/pipe.go is deprecated rather than deleted, since the package is
exported and may have callers outside this repository. Worth noting that
ReadFromFile has no size cap at all -- not even the 10 GB the tdf commands
apply -- which is its own argument for the notice.
InspectTDF takes an io.ReadSeeker instead of a byte slice. GetTdfType already
rewinds to the start, so the reader is positioned for LoadTDF. Because
cli.ExitWithError calls os.Exit and skips deferred functions, inspectRun
invokes cleanup explicitly on every exit path, including the successful one:
piped input is spooled to disk and the temp file would otherwise survive.
Signed-off-by: Dave Mihalcik <dmihalcik@virtru.com>
`otdfctl encrypt` read the entire plaintext into memory, handed the slice to EncryptBytes, which accumulated the entire ciphertext in a bytes.Buffer, and only then copied it to the destination. Peak RSS was therefore roughly twice the payload, and a 10 GB cap existed solely to keep that from taking the process down. The payload now streams from the input to the destination. The SDK already takes an io.ReadSeeker and writes incrementally, so this is a matter of not getting in its way: the file argument is opened directly and passed through, and piped stdin is spooled to a temporary file because the SDK seeks to the end of the payload to size it. Spooling trades disk for the memory a whole-payload read cost; once CreateTDF accepts a plain io.Reader the spool goes away. Handler.EncryptBytes becomes Handler.Encrypt(ctx, out, in, EncryptOptions). The options struct replaces eight positional parameters, and passing the command's context through means an interrupted encrypt is now cancellable. MIME detection no longer needs the payload in memory either. detectMimeType reads the first megabyte -- which is all mimetype inspects, given SetLimit -- and rewinds, so the whole payload still reaches the encoder. Two behaviors worth calling out: Fixes a panic. The extension fallback called mimetype.Lookup(fileExt), but Lookup takes a MIME type string, not an extension: it parses its argument with mime.ParseMediaType, which fails on a bare extension, so it returned nil for every extension and .String() on that nil dereferenced. Any file whose contents mimetype could not classify and whose name had an extension crashed the CLI. The stdlib mime.TypeByExtension is the extension lookup, and an unknown extension now leaves application/octet-stream in place. Output to a file is atomic. Encryption writes to a temporary sibling of the destination and renames it into place only on success, so a failed run no longer leaves a truncated .tdf where a complete one is expected. Output to stdout cannot offer this; a failure part-way through has already written bytes downstream. Because cli.ExitWithError calls os.Exit and skips deferred functions, every exit path discards the temporary output and the spool explicitly. Signed-off-by: Dave Mihalcik <dmihalcik@virtru.com>
3750b81 to
c1ce2ce
Compare
47342fb to
580073d
Compare
X-Test Failure Report |
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Benchmark Statistics
Bulk Benchmark Results
TDF3 Benchmark Results:
|
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Benchmark Statistics
Bulk Benchmark Results
TDF3 Benchmark Results:
|
|
> **Part 08 of 20** in the DSPX-2604 re-cut. Base branch: `main`. > > This stack replaces #3782 / #3865 / #3921, which stay open and untouched > until it lands. Nothing here is a rebase of those branches — the work was > re-cut from the ticket so each PR stands on its own. ### Proposed Changes Adds otdfctl/pkg/streamio, holding the input and output plumbing that the streaming encrypt and decrypt work needs, and migrates `inspect` onto it so nothing is left calling the buffered helpers it supersedes. This is groundwork with one user-visible consequence: `inspect` no longer reads the whole TDF into memory. Everything else is a move. Why a new package rather than pkg/cli. The helpers in pkg/cli/pipe.go call ExitWithError -- which calls os.Exit -- from inside the read, so they cannot be used from anywhere that wants to handle the failure itself, and they read the entire input into memory. streamio returns errors and leaves the decision to exit with the command layer. What moved in: - PipeReader establishes whether stdin is a non-empty pipe with a one-byte Peek instead of a read, so the payload still reaches the caller. - Spool copies a pipe to a temporary file and rewinds it. A TDF's manifest sits at the end of the archive, so decrypt and inspect have to seek and cannot consume a pipe directly. - OpenSeekable resolves "file argument or piped stdin" to one seekable handle, reporting ErrNoInput for the shared "nothing to read" case. - OutputFile writes to a temporary sibling of the destination and renames it into place on Commit, so a failed run leaves no partial output. The temp file is a sibling so the rename stays atomic rather than degrading to a cross-filesystem copy. Per review feedback on #3921: - readPipedStdin now delegates its detection to streamio.PipeReader rather than answering "is there piped input?" a second way. Its read is still unbounded; the callers that must stop buffering are changed separately. - pkg/cli/pipe.go is deprecated rather than deleted, since the package is exported and may have callers outside this repository. Worth noting that ReadFromFile has no size cap at all -- not even the 10 GB the tdf commands apply -- which is its own argument for the notice. InspectTDF takes an io.ReadSeeker instead of a byte slice. GetTdfType already rewinds to the start, so the reader is positioned for LoadTDF. Because cli.ExitWithError calls os.Exit and skips deferred functions, inspectRun invokes cleanup explicitly on every exit path, including the successful one: piped input is spooled to disk and the temp file would otherwise survive. ### Checklist - [x] I have added or updated unit tests - [ ] I have added or updated integration tests (if appropriate) - [ ] I have added or updated documentation ### Testing Instructions ``` cd otdfctl && go test ./pkg/streamio/... ./cmd/... -race ``` `inspect` is the only command migrated in this PR; check it still reads both a file argument and piped stdin, and that no `otdfctl-spool-*` file survives either run. <details> <summary><b>The full DSPX-2604 stack — 20 PRs</b></summary> | # | PR | Based on | |---|----|----------| | 01 | #3930 chore: bump go.work toolchain to go1.25.12 and simplify an rt_test condition | `main` | | 02 | #3931 feat(sdk): make the zipstream clock injectable for deterministic ZIP output | `main` | | 03 | #3932 fix(sdk): reject a zipstream write set that omits segment 0 | #3931 | | 04 | #3933 fix(sdk): map ReadAt plaintext offsets from cumulative segment sizes | `main` | | 05 | #3934 chore(sdk): extract integrityAlgorithmString, createPolicyBinding, signAssertions | `main` | | 06 | #3935 chore(sdk): add direct tests for createKeyAccess, encryptMetadata and tdfSalt | `main` | | 07 | #3936 fix(sdk): fill each segment with io.ReadFull and size the buffer to the input | `main` | | 08 | #3937 chore(cli): move streaming IO helpers into pkg | `main` | | 09 | #3938 fix(cli): stream encrypt instead of buffering the whole payload | #3937 | | 10 | #3939 fix(cli): stream decrypt and inspect instead of buffering | #3938 | | 11 | #3940 feat(sdk): add a chunked segment writer (experimental) | `dspx-2604-base-11` = #3932 + #3934 + #3935 | | 12 | #3941 fix(sdk): stop GetManifest from splitting the key under the lock | #3940 | | 13 | #3942 fix(sdk): reject a chunked split naming a KAS with no resolved public key | #3941 | | 14 | #3943 chore(sdk): alias experimental/tdf manifest and assertion types | #3942 | | 15 | #3944 fix(sdk): emit spec-compliant key access in experimental/tdf and delegate Writer | #3943 | | 16 | #3945 feat(sdk): accept io.Reader in CreateTDF and drop the 64 GB payload cap | #3936 | | 17 | #3946 chore(sdk): rewrite CreateTDF on top of the chunked writer | `dspx-2604-base-17` = #3944 + #3945 | | 18 | #3947 chore(sdk): drop dead TDFConfig fields and deprecate the TDFFormat enum | #3946 | | 19 | #3948 fix(cli): drop the encrypt-side stdin spool | `dspx-2604-base-19` = #3947 + #3939 | | 20 | #3949 feat(sdk): graduate the chunked writer to stable API | #3948 | **Reviewable in parallel right now**, since they sit directly on `main` and depend on nothing else: 01, 02, 04, 05, 06, 07, 08. **Why three PRs have a `dspx-2604-base-*` base.** A GitHub PR takes one base branch, but 11, 17 and 19 each build on more than one parent. The `base-*` branches are empty merge commits that exist only to join those parents so the PR diff shows exactly its own change and nothing else. They contain no code, have no PR of their own, and go away once their parents land — retarget the child onto `main` at that point. **Wants a cross-SDK xtest run before merge:** 15, 17 (and therefore 20). They touch the KAS wire format. **Red checks you may see are network flakes, not this stack.** Four distinct ones hit this batch and all clear on re-run: `golangci-lint config verify` timing out on `https://golangci-lint.run/.../golangci.v2.8.jsonschema.json` (fails the whole `go (<module>)` job and fail-fast cancels its siblings), the bats installer getting a 403, Docker Hub timing out on `keycloak/keycloak:26.4`, and `buf` reporting "the server hosted at that remote is unavailable" while the Java SDK generates sources. The `govulncheck` step also emits `##[error]` annotations against the go1.25.11 stdlib, but it is `continue-on-error: true` and never fails a job — 01 bumps the toolchain and clears those annotations. </details> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Added reliable support for inspecting TDF content from files, piped input, and standard input. - Added safer output handling that prevents incomplete files from replacing existing results. - Added clearer input errors when no content is provided or an input cannot be opened. - **Bug Fixes** - Improved handling of large and non-seekable input streams. - Preserved piped input correctly while processing and inspecting content. - Non-fatal inspection issues are now reported as warnings where possible, allowing processing to continue. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: Dave Mihalcik <dmihalcik@virtru.com>
Proposed Changes
otdfctl encryptread the entire plaintext into memory, handed the slice toEncryptBytes, which accumulated the entire ciphertext in a bytes.Buffer, and
only then copied it to the destination. Peak RSS was therefore roughly twice
the payload, and a 10 GB cap existed solely to keep that from taking the
process down.
The payload now streams from the input to the destination. The SDK already
takes an io.ReadSeeker and writes incrementally, so this is a matter of not
getting in its way: the file argument is opened directly and passed through,
and piped stdin is spooled to a temporary file because the SDK seeks to the
end of the payload to size it. Spooling trades disk for the memory a
whole-payload read cost; once CreateTDF accepts a plain io.Reader the spool
goes away.
Handler.EncryptBytes becomes Handler.Encrypt(ctx, out, in, EncryptOptions).
The options struct replaces eight positional parameters, and passing the
command's context through means an interrupted encrypt is now cancellable.
MIME detection no longer needs the payload in memory either. detectMimeType
reads the first megabyte -- which is all mimetype inspects, given SetLimit --
and rewinds, so the whole payload still reaches the encoder.
Two behaviors worth calling out:
Fixes a panic. The extension fallback called mimetype.Lookup(fileExt), but
Lookup takes a MIME type string, not an extension: it parses its argument with
mime.ParseMediaType, which fails on a bare extension, so it returned nil for
every extension and .String() on that nil dereferenced. Any file whose contents
mimetype could not classify and whose name had an extension crashed the CLI.
The stdlib mime.TypeByExtension is the extension lookup, and an unknown
extension now leaves application/octet-stream in place.
Output to a file is atomic. Encryption writes to a temporary sibling of the
destination and renames it into place only on success, so a failed run no
longer leaves a truncated .tdf where a complete one is expected. Output to
stdout cannot offer this; a failure part-way through has already written bytes
downstream. Because cli.ExitWithError calls os.Exit and skips deferred
functions, every exit path discards the temporary output and the spool
explicitly.
Checklist
Testing Instructions
Worth exercising by hand, since the panic this fixes needed a real file:
The full DSPX-2604 stack — 20 PRs
mainmainmainmainmainmainmaindspx-2604-base-11= #3932 + #3934 + #3935dspx-2604-base-17= #3944 + #3945dspx-2604-base-19= #3947 + #3939Reviewable in parallel right now, since they sit directly on
mainand depend onnothing else: 01, 02, 04, 05, 06, 07, 08.
Why three PRs have a
dspx-2604-base-*base. A GitHub PR takes one base branch,but 11, 17 and 19 each build on more than one parent. The
base-*branches are emptymerge commits that exist only to join those parents so the PR diff shows exactly its
own change and nothing else. They contain no code, have no PR of their own, and go
away once their parents land — retarget the child onto
mainat that point.Wants a cross-SDK xtest run before merge: 15, 17 (and therefore 20). They touch
the KAS wire format.
Red checks you may see are network flakes, not this stack. Four distinct ones hit
this batch and all clear on re-run:
golangci-lint config verifytiming out onhttps://golangci-lint.run/.../golangci.v2.8.jsonschema.json(fails the wholego (<module>)job and fail-fast cancels its siblings), the bats installer getting a 403,Docker Hub timing out on
keycloak/keycloak:26.4, andbufreporting "the serverhosted at that remote is unavailable" while the Java SDK generates sources. The
govulncheckstep also emits##[error]annotations against the go1.25.11 stdlib, butit is
continue-on-error: trueand never fails a job — 01 bumps the toolchain andclears those annotations.