-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
Remove python-keycloak #352
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #352 +/- ##
==========================================
+ Coverage 92.82% 93.36% +0.54%
==========================================
Files 61 61
Lines 2258 2232 -26
==========================================
- Hits 2096 2084 -12
+ Misses 162 148 -14 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@FedericoNegri Only two comments, with only one of those being a correction! This approval is only on doc content--but what you did was excellent. I've never only had one suggested correction, even on PRs much smaller than this one!
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@PipKat your comment made we wonder and I realized I forgot to include the new "managing users" doc guide! please review this one https://github.com/ansys/pyhps/pull/352/files#diff-f835861f0b7fc9c9c1098462eb63089cd78a308d47e973efa1fb1037eaaf98a9, I'm sure you'll have more corrections :-) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor edits suggested.
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Background:
python-keycloak
versions < 3.9.1 depend onpython-jose
which in turn depends onecdsa
, which has safety vulnerabilitiespython-keycloak >= 3.9.1
replacedpython-jose
withjwcrypto
which is LGPL.I propose to get rid of
python-keycloak
as a PyHPS dependency (we'd only keep using it for tests). The package was only used in theAuthApi
as a convenience to query/create/modify/delete users as well as query their groups and roles.Since by default HPS users do not have the realm management
manage-users
role, it seems just misleading to expose the create/modify/delete users endpoints. I therefore removed those and rather added an example in the doc showing how to use theKeycloakAdmin
client frompython-keycloak
to do so.Nightly build run with Python 3.9 - 3.12 tests: https://github.com/ansys/pyhps/actions/runs/8158129451
Breaking change
ansys.hps.client.auth.authenticate
moved toansys.hps.client.authenticate
to avoid circular dependencies