Summary: | OAuth/OIDC authentication for the staff interface requires OPAC enabled | ||
---|---|---|---|
Product: | Koha | Reporter: | Tomás Cohen Arazi (tcohen) <tomascohen> |
Component: | Authentication | Assignee: | Tomás Cohen Arazi (tcohen) <tomascohen> |
Status: | RESOLVED FIXED | QA Contact: | Testopia <testopia> |
Severity: | major | ||
Priority: | P5 - low | CC: | agustinmoyano, clemens.tubach, dcook, dpavlin, jonathan.druart, lukasz.koszyk, martin.renvoize, michaela.sieber, nick, tomascohen |
Version: | unspecified | ||
Hardware: | All | ||
OS: | All | ||
Change sponsored?: | --- | Patch complexity: | --- |
Documentation contact: | Documentation submission: | ||
Text to go in the release notes: | Version(s) released in: |
23.05.00,22.11.07
|
|
Circulation function: | |||
Bug Depends on: | |||
Bug Blocks: | 33675 | ||
Attachments: |
Bug 33708: Make staff interface login not require public API (OAuth/OIDC)
Bug 33708: Provide non-public endpoint for OAuth/OIDC for staff interface Bug 33708: Allow anonymous access to OAuth endpoints Bug 33708: Make staff interface login not require public API (OAuth/OIDC) Bug 33708: Provide non-public endpoint for OAuth/OIDC for staff interface Bug 33708: Allow anonymous access to OAuth endpoints |
Description
Tomás Cohen Arazi (tcohen)
2023-05-09 21:01:04 UTC
Created attachment 150905 [details] [review] Bug 33708: Make staff interface login not require public API (OAuth/OIDC) This patch makes the URL for staff login not point to the `/public` namespace. The behavior is not changed for the protocol, but as `/public` requires several settings to be available, it effectively requires to enable the OPAC, the public API, etc. This patch diferentiates both to solve the problem. I've tested following the Wiki instructions to set keycloak [1] using the *--sso* switch for `ktd` as well [2]. It is important to set the following URLs as allowed redirect in order to replicate the issue and verify the fix: http://localhost:8080/api/v1/public/oauth/login/test/opac http://localhost:8081/api/v1/oauth/login/test/staff To test: 1. Login into the staff interface using the SSO link: => FAIL: Results in a 'Bad redirect URL' error 2. Apply this patch and repeat 1 => SUCCESS: You get a permission denied error or you just login, depending on your setup. [1] https://wiki.koha-community.org/wiki/Testing_SSO [2] ktd --sso up -d Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Looking at this now... Not all URLs are updated it seems. The path for the URL for the button "Log in with Keycloak" on the staff interface is still /api/v1/public/oauth/login/keycloak/staff If you disable the sysprefs "RESTPublicAnonymousRequests" and "RESTPublicAPI", you'll see the following error {"error":"Configuration prevents the usage of this endpoint by unprivileged users"} If I fix the URL, then I get a 404. I see the paths in api/v1/swagger/paths/oauth.yaml but it doesn't appear in http://localhost:8081/api/v1/.html Ah because it's missing from api/v1/swagger/swagger.yaml If I fix the URL and the Swagger, then I get a 401 trying to access http://localhost:8081/api/v1/oauth/login/keycloak/staff I think I thought about this a bit when the OAuth/OIDC functionality was being developed. -- (The public endpoint actually has a similar problem. If you have disabled OpacPublic, you have to enable RESTPublicAnonymousRequests in order to use the OAuth/OIDC for the OPAC.) Created attachment 150918 [details] [review] Bug 33708: Provide non-public endpoint for OAuth/OIDC for staff interface This change fixes the definition for the non-public endpoint for the OAuth/OIDC implementation. It also uses the non-public endpoint for the staff interface UI. Created attachment 150919 [details] [review] Bug 33708: Allow anonymous access to OAuth endpoints Users needs anonymous access to OAuth endpoints so that they can login, and then use authenticated access for other endpoints. Tomas, take a look at my patches and let me know what you think. With all 3 patches, I've tested OIDC on staff interface and OPAC, and gotten them working with their respective URLs. (In reply to David Cook from comment #8) > Tomas, take a look at my patches and let me know what you think. > > With all 3 patches, I've tested OIDC on staff interface and OPAC, and gotten > them working with their respective URLs. They look great. I was really tired last night when I submitted. Thanks! (In reply to Tomás Cohen Arazi from comment #9) > They look great. I was really tired last night when I submitted. Thanks! No worries. How do we want to do the sign offs for these? Created attachment 151037 [details] [review] Bug 33708: Make staff interface login not require public API (OAuth/OIDC) This patch makes the URL for staff login not point to the `/public` namespace. The behavior is not changed for the protocol, but as `/public` requires several settings to be available, it effectively requires to enable the OPAC, the public API, etc. This patch diferentiates both to solve the problem. I've tested following the Wiki instructions to set keycloak [1] using the *--sso* switch for `ktd` as well [2]. It is important to set the following URLs as allowed redirect in order to replicate the issue and verify the fix: http://localhost:8080/api/v1/public/oauth/login/test/opac http://localhost:8081/api/v1/oauth/login/test/staff To test: 1. Login into the staff interface using the SSO link: => FAIL: Results in a 'Bad redirect URL' error 2. Apply this patch and repeat 1 => SUCCESS: You get a permission denied error or you just login, depending on your setup. [1] https://wiki.koha-community.org/wiki/Testing_SSO [2] ktd --sso up -d Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: David Cook <dcook@prosentient.com.au> Created attachment 151038 [details] [review] Bug 33708: Provide non-public endpoint for OAuth/OIDC for staff interface This change fixes the definition for the non-public endpoint for the OAuth/OIDC implementation. It also uses the non-public endpoint for the staff interface UI. Signed-off-by: David Cook <dcook@prosentient.com.au> Created attachment 151039 [details] [review] Bug 33708: Allow anonymous access to OAuth endpoints Users needs anonymous access to OAuth endpoints so that they can login, and then use authenticated access for other endpoints. Signed-off-by: David Cook <dcook@prosentient.com.au> (In reply to David Cook from comment #10) > (In reply to Tomás Cohen Arazi from comment #9) > > They look great. I was really tired last night when I submitted. Thanks! > > No worries. How do we want to do the sign offs for these? I've added my sign off to the patches. If you want to do the same for my last two, then I think we could move this to "Signed Off"? Pushed to master for 23.05. Nice work everyone, thanks! Nice work everyone! Pushed to stable for 22.11.x |