Skip to content

SeaweedFS is a distributed storage system for object storage (S3), file systems, Iceberg table buckets, and Lance vector buckets, designed to handle billions of files with O(1) disk access and effortless horizontal scaling.

2.5 KB
Raw Blame
package shell

import (
	"context"
	"flag"
	"fmt"
	"io"

	"github.com/seaweedfs/seaweedfs/weed/iam"
	"github.com/seaweedfs/seaweedfs/weed/pb/iam_pb"
)

func init() {
	Commands = append(Commands, &commandS3AccessKeyRotate{})
}

type commandS3AccessKeyRotate struct {
}

func (c *commandS3AccessKeyRotate) Name() string {
	return "s3.accesskey.rotate"
}

func (c *commandS3AccessKeyRotate) Help() string {
	return `rotate an access key for an S3 IAM user

	s3.accesskey.rotate -user <username> -access_key <old_key>

	Creates a new credential pair and deletes the old one. There is a brief
	window where both keys are valid.
`
}

func (c *commandS3AccessKeyRotate) HasTag(CommandTag) bool {
	return false
}

func (c *commandS3AccessKeyRotate) Do(args []string, commandEnv *CommandEnv, writer io.Writer) error {
	f := flag.NewFlagSet(c.Name(), flag.ContinueOnError)
	user := f.String("user", "", "user name")
	oldKey := f.String("access_key", "", "access key to rotate")
	if err := f.Parse(args); err != nil {
		return err
	}

	if *user == "" {
		return fmt.Errorf("-user is required")
	}
	if *oldKey == "" {
		return fmt.Errorf("-access_key is required")
	}

	newAK, err := iam.GenerateRandomString(iam.AccessKeyIdLength, iam.CharsetUpper)
	if err != nil {
		return fmt.Errorf("generate access key: %v", err)
	}
	newSK, err := iam.GenerateSecretAccessKey()
	if err != nil {
		return fmt.Errorf("generate secret key: %v", err)
	}

	err = commandEnv.withIamClient(func(ctx context.Context, client iam_pb.SeaweedIdentityAccessManagementClient) error {
		// Create new key first so there's no gap without credentials
		_, err := client.CreateAccessKey(ctx, &iam_pb.CreateAccessKeyRequest{
			Username: *user,
			Credential: &iam_pb.Credential{
				AccessKey: newAK,
				SecretKey: newSK,
				Status:    iam.AccessKeyStatusActive,
			},
		})
		if err != nil {
			return fmt.Errorf("create new key: %v", err)
		}

		// Delete old key
		_, err = client.DeleteAccessKey(ctx, &iam_pb.DeleteAccessKeyRequest{
			Username:  *user,
			AccessKey: *oldKey,
		})
		if err != nil {
			return fmt.Errorf("delete old key (new key %s was already created): %v", newAK, err)
		}

		return nil
	})
	if err != nil {
		return err
	}

	fmt.Fprintf(writer, "Rotated access key for user %q\n", *user)
	fmt.Fprintf(writer, "Old Key:    %s (deleted)\n", *oldKey)
	fmt.Fprintf(writer, "Access Key: %s\n", newAK)
	fmt.Fprintf(writer, "Secret Key: %s\n", newSK)
	fmt.Fprintln(writer)
	fmt.Fprintln(writer, "Save these credentials - the secret key cannot be retrieved later.")
	return nil
}