mirror of
https://github.com/seaweedfs/seaweedfs.git
synced 2026-07-27 02:23:23 +00:00
* shell: add s3.iam.*, s3.config.show, s3.user.provision; hide legacy commands Add import/export, configuration summary, and a convenience provisioning command: - s3.iam.export: dump full IAM state as JSON (stdout or file) - s3.iam.import: replace IAM state from a JSON file - s3.config.show: human-readable summary (users, policies, service accounts, groups with status and counts) - s3.user.provision: one-step user+policy+credentials creation for common readonly/readwrite/admin roles Hide legacy commands from help listing: - s3.configure: still works but hidden from help output - s3.bucket.access: still works but hidden from help output Both hidden commands remain fully functional for existing scripts. Also adds a Hidden command tag and filters it from printGenericHelp. * shell: address review feedback for s3.iam.*, s3.config.show, s3.user.provision - Simplify joinMax using strings.Join - Fix rolePolicies: remove s3:ListBucket from object-level actions (already covered by bucket-level statement) - Fix admin role: grant s3:* on bucket resource too - Return flag parse errors instead of swallowing them * shell: address missed review feedback for PR 3 - s3.iam.import: require -force flag for destructive IAM overwrite - s3.config.show: add nil guard for resp.Configuration - s3.user.provision: check if user exists before creating policy - s3.user.provision: reject wildcard bucket names (* ?) * shell: distinguish NotFound from transient errors in provision, use %w wrapping - s3.user.provision: check gRPC status code on GetUser error — only proceed on NotFound, abort on transient/network errors - s3.iam.import: use %w for error wrapping to preserve error chains, wrap PutConfiguration error with context * shell: remove duplicate joinMax after PR 8954 merge command_s3_helpers.go defined joinMax which is already in command_s3_user_list.go from the merged PR 8954. * shell: restrict export file permissions, rollback policy on user create failure - s3.iam.export: use os.OpenFile with mode 0600 instead of os.Create to protect exported credentials from other users - s3.user.provision: rollback the created policy if CreateUser fails, with a warning if the rollback itself fails
180 lines
5.1 KiB
Go
180 lines
5.1 KiB
Go
package shell
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"flag"
|
|
"fmt"
|
|
"io"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/seaweedfs/seaweedfs/weed/iam"
|
|
"github.com/seaweedfs/seaweedfs/weed/pb"
|
|
"github.com/seaweedfs/seaweedfs/weed/pb/iam_pb"
|
|
"google.golang.org/grpc"
|
|
"google.golang.org/grpc/codes"
|
|
"google.golang.org/grpc/status"
|
|
)
|
|
|
|
func init() {
|
|
Commands = append(Commands, &commandS3UserProvision{})
|
|
}
|
|
|
|
type commandS3UserProvision struct {
|
|
}
|
|
|
|
func (c *commandS3UserProvision) Name() string {
|
|
return "s3.user.provision"
|
|
}
|
|
|
|
func (c *commandS3UserProvision) Help() string {
|
|
return `create a user with a bucket policy in one step
|
|
|
|
s3.user.provision -name <username> -bucket <bucket_name> -role readwrite
|
|
s3.user.provision -name <username> -bucket <bucket_name> -role readonly
|
|
|
|
Convenience wrapper that performs these steps:
|
|
1. Creates an IAM policy for the bucket and role
|
|
2. Creates the user with auto-generated credentials
|
|
3. Attaches the policy to the user
|
|
|
|
Roles:
|
|
readonly - s3:GetObject, s3:ListBucket
|
|
readwrite - s3:GetObject, s3:PutObject, s3:DeleteObject, s3:ListBucket
|
|
admin - s3:* (full access to the bucket)
|
|
`
|
|
}
|
|
|
|
func (c *commandS3UserProvision) HasTag(CommandTag) bool {
|
|
return false
|
|
}
|
|
|
|
var rolePolicies = map[string][]string{
|
|
"readonly": {"s3:GetObject"},
|
|
"readwrite": {"s3:GetObject", "s3:PutObject", "s3:DeleteObject"},
|
|
"admin": {"s3:*"},
|
|
}
|
|
|
|
func (c *commandS3UserProvision) Do(args []string, commandEnv *CommandEnv, writer io.Writer) error {
|
|
f := flag.NewFlagSet(c.Name(), flag.ContinueOnError)
|
|
name := f.String("name", "", "user name")
|
|
bucket := f.String("bucket", "", "bucket name")
|
|
role := f.String("role", "", "role: readonly, readwrite, or admin")
|
|
if err := f.Parse(args); err != nil {
|
|
return err
|
|
}
|
|
|
|
if *name == "" {
|
|
return fmt.Errorf("-name is required")
|
|
}
|
|
if *bucket == "" {
|
|
return fmt.Errorf("-bucket is required")
|
|
}
|
|
if strings.ContainsAny(*bucket, "*?") {
|
|
return fmt.Errorf("-bucket must be a literal bucket name, not a wildcard pattern")
|
|
}
|
|
if *role == "" {
|
|
return fmt.Errorf("-role is required (readonly, readwrite, admin)")
|
|
}
|
|
|
|
actions, ok := rolePolicies[*role]
|
|
if !ok {
|
|
return fmt.Errorf("unknown role %q: must be readonly, readwrite, or admin", *role)
|
|
}
|
|
|
|
policyName := fmt.Sprintf("%s-%s-%s", *bucket, *name, *role)
|
|
|
|
// Build the policy document
|
|
bucketActions := []string{"s3:ListBucket"}
|
|
if *role == "admin" {
|
|
bucketActions = []string{"s3:*"}
|
|
}
|
|
policyDoc := map[string]interface{}{
|
|
"Version": "2012-10-17",
|
|
"Statement": []map[string]interface{}{
|
|
{
|
|
"Effect": "Allow",
|
|
"Action": actions,
|
|
"Resource": []string{fmt.Sprintf("arn:aws:s3:::%s/*", *bucket)},
|
|
},
|
|
{
|
|
"Effect": "Allow",
|
|
"Action": bucketActions,
|
|
"Resource": []string{fmt.Sprintf("arn:aws:s3:::%s", *bucket)},
|
|
},
|
|
},
|
|
}
|
|
policyJSON, err := json.Marshal(policyDoc)
|
|
if err != nil {
|
|
return fmt.Errorf("marshal policy: %v", err)
|
|
}
|
|
|
|
// Generate credentials
|
|
ak, err := iam.GenerateRandomString(iam.AccessKeyIdLength, iam.CharsetUpper)
|
|
if err != nil {
|
|
return fmt.Errorf("generate access key: %v", err)
|
|
}
|
|
sk, err := iam.GenerateSecretAccessKey()
|
|
if err != nil {
|
|
return fmt.Errorf("generate secret key: %v", err)
|
|
}
|
|
|
|
err = pb.WithGrpcClient(false, 0, func(conn *grpc.ClientConn) error {
|
|
client := iam_pb.NewSeaweedIdentityAccessManagementClient(conn)
|
|
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
|
|
defer cancel()
|
|
|
|
// Step 0: Check if user already exists
|
|
if resp, getErr := client.GetUser(ctx, &iam_pb.GetUserRequest{Username: *name}); getErr == nil && resp.Identity != nil {
|
|
return fmt.Errorf("user %q already exists", *name)
|
|
} else if getErr != nil && status.Code(getErr) != codes.NotFound {
|
|
return fmt.Errorf("check user existence: %w", getErr)
|
|
}
|
|
|
|
// Step 1: Create policy
|
|
_, err := client.PutPolicy(ctx, &iam_pb.PutPolicyRequest{
|
|
Name: policyName,
|
|
Content: string(policyJSON),
|
|
})
|
|
if err != nil {
|
|
return fmt.Errorf("create policy: %v", err)
|
|
}
|
|
fmt.Fprintf(writer, "Created policy %q\n", policyName)
|
|
|
|
// Step 2: Create user
|
|
identity := &iam_pb.Identity{
|
|
Name: *name,
|
|
Credentials: []*iam_pb.Credential{
|
|
{
|
|
AccessKey: ak,
|
|
SecretKey: sk,
|
|
Status: iam.AccessKeyStatusActive,
|
|
},
|
|
},
|
|
PolicyNames: []string{policyName},
|
|
}
|
|
_, err = client.CreateUser(ctx, &iam_pb.CreateUserRequest{Identity: identity})
|
|
if err != nil {
|
|
// Rollback: remove the policy we just created
|
|
if _, delErr := client.DeletePolicy(ctx, &iam_pb.DeletePolicyRequest{Name: policyName}); delErr != nil {
|
|
fmt.Fprintf(writer, "Warning: failed to rollback policy %q: %v\n", policyName, delErr)
|
|
}
|
|
return fmt.Errorf("create user: %w", err)
|
|
}
|
|
fmt.Fprintf(writer, "Created user %q with policy %q attached\n", *name, policyName)
|
|
|
|
return nil
|
|
}, commandEnv.option.FilerAddress.ToGrpcAddress(), false, commandEnv.option.GrpcDialOption)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
fmt.Fprintln(writer)
|
|
fmt.Fprintf(writer, "Access Key: %s\n", ak)
|
|
fmt.Fprintf(writer, "Secret Key: %s\n", sk)
|
|
fmt.Fprintln(writer)
|
|
fmt.Fprintln(writer, "Save these credentials - the secret key cannot be retrieved later.")
|
|
return nil
|
|
}
|