Skip to content

Commit

Permalink
Fix some typos, improvements the Keycloak settings for the server and…
Browse files Browse the repository at this point in the history 
… the client
  • Loading branch information
@macagua
macagua committed Oct 30, 2023
1 parent b42a4c1 commit 5739978
Showing 1 changed file with 92 additions and 63 deletions.
155 changes: 92 additions & 63 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
pas.plugins.oidc
================

This is an Plone authentication plugin for OpenID Connect.
OAuth 2.0 should work as well, because OpenID Connect is built on top of this protocol.
This is a Plone authentication plugin for OpenID Connect.
OAuth 2.0 should work as well because OpenID Connect is built on top of this protocol.

Features
--------
Expand All @@ -43,7 +43,7 @@ Features
Installation
------------

Install ``pas.plugins.oidc`` by adding it to your buildout::
Install ``pas.plugins.oidc`` by adding it to your buildout: ::

[buildout]

Expand All @@ -58,7 +58,7 @@ and then running ``bin/buildout``
Warning
-------

Pay attention to the customization of `User info property used as userid` field, with the wrong configuration it's easy impersonate another user.
Pay attention to the customization of `User info property used as userid` field, with the wrong configuration it's easy to impersonate another user.


Install and configure the plugin
Expand All @@ -67,32 +67,36 @@ Install and configure the plugin
* Go to the Add-ons control panel and install ``pas.plugins.oidc``.
* In the ZMI go to the plugin properties at http://localhost:8080/Plone/acl_users/oidc/manage_propertiesForm
* Configure the properties with the data obtained from your provider:
* OIDC/Oauth2 Issuer
* Client ID
* Client secret
* redirect_uris: this needs to match the **public URL** where the user will be redirected after the login flow is completed. It needs to include the `/Plone/acl_users/oidc/callback` part. When using Volto you need to expose Plone somehow to have the login process finish correctly.
* ``OIDC/Oauth2 Issuer``
* ``Client ID``
* ``Client secret``
* ``redirect_uris``: this needs to match the **public URL** where the user will be redirected after the login flow is completed. It needs to include
the `/Plone/acl_users/oidc/callback` part. When using Volto you need to expose Plone somehow to have the login process finish correctly.
* Use Zope session data manager: see the section below about the usage of session.
* Create user / update user properties: when selected the user data in Plone will be updated with the data coming from the OIDC provider.ç
* Create user / update user properties: when selected the user data in Plone will be updated with the data coming from the OIDC provider.
* Create authentication __ac ticket: when selected the user will be allowed to act as a logged-in user in Plone.
* Create authentication auth_token (volto/restapi) ticket: when selected the user will be allowed to act as a logged-in user in the Volto frontend.
* Create authentication auth_token (Volto/REST API) ticket: when selected the user will be allowed to act as a logged-in user in the Volto frontend.
* Open ID scopes to request to the server: information requested to the OIDC provider. Leave it as it is or modify it according to your provider's information.
* Use PKCE: when enabled uses PKCE_ when requesting authentication from the provider.

Login and Logout URLs
---------------------

When using this plugin the standard Plone URLs used for login (`http://localhost:8080/Plone/login`) and logout (`http://localhost:8080/Plone/logout`) will not trigger the usage of the plugin.
When using this plugin, the standard Plone URLs used for login (`http://localhost:8080/Plone/login`) and logout (`http://localhost:8080/Plone/logout`)
will not trigger the usage of the plugin.

When using this plugin with a Volto frontend the standard URLs for login (`http://localhost:3000/login`) and logout (`http://localhost:3000/logout`) will not trigger the usage of the plugin.
When using this plugin with a Volto frontend the standard URLs for login (`http://localhost:3000/login`) and logout (`http://localhost:3000/logout`)
will not trigger the usage of the plugin.

To login into a site using the OIDC provider, you will need to change those login URLs to the following:

* Login: /<Plone Site Id>/acl_users/<oidc pas plugin id>/login
* Logout: /<Plone Site Id>/acl_users/<oidc pas plugin id>/logout
* Login: /``<Plone Site Id>``/acl_users/``<oidc pas plugin id>``/login
* Logout: /``<Plone Site Id>``/acl_users/``<oidc pas plugin id>``/logout

Where:
- Plone Site Id: is the id you gave to the Plone site when you created it. It is usually `Plone` but may vary. It is the last part of the URL when you browse Plone directly without using any proxy server, ex. `http://localhost:8080/Plone+ -> `Plone`
- oidc pas plugin id: is the id you gave to the OIDC plugin when you created it inside the Plone PAS administration panel. If you just used the default configuration and installed this plugin using Plone's Add-on Control Panel, this id will be `oidc`
*Where:*

* ``Plone Site Id``: is the id you gave to the Plone site when you created it. It is usually `Plone` but may vary. It is the last part of the URL when you browse Plone directly without using any proxy server, ex. `http://localhost:8080/Plone+` -> `Plone`.
* ``oidc pas plugin id``: is the id you gave to the OIDC plugin when you created it inside the Plone PAS administration panel. If you just used the default configuration and installed this plugin using Plone's Add-on Control Panel, this id will be `oidc`.

