SAML2 Authentication Valve check_circle

Breaking Changes

URLs used in SAML have changed:

• The URL suffix to initiate the SAML Authentication process has changed from connectToSaml.do to connect.saml
• The URL suffix for the SAML callback has changed from samlCallback.do to callback.saml
• The URL suffix for SAML metadata has changed from saml2Metadata.do to metadata.saml 

A new siteKey query parameter (for example: *.connect.saml?siteKey={sitekey}) is now mandatory except if SAML is used on a URL with a configured, and unique, Jahia ServerName.

Migrate from SAML 2x

Search in your code, site and SAML configs, for occurences of the above-mentioned suffixes (connectToSaml.do, samlCallback.do, saml2Metadata.do) and replace them with their new value.

Ensure the siteKey parameter is present if the URL is not the same than Jahia ServerName for this site.

For example:

• If "mysite.sample.com" is the Jahia server name for the site "mysite", then the siteKey is not required and a URL such as https://mysite.sample.com/connect.saml can be used.
• If "mysite.sample.com" is NOT Jahia server name for the site "mysite", then the siteKey is required and a URL such as https://mysite.sample.com/connect.saml?siteKey=mysite can be used.

Improvements

• Added compatibility for SAML authentication for fully private website
• Made possible to use SAML suffixes on any URLs (including root), this was previously restricted to pages only
• Ensured the post-login redirect URL is valid according to Jahia redirect restrictions (https://academy.jahia.com/documentation/knowledge-base/setting-authorizedredirecthosts-in-jahia)

See https://academy.jahia.com/documentation/system-administrator/jahia/8/installing-connectors-and-optional-modules/installing-and-configuring-saml2-authentication

MIT License

Copyright (c) 2019 - present Jahia

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.