Skip to content

"rsync for cloud storage" - Google Drive, S3, Dropbox, Backblaze B2, One Drive, Swift, Hubic, Wasabi, Google Cloud Storage, Azure Blob, Azure Files, Yandex Files

serve s3: support changing object tags

Nick Craig-Wood76c40ece8598
diff --git a/cmd/serve/s3/backend.go b/cmd/serve/s3/backend.go
index 73b37836e..f29f4f575 100644
--- a/cmd/serve/s3/backend.go
+++ b/cmd/serve/s3/backend.go
@@ -198,6 +198,37 @@ func (t *tenant) storeMeta(_vfs *vfs.VFS, fp string, meta map[string]string) (er
return err
}
+// Check s3Backend satisfies the optional interface
+var _ gofakes3.ObjectTaggingBackend = (*s3Backend)(nil)
+
+// SetObjectTagging sets the tags of an existing object, which are kept
+// with its metadata.
+func (b *s3Backend) SetObjectTagging(ctx context.Context, bucketName, objectName string, tagging string) error {
+ _vfs, err := b.s.getVFS(ctx)
+ if err != nil {
+ return err
+ }
+ fp, err := bucketObjectPath(bucketName, objectName)
+ if err != nil {
+ return err
+ }
+ node, err := _vfs.Stat(fp)
+ if err != nil || !node.IsFile() {
+ return gofakes3.KeyNotFound(objectName)
+ }
+ t := b.tenant(ctx)
+ meta := map[string]string{}
+ if stored, ok := t.getMeta(ctx, fp, node); ok {
+ maps.Copy(meta, stored)
+ }
+ if tagging == "" {
+ delete(meta, gofakes3.TaggingMetadataKey)
+ } else {
+ meta[gofakes3.TaggingMetadataKey] = tagging
+ }
+ return t.storeMeta(_vfs, fp, meta)
+}
+
// removeMeta forgets the metadata of the object at fp.
func (t *tenant) removeMeta(fp string) {
t.meta.Remove(fp)
diff --git a/cmd/serve/s3/backend_test.go b/cmd/serve/s3/backend_test.go
index a81724bdd..60ab12640 100644
--- a/cmd/serve/s3/backend_test.go
+++ b/cmd/serve/s3/backend_test.go
@@ -336,3 +336,34 @@ func TestCopyObjectMetadata(t *testing.T) {
assert.Equal(t, "big", obj.Metadata["X-Amz-Meta-Size"])
assert.NotContains(t, obj.Metadata, "X-Amz-Meta-Colour")
}
+
+// TestSetObjectTagging checks the tags of an object can be changed
+// without changing its other metadata.
+func TestSetObjectTagging(t *testing.T) {
+ b, _ := newTestBackend(t)
+ ctx := context.Background()
+ _, err := b.PutObject(ctx, "bucket", "tagged.txt", map[string]string{"X-Amz-Meta-Colour": "red"}, strings.NewReader("data"), 4)
+ require.NoError(t, err)
+ meta := func() map[string]string {
+ obj, err := b.HeadObject(ctx, "bucket", "tagged.txt")
+ require.NoError(t, err)
+ return obj.Metadata
+ }
+
+ require.NoError(t, b.SetObjectTagging(ctx, "bucket", "tagged.txt", "a=1&b=2"))
+ assert.Equal(t, "a=1&b=2", meta()[gofakes3.TaggingMetadataKey])
+ assert.Equal(t, "red", meta()["X-Amz-Meta-Colour"])
+
+ require.NoError(t, b.SetObjectTagging(ctx, "bucket", "tagged.txt", ""))
+ assert.NotContains(t, meta(), gofakes3.TaggingMetadataKey)
+ assert.Equal(t, "red", meta()["X-Amz-Meta-Colour"])
+
+ // An object without stored metadata can be tagged
+ require.NoError(t, b.SetObjectTagging(ctx, "bucket", "object.txt", "c=3"))
+ obj, err := b.HeadObject(ctx, "bucket", "object.txt")
+ require.NoError(t, err)
+ assert.Equal(t, "c=3", obj.Metadata[gofakes3.TaggingMetadataKey])
+
+ err = b.SetObjectTagging(ctx, "bucket", "missing.txt", "a=1")
+ assert.True(t, gofakes3.HasErrorCode(err, gofakes3.ErrNoSuchKey), "%v", err)
+}
diff --git a/cmd/serve/s3/serve_s3.md b/cmd/serve/s3/serve_s3.md
index a7b5f85f8..529b7d37f 100644
--- a/cmd/serve/s3/serve_s3.md
+++ b/cmd/serve/s3/serve_s3.md
@@ -454,7 +454,8 @@ metadata of at most `--metadata-max-objects` objects (default `100000`,
`0` for no limit) of each user (each access key) is kept; after that
the metadata of the user's least recently used object is forgotten. The metadata of an object is
ignored once the object has been changed some other way, for example
-by another `--auth-proxy` user or directly on the backend.
+by another `--auth-proxy` user or directly on the backend. Object tags
+are kept with the metadata in the same way.
### Object names