Build instructions

SSO Extension for eXo Platform:

This extension is created to make easier the integration of an sso server within eXo Platform. We are going to explain the steps of integration for each SSO server: CAS, JOSSO, openAM.

System requirements

Recent Git client
Java Development Kit 1.6
Recent Maven 3
eXo Platform server 3.5.4. PLF_HOME is the location of the unzipped eXo server.
The eXo server will run on port 8080, make sure this port is not currently in use
Prepare an sso server (cas, openAM, JOSSO). The SSO server will run on port 8888, make sure this port is not currently in use
Download the sso-packaging from this link: https://repository.jboss.org/nexus/content/groups/public/org/gatein/sso/sso-packaging/1.1.1-GA/. SSO_HOME refers to the directory where you made your download.

Build instructions

Clone this project

git clone [email protected]:exo-addons/sso-extension.git PROJECT_HOME is the directory where you cloned the project. cd sso-extension

Build the project

mvn clean install

After a build success of the project you will have:

sso-extension.war under PROJECT_HOME/sso-extension/webapp/target.
exo.platform.sso-extension.component.sso-extensible-filter-0.1.jar under PROJECT_HOME/sso-extension/component/sso-extensible-filter/target.
exo.platform.sso-extension.config-0.1.jar under PROJECT_HOME/sso-extension/config/target.
sso-extension.ear under PROJECT_HOME/sso-extension/ear/target.

SSO integration steps:

CAS server

Move the jar exo.platform.sso-extension.component.sso-extensible-filter-0.1.jar under PROJECT_HOME/sso-extension/component/sso-extensible-filter/target to PLF_HOME/lib
Move the jar exo.platform.sso-extension.config-0.1.jar under PROJECT_HOME/sso-extension/config/target to PLF_HOME/lib.
In Tomcat, Move the war sso-extension.war under PROJECT_HOME/sso-extension/webapp/target to PLF_HOME/webapp.
In JBoss AS, Move the ear sso-extension.ear under PROJECT_HOME/sso-extension/ear/target to PLF_HOME/server/default/deploy.

If you are working with eXo Platform packaged with tomcat so edit PLF_HOME/webapps/portal.war/META-INF/context.xml and add ServletAccessValve into configuration as first sub-element of Context:

                  <Context path='/portal' docBase='portal' ... >
                     <Valve className='org.gatein.sso.agent.tomcat.ServletAccessValve' />
                     ...
                  </Context>

In JBoss AS, edit gatein.ear/META-INF/gatein-jboss-beans.xml and uncomment on this section:

                   <authentication>
                       <login-module code="org.gatein.sso.agent.login.SSOLoginModule" flag="required">
                         <module-option name="portalContainerName">portal</module-option>
                         <module-option name="realmName">gatein-domain</module-option>
                       </login-module>
                       <login-module code="org.exoplatform.services.security.j2ee.JbossLoginModule" flag="required">
                         <module-option name="portalContainerName">portal</module-option>
                         <module-option name="realmName">gatein-domain</module-option>
                       </login-module>
                     </authentication>

In Tomcat, edit PLF_HOME/conf/jaas.conf, uncomment on this section and comment other parts:

                   org.gatein.sso.agent.login.SSOLoginModule required;
                   org.exoplatform.services.security.j2ee.TomcatLoginModule required
                   portalContainerName=portal
                   realmName=gatein-domain;

Replace the entire contents of PLF_HOME/platform-extension.war/login/jsp/login.jsp with:

                    <html>
                       <head>
                         <script type="text/javascript">
                          window.location = '/portal/sso';
                         </script>
                       </head>
                       <body>
                       </body>
                     </html>

Move the jars under SSO_HOME/gatein-sso-1.1.1-GA/cas/gatein.ear/lib to the PLF_HOME/lib

Edit PLF_HOME/gatein/conf/configuration.properties and add the following properties:

                  ########################
                  # SSO-EXTENSION
                  ########################

                  #Single Sign On server address
                  sso.server.url=http://localhost:8888/cas
                  #Portal Server domain name
                  sso.platform.url=http://localhost:8080/portal
                  #SSO Server Type
                  sso.server.type=cas
                  #Cas parameter to renew the ticket or not on each authentication
                  sso.cas.renew.ticket=false

