Skip to content

feat: add created_by filter to ReadAllFlowObjects #1164

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

Merged
Tati1701 merged 2 commits into from
Apr 16, 2026
Merged

feat: add created_by filter to ReadAllFlowObjects #1164

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
6ba667e
feat: add created_by filter to ReadAllFlowObjects
TristanInSec Apr 16, 2026
7ed3890
fix: change created_by from str to Iterable[str]
TristanInSec Apr 16, 2026
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
7 changes: 7 additions & 0 deletions grr/server/grr_response_server/databases/db.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2061,6 +2061,7 @@ def ReadAllFlowObjects(
max_create_time: Optional[rdfvalue.RDFDatetime] = None,
include_child_flows: bool = True,
not_created_by: Optional[Iterable[str]] = None,
created_by: Optional[str] = None,

@Tati1701 Tati1701 Apr 16, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Let's make this one Iterable too, like in other methods.

@TristanInSec TristanInSec Apr 16, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done. Changed to Optional[Iterable[str]] across all four files, with IN %s in MySQL and list() membership in the in-memory backend. Test updated to cover multi-user filtering.

) -> list[flows_pb2.Flow]:
"""Returns all flow objects.

Expand All @@ -2072,6 +2073,7 @@ def ReadAllFlowObjects(
include_child_flows: include child flows in the results. If False, only
parent flows are returned. Must be `True` if the parent flow is given.
not_created_by: exclude flows created by any of the users in this list.
created_by: only include flows created by this user.

Returns:
A list of Flow objects.
Expand Down Expand Up @@ -4334,6 +4336,7 @@ def ReadAllFlowObjects(
max_create_time: Optional[rdfvalue.RDFDatetime] = None,
include_child_flows: bool = True,
not_created_by: Optional[Iterable[str]] = None,
created_by: Optional[str] = None,
) -> list[flows_pb2.Flow]:
if client_id is not None:
precondition.ValidateClientId(client_id)
Expand All @@ -4348,13 +4351,17 @@ def ReadAllFlowObjects(
if not_created_by is not None:
precondition.AssertIterableType(not_created_by, str)

if created_by is not None:
precondition.AssertType(created_by, str)

return self.delegate.ReadAllFlowObjects(
client_id=client_id,
parent_flow_id=parent_flow_id,
min_create_time=min_create_time,
max_create_time=max_create_time,
include_child_flows=include_child_flows,
not_created_by=not_created_by,
created_by=created_by,
)

def ReadChildFlowObjects(
Expand Down
23 changes: 23 additions & 0 deletions grr/server/grr_response_server/databases/db_flows_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,29 @@ def testReadAllFlowObjectsWithNotCreatedBy(self):
flows = self.db.ReadAllFlowObjects(not_created_by=frozenset(["baz", "foo"]))
self.assertCountEqual([f.flow_id for f in flows], ["000A0002"])

def testReadAllFlowObjectsWithCreatedBy(self):
client_id_1 = "C.1111111111111111"
self.db.WriteClientMetadata(client_id_1)

self.db.WriteFlowObject(
flows_pb2.Flow(client_id=client_id_1, flow_id="000A0001", creator="foo")
)
self.db.WriteFlowObject(
flows_pb2.Flow(client_id=client_id_1, flow_id="000A0002", creator="bar")
)
self.db.WriteFlowObject(
flows_pb2.Flow(client_id=client_id_1, flow_id="000A0003", creator="foo")
)

flows = self.db.ReadAllFlowObjects(created_by="foo")
self.assertCountEqual([f.flow_id for f in flows], ["000A0001", "000A0003"])

flows = self.db.ReadAllFlowObjects(created_by="bar")
self.assertCountEqual([f.flow_id for f in flows], ["000A0002"])

flows = self.db.ReadAllFlowObjects(created_by="nonexistent")
self.assertEmpty(flows)

def testReadAllFlowObjectsWithAllConditions(self):
client_id_1 = "C.1111111111111111"
client_id_2 = "C.2222222222222222"
Expand Down
3 changes: 3 additions & 0 deletions grr/server/grr_response_server/databases/mem_flows.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,7 @@ def ReadAllFlowObjects(
max_create_time: Optional[rdfvalue.RDFDatetime] = None,
include_child_flows: bool = True,
not_created_by: Optional[Iterable[str]] = None,
created_by: Optional[str] = None,
) -> list[flows_pb2.Flow]:
"""Returns all flow objects."""
res = []
Expand All @@ -261,6 +262,8 @@ def ReadAllFlowObjects(
continue
if not_created_by is not None and flow.creator in list(not_created_by):
continue
if created_by is not None and flow.creator != created_by:
continue
res.append(flow)
return res

Expand Down
5 changes: 5 additions & 0 deletions grr/server/grr_response_server/databases/mysql_flows.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,7 @@ def ReadAllFlowObjects(
max_create_time: Optional[rdfvalue.RDFDatetime] = None,
include_child_flows: bool = True,
not_created_by: Optional[Iterable[str]] = None,
created_by: Optional[str] = None,
cursor: Optional[cursors.Cursor] = None,
) -> list[flows_pb2.Flow]:
"""Returns all flow objects."""
Expand Down Expand Up @@ -441,6 +442,10 @@ def ReadAllFlowObjects(
# The cursor implementation knows how to convert lists and ordinary sets.
args.append(list(not_created_by))

if created_by is not None:
conditions.append("creator = %s")
args.append(created_by)

query = f"SELECT {self.FLOW_DB_FIELDS} FROM flows"
if conditions:
query += " WHERE " + " AND ".join(conditions)
Expand Down