diff --git a/README.md b/README.md index 96ae6e9..341a851 100644 --- a/README.md +++ b/README.md @@ -12,33 +12,31 @@ with existing applications by leveraging Keycloak identity brokering features. Keycloak is a nice product, but still lacking on some aspects of SAML2 compatibility, and the SPID specifications deviate from the SAML2 standard in some key aspects. -Apart from the SPID-SAML2 protocol differences the main issue that this project works around -is Keycloak lack of support for transient identities. Also, some of the SP behaviors +Besides the SPID-SAML2 protocol differences, the main issue that this project works around +is Keycloak's lack of support for transient identities. Also, some of the SP behaviors are hardcoded to work with simple IdPs only (i.e. the SP metadata generation is -severely lacking). +severely lacking). Keycloak is slowly improving on this aspect, so over time this plugin +will become simpler and targeted on implementing only the specific changes required by SPID. I have documented a reference configuration for SPID and the workarounds required -in the project wiki (https://github.com/lscorcia/keycloak-spid-provider/wiki). - -Please make sure to read it and understand the config steps and the open issues and +in the project wiki (https://github.com/lscorcia/keycloak-spid-provider/wiki). Please make +sure to read it and understand the config steps and the open issues and limitations before planning your Production environment. ## Status This project is still at an alpha stage. It is currently under development -and things may change quickly. -Also, as far as I know it has not been used in Production in any environment yet. - -It builds and successfully allows login/logout to the SPID-TestEnv2 test IdP -(https://github.com/italia/spid-testenv2) and to the online SPID tester -(https://idptest.spid.gov.it). +and things may change quickly. It builds and successfully allows login/logout +to the SPID-TestEnv2 test IdP (https://github.com/italia/spid-testenv2) +and to the online SPID tester (https://idptest.spid.gov.it). +As far as I know it has not been used in Production in any environment yet. -Until the project gets to a stable release, it will be targeting a reasonably recent release +Until the project gets to a stable release, it will be targeting the most recent release of Keycloak as published on the website (see property `version.keycloak` in file `pom.xml`). -Currently the main branch is targeting Keycloak 11.0.0, which unfortunately has a couple of -important regressions impacting SAML identity brokering, however a point release fixing them -is coming soon. -At the moment, I suggest you to test this package by building the latest available sources -for Keycloak yourself and grabbing a couple of extra patches. Detailed instructions are +Currently the main branch is targeting Keycloak 11.0.1. **Do not use this provider with previous +versions of Keycloak, it won't work!** + +If you are evaluating this solution, my suggestion is to test the provider by compiling Keycloak +yourself using the latest available sources, and grabbing a couple of extra patches. Detailed instructions are available in the project wiki (https://github.com/lscorcia/keycloak-spid-provider/wiki/Installing-the-SPID-provider). ## Build requirements diff --git a/pom.xml b/pom.xml index 5d2efd1..1049175 100644 --- a/pom.xml +++ b/pom.xml @@ -16,7 +16,7 @@ https://github.com/lscorcia/keycloak-spid-provider - 11.0.0 + 11.0.1 1.8 1.8 false @@ -25,8 +25,8 @@ scm:git:https://github.com/lscorcia/keycloak-spid-provider.git - HEAD - + HEAD + @@ -74,7 +74,7 @@ org.slf4j slf4j-api - 1.7.21 + 1.7.30