Mpsk devices #749

agmes4 · 2024-09-17T15:37:05Z

Added

added MPSK Clients for a user
added model representing MPSK Clients
added frontend integration for mpsk adding revoming and editing
added api endpoints for mpsk

Resolves #744

lukasjuhrich

Overall, these are some high-quality changes! I've found a few details here and there, and some things you could not have known about.

pycroft/model/mpsk_client.py

pycroft/lib/mpsk_client.py

pycroft/model/mpsk_client.py

tests/model/test_mpsk.py

web/api/v0/__init__.py

web/blueprints/mpskclient/__init__.py

ibot3 · 2024-09-19T07:42:19Z

Please add a certain limit for the number of MPSK devices per user. (e.g. 50)

agmes4 · 2024-09-19T07:50:09Z

I will set it to 10 dont think this should be exceeded by anyone

ibot3 · 2024-09-19T07:52:51Z

If you choose a limit this low, there may be situations where it is not enough for a user with many devices.
Maybe add this limitation only on the API side, so that there is no limit for our admins.

lukasjuhrich · 2024-09-19T07:55:42Z

Maybe add this limitation only on the API side, so that there is no limit for our admins.

Generally in favor, but is there any technical limit we should care about? or do the controllers allow arbitrarily many devices?
This should not matter since MPSK is an edge-case anyway, but I would be curious what the theoretical limit would be; every subnet is finite, anyway.

ibot3 · 2024-09-19T08:05:05Z

Generally in favor, but is there any technical limit we should care about? or do the controllers allow arbitrarily many devices? This should not matter since MPSK is an edge-case anyway, but I would be curious what the theoretical limit would be; every subnet is finite, anyway.

Besides the subnet size, there shouldn't be a limit AFAIK.
I suggested the devices limit mainly to avoid that someone creates lots of devices (maybe hundreds, thousands) with a bad intention.

agmes4 · 2024-09-19T08:31:37Z

but we dont preserve a IP for them so yeah when he has that many devices we have a problem but when he adds so much devices. Or am I missing something?

agmes4 · 2024-09-19T08:32:41Z

Anyway I added now the limit of 10 devices we could set it down.

pycroft/lib/mpsk_client.py

web/templates/user/user_show.html

mabezi · 2024-09-20T13:46:37Z

Looks pretty good to me.

Do we want to add a note in Pycroft if the user has a legacy wifi password? That could simplify debugging, but in the end it affects only very few users.

lukasjuhrich · 2024-09-28T09:53:06Z

@agmes4 I've rebased on top of develop and squashed the !fixup commits (you can do this yourself with rebase -i --autosquash), as you would have done anyway. Just be aware that when pulling, you'll have to rebase on top of the new origin/MPSK_devices.

lukasjuhrich · 2024-09-28T13:28:20Z

I'm setting up the API tests. In the meantime, I found a few things to fix.
Most importantly, we're missing an API endpoint to list all of the MPSK devices ;)

web/api/v0/__init__.py

lukasjuhrich · 2024-09-28T15:29:02Z

The API tests have been prepped; @agmes4 continues work and adds an endpoint for the devices.

An important feature has been suggested by @mabezi: when a user has no wifi password or a legacy password, instead of the mpsk table we should add a warning alert "user has no wifi password or a legacy password, and needs a new cleartext password to use MPSK clients".

This is only relevant for edge cases like active members or other folk with registered_at≤2020.

lukasjuhrich · 2024-09-28T15:35:02Z

