904 read permissions of entities within flex model or flex context #1071

Flix6x · 2024-05-24T08:35:20Z

Closes #904.

Signed-off-by: F.N. Claessen <[email protected]>

…ntext Signed-off-by: F.N. Claessen <[email protected]>

Signed-off-by: F.N. Claessen <[email protected]>

Flix6x · 2024-05-24T11:06:12Z

flexmeasures/data/models/planning/utils.py

@nhoening I need advice on where to move these new util functions, for example, to:

api/common/utils/args_parsing.py

auth/loaders.py

or elsewhere, maybe even becoming a new acl method on some class? I'm out of my league here.

I saw other ctx_loaders were pointing to various things, such as:

ctx_loader=lambda bdf: bdf.sensor

ctx_loader=GenericAsset

ctx_loader=AccountIdField.load_current

ctx_loader=AuditLog.account_table_acl

ctx_loader=AuditLog.user_table_acl

These have nothing to do with auth directly, but are lookup functions that rely on our planning data structure. So I guess this location isn't bad, really.

I don't see why ctx_loader should be used, as no AuthContext is touched.

I don't see why ctx_loader should be used, as no AuthContext is touched.

I'm not sure what to do with this. Am I using ctx_loader incorrectly?

Signed-off-by: F.N. Claessen <[email protected]>

flexmeasures/api/v3_0/tests/test_sensor_schedules.py

flexmeasures/auth/decorators.py

nhoening · 2024-05-29T14:08:16Z

flexmeasures/data/models/planning/utils.py

These have nothing to do with auth directly, but are lookup functions that rely on our planning data structure. So I guess this location isn't bad, really.

I don't see why ctx_loader should be used, as no AuthContext is touched.

…-permissions-of-entities-within-flex-model-or-flex-context

Signed-off-by: F.N. Claessen <[email protected]>

…nly. Signed-off-by: F.N. Claessen <[email protected]>

Signed-off-by: F.N. Claessen <[email protected]>

…uments only." This reverts commit b2ec43a.

…ontext loaders loads a None Signed-off-by: F.N. Claessen <[email protected]>

Signed-off-by: F.N. Claessen <[email protected]>

…-model-or-flex-context

nhoening

I see the improvements, this is good.
I disagree with one potential security problem in particular, like in the last review.

nhoening · 2024-09-16T12:45:58Z

flexmeasures/auth/decorators.py

+        context_from_args = kwargs.get(ctx_arg_name)
+        # skip check in case (optional) argument was not passed
+        if context_from_args is None:
+            return None


I (still) believe this should be a LookupError. Above, you skip the auth check if this looking up of a context by argument name did not work out (which I also am in favor of not doing). This could quite easily happen by programmer mistake, and could easily be overlooked during testing.

ctx_arg_name is an optional attribute, but if it is given, we need to actually use it.

I think this is the major problem blocking my progress on this PR. How do you propose I deal with checking authorization on an optional argument (in this case coming from an optional API field)? Should I add a boolean argument to permission_required_for_context telling the argument is optional (i.e. skip if context is None) or required (i.e. raise if context is None)?

Can we not check that context_from_args has to be something if the developer gave information to look it up?

I.e. if ctx_arg_name is not None, then we expect that context_from_args is also not None, otherwise we got wrong parameterisation.

Simply put, if permission_required_for_context() has no context, we cannot say the permission is granted.

Why did you change the logic so that it could be granted? The field was optional before. Maybe it is because the flex context can contain no sensors to check? That is a case I can imagine, and maybe we could add a parameter to permission_required_for_context() that says pass_if_no_context_found or similar.

But the interpretation has to fit.

It was because flex_model and flex_context could be None, as they are optional parameters. In that case, the context is None, too, and we should pass the permissions check: i.e. the fields contain no sensor references, so there is nothing to check. I still don't really understand why we shouldn't grant permission on a None context, but by now I did find an alternative fix, by setting load defaults for the flex_context and flex_model. So now they are no longer None, but empty dicts instead.

nhoening · 2024-09-16T12:51:08Z

flexmeasures/auth/decorators.py

+                context = [context]
+            for ctx in context:
+                if isinstance(ctx, tuple):
+                    c = ctx[0]  # c[0] is the context, c[1] is its origin


