fix(s3api): stream multipart-SSE chunks lazily to avoid truncated GETs (#8908) (#9228)

* fix(s3api): stream multipart SSE-S3 chunks lazily to avoid truncated GETs (#8908)

buildMultipartSSES3Reader opened a volume-server HTTP response for EVERY
chunk upfront, then walked them with io.MultiReader. For a multipart
SSE-S3 object with N internal chunks (e.g. a 200MB Docker Registry blob
with 25+ chunks), N volume-server bodies sat live at once; chunks
1..N-1 were idle while io.MultiReader drained chunk 0. Under concurrent
load the volume server's keep-alive logic closed those idle responses
mid-flight, and the S3 client saw `unexpected EOF` partway through the
GET. Truncated bytes hash to the wrong SHA-256, which is exactly the
"Digest did not match" symptom Docker Registry reports in #8908 (and
which persisted even after the per-chunk metadata fix in #9211 and the
completion backfill in #9224).

Introduce lazyMultipartChunkReader + preparedMultipartChunk{chunk,
wrap}: a generic lazy chunk streamer with a per-chunk wrap closure for
the SSE-specific decryption setup. Per-chunk metadata is still
validated UPFRONT so a malformed chunk fails fast without opening any
HTTP connection -- the eager validation contract callers and tests
rely on is preserved. The volume-server GET and the SSE-specific
decrypt wrap, however, fire LAZILY: at most one chunk body is live at
any time, regardless of object size.

This commit applies the new pattern to buildMultipartSSES3Reader only;
the SSE-KMS and SSE-C multipart readers retain their eager form for
now and will be migrated in follow-up commits, since the same shape
exists there too.

Tests:
  - TestBuildMultipartSSES3Reader_LazyChunkFetch pins the new contract:
    zero chunks opened at construction, peak liveness == 1, all closed
    after drain.
  - TestBuildMultipartSSES3Reader_RejectsBadChunkBeforeAnyFetch
    (replaces ClosesAppendedOnError) asserts a malformed chunk in
    position N causes zero fetches for chunks 0..N -- the previous
    test pinned a weaker contract (cleanup after eager open).
  - TestBuildMultipartSSES3Reader_InvalidIVLength updated for the same
    reason: the fetch callback must NOT be invoked at all on a bad-IV
    chunk.
  - TestMultipartSSES3RealisticEndToEnd round-trips multiple parts
    encrypted the way putToFiler writes them (shared DEK + baseIV,
    partOffset=0, post-completion global offsets) and walks them
    through buildMultipartSSES3Reader.

* fix(s3api): stream multipart SSE-KMS chunks lazily

Apply the same fix as the previous commit to
createMultipartSSEKMSDecryptedReaderDirect: per-chunk SSE-KMS metadata
is validated upfront, but volume-server GETs fire lazily through
lazyMultipartChunkReader. At most one chunk body is live at any time.

This is the same eager-open-all-chunks shape that produced #8908's
truncated GETs for SSE-S3; SSE-KMS multipart objects with many chunks
were exposed to the same idle-keepalive failure mode under concurrent
load.

The wire format on disk is unchanged (same per-chunk metadata, same
encrypted bytes, same object Extended attributes). Existing SSE-KMS
multipart objects read back identically -- only when the volume-server
GETs fire changes.

* fix(s3api): stream multipart SSE-C chunks lazily

Apply the same fix as the previous two commits to
createMultipartSSECDecryptedReaderDirect: per-chunk SSE-C metadata is
validated upfront (IV decode, IV length check, non-negative
PartOffset), but the volume-server GET and CreateSSECDecryptedReader-
WithOffset wrap fire lazily through lazyMultipartChunkReader. At most
one chunk body is live at any time.

This is the same eager-open-all-chunks shape that produced #8908's
truncated GETs for SSE-S3; SSE-C multipart objects with many chunks
were exposed to the same idle-keepalive failure mode under concurrent
load.

The pre-existing TODO note about CopyObject SSE-C PartOffset handling
is preserved verbatim. The wire format on disk is unchanged (same
per-chunk metadata, same encrypted bytes); existing SSE-C multipart
objects read back identically.

After this commit all three multipart SSE read paths (SSE-S3, SSE-KMS,
SSE-C) share lazyMultipartChunkReader as their streaming engine.

* test(s3): add Docker Registry-shape multipart SSE-S3 GET regression

Pin the end-to-end fix for #8908 with a test that mirrors what Docker
Registry actually does on pull: a 25-part * 5MB upload with bucket-
default SSE-S3, then a full GET, then SHA-256 over the streamed body
must match SHA-256 over the uploaded bytes.

The eager-multipart-reader bug was specifically a streaming truncation
under load: the response status was 200 with a Content-Length matching
the object size, but the body short-circuited mid-stream because
later chunks' volume-server connections had already been closed by
keepalive. The hash check is the symptom Docker Registry surfaces
("Digest did not match"), so this is the most faithful regression we
can pin without spinning up a registry.

uploadAndVerifyMultipartSSEObject already byte-compares the GET body,
but hashing on top is intentionally explicit -- it documents WHY the
test exists, and matches the failure mode reported in the issue.

* test(s3): add range-read coverage matrix across SSE modes and sizes

Existing range-read coverage in test/s3/sse was scoped to small (<= 1MB)
single-chunk objects, with one ad-hoc range case per SSE mode and one
129-byte boundary-crossing case in TestSSEMultipartUploadIntegration.
Nothing exercised:

  - Range reads on single-PUT objects whose content crosses the 8MB
    internal chunk boundary (medium size class).
  - Range reads on multipart objects whose parts each span multiple
    internal chunks (large size class) -- the shape #8908 originally
    surfaced for full-object GETs and the most likely site of any
    future regression in per-chunk IV / PartOffset plumbing for
    partial reads.
  - A consistent range-pattern set applied uniformly across SSE modes,
    so any divergence between modes (SSE-C uses random IV + PartOffset;
    SSE-S3/KMS use base IV + offset) is comparable at a glance.

TestSSERangeReadCoverageMatrix introduces a parameterized matrix:

  modes:     no_sse, sse_c, sse_kms, sse_s3
  sizes:     small (256KB single chunk),
             medium (12MB single PUT crossing one internal boundary),
             large (5x9MB multipart, ~10 internal chunks, every part
                    itself spans an 8MB boundary)
  ranges:    single byte at 0, prefix 512B, single byte at last,
             suffix bytes=-100, open-ended bytes=N-, whole object,
             AES-block boundary 15-31, mid straddling one internal
             boundary (medium+large), mid spanning many internal
             boundaries (large only)

Per case it asserts: body bytes equal the expected slice, Content-Length
matches the range length, Content-Range matches start-end/total, and the
SSE response headers match the mode.

The sse_kms branch probes once with a 1-byte SSE-KMS PUT and t.Skip's
the remaining sse_kms subtests with a clear reason if the local server
has no KMS provider configured -- the default `weed mini` setup lacks
one; the Makefile target `test-with-kms` provides one via OpenBao. Other
modes always run.

Verified locally: 75 subtests pass under no_sse / sse_c / sse_s3 against
weed mini, sse_kms cleanly skipped.

* test(s3): conform new test names to TestSSE*Integration so CI runs them

The two tests added in the previous commits had names that did NOT match
the patterns the test/s3/sse Makefile and .github/workflows/s3-sse-tests.yml
use to discover SSE integration tests:

  - test/s3/sse/Makefile `test` target:           TestSSE.*Integration
  - test/s3/sse/Makefile `test-multipart`:        TestSSEMultipartUploadIntegration
  - .github/workflows/s3-sse-tests.yml:           ...|.*Multipart.*Integration|.*RangeRequestsServerBehavior

Result: SSE-KMS coverage I added to TestSSERangeReadCoverageMatrix and
the Docker-Registry-shape multipart regression in
TestSSES3MultipartManyChunks_DockerRegistryShape were silently invisible
to CI even though the underlying test setup (start-seaweedfs-ci using
s3-config-template.json with the embedded `local` KMS provider) already
has SSE-KMS configured.

Renames:

  TestSSERangeReadCoverageMatrix              -> TestSSERangeReadIntegration
  TestSSES3MultipartManyChunks_...            -> TestSSEMultipartManyChunksIntegration

Both names now match `TestSSE.*Integration` (Makefile `test` target) and
TestSSEMultipartManyChunksIntegration additionally matches
`.*Multipart.*Integration` (CI's comprehensive subset). No behavior
change; only the function names move.

Verified locally against `weed mini` with s3-config-template.json:
TestSSERangeReadIntegration runs 96 leaf subtests across 4 SSE modes
(none, SSE-C, SSE-KMS, SSE-S3) x 3 size classes x 7-9 range patterns,
all passing, 0 skipped. The probe-and-skip in the SSE-KMS arm now only
fires for ad-hoc local setups that don't load any KMS provider; the
project's standard test setup loads the local provider, so CI has full
SSE-KMS range coverage.

* fix(s3api): validate SSE-KMS chunk IV during prep, before any fetch

Addresses CodeRabbit review on PR #9228: in
createMultipartSSEKMSDecryptedReaderDirect the per-chunk SSE-KMS metadata
was deserialized in the prep loop but the IV length was only validated
later, inside CreateSSEKMSDecryptedReader, which runs from the wrap
closure -- AFTER the chunk's volume-server fetch has already started.
That weakens the new "reject malformed chunks before any fetch" contract
for SSE-KMS specifically: a chunk with a missing/short/long IV would
fire its HTTP GET, then fail mid-stream during decrypt.

The fix moves the existing ValidateIV check into the prep loop, matching
the SSE-S3 and SSE-C paths.

Drive-by: extract the SSE-KMS prep loop into a free
buildMultipartSSEKMSReader helper that mirrors buildMultipartSSES3Reader,
so the new contract is unit-testable without an S3ApiServer. The
exported method (createMultipartSSEKMSDecryptedReaderDirect) stays a
thin caller, so behavior for production callers is unchanged.

New tests in weed/s3api/s3api_multipart_ssekms_test.go pin the contract:

  - TestBuildMultipartSSEKMSReader_RejectsBadIVBeforeAnyFetch covers
    missing IV, empty IV, short IV, long IV. Each case asserts both
    that an error is returned AND that the fetch callback is never
    invoked.
  - TestBuildMultipartSSEKMSReader_RejectsMissingMetadataBeforeAnyFetch
    pins the analogous behavior when SseMetadata is nil on a chunk in
    position N: chunks 0..N-1 must not be fetched (the earlier eager
    implementation depended on a closeAppendedReaders cleanup path; the
    new contract is stronger -- nothing is opened in the first place).
  - TestBuildMultipartSSEKMSReader_RejectsUnparseableMetadataBeforeAnyFetch
    covers the JSON-unmarshal failure branch.
  - TestBuildMultipartSSEKMSReader_SortsByOffset smoke-tests the
    documented sort-by-offset contract by recording the order in which
    fetch is invoked.

All four pass under `go test ./weed/s3api/`. Existing weed/s3api unit
suite + the SSE integration suite (with the local KMS provider enabled
via s3-config-template.json) continue to pass.

* test(s3): address CodeRabbit nitpicks on range coverage matrix

Three small follow-ups on the range-read coverage matrix from the
previous commit, per CodeRabbit nitpicks on PR #9228:

1. Promote the body-length check from `assert.Equal` to `require.Equal`
   so a truncation regression -- the canonical #8908 failure mode --
   aborts the subtest immediately. Previously the assertion logged a
   length mismatch and then `assertDataEqual` ran on differently-sized
   slices, producing a noisy byte-diff on top of the actual symptom.
   The redundant trailing `t.Fatalf` block becomes dead and is removed.

2. Broaden the SSE-KMS probe-skip heuristic. The probe previously
   produced the friendly "KMS provider not configured" message only
   for 5xx responses; KMS-misconfig surfaces also include 501
   NotImplemented, 4xx KMS.NotConfigured, and error messages
   containing "KMS.NotConfigured" / "NotImplemented" /
   "not configured". The behaviour change is purely cosmetic (the
   caller t.Skip's on any non-empty reason either way) but the new
   diagnostic is more useful in CI logs.

3. Add `t.Parallel()` at the mode and size-class levels of the matrix.
   Each (mode, size) writes an independent object key under the shared
   bucket, with no cross-talk, so parallel execution is safe. Local
   wall time on the full matrix dropped from ~2.0s to ~1.1s (~45%);
   the savings scale with chunk count and CI machine concurrency.

Verified locally against `weed mini` with s3-config-template.json:
  - go test ./weed/s3api/ -count=1                   PASS
  - TestSSERangeReadIntegration -v                   112 PASS, 0 SKIP
  - TestSSEMultipartUploadIntegration etc.           PASS

* fix(s3api): tighten lazy reader error path; unify SSE IV validation

Three CodeRabbit nitpicks on PR #9228:

1. lazyMultipartChunkReader: mark finished on non-EOF Read errors

   The Read loop's three earlier failure paths (chunk index past end,
   fetch error, wrap error) all set l.finished = true before returning.
   The non-EOF Read path -- where l.current.Read itself errors mid-chunk
   -- did not, leaving l.current/l.closer set and l.finished = false. A
   caller that retried Read after an error would re-enter the same
   broken stream instead of advancing or giving up. Set l.finished =
   true on non-EOF Read error so post-error state is consistent across
   all four failure sites; Close() (which the GetObjectHandler defers)
   still releases the chunk body.

2. Unify IV-length validation across SSE-S3, SSE-KMS, SSE-C prep paths

   The previous commit moved SSE-KMS to the shared ValidateIV helper
   but left SSE-S3 and SSE-C with bespoke inline `len(...) !=
   AESBlockSize` checks. All three are enforcing the same invariant;
   inconsistency obscures the symmetry. Move SSE-S3 and SSE-C to
   ValidateIV too, with the same `<algo> chunk <fileId> IV` name
   convention. Error message wording shifts from "<algo> chunk X has
   invalid IV length N (expected 16)" to ValidateIV's "invalid <algo>
   chunk X IV length: expected 16 bytes, got N". The substring
   "IV length" is preserved across both, so the existing
   TestBuildMultipartSSES3Reader_InvalidIVLength substring assertion
   is loosened to match either form.

3. TestBuildMultipartSSEKMSReader_SortsByOffset: verify full ordering

   The test previously drove Read() to observe fetch-call order, but
   CreateSSEKMSDecryptedReader requires a live KMS provider to unwrap
   the encrypted DEK -- unavailable in unit tests -- so the wrap
   closure failed on the first chunk and only one fetch was ever
   recorded. The test asserted only fetchOrder[0] == "c0", which is
   weaker than the comment promised.

   Switch to a static check: type-assert the returned reader to
   *lazyMultipartChunkReader (same package so unexported fields are
   accessible) and inspect the prepared chunks slice directly. This
   pins the entire [c0, c1, c2] sort order in one place, doesn't
   depend on KMS, and runs in zero fetch calls. The fetch closure
   now asserts it is never invoked during preparation.

All weed/s3api unit tests pass; integration suite (with KMS provider
configured via s3-config-template.json) passes.

* test(s3): switch range coverage cleanup to t.Cleanup; tighten KMS probe

Two CodeRabbit comments on PR #9228, both about
test/s3/sse/s3_sse_range_coverage_test.go:

1. CRITICAL: defer + t.Parallel() race in TestSSERangeReadIntegration

   The test creates one bucket up front, then runs subtests that call
   t.Parallel() at the mode and size levels (added in 058cbf27 to cut
   wall time). t.Parallel() pauses each subtest and yields back to the
   parent. The parent's for loop finishes scheduling, the function
   returns, and the deferred cleanupTestBucket fires -- BEFORE any
   parallel subtest body has executed. The bucket gets deleted out
   from under the parallel subtests, which then race the cleanup and
   either fail with NoSuchBucket or, depending on lazy-deletion
   behaviour on the server side, mask other regressions because
   chunks happen to still be readable for a brief window.

   The local matrix passing prior to this commit was a server-side
   coincidence; the t.Cleanup contract is the right one for parent
   tests with parallel children, and switching to it is a one-line
   change. t.Cleanup runs after the test AND all its (parallel)
   subtests complete, so the bucket survives until every leaf
   subtest is done.

2. MINOR: tighten the SSE-KMS probe-skip heuristic

   The previous broadening (058cbf27) treated `code == 400` as
   "KMS provider not configured", on the theory that some servers
   return 4xx for KMS misconfig. That is too aggressive: a real
   misconfiguration in the SSE-KMS test request itself (bad keyID
   format, missing header) ALSO surfaces as a 400, and would
   silently t.Skip the SSE-KMS subtree in CI -- which is exactly
   the integration coverage the new TestSSERangeReadIntegration is
   supposed to add. Drop the 400 branch (and the redundant 501
   match, since 501 >= 500 already covers it). Genuine
   "KMS.NotConfigured" / "NotImplemented" responses are still
   recognised via the string-match block immediately below,
   regardless of status code, so the friendly skip message survives
   for the cases where it actually applies.

Verified locally against `weed mini` with s3-config-template.json:

  - go test ./weed/s3api/                     PASS
  - TestSSERangeReadIntegration -v            113 PASS lines, 0 SKIP
  - TestSSEMultipartUploadIntegration etc.    PASS
This commit is contained in:
Chris Lu
2026-04-26 16:31:42 -07:00
committed by GitHub
parent dc462a80d7
commit 4f628ff4e5
6 changed files with 1476 additions and 268 deletions
+28 -35
View File
@@ -489,9 +489,10 @@ func TestBuildMultipartSSES3Reader_InvalidIVLength(t *testing.T) {
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
closed := false
fetchCalled := false
fetch := func(c *filer_pb.FileChunk) (io.ReadCloser, error) {
return &closeTrackingReadCloser{Reader: bytes.NewReader([]byte("whatever")), closed: &closed}, nil
fetchCalled = true
return io.NopCloser(bytes.NewReader([]byte("whatever"))), nil
}
chunks := []*filer_pb.FileChunk{
@@ -508,27 +509,35 @@ func TestBuildMultipartSSES3Reader_InvalidIVLength(t *testing.T) {
if err == nil {
t.Fatal("expected error for invalid IV length, got nil")
}
if !strings.Contains(err.Error(), "invalid IV length") {
t.Errorf("expected 'invalid IV length' in error, got: %v", err)
// ValidateIV's error format is "invalid <name> length: ...";
// match on the part of the message that's stable across the
// shared helper's wording.
if !strings.Contains(err.Error(), "IV length") {
t.Errorf("expected 'IV length' in error, got: %v", err)
}
if !closed {
t.Error("chunk reader for the bad chunk was not closed on error")
// Validation runs upfront before any chunk fetch, so no volume-server
// HTTP connection should have been opened on the failure path.
if fetchCalled {
t.Error("fetchChunk was called for an invalid-IV chunk; metadata validation should fail before any fetch")
}
})
}
}
// TestBuildMultipartSSES3Reader_ClosesAppendedOnError verifies that when a
// later chunk fails (e.g., malformed metadata), readers already appended for
// earlier valid chunks are closed so volume-server HTTP connections do not leak.
func TestBuildMultipartSSES3Reader_ClosesAppendedOnError(t *testing.T) {
// TestBuildMultipartSSES3Reader_RejectsBadChunkBeforeAnyFetch verifies that
// when any chunk's metadata is malformed, the helper returns an error WITHOUT
// having opened a volume-server HTTP connection for any chunk. Per-chunk
// metadata is validated upfront precisely so a bad chunk in position N does
// not leak open HTTP responses for chunks 0..N-1 (the original eager
// implementation depended on a closeAppendedReaders cleanup path; this test
// pins the stronger contract: nothing is opened in the first place).
func TestBuildMultipartSSES3Reader_RejectsBadChunkBeforeAnyFetch(t *testing.T) {
keyManager := initSSES3KeyManagerForTest(t)
// First chunk: valid SSE-S3 chunk.
cipher1, meta1 := encryptSSES3Part(t, []byte("first chunk plaintext"))
// Second chunk: missing per-chunk metadata, triggers error after first is
// already appended.
// Second chunk: missing per-chunk metadata, triggers error.
chunks := []*filer_pb.FileChunk{
{
FileId: "1,good",
@@ -546,36 +555,20 @@ func TestBuildMultipartSSES3Reader_ClosesAppendedOnError(t *testing.T) {
},
}
firstClosed := false
secondClosed := false
fetched := map[string]int{}
fetch := func(c *filer_pb.FileChunk) (io.ReadCloser, error) {
switch c.GetFileIdString() {
case "1,good":
return &closeTrackingReadCloser{Reader: bytes.NewReader(cipher1), closed: &firstClosed}, nil
case "2,bad":
return &closeTrackingReadCloser{Reader: bytes.NewReader([]byte("x")), closed: &secondClosed}, nil
}
return nil, fmt.Errorf("unexpected chunk %s", c.GetFileIdString())
fetched[c.GetFileIdString()]++
return io.NopCloser(bytes.NewReader([]byte("x"))), nil
}
_, err := buildMultipartSSES3Reader(chunks, keyManager, fetch)
if err == nil {
t.Fatal("expected error from missing chunk metadata, got nil")
}
if !firstClosed {
t.Error("previously appended chunk reader was not closed on error")
if !strings.Contains(err.Error(), "missing per-chunk metadata") {
t.Errorf("expected 'missing per-chunk metadata' in error, got: %v", err)
}
if !secondClosed {
t.Error("chunk reader for the failing chunk was not closed on error")
if len(fetched) != 0 {
t.Errorf("expected no chunks fetched on validation failure, got %v", fetched)
}
}
type closeTrackingReadCloser struct {
io.Reader
closed *bool
}
func (r *closeTrackingReadCloser) Close() error {
*r.closed = true
return nil
}
+247
View File
@@ -0,0 +1,247 @@
package s3api
import (
"bytes"
"crypto/rand"
"fmt"
"io"
"strings"
"testing"
"github.com/seaweedfs/seaweedfs/weed/pb/filer_pb"
"github.com/seaweedfs/seaweedfs/weed/s3api/s3_constants"
)
// TestBuildMultipartSSEKMSReader_RejectsBadIVBeforeAnyFetch pins the contract
// that a per-chunk SSE-KMS metadata blob with a missing or wrong-length IV is
// rejected during preparation, before any volume-server fetch fires.
//
// DeserializeSSEKMSMetadata only proves the JSON parses; it leaves the
// kmsKey.IV field at whatever the metadata actually carried. CreateSSEKMSDecryptedReader
// does call ValidateIV, but only when the wrap closure runs -- after the
// chunk's HTTP body has already been opened. The lazy reader's whole point
// is to never start an HTTP fetch for a chunk we know we cannot decrypt, so
// IV validation must happen in the prep loop. This test is the regression
// guard for that, addressing CodeRabbit review feedback on PR #9228.
func TestBuildMultipartSSEKMSReader_RejectsBadIVBeforeAnyFetch(t *testing.T) {
makeMetadata := func(iv []byte) []byte {
t.Helper()
key := &SSEKMSKey{
KeyID: "test-kms-key",
EncryptedDataKey: bytes.Repeat([]byte{0x42}, 32),
IV: iv,
}
md, err := SerializeSSEKMSMetadata(key)
if err != nil {
t.Fatalf("SerializeSSEKMSMetadata: %v", err)
}
return md
}
cases := []struct {
name string
iv []byte
expectErr string
}{
{"missing IV", nil, "invalid"},
{"empty IV", []byte{}, "invalid"},
{"short IV", []byte("too-short"), "invalid"}, // 9 bytes, not 16
{"long IV", bytes.Repeat([]byte{1}, 32), "invalid"},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
fetchCalled := false
fetch := func(c *filer_pb.FileChunk) (io.ReadCloser, error) {
fetchCalled = true
return io.NopCloser(bytes.NewReader([]byte("ignored"))), nil
}
chunks := []*filer_pb.FileChunk{
{
FileId: "1,bad-iv",
Offset: 0,
Size: 8,
SseType: filer_pb.SSEType_SSE_KMS,
SseMetadata: makeMetadata(tc.iv),
},
}
_, err := buildMultipartSSEKMSReader(chunks, fetch)
if err == nil {
t.Fatal("expected error for invalid SSE-KMS IV, got nil")
}
if !strings.Contains(err.Error(), tc.expectErr) {
t.Errorf("expected %q in error, got: %v", tc.expectErr, err)
}
// The whole point of upfront validation: no HTTP fetch must fire
// for a chunk that fails the metadata gate.
if fetchCalled {
t.Error("fetchChunk was called for a chunk with invalid IV; metadata validation must run before any fetch")
}
})
}
}
// TestBuildMultipartSSEKMSReader_RejectsMissingMetadataBeforeAnyFetch verifies
// that a chunk tagged SSE-KMS but with no SseMetadata bytes is rejected during
// preparation, also without firing a fetch. Mirrors the SSE-S3 contract pinned
// by TestBuildMultipartSSES3Reader_RejectsBadChunkBeforeAnyFetch.
func TestBuildMultipartSSEKMSReader_RejectsMissingMetadataBeforeAnyFetch(t *testing.T) {
fetched := map[string]int{}
fetch := func(c *filer_pb.FileChunk) (io.ReadCloser, error) {
fetched[c.GetFileIdString()]++
return io.NopCloser(bytes.NewReader([]byte("ignored"))), nil
}
// First chunk has valid SSE-KMS metadata; second chunk is tagged SSE-KMS
// but has no metadata blob. The eager pre-#9228 implementation would have
// opened chunk 0's HTTP body before discovering chunk 1's problem; the
// lazy implementation must reject up front and leave both alone.
validKey := &SSEKMSKey{
KeyID: "test-kms-key",
EncryptedDataKey: bytes.Repeat([]byte{0x42}, 32),
IV: make([]byte, s3_constants.AESBlockSize),
}
if _, err := rand.Read(validKey.IV); err != nil {
t.Fatalf("rand.Read: %v", err)
}
validMeta, err := SerializeSSEKMSMetadata(validKey)
if err != nil {
t.Fatalf("SerializeSSEKMSMetadata: %v", err)
}
chunks := []*filer_pb.FileChunk{
{
FileId: "1,good",
Offset: 0,
Size: 16,
SseType: filer_pb.SSEType_SSE_KMS,
SseMetadata: validMeta,
},
{
FileId: "2,no-metadata",
Offset: 16,
Size: 16,
SseType: filer_pb.SSEType_SSE_KMS,
SseMetadata: nil, // triggers "missing per-chunk metadata"
},
}
_, err = buildMultipartSSEKMSReader(chunks, fetch)
if err == nil {
t.Fatal("expected error from missing chunk metadata, got nil")
}
if !strings.Contains(err.Error(), "missing per-chunk metadata") {
t.Errorf("expected 'missing per-chunk metadata' in error, got: %v", err)
}
if len(fetched) != 0 {
t.Errorf("expected no chunks fetched on validation failure, got %v", fetched)
}
}
// TestBuildMultipartSSEKMSReader_RejectsUnparseableMetadataBeforeAnyFetch
// covers the prep-loop branch where SseMetadata is non-empty but JSON-malformed
// so DeserializeSSEKMSMetadata itself returns an error. Same contract: no
// fetch fires.
func TestBuildMultipartSSEKMSReader_RejectsUnparseableMetadataBeforeAnyFetch(t *testing.T) {
fetchCalled := false
fetch := func(c *filer_pb.FileChunk) (io.ReadCloser, error) {
fetchCalled = true
return io.NopCloser(bytes.NewReader([]byte("ignored"))), nil
}
chunks := []*filer_pb.FileChunk{
{
FileId: "1,garbage",
Offset: 0,
Size: 8,
SseType: filer_pb.SSEType_SSE_KMS,
SseMetadata: []byte("{not-json"),
},
}
_, err := buildMultipartSSEKMSReader(chunks, fetch)
if err == nil {
t.Fatal("expected error from unparseable SSE-KMS metadata, got nil")
}
if !strings.Contains(err.Error(), "deserialize SSE-KMS metadata") {
t.Errorf("expected 'deserialize SSE-KMS metadata' in error, got: %v", err)
}
if fetchCalled {
t.Error("fetchChunk was called for a chunk with garbage metadata; deserialize must fail before any fetch")
}
}
// TestBuildMultipartSSEKMSReader_SortsByOffset verifies that the prep loop
// reorders chunks by Offset before constructing the lazy reader, matching
// the documented contract and the SSE-S3 helper.
//
// Driving the reader's Read() to observe fetch order does not work as a full
// ordering check: CreateSSEKMSDecryptedReader requires a live KMS provider to
// unwrap the encrypted DEK, which is unavailable in this unit test, so the
// wrap closure fails on the first chunk and the lazy reader marks itself
// finished -- only one fetch is ever observed. Instead, since the lazy
// reader and its prepared chunks live in the same package, we type-assert
// the returned reader to *lazyMultipartChunkReader and inspect the prepared
// chunks slice directly. This is a stronger check (the entire ordering, not
// just the first element) and does not depend on KMS availability.
func TestBuildMultipartSSEKMSReader_SortsByOffset(t *testing.T) {
makeChunk := func(fid string, offset int64) *filer_pb.FileChunk {
key := &SSEKMSKey{
KeyID: "test-kms-key",
EncryptedDataKey: bytes.Repeat([]byte{0x42}, 32),
IV: bytes.Repeat([]byte{0x10}, s3_constants.AESBlockSize),
}
meta, err := SerializeSSEKMSMetadata(key)
if err != nil {
t.Fatalf("SerializeSSEKMSMetadata: %v", err)
}
return &filer_pb.FileChunk{
FileId: fid,
Offset: offset,
Size: 1,
SseType: filer_pb.SSEType_SSE_KMS,
SseMetadata: meta,
}
}
chunks := []*filer_pb.FileChunk{
makeChunk("c2", 200),
makeChunk("c0", 0),
makeChunk("c1", 100),
}
fetchCalled := false
fetch := func(c *filer_pb.FileChunk) (io.ReadCloser, error) {
fetchCalled = true
return nil, fmt.Errorf("fetch must not be called: ordering is checked via prepared chunks")
}
reader, err := buildMultipartSSEKMSReader(chunks, fetch)
if err != nil {
t.Fatalf("buildMultipartSSEKMSReader: %v", err)
}
if fetchCalled {
t.Fatal("fetch must not be invoked during prep; ordering is verified statically")
}
lazy, ok := reader.(*lazyMultipartChunkReader)
if !ok {
t.Fatalf("expected *lazyMultipartChunkReader, got %T", reader)
}
if len(lazy.chunks) != 3 {
t.Fatalf("expected 3 prepared chunks, got %d", len(lazy.chunks))
}
gotOrder := []string{
lazy.chunks[0].chunk.GetFileIdString(),
lazy.chunks[1].chunk.GetFileIdString(),
lazy.chunks[2].chunk.GetFileIdString(),
}
wantOrder := []string{"c0", "c1", "c2"}
for i, want := range wantOrder {
if gotOrder[i] != want {
t.Errorf("prepared chunks not in offset order: got %v, want %v", gotOrder, wantOrder)
break
}
}
}
+262 -233
View File
@@ -2563,10 +2563,22 @@ func (s3a *S3ApiServer) detectPrimarySSEType(entry *filer_pb.Entry) string {
// createMultipartSSECDecryptedReaderDirect creates a reader that decrypts each chunk independently for multipart SSE-C objects (direct volume path)
// Note: encryptedStream parameter is unused (always nil) as this function fetches chunks directly to avoid double I/O.
// It's kept in the signature for API consistency with non-Direct versions.
//
// Per-chunk metadata is validated upfront (so a malformed chunk fails fast
// without opening any HTTP connections); chunk fetches happen LAZILY through
// lazyMultipartChunkReader, so at most one volume-server connection is open
// at a time. See buildMultipartSSES3Reader for the rationale (issue #8908).
//
// SSE-C multipart behavior (differs from SSE-KMS/SSE-S3):
// - Upload: CreateSSECEncryptedReader generates a RANDOM IV per part (no base IV + offset).
// - Metadata: PartOffset tracks position within the encrypted stream.
// - Decryption: use stored IV and advance the CTR stream by PartOffset.
//
// SSE-KMS/SSE-S3 instead use base IV + calculateIVWithOffset(partOffset) at
// encryption time. CopyObject currently applies calculateIVWithOffset to SSE-C
// as well, which may be incorrect (TODO: investigate consistency).
func (s3a *S3ApiServer) createMultipartSSECDecryptedReaderDirect(ctx context.Context, encryptedStream io.ReadCloser, customerKey *SSECustomerKey, entry *filer_pb.Entry) (io.Reader, error) {
// Close the original encrypted stream since chunks are fetched individually.
// Defer so the stream is closed on every return path (including error
// returns from inside the per-chunk loop), matching the SSE-S3 helper.
if encryptedStream != nil {
defer encryptedStream.Close()
}
@@ -2580,192 +2592,135 @@ func (s3a *S3ApiServer) createMultipartSSECDecryptedReaderDirect(ctx context.Con
return chunks[i].GetOffset() < chunks[j].GetOffset()
})
// Create readers for each chunk, decrypting them independently
readers := make([]io.Reader, 0, len(chunks))
// Close any readers already appended to `readers` on error paths, to avoid
// leaking volume-server HTTP connections.
closeAppendedReaders := func() {
for _, r := range readers {
if closer, ok := r.(io.Closer); ok {
closer.Close()
}
}
}
preparedChunks := make([]preparedMultipartChunk, 0, len(chunks))
for _, chunk := range chunks {
// Get this chunk's encrypted data
chunkReader, err := s3a.createEncryptedChunkReader(ctx, chunk)
if chunk.GetSseType() != filer_pb.SSEType_SSE_C {
preparedChunks = append(preparedChunks, preparedMultipartChunk{chunk: chunk})
continue
}
if len(chunk.GetSseMetadata()) == 0 {
return nil, fmt.Errorf("SSE-C chunk %s missing per-chunk metadata", chunk.GetFileIdString())
}
ssecMetadata, err := DeserializeSSECMetadata(chunk.GetSseMetadata())
if err != nil {
closeAppendedReaders()
return nil, fmt.Errorf("failed to create chunk reader: %v", err)
return nil, fmt.Errorf("failed to deserialize SSE-C metadata for chunk %s: %v", chunk.GetFileIdString(), err)
}
// Handle based on chunk's encryption type
if chunk.GetSseType() == filer_pb.SSEType_SSE_C {
// Check if this chunk has per-chunk SSE-C metadata
if len(chunk.GetSseMetadata()) == 0 {
chunkReader.Close()
closeAppendedReaders()
return nil, fmt.Errorf("SSE-C chunk %s missing per-chunk metadata", chunk.GetFileIdString())
}
// Deserialize the SSE-C metadata
ssecMetadata, err := DeserializeSSECMetadata(chunk.GetSseMetadata())
if err != nil {
chunkReader.Close()
closeAppendedReaders()
return nil, fmt.Errorf("failed to deserialize SSE-C metadata for chunk %s: %v", chunk.GetFileIdString(), err)
}
// Decode the IV from the metadata
chunkIV, err := base64.StdEncoding.DecodeString(ssecMetadata.IV)
if err != nil {
chunkReader.Close()
closeAppendedReaders()
return nil, fmt.Errorf("failed to decode IV for SSE-C chunk %s: %v", chunk.GetFileIdString(), err)
}
// Guard cipher.NewCTR against a missing/short IV (base64 decode of
// an empty or malformed field would otherwise reach it and panic).
if len(chunkIV) != s3_constants.AESBlockSize {
chunkReader.Close()
closeAppendedReaders()
return nil, fmt.Errorf("SSE-C chunk %s has invalid IV length %d (expected %d)",
chunk.GetFileIdString(), len(chunkIV), s3_constants.AESBlockSize)
}
glog.V(4).Infof("Decrypting SSE-C chunk %s with IV=%x, PartOffset=%d",
chunk.GetFileIdString(), chunkIV[:8], ssecMetadata.PartOffset)
// Note: SSE-C multipart behavior (differs from SSE-KMS/SSE-S3):
// - Upload: CreateSSECEncryptedReader generates RANDOM IV per part (no base IV + offset)
// - Metadata: PartOffset tracks position within the encrypted stream
// - Decryption: Use stored IV and advance CTR stream by PartOffset
//
// This differs from:
// - SSE-KMS/SSE-S3: Use base IV + calculateIVWithOffset(partOffset) during encryption
// - CopyObject: Applies calculateIVWithOffset to SSE-C (which may be incorrect)
//
// TODO: Investigate CopyObject SSE-C PartOffset handling for consistency
partOffset := ssecMetadata.PartOffset
if partOffset < 0 {
chunkReader.Close()
closeAppendedReaders()
return nil, fmt.Errorf("invalid SSE-C part offset %d for chunk %s", partOffset, chunk.GetFileIdString())
}
decryptedChunkReader, decErr := CreateSSECDecryptedReaderWithOffset(chunkReader, customerKey, chunkIV, uint64(partOffset))
if decErr != nil {
chunkReader.Close()
closeAppendedReaders()
return nil, fmt.Errorf("failed to decrypt chunk: %v", decErr)
}
// Use the streaming decrypted reader directly
readers = append(readers, struct {
io.Reader
io.Closer
}{
Reader: decryptedChunkReader,
Closer: chunkReader,
})
glog.V(4).Infof("Added streaming decrypted reader for SSE-C chunk %s", chunk.GetFileIdString())
} else {
// Non-SSE-C chunk, use as-is
readers = append(readers, chunkReader)
glog.V(4).Infof("Added non-encrypted reader for chunk %s", chunk.GetFileIdString())
chunkIV, err := base64.StdEncoding.DecodeString(ssecMetadata.IV)
if err != nil {
return nil, fmt.Errorf("failed to decode IV for SSE-C chunk %s: %v", chunk.GetFileIdString(), err)
}
// Guard cipher.NewCTR against a missing/short IV (base64 decode of
// an empty or malformed field would otherwise reach it and panic).
// Uses the shared ValidateIV helper so all three SSE prep paths
// (SSE-S3, SSE-KMS, SSE-C) enforce IV length identically.
if err := ValidateIV(chunkIV, fmt.Sprintf("SSE-C chunk %s IV", chunk.GetFileIdString())); err != nil {
return nil, err
}
if ssecMetadata.PartOffset < 0 {
return nil, fmt.Errorf("invalid SSE-C part offset %d for chunk %s", ssecMetadata.PartOffset, chunk.GetFileIdString())
}
// Capture per-chunk values into the wrap closure.
fileId := chunk.GetFileIdString()
ivCopy := chunkIV
partOffset := uint64(ssecMetadata.PartOffset)
preparedChunks = append(preparedChunks, preparedMultipartChunk{
chunk: chunk,
wrap: func(raw io.ReadCloser) (io.Reader, error) {
glog.V(4).Infof("Decrypting SSE-C chunk %s with IV=%x, PartOffset=%d",
fileId, ivCopy[:8], partOffset)
dec, decErr := CreateSSECDecryptedReaderWithOffset(raw, customerKey, ivCopy, partOffset)
if decErr != nil {
return nil, fmt.Errorf("failed to decrypt chunk: %v", decErr)
}
return dec, nil
},
})
}
return NewMultipartSSEReader(readers), nil
return &lazyMultipartChunkReader{
chunks: preparedChunks,
fetch: func(c *filer_pb.FileChunk) (io.ReadCloser, error) {
return s3a.createEncryptedChunkReader(ctx, c)
},
}, nil
}
// createMultipartSSEKMSDecryptedReaderDirect creates a reader that decrypts each chunk independently for multipart SSE-KMS objects (direct volume path)
// Note: encryptedStream parameter is unused (always nil) as this function fetches chunks directly to avoid double I/O.
// It's kept in the signature for API consistency with non-Direct versions.
//
// Per-chunk metadata is validated upfront (so a malformed chunk fails fast
// without opening any HTTP connections); chunk fetches happen LAZILY through
// lazyMultipartChunkReader, so at most one volume-server connection is open
// at a time. See buildMultipartSSES3Reader for the rationale (issue #8908).
func (s3a *S3ApiServer) createMultipartSSEKMSDecryptedReaderDirect(ctx context.Context, encryptedStream io.ReadCloser, entry *filer_pb.Entry) (io.Reader, error) {
// Close the original encrypted stream since chunks are fetched individually.
// Defer so the stream is closed on every return path (including error
// returns from inside the per-chunk loop), matching the SSE-S3 helper.
if encryptedStream != nil {
defer encryptedStream.Close()
}
// Sort a copy of the slice so entry.Chunks is not reordered (other code
// paths, e.g. ETag computation, can rely on the original chunk order).
// IV length is validated inside CreateSSEKMSDecryptedReader via ValidateIV.
originalChunks := entry.GetChunks()
chunks := make([]*filer_pb.FileChunk, len(originalChunks))
copy(chunks, originalChunks)
sort.Slice(chunks, func(i, j int) bool {
return chunks[i].GetOffset() < chunks[j].GetOffset()
return buildMultipartSSEKMSReader(entry.GetChunks(), func(chunk *filer_pb.FileChunk) (io.ReadCloser, error) {
return s3a.createEncryptedChunkReader(ctx, chunk)
})
}
// buildMultipartSSEKMSReader composes a decrypted reader from a set of
// multipart SSE-KMS chunks. Mirrors buildMultipartSSES3Reader: chunks are
// validated upfront (per-chunk metadata parses, IV has the right length) and
// fetched + decrypted lazily through lazyMultipartChunkReader, so at most one
// volume-server HTTP body is live at a time. Exposed as a free function so
// tests can inject a mock chunk fetcher and pin the "no fetch on bad
// metadata" contract without spinning up an S3ApiServer.
func buildMultipartSSEKMSReader(chunks []*filer_pb.FileChunk, fetchChunk func(*filer_pb.FileChunk) (io.ReadCloser, error)) (io.Reader, error) {
sortedChunks := make([]*filer_pb.FileChunk, len(chunks))
copy(sortedChunks, chunks)
sort.Slice(sortedChunks, func(i, j int) bool {
return sortedChunks[i].GetOffset() < sortedChunks[j].GetOffset()
})
// Create readers for each chunk, decrypting them independently
readers := make([]io.Reader, 0, len(chunks))
// Close any readers already appended to `readers` on error paths, to avoid
// leaking volume-server HTTP connections.
closeAppendedReaders := func() {
for _, r := range readers {
if closer, ok := r.(io.Closer); ok {
closer.Close()
}
preparedChunks := make([]preparedMultipartChunk, 0, len(sortedChunks))
for _, chunk := range sortedChunks {
if chunk.GetSseType() != filer_pb.SSEType_SSE_KMS {
preparedChunks = append(preparedChunks, preparedMultipartChunk{chunk: chunk})
continue
}
}
for _, chunk := range chunks {
// Get this chunk's encrypted data
chunkReader, err := s3a.createEncryptedChunkReader(ctx, chunk)
if len(chunk.GetSseMetadata()) == 0 {
return nil, fmt.Errorf("SSE-KMS chunk %s missing per-chunk metadata", chunk.GetFileIdString())
}
kmsKey, err := DeserializeSSEKMSMetadata(chunk.GetSseMetadata())
if err != nil {
closeAppendedReaders()
return nil, fmt.Errorf("failed to create chunk reader: %v", err)
return nil, fmt.Errorf("failed to deserialize SSE-KMS metadata for chunk %s: %v", chunk.GetFileIdString(), err)
}
// Handle based on chunk's encryption type
if chunk.GetSseType() == filer_pb.SSEType_SSE_KMS {
// Check if this chunk has per-chunk SSE-KMS metadata
if len(chunk.GetSseMetadata()) == 0 {
chunkReader.Close()
closeAppendedReaders()
return nil, fmt.Errorf("SSE-KMS chunk %s missing per-chunk metadata", chunk.GetFileIdString())
}
// Use the per-chunk SSE-KMS metadata
kmsKey, err := DeserializeSSEKMSMetadata(chunk.GetSseMetadata())
if err != nil {
chunkReader.Close()
closeAppendedReaders()
return nil, fmt.Errorf("failed to deserialize SSE-KMS metadata for chunk %s: %v", chunk.GetFileIdString(), err)
}
glog.V(4).Infof("Decrypting SSE-KMS chunk %s with KeyID=%s",
chunk.GetFileIdString(), kmsKey.KeyID)
// Create decrypted reader for this chunk
decryptedChunkReader, decErr := CreateSSEKMSDecryptedReader(chunkReader, kmsKey)
if decErr != nil {
chunkReader.Close()
closeAppendedReaders()
return nil, fmt.Errorf("failed to decrypt chunk: %v", decErr)
}
// Use the streaming decrypted reader directly
readers = append(readers, struct {
io.Reader
io.Closer
}{
Reader: decryptedChunkReader,
Closer: chunkReader,
})
glog.V(4).Infof("Added streaming decrypted reader for SSE-KMS chunk %s", chunk.GetFileIdString())
} else {
// Non-SSE-KMS chunk, use as-is
readers = append(readers, chunkReader)
glog.V(4).Infof("Added non-encrypted reader for chunk %s", chunk.GetFileIdString())
// Validate IV length up front, mirroring the SSE-S3 / SSE-C
// preparation paths. CreateSSEKMSDecryptedReader does call
// ValidateIV internally, but only when the wrap closure runs --
// after the chunk's volume-server fetch has already started. We
// want the "reject malformed chunks before any fetch" contract to
// hold for SSE-KMS too, so a missing or short IV must fail here
// in the prep loop rather than turn into a mid-stream error.
if err := ValidateIV(kmsKey.IV, fmt.Sprintf("SSE-KMS chunk %s IV", chunk.GetFileIdString())); err != nil {
return nil, err
}
// Capture kmsKey and chunk into the wrap closure so each prepared
// entry decrypts with its own per-chunk SSE-KMS key.
fileId := chunk.GetFileIdString()
preparedChunks = append(preparedChunks, preparedMultipartChunk{
chunk: chunk,
wrap: func(raw io.ReadCloser) (io.Reader, error) {
glog.V(4).Infof("Decrypting SSE-KMS chunk %s with KeyID=%s", fileId, kmsKey.KeyID)
dec, decErr := CreateSSEKMSDecryptedReader(raw, kmsKey)
if decErr != nil {
return nil, fmt.Errorf("failed to decrypt chunk: %v", decErr)
}
return dec, nil
},
})
}
return NewMultipartSSEReader(readers), nil
return &lazyMultipartChunkReader{
chunks: preparedChunks,
fetch: fetchChunk,
}, nil
}
// createMultipartSSES3DecryptedReaderDirect creates a reader that decrypts each chunk independently for multipart SSE-S3 objects (direct volume path)
@@ -2786,6 +2741,15 @@ func (s3a *S3ApiServer) createMultipartSSES3DecryptedReaderDirect(ctx context.Co
// SSE-S3 chunks. Chunks are fetched via fetchChunk and decrypted using their
// per-chunk metadata (each multipart part has its own DEK and IV). Exposed as a
// standalone helper so tests can inject a mock chunk fetcher.
//
// All per-chunk metadata is validated upfront so a malformed chunk fails fast
// without opening any HTTP connections to volume servers. The actual chunk
// fetch and decryption happens LAZILY as the returned reader is read: at most
// one chunk's HTTP connection is open at a time. Eagerly opening every chunk's
// HTTP response (the previous behavior) caused later chunks' connections to
// sit idle while earlier chunks were still being consumed, which under load
// could trip volume-server idle/keepalive limits and yield truncated reads
// (issue #8908).
func buildMultipartSSES3Reader(chunks []*filer_pb.FileChunk, keyManager *SSES3KeyManager, fetchChunk func(*filer_pb.FileChunk) (io.ReadCloser, error)) (io.Reader, error) {
// Sort a copy of the slice so callers do not observe their input chunks
// reordered (the backing array is shared with entry.Chunks, which other
@@ -2796,82 +2760,147 @@ func buildMultipartSSES3Reader(chunks []*filer_pb.FileChunk, keyManager *SSES3Ke
return sortedChunks[i].GetOffset() < sortedChunks[j].GetOffset()
})
// Create readers for each chunk, decrypting them independently
readers := make([]io.Reader, 0, len(sortedChunks))
// Close any readers already appended to `readers` on error paths, to avoid
// leaking volume-server HTTP connections.
closeAppendedReaders := func() {
for _, r := range readers {
if closer, ok := r.(io.Closer); ok {
closer.Close()
}
}
}
// Validate every chunk's SSE-S3 metadata before returning a reader. This
// keeps the eager-validation contract that callers and tests rely on
// (malformed metadata fails immediately), without holding open any
// volume-server HTTP connections.
preparedChunks := make([]preparedMultipartChunk, 0, len(sortedChunks))
for _, chunk := range sortedChunks {
// Get this chunk's encrypted data
chunkReader, err := fetchChunk(chunk)
if chunk.GetSseType() != filer_pb.SSEType_SSE_S3 {
preparedChunks = append(preparedChunks, preparedMultipartChunk{chunk: chunk})
continue
}
if len(chunk.GetSseMetadata()) == 0 {
return nil, fmt.Errorf("SSE-S3 chunk %s missing per-chunk metadata", chunk.GetFileIdString())
}
meta, err := DeserializeSSES3Metadata(chunk.GetSseMetadata(), keyManager)
if err != nil {
closeAppendedReaders()
return nil, fmt.Errorf("failed to create chunk reader: %v", err)
return nil, fmt.Errorf("failed to deserialize SSE-S3 metadata for chunk %s: %v", chunk.GetFileIdString(), err)
}
// Handle based on chunk's encryption type
if chunk.GetSseType() == filer_pb.SSEType_SSE_S3 {
// Check if this chunk has per-chunk SSE-S3 metadata
if len(chunk.GetSseMetadata()) == 0 {
chunkReader.Close()
closeAppendedReaders()
return nil, fmt.Errorf("SSE-S3 chunk %s missing per-chunk metadata", chunk.GetFileIdString())
}
// Deserialize the per-chunk SSE-S3 metadata to get the IV
chunkSSES3Metadata, err := DeserializeSSES3Metadata(chunk.GetSseMetadata(), keyManager)
if err != nil {
chunkReader.Close()
closeAppendedReaders()
return nil, fmt.Errorf("failed to deserialize SSE-S3 metadata for chunk %s: %v", chunk.GetFileIdString(), err)
}
// Use the IV from the chunk metadata. DeserializeSSES3Metadata does
// not require an IV, so validate the length here before it reaches
// cipher.NewCTR, which would otherwise panic on a nil or short IV.
iv := chunkSSES3Metadata.IV
if len(iv) != s3_constants.AESBlockSize {
chunkReader.Close()
closeAppendedReaders()
return nil, fmt.Errorf("SSE-S3 chunk %s has invalid IV length %d (expected %d)",
chunk.GetFileIdString(), len(iv), s3_constants.AESBlockSize)
}
glog.V(4).Infof("Decrypting SSE-S3 chunk %s with KeyID=%s, IV length=%d",
chunk.GetFileIdString(), chunkSSES3Metadata.KeyID, len(iv))
// Create decrypted reader for this chunk
decryptedChunkReader, decErr := CreateSSES3DecryptedReader(chunkReader, chunkSSES3Metadata, iv)
if decErr != nil {
chunkReader.Close()
closeAppendedReaders()
return nil, fmt.Errorf("failed to decrypt SSE-S3 chunk: %v", decErr)
}
// Use the streaming decrypted reader directly
readers = append(readers, struct {
io.Reader
io.Closer
}{
Reader: decryptedChunkReader,
Closer: chunkReader,
})
glog.V(4).Infof("Added streaming decrypted reader for SSE-S3 chunk %s", chunk.GetFileIdString())
} else {
// Non-SSE-S3 chunk, use as-is
readers = append(readers, chunkReader)
glog.V(4).Infof("Added non-encrypted reader for chunk %s", chunk.GetFileIdString())
// DeserializeSSES3Metadata does not require an IV, so validate the
// length here before it reaches cipher.NewCTR, which would otherwise
// panic on a nil or short IV. Uses the shared ValidateIV helper so
// all three SSE prep paths (SSE-S3, SSE-KMS, SSE-C) enforce IV
// length identically.
if err := ValidateIV(meta.IV, fmt.Sprintf("SSE-S3 chunk %s IV", chunk.GetFileIdString())); err != nil {
return nil, err
}
// Capture meta and chunk by-value into the wrap closure so each
// prepared entry decrypts with its own per-chunk key + IV.
fileId := chunk.GetFileIdString()
preparedChunks = append(preparedChunks, preparedMultipartChunk{
chunk: chunk,
wrap: func(raw io.ReadCloser) (io.Reader, error) {
glog.V(4).Infof("Decrypting SSE-S3 chunk %s with KeyID=%s, IV length=%d",
fileId, meta.KeyID, len(meta.IV))
dec, err := CreateSSES3DecryptedReader(raw, meta, meta.IV)
if err != nil {
return nil, fmt.Errorf("failed to decrypt SSE-S3 chunk: %v", err)
}
return dec, nil
},
})
}
return NewMultipartSSEReader(readers), nil
return &lazyMultipartChunkReader{
chunks: preparedChunks,
fetch: fetchChunk,
}, nil
}
// preparedMultipartChunk pairs a chunk with the per-SSE wrapping logic the
// lazy reader applies to its raw HTTP body. wrap is nil for chunks that
// stream as-is (no SSE on the chunk, even though the object is multipart-SSE);
// otherwise wrap is the SSE-specific decryption setup, which receives the
// already-opened raw chunk body and returns the plaintext reader.
type preparedMultipartChunk struct {
chunk *filer_pb.FileChunk
wrap func(raw io.ReadCloser) (io.Reader, error)
}
// lazyMultipartChunkReader streams a sequence of multipart chunks one at a
// time. It opens each chunk's underlying HTTP fetch (and applies the
// SSE-specific decryption wrapper) only when the previous chunk has been
// fully consumed, so volume-server connections do not pile up for large
// objects. This is the same shape used by all three SSE multipart read
// paths (SSE-S3, SSE-KMS, SSE-C); only the per-chunk wrap closure differs.
type lazyMultipartChunkReader struct {
chunks []preparedMultipartChunk
fetch func(*filer_pb.FileChunk) (io.ReadCloser, error)
idx int
current io.Reader // current chunk's plaintext reader (or raw reader for non-SSE chunks)
closer io.Closer // current chunk's underlying HTTP body, to close on advance/Close
finished bool
}
func (l *lazyMultipartChunkReader) Read(p []byte) (int, error) {
for {
if l.finished {
return 0, io.EOF
}
if l.current == nil {
if l.idx >= len(l.chunks) {
l.finished = true
return 0, io.EOF
}
pc := l.chunks[l.idx]
l.idx++
chunkReader, err := l.fetch(pc.chunk)
if err != nil {
l.finished = true
return 0, fmt.Errorf("failed to create chunk reader: %v", err)
}
if pc.wrap == nil {
// Non-SSE chunk in an otherwise SSE-multipart object: stream
// raw bytes through.
l.current = chunkReader
l.closer = chunkReader
glog.V(4).Infof("Streaming non-encrypted chunk %s", pc.chunk.GetFileIdString())
} else {
wrapped, wrapErr := pc.wrap(chunkReader)
if wrapErr != nil {
chunkReader.Close()
l.finished = true
return 0, wrapErr
}
l.current = wrapped
l.closer = chunkReader
}
}
n, err := l.current.Read(p)
if err == io.EOF {
closeErr := l.closer.Close()
l.current = nil
l.closer = nil
if n > 0 {
return n, nil
}
if closeErr != nil {
glog.V(2).Infof("Error closing chunk reader: %v", closeErr)
}
continue
}
if err != nil {
// Non-EOF read error: the underlying chunk body is in an
// indeterminate state. Mark ourselves finished so a retried
// Read does not try to drain the same broken stream; let
// Close() release the chunk body. This matches the failure
// semantics of the fetch and wrap error paths above.
l.finished = true
}
return n, err
}
}
func (l *lazyMultipartChunkReader) Close() error {
l.finished = true
if l.closer != nil {
err := l.closer.Close()
l.current = nil
l.closer = nil
return err
}
return nil
}
// createEncryptedChunkReader creates a reader for a single encrypted chunk
+280
View File
@@ -0,0 +1,280 @@
package s3api
import (
"bytes"
"crypto/rand"
"fmt"
"io"
"sync/atomic"
"testing"
"github.com/seaweedfs/seaweedfs/weed/pb/filer_pb"
"github.com/seaweedfs/seaweedfs/weed/s3api/s3_constants"
)
// TestMultipartSSES3RealisticEndToEnd reproduces the production multipart SSE-S3
// flow where ALL parts share the same DEK and baseIV (the upload-init key/IV),
// and each part is encrypted with partOffset=0. Each part is then chunked at 8MB
// boundaries the way UploadReaderInChunks does. After completion, the chunks
// have global offsets but per-chunk stored IVs derived from part-local offsets.
//
// buildMultipartSSES3Reader is then run on the assembled chunks; the
// concatenated decrypted output must equal the concatenation of the part
// plaintexts. This is the round trip that fails in #8908 if anything in the
// encrypt or decrypt path is inconsistent.
func TestMultipartSSES3RealisticEndToEnd(t *testing.T) {
keyManager := initSSES3KeyManagerForTest(t)
// One DEK and one baseIV, shared by all parts (the upload-init values).
key, err := GenerateSSES3Key()
if err != nil {
t.Fatalf("GenerateSSES3Key: %v", err)
}
baseIV := make([]byte, s3_constants.AESBlockSize)
if _, err := rand.Read(baseIV); err != nil {
t.Fatalf("rand.Read baseIV: %v", err)
}
const chunkSize = int64(8 * 1024 * 1024)
// Realistic mix of part sizes: small (one chunk), exact 8MB, >8MB (two
// chunks), much larger (multiple chunks).
partSizes := []int{
5 * 1024 * 1024, // 5MB (single chunk)
8 * 1024 * 1024, // 8MB exactly (single chunk, full)
8*1024*1024 + 123, // crosses chunk boundary (two chunks)
17 * 1024 * 1024, // three chunks
1234, // tiny
}
parts := make([][]byte, len(partSizes))
for i, n := range partSizes {
parts[i] = makeRandomPlaintext(t, n)
}
// Build the chunks list the way completion would produce it: encrypt each
// part with partOffset=0, slice the ciphertext at chunkSize boundaries,
// store per-chunk metadata IV = calculateIVWithOffset(baseIV, partLocalOff),
// then assign GLOBAL offsets to the FileChunk.
type chunkBlob struct {
fid string
ciphertext []byte
}
var chunks []*filer_pb.FileChunk
chunkData := map[string][]byte{}
var globalOffset int64
for partIdx, partPlaintext := range parts {
encReader, _, err := CreateSSES3EncryptedReaderWithBaseIV(bytes.NewReader(partPlaintext), key, baseIV, 0)
if err != nil {
t.Fatalf("CreateSSES3EncryptedReaderWithBaseIV(part %d): %v", partIdx, err)
}
ciphertext, err := io.ReadAll(encReader)
if err != nil {
t.Fatalf("read encrypted part %d: %v", partIdx, err)
}
for partLocalOff := int64(0); partLocalOff < int64(len(ciphertext)); partLocalOff += chunkSize {
end := partLocalOff + chunkSize
if end > int64(len(ciphertext)) {
end = int64(len(ciphertext))
}
cipherSlice := ciphertext[partLocalOff:end]
chunkIV, _ := calculateIVWithOffset(baseIV, partLocalOff)
chunkKey := &SSES3Key{
Key: key.Key,
KeyID: key.KeyID,
Algorithm: key.Algorithm,
IV: chunkIV,
}
meta, err := SerializeSSES3Metadata(chunkKey)
if err != nil {
t.Fatalf("SerializeSSES3Metadata(part %d off %d): %v", partIdx, partLocalOff, err)
}
fid := fmt.Sprintf("%d,%d", partIdx+1, partLocalOff)
chunks = append(chunks, &filer_pb.FileChunk{
FileId: fid,
Offset: globalOffset, // global offset assigned at completion
Size: uint64(end - partLocalOff),
SseType: filer_pb.SSEType_SSE_S3,
SseMetadata: meta,
})
chunkData[fid] = cipherSlice
globalOffset += end - partLocalOff
}
}
fetch := func(c *filer_pb.FileChunk) (io.ReadCloser, error) {
data, ok := chunkData[c.GetFileIdString()]
if !ok {
return nil, fmt.Errorf("unexpected chunk %s", c.GetFileIdString())
}
return io.NopCloser(bytes.NewReader(data)), nil
}
reader, err := buildMultipartSSES3Reader(chunks, keyManager, fetch)
if err != nil {
t.Fatalf("buildMultipartSSES3Reader: %v", err)
}
got, err := io.ReadAll(reader)
if err != nil {
t.Fatalf("ReadAll decrypted output: %v", err)
}
want := bytes.Join(parts, nil)
if !bytes.Equal(got, want) {
idx := firstMismatch(got, want)
end := idx + 32
if end > len(got) {
end = len(got)
}
if end > len(want) {
end = len(want)
}
t.Fatalf("decrypted output mismatch at byte %d (total len got=%d want=%d)\n got: %x\nwant: %x",
idx, len(got), len(want), got[idx:end], want[idx:end])
}
}
// TestBuildMultipartSSES3Reader_LazyChunkFetch pins the lazy behavior of
// buildMultipartSSES3Reader: chunk N's HTTP fetch only happens after chunk
// N-1 has been fully consumed. The original eager loop opened every chunk's
// HTTP response upfront and held them open while io.MultiReader walked
// through readers[0]; for objects with many chunks (e.g. a 200MB Docker image
// blob), this could trip volume-server idle/keepalive limits and produce
// truncated reads at the client (issue #8908).
//
// The test installs a fetch hook that tracks how many chunks have been
// opened and when each one is closed, and verifies:
// - At any point during streaming, at most one chunk's reader is open.
// - The number of opened chunks grows as bytes are read out, not upfront.
// - All chunks are closed when the outer reader is fully drained.
func TestBuildMultipartSSES3Reader_LazyChunkFetch(t *testing.T) {
keyManager := initSSES3KeyManagerForTest(t)
key, err := GenerateSSES3Key()
if err != nil {
t.Fatalf("GenerateSSES3Key: %v", err)
}
baseIV := make([]byte, s3_constants.AESBlockSize)
if _, err := rand.Read(baseIV); err != nil {
t.Fatalf("rand.Read baseIV: %v", err)
}
// Many small chunks (mirrors many-part Docker Registry uploads).
const numChunks = 8
const chunkPayload = 1024
plaintexts := make([][]byte, numChunks)
chunkData := map[string][]byte{}
chunks := make([]*filer_pb.FileChunk, 0, numChunks)
for i := 0; i < numChunks; i++ {
plaintexts[i] = makeRandomPlaintext(t, chunkPayload)
// Encrypt as a fresh "part" with partOffset=0 (matching putToFiler).
encReader, _, err := CreateSSES3EncryptedReaderWithBaseIV(bytes.NewReader(plaintexts[i]), key, baseIV, 0)
if err != nil {
t.Fatalf("encrypt chunk %d: %v", i, err)
}
ciphertext, err := io.ReadAll(encReader)
if err != nil {
t.Fatalf("read ciphertext %d: %v", i, err)
}
chunkIV, _ := calculateIVWithOffset(baseIV, 0)
chunkKey := &SSES3Key{
Key: key.Key,
KeyID: key.KeyID,
Algorithm: key.Algorithm,
IV: chunkIV,
}
meta, err := SerializeSSES3Metadata(chunkKey)
if err != nil {
t.Fatalf("serialize meta %d: %v", i, err)
}
fid := fmt.Sprintf("vol,c%d", i)
chunks = append(chunks, &filer_pb.FileChunk{
FileId: fid,
Offset: int64(i) * chunkPayload,
Size: uint64(chunkPayload),
SseType: filer_pb.SSEType_SSE_S3,
SseMetadata: meta,
})
chunkData[fid] = ciphertext
}
var openCount int64 // total opens
var liveCount int64 // currently open
var maxLive int64
fetch := func(c *filer_pb.FileChunk) (io.ReadCloser, error) {
atomic.AddInt64(&openCount, 1)
if live := atomic.AddInt64(&liveCount, 1); live > atomic.LoadInt64(&maxLive) {
atomic.StoreInt64(&maxLive, live)
}
data, ok := chunkData[c.GetFileIdString()]
if !ok {
return nil, fmt.Errorf("unexpected chunk %s", c.GetFileIdString())
}
return &liveTrackingReadCloser{Reader: bytes.NewReader(data), live: &liveCount}, nil
}
reader, err := buildMultipartSSES3Reader(chunks, keyManager, fetch)
if err != nil {
t.Fatalf("buildMultipartSSES3Reader: %v", err)
}
// Construction alone must not have opened any chunk reader.
if got := atomic.LoadInt64(&openCount); got != 0 {
t.Fatalf("expected no chunks opened before any Read, got %d", got)
}
// Read first byte: should open chunk 0 only.
one := make([]byte, 1)
if n, err := reader.Read(one); n != 1 || err != nil {
t.Fatalf("first Read: n=%d err=%v", n, err)
}
if got := atomic.LoadInt64(&openCount); got != 1 {
t.Errorf("after first byte, expected 1 chunk opened, got %d", got)
}
if got := atomic.LoadInt64(&liveCount); got != 1 {
t.Errorf("after first byte, expected 1 chunk live, got %d", got)
}
// Drain the rest.
rest, err := io.ReadAll(reader)
if err != nil {
t.Fatalf("drain: %v", err)
}
got := append(one, rest...)
want := bytes.Join(plaintexts, nil)
if !bytes.Equal(got, want) {
idx := firstMismatch(got, want)
t.Fatalf("decrypted output mismatch at byte %d (got len %d, want len %d)", idx, len(got), len(want))
}
if got := atomic.LoadInt64(&openCount); got != int64(numChunks) {
t.Errorf("expected exactly %d chunk opens after drain, got %d", numChunks, got)
}
if got := atomic.LoadInt64(&maxLive); got > 1 {
t.Errorf("expected at most 1 chunk reader live at a time (lazy), saw peak of %d", got)
}
if got := atomic.LoadInt64(&liveCount); got != 0 {
t.Errorf("expected all chunks closed after drain, %d still live", got)
}
}
type liveTrackingReadCloser struct {
io.Reader
live *int64
once bool
}
func (r *liveTrackingReadCloser) Close() error {
if r.once {
return nil
}
r.once = true
atomic.AddInt64(r.live, -1)
return nil
}