1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
|
package s3api
import (
"fmt"
"net/http/httptest"
"strconv"
"testing"
"time"
"errors"
"github.com/seaweedfs/seaweedfs/weed/pb/filer_pb"
"github.com/seaweedfs/seaweedfs/weed/s3api/s3_constants"
"github.com/seaweedfs/seaweedfs/weed/s3api/s3err"
"github.com/stretchr/testify/assert"
)
// TestExtractObjectLockMetadataFromRequest tests the function that extracts
// object lock headers from PUT requests and stores them in Extended attributes.
// This test would have caught the bug where object lock headers were ignored.
func TestExtractObjectLockMetadataFromRequest(t *testing.T) {
s3a := &S3ApiServer{}
t.Run("Extract COMPLIANCE mode and retention date", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
retainUntilDate := time.Now().Add(24 * time.Hour)
req.Header.Set(s3_constants.AmzObjectLockMode, "COMPLIANCE")
req.Header.Set(s3_constants.AmzObjectLockRetainUntilDate, retainUntilDate.Format(time.RFC3339))
entry := &filer_pb.Entry{
Extended: make(map[string][]byte),
}
err := s3a.extractObjectLockMetadataFromRequest(req, entry)
assert.NoError(t, err)
// Verify mode was stored
assert.Contains(t, entry.Extended, s3_constants.ExtObjectLockModeKey)
assert.Equal(t, "COMPLIANCE", string(entry.Extended[s3_constants.ExtObjectLockModeKey]))
// Verify retention date was stored
assert.Contains(t, entry.Extended, s3_constants.ExtRetentionUntilDateKey)
storedTimestamp, err := strconv.ParseInt(string(entry.Extended[s3_constants.ExtRetentionUntilDateKey]), 10, 64)
assert.NoError(t, err)
storedTime := time.Unix(storedTimestamp, 0)
assert.WithinDuration(t, retainUntilDate, storedTime, 1*time.Second)
})
t.Run("Extract GOVERNANCE mode and retention date", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
retainUntilDate := time.Now().Add(12 * time.Hour)
req.Header.Set(s3_constants.AmzObjectLockMode, "GOVERNANCE")
req.Header.Set(s3_constants.AmzObjectLockRetainUntilDate, retainUntilDate.Format(time.RFC3339))
entry := &filer_pb.Entry{
Extended: make(map[string][]byte),
}
err := s3a.extractObjectLockMetadataFromRequest(req, entry)
assert.NoError(t, err)
assert.Equal(t, "GOVERNANCE", string(entry.Extended[s3_constants.ExtObjectLockModeKey]))
assert.Contains(t, entry.Extended, s3_constants.ExtRetentionUntilDateKey)
})
t.Run("Extract legal hold ON", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
req.Header.Set(s3_constants.AmzObjectLockLegalHold, "ON")
entry := &filer_pb.Entry{
Extended: make(map[string][]byte),
}
err := s3a.extractObjectLockMetadataFromRequest(req, entry)
assert.NoError(t, err)
assert.Contains(t, entry.Extended, s3_constants.ExtLegalHoldKey)
assert.Equal(t, "ON", string(entry.Extended[s3_constants.ExtLegalHoldKey]))
})
t.Run("Extract legal hold OFF", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
req.Header.Set(s3_constants.AmzObjectLockLegalHold, "OFF")
entry := &filer_pb.Entry{
Extended: make(map[string][]byte),
}
err := s3a.extractObjectLockMetadataFromRequest(req, entry)
assert.NoError(t, err)
assert.Contains(t, entry.Extended, s3_constants.ExtLegalHoldKey)
assert.Equal(t, "OFF", string(entry.Extended[s3_constants.ExtLegalHoldKey]))
})
t.Run("Handle all object lock headers together", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
retainUntilDate := time.Now().Add(24 * time.Hour)
req.Header.Set(s3_constants.AmzObjectLockMode, "COMPLIANCE")
req.Header.Set(s3_constants.AmzObjectLockRetainUntilDate, retainUntilDate.Format(time.RFC3339))
req.Header.Set(s3_constants.AmzObjectLockLegalHold, "ON")
entry := &filer_pb.Entry{
Extended: make(map[string][]byte),
}
err := s3a.extractObjectLockMetadataFromRequest(req, entry)
assert.NoError(t, err)
// All metadata should be stored
assert.Equal(t, "COMPLIANCE", string(entry.Extended[s3_constants.ExtObjectLockModeKey]))
assert.Contains(t, entry.Extended, s3_constants.ExtRetentionUntilDateKey)
assert.Equal(t, "ON", string(entry.Extended[s3_constants.ExtLegalHoldKey]))
})
t.Run("Handle no object lock headers", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
// No object lock headers set
entry := &filer_pb.Entry{
Extended: make(map[string][]byte),
}
err := s3a.extractObjectLockMetadataFromRequest(req, entry)
assert.NoError(t, err)
// No object lock metadata should be stored
assert.NotContains(t, entry.Extended, s3_constants.ExtObjectLockModeKey)
assert.NotContains(t, entry.Extended, s3_constants.ExtRetentionUntilDateKey)
assert.NotContains(t, entry.Extended, s3_constants.ExtLegalHoldKey)
})
t.Run("Handle invalid retention date - should return error", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
req.Header.Set(s3_constants.AmzObjectLockMode, "GOVERNANCE")
req.Header.Set(s3_constants.AmzObjectLockRetainUntilDate, "invalid-date")
entry := &filer_pb.Entry{
Extended: make(map[string][]byte),
}
err := s3a.extractObjectLockMetadataFromRequest(req, entry)
assert.Error(t, err)
assert.True(t, errors.Is(err, ErrInvalidRetentionDateFormat))
// Mode should be stored but not invalid date
assert.Equal(t, "GOVERNANCE", string(entry.Extended[s3_constants.ExtObjectLockModeKey]))
assert.NotContains(t, entry.Extended, s3_constants.ExtRetentionUntilDateKey)
})
t.Run("Handle invalid legal hold value - should return error", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
req.Header.Set(s3_constants.AmzObjectLockLegalHold, "INVALID")
entry := &filer_pb.Entry{
Extended: make(map[string][]byte),
}
err := s3a.extractObjectLockMetadataFromRequest(req, entry)
assert.Error(t, err)
assert.True(t, errors.Is(err, ErrInvalidLegalHoldStatus))
// No legal hold metadata should be stored due to error
assert.NotContains(t, entry.Extended, s3_constants.ExtLegalHoldKey)
})
}
// TestAddObjectLockHeadersToResponse tests the function that adds object lock
// metadata from Extended attributes to HTTP response headers.
// This test would have caught the bug where HEAD responses didn't include object lock metadata.
func TestAddObjectLockHeadersToResponse(t *testing.T) {
s3a := &S3ApiServer{}
t.Run("Add COMPLIANCE mode and retention date to response", func(t *testing.T) {
w := httptest.NewRecorder()
retainUntilTime := time.Now().Add(24 * time.Hour)
entry := &filer_pb.Entry{
Extended: map[string][]byte{
s3_constants.ExtObjectLockModeKey: []byte("COMPLIANCE"),
s3_constants.ExtRetentionUntilDateKey: []byte(strconv.FormatInt(retainUntilTime.Unix(), 10)),
},
}
s3a.addObjectLockHeadersToResponse(w, entry)
// Verify headers were set
assert.Equal(t, "COMPLIANCE", w.Header().Get(s3_constants.AmzObjectLockMode))
assert.NotEmpty(t, w.Header().Get(s3_constants.AmzObjectLockRetainUntilDate))
// Verify the date format is correct
returnedDate := w.Header().Get(s3_constants.AmzObjectLockRetainUntilDate)
parsedTime, err := time.Parse(time.RFC3339, returnedDate)
assert.NoError(t, err)
assert.WithinDuration(t, retainUntilTime, parsedTime, 1*time.Second)
})
t.Run("Add GOVERNANCE mode to response", func(t *testing.T) {
w := httptest.NewRecorder()
entry := &filer_pb.Entry{
Extended: map[string][]byte{
s3_constants.ExtObjectLockModeKey: []byte("GOVERNANCE"),
},
}
s3a.addObjectLockHeadersToResponse(w, entry)
assert.Equal(t, "GOVERNANCE", w.Header().Get(s3_constants.AmzObjectLockMode))
})
t.Run("Add legal hold ON to response", func(t *testing.T) {
w := httptest.NewRecorder()
entry := &filer_pb.Entry{
Extended: map[string][]byte{
s3_constants.ExtLegalHoldKey: []byte("ON"),
},
}
s3a.addObjectLockHeadersToResponse(w, entry)
assert.Equal(t, "ON", w.Header().Get(s3_constants.AmzObjectLockLegalHold))
})
t.Run("Add legal hold OFF to response", func(t *testing.T) {
w := httptest.NewRecorder()
entry := &filer_pb.Entry{
Extended: map[string][]byte{
s3_constants.ExtLegalHoldKey: []byte("OFF"),
},
}
s3a.addObjectLockHeadersToResponse(w, entry)
assert.Equal(t, "OFF", w.Header().Get(s3_constants.AmzObjectLockLegalHold))
})
t.Run("Add all object lock headers to response", func(t *testing.T) {
w := httptest.NewRecorder()
retainUntilTime := time.Now().Add(12 * time.Hour)
entry := &filer_pb.Entry{
Extended: map[string][]byte{
s3_constants.ExtObjectLockModeKey: []byte("GOVERNANCE"),
s3_constants.ExtRetentionUntilDateKey: []byte(strconv.FormatInt(retainUntilTime.Unix(), 10)),
s3_constants.ExtLegalHoldKey: []byte("ON"),
},
}
s3a.addObjectLockHeadersToResponse(w, entry)
// All headers should be set
assert.Equal(t, "GOVERNANCE", w.Header().Get(s3_constants.AmzObjectLockMode))
assert.NotEmpty(t, w.Header().Get(s3_constants.AmzObjectLockRetainUntilDate))
assert.Equal(t, "ON", w.Header().Get(s3_constants.AmzObjectLockLegalHold))
})
t.Run("Handle entry with no object lock metadata", func(t *testing.T) {
w := httptest.NewRecorder()
entry := &filer_pb.Entry{
Extended: map[string][]byte{
"other-metadata": []byte("some-value"),
},
}
s3a.addObjectLockHeadersToResponse(w, entry)
// No object lock headers should be set for entries without object lock metadata
assert.Empty(t, w.Header().Get(s3_constants.AmzObjectLockMode))
assert.Empty(t, w.Header().Get(s3_constants.AmzObjectLockRetainUntilDate))
assert.Empty(t, w.Header().Get(s3_constants.AmzObjectLockLegalHold))
})
t.Run("Handle entry with object lock mode but no legal hold - should default to OFF", func(t *testing.T) {
w := httptest.NewRecorder()
entry := &filer_pb.Entry{
Extended: map[string][]byte{
s3_constants.ExtObjectLockModeKey: []byte("GOVERNANCE"),
},
}
s3a.addObjectLockHeadersToResponse(w, entry)
// Should set mode and default legal hold to OFF
assert.Equal(t, "GOVERNANCE", w.Header().Get(s3_constants.AmzObjectLockMode))
assert.Empty(t, w.Header().Get(s3_constants.AmzObjectLockRetainUntilDate))
assert.Equal(t, "OFF", w.Header().Get(s3_constants.AmzObjectLockLegalHold))
})
t.Run("Handle entry with retention date but no legal hold - should default to OFF", func(t *testing.T) {
w := httptest.NewRecorder()
retainUntilTime := time.Now().Add(24 * time.Hour)
entry := &filer_pb.Entry{
Extended: map[string][]byte{
s3_constants.ExtRetentionUntilDateKey: []byte(strconv.FormatInt(retainUntilTime.Unix(), 10)),
},
}
s3a.addObjectLockHeadersToResponse(w, entry)
// Should set retention date and default legal hold to OFF
assert.Empty(t, w.Header().Get(s3_constants.AmzObjectLockMode))
assert.NotEmpty(t, w.Header().Get(s3_constants.AmzObjectLockRetainUntilDate))
assert.Equal(t, "OFF", w.Header().Get(s3_constants.AmzObjectLockLegalHold))
})
t.Run("Handle nil entry gracefully", func(t *testing.T) {
w := httptest.NewRecorder()
// Should not panic
s3a.addObjectLockHeadersToResponse(w, nil)
// No headers should be set
assert.Empty(t, w.Header().Get(s3_constants.AmzObjectLockMode))
assert.Empty(t, w.Header().Get(s3_constants.AmzObjectLockRetainUntilDate))
assert.Empty(t, w.Header().Get(s3_constants.AmzObjectLockLegalHold))
})
t.Run("Handle entry with nil Extended map gracefully", func(t *testing.T) {
w := httptest.NewRecorder()
entry := &filer_pb.Entry{
Extended: nil,
}
// Should not panic
s3a.addObjectLockHeadersToResponse(w, entry)
// No headers should be set
assert.Empty(t, w.Header().Get(s3_constants.AmzObjectLockMode))
assert.Empty(t, w.Header().Get(s3_constants.AmzObjectLockRetainUntilDate))
assert.Empty(t, w.Header().Get(s3_constants.AmzObjectLockLegalHold))
})
t.Run("Handle invalid retention timestamp gracefully", func(t *testing.T) {
w := httptest.NewRecorder()
entry := &filer_pb.Entry{
Extended: map[string][]byte{
s3_constants.ExtObjectLockModeKey: []byte("COMPLIANCE"),
s3_constants.ExtRetentionUntilDateKey: []byte("invalid-timestamp"),
},
}
s3a.addObjectLockHeadersToResponse(w, entry)
// Mode should be set but not retention date due to invalid timestamp
assert.Equal(t, "COMPLIANCE", w.Header().Get(s3_constants.AmzObjectLockMode))
assert.Empty(t, w.Header().Get(s3_constants.AmzObjectLockRetainUntilDate))
})
}
// TestObjectLockHeaderRoundTrip tests the complete round trip:
// extract from request → store in Extended attributes → add to response
func TestObjectLockHeaderRoundTrip(t *testing.T) {
s3a := &S3ApiServer{}
t.Run("Complete round trip for COMPLIANCE mode", func(t *testing.T) {
// 1. Create request with object lock headers
req := httptest.NewRequest("PUT", "/bucket/object", nil)
retainUntilDate := time.Now().Add(24 * time.Hour)
req.Header.Set(s3_constants.AmzObjectLockMode, "COMPLIANCE")
req.Header.Set(s3_constants.AmzObjectLockRetainUntilDate, retainUntilDate.Format(time.RFC3339))
req.Header.Set(s3_constants.AmzObjectLockLegalHold, "ON")
// 2. Extract and store in Extended attributes
entry := &filer_pb.Entry{
Extended: make(map[string][]byte),
}
err := s3a.extractObjectLockMetadataFromRequest(req, entry)
assert.NoError(t, err)
// 3. Add to response headers
w := httptest.NewRecorder()
s3a.addObjectLockHeadersToResponse(w, entry)
// 4. Verify round trip preserved all data
assert.Equal(t, "COMPLIANCE", w.Header().Get(s3_constants.AmzObjectLockMode))
assert.Equal(t, "ON", w.Header().Get(s3_constants.AmzObjectLockLegalHold))
returnedDate := w.Header().Get(s3_constants.AmzObjectLockRetainUntilDate)
parsedTime, err := time.Parse(time.RFC3339, returnedDate)
assert.NoError(t, err)
assert.WithinDuration(t, retainUntilDate, parsedTime, 1*time.Second)
})
t.Run("Complete round trip for GOVERNANCE mode", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
retainUntilDate := time.Now().Add(12 * time.Hour)
req.Header.Set(s3_constants.AmzObjectLockMode, "GOVERNANCE")
req.Header.Set(s3_constants.AmzObjectLockRetainUntilDate, retainUntilDate.Format(time.RFC3339))
entry := &filer_pb.Entry{Extended: make(map[string][]byte)}
err := s3a.extractObjectLockMetadataFromRequest(req, entry)
assert.NoError(t, err)
w := httptest.NewRecorder()
s3a.addObjectLockHeadersToResponse(w, entry)
assert.Equal(t, "GOVERNANCE", w.Header().Get(s3_constants.AmzObjectLockMode))
assert.NotEmpty(t, w.Header().Get(s3_constants.AmzObjectLockRetainUntilDate))
})
}
// TestValidateObjectLockHeaders tests the validateObjectLockHeaders function
// to ensure proper validation of object lock headers in PUT requests
func TestValidateObjectLockHeaders(t *testing.T) {
s3a := &S3ApiServer{}
t.Run("Valid COMPLIANCE mode with retention date on versioned bucket", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
retainUntilDate := time.Now().Add(24 * time.Hour)
req.Header.Set(s3_constants.AmzObjectLockMode, "COMPLIANCE")
req.Header.Set(s3_constants.AmzObjectLockRetainUntilDate, retainUntilDate.Format(time.RFC3339))
err := s3a.validateObjectLockHeaders(req, true) // versioned bucket
assert.NoError(t, err)
})
t.Run("Valid GOVERNANCE mode with retention date on versioned bucket", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
retainUntilDate := time.Now().Add(12 * time.Hour)
req.Header.Set(s3_constants.AmzObjectLockMode, "GOVERNANCE")
req.Header.Set(s3_constants.AmzObjectLockRetainUntilDate, retainUntilDate.Format(time.RFC3339))
err := s3a.validateObjectLockHeaders(req, true) // versioned bucket
assert.NoError(t, err)
})
t.Run("Valid legal hold ON on versioned bucket", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
req.Header.Set(s3_constants.AmzObjectLockLegalHold, "ON")
err := s3a.validateObjectLockHeaders(req, true) // versioned bucket
assert.NoError(t, err)
})
t.Run("Valid legal hold OFF on versioned bucket", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
req.Header.Set(s3_constants.AmzObjectLockLegalHold, "OFF")
err := s3a.validateObjectLockHeaders(req, true) // versioned bucket
assert.NoError(t, err)
})
t.Run("Invalid object lock mode", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
req.Header.Set(s3_constants.AmzObjectLockMode, "INVALID_MODE")
retainUntilDate := time.Now().Add(24 * time.Hour)
req.Header.Set(s3_constants.AmzObjectLockRetainUntilDate, retainUntilDate.Format(time.RFC3339))
err := s3a.validateObjectLockHeaders(req, true) // versioned bucket
assert.Error(t, err)
assert.True(t, errors.Is(err, ErrInvalidObjectLockMode))
})
t.Run("Invalid legal hold status", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
req.Header.Set(s3_constants.AmzObjectLockLegalHold, "INVALID_STATUS")
err := s3a.validateObjectLockHeaders(req, true) // versioned bucket
assert.Error(t, err)
assert.True(t, errors.Is(err, ErrInvalidLegalHoldStatus))
})
t.Run("Object lock headers on non-versioned bucket", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
req.Header.Set(s3_constants.AmzObjectLockMode, "COMPLIANCE")
retainUntilDate := time.Now().Add(24 * time.Hour)
req.Header.Set(s3_constants.AmzObjectLockRetainUntilDate, retainUntilDate.Format(time.RFC3339))
err := s3a.validateObjectLockHeaders(req, false) // non-versioned bucket
assert.Error(t, err)
assert.True(t, errors.Is(err, ErrObjectLockVersioningRequired))
})
t.Run("Invalid retention date format", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
req.Header.Set(s3_constants.AmzObjectLockMode, "COMPLIANCE")
req.Header.Set(s3_constants.AmzObjectLockRetainUntilDate, "invalid-date-format")
err := s3a.validateObjectLockHeaders(req, true) // versioned bucket
assert.Error(t, err)
assert.True(t, errors.Is(err, ErrInvalidRetentionDateFormat))
})
t.Run("Retention date in the past", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
req.Header.Set(s3_constants.AmzObjectLockMode, "COMPLIANCE")
pastDate := time.Now().Add(-24 * time.Hour)
req.Header.Set(s3_constants.AmzObjectLockRetainUntilDate, pastDate.Format(time.RFC3339))
err := s3a.validateObjectLockHeaders(req, true) // versioned bucket
assert.Error(t, err)
assert.True(t, errors.Is(err, ErrRetentionDateMustBeFuture))
})
t.Run("Mode without retention date", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
req.Header.Set(s3_constants.AmzObjectLockMode, "COMPLIANCE")
err := s3a.validateObjectLockHeaders(req, true) // versioned bucket
assert.Error(t, err)
assert.True(t, errors.Is(err, ErrObjectLockModeRequiresDate))
})
t.Run("Retention date without mode", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
retainUntilDate := time.Now().Add(24 * time.Hour)
req.Header.Set(s3_constants.AmzObjectLockRetainUntilDate, retainUntilDate.Format(time.RFC3339))
err := s3a.validateObjectLockHeaders(req, true) // versioned bucket
assert.Error(t, err)
assert.True(t, errors.Is(err, ErrRetentionDateRequiresMode))
})
t.Run("Governance bypass header on non-versioned bucket", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
req.Header.Set("x-amz-bypass-governance-retention", "true")
err := s3a.validateObjectLockHeaders(req, false) // non-versioned bucket
assert.Error(t, err)
assert.True(t, errors.Is(err, ErrGovernanceBypassVersioningRequired))
})
t.Run("Governance bypass header on versioned bucket should pass", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
req.Header.Set("x-amz-bypass-governance-retention", "true")
err := s3a.validateObjectLockHeaders(req, true) // versioned bucket
assert.NoError(t, err)
})
t.Run("No object lock headers should pass", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
// No object lock headers set
err := s3a.validateObjectLockHeaders(req, true) // versioned bucket
assert.NoError(t, err)
})
t.Run("Mixed valid headers should pass", func(t *testing.T) {
req := httptest.NewRequest("PUT", "/bucket/object", nil)
retainUntilDate := time.Now().Add(48 * time.Hour)
req.Header.Set(s3_constants.AmzObjectLockMode, "GOVERNANCE")
req.Header.Set(s3_constants.AmzObjectLockRetainUntilDate, retainUntilDate.Format(time.RFC3339))
req.Header.Set(s3_constants.AmzObjectLockLegalHold, "ON")
err := s3a.validateObjectLockHeaders(req, true) // versioned bucket
assert.NoError(t, err)
})
}
// TestMapValidationErrorToS3Error tests the error mapping function
func TestMapValidationErrorToS3Error(t *testing.T) {
tests := []struct {
name string
inputError error
expectedCode s3err.ErrorCode
}{
{
name: "ErrObjectLockVersioningRequired",
inputError: ErrObjectLockVersioningRequired,
expectedCode: s3err.ErrInvalidRequest,
},
{
name: "ErrInvalidObjectLockMode",
inputError: ErrInvalidObjectLockMode,
expectedCode: s3err.ErrInvalidRequest,
},
{
name: "ErrInvalidLegalHoldStatus",
inputError: ErrInvalidLegalHoldStatus,
expectedCode: s3err.ErrMalformedXML,
},
{
name: "ErrInvalidRetentionDateFormat",
inputError: ErrInvalidRetentionDateFormat,
expectedCode: s3err.ErrMalformedDate,
},
{
name: "ErrRetentionDateMustBeFuture",
inputError: ErrRetentionDateMustBeFuture,
expectedCode: s3err.ErrInvalidRequest,
},
{
name: "ErrObjectLockModeRequiresDate",
inputError: ErrObjectLockModeRequiresDate,
expectedCode: s3err.ErrInvalidRequest,
},
{
name: "ErrRetentionDateRequiresMode",
inputError: ErrRetentionDateRequiresMode,
expectedCode: s3err.ErrInvalidRequest,
},
{
name: "ErrGovernanceBypassVersioningRequired",
inputError: ErrGovernanceBypassVersioningRequired,
expectedCode: s3err.ErrInvalidRequest,
},
{
name: "Unknown error defaults to ErrInvalidRequest",
inputError: fmt.Errorf("unknown error"),
expectedCode: s3err.ErrInvalidRequest,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := mapValidationErrorToS3Error(tt.inputError)
assert.Equal(t, tt.expectedCode, result)
})
}
}
// TestObjectLockPermissionLogic documents the correct behavior for object lock permission checks
// in PUT operations for both versioned and non-versioned buckets
func TestObjectLockPermissionLogic(t *testing.T) {
t.Run("Non-versioned bucket PUT operation logic", func(t *testing.T) {
// In non-versioned buckets, PUT operations overwrite existing objects
// Therefore, we MUST check if the existing object has object lock protections
// that would prevent overwrite before allowing the PUT operation.
//
// This test documents the expected behavior:
// 1. Check object lock headers validity (handled by validateObjectLockHeaders)
// 2. Check if existing object has object lock protections (handled by checkObjectLockPermissions)
// 3. If existing object is under retention/legal hold, deny the PUT unless governance bypass is valid
t.Log("For non-versioned buckets:")
t.Log("- PUT operations overwrite existing objects")
t.Log("- Must check existing object lock protections before allowing overwrite")
t.Log("- Governance bypass headers can be used to override GOVERNANCE mode retention")
t.Log("- COMPLIANCE mode retention and legal holds cannot be bypassed")
})
t.Run("Versioned bucket PUT operation logic", func(t *testing.T) {
// In versioned buckets, PUT operations create new versions without overwriting existing ones
// Therefore, we do NOT need to check existing object permissions since we're not modifying them.
// We only need to validate the object lock headers for the new version being created.
//
// This test documents the expected behavior:
// 1. Check object lock headers validity (handled by validateObjectLockHeaders)
// 2. Skip checking existing object permissions (since we're creating a new version)
// 3. Apply object lock metadata to the new version being created
t.Log("For versioned buckets:")
t.Log("- PUT operations create new versions without overwriting existing objects")
t.Log("- No need to check existing object lock protections")
t.Log("- Only validate object lock headers for the new version being created")
t.Log("- Each version has independent object lock settings")
})
t.Run("Governance bypass header validation", func(t *testing.T) {
// Governance bypass headers should only be used in specific scenarios:
// 1. Only valid on versioned buckets (consistent with object lock headers)
// 2. For non-versioned buckets: Used to override existing object's GOVERNANCE retention
// 3. For versioned buckets: Not typically needed since new versions don't conflict with existing ones
t.Log("Governance bypass behavior:")
t.Log("- Only valid on versioned buckets (header validation)")
t.Log("- For non-versioned buckets: Allows overwriting objects under GOVERNANCE retention")
t.Log("- For versioned buckets: Not typically needed for PUT operations")
t.Log("- Must have s3:BypassGovernanceRetention permission")
})
}
|