JOSSO server

Move the jar exo.platform.sso-extension.component.sso-extensible-filter-0.1.jar under PROJECT_HOME/sso-extension/component/sso-extensible-filter/target to PLF_HOME/lib
Move the jar exo.platform.sso-extension.config-0.1.jar under PROJECT_HOME/sso-extension/config/target to PLF_HOME/lib.
Move the war sso-extension.war under PROJECT_HOME/sso-extension/webapp/target to PLF_HOME/webapp.

If you are working with eXo Platform packaged with tomcat so edit PLF_HOME/webapps/portal.war/META-INF/context.xml and add ServletAccessValve into configuration as first sub-element of Context:

                  <Context path='/portal' docBase='portal' ... >
                     <Valve className='org.gatein.sso.agent.tomcat.ServletAccessValve' />
                     ...
                  </Context>

In JBoss AS, edit gatein.ear/META-INF/gatein-jboss-beans.xml and uncomment on this section:

                   <authentication>
                       <login-module code="org.gatein.sso.agent.login.SSOLoginModule" flag="required">
                         <module-option name="portalContainerName">portal</module-option>
                         <module-option name="realmName">gatein-domain</module-option>
                       </login-module>
                       <login-module code="org.exoplatform.services.security.j2ee.JbossLoginModule" flag="required">
                         <module-option name="portalContainerName">portal</module-option>
                         <module-option name="realmName">gatein-domain</module-option>
                       </login-module>
                     </authentication>

In Tomcat, edit PLF_HOME/conf/jaas.conf, uncomment on this section and comment other parts:

                   org.gatein.sso.agent.login.SSOLoginModule required;
                   org.exoplatform.services.security.j2ee.TomcatLoginModule required
                   portalContainerName=portal
                   realmName=gatein-domain;

Replace the entire contents of PLF_HOME/platform-extension.war/login/jsp/login.jsp with:

                    <html>
                       <head>
                         <script type="text/javascript">
                          window.location = '/portal/sso';
                         </script>
                       </head>
                       <body>
                       </body>
                     </html>

Move the jars under SSO_HOME/gatein-sso-{version}/josso/gatein.ear/lib to the PLF_HOME/lib

Edit PLF_HOME/gatein/conf/configuration.properties and add the following properties:

                  ########################
                  # SSO-EXTENSION
                  ########################

                  #Single Sign On server address
                  sso.server.url=http://localhost:8888/josso/signon/login.do
                  #Portal Server domain name
                  sso.platform.url=http://localhost:8080/portal
                  #SSO Server Type
                  sso.josso.server.type=josso

OpenAM server

Move the jar exo.platform.sso-extension.component.sso-extensible-filter-0.1.jar under PROJECT_HOME/sso-extension/component/sso-extensible-filter/target to PLF_HOME/lib
Move the jar exo.platform.sso-extension.config-0.1.jar under PROJECT_HOME/sso-extension/config/target to PLF_HOME/lib.
Move the war sso-extension.war under PROJECT_HOME/sso-extension/webapp/target to PLF_HOME/webapp.

If you are working with eXo Platform packaged with tomcat so edit PLF_HOME/webapps/portal.war/META-INF/context.xml and add ServletAccessValve into configuration as first sub-element of Context:

                  <Context path='/portal' docBase='portal' ... >
                     <Valve className='org.gatein.sso.agent.tomcat.ServletAccessValve' />
                     ...
                  </Context>

In JBoss AS, edit gatein.ear/META-INF/gatein-jboss-beans.xml and uncomment on this section:

                   <authentication>
                       <login-module code="org.gatein.sso.agent.login.SSOLoginModule" flag="required">
                         <module-option name="portalContainerName">portal</module-option>
                         <module-option name="realmName">gatein-domain</module-option>
                       </login-module>
                       <login-module code="org.exoplatform.services.security.j2ee.JbossLoginModule" flag="required">
                         <module-option name="portalContainerName">portal</module-option>
                         <module-option name="realmName">gatein-domain</module-option>
                       </login-module>
                     </authentication>

