Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do not expose private metadata via relationfield serializer. #1635

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Do not expose private metadata via relationfield serializer. #1635

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5124fa
Do not expose private metadata via relationfield serializer.
maethu May 1, 2023
bc3b71e
Check for Access contents information on parent object instead of vie…
maethu May 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions news/1634.bugfix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Do not expose private metadata via relationfield serializer.
[maethu]
11 changes: 9 additions & 2 deletions src/plone/restapi/serializer/relationfield.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
from plone import api
from plone.dexterity.interfaces import IDexterityContent
from plone.restapi.interfaces import IFieldSerializer
from plone.restapi.interfaces import IJsonCompatible
Expand All @@ -17,7 +18,8 @@
@adapter(IRelationValue)
@implementer(IJsonCompatible)
def relationvalue_converter(value):
if value.to_object:
mtool = api.portal.get_tool("portal_membership")
if value.to_object and mtool.checkPermission("View", value.to_object):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is too much overhead and probably slow. Use the Zope basics, those are perfectly fine here:

from AccessControl.SecurityManagement import getSecurityManager
getSecurityManager().checkPermission(permission, obj)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

btw, if you anyway use plone.api, there is api.user.check_permission too as an alternative.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I am not wrong, plone.api may only be used in plone.restapi tests right? @plone/restapi-team

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure what the rules are, but if there are those rules, they must be documented somewhere.

request = getRequest()
request.form["metadata_fields"] = ["UID"]
summary = getMultiAdapter((value.to_object, request), ISerializeToJsonSummary)()
Expand All @@ -33,4 +35,9 @@ class RelationChoiceFieldSerializer(DefaultFieldSerializer):
@adapter(IRelationList, IDexterityContent, Interface)
@implementer(IFieldSerializer)
class RelationListFieldSerializer(DefaultFieldSerializer):
pass
def __call__(self):
value = self.get_value()
if value:
return [item for item in json_compatible(value) if item]
else:
return super().__call__()
Comment on lines +44 to +47
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if value:
return [item for item in json_compatible(value) if item]
else:
return super().__call__()
if value:
return [item for item in json_compatible(value) if item]
return super().__call__()

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the sake of readability: No else needed when the if returns.

26 changes: 25 additions & 1 deletion src/plone/restapi/tests/test_content_get.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@


class TestContentGet(unittest.TestCase):

layer = PLONE_RESTAPI_DX_FUNCTIONAL_TESTING

def setUp(self):
Expand Down Expand Up @@ -137,6 +136,31 @@ def test_get_content_includes_related_items(self):
response.json()["relatedItems"],
)

def test_get_content_includes_related_items_filtered_by_view_permission(self):
intids = getUtility(IIntIds)
self.portal.folder1.doc1.relatedItems = [
RelationValue(intids.getId(self.portal.folder1.folder2.doc2)),
]

# Remove view permission
self.portal.folder1.folder2.doc2.manage_permission(
"View", roles=[], acquire=False
)
self.portal.folder1.folder2.doc2.reindexObjectSecurity()
transaction.commit()

response = requests.get(
self.portal.folder1.doc1.absolute_url(),
headers={"Accept": "application/json"},
auth=(SITE_OWNER_NAME, SITE_OWNER_PASSWORD),
)
self.assertEqual(response.status_code, 200)
self.assertEqual(0, len(response.json()["relatedItems"]))
self.assertEqual(
[],
response.json()["relatedItems"],
)

def test_get_content_related_items_without_workflow(self):
intids = getUtility(IIntIds)

Expand Down