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

Fix listing metrics as non-admin without creator policy defined #1440

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix listing metrics as non-admin without creator policy defined #1440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 1 addition & 1 deletion gnocchi/rest/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -698,7 +698,7 @@ def get_all(cls, **kwargs):
attr_filters.append({"=": {k: v}})

policy_filter = pecan.request.auth_helper.get_metric_policy_filter(
pecan.request, "list metric")
pecan.request, "list metric", allow_resource_project_id=True)
resource_policy_filter = (
pecan.request.auth_helper.get_resource_policy_filter(
pecan.request, "list metric", resource_type=None,
Expand Down
39 changes: 35 additions & 4 deletions gnocchi/rest/auth_helper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,9 @@ def get_resource_policy_filter(request, rule, resource_type, prefix=None):
return {"or": policy_filter}

@staticmethod
def get_metric_policy_filter(request, rule):
def get_metric_policy_filter(request,
rule,
allow_resource_project_id=False):
try:
# Check if the policy allows the user to list any metric
api.enforce(rule, {})
Expand All @@ -108,11 +110,36 @@ def get_metric_policy_filter(request, rule):
"created_by_project_id": project_id,
})
except webob.exc.HTTPForbidden:
pass
LOG.debug(("Policy rule for [%s] does not allow "
"users to access metrics they created."),
rule)
else:
policy_filter.append(
{"like": {"creator": "%:" + project_id}})

resource_project_id_allowed = False
try:
# Check if the policy allows the user to list metrics linked
# to their project via a resource
api.enforce(rule, {"resource": {"project_id": project_id}})
except webob.exc.HTTPForbidden:
LOG.debug(("Policy rule for [%s] does not allow "
"users to access resource metrics "
"linked to their project."),
rule)
else:
if allow_resource_project_id:
resource_project_id_allowed = True

# NOTE(callumdickinson): If allow_resource_project_id is enabled
# and the policy filter is empty, allow an empty policy filter
# to be returned for this case ONLY.
# The caller is expected to use get_resource_policy_filter
# to perform filtering by resource to ensure the client
# only gets metrics for resources they are allowed to access.
if resource_project_id_allowed and not policy_filter:
return {}

if not policy_filter:
# We need to have at least one policy filter in place
api.abort(403, "Insufficient privileges")
Expand Down Expand Up @@ -155,7 +182,9 @@ def get_resource_policy_filter(request, rule, resource_type, prefix=None):
return None

@staticmethod
def get_metric_policy_filter(request, rule):
def get_metric_policy_filter(request,
rule,
allow_resource_project_id=False):
return None


Expand Down Expand Up @@ -186,5 +215,7 @@ def get_resource_policy_filter(request, rule, resource_type, prefix=None):
return None

@staticmethod
def get_metric_policy_filter(request, rule):
def get_metric_policy_filter(request,
rule,
allow_resource_project_id=False):
return None
80 changes: 68 additions & 12 deletions gnocchi/tests/test_rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import testscenarios
from testtools import testcase
from unittest import mock
import webob
import webtest

import gnocchi
Expand Down Expand Up @@ -333,20 +334,75 @@ def test_list_metric_with_another_user(self):
self.assertNotIn(metric_id, [m["id"] for m in metric_list.json])

def test_list_metric_with_another_user_allowed(self):
rid = str(uuid.uuid4())
r = self.app.post_json("/v1/resource/generic",
params={
"id": rid,
"project_id": TestingApp.PROJECT_ID_2,
"metrics": {
"disk": {"archive_policy_name": "low"},
}
})
metric_id = r.json['metrics']['disk']
r1id = str(uuid.uuid4())
r1 = self.app.post_json("/v1/resource/generic",
params={
"id": r1id,
"project_id": TestingApp.PROJECT_ID,
"metrics": {
"disk": {
"archive_policy_name": "low"},
}
})
metric_id1 = r1.json['metrics']['disk']
r2id = str(uuid.uuid4())
r2 = self.app.post_json("/v1/resource/generic",
params={
"id": r2id,
"project_id": TestingApp.PROJECT_ID_2,
"metrics": {
"disk": {
"archive_policy_name": "low"},
}
})
metric_id2 = r2.json['metrics']['disk']

with self.app.use_another_user():
metric_list = self.app.get("/v1/metric")
self.assertIn(metric_id, [m["id"] for m in metric_list.json])
metric_list = self.app.get("/v1/metric").json
metric_ids = [m["id"] for m in metric_list]
self.assertNotIn(metric_id1, metric_ids)
self.assertIn(metric_id2, metric_ids)

def test_list_metric_with_another_user_allowed_no_creator_policy(self):
r1id = str(uuid.uuid4())
r1 = self.app.post_json("/v1/resource/generic",
params={
"id": r1id,
"project_id": TestingApp.PROJECT_ID,
"metrics": {
"disk": {
"archive_policy_name": "low"},
}
})
metric_id1 = r1.json['metrics']['disk']
r2id = str(uuid.uuid4())
r2 = self.app.post_json("/v1/resource/generic",
params={
"id": r2id,
"project_id": TestingApp.PROJECT_ID_2,
"metrics": {
"disk": {
"archive_policy_name": "low"},
}
})
metric_id2 = r2.json['metrics']['disk']

orig_enforce = api.enforce

def _enforce(rule, target):
if rule == "list metric" and "created_by_project_id" in target:
raise webob.exc.HTTPForbidden()
return orig_enforce(rule, target)

with mock.patch.object(api,
'enforce',
side_effect=_enforce) as mock_enforce:
with self.app.use_another_user():
metric_list = self.app.get("/v1/metric").json
metric_ids = [m["id"] for m in metric_list]
self.assertNotIn(metric_id1, metric_ids)
self.assertIn(metric_id2, metric_ids)
mock_enforce.assert_called()

def test_get_metric_with_another_user(self):
result = self.app.post_json("/v1/metric",
Expand Down