Stages Documentation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
261:integration:saml [2026/04/27 09:56] – [Configure the SAML Service Provider (SP)] Weinlein, Thomas261:integration:saml [2026/04/28 09:04] (current) – [Configure signing] Weinlein, Thomas
Line 1: Line 1:
-====== Configure SAML Authentication (work in progress) ======+====== Configure SAML Authentication ======
  
 SAML stands for Security Assertion Markup Language. It is a current standard for authenticating users in a distributed system. SAML stands for Security Assertion Markup Language. It is a current standard for authenticating users in a distributed system.
Line 58: Line 58:
 sp.saml.keystore.password = SECRET sp.saml.keystore.password = SECRET
 </code> </code>
 +
 +//Please make sure to call **''update.sh|bat''** after enabling or disabling SAML and restart Stages.//
  
  
 ===== Generate the SAML SP metadata ===== ===== Generate the SAML SP metadata =====
  
-After configuring the SAML SP and logged on as root, you can download the SAML SP metadata directly by navigating to the URL ''[[http://<yourstages|https://<yourstages]]>/stages/rest/saml/metadata''+When you are done with generating the keystore and other service provider attributes, you should add the following line to the authentication method section from above to generate the sp-metadata.xml file for the SAML IdP administrators
  
-For SP metadata generated correctly the whole authentication section must be present in config.xml : [[https://doc.stagesasaservice.com/712/integration/saml#configure-the-saml-identity-provider-idp]]+<code xml> 
 +    <authentication> 
 +        [...] 
 +        <method type="SAML2" name="saml-idp" enabled="${idp.saml.enabled}"> 
 +            <properties> 
 +                [...] 
 +                <property name="serviceProviderMetadataPath" value="${sp.saml.metadata.path}"/> 
 +                [...] 
 +            </properties> 
 +        </method> 
 +    </authentication> 
 +</code>
  
-The resulting XML file can be sent to the SAML IdP administrators and contains all information necessary to set up the trust relationship on the IdP side. After the SAML IdP has been configured with the SP metadata, users will be able to authenticate successfully with Stages through the SAML IdP.+''conf/config.properties''
  
-=====   =====+<code properties> 
 +sp.saml.metadata.path=file:data-cache/generated/sp-metadata.xml 
 +</code>
  
 +Restart Stages and access the Login page. The sp-metadata.xml should now be generated.
  
-===== Configure the SAML Identity Provider (IdP) =====+The resulting XML file can be sent to the SAML IdP administrators and contains all information necessary to set up the trust relationship on the IdP side.
  
-The SAML Identity Provider describes the remote service that Stages uses to authenticate users. Typically, it is run by the access management group within your IT organization.+//Please note that you need to delete the sp-metadata.xml file whenever you change the service provider configuration. An existing file will never be updated//
  
-The most reliable way to configure the SAML Identity Provider (IdP) is to ask the access management team for the IdP metadata.+After the SAML IdP has been configured with the SP metadata, you will receive an idp-metadata.xml file with the IDP specific part of the SAML configuration.
  
-From this metadata, you will be able to derive the parameters 
  
-  * EntityIdfromMetadata+===== Configure the SAML Identity Provider (IdP) =====
  
-  * SingleSignOnServiceLocationFromMetadata (should be HTTPS, please see [[:general:saml-note-samesite]])+The SAML Identity Provider describes the remote service that Stages uses to authenticate users. Typically, it is run by the access management group within your IT organization.
  
-  * DisplayName (alternative: FirstName, LastName)+The most reliable way to configure the SAML Identity Provider (IdP) is to ask the access management team for the IdP metadata.
  
-  * EMailAddress+Store this metadata in ''conf/secret/idp-metadata.xml'' and add the following configuration to  
 +''conf/config.xml'' 
 +<code xml> 
 +<method type="SAML2" name="saml-idp" enabled="${idp.saml.enabled}"> 
 +    <properties> 
 +        [...] 
 +        <property name="identityProviderMetadataPath" value="${idp.saml.metadata.path}"/> 
 +        [...] 
 +    </properties> 
 +    [...] 
 +</method> 
 +</code>
  
-for the following configuration: +''conf/config.properties'' 
- +<code properties> 
-<code -> +idp.saml.metadata.path = file:conf/secret/idp-metadata.xml 
-<authentication +</code>
-     enabled="true" +
-     keystoreFile="/opt/stages/conf/saml-keystore.jks" +
-     keystorePass="changeit"> +
- +
-    <service-provider +
-         providerId="yourStagesURL" +
-         keyAlias="samlkeyalias"> +
- +
-    </service-provider> +
- +
-    <identity-provider +
-        providerId="EntityIDfromMetadata" +
-        providerUrl="SingleSignOnServiceLocationFromMetadata" +
-        nameIdPolicyFormat="urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified" +
-        sendBinding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" +
-        userFullnameTemplate="%firstname% %lastname%"> +
- +
-        <!-- userFullnameTemplate is used to build the user's full name from multiple IDP attributes +
-             as defined below as <identity-provider-attribute name=.../>. +
-             In the example above the firstname and lastname attributes are concatenated speparated by a space. --> +
- +
-        <!-- hardcoded magic value that specifies the NameID from the SAML reply --> +
-        <identity-provider-attribute name="username" id="http://schemas.stages.methodpark.com/saml/v2/identity/claims/subject" /> +
- +
-        <!-- either "fullname" or "firstname" and "lastname" need to be defined --> +
-        <!--<identity-provider-attribute name="fullname" id="DisplayName" />--> +
-        <identity-provider-attribute name="firstname" id="FirstName" /> +
-        <identity-provider-attribute name="lastname" id="LastName" /> +
- +
-        <identity-provider-attribute name="email" id="EMailAddress" /> +
- +
-        <!-- This matches if the SAML assertion contains a SAML attribute "Organization" with value "External" --> +
-        <!-- +
-        <identity-provider-attribute-match +
-            id="Organization" +
-            pattern="External" +
-            defaultRolesUsername="default_supplier" +
-            defaultLicenseType="DEV" +
-            licensePoolIdent="" +
-            autocreateUser="true" +
-                    /> +
-        -->+
  
 +A complete SAML configuration should then look like that:
 +<code xml>
 +<method type="SAML2" name="saml-idp" enabled="${idp.saml.enabled}">
 +    <properties>
 +        <property name="serviceProviderEntityId" value="${sp.id}"/>
 +        <property name="keystorePath" value="${sp.saml.keystore.path}"/>
 +        <property name="keystorePassword" value="${sp.saml.keystore.password}"/>
 +        <property name="privateKeyPassword" value="${sp.saml.keystore.password}"/>
 +        <property name="keyStoreAlias" value="${sp.saml.keystore.keyAlias}"/>
 +        <property name="serviceProviderMetadataPath" value="${sp.saml.metadata.path}"/>
 +        <property name="identityProviderMetadataPath" value="${idp.saml.metadata.path}"/>
 +        <property name="nameIdPolicyFormat" value="urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" />
 +        <property name="mappedAttributes(_subject_nameid_)" value="username"/>
 +        <property name="mappedAttributes(${idp.saml.attribute.firstname})" value="firstname"/>
 +        <property name="mappedAttributes(${idp.saml.attribute.lastname})" value="lastname"/>
 +        <property name="mappedAttributes(${idp.saml.attribute.email})" value="email"/>
 +        <property name="internal.userFullnameTemplate" value="${idp.saml.fullname.template}"/>
 +    </properties>
 +    <filters>
         <!-- This is the default matcher, identified by id and pattern attributes set to "*" -->         <!-- This is the default matcher, identified by id and pattern attributes set to "*" -->
-        <identity-provider-attribute-match +        <attribute-match 
-            id="*" +                id="*" 
-            pattern="*" +                pattern="*" 
-            defaultRolesUsername="default" +                defaultUserGroupsUsername="${user.default.username}" 
-            defaultLicenseType="QM" +                defaultLicenseType="${user.default.licenseType}" 
-            licensePoolIdent="" +                autocreateUser="${idp.saml.autocreate}"
-            autocreateUser="true"+
         />         />
 +    </filters>
 +</method>
 +</code>
  
-        <!-- +''conf/config.properties'' 
-            Specifying at least one signing certificate automatically enables +<code properties> 
-            signature verification of the authentication response. +sp.id = https://stages.example.com 
-            The key data can also be copied from the IdP metadata. +#needs to be generated. Path needs to be relative to ${STAGES_ROOT} 
-            If no signing certificate is specified, no signature +sp.saml.keystore.path = file:conf/secret/saml-keystore.pk12 
-            validation will be performed. +#will be generated on first login page access (path needs to be relative to ${STAGES_ROOT}) 
-        --> +sp.saml.metadata.path = file:data-cache/generated/saml-sp-metadata.xml
-        <certificate use="signing">${saml.idp.signatureCertificate}+
  
-       <!-- MIIDCTCC...Qwgf5bXby+ug==   --> +idp.saml.enabled = false 
-        </certificate>+#exported metadata from SAML IDP (path needs to be relative to ${STAGES_ROOT}) 
 +idp.saml.metadata.path = file:conf/secret/saml-idp-metadata.xml 
 +idp.saml.attribute.firstname = urn:oid:2.5.4.42 
 +idp.saml.attribute.lastname = urn:oid:2.5.4.4 
 +idp.saml.attribute.email = urn:oid:1.2.840.113549.1.9.1 
 +idp.saml.fullname.template = %firstname% %lastname% 
 +idp.saml.autocreate = true
  
-        <!-- +user.default.username = default 
-             In case the IDP only provides encrypted assertions specify +user.default.licenseType = AuthPsReader
-             encryption certifacte. The key data can also be copied from the +
-             IdP metadata. If no encryption certificate is specified, no encrypted +
-             assertion can be accepted. +
-        --> +
-        <certificate use="encryption">${saml.idp.encryptionCertificate} +
-                <!-- MIIDCTCC...Qwgf5bXby+ug==  --> +
-       </certificate> +
-    </identity-provider> +
- +
-    <!-- +
-        This identity provider statement with the "STAGES" +
-        magic id enables local Stages logins to be available +
-        for selection between multiple identity providers +
-        (NOT IMPLEMENTED YET). +
-        If the authentication with the IdP fails and the "STAGES" +
-        provider is enabled, the Stages login screen is shown, so +
-        the user may log in with a local user id. If it is not +
-        configured, the server answers with a 403 (Forbidden) +
-        status code. +
-    --> +
-    <identity-provider providerId="STAGES"/> +
-</authentication>+
 </code> </code>
  
Line 186: Line 174:
 ===== Changing the license pool and license type for existing users ===== ===== Changing the license pool and license type for existing users =====
  
-''By default, existing users are not modified by the SAML authentication process when the SAML configuration was changed after the user had been created. However, you can set the ''forceLicensePoolReassignment''  attribute on an ''identity-provider-attribute-match'' to ''true'' if you want changes of the ''licensePoolIdent''  or ''defaultLicenseType''  attributes to be applied to existing users.  ''+''By default, existing users are not modified by the SAML authentication process when the SAML configuration was changed after the user had been created. However, you can set the ''forceLicensePoolReassignment''  attribute on an ''attribute-match'' to ''true'' if you want changes of the ''licensePoolIdent''  or ''defaultLicenseType''  attributes to be applied to existing users.  ''
  
 ===== Configuring Stages attributes in default-matcher section with JavaScript ===== ===== Configuring Stages attributes in default-matcher section with JavaScript =====
  
-''JavaScript control flow statements (e.g. "if","switch") can be used to configure values for Stages attributes. All assertion attributes of the SAML response are accessible as variables and can be used in the JavaScript expression  JavaScript expressions can be used with the following Stages attributes:    * defaultRolesUsername   * defaultLicenseType   * licensePoolIdent  **General JavaScript expression notation:**  <code> <Stages_attribute>="=<JavaScript_expression>"  </code>  **JavaScript notation of if-clauses:**  <code> if (condition1) 'returnValue1'; else if (condition2) 'returnValue2'; else if (condition3) 'returnValue3'; else 'returnValue4';  </code>  **JavaScript notation of value conditions:**  SAML Attributes that are defined via identity_provider_attribute elements can be used in these scripts. E.g.  <code> <identity-provider-attribute name="email" id="<EMailAddress>" />  </code>  <code> Attribute contains value:  </code>  <code> <saml_attribute_id>.match(/.*value/)         // <= 7.9.10.0, <= 7.10.1.0 <saml_attribute_name>.match(/.*value/)       //> 7.9.10.0,> 7.10.1.0  </code>  Attribute equals value:  <code> <saml_attribute_id>=="value                 // <= 7.9.10.0, <= 7.10.1.0 <saml_attribute_name>=="value               //> 7.9.10.0,> 7.10.1.0  </code>  **Names of license types for license assignment**  ^License name^License type^ |Modeler|QM| |Contributor|FloatingADev| |Participant|FloatingDev| |Project Manager|FloatingPM| |Viewer|AuthPsReader|  **Example configuration:** ''\\ '' ''\\ ''This example creates Stages users with the following conditions:    * The pattern matches the entry of the SAML attribute "id".   * Depending on the users' email address (domain-part), SAML attribute name "email" is used to assign different values for defaultRolesUsername, defaultLicenseType and licensePoolIdent  <code> <identity-provider-attribute-match      id="<saml_attribute_id>"      pattern="<matching_value>"      defaultRolesUsername="=         if (email.match(/.*@company1.com/)) 'User1';         else if (email.match(/.*@company2.com/)) 'User2';         else 'default';         "      defaultLicenseType="=         if (email.match(/.*@company1.com/)) 'QM';         else if (email.match(/.*@company2.com/)) 'PM';         else 'none';         "      licensePoolIdent="=           if (email.match(/.*@company2.com/)) 'company2';         else '';+JavaScript control flow statements (e.g. "if","switch") can be used to configure values for Stages attributes. All assertion attributes of the SAML response are accessible as variables and can be used in the JavaScript expression  JavaScript expressions can be used with the following Stages attributes:    * defaultRolesUsername   * defaultLicenseType   * licensePoolIdent  **General JavaScript expression notation:**  
  
-        " +<code javascript> <Stages_attribute>="=<JavaScript_expression>"   
-     autocreateUser="true"+</code>  
  
-/>+**JavaScript notation of if-clauses:**   
 +<code javascript> if (condition1) 'returnValue1'; else if (condition2) 'returnValue2'; else if (condition3) 'returnValue3'; else 'returnValue4';   
 +</code>  
  
 +**JavaScript notation of value conditions:
 +**  SAML Attributes that are defined via identity_provider_attribute elements can be used in these scripts. E.g.  
 +<code xml> 
 +<identity-provider-attribute name="email" id="<EMailAddress>" />  
 +</code>  
 +
 +**Names of license types for license assignment**
 +^License name^License type^ 
 +|Modeler|QM| 
 +|Contributor|FloatingADev| 
 +|Participant|FloatingDev| 
 +|Project Manager|FloatingPM| 
 +|Viewer|AuthPsReader|  
 +
 +**Example configuration:** 
 +''\\ '' ''\\ ''This example creates Stages users with the following conditions:    
 +* The pattern matches the entry of the SAML attribute "id".   
 +* Depending on the users' email address (domain-part), SAML attribute name "email" is used to assign different values for defaultRolesUsername, defaultLicenseType and licensePoolIdent 
 +
 +<code xml> 
 +<attribute-match      
 +    id="[saml_attribute_id]"
 +    pattern="[matching_value]"      
 +    defaultRolesUsername="= if (email.match(/.*@company1.com/)) 'User1';         
 +                       else if (email.match(/.*@company2.com/)) 'User2'; 
 +                       else 'default';         " 
 +    defaultLicenseType="= if (email.match(/.*@company1.com/)) 'QM';
 +                 else if (email.match(/.*@company2.com/)) 'PM';         
 +                 else 'none';         "      
 +    licensePoolIdent="= if (email.match(/.*@company2.com/)) 'company2'; 
 +             else '';"
 +    autocreateUser="true"
 +/>
 </code> </code>
  
Line 204: Line 227:
 ===== Configure the SAML Request Type ===== ===== Configure the SAML Request Type =====
  
-The default binding type of the SAML Request is ''redirect''.+The default binding type of the SAML Request is ''POST''.
  
-Some IDPs do not work with that type and rather need a POST Request. This can only be found out on the IDP.+Some IDPs do not work with that type and rather need a "REDIRECT". This can only be found out on the IDP.
  
-This can be configured in the ''identity-provider''  section via+This can be configured in the authentication method properties section via
  
-<code> +<code xml> 
-sendBinding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"+<method type="SAML2" name="saml-idp" enabled="${idp.saml.enabled}"> 
 +    <properties> 
 +        [...]            
 +        <property name="authnRequestBindingType" value="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" 
 +        [...] 
 +     </properties> 
 +     [...] 
 + </method> 
 +</code>
  
 +===== Configure signature validation =====
 +
 +By default Stages send authentication requests signed and expects assertions in the response as well as the response itself to be signed.
 +In case this is not supported by the IDP it can be disabled by setting the according property to **false**.
 +
 +//Please use with care as it degrades security.//
 +<code xml>
 +<method type="SAML2" [...]>
 +    <properties> <!-- implicit default values -->
 +        <property name="authnRequestSigned" value="true" />
 +        <property name="wantsAssertionsSigned" value="true" />
 +        <property name="wantsResponsesSigned" value="true" />
 +    </properties>
 +</method>
 +</code>
 +===== Configure multiple SAML IDPs =====
 +
 +Stages does now allow to configure multiple IDPs. Just add another authentication method of type SAML2 and ensure it has an **unique name**. E.g.
 +
 +<code xml>
 +<authentication>
 +    [...]
 +    <method type="SAML2" name="saml-idp-1" enabled="${idp1.saml.enabled}">
 +        [...]
 +    </method>
 +    <method type="SAML2" name="saml-idp-2" enabled="${idp2.saml.enabled}">
 +        [...]
 +    </method>
 +</authentication>
 +</code>
 +
 +This will create a SSO button on the login page for each IDP.
 +Please provide a user understandable naming by defining a translation property for each login.sso.[name] propertyin each supported language:
 +''conf/local.properties'', ''conf/local_de.properties'', ...
 +<code properties>
 +login.sso.saml-idp-1 = Single Sign-On for company 1
 +login.sso.saml-idp-2 = Single Sign-On for company 2
 </code> </code>
  
Line 220: Line 288:
  
   * Azure AD IdP   * Azure AD IdP
-  * Okta +  * Keycloak
-  * JumpCloud +
-  * Cisco Central Web Authentication (CWA) +
-  * Oracle Access Manager (OAM)+
   * Shibboleth IdP   * Shibboleth IdP
-  * Active Directory Federation Services (ADFS) 
  
 Please let us know if you were able to make Stages SAML work with your server and it is not on this list yet. Please let us know if you were able to make Stages SAML work with your server and it is not on this list yet.