Platform Explorer / Nuxeo Platform 5.8

Extension point authenticators

In component org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService

Documentation

Registry for Authentication Plugins. Authentication plugins are responsible for : - generating the authentication prompt (if needed) - get the user identity - set the LoginModule that will be used for Login

Authentication plugin must implement the NuxeoAuthenticationPlugin interface.

Default implementation of Authentication Plugins are : - Form based authentication - HTTP Basic Authentication

Contribution Descriptors

Existing Contributions

Contributions are presented in the same order as the registration order on this extension point. This order is displayed before the contribution name, in brackets.

  • nuxeo-application-definition-5.8.jar 
    <extension point="authenticators" target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService">

    <authenticationPlugin class="org.nuxeo.ecm.mobile.filter.ApplicationFormAuthenticator" enabled="true" name="FORM_WEBENGINE_APPLICATION_AUTH">
      <needStartingURLSaving>true</needStartingURLSaving>
      <parameters>
        <parameter name="UsernameKey">user_name</parameter>
        <parameter name="PasswordKey">user_password</parameter>
      </parameters>
    </authenticationPlugin>

  </extension>
    (?) nuxeo-application-definition-5.8.jar   Override
  • nuxeo-opensocial-container-5.8.jar 
    <extension point="authenticators" target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService">
    <authenticationPlugin class="org.nuxeo.ecm.platform.ui.web.auth.plugins.FormAuthenticator" enabled="true" name="OPENSOCIAL_FORM_AUTH">
      <needStartingURLSaving>true</needStartingURLSaving>
      <parameters>
        <parameter name="LoginPage">opensocial_login.jsp</parameter>
        <parameter name="UsernameKey">user_name</parameter>
        <parameter name="PasswordKey">user_password</parameter>
      </parameters>
    </authenticationPlugin>
  </extension>
    (?) nuxeo-opensocial-container-5.8.jar   Override
  • nuxeo-platform-web-common-5.8.jar 
    <extension point="authenticators" target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService">

    <authenticationPlugin class="org.nuxeo.ecm.platform.ui.web.auth.plugins.FormAuthenticator" enabled="true" name="FORM_AUTH">
      <needStartingURLSaving>true</needStartingURLSaving>
      <parameters>
        <parameter name="LoginPage">login.jsp</parameter>
        <parameter name="UsernameKey">user_name</parameter>
        <parameter name="PasswordKey">user_password</parameter>
      </parameters>
    </authenticationPlugin>

    <authenticationPlugin class="org.nuxeo.ecm.platform.ui.web.auth.plugins.BasicAuthenticator" enabled="true" name="BASIC_AUTH">
      <needStartingURLSaving>false</needStartingURLSaving>
      <stateful>false</stateful>
      <parameters>
        <parameter name="RealmName">Nuxeo 5 EP</parameter>
        <parameter name="AutoPrompt">false</parameter>
        <parameter name="ForcePromptURL_RSS">
          getSyndicationDocument.faces
        </parameter>
        <parameter name="ForcePromptURL_RSS_SEARCH">
          getSyndicationSearch.faces
        </parameter>
        <parameter name="ForcePromptURL_Restlet">restAPI/</parameter>
        <parameter name="ForcePromptURL_WebEngineRest">site/api/</parameter>
        <parameter name="ForcePromptURL_WebEngineRSS">site/sites/@rss/</parameter>
        <parameter name="ForcePromptURL_WebEngineBlogsRSS">site/blogs/@rss/</parameter>
      </parameters>
    </authenticationPlugin>

    <authenticationPlugin class="org.nuxeo.ecm.platform.ui.web.auth.plugins.AnonymousAuthenticator" enabled="true" name="ANONYMOUS_AUTH">
      <loginModulePlugin>Trusting_LM</loginModulePlugin>
    </authenticationPlugin>

    <authenticationPlugin class="org.nuxeo.ecm.platform.ui.web.auth.plugins.WebServicesAuthenticator" enabled="true" name="WEBSERVICES_AUTH">
      <parameters>
        <parameter name="URLSkip">webservices/</parameter>
      </parameters>
    </authenticationPlugin>
  </extension>
    (?) nuxeo-platform-web-common-5.8.jar   Override
  • nuxeo-platform-login-digest-5.8.jar 
    <extension point="authenticators" target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService">
    <authenticationPlugin class="org.nuxeo.ecm.ui.web.auth.digest.DigestAuthenticator" enabled="true" name="DIGEST_AUTH">
      <stateful>false</stateful>
      <loginModulePlugin>DigestLoginPlugin</loginModulePlugin>
    </authenticationPlugin>
  </extension>
    (?) nuxeo-platform-login-digest-5.8.jar   Override
  • nuxeo-web-mobile-dm-5.8.jar 
    <extension point="authenticators" target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService">
    <authenticationPlugin class="org.nuxeo.ecm.platform.ui.web.auth.plugins.BasicAuthenticator" enabled="true" name="BASIC_AUTH_STATEFUL">
      <needStartingURLSaving>true</needStartingURLSaving>
      <stateful>true</stateful>
      <parameters>
        <parameter name="UsernameKey">username</parameter>
        <parameter name="PasswordKey">password</parameter>
      </parameters>
    </authenticationPlugin>
  </extension>
    (?) nuxeo-web-mobile-dm-5.8.jar   Override
  • nuxeo-webengine-sites-5.8.jar 
    <extension point="authenticators" target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService">
    <authenticationPlugin class="org.nuxeo.ecm.platform.ui.web.auth.plugins.BasicAuthenticator" enabled="true" name="BASIC_AUTH">
      <parameters>
         <parameter name="ForcePromptURL_RSS_WEBENGINE_PAGE">
          site/sites/@rss
          </parameter>
      </parameters>
    </authenticationPlugin>
  </extension>
    (?) nuxeo-webengine-sites-5.8.jar   Override
  • nuxeo-automation-server-5.8.jar 
    <extension point="authenticators" target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService">
    <authenticationPlugin class="org.nuxeo.ecm.platform.ui.web.auth.plugins.BasicAuthenticator" enabled="true" name="AUTOMATION_BASIC_AUTH">
      <parameters>
        <parameter name="AutoPrompt">true</parameter>
        <parameter name="RealmName">Nuxeo Automation</parameter>
      </parameters>
    </authenticationPlugin>
  </extension>
    (?) nuxeo-automation-server-5.8.jar   Override
  • nuxeo-webengine-blogs-5.8.jar 
    <extension point="authenticators" target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService">
    <authenticationPlugin class="org.nuxeo.ecm.platform.ui.web.auth.plugins.BasicAuthenticator" enabled="true" name="BASIC_AUTH">
      <parameters>
         <parameter name="ForcePromptURL_RSS_WEBENGINE_BLOG">
          site/blogs/@rss
          </parameter>
      </parameters>
    </authenticationPlugin>
  </extension>
    (?) nuxeo-webengine-blogs-5.8.jar   Override
  • nuxeo-webengine-core-5.8.jar 
    <extension point="authenticators" target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService">
    <authenticationPlugin class="org.nuxeo.ecm.webengine.login.WebEngineFormAuthenticator" enabled="true" name="WEBENGINE_FORM_AUTH">
      <needStartingURLSaving>true</needStartingURLSaving>
      <parameters>
        <parameter name="UsernameKey">username</parameter>
        <parameter name="PasswordKey">password</parameter>
      </parameters>
      <stateful>false</stateful>
    </authenticationPlugin>
  </extension>
    (?) nuxeo-webengine-core-5.8.jar   Override
  • nuxeo-opencmis-bindings-5.8.jar 
    <extension point="authenticators" target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService">
    <authenticationPlugin class="org.nuxeo.ecm.platform.ui.web.auth.plugins.BasicAuthenticator" enabled="true" name="BASIC_AUTH">
      <parameters>
        <parameter name="ForcePromptURL_CMISAtomPub">atom/cmis</parameter>
      </parameters>
    </authenticationPlugin>
  </extension>
    (?) nuxeo-opencmis-bindings-5.8.jar   Override
  • nuxeo-opencmis-bindings-5.8.jar 
    <extension point="authenticators" target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService">
    <authenticationPlugin class="org.nuxeo.ecm.platform.ui.web.auth.plugins.BasicAuthenticator" enabled="true" name="BASIC_AUTH">
      <parameters>
        <parameter name="ForcePromptURL_CMISJSON">json/cmis</parameter>
      </parameters>
    </authenticationPlugin>
  </extension>
    (?) nuxeo-opencmis-bindings-5.8.jar   Override
  • nuxeo-webdav-5.8.jar 
    <extension point="authenticators" target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService">
    <authenticationPlugin class="org.nuxeo.ecm.platform.ui.web.auth.plugins.BasicAuthenticator" enabled="true" name="WEBDAV_BASIC_AUTH">
      <parameters>
        <parameter name="AutoPrompt">true</parameter>
        <parameter name="RealmName">Nuxeo WebDAV</parameter>
      </parameters>
    </authenticationPlugin>
  </extension>
    (?) nuxeo-webdav-5.8.jar   Override
  • nuxeo-platform-login-token-5.8.jar 
    <extension point="authenticators" target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService">

    <documentation>
      Authentication plugin using a token to validate
      identity. This token is sent as a HTTP request header.

      The user is
      retrieved looking into a directory mapping unique tokens to user
      names.

      This Authentication Plugin is configured to be
      used with the
      Trusting_LM LoginModule plugin
      =&gt; no password check will
      be done, a
      principal will be created
      from the userName if the user exists in
      the
      user directory.

      @author
      Antoine Taillefer (ataillefer@nuxeo.com)
    </documentation>

    <authenticationPlugin class="org.nuxeo.ecm.platform.ui.web.auth.token.TokenAuthenticator" enabled="true" name="TOKEN_AUTH">
      <loginModulePlugin>Trusting_LM</loginModulePlugin>
    </authenticationPlugin>

  </extension>
    (?) nuxeo-platform-login-token-5.8.jar   Override