Browse Source
shell: add -owner flag to s3.bucket.create command (#7728)
shell: add -owner flag to s3.bucket.create command (#7728)
* shell: add -owner flag to s3.bucket.create command
This fixes an issue where buckets created via weed shell cannot be accessed
by non-admin S3 users because the bucket has no owner set.
When using S3 IAM authentication, non-admin users can only access buckets
they own. Buckets created via lazy S3 creation automatically have their
owner set from the request context, but buckets created via weed shell
had no owner, making them inaccessible to non-admin users.
The new -owner flag allows setting the bucket owner identity (s3-identity-id)
at creation time:
s3.bucket.create -name my-bucket -owner my-identity-name
Fixes: https://github.com/seaweedfs/seaweedfs/discussions/7599
* shell: add s3.bucket.owner command to view/change bucket ownership
This command allows viewing and changing the owner of an S3 bucket,
making it easier to manage bucket access for IAM users.
Usage:
# View the current owner of a bucket
s3.bucket.owner -name my-bucket
# Set or change the owner of a bucket
s3.bucket.owner -name my-bucket -set -owner new-identity
# Remove the owner (make bucket admin-only)
s3.bucket.owner -name my-bucket -set -owner ""
* shell: show bucket owner in s3.bucket.list output
Display the bucket owner (s3-identity-id) when listing buckets,
making it easier to see which identity owns each bucket.
Example output:
my-bucket size:1024 chunk:5 owner:my-identity
* admin: add bucket owner support to admin UI
- Add Owner field to S3Bucket struct for displaying bucket ownership
- Add Owner field to CreateBucketRequest for setting owner at creation
- Add UpdateBucketOwner API endpoint (PUT /api/s3/buckets/:bucket/owner)
- Add SetBucketOwner function for updating bucket ownership
- Update GetS3Buckets to populate owner from s3-identity-id extended attribute
- Update CreateS3BucketWithObjectLock to set owner when creating bucket
This allows the admin UI to display bucket owners and supports creating/
editing bucket ownership, which is essential for S3 IAM authentication
where non-admin users can only access buckets they own.
* admin: show bucket owner in buckets list and create form
- Add Owner column to buckets table to display bucket ownership
- Add Owner field to create bucket form for setting owner at creation
- Show owner in bucket details modal
- Update JavaScript to include owner when creating buckets
This makes bucket ownership visible and configurable from the admin UI,
which is essential for S3 IAM authentication where non-admin users can
only access buckets they own.
* admin: add bucket owner management with user dropdown
- Add 'Manage Owner' button to bucket actions
- Add modal with dropdown to select owner from existing users
- Fetch users from /api/users endpoint to populate dropdown
- Update create bucket form to use dropdown for owner selection
- Allow setting owner to empty (no owner = admin-only access)
This provides a user-friendly way to manage bucket ownership by selecting
from existing S3 identities rather than manually typing identity names.
* fix: use username instead of name for user dropdown
The /api/users endpoint returns 'username' field, not 'name'.
Fixed both the manage owner modal and create bucket form.
* Update s3_buckets_templ.go
* fix: address code review feedback for s3.bucket.create
- Check if entry.Extended is nil before making a new map to prevent
overwriting any previously set extended attributes
- Use fmt.Fprintln(writer, ...) instead of println() for consistent
output handling across the shell command framework
* fix: improve help text and validate owner input
- Add note that -owner value should match identity name in s3.json
- Trim whitespace from owner and treat whitespace-only as empty
* fix: address code review feedback for list and owner commands
- s3.bucket.list: Use %q to escape owner value and prevent malformed
tabular output from special characters (tabs/newlines/control chars)
- s3.bucket.owner: Use neutral error message for lookup failures since
they can occur for reasons other than missing bucket (e.g., permission)
* fix: improve s3.bucket.owner CLI UX
- Remove confusing -set flag that was required but not shown in examples
- Add explicit -delete flag to remove owner (safer than empty string)
- Presence of -owner now implies set operation (no extra flag needed)
- Validate that -owner and -delete cannot be used together
- Trim whitespace from owner value
- Update help text with correct examples and add note about identity name
- Clearer success messages for each operation
* fix: address code review feedback for admin UI
- GetBucketDetails: Extract and return owner from extended attributes
- CSV export: Fix column indices after adding Owner column, add Owner to header
- XSS prevention: Add escapeHtml() function to sanitize user data in innerHTML
(bucket.name, bucket.owner, bucket.object_lock_mode, obj.key, obj.storage_class)
* fix: address additional code review feedback
- types.go: Add omitempty to Owner JSON tag, update comment
- bucket_management.go: Trim and validate owner (max 256 chars) in CreateBucket
- bucket_management.go: Use neutral error message in SetBucketOwner lookup
* fix: improve owner field handling and error recovery
bucket_management.go:
- Use *string pointer for Owner to detect if field was explicitly provided
- Return HTTP 400 if owner field is missing (use empty string to clear)
- Trim and validate owner (max 256 chars) in UpdateBucketOwner
s3_buckets.templ:
- Re-enable owner select dropdown on fetch error
- Reset dropdown to default 'No owner' option on error
- Allow users to retry or continue without selecting an owner
* fix: move modal instance variables to global scope
Move deleteModalInstance, quotaModalInstance, ownerModalInstance,
detailsModalInstance, and cachedUsers to global scope so they are
accessible from both DOMContentLoaded handlers and global functions
like deleteBucket(). This fixes the undefined variable issue.
* refactor: improve modal handling and avoid global window properties
- Initialize modal instances once on DOMContentLoaded and reuse with show()
- Replace window.currentBucket* global properties with data attributes on forms
- Remove modal dispose/recreate pattern and unnecessary cleanup code
- Scope state to relevant DOM elements instead of global namespace
* Update s3_buckets_templ.go
* fix: define MaxOwnerNameLength constant and implement RFC 4180 CSV escaping
bucket_management.go:
- Add MaxOwnerNameLength constant (256) with documentation
- Replace magic number 256 with constant in both validation checks
s3_buckets.templ:
- Add escapeCsvField() helper for RFC 4180 compliant CSV escaping
- Properly handle commas, double quotes, and newlines in field values
- Escape internal quotes by doubling them (")→("")
* Update s3_buckets_templ.go
* refactor: use direct gRPC client methods for consistency
- command_s3_bucket_create.go: Use client.CreateEntry instead of filer_pb.CreateEntry
- command_s3_bucket_owner.go: Use client.LookupDirectoryEntry instead of filer_pb.LookupEntry
- command_s3_bucket_owner.go: Use client.UpdateEntry instead of filer_pb.UpdateEntry
This aligns with the pattern used in weed/admin/dash/bucket_management.go
pull/7729/head
Chris Lu
4 weeks ago
committed by
GitHub
GitHub
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 723 additions and 177 deletions
-
19weed/admin/dash/admin_server.go
-
112weed/admin/dash/bucket_management.go
-
1weed/admin/dash/types.go
-
2weed/admin/handlers/admin_handlers.go
-
336weed/admin/view/app/s3_buckets.templ
-
236weed/admin/view/app/s3_buckets_templ.go
-
37weed/shell/command_s3_bucket_create.go
-
7weed/shell/command_s3_bucket_list.go
-
150weed/shell/command_s3_bucket_owner.go
236
weed/admin/view/app/s3_buckets_templ.go
File diff suppressed because it is too large
View File
File diff suppressed because it is too large
View File
@ -0,0 +1,150 @@ |
|||
package shell |
|||
|
|||
import ( |
|||
"context" |
|||
"flag" |
|||
"fmt" |
|||
"io" |
|||
"strings" |
|||
|
|||
"github.com/seaweedfs/seaweedfs/weed/pb/filer_pb" |
|||
"github.com/seaweedfs/seaweedfs/weed/s3api/s3_constants" |
|||
"github.com/seaweedfs/seaweedfs/weed/util" |
|||
) |
|||
|
|||
func init() { |
|||
Commands = append(Commands, &commandS3BucketOwner{}) |
|||
} |
|||
|
|||
type commandS3BucketOwner struct { |
|||
} |
|||
|
|||
func (c *commandS3BucketOwner) Name() string { |
|||
return "s3.bucket.owner" |
|||
} |
|||
|
|||
func (c *commandS3BucketOwner) Help() string { |
|||
return `view or change the owner of an S3 bucket |
|||
|
|||
Example: |
|||
# View the current owner of a bucket |
|||
s3.bucket.owner -name <bucket_name> |
|||
|
|||
# Set or change the owner of a bucket |
|||
s3.bucket.owner -name <bucket_name> -owner <identity_name> |
|||
|
|||
# Remove the owner (make bucket admin-only) |
|||
s3.bucket.owner -name <bucket_name> -delete |
|||
|
|||
The owner identity determines which S3 user can access the bucket. |
|||
Non-admin users can only access buckets they own. Admin users can |
|||
access all buckets regardless of ownership. |
|||
|
|||
The -owner value should match the identity name configured in your |
|||
S3 IAM system (the "name" field in s3.json identities configuration). |
|||
` |
|||
} |
|||
|
|||
func (c *commandS3BucketOwner) HasTag(CommandTag) bool { |
|||
return false |
|||
} |
|||
|
|||
func (c *commandS3BucketOwner) Do(args []string, commandEnv *CommandEnv, writer io.Writer) (err error) { |
|||
|
|||
bucketCommand := flag.NewFlagSet(c.Name(), flag.ContinueOnError) |
|||
bucketName := bucketCommand.String("name", "", "bucket name") |
|||
bucketOwner := bucketCommand.String("owner", "", "new bucket owner identity name") |
|||
deleteOwner := bucketCommand.Bool("delete", false, "remove the bucket owner (make admin-only)") |
|||
if err = bucketCommand.Parse(args); err != nil { |
|||
return nil |
|||
} |
|||
|
|||
if *bucketName == "" { |
|||
return fmt.Errorf("empty bucket name") |
|||
} |
|||
|
|||
// Trim whitespace from owner
|
|||
owner := strings.TrimSpace(*bucketOwner) |
|||
|
|||
// Validate flags: can't use both -owner and -delete
|
|||
if owner != "" && *deleteOwner { |
|||
return fmt.Errorf("cannot use both -owner and -delete flags together") |
|||
} |
|||
|
|||
err = commandEnv.WithFilerClient(false, func(client filer_pb.SeaweedFilerClient) error { |
|||
|
|||
resp, err := client.GetFilerConfiguration(context.Background(), &filer_pb.GetFilerConfigurationRequest{}) |
|||
if err != nil { |
|||
return fmt.Errorf("get filer configuration: %w", err) |
|||
} |
|||
filerBucketsPath := resp.DirBuckets |
|||
|
|||
// Look up the bucket entry
|
|||
lookupResp, err := client.LookupDirectoryEntry(context.Background(), &filer_pb.LookupDirectoryEntryRequest{ |
|||
Directory: filerBucketsPath, |
|||
Name: *bucketName, |
|||
}) |
|||
if err != nil { |
|||
return fmt.Errorf("lookup bucket %s: %w", *bucketName, err) |
|||
} |
|||
|
|||
entry := lookupResp.Entry |
|||
|
|||
// If -owner is provided, set the owner
|
|||
if owner != "" { |
|||
if entry.Extended == nil { |
|||
entry.Extended = make(map[string][]byte) |
|||
} |
|||
entry.Extended[s3_constants.AmzIdentityId] = []byte(owner) |
|||
fmt.Fprintf(writer, "Setting owner of bucket %s to: %s\n", *bucketName, owner) |
|||
|
|||
// Update the entry
|
|||
if _, err := client.UpdateEntry(context.Background(), &filer_pb.UpdateEntryRequest{ |
|||
Directory: filerBucketsPath, |
|||
Entry: entry, |
|||
}); err != nil { |
|||
return fmt.Errorf("failed to update bucket: %w", err) |
|||
} |
|||
|
|||
fmt.Fprintf(writer, "Bucket owner updated successfully.\n") |
|||
return nil |
|||
} |
|||
|
|||
// If -delete is provided, remove the owner
|
|||
if *deleteOwner { |
|||
if entry.Extended != nil { |
|||
delete(entry.Extended, s3_constants.AmzIdentityId) |
|||
} |
|||
fmt.Fprintf(writer, "Removing owner from bucket %s\n", *bucketName) |
|||
|
|||
// Update the entry
|
|||
if _, err := client.UpdateEntry(context.Background(), &filer_pb.UpdateEntryRequest{ |
|||
Directory: filerBucketsPath, |
|||
Entry: entry, |
|||
}); err != nil { |
|||
return fmt.Errorf("failed to update bucket: %w", err) |
|||
} |
|||
|
|||
fmt.Fprintf(writer, "Bucket owner removed. Bucket is now admin-only.\n") |
|||
return nil |
|||
} |
|||
|
|||
// Display current owner (no flags provided)
|
|||
fmt.Fprintf(writer, "Bucket: %s\n", *bucketName) |
|||
fmt.Fprintf(writer, "Path: %s\n", util.NewFullPath(filerBucketsPath, *bucketName)) |
|||
|
|||
if entry.Extended != nil { |
|||
if ownerBytes, ok := entry.Extended[s3_constants.AmzIdentityId]; ok && len(ownerBytes) > 0 { |
|||
fmt.Fprintf(writer, "Owner: %s\n", string(ownerBytes)) |
|||
} else { |
|||
fmt.Fprintf(writer, "Owner: (none - admin access only)\n") |
|||
} |
|||
} else { |
|||
fmt.Fprintf(writer, "Owner: (none - admin access only)\n") |
|||
} |
|||
|
|||
return nil |
|||
}) |
|||
|
|||
return err |
|||
} |
|||
Write
Preview
Loading…
Cancel
Save
Reference in new issue