In Tomcat, edit PLF_HOME/conf/jaas.conf, uncomment on this section and comment other parts:

                   org.gatein.sso.agent.login.SSOLoginModule required;
                   org.exoplatform.services.security.j2ee.TomcatLoginModule required
                   portalContainerName=portal
                   realmName=gatein-domain;

Replace the entire contents of PLF_HOME/platform-extension.war/login/jsp/login.jsp with:

                    <html>
                       <head>
                         <script type="text/javascript">
                          window.location = '/portal/sso';
                         </script>
                       </head>
                       <body>
                       </body>
                     </html>

Move the jars under SSO_HOME/gatein-sso-1.1.1-GA/openAM/gatein.ear/lib to the PLF_HOME/lib

Edit PLF_HOME/gatein/conf/configuration.properties and add the following properties:

                  ########################
                  # SSO-EXTENSION
                  ########################

                  #Single Sign On server address
                  sso.server.url=http://localhost:8888/opensso
                  #Portal Server domain name
                  sso.platform.url=http://localhost:8080/portal
                  #SSO Server Type
                  sso.server.type=openAM
                  #The name of the registred openAM cookie where openAM SSO ticket is stored
                  sso.openam.cookie.name=iPlanetDirectoryPro

Troubleshooting

Maven dependencies issues

While Platform should build without any extra maven repository configuration it may happen that the build complains about missing artifacts.

If you encounter this situation, please let us know via our forums (http://forum.exoplatform.org).

As a quick workaround you may try setting up maven repositories as follows.

Create file settings.xml in $HOME/.m2 (%HOMEPATH%.m2 on Windows) with the following content:

jboss-public-repository jboss-public-repository-group JBoss Public Maven Repository Group https://repository.jboss.org/nexus/content/groups/public-jboss/ default true never true never jboss-public-repository-group JBoss Public Maven Repository Group https://repository.jboss.org/nexus/content/groups/public-jboss/ default true never true never

 <profile>
   <id>exo-public-repository</id>
   <repositories>
     <repository>
       <id>exo-public-repository-group</id>
       <name>eXo Public Maven Repository Group</name>
       <url>http://repository.exoplatform.org/content/groups/public</url>
       <layout>default</layout>
       <releases>
         <enabled>true</enabled>
         <updatePolicy>never</updatePolicy>
       </releases>
       <snapshots>
         <enabled>true</enabled>
         <updatePolicy>never</updatePolicy>
       </snapshots>
     </repository>
   </repositories>
   <pluginRepositories>
     <pluginRepository>
       <id>exo-public-repository-group</id>
       <name>eXo Public Maven Repository Group</name>
       <url>http://repository.exoplatform.org/content/groups/public</url>
       <layout>default</layout>
       <releases>
         <enabled>true</enabled>
         <updatePolicy>never</updatePolicy>
       </releases>
       <snapshots>
         <enabled>true</enabled>
         <updatePolicy>never</updatePolicy>
       </snapshots>
     </pluginRepository>
   </pluginRepositories>
 </profile>

jboss-public-repository exo-public-repository

Going Further

learn more about using the features in the User Manuals: http://docs.exoplatform.com/PLF35/topic/org.exoplatform.doc.35/UserGuide.html

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

System requirements

Build instructions

SSO integration steps:

Troubleshooting

Maven dependencies issues

Going Further

About

Uh oh!

Releases

Packages

Name		Name	Last commit message	Last commit date
Latest commit History 7 Commits
component		component
config		config
ear		ear
webapp		webapp
.gitignore		.gitignore
README.md		README.md
pom.xml		pom.xml

rtouzi/sso-extension

Folders and files

Latest commit

History

Repository files navigation

System requirements

Build instructions

SSO integration steps:

Troubleshooting

Maven dependencies issues

Going Further

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Packages