Ah, also, please add lib.mpsk_client to the list of modules with strictest type checking in pyproject.toml (that is, next to lib.user

web/api/v0/__init__.py

added a new Subsection for MPSK Clients for the creating of them #744

added the database model for storing added the needed functions as well as the relation to the user and back Signed-off-by: Alex <[email protected]> #744

changed the name Signed-off-by: Alex <[email protected]>

changed the creat mpsks so that it now validates for the length of added clients Signed-off-by: Alex <[email protected]> #744

the api is now able to add more clients Signed-off-by: Alex <[email protected]> #744

Co-authored-by: Lukas Juhrich <[email protected]>

Signed-off-by: Alex <[email protected]> #744

added the db session now as parameter removed kargs for determining api calls moved check for number of mpsks clients to api Signed-off-by: Alex <[email protected]> #744

added the type hint for Session

fixed api wrong type

Since the amount check moved from lib to API, this is not raised anymore.

This uses the data attached by the webargs handler, which is responsible for throwing 422 unprocessable entity. See https://webargs.readthedocs.io/en/latest/framework_support.html#error-handling Also, note that pallets/flask#593 is now closed, making the workaround superfluous.

This fixes a subtle parameter swap in the API call.

In that case, it returns `None` just as if the password weren't set

added same mac test, invalid password, exceeds the max clients added delete mpsk; test not found, unauthed, successful delete Signed-off-by: Alex <[email protected]> #744

refactored code renamed some error codes for better readability Signed-off-by: Alex <[email protected]> #744

added get mpsks clients tests Signed-off-by: Alex <[email protected]> #744

added api route for getting all the mpsks clients of a user Signed-off-by: Alex <[email protected]> #744

added test for changing the mpsk clients Signed-off-by: Alex <[email protected]> #744

changed the error codes for changing mpsk client so they match the ones in adding Signed-off-by: Alex <[email protected]> #744

Signed-off-by: Alex <[email protected]> #744

added karg parameter Signed-off-by: Alex <[email protected]> #744

imported the pycroft.lib.mpsk_client to strict typechecking

The tablet icon was hard to idenfity.

lukasjuhrich · 2024-10-03T14:45:21Z

tests (& migration) went through locally, and ruff cannot handle a PR of this size, so merging in spite of CI.

agmes4 requested a review from lukasjuhrich September 17, 2024 15:37

agmes4 linked an issue Sep 17, 2024 that may be closed by this pull request

Add support for MPSK #744

Closed

agmes4 force-pushed the MPSK_devices branch from 5f55f51 to 6b16064 Compare September 17, 2024 15:45

lukasjuhrich reviewed Sep 18, 2024

View reviewed changes

ibot3 reviewed Sep 19, 2024

View reviewed changes

pycroft/lib/mpsk_client.py Outdated Show resolved Hide resolved

ibot3 reviewed Sep 19, 2024

View reviewed changes

web/templates/user/user_show.html Outdated Show resolved Hide resolved

lukasjuhrich force-pushed the MPSK_devices branch 2 times, most recently from d81dede to 9dca68e Compare September 28, 2024 09:52

lukasjuhrich reviewed Sep 28, 2024

View reviewed changes

web/api/v0/__init__.py Outdated Show resolved Hide resolved

lukasjuhrich reviewed Sep 29, 2024

View reviewed changes

web/api/v0/__init__.py Outdated Show resolved Hide resolved

mabezi added feature 🔨 web/ui Things relating to Flask routes and Jinja templates 🔨 db-schema Things that touch the DB schema and probably require a migration. 🔨 api labels Oct 1, 2024

lukasjuhrich force-pushed the MPSK_devices branch from 0ecb598 to 05cf3ea Compare October 2, 2024 14:35

agmes4 added 3 commits October 2, 2024 16:35

added frontend MPSK Clients

72c2731

added a new Subsection for MPSK Clients for the creating of them #744

added MSPK Client Model

4e06e42

added the database model for storing added the needed functions as well as the relation to the user and back Signed-off-by: Alex <[email protected]> #744

changed name to mspk client module

6363c73

changed the name Signed-off-by: Alex <[email protected]>

agmes4 and others added 25 commits October 2, 2024 16:35

changed Create MPSK

ab23c44

changed the creat mpsks so that it now validates for the length of added clients Signed-off-by: Alex <[email protected]> #744

api mpsk api more clients

3cafd5c

the api is now able to add more clients Signed-off-by: Alex <[email protected]> #744

Update web/api/v0/__init__.py

cda3369

Co-authored-by: Lukas Juhrich <[email protected]>

fixed typo

22dc893

Signed-off-by: Alex <[email protected]> #744

lib mpsks added session as parameter

99c47af

added the db session now as parameter removed kargs for determining api calls moved check for number of mpsks clients to api Signed-off-by: Alex <[email protected]> #744

MPSKS Lib: added type hint session

26ed413

added the type hint for Session

fixed wrong type in passings

8f7f359

fixed api wrong type

schema: add mpsk_client

85febde

Remove now unused AmountExceededError

10002d0

Since the amount check moved from lib to API, this is not raised anymore.

api: Make certain error messages more specific

c9148d2

tests: POC API test for add-mpsk

a52ec26

lib.mpsk_client: Enforce keyword-only arguments

97373c6

This fixes a subtle parameter swap in the API call.

model: Allow accessing user.wifi_password even if stored in crypt

4fc6e29

In that case, it returns `None` just as if the password weren't set

model: rename backref User.mpsks → User.mpsk_clients

3b0b18c

tests: move test_api to api.test_mpsk and introduce class

f5dc3ff

added api tests

9c9ad26

added same mac test, invalid password, exceeds the max clients added delete mpsk; test not found, unauthed, successful delete Signed-off-by: Alex <[email protected]> #744

refactoring and renaming of error codes

a26a496

refactored code renamed some error codes for better readability Signed-off-by: Alex <[email protected]> #744

added test for API

0f85476

added get mpsks clients tests Signed-off-by: Alex <[email protected]> #744

API: added get mpsks clients

886e4b3

added api route for getting all the mpsks clients of a user Signed-off-by: Alex <[email protected]> #744

added mpsks change tests

e4dec3a

added test for changing the mpsk clients Signed-off-by: Alex <[email protected]> #744

API: renaming of error codes MPSK

da89cae

changed the error codes for changing mpsk client so they match the ones in adding Signed-off-by: Alex <[email protected]> #744

API: refactoring

139778a

Signed-off-by: Alex <[email protected]> #744

fixed added admin mpsk test

489c55f

added karg parameter Signed-off-by: Alex <[email protected]> #744

added lib.mpsk_clients pyproject.toml

7534a7d

imported the pycroft.lib.mpsk_client to strict typechecking

lukasjuhrich force-pushed the MPSK_devices branch from 05cf3ea to 7534a7d Compare October 2, 2024 14:36

Change mpsk icon to wifi

c350c1b

The tablet icon was hard to idenfity.

lukasjuhrich merged commit 5948cfe into develop Oct 3, 2024
5 of 6 checks passed

lukasjuhrich deleted the MPSK_devices branch October 3, 2024 14:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mpsk devices #749

Mpsk devices #749

agmes4 commented Sep 17, 2024

lukasjuhrich left a comment

ibot3 commented Sep 19, 2024

agmes4 commented Sep 19, 2024

ibot3 commented Sep 19, 2024

lukasjuhrich commented Sep 19, 2024

ibot3 commented Sep 19, 2024

agmes4 commented Sep 19, 2024

agmes4 commented Sep 19, 2024

mabezi commented Sep 20, 2024 •

edited

Loading

lukasjuhrich commented Sep 28, 2024

lukasjuhrich commented Sep 28, 2024

lukasjuhrich commented Sep 28, 2024

lukasjuhrich commented Sep 28, 2024

lukasjuhrich commented Oct 3, 2024

Mpsk devices #749

Mpsk devices #749

Conversation

agmes4 commented Sep 17, 2024

Added

lukasjuhrich left a comment

Choose a reason for hiding this comment

ibot3 commented Sep 19, 2024

agmes4 commented Sep 19, 2024

ibot3 commented Sep 19, 2024

lukasjuhrich commented Sep 19, 2024

ibot3 commented Sep 19, 2024

agmes4 commented Sep 19, 2024

agmes4 commented Sep 19, 2024

mabezi commented Sep 20, 2024 • edited Loading

lukasjuhrich commented Sep 28, 2024

lukasjuhrich commented Sep 28, 2024

lukasjuhrich commented Sep 28, 2024

lukasjuhrich commented Sep 28, 2024

lukasjuhrich commented Oct 3, 2024

mabezi commented Sep 20, 2024 •

edited

Loading