When using Volto as a frontend, you need to expose those login and logout URLs somehow to make the login and logout process work.

Expand All @@ -106,52 +110,75 @@ Please refer to the `Keycloak documentation <https://www.keycloak.org/documentat
Specifically, here we will use a Docker image, so follow the instructions on how to `get started with Keycloak on Docker <https://www.keycloak.org/getting-started/getting-started-docker>`_.
This does **not** give you a production setup, but it is fine for local development.

Keycloak runs on port 8080 by default.
Plone uses the same port.
When you are reading this, you probably know how to let Plone use a different port.
So let's indeed let Keycloak use its preferred port.
At the moment of writing, this is how you start a Keycloak container::
**Note:** Keycloak runs on port ``8080`` by default. Plone uses the same port. When you are reading this, you probably know how to let Plone use a different port.
So let's indeed let Keycloak use its preferred port. At the moment of writing, this is how you start a Keycloak container: ::

docker run -p 8080:8080 -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin quay.io/keycloak/keycloak:19.0.3 start-dev

The plugin can be used with legacy(deprecated) keycloak redirect_uri parameter. To use this you need to enable the option in the plugin configuration. To test that you can run the keycloak server with the option--spi-login-protocol-openid-connect-legacy-logout-redirect-uri=true::
The plugin can be used with legacy (deprecated) Keycloak ``redirect_uri`` parameter. To use this you need to enable the option
in the plugin configuration. To test that you can run the Keycloak server with the `--spi-login-protocol-openid-connect-legacy-logout-redirect-uri=true`
option: ::

docker run -p 8080:8080 -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin quay.io/keycloak/keycloak:19.0.3 start-dev --spi-login-protocol-openid-connect-legacy-logout-redirect-uri=true

Note: when you exit this container, it still exists and you can restart it so you don't lose your configuration.
**Note:** when you exit this container, it still exists and you can restart it so you don't lose your configuration.
With ``docker ps -a`` figure out the name of the container and then use ``docker container start -ai <name>``.

Follow the Keycloak Docker documentation further:

* Create a realm. Give this the name ``plone``.
* Create a user. Remember to set a password for this user in the Credentials tab.
* Open a different browser and check that you can login to Keycloak with this user.
* Open the `Keycloak Admin Console <http://localhost:8080/admin>`_, make sure you are logged in as ``admin``.

* Click the word ``master`` in the top-left corner, then click ``Create Realm``.

* Enter `plone` in the ``Realm name`` field.

* Click ``Create``.

* Click the word ``master`` in the top-left corner, then click ``plone``.

* Click ``Manage`` -> ``Users`` in the left-hand menu.

* Click ``Create new user``.

* Remember to set a password for this user in the ``Credentials`` tab.

* Open a different browser and check that you can login to `Keycloak Account Console <http://localhost:8080/realms/plone/account>`_ with this user.

In the original browser, follow the steps for securing your first app.
But we will be using different settings for Plone.
And when last I checked, the actual UI differed from the documentation.
So:

* Make sure you are logged in as admin in Keycloak, and are in the Plone realm.
* Go to Clients.
* Click 'Create client':
* Open the `Keycloak Admin Console <http://localhost:8080/admin>`_, make sure you are logged in as ``admin``.

* Click the word ``master`` in the top-left corner, then click ``plone``.

* Click ``Manage`` -> ``Clients`` in the left-hand menu.

* Click ``Create client``:

* ``Client type``: *OpenID Connect*

* ``Client ID``: *plone*

* Turn ``Always display in console`` to ``On`` Useful for testing.

* Click ``Next`` and click ``Save``.

* Now you can fill in the ``Settings`` -> ``Access settings``. We will assume Plone runs on port 8081:

* ``Root URL``: `http://localhost:8081/Plone/`

* client type: OpenID Connect
* client ID: plone
* Turn 'always display in console' on. Useful for testing.
* Click Next and Save.
* ``Home URL``: `http://localhost:8081/Plone/`

* Now you can fill in the Access settings. We will assume Plone runs on port 8081:
* ``Valid redirect URIs``: `http://localhost:8081/Plone*`

* Root URL: http://localhost:8081/Plone/
* Home URL: http://localhost:8081/Plone/
* Valid redirect URIs: http://localhost:8081/Plone*
* Leave the rest at the defaults, unless you know what you are doing, and click Save.
* Leave the rest at the defaults, unless you know what you are doing, and click ``Save``.

Keycloak is ready.

Setup Plone as client
~~~~~~~~~~~~~~~~~~~~~
Setup Plone as a client
~~~~~~~~~~~~~~~~~~~~~~~

* In your Zope instance configuration, make sure Plone runs on port 8081.
* Make sure ``pas.plugins.oidc`` is installed with pip or Buildout.
Expand All @@ -161,24 +188,27 @@ Setup Plone as client
* Set these properties:

* OIDC/Oauth2 Issuer: http://localhost:8080/realms/plone/
* client ID: plone. This must match the client ID you have set in Keycloak.
* Use deprecated redirect_uri. Use this if you need to run old versions of keycloak.
* Client ID: plone. This must match the client ID you have set in Keycloak.
* Use deprecated ``redirect_uri``. Use this if you need to run old versions of Keycloak.
* Leave the rest at the default and save the changes.

