Browse Source
fix: admin UI bucket delete now properly deletes collection and checks Object Lock (#7734)
fix: admin UI bucket delete now properly deletes collection and checks Object Lock (#7734)
* fix: admin UI bucket delete now properly deletes collection and checks Object Lock Fixes #7711 The admin UI's DeleteS3Bucket function was missing two critical behaviors: 1. It did not delete the collection from the master (unlike s3.bucket.delete shell command), leaving orphaned volume data that caused fs.verify errors. 2. It did not check for Object Lock protections before deletion, potentially allowing deletion of buckets with locked objects. Changes: - Add shared Object Lock checking utilities to object_lock_utils.go: - EntryHasActiveLock: standalone function to check if an entry has active lock - HasObjectsWithActiveLocks: shared function to scan bucket for locked objects - Refactor S3 API entryHasActiveLock to use shared EntryHasActiveLock function - Update admin UI DeleteS3Bucket to: - Check Object Lock using shared HasObjectsWithActiveLocks utility - Delete the collection before deleting filer entries (matching s3.bucket.delete) * refactor: S3 API uses shared Object Lock utilities Removes 114 lines of duplicated code from s3api_bucket_handlers.go by having hasObjectsWithActiveLocks delegate to the shared HasObjectsWithActiveLocks function in object_lock_utils.go. Now both S3 API and Admin UI use the same shared utilities: - EntryHasActiveLock - HasObjectsWithActiveLocks - recursivelyCheckLocksWithClient - checkVersionsForLocksWithClient * feat: s3.bucket.delete shell command now checks Object Lock Add Object Lock protection to the s3.bucket.delete shell command. If the bucket has Object Lock enabled and contains objects with active retention or legal hold, deletion is prevented. Also refactors Object Lock checking utilities into a new s3_objectlock package to avoid import cycles between shell, s3api, and admin packages. All three components now share the same logic: - S3 API (DeleteBucketHandler) - Admin UI (DeleteS3Bucket) - Shell command (s3.bucket.delete) * refactor: unified Object Lock checking and consistent deletion parameters 1. Add CheckBucketForLockedObjects() - a unified function that combines: - Bucket entry lookup - Object Lock enabled check - Scan for locked objects 2. All three components now use this single function: - S3 API (via s3api.CheckBucketForLockedObjects) - Admin UI (via s3api.CheckBucketForLockedObjects) - Shell command (via s3_objectlock.CheckBucketForLockedObjects) 3. Aligned deletion parameters across all components: - isDeleteData: false (collection already deleted separately) - isRecursive: true - ignoreRecursiveError: true * fix: properly handle non-EOF errors in Recv() loops The Recv() loops in recursivelyCheckLocksWithClient and checkVersionsForLocksWithClient were breaking on any error, which could hide real stream errors and incorrectly report 'no locks found'. Now: - io.EOF: break loop (normal end of stream) - any other error: return it so caller knows the stream failed * fix: address PR review comments 1. Add path traversal protection - validate entry names before building subdirectory paths. Skip entries with empty names, '.', '..', or containing path separators. 2. Use exact match for .versions folder instead of HasSuffix() to avoid mismatching unrelated directories like 'foo.versions'. 3. Replace path.Join with simple string concatenation since we now validate entry names. * refactor: extract paginateEntries helper to reduce duplication The recursivelyCheckLocksWithClient and checkVersionsForLocksWithClient functions shared significant structural similarity. Extracted a generic paginateEntries helper that: - Handles pagination logic (lastFileName tracking, Limit) - Handles stream receiving with proper EOF vs error handling - Validates entry names (path traversal protection) - Calls a processEntry callback for business logic This centralizes pagination logic and makes the code more maintainable. * feat: add context propagation for timeout and cancellation support All Object Lock checking functions now accept context.Context parameter: - paginateEntries(ctx, client, dir, processEntry) - recursivelyCheckLocksWithClient(ctx, client, dir, hasLocks, currentTime) - checkVersionsForLocksWithClient(ctx, client, versionsDir, hasLocks, currentTime) - HasObjectsWithActiveLocks(ctx, client, bucketPath) - CheckBucketForLockedObjects(ctx, client, bucketsPath, bucketName) This enables: - Timeout support for large bucket scans - Cancellation propagation from HTTP requests - The S3 API handler now uses r.Context() for proper request lifecycle * fix: address PR review comments 1. Add DefaultBucketsPath constant in admin_server.go instead of hardcoding "/buckets" in multiple places. 2. Add defensive normalization in EntryHasActiveLock: - TrimSpace to handle whitespace around values - ToUpper for case-insensitive comparison of legal hold and retention mode values - TrimSpace on retention date before parsing * fix: use ctx variable consistently instead of context.Background() In both DeleteS3Bucket and command_s3_bucket_delete, use the ctx variable defined at the start of the function for all gRPC calls instead of creating new context.Background() instances.pull/7736/head
Chris Lu
4 days ago
committed by
GitHub
GitHub
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 316 additions and 158 deletions
-
41weed/admin/dash/admin_server.go
-
27weed/s3api/object_lock_utils.go
-
232weed/s3api/s3_objectlock/object_lock_check.go
-
158weed/s3api/s3api_bucket_handlers.go
-
16weed/shell/command_s3_bucket_delete.go
@ -0,0 +1,232 @@ |
|||
package s3_objectlock |
|||
|
|||
import ( |
|||
"context" |
|||
"errors" |
|||
"fmt" |
|||
"io" |
|||
"strconv" |
|||
"strings" |
|||
"time" |
|||
|
|||
"github.com/seaweedfs/seaweedfs/weed/glog" |
|||
"github.com/seaweedfs/seaweedfs/weed/pb/filer_pb" |
|||
"github.com/seaweedfs/seaweedfs/weed/s3api/s3_constants" |
|||
) |
|||
|
|||
// ====================================================================
|
|||
// SHARED OBJECT LOCK CHECKING FUNCTIONS
|
|||
// ====================================================================
|
|||
// These functions are used by S3 API, Admin UI, and shell commands for
|
|||
// checking Object Lock status before bucket deletion.
|
|||
|
|||
// EntryHasActiveLock checks if an entry has an active retention or legal hold
|
|||
// This is a standalone function that can be used by any component
|
|||
func EntryHasActiveLock(entry *filer_pb.Entry, currentTime time.Time) bool { |
|||
if entry == nil || entry.Extended == nil { |
|||
return false |
|||
} |
|||
|
|||
// Check for active legal hold (case-insensitive, trimmed for defensive parsing)
|
|||
if legalHoldBytes, exists := entry.Extended[s3_constants.ExtLegalHoldKey]; exists { |
|||
legalHold := strings.TrimSpace(strings.ToUpper(string(legalHoldBytes))) |
|||
if legalHold == s3_constants.LegalHoldOn { |
|||
return true |
|||
} |
|||
} |
|||
|
|||
// Check for active retention (case-insensitive, trimmed for defensive parsing)
|
|||
if modeBytes, exists := entry.Extended[s3_constants.ExtObjectLockModeKey]; exists { |
|||
mode := strings.TrimSpace(strings.ToUpper(string(modeBytes))) |
|||
if mode == s3_constants.RetentionModeCompliance || mode == s3_constants.RetentionModeGovernance { |
|||
// Check if retention is still active
|
|||
if dateBytes, dateExists := entry.Extended[s3_constants.ExtRetentionUntilDateKey]; dateExists { |
|||
dateStr := strings.TrimSpace(string(dateBytes)) |
|||
timestamp, err := strconv.ParseInt(dateStr, 10, 64) |
|||
if err != nil { |
|||
// Fail-safe: if we can't parse the retention date, assume the object is locked
|
|||
// to prevent accidental data loss
|
|||
glog.Warningf("Failed to parse retention date '%s' for entry, assuming locked: %v", dateStr, err) |
|||
return true |
|||
} |
|||
retainUntil := time.Unix(timestamp, 0) |
|||
if retainUntil.After(currentTime) { |
|||
return true |
|||
} |
|||
} |
|||
} |
|||
} |
|||
|
|||
return false |
|||
} |
|||
|
|||
// HasObjectsWithActiveLocks checks if any objects in the bucket have active retention or legal hold
|
|||
// This function uses the filer gRPC client to scan the bucket directory
|
|||
func HasObjectsWithActiveLocks(ctx context.Context, client filer_pb.SeaweedFilerClient, bucketPath string) (bool, error) { |
|||
hasLocks := false |
|||
currentTime := time.Now() |
|||
|
|||
err := recursivelyCheckLocksWithClient(ctx, client, bucketPath, &hasLocks, currentTime) |
|||
if err != nil { |
|||
return false, fmt.Errorf("error checking for locked objects: %w", err) |
|||
} |
|||
|
|||
return hasLocks, nil |
|||
} |
|||
|
|||
// paginateEntries is a generic helper that handles pagination logic for listing directory entries.
|
|||
// The processEntry callback is called for each entry; returning stop=true stops iteration early.
|
|||
func paginateEntries(ctx context.Context, client filer_pb.SeaweedFilerClient, dir string, |
|||
processEntry func(entry *filer_pb.Entry) (stop bool, err error)) error { |
|||
lastFileName := "" |
|||
for { |
|||
resp, err := client.ListEntries(ctx, &filer_pb.ListEntriesRequest{ |
|||
Directory: dir, |
|||
StartFromFileName: lastFileName, |
|||
InclusiveStartFrom: false, |
|||
Limit: 10000, |
|||
}) |
|||
if err != nil { |
|||
return fmt.Errorf("failed to list directory %s: %w", dir, err) |
|||
} |
|||
|
|||
entriesReceived := false |
|||
for { |
|||
entryResp, recvErr := resp.Recv() |
|||
if recvErr != nil { |
|||
if errors.Is(recvErr, io.EOF) { |
|||
break // Normal end of stream
|
|||
} |
|||
return fmt.Errorf("failed to receive entry from %s: %w", dir, recvErr) |
|||
} |
|||
entriesReceived = true |
|||
entry := entryResp.Entry |
|||
lastFileName = entry.Name |
|||
|
|||
// Skip invalid entry names to prevent path traversal
|
|||
if entry.Name == "" || entry.Name == "." || entry.Name == ".." || |
|||
strings.ContainsAny(entry.Name, "/\\") { |
|||
glog.V(2).Infof("Skipping invalid entry name: %q in %s", entry.Name, dir) |
|||
continue |
|||
} |
|||
|
|||
stop, err := processEntry(entry) |
|||
if err != nil { |
|||
return err |
|||
} |
|||
if stop { |
|||
return nil |
|||
} |
|||
} |
|||
|
|||
if !entriesReceived { |
|||
break |
|||
} |
|||
} |
|||
return nil |
|||
} |
|||
|
|||
// recursivelyCheckLocksWithClient recursively checks all objects and versions for active locks
|
|||
func recursivelyCheckLocksWithClient(ctx context.Context, client filer_pb.SeaweedFilerClient, dir string, hasLocks *bool, currentTime time.Time) error { |
|||
if *hasLocks { |
|||
return nil // Early exit if already found a locked object
|
|||
} |
|||
|
|||
return paginateEntries(ctx, client, dir, func(entry *filer_pb.Entry) (bool, error) { |
|||
if *hasLocks { |
|||
return true, nil // Stop iteration
|
|||
} |
|||
|
|||
// Skip special directories
|
|||
if entry.Name == s3_constants.MultipartUploadsFolder { |
|||
return false, nil // Continue
|
|||
} |
|||
|
|||
if entry.IsDirectory { |
|||
subDir := dir + "/" + entry.Name |
|||
if entry.Name == s3_constants.VersionsFolder { |
|||
// Check all version files (exact match for .versions folder)
|
|||
if err := checkVersionsForLocksWithClient(ctx, client, subDir, hasLocks, currentTime); err != nil { |
|||
return false, err |
|||
} |
|||
} else { |
|||
// Recursively check subdirectories
|
|||
if err := recursivelyCheckLocksWithClient(ctx, client, subDir, hasLocks, currentTime); err != nil { |
|||
return false, err |
|||
} |
|||
} |
|||
} else { |
|||
// Check if this object has an active lock
|
|||
if EntryHasActiveLock(entry, currentTime) { |
|||
*hasLocks = true |
|||
glog.V(2).Infof("Found object with active lock: %s/%s", dir, entry.Name) |
|||
return true, nil // Stop iteration
|
|||
} |
|||
} |
|||
return false, nil // Continue
|
|||
}) |
|||
} |
|||
|
|||
// checkVersionsForLocksWithClient checks all versions in a .versions directory for active locks
|
|||
func checkVersionsForLocksWithClient(ctx context.Context, client filer_pb.SeaweedFilerClient, versionsDir string, hasLocks *bool, currentTime time.Time) error { |
|||
return paginateEntries(ctx, client, versionsDir, func(entry *filer_pb.Entry) (bool, error) { |
|||
if *hasLocks { |
|||
return true, nil // Stop iteration
|
|||
} |
|||
|
|||
if EntryHasActiveLock(entry, currentTime) { |
|||
*hasLocks = true |
|||
glog.V(2).Infof("Found version with active lock: %s/%s", versionsDir, entry.Name) |
|||
return true, nil // Stop iteration
|
|||
} |
|||
return false, nil // Continue
|
|||
}) |
|||
} |
|||
|
|||
// IsObjectLockEnabled checks if Object Lock is enabled on a bucket entry
|
|||
func IsObjectLockEnabled(entry *filer_pb.Entry) bool { |
|||
if entry == nil || entry.Extended == nil { |
|||
return false |
|||
} |
|||
|
|||
enabledBytes, exists := entry.Extended[s3_constants.ExtObjectLockEnabledKey] |
|||
if !exists { |
|||
return false |
|||
} |
|||
|
|||
enabled := string(enabledBytes) |
|||
return enabled == s3_constants.ObjectLockEnabled || enabled == "true" |
|||
} |
|||
|
|||
// CheckBucketForLockedObjects is a unified function that checks if a bucket has Object Lock enabled
|
|||
// and if so, scans for objects with active locks. This combines the bucket lookup and lock check
|
|||
// into a single operation used by S3 API, Admin UI, and shell commands.
|
|||
// Returns an error if the bucket has locked objects or if the check fails.
|
|||
func CheckBucketForLockedObjects(ctx context.Context, client filer_pb.SeaweedFilerClient, bucketsPath, bucketName string) error { |
|||
// Look up the bucket entry
|
|||
lookupResp, err := client.LookupDirectoryEntry(ctx, &filer_pb.LookupDirectoryEntryRequest{ |
|||
Directory: bucketsPath, |
|||
Name: bucketName, |
|||
}) |
|||
if err != nil { |
|||
return fmt.Errorf("bucket not found: %w", err) |
|||
} |
|||
|
|||
// Check if Object Lock is enabled
|
|||
if !IsObjectLockEnabled(lookupResp.Entry) { |
|||
return nil // No Object Lock, nothing to check
|
|||
} |
|||
|
|||
// Check for objects with active locks
|
|||
bucketPath := bucketsPath + "/" + bucketName |
|||
hasLockedObjects, checkErr := HasObjectsWithActiveLocks(ctx, client, bucketPath) |
|||
if checkErr != nil { |
|||
return fmt.Errorf("failed to check for locked objects: %w", checkErr) |
|||
} |
|||
if hasLockedObjects { |
|||
return fmt.Errorf("bucket has objects with active Object Lock retention or legal hold") |
|||
} |
|||
|
|||
return nil |
|||
} |
|||
|
|||
Write
Preview
Loading…
Cancel
Save
Reference in new issue