rgw/s3: add ObjectOwnership and OwnershipControls

Signed-off-by: Casey Bodley <[email protected]>

Author: cbodley

src/rgw/CMakeLists.txt

@@ -72,6 +72,7 @@ set(librgw_common_srcs
   rgw_multi_del.cc
   rgw_multipart_meta_filter.cc
   rgw_obj_manifest.cc
+  rgw_object_ownership.cc
   rgw_period.cc
   rgw_realm.cc
   rgw_sync.cc

src/rgw/rgw_object_ownership.cc

@@ -0,0 +1,90 @@
+// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
+// vim: ts=8 sw=2 smarttab ft=cpp
+
+/*
+ * Ceph - scalable distributed file system
+ *
+ * Copyright contributors to the Ceph project
+ *
+ * This is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1, as published by the Free Software
+ * Foundation. See file COPYING.
+ *
+ */
+
+#include "rgw_object_ownership.h"
+#include "rgw_xml.h"
+
+namespace rgw::s3 {
+
+std::string to_string(ObjectOwnership ownership)
+{
+  switch (ownership) {
+    case ObjectOwnership::BucketOwnerEnforced:
+      return "BucketOwnerEnforced";
+    case ObjectOwnership::BucketOwnerPreferred:
+      return "BucketOwnerPreferred";
+    case ObjectOwnership::ObjectWriter:
+      return "ObjectWriter";
+    default:
+      return "invalid";
+  }
+}
+
+bool parse(std::string_view input, ObjectOwnership& ownership,
+           std::string& error_message)
+{
+  if (input == "BucketOwnerEnforced") {
+    ownership = ObjectOwnership::BucketOwnerEnforced;
+    return true;
+  }
+  if (input == "BucketOwnerPreferred") {
+    ownership = ObjectOwnership::BucketOwnerPreferred;
+    return true;
+  }
+  if (input == "ObjectWriter") {
+    ownership = ObjectOwnership::ObjectWriter;
+    return true;
+  }
+  error_message = "ObjectOwnership must be one of "
+      "BucketOwnerEnforced | BucketOwnerPreferred | ObjectWriter";
+  return false;
+}
+
+bool OwnershipControls::decode_xml(XMLObj* xml, std::string& error_message)
+{
+  XMLObj* r = xml->find_first("Rule");
+  if (!r) {
+    error_message = "Missing required element Rule";
+    return false;
+  }
+  XMLObj* o = r->find_first("ObjectOwnership");
+  if (!o) {
+    error_message = "Missing required element ObjectOwnership";
+    return false;
+  }
+  return parse(o->get_data(), object_ownership, error_message);
+}
+
+void OwnershipControls::dump_xml(Formatter *f) const
+{
+  auto rule = Formatter::ObjectSection{*f, "Rule"};
+  encode_xml("ObjectOwnership", to_string(object_ownership), f);
+}
+
+void encode(const OwnershipControls& c, bufferlist& bl, uint64_t f)
+{
+  ENCODE_START(1, 1, bl);
+  encode(c.object_ownership, bl);
+  ENCODE_FINISH(bl);
+}
+
+void decode(OwnershipControls& c, bufferlist::const_iterator& bl)
+{
+  DECODE_START(1, bl);
+  decode(c.object_ownership, bl);
+  DECODE_FINISH(bl);
+}
+
+} // namespace rgw::s3

src/rgw/rgw_object_ownership.h

@@ -0,0 +1,54 @@
+// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
+// vim: ts=8 sw=2 smarttab ft=cpp
+
+/*
+ * Ceph - scalable distributed file system
+ *
+ * Copyright contributors to the Ceph project
+ *
+ * This is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1, as published by the Free Software
+ * Foundation. See file COPYING.
+ *
+ */
+
+#pragma once
+
+#include <cstdint>
+#include <optional>
+#include <string>
+#include "include/encoding.h"
+
+class XMLObj;
+namespace ceph { class Formatter; }
+
+namespace rgw::s3 {
+
+/// S3 Object Ownership configuration
+enum class ObjectOwnership : uint8_t {
+  BucketOwnerEnforced,
+  BucketOwnerPreferred,
+  ObjectWriter,
+};
+
+/// Format ObjectOwnership configuration as a string
+std::string to_string(ObjectOwnership ownership);
+
+/// Parse ObjectOwnership configuration from a string
+bool parse(std::string_view input, ObjectOwnership& ownership,
+           std::string& error_message);
+
+
+/// Ownership controls for a bucket, encoded in RGW_ATTR_OWNERSHIP_CONTROLS.
+struct OwnershipControls {
+  ObjectOwnership object_ownership = ObjectOwnership::ObjectWriter;
+
+  bool decode_xml(XMLObj* xml, std::string& error_message);
+  void dump_xml(ceph::Formatter* f) const;
+};
+
+void encode(const OwnershipControls&, bufferlist&, uint64_t f=0);
+void decode(OwnershipControls&, bufferlist::const_iterator&);
+
+} // namespace rgw::s3