1 // -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
2 // vim: ts=8 sw=2 smarttab
4 #include <boost/algorithm/string/predicate.hpp>
5 #include <boost/format.hpp>
6 #include <boost/optional.hpp>
7 #include <boost/utility/in_place_factory.hpp>
9 #include "include/assert.h"
12 #include "common/Formatter.h"
13 #include "common/utf8.h"
14 #include "common/ceph_json.h"
16 #include "rgw_rest_swift.h"
17 #include "rgw_acl_swift.h"
18 #include "rgw_cors_swift.h"
19 #include "rgw_formats.h"
20 #include "rgw_client_io.h"
23 #include "rgw_swift_auth.h"
25 #include "rgw_request.h"
26 #include "rgw_process.h"
32 #include <boost/utility/string_ref.hpp>
34 #define dout_context g_ceph_context
35 #define dout_subsys ceph_subsys_rgw
37 int RGWListBuckets_ObjStore_SWIFT::get_params()
39 prefix = s->info.args.get("prefix");
40 marker = s->info.args.get("marker");
41 end_marker = s->info.args.get("end_marker");
42 wants_reversed = s->info.args.exists("reverse");
45 std::swap(marker, end_marker);
48 std::string limit_str = s->info.args.get("limit");
49 if (!limit_str.empty()) {
51 long l = strict_strtol(limit_str.c_str(), 10, &err);
56 if (l > (long)limit_max || l < 0) {
57 return -ERR_PRECONDITION_FAILED;
63 if (s->cct->_conf->rgw_swift_need_stats) {
65 int r = s->info.args.get_bool("stats", &stats, &exists);
81 static void dump_account_metadata(struct req_state * const s,
82 const RGWUsageStats& global_stats,
83 const std::map<std::string, RGWUsageStats> policies_stats,
84 /* const */map<string, bufferlist>& attrs,
85 const RGWQuotaInfo& quota,
86 const RGWAccessControlPolicy_SWIFTAcct &policy)
88 /* Adding X-Timestamp to keep align with Swift API */
89 dump_header(s, "X-Timestamp", ceph_clock_now());
91 dump_header(s, "X-Account-Container-Count", global_stats.buckets_count);
92 dump_header(s, "X-Account-Object-Count", global_stats.objects_count);
93 dump_header(s, "X-Account-Bytes-Used", global_stats.bytes_used);
94 dump_header(s, "X-Account-Bytes-Used-Actual", global_stats.bytes_used_rounded);
96 for (const auto& kv : policies_stats) {
97 const auto& policy_name = camelcase_dash_http_attr(kv.first);
98 const auto& policy_stats = kv.second;
100 dump_header_infixed(s, "X-Account-Storage-Policy-", policy_name,
101 "-Container-Count", policy_stats.buckets_count);
102 dump_header_infixed(s, "X-Account-Storage-Policy-", policy_name,
103 "-Object-Count", policy_stats.objects_count);
104 dump_header_infixed(s, "X-Account-Storage-Policy-", policy_name,
105 "-Bytes-Used", policy_stats.bytes_used);
106 dump_header_infixed(s, "X-Account-Storage-Policy-", policy_name,
107 "-Bytes-Used-Actual", policy_stats.bytes_used_rounded);
110 /* Dump TempURL-related stuff */
111 if (s->perm_mask == RGW_PERM_FULL_CONTROL) {
112 auto iter = s->user->temp_url_keys.find(0);
113 if (iter != std::end(s->user->temp_url_keys) && ! iter->second.empty()) {
114 dump_header(s, "X-Account-Meta-Temp-Url-Key", iter->second);
117 iter = s->user->temp_url_keys.find(1);
118 if (iter != std::end(s->user->temp_url_keys) && ! iter->second.empty()) {
119 dump_header(s, "X-Account-Meta-Temp-Url-Key-2", iter->second);
123 /* Dump quota headers. */
125 if (quota.max_size >= 0) {
126 dump_header(s, "X-Account-Meta-Quota-Bytes", quota.max_size);
129 /* Limit on the number of objects in a given account is a RadosGW's
130 * extension. Swift's account quota WSGI filter doesn't support it. */
131 if (quota.max_objects >= 0) {
132 dump_header(s, "X-Account-Meta-Quota-Count", quota.max_objects);
136 /* Dump user-defined metadata items and generic attrs. */
137 const size_t PREFIX_LEN = sizeof(RGW_ATTR_META_PREFIX) - 1;
138 map<string, bufferlist>::iterator iter;
139 for (iter = attrs.lower_bound(RGW_ATTR_PREFIX); iter != attrs.end(); ++iter) {
140 const char *name = iter->first.c_str();
141 map<string, string>::const_iterator geniter = rgw_to_http_attrs.find(name);
143 if (geniter != rgw_to_http_attrs.end()) {
144 dump_header(s, geniter->second, iter->second);
145 } else if (strncmp(name, RGW_ATTR_META_PREFIX, PREFIX_LEN) == 0) {
146 dump_header_prefixed(s, "X-Account-Meta-",
147 camelcase_dash_http_attr(name + PREFIX_LEN),
152 /* Dump account ACLs */
153 auto account_acls = policy.to_str();
155 dump_header(s, "X-Account-Access-Control", std::move(*account_acls));
159 void RGWListBuckets_ObjStore_SWIFT::send_response_begin(bool has_buckets)
162 set_req_state_err(s, op_ret);
163 } else if (!has_buckets && s->format == RGW_FORMAT_PLAIN) {
164 op_ret = STATUS_NO_CONTENT;
165 set_req_state_err(s, op_ret);
168 if (! s->cct->_conf->rgw_swift_enforce_content_length) {
169 /* Adding account stats in the header to keep align with Swift API */
170 dump_account_metadata(s,
175 static_cast<RGWAccessControlPolicy_SWIFTAcct&>(*s->user_acl));
177 end_header(s, NULL, NULL, NO_CONTENT_LENGTH, true);
182 s->formatter->open_array_section_with_attrs("account",
183 FormatterAttrs("name", s->user->display_name.c_str(), NULL));
189 void RGWListBuckets_ObjStore_SWIFT::handle_listing_chunk(RGWUserBuckets&& buckets)
191 if (wants_reversed) {
192 /* Just store in the reversal buffer. Its content will be handled later,
193 * in send_response_end(). */
194 reverse_buffer.emplace(std::begin(reverse_buffer), std::move(buckets));
196 return send_response_data(buckets);
200 void RGWListBuckets_ObjStore_SWIFT::send_response_data(RGWUserBuckets& buckets)
206 /* Take care of the prefix parameter of Swift API. There is no business
207 * in applying the filter earlier as we really need to go through all
208 * entries regardless of it (the headers like X-Account-Container-Count
209 * aren't affected by specifying prefix). */
210 const std::map<std::string, RGWBucketEnt>& m = buckets.get_buckets();
211 for (auto iter = m.lower_bound(prefix);
212 iter != m.end() && boost::algorithm::starts_with(iter->first, prefix);
214 dump_bucket_entry(iter->second);
218 void RGWListBuckets_ObjStore_SWIFT::dump_bucket_entry(const RGWBucketEnt& obj)
220 s->formatter->open_object_section("container");
221 s->formatter->dump_string("name", obj.bucket.name);
224 s->formatter->dump_int("count", obj.count);
225 s->formatter->dump_int("bytes", obj.size);
228 s->formatter->close_section();
230 if (! s->cct->_conf->rgw_swift_enforce_content_length) {
231 rgw_flush_formatter(s, s->formatter);
235 void RGWListBuckets_ObjStore_SWIFT::send_response_data_reversed(RGWUserBuckets& buckets)
241 /* Take care of the prefix parameter of Swift API. There is no business
242 * in applying the filter earlier as we really need to go through all
243 * entries regardless of it (the headers like X-Account-Container-Count
244 * aren't affected by specifying prefix). */
245 std::map<std::string, RGWBucketEnt>& m = buckets.get_buckets();
247 auto iter = m.rbegin();
248 for (/* initialized above */;
249 iter != m.rend() && !boost::algorithm::starts_with(iter->first, prefix);
254 for (/* iter carried */;
255 iter != m.rend() && boost::algorithm::starts_with(iter->first, prefix);
257 dump_bucket_entry(iter->second);
261 void RGWListBuckets_ObjStore_SWIFT::send_response_end()
263 if (wants_reversed) {
264 for (auto& buckets : reverse_buffer) {
265 send_response_data_reversed(buckets);
270 s->formatter->close_section();
273 if (s->cct->_conf->rgw_swift_enforce_content_length) {
274 /* Adding account stats in the header to keep align with Swift API */
275 dump_account_metadata(s,
280 static_cast<RGWAccessControlPolicy_SWIFTAcct&>(*s->user_acl));
282 end_header(s, nullptr, nullptr, s->formatter->get_len(), true);
285 if (sent_data || s->cct->_conf->rgw_swift_enforce_content_length) {
286 rgw_flush_formatter_and_reset(s, s->formatter);
290 int RGWListBucket_ObjStore_SWIFT::get_params()
292 prefix = s->info.args.get("prefix");
293 marker = s->info.args.get("marker");
294 end_marker = s->info.args.get("end_marker");
295 max_keys = s->info.args.get("limit");
296 op_ret = parse_max_keys();
300 if (max > default_max)
301 return -ERR_PRECONDITION_FAILED;
303 delimiter = s->info.args.get("delimiter");
306 if (s->info.args.exists("path")) { // should handle empty path
307 path_args = s->info.args.get("path");
308 if (!delimiter.empty() || !prefix.empty()) {
315 if (path.size() && path[path.size() - 1] != '/')
318 int len = prefix.size();
319 int delim_size = delimiter.size();
321 if (len >= delim_size) {
322 if (prefix.substr(len - delim_size).compare(delimiter) != 0)
323 prefix.append(delimiter);
330 static void dump_container_metadata(struct req_state *,
333 const RGWBucketWebsiteConf&);
335 void RGWListBucket_ObjStore_SWIFT::send_response()
337 vector<rgw_bucket_dir_entry>::iterator iter = objs.begin();
338 map<string, bool>::iterator pref_iter = common_prefixes.begin();
341 dump_container_metadata(s, bucket, bucket_quota,
342 s->bucket_info.website_conf);
344 s->formatter->open_array_section_with_attrs("container", FormatterAttrs("name", s->bucket.name.c_str(), NULL));
346 while (iter != objs.end() || pref_iter != common_prefixes.end()) {
347 bool do_pref = false;
348 bool do_objs = false;
350 if (iter != objs.end()) {
353 if (pref_iter == common_prefixes.end())
355 else if (iter == objs.end())
357 else if (!key.empty() && key.name.compare(pref_iter->first) == 0) {
360 } else if (!key.empty() && key.name.compare(pref_iter->first) <= 0)
365 if (do_objs && (marker.empty() || marker < key)) {
366 if (key.name.compare(path) == 0)
369 s->formatter->open_object_section("object");
370 s->formatter->dump_string("name", key.name);
371 s->formatter->dump_string("hash", iter->meta.etag);
372 s->formatter->dump_int("bytes", iter->meta.accounted_size);
373 if (!iter->meta.user_data.empty())
374 s->formatter->dump_string("user_custom_data", iter->meta.user_data);
375 string single_content_type = iter->meta.content_type;
376 if (iter->meta.content_type.size()) {
377 // content type might hold multiple values, just dump the last one
378 ssize_t pos = iter->meta.content_type.rfind(',');
381 while (single_content_type[pos] == ' ')
383 single_content_type = single_content_type.substr(pos);
385 s->formatter->dump_string("content_type", single_content_type);
387 dump_time(s, "last_modified", &iter->meta.mtime);
388 s->formatter->close_section();
391 if (do_pref && (marker.empty() || pref_iter->first.compare(marker.name) > 0)) {
392 const string& name = pref_iter->first;
393 if (name.compare(delimiter) == 0)
396 s->formatter->open_object_section_with_attrs("subdir", FormatterAttrs("name", name.c_str(), NULL));
398 /* swift is a bit inconsistent here */
401 s->formatter->dump_string("name", name);
404 s->formatter->dump_string("subdir", name);
406 s->formatter->close_section();
415 s->formatter->close_section();
417 int64_t content_len = 0;
419 content_len = s->formatter->get_len();
420 if (content_len == 0) {
421 op_ret = STATUS_NO_CONTENT;
423 } else if (op_ret > 0) {
427 set_req_state_err(s, op_ret);
429 end_header(s, this, NULL, content_len);
434 rgw_flush_formatter_and_reset(s, s->formatter);
437 static void dump_container_metadata(struct req_state *s,
438 const RGWBucketEnt& bucket,
439 const RGWQuotaInfo& quota,
440 const RGWBucketWebsiteConf& ws_conf)
442 /* Adding X-Timestamp to keep align with Swift API */
443 dump_header(s, "X-Timestamp", utime_t(s->bucket_info.creation_time));
445 dump_header(s, "X-Container-Object-Count", bucket.count);
446 dump_header(s, "X-Container-Bytes-Used", bucket.size);
447 dump_header(s, "X-Container-Bytes-Used-Actual", bucket.size_rounded);
449 if (s->object.empty()) {
450 auto swift_policy = \
451 static_cast<RGWAccessControlPolicy_SWIFT*>(s->bucket_acl.get());
452 std::string read_acl, write_acl;
453 swift_policy->to_str(read_acl, write_acl);
455 if (read_acl.size()) {
456 dump_header(s, "X-Container-Read", read_acl);
458 if (write_acl.size()) {
459 dump_header(s, "X-Container-Write", write_acl);
461 if (!s->bucket_info.placement_rule.empty()) {
462 dump_header(s, "X-Storage-Policy", s->bucket_info.placement_rule);
465 /* Dump user-defined metadata items and generic attrs. */
466 const size_t PREFIX_LEN = sizeof(RGW_ATTR_META_PREFIX) - 1;
467 map<string, bufferlist>::iterator iter;
468 for (iter = s->bucket_attrs.lower_bound(RGW_ATTR_PREFIX);
469 iter != s->bucket_attrs.end();
471 const char *name = iter->first.c_str();
472 map<string, string>::const_iterator geniter = rgw_to_http_attrs.find(name);
474 if (geniter != rgw_to_http_attrs.end()) {
475 dump_header(s, geniter->second, iter->second);
476 } else if (strncmp(name, RGW_ATTR_META_PREFIX, PREFIX_LEN) == 0) {
477 dump_header_prefixed(s, "X-Container-Meta-",
478 camelcase_dash_http_attr(name + PREFIX_LEN),
484 /* Dump container versioning info. */
485 if (! s->bucket_info.swift_ver_location.empty()) {
486 dump_header(s, "X-Versions-Location",
487 url_encode(s->bucket_info.swift_ver_location));
490 /* Dump quota headers. */
492 if (quota.max_size >= 0) {
493 dump_header(s, "X-Container-Meta-Quota-Bytes", quota.max_size);
496 if (quota.max_objects >= 0) {
497 dump_header(s, "X-Container-Meta-Quota-Count", quota.max_objects);
501 /* Dump Static Website headers. */
502 if (! ws_conf.index_doc_suffix.empty()) {
503 dump_header(s, "X-Container-Meta-Web-Index", ws_conf.index_doc_suffix);
506 if (! ws_conf.error_doc.empty()) {
507 dump_header(s, "X-Container-Meta-Web-Error", ws_conf.error_doc);
510 if (! ws_conf.subdir_marker.empty()) {
511 dump_header(s, "X-Container-Meta-Web-Directory-Type",
512 ws_conf.subdir_marker);
515 if (! ws_conf.listing_css_doc.empty()) {
516 dump_header(s, "X-Container-Meta-Web-Listings-CSS",
517 ws_conf.listing_css_doc);
520 if (ws_conf.listing_enabled) {
521 dump_header(s, "X-Container-Meta-Web-Listings", "true");
525 void RGWStatAccount_ObjStore_SWIFT::execute()
527 RGWStatAccount_ObjStore::execute();
528 op_ret = rgw_get_user_attrs_by_uid(store, s->user->user_id, attrs);
531 void RGWStatAccount_ObjStore_SWIFT::send_response()
534 op_ret = STATUS_NO_CONTENT;
535 dump_account_metadata(s,
540 static_cast<RGWAccessControlPolicy_SWIFTAcct&>(*s->user_acl));
543 set_req_state_err(s, op_ret);
546 end_header(s, NULL, NULL, 0, true);
551 void RGWStatBucket_ObjStore_SWIFT::send_response()
554 op_ret = STATUS_NO_CONTENT;
555 dump_container_metadata(s, bucket, bucket_quota,
556 s->bucket_info.website_conf);
559 set_req_state_err(s, op_ret);
562 end_header(s, this, NULL, 0, true);
566 static int get_swift_container_settings(req_state * const s,
567 RGWRados * const store,
568 RGWAccessControlPolicy * const policy,
569 bool * const has_policy,
571 RGWCORSConfiguration * const cors_config,
572 bool * const has_cors)
574 string read_list, write_list;
576 const char * const read_attr = s->info.env->get("HTTP_X_CONTAINER_READ");
578 read_list = read_attr;
580 const char * const write_attr = s->info.env->get("HTTP_X_CONTAINER_WRITE");
582 write_list = write_attr;
587 if (read_attr || write_attr) {
588 RGWAccessControlPolicy_SWIFT swift_policy(s->cct);
589 const auto r = swift_policy.create(store,
591 s->user->display_name,
599 *policy = swift_policy;
605 /*Check and update CORS configuration*/
606 const char *allow_origins = s->info.env->get("HTTP_X_CONTAINER_META_ACCESS_CONTROL_ALLOW_ORIGIN");
607 const char *allow_headers = s->info.env->get("HTTP_X_CONTAINER_META_ACCESS_CONTROL_ALLOW_HEADERS");
608 const char *expose_headers = s->info.env->get("HTTP_X_CONTAINER_META_ACCESS_CONTROL_EXPOSE_HEADERS");
609 const char *max_age = s->info.env->get("HTTP_X_CONTAINER_META_ACCESS_CONTROL_MAX_AGE");
611 RGWCORSConfiguration_SWIFT *swift_cors = new RGWCORSConfiguration_SWIFT;
612 int r = swift_cors->create_update(allow_origins, allow_headers, expose_headers, max_age);
614 dout(0) << "Error creating/updating the cors configuration" << dendl;
619 *cors_config = *swift_cors;
627 #define ACCT_REMOVE_ATTR_PREFIX "HTTP_X_REMOVE_ACCOUNT_META_"
628 #define ACCT_PUT_ATTR_PREFIX "HTTP_X_ACCOUNT_META_"
629 #define CONT_REMOVE_ATTR_PREFIX "HTTP_X_REMOVE_CONTAINER_META_"
630 #define CONT_PUT_ATTR_PREFIX "HTTP_X_CONTAINER_META_"
632 static void get_rmattrs_from_headers(const req_state * const s,
633 const char * const put_prefix,
634 const char * const del_prefix,
635 set<string>& rmattr_names)
637 const size_t put_prefix_len = strlen(put_prefix);
638 const size_t del_prefix_len = strlen(del_prefix);
640 for (const auto& kv : s->info.env->get_map()) {
641 size_t prefix_len = 0;
642 const char * const p = kv.first.c_str();
644 if (strncasecmp(p, del_prefix, del_prefix_len) == 0) {
645 /* Explicitly requested removal. */
646 prefix_len = del_prefix_len;
647 } else if ((strncasecmp(p, put_prefix, put_prefix_len) == 0)
648 && kv.second.empty()) {
649 /* Removal requested by putting an empty value. */
650 prefix_len = put_prefix_len;
653 if (prefix_len > 0) {
654 string name(RGW_ATTR_META_PREFIX);
655 name.append(lowercase_dash_http_attr(p + prefix_len));
656 rmattr_names.insert(name);
661 static int get_swift_versioning_settings(
663 boost::optional<std::string>& swift_ver_location)
665 /* Removing the Swift's versions location has lower priority than setting
666 * a new one. That's the reason why we're handling it first. */
667 const std::string vlocdel =
668 s->info.env->get("HTTP_X_REMOVE_VERSIONS_LOCATION", "");
669 if (vlocdel.size()) {
670 swift_ver_location = boost::in_place(std::string());
673 if (s->info.env->exists("HTTP_X_VERSIONS_LOCATION")) {
674 /* If the Swift's versioning is globally disabled but someone wants to
675 * enable it for a given container, new version of Swift will generate
676 * the precondition failed error. */
677 if (! s->cct->_conf->rgw_swift_versioning_enabled) {
678 return -ERR_PRECONDITION_FAILED;
681 swift_ver_location = s->info.env->get("HTTP_X_VERSIONS_LOCATION", "");
687 int RGWCreateBucket_ObjStore_SWIFT::get_params()
690 uint32_t policy_rw_mask = 0;
692 int r = get_swift_container_settings(s, store, &policy, &has_policy,
693 &policy_rw_mask, &cors_config, &has_cors);
699 policy.create_default(s->user->user_id, s->user->display_name);
702 location_constraint = store->get_zonegroup().api_name;
703 get_rmattrs_from_headers(s, CONT_PUT_ATTR_PREFIX,
704 CONT_REMOVE_ATTR_PREFIX, rmattr_names);
705 placement_rule = s->info.env->get("HTTP_X_STORAGE_POLICY", "");
707 return get_swift_versioning_settings(s, swift_ver_location);
710 static inline int handle_metadata_errors(req_state* const s, const int op_ret)
712 if (op_ret == -EFBIG) {
713 /* Handle the custom error message of exceeding maximum custom attribute
714 * (stored as xattr) size. */
715 const auto error_message = boost::str(
716 boost::format("Metadata value longer than %lld")
717 % s->cct->_conf->get_val<size_t>("rgw_max_attr_size"));
718 set_req_state_err(s, EINVAL, error_message);
720 } else if (op_ret == -E2BIG) {
721 const auto error_message = boost::str(
722 boost::format("Too many metadata items; max %lld")
723 % s->cct->_conf->get_val<size_t>("rgw_max_attrs_num_in_req"));
724 set_req_state_err(s, EINVAL, error_message);
731 void RGWCreateBucket_ObjStore_SWIFT::send_response()
733 const auto meta_ret = handle_metadata_errors(s, op_ret);
734 if (meta_ret != op_ret) {
738 op_ret = STATUS_CREATED;
739 } else if (op_ret == -ERR_BUCKET_EXISTS) {
740 op_ret = STATUS_ACCEPTED;
742 set_req_state_err(s, op_ret);
746 /* Propose ending HTTP header with 0 Content-Length header. */
747 end_header(s, NULL, NULL, 0);
748 rgw_flush_formatter_and_reset(s, s->formatter);
751 void RGWDeleteBucket_ObjStore_SWIFT::send_response()
755 r = STATUS_NO_CONTENT;
757 set_req_state_err(s, r);
759 end_header(s, this, NULL, 0);
760 rgw_flush_formatter_and_reset(s, s->formatter);
763 static int get_delete_at_param(req_state *s, boost::optional<real_time> &delete_at)
765 /* Handle Swift object expiration. */
766 real_time delat_proposal;
767 string x_delete = s->info.env->get("HTTP_X_DELETE_AFTER", "");
769 if (x_delete.empty()) {
770 x_delete = s->info.env->get("HTTP_X_DELETE_AT", "");
772 /* X-Delete-After HTTP is present. It means we need add its value
773 * to the current time. */
774 delat_proposal = real_clock::now();
777 if (x_delete.empty()) {
778 delete_at = boost::none;
779 if (s->info.env->exists("HTTP_X_REMOVE_DELETE_AT")) {
780 delete_at = boost::in_place(real_time());
785 long ts = strict_strtoll(x_delete.c_str(), 10, &err);
791 delat_proposal += make_timespan(ts);
792 if (delat_proposal < real_clock::now()) {
796 delete_at = delat_proposal;
801 int RGWPutObj_ObjStore_SWIFT::verify_permission()
803 op_ret = RGWPutObj_ObjStore::verify_permission();
805 /* We have to differentiate error codes depending on whether user is
806 * anonymous (401 Unauthorized) or he doesn't have necessary permissions
807 * (403 Forbidden). */
808 if (s->auth.identity->is_anonymous() && op_ret == -EACCES) {
815 int RGWPutObj_ObjStore_SWIFT::get_params()
817 if (s->has_bad_meta) {
822 const char *encoding = s->info.env->get("HTTP_TRANSFER_ENCODING");
823 if (!encoding || strcmp(encoding, "chunked") != 0) {
824 ldout(s->cct, 20) << "neither length nor chunked encoding" << dendl;
825 return -ERR_LENGTH_REQUIRED;
828 chunked_upload = true;
831 supplied_etag = s->info.env->get("HTTP_ETAG");
833 if (!s->generic_attrs.count(RGW_ATTR_CONTENT_TYPE)) {
834 ldout(s->cct, 5) << "content type wasn't provided, trying to guess" << dendl;
835 const char *suffix = strrchr(s->object.name.c_str(), '.');
839 string suffix_str(suffix);
840 const char *mime = rgw_find_mime_by_ext(suffix_str);
842 s->generic_attrs[RGW_ATTR_CONTENT_TYPE] = mime;
848 policy.create_default(s->user->user_id, s->user->display_name);
850 int r = get_delete_at_param(s, delete_at);
852 ldout(s->cct, 5) << "ERROR: failed to get Delete-At param" << dendl;
856 if (!s->cct->_conf->rgw_swift_custom_header.empty()) {
857 string custom_header = s->cct->_conf->rgw_swift_custom_header;
858 if (s->info.env->exists(custom_header.c_str())) {
859 user_data = s->info.env->get(custom_header.c_str());
863 dlo_manifest = s->info.env->get("HTTP_X_OBJECT_MANIFEST");
865 string multipart_manifest = s->info.args.get("multipart-manifest", &exists);
867 if (multipart_manifest != "put") {
868 ldout(s->cct, 5) << "invalid multipart-manifest http param: " << multipart_manifest << dendl;
872 #define MAX_SLO_ENTRY_SIZE (1024 + 128) // 1024 - max obj name, 128 - enough extra for other info
873 uint64_t max_len = s->cct->_conf->rgw_max_slo_entries * MAX_SLO_ENTRY_SIZE;
875 slo_info = new RGWSLOInfo;
877 int r = rgw_rest_get_json_input_keep_data(s->cct, s, slo_info->entries, max_len, &slo_info->raw_data, &slo_info->raw_data_len);
879 ldout(s->cct, 5) << "failed to read input for slo r=" << r << dendl;
883 if ((int64_t)slo_info->entries.size() > s->cct->_conf->rgw_max_slo_entries) {
884 ldout(s->cct, 5) << "too many entries in slo request: " << slo_info->entries.size() << dendl;
889 uint64_t total_size = 0;
890 for (const auto& entry : slo_info->entries) {
891 etag_sum.Update((const byte *)entry.etag.c_str(),
892 entry.etag.length());
893 total_size += entry.size_bytes;
895 ldout(s->cct, 20) << "slo_part: " << entry.path
896 << " size=" << entry.size_bytes
897 << " etag=" << entry.etag
900 complete_etag(etag_sum, &lo_etag);
901 slo_info->total_size = total_size;
903 ofs = slo_info->raw_data_len;
906 return RGWPutObj_ObjStore::get_params();
909 void RGWPutObj_ObjStore_SWIFT::send_response()
911 const auto meta_ret = handle_metadata_errors(s, op_ret);
916 op_ret = STATUS_CREATED;
918 set_req_state_err(s, op_ret);
921 if (! lo_etag.empty()) {
922 /* Static Large Object of Swift API has two etags represented by
924 * - etag - for the manifest itself (it will be stored in xattrs),
925 * - lo_etag - for the content composited from SLO's segments.
926 * The value is calculated basing on segments' etags.
927 * In response for PUT request we have to expose the second one.
928 * The first one may be obtained by GET with "multipart-manifest=get"
929 * in query string on a given SLO. */
930 dump_etag(s, lo_etag, true /* quoted */);
935 dump_last_modified(s, mtime);
936 set_req_state_err(s, op_ret);
939 rgw_flush_formatter_and_reset(s, s->formatter);
942 static int get_swift_account_settings(req_state * const s,
943 RGWRados * const store,
944 RGWAccessControlPolicy_SWIFTAcct * const policy,
945 bool * const has_policy)
949 const char * const acl_attr = s->info.env->get("HTTP_X_ACCOUNT_ACCESS_CONTROL");
951 RGWAccessControlPolicy_SWIFTAcct swift_acct_policy(s->cct);
952 const bool r = swift_acct_policy.create(store,
954 s->user->display_name,
960 *policy = swift_acct_policy;
967 int RGWPutMetadataAccount_ObjStore_SWIFT::get_params()
969 if (s->has_bad_meta) {
973 int ret = get_swift_account_settings(s,
975 // FIXME: we need to carry unique_ptr in generic class
976 // and allocate appropriate ACL class in the ctor
977 static_cast<RGWAccessControlPolicy_SWIFTAcct *>(&policy),
983 get_rmattrs_from_headers(s, ACCT_PUT_ATTR_PREFIX, ACCT_REMOVE_ATTR_PREFIX,
988 void RGWPutMetadataAccount_ObjStore_SWIFT::send_response()
990 const auto meta_ret = handle_metadata_errors(s, op_ret);
991 if (meta_ret != op_ret) {
995 op_ret = STATUS_NO_CONTENT;
997 set_req_state_err(s, op_ret);
1001 end_header(s, this);
1002 rgw_flush_formatter_and_reset(s, s->formatter);
1005 int RGWPutMetadataBucket_ObjStore_SWIFT::get_params()
1007 if (s->has_bad_meta) {
1011 int r = get_swift_container_settings(s, store, &policy, &has_policy,
1012 &policy_rw_mask, &cors_config, &has_cors);
1017 get_rmattrs_from_headers(s, CONT_PUT_ATTR_PREFIX, CONT_REMOVE_ATTR_PREFIX,
1019 placement_rule = s->info.env->get("HTTP_X_STORAGE_POLICY", "");
1021 return get_swift_versioning_settings(s, swift_ver_location);
1024 void RGWPutMetadataBucket_ObjStore_SWIFT::send_response()
1026 const auto meta_ret = handle_metadata_errors(s, op_ret);
1027 if (meta_ret != op_ret) {
1030 if (!op_ret && (op_ret != -EINVAL)) {
1031 op_ret = STATUS_NO_CONTENT;
1033 set_req_state_err(s, op_ret);
1037 end_header(s, this);
1038 rgw_flush_formatter_and_reset(s, s->formatter);
1041 int RGWPutMetadataObject_ObjStore_SWIFT::get_params()
1043 if (s->has_bad_meta) {
1047 /* Handle Swift object expiration. */
1048 int r = get_delete_at_param(s, delete_at);
1050 ldout(s->cct, 5) << "ERROR: failed to get Delete-At param" << dendl;
1054 placement_rule = s->info.env->get("HTTP_X_STORAGE_POLICY", "");
1055 dlo_manifest = s->info.env->get("HTTP_X_OBJECT_MANIFEST");
1060 void RGWPutMetadataObject_ObjStore_SWIFT::send_response()
1062 const auto meta_ret = handle_metadata_errors(s, op_ret);
1063 if (meta_ret != op_ret) {
1067 op_ret = STATUS_ACCEPTED;
1069 set_req_state_err(s, op_ret);
1073 dump_content_length(s, 0);
1077 end_header(s, this);
1078 rgw_flush_formatter_and_reset(s, s->formatter);
1081 static void bulkdelete_respond(const unsigned num_deleted,
1082 const unsigned int num_unfound,
1083 const std::list<RGWBulkDelete::fail_desc_t>& failures,
1084 const int prot_flags, /* in */
1085 ceph::Formatter& formatter) /* out */
1087 formatter.open_object_section("delete");
1092 if (!failures.empty()) {
1093 int reason = ERR_INVALID_REQUEST;
1094 for (const auto fail_desc : failures) {
1095 if (-ENOENT != fail_desc.err && -EACCES != fail_desc.err) {
1096 reason = fail_desc.err;
1100 set_req_state_err(err, reason, prot_flags);
1101 dump_errno(err, resp_status);
1102 } else if (0 == num_deleted && 0 == num_unfound) {
1103 /* 400 Bad Request */
1104 dump_errno(400, resp_status);
1105 resp_body = "Invalid bulk delete.";
1108 dump_errno(200, resp_status);
1111 encode_json("Number Deleted", num_deleted, &formatter);
1112 encode_json("Number Not Found", num_unfound, &formatter);
1113 encode_json("Response Body", resp_body, &formatter);
1114 encode_json("Response Status", resp_status, &formatter);
1116 formatter.open_array_section("Errors");
1117 for (const auto fail_desc : failures) {
1118 formatter.open_array_section("object");
1120 stringstream ss_name;
1121 ss_name << fail_desc.path;
1122 encode_json("Name", ss_name.str(), &formatter);
1125 set_req_state_err(err, fail_desc.err, prot_flags);
1127 dump_errno(err, status);
1128 encode_json("Status", status, &formatter);
1129 formatter.close_section();
1131 formatter.close_section();
1133 formatter.close_section();
1136 int RGWDeleteObj_ObjStore_SWIFT::verify_permission()
1138 op_ret = RGWDeleteObj_ObjStore::verify_permission();
1140 /* We have to differentiate error codes depending on whether user is
1141 * anonymous (401 Unauthorized) or he doesn't have necessary permissions
1142 * (403 Forbidden). */
1143 if (s->auth.identity->is_anonymous() && op_ret == -EACCES) {
1150 int RGWDeleteObj_ObjStore_SWIFT::get_params()
1152 const string& mm = s->info.args.get("multipart-manifest");
1153 multipart_delete = (mm.compare("delete") == 0);
1155 return RGWDeleteObj_ObjStore::get_params();
1158 void RGWDeleteObj_ObjStore_SWIFT::send_response()
1162 if (multipart_delete) {
1165 r = STATUS_NO_CONTENT;
1168 set_req_state_err(s, r);
1171 if (multipart_delete) {
1172 end_header(s, this /* RGWOp */, nullptr /* contype */,
1173 CHUNKED_TRANSFER_ENCODING);
1176 bulkdelete_respond(deleter->get_num_deleted(),
1177 deleter->get_num_unfound(),
1178 deleter->get_failures(),
1181 } else if (-ENOENT == op_ret) {
1182 bulkdelete_respond(0, 1, {}, s->prot_flags, *s->formatter);
1184 RGWBulkDelete::acct_path_t path;
1185 path.bucket_name = s->bucket_name;
1186 path.obj_key = s->object;
1188 RGWBulkDelete::fail_desc_t fail_desc;
1189 fail_desc.err = op_ret;
1190 fail_desc.path = path;
1192 bulkdelete_respond(0, 0, { fail_desc }, s->prot_flags, *s->formatter);
1195 end_header(s, this);
1198 rgw_flush_formatter_and_reset(s, s->formatter);
1202 static void get_contype_from_attrs(map<string, bufferlist>& attrs,
1203 string& content_type)
1205 map<string, bufferlist>::iterator iter = attrs.find(RGW_ATTR_CONTENT_TYPE);
1206 if (iter != attrs.end()) {
1207 content_type = iter->second.c_str();
1211 static void dump_object_metadata(struct req_state * const s,
1212 map<string, bufferlist> attrs)
1214 map<string, string> response_attrs;
1216 for (auto kv : attrs) {
1217 const char * name = kv.first.c_str();
1218 const auto aiter = rgw_to_http_attrs.find(name);
1220 if (aiter != std::end(rgw_to_http_attrs)) {
1221 response_attrs[aiter->second] = kv.second.c_str();
1222 } else if (strcmp(name, RGW_ATTR_SLO_UINDICATOR) == 0) {
1223 // this attr has an extra length prefix from ::encode() in prior versions
1224 dump_header(s, "X-Object-Meta-Static-Large-Object", "True");
1225 } else if (strncmp(name, RGW_ATTR_META_PREFIX,
1226 sizeof(RGW_ATTR_META_PREFIX)-1) == 0) {
1227 name += sizeof(RGW_ATTR_META_PREFIX) - 1;
1228 dump_header_prefixed(s, "X-Object-Meta-",
1229 camelcase_dash_http_attr(name), kv.second);
1233 /* Handle override and fallback for Content-Disposition HTTP header.
1234 * At the moment this will be used only by TempURL of the Swift API. */
1235 const auto cditer = rgw_to_http_attrs.find(RGW_ATTR_CONTENT_DISP);
1236 if (cditer != std::end(rgw_to_http_attrs)) {
1237 const auto& name = cditer->second;
1239 if (!s->content_disp.override.empty()) {
1240 response_attrs[name] = s->content_disp.override;
1241 } else if (!s->content_disp.fallback.empty()
1242 && response_attrs.find(name) == std::end(response_attrs)) {
1243 response_attrs[name] = s->content_disp.fallback;
1247 for (const auto kv : response_attrs) {
1248 dump_header(s, kv.first, kv.second);
1251 const auto iter = attrs.find(RGW_ATTR_DELETE_AT);
1252 if (iter != std::end(attrs)) {
1255 ::decode(delete_at, iter->second);
1256 if (!delete_at.is_zero()) {
1257 dump_header(s, "X-Delete-At", delete_at.sec());
1259 } catch (buffer::error& err) {
1260 ldout(s->cct, 0) << "ERROR: cannot decode object's " RGW_ATTR_DELETE_AT
1267 int RGWCopyObj_ObjStore_SWIFT::init_dest_policy()
1269 dest_policy.create_default(s->user->user_id, s->user->display_name);
1274 int RGWCopyObj_ObjStore_SWIFT::get_params()
1276 if_mod = s->info.env->get("HTTP_IF_MODIFIED_SINCE");
1277 if_unmod = s->info.env->get("HTTP_IF_UNMODIFIED_SINCE");
1278 if_match = s->info.env->get("HTTP_COPY_IF_MATCH");
1279 if_nomatch = s->info.env->get("HTTP_COPY_IF_NONE_MATCH");
1281 src_tenant_name = s->src_tenant_name;
1282 src_bucket_name = s->src_bucket_name;
1283 src_object = s->src_object;
1284 dest_tenant_name = s->bucket_tenant;
1285 dest_bucket_name = s->bucket_name;
1286 dest_object = s->object.name;
1288 const char * const fresh_meta = s->info.env->get("HTTP_X_FRESH_METADATA");
1289 if (fresh_meta && strcasecmp(fresh_meta, "TRUE") == 0) {
1290 attrs_mod = RGWRados::ATTRSMOD_REPLACE;
1292 attrs_mod = RGWRados::ATTRSMOD_MERGE;
1295 int r = get_delete_at_param(s, delete_at);
1297 ldout(s->cct, 5) << "ERROR: failed to get Delete-At param" << dendl;
1304 void RGWCopyObj_ObjStore_SWIFT::send_partial_response(off_t ofs)
1306 if (! sent_header) {
1308 op_ret = STATUS_CREATED;
1309 set_req_state_err(s, op_ret);
1311 end_header(s, this);
1313 /* Send progress information. Note that this diverge from the original swift
1314 * spec. We do this in order to keep connection alive.
1317 s->formatter->open_array_section("progress");
1321 s->formatter->dump_int("ofs", (uint64_t)ofs);
1323 rgw_flush_formatter(s, s->formatter);
1326 void RGWCopyObj_ObjStore_SWIFT::dump_copy_info()
1328 /* Dump X-Copied-From. */
1329 dump_header(s, "X-Copied-From", url_encode(src_bucket.name) +
1330 "/" + url_encode(src_object.name));
1332 /* Dump X-Copied-From-Account. */
1334 dump_header(s, "X-Copied-From-Account", url_encode(s->user->user_id.id));
1336 /* Dump X-Copied-From-Last-Modified. */
1337 dump_time_header(s, "X-Copied-From-Last-Modified", src_mtime);
1340 void RGWCopyObj_ObjStore_SWIFT::send_response()
1342 if (! sent_header) {
1343 string content_type;
1345 op_ret = STATUS_CREATED;
1346 set_req_state_err(s, op_ret);
1349 dump_last_modified(s, mtime);
1351 get_contype_from_attrs(attrs, content_type);
1352 dump_object_metadata(s, attrs);
1353 end_header(s, this, !content_type.empty() ? content_type.c_str()
1354 : "binary/octet-stream");
1356 s->formatter->close_section();
1357 rgw_flush_formatter(s, s->formatter);
1361 int RGWGetObj_ObjStore_SWIFT::verify_permission()
1363 op_ret = RGWGetObj_ObjStore::verify_permission();
1365 /* We have to differentiate error codes depending on whether user is
1366 * anonymous (401 Unauthorized) or he doesn't have necessary permissions
1367 * (403 Forbidden). */
1368 if (s->auth.identity->is_anonymous() && op_ret == -EACCES) {
1375 int RGWGetObj_ObjStore_SWIFT::get_params()
1377 const string& mm = s->info.args.get("multipart-manifest");
1378 skip_manifest = (mm.compare("get") == 0);
1380 return RGWGetObj_ObjStore::get_params();
1383 int RGWGetObj_ObjStore_SWIFT::send_response_data_error()
1385 std::string error_content;
1386 op_ret = error_handler(op_ret, &error_content);
1388 /* The error handler has taken care of the error. */
1392 bufferlist error_bl;
1393 error_bl.append(error_content);
1394 return send_response_data(error_bl, 0, error_bl.length());
1397 int RGWGetObj_ObjStore_SWIFT::send_response_data(bufferlist& bl,
1401 string content_type;
1407 if (custom_http_ret) {
1408 set_req_state_err(s, 0);
1409 dump_errno(s, custom_http_ret);
1411 set_req_state_err(s, (partial_content && !op_ret) ? STATUS_PARTIAL_CONTENT
1416 end_header(s, NULL);
1422 dump_range(s, ofs, end, s->obj_size);
1426 end_header(s, NULL);
1430 dump_content_length(s, total_len);
1431 dump_last_modified(s, lastmod);
1432 dump_header(s, "X-Timestamp", utime_t(lastmod));
1434 dump_header(s, "X-Static-Large-Object", "True");
1438 if (! lo_etag.empty()) {
1439 dump_etag(s, lo_etag, true /* quoted */);
1441 auto iter = attrs.find(RGW_ATTR_ETAG);
1442 if (iter != attrs.end()) {
1443 dump_etag(s, iter->second);
1447 get_contype_from_attrs(attrs, content_type);
1448 dump_object_metadata(s, attrs);
1451 end_header(s, this, !content_type.empty() ? content_type.c_str()
1452 : "binary/octet-stream");
1457 if (get_data && !op_ret) {
1458 const auto r = dump_body(s, bl.c_str() + bl_ofs, bl_len);
1463 rgw_flush_formatter_and_reset(s, s->formatter);
1468 void RGWOptionsCORS_ObjStore_SWIFT::send_response()
1470 string hdrs, exp_hdrs;
1471 uint32_t max_age = CORS_MAX_AGE_INVALID;
1472 /*EACCES means, there is no CORS registered yet for the bucket
1473 *ENOENT means, there is no match of the Origin in the list of CORSRule
1475 if (op_ret == -ENOENT)
1478 set_req_state_err(s, op_ret);
1480 end_header(s, NULL);
1483 get_response_params(hdrs, exp_hdrs, &max_age);
1485 dump_access_control(s, origin, req_meth, hdrs.c_str(), exp_hdrs.c_str(),
1487 end_header(s, NULL);
1490 int RGWBulkDelete_ObjStore_SWIFT::get_data(
1491 list<RGWBulkDelete::acct_path_t>& items, bool * const is_truncated)
1493 constexpr size_t MAX_LINE_SIZE = 2048;
1495 RGWClientIOStreamBuf ciosb(static_cast<RGWRestfulIO&>(*(s->cio)),
1496 size_t(s->cct->_conf->rgw_max_chunk_size));
1497 istream cioin(&ciosb);
1499 char buf[MAX_LINE_SIZE];
1500 while (cioin.getline(buf, sizeof(buf))) {
1501 string path_str(buf);
1503 ldout(s->cct, 20) << "extracted Bulk Delete entry: " << path_str << dendl;
1505 RGWBulkDelete::acct_path_t path;
1507 /* We need to skip all slashes at the beginning in order to preserve
1508 * compliance with Swift. */
1509 const size_t start_pos = path_str.find_first_not_of('/');
1511 if (string::npos != start_pos) {
1512 /* Seperator is the first slash after the leading ones. */
1513 const size_t sep_pos = path_str.find('/', start_pos);
1515 if (string::npos != sep_pos) {
1516 path.bucket_name = url_decode(path_str.substr(start_pos,
1517 sep_pos - start_pos));
1518 path.obj_key = url_decode(path_str.substr(sep_pos + 1));
1520 /* It's guaranteed here that bucket name is at least one character
1521 * long and is different than slash. */
1522 path.bucket_name = url_decode(path_str.substr(start_pos));
1525 items.push_back(path);
1528 if (items.size() == MAX_CHUNK_ENTRIES) {
1529 *is_truncated = true;
1534 *is_truncated = false;
1538 void RGWBulkDelete_ObjStore_SWIFT::send_response()
1540 set_req_state_err(s, op_ret);
1542 end_header(s, this /* RGWOp */, nullptr /* contype */,
1543 CHUNKED_TRANSFER_ENCODING);
1545 bulkdelete_respond(deleter->get_num_deleted(),
1546 deleter->get_num_unfound(),
1547 deleter->get_failures(),
1550 rgw_flush_formatter_and_reset(s, s->formatter);
1554 std::unique_ptr<RGWBulkUploadOp::StreamGetter>
1555 RGWBulkUploadOp_ObjStore_SWIFT::create_stream()
1557 class SwiftStreamGetter : public StreamGetter {
1558 const size_t conlen;
1563 SwiftStreamGetter(req_state* const s, const size_t conlen)
1569 ssize_t get_at_most(size_t want, ceph::bufferlist& dst) override {
1570 /* maximum requested by a caller */
1571 /* data provided by client */
1572 /* RadosGW's limit. */
1573 const size_t max_chunk_size = \
1574 static_cast<size_t>(s->cct->_conf->rgw_max_chunk_size);
1575 const size_t max_to_read = std::min({ want, conlen - curpos, max_chunk_size });
1577 ldout(s->cct, 20) << "bulk_upload: get_at_most max_to_read="
1579 << ", dst.c_str()=" << reinterpret_cast<intptr_t>(dst.c_str()) << dendl;
1581 bufferptr bp(max_to_read);
1582 const auto read_len = recv_body(s, bp.c_str(), max_to_read);
1583 dst.append(bp, 0, read_len);
1584 //const auto read_len = recv_body(s, dst.c_str(), max_to_read);
1590 return curpos > s->cct->_conf->rgw_max_put_size ? -ERR_TOO_LARGE
1594 ssize_t get_exactly(size_t want, ceph::bufferlist& dst) override {
1595 ldout(s->cct, 20) << "bulk_upload: get_exactly want=" << want << dendl;
1597 /* FIXME: do this in a loop. */
1598 const auto ret = get_at_most(want, dst);
1599 ldout(s->cct, 20) << "bulk_upload: get_exactly ret=" << ret << dendl;
1602 } else if (static_cast<size_t>(ret) != want) {
1614 ldout(s->cct, 20) << "bulk upload: create_stream for length="
1615 << s->length << dendl;
1617 const size_t conlen = atoll(s->length);
1618 return std::unique_ptr<SwiftStreamGetter>(new SwiftStreamGetter(s, conlen));
1622 void RGWBulkUploadOp_ObjStore_SWIFT::send_response()
1624 set_req_state_err(s, op_ret);
1626 end_header(s, this /* RGWOp */, nullptr /* contype */,
1627 CHUNKED_TRANSFER_ENCODING);
1628 rgw_flush_formatter_and_reset(s, s->formatter);
1630 s->formatter->open_object_section("delete");
1632 std::string resp_status;
1633 std::string resp_body;
1635 if (! failures.empty()) {
1638 const auto last_err = { failures.back().err };
1639 if (boost::algorithm::contains(last_err, terminal_errors)) {
1640 /* The terminal errors are affecting the status of the whole upload. */
1641 set_req_state_err(err, failures.back().err, s->prot_flags);
1643 set_req_state_err(err, ERR_INVALID_REQUEST, s->prot_flags);
1646 dump_errno(err, resp_status);
1647 } else if (0 == num_created && failures.empty()) {
1648 /* Nothing created, nothing failed. This means the archive contained no
1649 * entity we could understand (regular file or directory). We need to
1650 * send 400 Bad Request to an HTTP client in the internal status field. */
1651 dump_errno(400, resp_status);
1652 resp_body = "Invalid Tar File: No Valid Files";
1655 dump_errno(201, resp_status);
1658 encode_json("Number Files Created", num_created, s->formatter);
1659 encode_json("Response Body", resp_body, s->formatter);
1660 encode_json("Response Status", resp_status, s->formatter);
1662 s->formatter->open_array_section("Errors");
1663 for (const auto& fail_desc : failures) {
1664 s->formatter->open_array_section("object");
1666 encode_json("Name", fail_desc.path, s->formatter);
1669 set_req_state_err(err, fail_desc.err, s->prot_flags);
1671 dump_errno(err, status);
1672 encode_json("Status", status, s->formatter);
1674 s->formatter->close_section();
1676 s->formatter->close_section();
1678 s->formatter->close_section();
1679 rgw_flush_formatter_and_reset(s, s->formatter);
1683 void RGWGetCrossDomainPolicy_ObjStore_SWIFT::send_response()
1685 set_req_state_err(s, op_ret);
1687 end_header(s, this, "application/xml");
1689 std::stringstream ss;
1691 ss << R"(<?xml version="1.0"?>)" << "\n"
1692 << R"(<!DOCTYPE cross-domain-policy SYSTEM )"
1693 << R"("http://www.adobe.com/xml/dtds/cross-domain-policy.dtd" >)" << "\n"
1694 << R"(<cross-domain-policy>)" << "\n"
1695 << g_conf->rgw_cross_domain_policy << "\n"
1696 << R"(</cross-domain-policy>)";
1698 dump_body(s, ss.str());
1701 void RGWGetHealthCheck_ObjStore_SWIFT::send_response()
1703 set_req_state_err(s, op_ret);
1705 end_header(s, this, "application/xml");
1708 static constexpr char DISABLED[] = "DISABLED BY FILE";
1709 dump_body(s, DISABLED, strlen(DISABLED));
1713 const vector<pair<string, RGWInfo_ObjStore_SWIFT::info>> RGWInfo_ObjStore_SWIFT::swift_info =
1715 {"bulk_delete", {false, nullptr}},
1716 {"container_quotas", {false, nullptr}},
1717 {"swift", {false, RGWInfo_ObjStore_SWIFT::list_swift_data}},
1718 {"tempurl", { false, RGWInfo_ObjStore_SWIFT::list_tempurl_data}},
1719 {"slo", {false, RGWInfo_ObjStore_SWIFT::list_slo_data}},
1720 {"account_quotas", {false, nullptr}},
1721 {"staticweb", {false, nullptr}},
1722 {"tempauth", {false, RGWInfo_ObjStore_SWIFT::list_tempauth_data}},
1725 void RGWInfo_ObjStore_SWIFT::execute()
1727 bool is_admin_info_enabled = false;
1729 const string& swiftinfo_sig = s->info.args.get("swiftinfo_sig");
1730 const string& swiftinfo_expires = s->info.args.get("swiftinfo_expires");
1732 if (!swiftinfo_sig.empty() &&
1733 !swiftinfo_expires.empty() &&
1734 !is_expired(swiftinfo_expires, s->cct)) {
1735 is_admin_info_enabled = true;
1738 s->formatter->open_object_section("info");
1740 for (const auto& pair : swift_info) {
1741 if(!is_admin_info_enabled && pair.second.is_admin_info)
1744 if (!pair.second.list_data) {
1745 s->formatter->open_object_section((pair.first).c_str());
1746 s->formatter->close_section();
1749 pair.second.list_data(*(s->formatter), *(s->cct->_conf), *store);
1753 s->formatter->close_section();
1756 void RGWInfo_ObjStore_SWIFT::send_response()
1759 op_ret = STATUS_NO_CONTENT;
1761 set_req_state_err(s, op_ret);
1763 end_header(s, this);
1764 rgw_flush_formatter_and_reset(s, s->formatter);
1767 void RGWInfo_ObjStore_SWIFT::list_swift_data(Formatter& formatter,
1768 const md_config_t& config,
1771 formatter.open_object_section("swift");
1772 formatter.dump_int("max_file_size", config.rgw_max_put_size);
1773 formatter.dump_int("container_listing_limit", RGW_LIST_BUCKETS_LIMIT_MAX);
1775 string ceph_version(CEPH_GIT_NICE_VER);
1776 formatter.dump_string("version", ceph_version);
1778 const size_t max_attr_name_len = \
1779 g_conf->get_val<size_t>("rgw_max_attr_name_len");
1780 if (max_attr_name_len) {
1781 const size_t meta_name_limit = \
1782 max_attr_name_len - strlen(RGW_ATTR_PREFIX RGW_AMZ_META_PREFIX);
1783 formatter.dump_int("max_meta_name_length", meta_name_limit);
1786 const size_t meta_value_limit = g_conf->get_val<size_t>("rgw_max_attr_size");
1787 if (meta_value_limit) {
1788 formatter.dump_int("max_meta_value_length", meta_value_limit);
1791 const size_t meta_num_limit = \
1792 g_conf->get_val<size_t>("rgw_max_attrs_num_in_req");
1793 if (meta_num_limit) {
1794 formatter.dump_int("max_meta_count", meta_num_limit);
1797 formatter.open_array_section("policies");
1798 RGWZoneGroup& zonegroup = store.get_zonegroup();
1800 for (const auto& placement_targets : zonegroup.placement_targets) {
1801 formatter.open_object_section("policy");
1802 if (placement_targets.second.name.compare(zonegroup.default_placement) == 0)
1803 formatter.dump_bool("default", true);
1804 formatter.dump_string("name", placement_targets.second.name.c_str());
1805 formatter.close_section();
1807 formatter.close_section();
1809 formatter.dump_int("max_object_name_size", RGWHandler_REST::MAX_OBJ_NAME_LEN);
1810 formatter.dump_bool("strict_cors_mode", true);
1811 formatter.dump_int("max_container_name_length", RGWHandler_REST::MAX_BUCKET_NAME_LEN);
1812 formatter.close_section();
1815 void RGWInfo_ObjStore_SWIFT::list_tempauth_data(Formatter& formatter,
1816 const md_config_t& config,
1819 formatter.open_object_section("tempauth");
1820 formatter.dump_bool("account_acls", true);
1821 formatter.close_section();
1823 void RGWInfo_ObjStore_SWIFT::list_tempurl_data(Formatter& formatter,
1824 const md_config_t& config,
1827 formatter.open_object_section("tempurl");
1828 formatter.open_array_section("methods");
1829 formatter.dump_string("methodname", "GET");
1830 formatter.dump_string("methodname", "HEAD");
1831 formatter.dump_string("methodname", "PUT");
1832 formatter.dump_string("methodname", "POST");
1833 formatter.dump_string("methodname", "DELETE");
1834 formatter.close_section();
1835 formatter.close_section();
1838 void RGWInfo_ObjStore_SWIFT::list_slo_data(Formatter& formatter,
1839 const md_config_t& config,
1842 formatter.open_object_section("slo");
1843 formatter.dump_int("max_manifest_segments", config.rgw_max_slo_entries);
1844 formatter.close_section();
1847 bool RGWInfo_ObjStore_SWIFT::is_expired(const std::string& expires, CephContext* cct)
1850 const utime_t now = ceph_clock_now();
1851 const uint64_t expiration = (uint64_t)strict_strtoll(expires.c_str(),
1854 ldout(cct, 5) << "failed to parse siginfo_expires: " << err << dendl;
1858 if (expiration <= (uint64_t)now.sec()) {
1859 ldout(cct, 5) << "siginfo expired: " << expiration << " <= " << now.sec() << dendl;
1867 void RGWFormPost::init(RGWRados* const store,
1869 RGWHandler* const dialect_handler)
1871 prefix = std::move(s->object.name);
1872 s->object = rgw_obj_key();
1874 return RGWPostObj_ObjStore::init(store, s, dialect_handler);
1877 std::size_t RGWFormPost::get_max_file_size() /*const*/
1879 std::string max_str = get_part_str(ctrl_parts, "max_file_size", "0");
1882 const std::size_t max_file_size =
1883 static_cast<uint64_t>(strict_strtoll(max_str.c_str(), 10, &err));
1885 if (! err.empty()) {
1886 ldout(s->cct, 5) << "failed to parse FormPost's max_file_size: " << err
1891 return max_file_size;
1894 bool RGWFormPost::is_non_expired()
1896 std::string expires = get_part_str(ctrl_parts, "expires", "0");
1899 const uint64_t expires_timestamp =
1900 static_cast<uint64_t>(strict_strtoll(expires.c_str(), 10, &err));
1902 if (! err.empty()) {
1903 dout(5) << "failed to parse FormPost's expires: " << err << dendl;
1907 const utime_t now = ceph_clock_now();
1908 if (expires_timestamp <= static_cast<uint64_t>(now.sec())) {
1909 dout(5) << "FormPost form expired: "
1910 << expires_timestamp << " <= " << now.sec() << dendl;
1917 bool RGWFormPost::is_integral()
1919 const std::string form_signature = get_part_str(ctrl_parts, "signature");
1922 get_owner_info(s, *s->user);
1923 s->auth.identity = rgw::auth::transform_old_authinfo(s);
1925 ldout(s->cct, 5) << "cannot get user_info of account's owner" << dendl;
1929 for (const auto& kv : s->user->temp_url_keys) {
1930 const int temp_url_key_num = kv.first;
1931 const string& temp_url_key = kv.second;
1933 if (temp_url_key.empty()) {
1937 SignatureHelper sig_helper;
1938 sig_helper.calc(temp_url_key,
1939 s->info.request_uri,
1940 get_part_str(ctrl_parts, "redirect"),
1941 get_part_str(ctrl_parts, "max_file_size", "0"),
1942 get_part_str(ctrl_parts, "max_file_count", "0"),
1943 get_part_str(ctrl_parts, "expires", "0"));
1945 const auto local_sig = sig_helper.get_signature();
1947 ldout(s->cct, 20) << "FormPost signature [" << temp_url_key_num << "]"
1948 << " (calculated): " << local_sig << dendl;
1950 if (sig_helper.is_equal_to(form_signature)) {
1953 ldout(s->cct, 5) << "FormPost's signature mismatch: "
1954 << local_sig << " != " << form_signature << dendl;
1961 void RGWFormPost::get_owner_info(const req_state* const s,
1962 RGWUserInfo& owner_info) const
1964 /* We cannot use req_state::bucket_name because it isn't available
1965 * now. It will be initialized in RGWHandler_REST_SWIFT::postauth_init(). */
1966 const string& bucket_name = s->init_state.url_bucket;
1968 /* TempURL in Formpost only requires that bucket name is specified. */
1969 if (bucket_name.empty()) {
1973 string bucket_tenant;
1974 if (!s->account_name.empty()) {
1978 const rgw_user uid(s->account_name);
1979 if (uid.tenant.empty()) {
1980 const rgw_user tenanted_uid(uid.id, uid.id);
1982 if (rgw_get_user_info_by_uid(store, tenanted_uid, uinfo) >= 0) {
1984 bucket_tenant = uinfo.user_id.tenant;
1989 if (!found && rgw_get_user_info_by_uid(store, uid, uinfo) < 0) {
1992 bucket_tenant = uinfo.user_id.tenant;
1996 /* Need to get user info of bucket owner. */
1997 RGWBucketInfo bucket_info;
1998 int ret = store->get_bucket_info(*static_cast<RGWObjectCtx *>(s->obj_ctx),
1999 bucket_tenant, bucket_name,
2000 bucket_info, nullptr);
2005 ldout(s->cct, 20) << "temp url user (bucket owner): " << bucket_info.owner
2008 if (rgw_get_user_info_by_uid(store, bucket_info.owner, owner_info) < 0) {
2013 int RGWFormPost::get_params()
2015 /* The parentt class extracts boundary info from the Content-Type. */
2016 int ret = RGWPostObj_ObjStore::get_params();
2021 policy.create_default(s->user->user_id, s->user->display_name);
2023 /* Let's start parsing the HTTP body by parsing each form part step-
2024 * by-step till encountering the first part with file data. */
2026 struct post_form_part part;
2027 ret = read_form_part_header(&part, stream_done);
2032 if (s->cct->_conf->subsys.should_gather(ceph_subsys_rgw, 20)) {
2033 ldout(s->cct, 20) << "read part header -- part.name="
2034 << part.name << dendl;
2036 for (const auto& pair : part.fields) {
2037 ldout(s->cct, 20) << "field.name=" << pair.first << dendl;
2038 ldout(s->cct, 20) << "field.val=" << pair.second.val << dendl;
2039 ldout(s->cct, 20) << "field.params:" << dendl;
2041 for (const auto& param_pair : pair.second.params) {
2042 ldout(s->cct, 20) << " " << param_pair.first
2043 << " -> " << param_pair.second << dendl;
2049 /* Unexpected here. */
2050 err_msg = "Malformed request";
2054 const auto field_iter = part.fields.find("Content-Disposition");
2055 if (std::end(part.fields) != field_iter &&
2056 std::end(field_iter->second.params) != field_iter->second.params.find("filename")) {
2057 /* First data part ahead. */
2058 current_data_part = std::move(part);
2060 /* Stop the iteration. We can assume that all control parts have been
2061 * already parsed. The rest of HTTP body should contain data parts
2062 * only. They will be picked up by ::get_data(). */
2065 /* Control part ahead. Receive, parse and store for later usage. */
2067 ret = read_data(part.data, s->cct->_conf->rgw_max_chunk_size,
2068 boundary, stream_done);
2071 } else if (! boundary) {
2072 err_msg = "Couldn't find boundary";
2076 ctrl_parts[part.name] = std::move(part);
2078 } while (! stream_done);
2081 max_len = get_max_file_size();
2083 if (! current_data_part) {
2084 err_msg = "FormPost: no files to process";
2088 if (! is_non_expired()) {
2089 err_msg = "FormPost: Form Expired";
2093 if (! is_integral()) {
2094 err_msg = "FormPost: Invalid Signature";
2101 std::string RGWFormPost::get_current_filename() const
2104 const auto& field = current_data_part->fields.at("Content-Disposition");
2105 const auto iter = field.params.find("filename");
2107 if (std::end(field.params) != iter) {
2108 return prefix + iter->second;
2110 } catch (std::out_of_range&) {
2117 std::string RGWFormPost::get_current_content_type() const
2120 const auto& field = current_data_part->fields.at("Content-Type");
2122 } catch (std::out_of_range&) {
2126 return std::string();
2129 bool RGWFormPost::is_next_file_to_upload()
2131 if (! stream_done) {
2132 /* We have at least one additional part in the body. */
2133 struct post_form_part part;
2134 int r = read_form_part_header(&part, stream_done);
2139 const auto field_iter = part.fields.find("Content-Disposition");
2140 if (std::end(part.fields) != field_iter) {
2141 const auto& params = field_iter->second.params;
2142 const auto& filename_iter = params.find("filename");
2144 if (std::end(params) != filename_iter && ! filename_iter->second.empty()) {
2145 current_data_part = std::move(part);
2154 int RGWFormPost::get_data(ceph::bufferlist& bl, bool& again)
2158 int r = read_data(bl, s->cct->_conf->rgw_max_chunk_size,
2159 boundary, stream_done);
2164 /* Tell RGWPostObj::execute() that it has some data to put. */
2170 void RGWFormPost::send_response()
2172 std::string redirect = get_part_str(ctrl_parts, "redirect");
2173 if (! redirect.empty()) {
2174 op_ret = STATUS_REDIRECT;
2177 set_req_state_err(s, op_ret);
2178 s->err.err_code = err_msg;
2180 if (! redirect.empty()) {
2181 dump_redirect(s, redirect);
2183 end_header(s, this);
2186 bool RGWFormPost::is_formpost_req(req_state* const s)
2188 std::string content_type;
2189 std::map<std::string, std::string> params;
2191 parse_boundary_params(s->info.env->get("CONTENT_TYPE", ""),
2192 content_type, params);
2194 return boost::algorithm::iequals(content_type, "multipart/form-data") &&
2195 params.count("boundary") > 0;
2199 RGWOp *RGWHandler_REST_Service_SWIFT::op_get()
2201 return new RGWListBuckets_ObjStore_SWIFT;
2204 RGWOp *RGWHandler_REST_Service_SWIFT::op_head()
2206 return new RGWStatAccount_ObjStore_SWIFT;
2209 RGWOp *RGWHandler_REST_Service_SWIFT::op_put()
2211 if (s->info.args.exists("extract-archive")) {
2212 return new RGWBulkUploadOp_ObjStore_SWIFT;
2217 RGWOp *RGWHandler_REST_Service_SWIFT::op_post()
2219 if (s->info.args.exists("bulk-delete")) {
2220 return new RGWBulkDelete_ObjStore_SWIFT;
2222 return new RGWPutMetadataAccount_ObjStore_SWIFT;
2225 RGWOp *RGWHandler_REST_Service_SWIFT::op_delete()
2227 if (s->info.args.exists("bulk-delete")) {
2228 return new RGWBulkDelete_ObjStore_SWIFT;
2233 int RGWSwiftWebsiteHandler::serve_errordoc(const int http_ret,
2234 const std::string error_doc)
2236 /* Try to throw it all away. */
2237 s->formatter->reset();
2239 class RGWGetErrorPage : public RGWGetObj_ObjStore_SWIFT {
2241 RGWGetErrorPage(RGWRados* const store,
2242 RGWHandler_REST* const handler,
2244 const int http_ret) {
2245 /* Calling a virtual from the base class is safe as the subobject should
2246 * be properly initialized and we haven't overridden the init method. */
2247 init(store, s, handler);
2249 set_custom_http_response(http_ret);
2252 int error_handler(const int err_no,
2253 std::string* const error_content) override {
2254 /* Enforce that any error generated while getting the error page will
2255 * not be send to a client. This allows us to recover from the double
2256 * fault situation by sending the original message. */
2259 } get_errpage_op(store, handler, s, http_ret);
2261 s->object = std::to_string(http_ret) + error_doc;
2263 RGWOp* newop = &get_errpage_op;
2265 return rgw_process_authenticated(handler, newop, &req, s, true);
2268 int RGWSwiftWebsiteHandler::error_handler(const int err_no,
2269 std::string* const error_content)
2271 const auto& ws_conf = s->bucket_info.website_conf;
2273 if (can_be_website_req() && ! ws_conf.error_doc.empty()) {
2274 set_req_state_err(s, err_no);
2275 return serve_errordoc(s->err.http_ret, ws_conf.error_doc);
2278 /* Let's go to the default, no-op handler. */
2282 bool RGWSwiftWebsiteHandler::is_web_mode() const
2284 const boost::string_ref webmode = s->info.env->get("HTTP_X_WEB_MODE", "");
2285 return boost::algorithm::iequals(webmode, "true");
2288 bool RGWSwiftWebsiteHandler::can_be_website_req() const
2290 /* Static website works only with the GET or HEAD method. Nothing more. */
2291 static const std::set<boost::string_ref> ws_methods = { "GET", "HEAD" };
2292 if (ws_methods.count(s->info.method) == 0) {
2296 /* We also need to handle early failures from the auth system. In such cases
2297 * req_state::auth.identity may be empty. Let's treat that the same way as
2298 * the anonymous access. */
2299 if (! s->auth.identity) {
2303 /* Swift serves websites only for anonymous requests unless client explicitly
2304 * requested this behaviour by supplying X-Web-Mode HTTP header set to true. */
2305 if (s->auth.identity->is_anonymous() || is_web_mode()) {
2312 RGWOp* RGWSwiftWebsiteHandler::get_ws_redirect_op()
2314 class RGWMovedPermanently: public RGWOp {
2315 const std::string location;
2317 RGWMovedPermanently(const std::string& location)
2318 : location(location) {
2321 int verify_permission() override {
2325 void execute() override {
2326 op_ret = -ERR_PERMANENT_REDIRECT;
2330 void send_response() override {
2331 set_req_state_err(s, op_ret);
2333 dump_content_length(s, 0);
2334 dump_redirect(s, location);
2335 end_header(s, this);
2338 const string name() override {
2339 return "RGWMovedPermanently";
2343 return new RGWMovedPermanently(s->info.request_uri + '/');
2346 RGWOp* RGWSwiftWebsiteHandler::get_ws_index_op()
2348 /* Retarget to get obj on requested index file. */
2349 if (! s->object.empty()) {
2350 s->object = s->object.name +
2351 s->bucket_info.website_conf.get_index_doc();
2353 s->object = s->bucket_info.website_conf.get_index_doc();
2356 auto getop = new RGWGetObj_ObjStore_SWIFT;
2357 getop->set_get_data(boost::algorithm::equals("GET", s->info.method));
2362 RGWOp* RGWSwiftWebsiteHandler::get_ws_listing_op()
2364 class RGWWebsiteListing : public RGWListBucket_ObjStore_SWIFT {
2365 const std::string prefix_override;
2367 int get_params() override {
2368 prefix = prefix_override;
2374 void send_response() override {
2375 /* Generate the header now. */
2376 set_req_state_err(s, op_ret);
2378 dump_container_metadata(s, bucket, bucket_quota,
2379 s->bucket_info.website_conf);
2380 end_header(s, this, "text/html");
2385 /* Now it's the time to start generating HTML bucket listing.
2386 * All the crazy stuff with crafting tags will be delegated to
2387 * RGWSwiftWebsiteListingFormatter. */
2388 std::stringstream ss;
2389 RGWSwiftWebsiteListingFormatter htmler(ss, prefix);
2391 const auto& ws_conf = s->bucket_info.website_conf;
2392 htmler.generate_header(s->decoded_uri,
2393 ws_conf.listing_css_doc);
2395 for (const auto& pair : common_prefixes) {
2396 std::string subdir_name = pair.first;
2397 if (! subdir_name.empty()) {
2398 /* To be compliant with Swift we need to remove the trailing
2400 subdir_name.pop_back();
2403 htmler.dump_subdir(subdir_name);
2406 for (const rgw_bucket_dir_entry& obj : objs) {
2407 if (! common_prefixes.count(obj.key.name + '/')) {
2408 htmler.dump_object(obj);
2412 htmler.generate_footer();
2413 dump_body(s, ss.str());
2416 /* Taking prefix_override by value to leverage std::string r-value ref
2417 * ctor and thus avoid extra memory copying/increasing ref counter. */
2418 RGWWebsiteListing(std::string prefix_override)
2419 : prefix_override(std::move(prefix_override)) {
2423 std::string prefix = std::move(s->object.name);
2424 s->object = rgw_obj_key();
2426 return new RGWWebsiteListing(std::move(prefix));
2429 bool RGWSwiftWebsiteHandler::is_web_dir() const
2431 std::string subdir_name = url_decode(s->object.name);
2433 /* Remove character from the subdir name if it is "/". */
2434 if (subdir_name.empty()) {
2436 } else if (subdir_name.back() == '/') {
2437 subdir_name.pop_back();
2440 rgw_obj obj(s->bucket, std::move(subdir_name));
2442 /* First, get attrset of the object we'll try to retrieve. */
2443 RGWObjectCtx& obj_ctx = *static_cast<RGWObjectCtx *>(s->obj_ctx);
2444 obj_ctx.obj.set_atomic(obj);
2445 obj_ctx.obj.set_prefetch_data(obj);
2447 RGWObjState* state = nullptr;
2448 if (store->get_obj_state(&obj_ctx, s->bucket_info, obj, &state, false) < 0) {
2452 /* A nonexistent object cannot be a considered as a marker representing
2453 * the emulation of catalog in FS hierarchy. */
2454 if (! state->exists) {
2458 /* Decode the content type. */
2459 std::string content_type;
2460 get_contype_from_attrs(state->attrset, content_type);
2462 const auto& ws_conf = s->bucket_info.website_conf;
2463 const std::string subdir_marker = ws_conf.subdir_marker.empty()
2464 ? "application/directory"
2465 : ws_conf.subdir_marker;
2466 return subdir_marker == content_type && state->size <= 1;
2469 bool RGWSwiftWebsiteHandler::is_index_present(const std::string& index)
2471 rgw_obj obj(s->bucket, index);
2473 RGWObjectCtx& obj_ctx = *static_cast<RGWObjectCtx *>(s->obj_ctx);
2474 obj_ctx.obj.set_atomic(obj);
2475 obj_ctx.obj.set_prefetch_data(obj);
2477 RGWObjState* state = nullptr;
2478 if (store->get_obj_state(&obj_ctx, s->bucket_info, obj, &state, false) < 0) {
2482 /* A nonexistent object cannot be a considered as a viable index. We will
2483 * try to list the bucket or - if this is impossible - return an error. */
2484 return state->exists;
2487 int RGWSwiftWebsiteHandler::retarget_bucket(RGWOp* op, RGWOp** new_op)
2489 ldout(s->cct, 10) << "Starting retarget" << dendl;
2490 RGWOp* op_override = nullptr;
2492 /* In Swift static web content is served if the request is anonymous or
2493 * has X-Web-Mode HTTP header specified to true. */
2494 if (can_be_website_req()) {
2495 const auto& ws_conf = s->bucket_info.website_conf;
2496 const auto& index = s->bucket_info.website_conf.get_index_doc();
2498 if (s->decoded_uri.back() != '/') {
2499 op_override = get_ws_redirect_op();
2500 } else if (! index.empty() && is_index_present(index)) {
2501 op_override = get_ws_index_op();
2502 } else if (ws_conf.listing_enabled) {
2503 op_override = get_ws_listing_op();
2508 handler->put_op(op);
2509 op_override->init(store, s, handler);
2511 *new_op = op_override;
2516 /* Return 404 Not Found is the request has web mode enforced but we static web
2517 * wasn't able to serve it accordingly. */
2518 return ! op_override && is_web_mode() ? -ENOENT : 0;
2521 int RGWSwiftWebsiteHandler::retarget_object(RGWOp* op, RGWOp** new_op)
2523 ldout(s->cct, 10) << "Starting object retarget" << dendl;
2524 RGWOp* op_override = nullptr;
2526 /* In Swift static web content is served if the request is anonymous or
2527 * has X-Web-Mode HTTP header specified to true. */
2528 if (can_be_website_req() && is_web_dir()) {
2529 const auto& ws_conf = s->bucket_info.website_conf;
2530 const auto& index = s->bucket_info.website_conf.get_index_doc();
2532 if (s->decoded_uri.back() != '/') {
2533 op_override = get_ws_redirect_op();
2534 } else if (! index.empty() && is_index_present(index)) {
2535 op_override = get_ws_index_op();
2536 } else if (ws_conf.listing_enabled) {
2537 op_override = get_ws_listing_op();
2540 /* A regular request or the specified object isn't a subdirectory marker.
2541 * We don't need any re-targeting. Error handling (like sending a custom
2542 * error page) will be performed by error_handler of the actual RGWOp. */
2547 handler->put_op(op);
2548 op_override->init(store, s, handler);
2550 *new_op = op_override;
2555 /* Return 404 Not Found if we aren't able to re-target for subdir marker. */
2556 return ! op_override ? -ENOENT : 0;
2560 RGWOp *RGWHandler_REST_Bucket_SWIFT::get_obj_op(bool get_data)
2563 return new RGWGetACLs_ObjStore_SWIFT;
2567 return new RGWListBucket_ObjStore_SWIFT;
2569 return new RGWStatBucket_ObjStore_SWIFT;
2572 RGWOp *RGWHandler_REST_Bucket_SWIFT::op_get()
2574 return get_obj_op(true);
2577 RGWOp *RGWHandler_REST_Bucket_SWIFT::op_head()
2579 return get_obj_op(false);
2582 RGWOp *RGWHandler_REST_Bucket_SWIFT::op_put()
2585 return new RGWPutACLs_ObjStore_SWIFT;
2587 if(s->info.args.exists("extract-archive")) {
2588 return new RGWBulkUploadOp_ObjStore_SWIFT;
2590 return new RGWCreateBucket_ObjStore_SWIFT;
2593 RGWOp *RGWHandler_REST_Bucket_SWIFT::op_delete()
2595 return new RGWDeleteBucket_ObjStore_SWIFT;
2598 RGWOp *RGWHandler_REST_Bucket_SWIFT::op_post()
2600 if (RGWFormPost::is_formpost_req(s)) {
2601 return new RGWFormPost;
2603 return new RGWPutMetadataBucket_ObjStore_SWIFT;
2607 RGWOp *RGWHandler_REST_Bucket_SWIFT::op_options()
2609 return new RGWOptionsCORS_ObjStore_SWIFT;
2613 RGWOp *RGWHandler_REST_Obj_SWIFT::get_obj_op(bool get_data)
2616 return new RGWGetACLs_ObjStore_SWIFT;
2619 RGWGetObj_ObjStore_SWIFT *get_obj_op = new RGWGetObj_ObjStore_SWIFT;
2620 get_obj_op->set_get_data(get_data);
2624 RGWOp *RGWHandler_REST_Obj_SWIFT::op_get()
2626 return get_obj_op(true);
2629 RGWOp *RGWHandler_REST_Obj_SWIFT::op_head()
2631 return get_obj_op(false);
2634 RGWOp *RGWHandler_REST_Obj_SWIFT::op_put()
2637 return new RGWPutACLs_ObjStore_SWIFT;
2639 if(s->info.args.exists("extract-archive")) {
2640 return new RGWBulkUploadOp_ObjStore_SWIFT;
2642 if (s->init_state.src_bucket.empty())
2643 return new RGWPutObj_ObjStore_SWIFT;
2645 return new RGWCopyObj_ObjStore_SWIFT;
2648 RGWOp *RGWHandler_REST_Obj_SWIFT::op_delete()
2650 return new RGWDeleteObj_ObjStore_SWIFT;
2653 RGWOp *RGWHandler_REST_Obj_SWIFT::op_post()
2655 if (RGWFormPost::is_formpost_req(s)) {
2656 return new RGWFormPost;
2658 return new RGWPutMetadataObject_ObjStore_SWIFT;
2662 RGWOp *RGWHandler_REST_Obj_SWIFT::op_copy()
2664 return new RGWCopyObj_ObjStore_SWIFT;
2667 RGWOp *RGWHandler_REST_Obj_SWIFT::op_options()
2669 return new RGWOptionsCORS_ObjStore_SWIFT;
2673 int RGWHandler_REST_SWIFT::authorize()
2675 return rgw::auth::Strategy::apply(auth_strategy, s);
2678 int RGWHandler_REST_SWIFT::postauth_init()
2680 struct req_init_state* t = &s->init_state;
2682 /* XXX Stub this until Swift Auth sets account into URL. */
2683 s->bucket_tenant = s->user->user_id.tenant;
2684 s->bucket_name = t->url_bucket;
2686 dout(10) << "s->object=" <<
2687 (!s->object.empty() ? s->object : rgw_obj_key("<NULL>"))
2689 << rgw_make_bucket_entry_name(s->bucket_tenant, s->bucket_name)
2693 ret = rgw_validate_tenant_name(s->bucket_tenant);
2696 ret = validate_bucket_name(s->bucket_name);
2699 ret = validate_object_name(s->object.name);
2703 if (!t->src_bucket.empty()) {
2705 * We don't allow cross-tenant copy at present. It requires account
2706 * names in the URL for Swift.
2708 s->src_tenant_name = s->user->user_id.tenant;
2709 s->src_bucket_name = t->src_bucket;
2711 ret = validate_bucket_name(s->src_bucket_name);
2715 ret = validate_object_name(s->src_object.name);
2724 int RGWHandler_REST_SWIFT::validate_bucket_name(const string& bucket)
2726 const size_t len = bucket.size();
2728 if (len > MAX_BUCKET_NAME_LEN) {
2729 /* Bucket Name too long. Generate custom error message and bind it
2730 * to an R-value reference. */
2731 const auto msg = boost::str(
2732 boost::format("Container name length of %lld longer than %lld")
2733 % len % int(MAX_BUCKET_NAME_LEN));
2734 set_req_state_err(s, ERR_INVALID_BUCKET_NAME, msg);
2735 return -ERR_INVALID_BUCKET_NAME;
2738 const auto ret = RGWHandler_REST::validate_bucket_name(bucket);
2746 if (bucket[0] == '.')
2747 return -ERR_INVALID_BUCKET_NAME;
2749 if (check_utf8(bucket.c_str(), len))
2750 return -ERR_INVALID_UTF8;
2752 const char *s = bucket.c_str();
2754 for (size_t i = 0; i < len; ++i, ++s) {
2755 if (*(unsigned char *)s == 0xff)
2756 return -ERR_INVALID_BUCKET_NAME;
2762 static void next_tok(string& str, string& tok, char delim)
2764 if (str.size() == 0) {
2769 int pos = str.find(delim);
2771 tok = str.substr(0, pos);
2772 str = str.substr(pos + 1);
2778 int RGWHandler_REST_SWIFT::init_from_header(struct req_state* const s,
2779 const std::string& frontend_prefix)
2784 s->prot_flags |= RGW_REST_SWIFT;
2786 char reqbuf[frontend_prefix.length() + s->decoded_uri.length() + 1];
2787 sprintf(reqbuf, "%s%s", frontend_prefix.c_str(), s->decoded_uri.c_str());
2788 const char *req_name = reqbuf;
2792 if (*req_name == '?') {
2795 p = s->info.request_params.c_str();
2798 s->info.args.set(p);
2799 s->info.args.parse();
2801 /* Skip the leading slash of URL hierarchy. */
2802 if (req_name[0] != '/') {
2808 if ('\0' == req_name[0]) {
2809 return g_conf->rgw_swift_url_prefix == "/" ? -ERR_BAD_URL : 0;
2814 size_t pos = req.find('/');
2815 if (std::string::npos != pos && g_conf->rgw_swift_url_prefix != "/") {
2816 bool cut_url = g_conf->rgw_swift_url_prefix.length();
2817 first = req.substr(0, pos);
2819 if (first.compare(g_conf->rgw_swift_url_prefix) == 0) {
2821 /* Rewind to the "v1/..." part. */
2822 next_tok(req, first, '/');
2825 } else if (req.compare(g_conf->rgw_swift_url_prefix) == 0) {
2826 s->formatter = new RGWFormatter_Plain;
2827 return -ERR_BAD_URL;
2832 std::string tenant_path;
2833 if (! g_conf->rgw_swift_tenant_name.empty()) {
2834 tenant_path = "/AUTH_";
2835 tenant_path.append(g_conf->rgw_swift_tenant_name);
2838 /* verify that the request_uri conforms with what's expected */
2839 char buf[g_conf->rgw_swift_url_prefix.length() + 16 + tenant_path.length()];
2841 if (g_conf->rgw_swift_url_prefix == "/") {
2842 blen = sprintf(buf, "/v1%s", tenant_path.c_str());
2844 blen = sprintf(buf, "/%s/v1%s",
2845 g_conf->rgw_swift_url_prefix.c_str(), tenant_path.c_str());
2848 if (strncmp(reqbuf, buf, blen) != 0) {
2852 int ret = allocate_formatter(s, RGW_FORMAT_PLAIN, true);
2858 next_tok(req, ver, '/');
2860 if (!tenant_path.empty() || g_conf->rgw_swift_account_in_url) {
2861 string account_name;
2862 next_tok(req, account_name, '/');
2864 /* Erase all pre-defined prefixes like "AUTH_" or "KEY_". */
2865 const vector<string> skipped_prefixes = { "AUTH_", "KEY_" };
2867 for (const auto pfx : skipped_prefixes) {
2868 const size_t comp_len = min(account_name.length(), pfx.length());
2869 if (account_name.compare(0, comp_len, pfx) == 0) {
2870 /* Prefix is present. Drop it. */
2871 account_name = account_name.substr(comp_len);
2876 if (account_name.empty()) {
2877 return -ERR_PRECONDITION_FAILED;
2879 s->account_name = account_name;
2883 next_tok(req, first, '/');
2885 dout(10) << "ver=" << ver << " first=" << first << " req=" << req << dendl;
2886 if (first.size() == 0)
2889 s->info.effective_uri = "/" + first;
2891 // Save bucket to tide us over until token is parsed.
2892 s->init_state.url_bucket = first;
2896 rgw_obj_key(req, s->info.env->get("HTTP_X_OBJECT_VERSION_ID", "")); /* rgw swift extension */
2897 s->info.effective_uri.append("/" + s->object.name);
2903 int RGWHandler_REST_SWIFT::init(RGWRados* store, struct req_state* s,
2904 rgw::io::BasicClient *cio)
2906 struct req_init_state *t = &s->init_state;
2908 s->dialect = "swift";
2910 const char *copy_source = s->info.env->get("HTTP_X_COPY_FROM");
2912 bool result = RGWCopyObj::parse_copy_location(copy_source, t->src_bucket,
2915 return -ERR_BAD_URL;
2918 if (s->op == OP_COPY) {
2919 const char *req_dest = s->info.env->get("HTTP_DESTINATION");
2921 return -ERR_BAD_URL;
2923 string dest_bucket_name;
2924 rgw_obj_key dest_obj_key;
2926 RGWCopyObj::parse_copy_location(req_dest, dest_bucket_name,
2929 return -ERR_BAD_URL;
2931 string dest_object = dest_obj_key.name;
2933 /* convert COPY operation into PUT */
2934 t->src_bucket = t->url_bucket;
2935 s->src_object = s->object;
2936 t->url_bucket = dest_bucket_name;
2937 s->object = rgw_obj_key(dest_object);
2941 return RGWHandler_REST::init(store, s, cio);
2945 RGWRESTMgr_SWIFT::get_handler(struct req_state* const s,
2946 const rgw::auth::StrategyRegistry& auth_registry,
2947 const std::string& frontend_prefix)
2949 int ret = RGWHandler_REST_SWIFT::init_from_header(s, frontend_prefix);
2951 ldout(s->cct, 10) << "init_from_header returned err=" << ret << dendl;
2955 const auto& auth_strategy = auth_registry.get_swift();
2957 if (s->init_state.url_bucket.empty()) {
2958 return new RGWHandler_REST_Service_SWIFT(auth_strategy);
2961 if (s->object.empty()) {
2962 return new RGWHandler_REST_Bucket_SWIFT(auth_strategy);
2965 return new RGWHandler_REST_Obj_SWIFT(auth_strategy);
2968 RGWHandler_REST* RGWRESTMgr_SWIFT_Info::get_handler(
2969 struct req_state* const s,
2970 const rgw::auth::StrategyRegistry& auth_registry,
2971 const std::string& frontend_prefix)
2973 s->prot_flags |= RGW_REST_SWIFT;
2974 const auto& auth_strategy = auth_registry.get_swift();
2975 return new RGWHandler_REST_SWIFT_Info(auth_strategy);