1 // -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
2 // vim: ts=8 sw=2 smarttab ft=cpp
9 #include "include/types.h"
11 #include "rgw_acl_s3.h"
14 #define dout_subsys ceph_subsys_rgw
18 #define RGW_URI_ALL_USERS "http://acs.amazonaws.com/groups/global/AllUsers"
19 #define RGW_URI_AUTH_USERS "http://acs.amazonaws.com/groups/global/AuthenticatedUsers"
21 static string rgw_uri_all_users
= RGW_URI_ALL_USERS
;
22 static string rgw_uri_auth_users
= RGW_URI_AUTH_USERS
;
24 void ACLPermission_S3::to_xml(ostream
& out
)
26 if ((flags
& RGW_PERM_FULL_CONTROL
) == RGW_PERM_FULL_CONTROL
) {
27 out
<< "<Permission>FULL_CONTROL</Permission>";
29 if (flags
& RGW_PERM_READ
)
30 out
<< "<Permission>READ</Permission>";
31 if (flags
& RGW_PERM_WRITE
)
32 out
<< "<Permission>WRITE</Permission>";
33 if (flags
& RGW_PERM_READ_ACP
)
34 out
<< "<Permission>READ_ACP</Permission>";
35 if (flags
& RGW_PERM_WRITE_ACP
)
36 out
<< "<Permission>WRITE_ACP</Permission>";
40 bool ACLPermission_S3::
41 xml_end(const char *el
)
43 const char *s
= data
.c_str();
44 if (strcasecmp(s
, "READ") == 0) {
45 flags
|= RGW_PERM_READ
;
47 } else if (strcasecmp(s
, "WRITE") == 0) {
48 flags
|= RGW_PERM_WRITE
;
50 } else if (strcasecmp(s
, "READ_ACP") == 0) {
51 flags
|= RGW_PERM_READ_ACP
;
53 } else if (strcasecmp(s
, "WRITE_ACP") == 0) {
54 flags
|= RGW_PERM_WRITE_ACP
;
56 } else if (strcasecmp(s
, "FULL_CONTROL") == 0) {
57 flags
|= RGW_PERM_FULL_CONTROL
;
64 class ACLGranteeType_S3
{
66 static const char *to_string(ACLGranteeType
& type
) {
67 switch (type
.get_type()) {
68 case ACL_TYPE_CANON_USER
:
69 return "CanonicalUser";
70 case ACL_TYPE_EMAIL_USER
:
71 return "AmazonCustomerByEmail";
79 static void set(const char *s
, ACLGranteeType
& type
) {
81 type
.set(ACL_TYPE_UNKNOWN
);
84 if (strcmp(s
, "CanonicalUser") == 0)
85 type
.set(ACL_TYPE_CANON_USER
);
86 else if (strcmp(s
, "AmazonCustomerByEmail") == 0)
87 type
.set(ACL_TYPE_EMAIL_USER
);
88 else if (strcmp(s
, "Group") == 0)
89 type
.set(ACL_TYPE_GROUP
);
91 type
.set(ACL_TYPE_UNKNOWN
);
95 class ACLID_S3
: public XMLObj
99 ~ACLID_S3() override
{}
100 string
& to_str() { return data
; }
103 class ACLURI_S3
: public XMLObj
107 ~ACLURI_S3() override
{}
110 class ACLEmail_S3
: public XMLObj
114 ~ACLEmail_S3() override
{}
117 class ACLDisplayName_S3
: public XMLObj
120 ACLDisplayName_S3() {}
121 ~ACLDisplayName_S3() override
{}
124 bool ACLOwner_S3::xml_end(const char *el
) {
125 ACLID_S3
*acl_id
= static_cast<ACLID_S3
*>(find_first("ID"));
126 ACLID_S3
*acl_name
= static_cast<ACLID_S3
*>(find_first("DisplayName"));
131 id
= acl_id
->get_data();
133 // DisplayName is optional
135 display_name
= acl_name
->get_data();
142 void ACLOwner_S3::to_xml(ostream
& out
) {
147 out
<< "<Owner>" << "<ID>" << s
<< "</ID>";
148 if (!display_name
.empty())
149 out
<< "<DisplayName>" << display_name
<< "</DisplayName>";
153 bool ACLGrant_S3::xml_end(const char *el
) {
154 ACLGrantee_S3
*acl_grantee
;
157 ACLEmail_S3
*acl_email
;
158 ACLPermission_S3
*acl_permission
;
159 ACLDisplayName_S3
*acl_name
;
162 acl_grantee
= static_cast<ACLGrantee_S3
*>(find_first("Grantee"));
166 if (!acl_grantee
->get_attr("xsi:type", type_str
))
168 ACLGranteeType_S3::set(type_str
.c_str(), type
);
170 acl_permission
= static_cast<ACLPermission_S3
*>(find_first("Permission"));
174 permission
= *acl_permission
;
180 switch (type
.get_type()) {
181 case ACL_TYPE_CANON_USER
:
182 acl_id
= static_cast<ACLID_S3
*>(acl_grantee
->find_first("ID"));
185 id
= acl_id
->to_str();
186 acl_name
= static_cast<ACLDisplayName_S3
*>(acl_grantee
->find_first("DisplayName"));
188 name
= acl_name
->get_data();
191 acl_uri
= static_cast<ACLURI_S3
*>(acl_grantee
->find_first("URI"));
194 uri
= acl_uri
->get_data();
195 group
= uri_to_group(uri
);
197 case ACL_TYPE_EMAIL_USER
:
198 acl_email
= static_cast<ACLEmail_S3
*>(acl_grantee
->find_first("EmailAddress"));
201 email
= acl_email
->get_data();
210 void ACLGrant_S3::to_xml(CephContext
*cct
, ostream
& out
) {
211 ACLPermission_S3
& perm
= static_cast<ACLPermission_S3
&>(permission
);
213 /* only show s3 compatible permissions */
214 if (!(perm
.get_permissions() & RGW_PERM_ALL_S3
))
220 "<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"" << ACLGranteeType_S3::to_string(type
) << "\">";
221 switch (type
.get_type()) {
222 case ACL_TYPE_CANON_USER
:
223 out
<< "<ID>" << id
<< "</ID>";
225 out
<< "<DisplayName>" << name
<< "</DisplayName>";
228 case ACL_TYPE_EMAIL_USER
:
229 out
<< "<EmailAddress>" << email
<< "</EmailAddress>";
232 if (!group_to_uri(group
, uri
)) {
233 ldout(cct
, 0) << "ERROR: group_to_uri failed with group=" << (int)group
<< dendl
;
236 out
<< "<URI>" << uri
<< "</URI>";
246 bool ACLGrant_S3::group_to_uri(ACLGroupTypeEnum group
, string
& uri
)
249 case ACL_GROUP_ALL_USERS
:
250 uri
= rgw_uri_all_users
;
252 case ACL_GROUP_AUTHENTICATED_USERS
:
253 uri
= rgw_uri_auth_users
;
260 bool RGWAccessControlList_S3::xml_end(const char *el
) {
261 XMLObjIter iter
= find("Grant");
262 ACLGrant_S3
*grant
= static_cast<ACLGrant_S3
*>(iter
.get_next());
265 grant
= static_cast<ACLGrant_S3
*>(iter
.get_next());
270 void RGWAccessControlList_S3::to_xml(ostream
& out
) {
271 multimap
<string
, ACLGrant
>::iterator iter
;
272 out
<< "<AccessControlList>";
273 for (iter
= grant_map
.begin(); iter
!= grant_map
.end(); ++iter
) {
274 ACLGrant_S3
& grant
= static_cast<ACLGrant_S3
&>(iter
->second
);
275 grant
.to_xml(cct
, out
);
277 out
<< "</AccessControlList>";
280 struct s3_acl_header
{
282 const char *http_header
;
285 static const char *get_acl_header(const RGWEnv
*env
,
286 const struct s3_acl_header
*perm
)
288 const char *header
= perm
->http_header
;
290 return env
->get(header
, NULL
);
293 static int parse_grantee_str(RGWUserCtl
*user_ctl
, string
& grantee_str
,
294 const struct s3_acl_header
*perm
, ACLGrant
& grant
)
296 string id_type
, id_val_quoted
;
297 int rgw_perm
= perm
->rgw_perm
;
302 ret
= parse_key_value(grantee_str
, id_type
, id_val_quoted
);
306 string id_val
= rgw_trim_quotes(id_val_quoted
);
308 if (strcasecmp(id_type
.c_str(), "emailAddress") == 0) {
309 ret
= user_ctl
->get_info_by_email(id_val
, &info
, null_yield
);
313 grant
.set_canon(info
.user_id
, info
.display_name
, rgw_perm
);
314 } else if (strcasecmp(id_type
.c_str(), "id") == 0) {
315 rgw_user
user(id_val
);
316 ret
= user_ctl
->get_info_by_uid(user
, &info
, null_yield
);
320 grant
.set_canon(info
.user_id
, info
.display_name
, rgw_perm
);
321 } else if (strcasecmp(id_type
.c_str(), "uri") == 0) {
322 ACLGroupTypeEnum gid
= grant
.uri_to_group(id_val
);
323 if (gid
== ACL_GROUP_NONE
)
326 grant
.set_group(gid
, rgw_perm
);
334 static int parse_acl_header(RGWUserCtl
*user_ctl
, const RGWEnv
*env
,
335 const struct s3_acl_header
*perm
, std::list
<ACLGrant
>& _grants
)
337 std::list
<string
> grantees
;
338 std::string hacl_str
;
340 const char *hacl
= get_acl_header(env
, perm
);
345 get_str_list(hacl_str
, ",", grantees
);
347 for (list
<string
>::iterator it
= grantees
.begin(); it
!= grantees
.end(); ++it
) {
349 int ret
= parse_grantee_str(user_ctl
, *it
, perm
, grant
);
353 _grants
.push_back(grant
);
359 int RGWAccessControlList_S3::create_canned(ACLOwner
& owner
, ACLOwner
& bucket_owner
, const string
& canned_acl
)
361 acl_user_map
.clear();
364 ACLGrant owner_grant
;
366 rgw_user bid
= bucket_owner
.get_id();
367 string bname
= bucket_owner
.get_display_name();
369 /* owner gets full control */
370 owner_grant
.set_canon(owner
.get_id(), owner
.get_display_name(), RGW_PERM_FULL_CONTROL
);
371 add_grant(&owner_grant
);
373 if (canned_acl
.size() == 0 || canned_acl
.compare("private") == 0) {
377 ACLGrant bucket_owner_grant
;
378 ACLGrant group_grant
;
379 if (canned_acl
.compare("public-read") == 0) {
380 group_grant
.set_group(ACL_GROUP_ALL_USERS
, RGW_PERM_READ
);
381 add_grant(&group_grant
);
382 } else if (canned_acl
.compare("public-read-write") == 0) {
383 group_grant
.set_group(ACL_GROUP_ALL_USERS
, RGW_PERM_READ
);
384 add_grant(&group_grant
);
385 group_grant
.set_group(ACL_GROUP_ALL_USERS
, RGW_PERM_WRITE
);
386 add_grant(&group_grant
);
387 } else if (canned_acl
.compare("authenticated-read") == 0) {
388 group_grant
.set_group(ACL_GROUP_AUTHENTICATED_USERS
, RGW_PERM_READ
);
389 add_grant(&group_grant
);
390 } else if (canned_acl
.compare("bucket-owner-read") == 0) {
391 bucket_owner_grant
.set_canon(bid
, bname
, RGW_PERM_READ
);
392 if (bid
.compare(owner
.get_id()) != 0)
393 add_grant(&bucket_owner_grant
);
394 } else if (canned_acl
.compare("bucket-owner-full-control") == 0) {
395 bucket_owner_grant
.set_canon(bid
, bname
, RGW_PERM_FULL_CONTROL
);
396 if (bid
.compare(owner
.get_id()) != 0)
397 add_grant(&bucket_owner_grant
);
405 int RGWAccessControlList_S3::create_from_grants(std::list
<ACLGrant
>& grants
)
410 acl_user_map
.clear();
413 for (std::list
<ACLGrant
>::iterator it
= grants
.begin(); it
!= grants
.end(); ++it
) {
421 bool RGWAccessControlPolicy_S3::xml_end(const char *el
) {
422 RGWAccessControlList_S3
*s3acl
=
423 static_cast<RGWAccessControlList_S3
*>(find_first("AccessControlList"));
429 ACLOwner
*owner_p
= static_cast<ACLOwner_S3
*>(find_first("Owner"));
436 void RGWAccessControlPolicy_S3::to_xml(ostream
& out
) {
437 out
<< "<AccessControlPolicy xmlns=\"" << XMLNS_AWS_S3
<< "\">";
438 ACLOwner_S3
& _owner
= static_cast<ACLOwner_S3
&>(owner
);
439 RGWAccessControlList_S3
& _acl
= static_cast<RGWAccessControlList_S3
&>(acl
);
442 out
<< "</AccessControlPolicy>";
445 static const s3_acl_header acl_header_perms
[] = {
446 {RGW_PERM_READ
, "HTTP_X_AMZ_GRANT_READ"},
447 {RGW_PERM_WRITE
, "HTTP_X_AMZ_GRANT_WRITE"},
448 {RGW_PERM_READ_ACP
,"HTTP_X_AMZ_GRANT_READ_ACP"},
449 {RGW_PERM_WRITE_ACP
, "HTTP_X_AMZ_GRANT_WRITE_ACP"},
450 {RGW_PERM_FULL_CONTROL
, "HTTP_X_AMZ_GRANT_FULL_CONTROL"},
454 int RGWAccessControlPolicy_S3::create_from_headers(RGWUserCtl
*user_ctl
, const RGWEnv
*env
, ACLOwner
& _owner
)
456 std::list
<ACLGrant
> grants
;
459 for (const struct s3_acl_header
*p
= acl_header_perms
; p
->rgw_perm
; p
++) {
460 r
= parse_acl_header(user_ctl
, env
, p
, grants
);
466 RGWAccessControlList_S3
& _acl
= static_cast<RGWAccessControlList_S3
&>(acl
);
467 r
= _acl
.create_from_grants(grants
);
475 can only be called on object that was parsed
477 int RGWAccessControlPolicy_S3::rebuild(RGWUserCtl
*user_ctl
, ACLOwner
*owner
, RGWAccessControlPolicy
& dest
,
478 std::string
&err_msg
)
483 ACLOwner
*requested_owner
= static_cast<ACLOwner_S3
*>(find_first("Owner"));
484 if (requested_owner
) {
485 rgw_user
& requested_id
= requested_owner
->get_id();
486 if (!requested_id
.empty() && requested_id
.compare(owner
->get_id()) != 0)
490 RGWUserInfo owner_info
;
491 if (user_ctl
->get_info_by_uid(owner
->get_id(), &owner_info
, null_yield
) < 0) {
492 ldout(cct
, 10) << "owner info does not exist" << dendl
;
493 err_msg
= "Invalid id";
496 ACLOwner
& dest_owner
= dest
.get_owner();
497 dest_owner
.set_id(owner
->get_id());
498 dest_owner
.set_name(owner_info
.display_name
);
500 ldout(cct
, 20) << "owner id=" << owner
->get_id() << dendl
;
501 ldout(cct
, 20) << "dest owner id=" << dest
.get_owner().get_id() << dendl
;
503 RGWAccessControlList
& dst_acl
= dest
.get_acl();
505 multimap
<string
, ACLGrant
>& grant_map
= acl
.get_grant_map();
506 multimap
<string
, ACLGrant
>::iterator iter
;
507 for (iter
= grant_map
.begin(); iter
!= grant_map
.end(); ++iter
) {
508 ACLGrant
& src_grant
= iter
->second
;
509 ACLGranteeType
& type
= src_grant
.get_type();
511 bool grant_ok
= false;
513 RGWUserInfo grant_user
;
514 switch (type
.get_type()) {
515 case ACL_TYPE_EMAIL_USER
:
519 if (!src_grant
.get_id(u
)) {
520 ldout(cct
, 0) << "ERROR: src_grant.get_id() failed" << dendl
;
524 ldout(cct
, 10) << "grant user email=" << email
<< dendl
;
525 if (user_ctl
->get_info_by_email(email
, &grant_user
, null_yield
) < 0) {
526 ldout(cct
, 10) << "grant user email not found or other error" << dendl
;
527 err_msg
= "The e-mail address you provided does not match any account on record.";
528 return -ERR_UNRESOLVABLE_EMAIL
;
530 uid
= grant_user
.user_id
;
532 case ACL_TYPE_CANON_USER
:
534 if (type
.get_type() == ACL_TYPE_CANON_USER
) {
535 if (!src_grant
.get_id(uid
)) {
536 ldout(cct
, 0) << "ERROR: src_grant.get_id() failed" << dendl
;
537 err_msg
= "Invalid id";
542 if (grant_user
.user_id
.empty() && user_ctl
->get_info_by_uid(uid
, &grant_user
, null_yield
) < 0) {
543 ldout(cct
, 10) << "grant user does not exist:" << uid
<< dendl
;
544 err_msg
= "Invalid id";
547 ACLPermission
& perm
= src_grant
.get_permission();
548 new_grant
.set_canon(uid
, grant_user
.display_name
, perm
.get_permissions());
551 new_grant
.get_id(new_id
);
552 ldout(cct
, 10) << "new grant: " << new_id
<< ":" << grant_user
.display_name
<< dendl
;
559 if (ACLGrant_S3::group_to_uri(src_grant
.get_group(), uri
)) {
560 new_grant
= src_grant
;
562 ldout(cct
, 10) << "new grant: " << uri
<< dendl
;
564 ldout(cct
, 10) << "bad grant group:" << (int)src_grant
.get_group() << dendl
;
565 err_msg
= "Invalid group uri";
573 dst_acl
.add_grant(&new_grant
);
580 bool RGWAccessControlPolicy_S3::compare_group_name(string
& id
, ACLGroupTypeEnum group
)
583 case ACL_GROUP_ALL_USERS
:
584 return (id
.compare(RGW_USER_ANON_ID
) == 0);
585 case ACL_GROUP_AUTHENTICATED_USERS
:
586 return (id
.compare(rgw_uri_auth_users
) == 0);
591 // shouldn't get here
595 XMLObj
*RGWACLXMLParser_S3::alloc_obj(const char *el
)
598 if (strcmp(el
, "AccessControlPolicy") == 0) {
599 obj
= new RGWAccessControlPolicy_S3(cct
);
600 } else if (strcmp(el
, "Owner") == 0) {
601 obj
= new ACLOwner_S3();
602 } else if (strcmp(el
, "AccessControlList") == 0) {
603 obj
= new RGWAccessControlList_S3(cct
);
604 } else if (strcmp(el
, "ID") == 0) {
605 obj
= new ACLID_S3();
606 } else if (strcmp(el
, "DisplayName") == 0) {
607 obj
= new ACLDisplayName_S3();
608 } else if (strcmp(el
, "Grant") == 0) {
609 obj
= new ACLGrant_S3();
610 } else if (strcmp(el
, "Grantee") == 0) {
611 obj
= new ACLGrantee_S3();
612 } else if (strcmp(el
, "Permission") == 0) {
613 obj
= new ACLPermission_S3();
614 } else if (strcmp(el
, "URI") == 0) {
615 obj
= new ACLURI_S3();
616 } else if (strcmp(el
, "EmailAddress") == 0) {
617 obj
= new ACLEmail_S3();