Let's mention for ease of reading that the origin is just a string.

nhoening · 2024-09-16T13:00:05Z

flexmeasures/auth/decorators.py

+
+def load_context(
+    ctx_arg_pos, ctx_arg_name, ctx_loader, pass_ctx_to_loader, args, kwargs
+) -> AuthModelMixin | None:


Is this return type still valid? It can be a list or tuples with origins, right?

nhoening · 2024-09-16T13:04:14Z

flexmeasures/auth/decorators.py

+        context = context_from_args
+    if context is None:
+        raise LookupError(f"No context could be loaded from {context_from_args}.")
+    return context


Another thought: We provide several means of looking up context(s). Should we maybe check here that all context(s) are actually a subclass of AuthModelMixin and throw a meaningful LookupError if they are not?

I just checked, and check_access does this check. So we can not do it here. But it could help debugging problems.

flexmeasures/data/models/planning/utils.py

nhoening · 2024-09-16T13:13:52Z

flexmeasures/api/v3_0/sensors.py

+    @permission_required_for_context(
+        "read",
+        ctx_arg_name="flex_model",
+        ctx_loader=flex_model_loader,


I'd add a comment: "This extracts sensors from the flex model parameter - user needs read access to them"

…-permissions-of-entities-within-flex-model-or-flex-context

Signed-off-by: F.N. Claessen <[email protected]>

…so now permission_required_for_context still doesn't work with optional contexts Signed-off-by: F.N. Claessen <[email protected]>

read-the-docs-community · 2025-11-29T10:04:52Z

Documentation build overview

📚 flexmeasures | 🛠️ Build #30501709 | 📁 Comparing 70e3615 against latest (208943a)

🔍 Preview build

Show files changed (7 files in total): 📝 7 modified | ➕ 0 added | ➖ 0 deleted

File	Status
changelog.html	📝 modified
genindex.html	📝 modified
_autosummary/flexmeasures.api.common.responses.html	📝 modified
_autosummary/flexmeasures.auth.decorators.html	📝 modified
_autosummary/flexmeasures.data.models.planning.utils.html	📝 modified
api/change_log.html	📝 modified
api/v3_0.html	📝 modified

Signed-off-by: F.N. Claessen <[email protected]>

Flix6x added 12 commits May 24, 2024 10:30

feature: allow checking permissions on optional fields

6ecb17f

Signed-off-by: F.N. Claessen <[email protected]>

feature: decorator supports custom error handler

2546546

Signed-off-by: F.N. Claessen <[email protected]>

docs: add inline note explaining status code

c3a5920

Signed-off-by: F.N. Claessen <[email protected]>

feature: flex_context_loader lists all sensors contained in a flex-co…

482dd0a

…ntext Signed-off-by: F.N. Claessen <[email protected]>

feature: support context loader that returns multiple contexts

cc7248b

Signed-off-by: F.N. Claessen <[email protected]>

feature: check permissions on sensors referenced in flex-context

0b41e77

Signed-off-by: F.N. Claessen <[email protected]>

feature: add test checking permissions

e616d1c

Signed-off-by: F.N. Claessen <[email protected]>

fix: response with field names

019d772

Signed-off-by: F.N. Claessen <[email protected]>

feature: check permissions on sensors referenced in flex-model

aa27d79

Signed-off-by: F.N. Claessen <[email protected]>

refactor: sensor_loader

6ea9202

Signed-off-by: F.N. Claessen <[email protected]>

feature: add test case for unauthorized sensor in flex-model

f72ab14

Signed-off-by: F.N. Claessen <[email protected]>

style: black

edfa646

Signed-off-by: F.N. Claessen <[email protected]>

Flix6x added API Scheduling Auth labels May 24, 2024

Flix6x self-assigned this May 24, 2024

Flix6x linked an issue May 24, 2024 that may be closed by this pull request

Read permissions of entities within flex-model or flex-context #904

Open

Flix6x added 2 commits May 24, 2024 10:35

style: black once more

16684e6

Signed-off-by: F.N. Claessen <[email protected]>

style: flake8

7a12c49

Signed-off-by: F.N. Claessen <[email protected]>

Flix6x added the security label May 24, 2024

Flix6x commented May 24, 2024

View reviewed changes

Flix6x added 3 commits May 24, 2024 13:15

docs: fix test docstring

c7938fa

Signed-off-by: F.N. Claessen <[email protected]>

docs: API changelog entry

8733408

Signed-off-by: F.N. Claessen <[email protected]>

docs: main changelog entry

38d8241

Signed-off-by: F.N. Claessen <[email protected]>

Flix6x mentioned this pull request May 24, 2024

API endpoint for scheduling asset #1065

Merged

12 tasks

nhoening reviewed May 29, 2024

View reviewed changes

Flix6x added 4 commits June 8, 2024 22:07

Merge remote-tracking branch 'refs/remotes/origin/main' into 904-read…

075db1a

…-permissions-of-entities-within-flex-model-or-flex-context

docs: update docstring for supported ctx_loader return values

97aa1d7

Signed-off-by: F.N. Claessen <[email protected]>

fix: narrow down skipping auth check for optional keyword arguments o…

b2ec43a

…nly. Signed-off-by: F.N. Claessen <[email protected]>

fix: permission_required_for_context returns 403 rather than 422

d7862fc

Signed-off-by: F.N. Claessen <[email protected]>

Flix6x and others added 5 commits June 10, 2024 16:29

fix: typo

07b864c

Signed-off-by: F.N. Claessen <[email protected]>

Revert "fix: narrow down skipping auth check for optional keyword arg…

b07d76f

…uments only." This reverts commit b2ec43a.

fix: only return None in case of no context from args, but not when c…

ff73a4c

…ontext loaders loads a None Signed-off-by: F.N. Claessen <[email protected]>

fix: mypy

110d027

Signed-off-by: F.N. Claessen <[email protected]>

Merge branch 'main' into 904-read-permissions-of-entities-within-flex…

54c87d4

…-model-or-flex-context

Flix6x added this to the 0.23.0 milestone Aug 19, 2024

Merge branch 'main' into 904-read-permissions-of-entities-within-flex…

0873183

…-model-or-flex-context

nhoening requested changes Sep 16, 2024

View reviewed changes

nhoening modified the milestones: 0.23.0, 0.24.0 Sep 18, 2024

Flix6x modified the milestones: 0.24.0, 0.25.0 Jan 7, 2025

nhoening modified the milestones: 0.25.0, 0.26.0 Apr 1, 2025

Flix6x modified the milestones: 0.26.0, 0.27.0 Jun 2, 2025

Flix6x modified the milestones: 0.27.0, 0.28.0 Jul 17, 2025

nhoening modified the milestones: 0.28.0, 0.29 Sep 9, 2025

nhoening modified the milestones: 0.29.0, 0.30.0 Oct 15, 2025

Flix6x added 3 commits November 29, 2025 10:13

Merge remote-tracking branch 'refs/remotes/origin/main' into 904-read…

4740e7a

…-permissions-of-entities-within-flex-model-or-flex-context

fix: pass_if_no_context_found

934ac5f

Signed-off-by: F.N. Claessen <[email protected]>

refactor: set load_defaults for flex_model and flex_context instead; …

a53db55

…so now permission_required_for_context still doesn't work with optional contexts Signed-off-by: F.N. Claessen <[email protected]>

Flix6x added 2 commits November 29, 2025 15:36

feat: also apply auth decorators to asset trigger endpoint

3e78412

Signed-off-by: F.N. Claessen <[email protected]>

refactor: one less method

70e3615

Signed-off-by: F.N. Claessen <[email protected]>

nhoening modified the milestones: 0.30.0, 0.31.0 Dec 2, 2025

904 read permissions of entities within flex model or flex context #1071

Are you sure you want to change the base?

904 read permissions of entities within flex model or flex context #1071

Uh oh!

Conversation

Flix6x commented May 24, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nhoening left a comment

Choose a reason for hiding this comment

Uh oh!

nhoening Sep 16, 2024 • edited by Flix6x Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Flix6x Sep 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

read-the-docs-community bot commented Nov 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation build overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nhoening Sep 16, 2024 •

edited by Flix6x

Loading

Flix6x Sep 16, 2024 •

edited

Loading

read-the-docs-community bot commented Nov 29, 2025 •

edited

Loading