Home > Server > Authentication and User Management > SSO with Portals
Server

SSO with Portals

Updated: December 19, 2024

This plugin provides a way to handle identity propagation between an external application and Nuxeo. It was coded to propagate user identify between a JSR168 portal and a Nuxeo server. The goal is to let the external application (ex: the portal) call the Nuxeo API "on behalf" of the interactive users. This ensures that:

  • The app/portal will never display data that should not be visible to the user
  • All actions done via the app/portal will still be logged in the Nuxeo Audit log with the correct information

Server-Side Configuration

To install this authentication plugin:

  1. Download the nuxeo-platform-login-portal-sso plugin. You must be already authenticated on https://packages.nuxeo.com/ ("Sign In with SSO" button) to see this resource.
  2. Put it in $TOMCAT_HOME/nxserver/bundles or $JBOSS_HOME/server/default/deploy/nuxeo.ear/bundles and restart the server.

  3. Put the plugin into the authentication chain. Contribute an XML extension from the following content. Adapt the authenticationChain element content with the list of plugins you want to use.

    <extension
target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService"
point="chain">
<authenticationChain>
  <plugins>
    <plugin>BASIC_AUTH</plugin>
    <plugin>ANONYMOUS_AUTH</plugin>
    <plugin>THE_PLUGIN_I_WANT_TO_USE</plugin>
  </plugins>
</authenticationChain>
</extension>

    Use PORTAL_AUTH.

  4. Create an XML extension with the following content:

    <component name="org.nuxeo.ecm.platform.authenticator.portal.sso.config">

  <require>org.nuxeo.ecm.platform.ui.web.auth.WebEngineConfig</require>
  <require>org.nuxeo.ecm.platform.login.Portal</require>

  <extension target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService" point="authenticators">
    <authenticationPlugin name="PORTAL_AUTH">
      <loginModulePlugin>Trusting_LM</loginModulePlugin>
      <parameters>
        <\!-\- define here shared secret between the portal and Nuxeo server -->
        <parameter name="secret">nuxeo5secretkey</parameter>
        <parameter name="maxAge">3600</parameter>
        <parameter name="digestAlgorithm">MD5</parameter>
      </parameters>
    </authenticationPlugin>
  </extension>
</component>

    Note: Your XML extension's name must end with -config.xml.

  5. Adapt the content of the loginModulePlugin section.

  6. Save.

Client-Side Configuration

Portal_SSO is integrated in Nuxeo Java client.

Using Nuxeo Java Client

Configure it to connect to a server that uses platform-login-portal-sso by using an interceptor:

new NuxeoClient.Builder().authentication(new PortalSSOAuthInterceptor("Administrator", "nuxeo5secretkey"));

Manual HTTP Calls

To do all the calls to Nuxeo yourself, you have to decide which HTTP requests to make, and in addition you'll have to send some specific headers to authenticate. The HTTP headers are:

  • NX_TS: the timestamp, in milliseconds since epoch, when you're generating the request.
  • NX_RD: a few some random characters.
  • NX_USER: the user as whom you want to authenticate.
  • NX_TOKEN: a token proving authentication generated using the algorithm BASE64_MD5(timestamp + ":" + random + ":" + secret + ":" + user)

The token contains the secret but in a hashed form which cannot be reversed by an eavesdropper to generate new requests. The timestamp is used to avoid replay attacks (the delta with the real time on the server cannot be more than the maxAge specified on the server). The random characters are used to avoid pre-computed dictionary attacks.

The following Java code can be used:

import java.security.MessageDigest;
import javax.xml.bind.DatatypeConverter;

public String makeToken(String timestamp, String random, String secret,
        String user) throws Exception {
    String clearToken = timestamp + ":" + random + ":" + secret + ":"
            + user;
    String digestAlgorithm = "MD5"; // or whatever digestAlgorithm was configured on the server
    byte[] digest = MessageDigest.getInstance(digestAlgorithm).digest(clearToken.getBytes());
    return DatatypeConverter.printBase64Binary(digest);
}

As a validation of your code, check that makeToken("1324572561000", "qwertyuiop", "secret", "bob") returns 8y4yXfms/iKge/OtG6d2zg== for the MD5 algorithm.

Related Documentation