[TODO] screenshot.

Attention, before keycloak 18, the parameter for logout was redirect_uri and it is deprecated since version 18. But the keycloak server can run with the redirect_uri if needed, it is possible to use the plugin with the legacy parameter enabled also. The problem is that if the deprecated parameter is enabled in the plugin but not in the server, the plugin will not work.
Attention, before Keycloak 18, the parameter for logout was ``redirect_uri`` and it has been deprecated since version 18. But the
Keycloak server can run with the ``redirect_uri`` if needed, it is possible to use the plugin with the legacy parameter enabled also.
The problem is that if the deprecated parameter is enabled in the plugin but not in the server, the plugin will not work.

So this is the way it works:
So, this is the way it works:

* With legacy enabled in keycloak, the plugin works in default mode.
* With legacy enabled in keycloak, the plugin also works with legacy mode.
* With legacy disabled in keycloak(default after version 18), the plugin works in default mode.
* With legacy disabled in keycloak(default after version 18), the plugin do NOT works with legacy mode.
* With legacy enabled in Keycloak, the plugin works in default mode.
* With legacy enabled in Keycloak, the plugin also works with legacy mode.
* With legacy disabled in Keycloak (default after version 18), the plugin works in default mode.
* With legacy disabled in Keycloak (default after version 18), the plugin does NOT work with legacy mode.

So, for keycloak, it do not matter if we use the default or legacy mode if the keycloak runs in legacy mode.
So, for Keycloak, it does not matter if we use the default or legacy mode if the Keycloak runs in legacy mode.

If legacy is disabled in keycloak, this is the default since version 18 of keycloak according to this comment in starckoverflow: https://stackoverflow.com/a/72142887, the plugin will work only if the option use legacy mode is off(un-checked).
If legacy is disabled in Keycloak, this is the default since version 18 of Keycloak according to this comment in *Starck Overflow*: https://stackoverflow.com/a/72142887,
the plugin will work only if the option use legacy mode is off (un-checked).

Login
~~~~~
Expand All @@ -187,12 +217,12 @@ Go to the other browser, or logout as admin from Keycloak.
Currently, the Plone login form is unchanged.
Instead, go to the login page of the plugin: http://localhost:8081/Plone/acl_users/oidc/login
This will take you to Keycloak to login, and then return.
You should now be logged in to Plone, and see the fullname and email, if you have set this in Keycloak.
You should now be logged in to Plone, and see the *full name* and *email*, if you have set this in Keycloak.

Logout
~~~~~~

If the login did worked as expected you can try to logout.
If the login did work as expected you can try to logout.

Go to the logout page of the plugin: http://localhost:8081/Plone/acl_users/oidc/logout
This will take you to Keycloak to logout, and then return to the post logout redirect url.
Expand All @@ -206,31 +236,30 @@ and comes back from there.
The plugin has 2 ways of working with sessions:

- Use the Zope Session Management: if the "Use Zope session data manager" option in the plugin configuration is enabled,
the plugin will use the sessioning configuration configured in Zope. To do so we advise to use `Products.mcdutils`_
the plugin will use the sessioning configuration configured in Zope. To do so we advise using `Products.mcdutils`_
to save the session data in a memcached based storage. Otherwise Zope will try to use ZODB based sessioning
which has shown several problems in the past.

- Use the cookie based session management: if the "Use Zope session data manager" option in the plugin
- Use the cookie-based session management: if the "Use Zope session data manager" option in the plugin
configuration is disabled, the plugin will use a Cookie to save that information in the client's browser.


Settings in environment variables
---------------------------------

Instead of editing your OIDC provider settings through the ZMI, you can use `collective.regenv`_ and provide
a YAML file with your settings. This is very useful if you have different settings in different environments
and and you do not want to edit the settings each time
you move the contents.
Optionally, instead of editing your OIDC provider settings through the ZMI, you can use `collective.regenv`_ and provide
a ``YAML`` file with your settings. This is very useful if you have different settings in different environments
and you do not want to edit the settings each time you move the contents.


Varnish
-------

If you are using the Varnish caching server in front of Plone, you may see this plugin only partially working.
Especially the ``came_from`` parameter may be ignored.
Optionally, if you are using the `Varnish caching server <https://6.docs.plone.org/glossary.html#term-Varnish>`_ in front
of Plone, you may see this plugin only partially working. Especially the ``came_from`` parameter may be ignored.
This is because the standard configuration from ``plone.recipe.varnish`` removes most cookies to improve anonymous caching.
Solution is to make sure the ``__ac_session`` cookie is added to the ``cookie-pass`` option.
Check what the current default is in the recipe, and update it::
The solution is to make sure the ``__ac_session`` cookie is added to the ``cookie-pass`` option.
Check what the current default is in the recipe, and update it: ::

[varnish-configuration]
recipe = plone.recipe.varnish:configuration
Expand Down

0 comments on commit 5739978

Please sign in to comment.