[gatein-commits] gatein SVN: r8997 - epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity.

Author: smumford Date: 2012-12-12 23:12:57 -0500 (Wed, 12 Dec 2012) New Revision: 8997 Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml Log: BZ856430: Further edits to new JOSSO content Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2012-12-12 14:59:10 UTC (rev 8996) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2012-12-13 04:12:57 UTC (rev 8997) @@ -702,7 +702,7 @@ </para> <para> - After completing all procedures in this section, all links redirecting to the user authentication pages will redirect to the JOSSO centralized authentication form. + After completing the procedures in this section, all links redirecting to the user authentication pages will redirect to the JOSSO centralized authentication form. </para> <section> @@ -713,11 +713,11 @@ </para> <para> - Essentially, after a user clicks to sign in they are redirected to the JOSSO login screen, where they supply the appropriate credentials. They are then redirected back to the Portal. + Briefly; when a user clicks to sign in to a portal they are redirected to the JOSSO login screen, where they supply the appropriate credentials. They are then redirected (with access authorization) back to the Portal. </para> <para> - The <systemitem>JOSSOAgent</systemitem> component performs a validation of the ticket with the JOSSO server via a back channel after the <systemitem>InitiateLoginFilter</systemitem> has delegated the <parameter> josso_assertion_id </parameter> request to it. The JOSSO agent and JOSSO server communicate via web services. + The <systemitem>JOSSOAgent</systemitem> component performs a validation of the authorization ticket with the JOSSO server via a back channel after the <systemitem>InitiateLoginFilter</systemitem> has delegated the <parameter>josso_assertion_id</parameter> request to it. The JOSSO agent and JOSSO server communicate via web services. </para> <para> @@ -729,11 +729,11 @@ </para> <para> - While the authentication plugin (which is able to send REST requests to the portal, receive the response, and authenticate the user on the JOSSO side) is supported, this support is only for JOSSO 1.8 (not JOSSO 2.2 at this release). + While the authentication plugin (which is able to send REST requests to the portal, receive the response, and authenticate the user on the JOSSO side) is supported, this support is only for JOSSO 1.8 (not JOSSO 2.2 as at this release). </para> <para> - In this example, we will assume again that JBoss Portal Platform will be running on JBoss Enterprise Application Platform 6 using port <emphasis role="italics">localhost:8080</emphasis> and that the JOSSO server will be running on Tomcat, using <emphasis role="italics">localhost:8888</emphasis>. + In this section, we will assume that JBoss Portal Platform will be running on JBoss Enterprise Application Platform 6 using port <emphasis role="italics">localhost:8080</emphasis> and that the JOSSO server will be running on Tomcat, using <emphasis role="italics">localhost:8888</emphasis>. </para> <note> @@ -750,16 +750,16 @@ <title>Obtaining JOSSO</title> <para> - JOSSO can be downloaded from <ulink url="http://sourceforge.net/projects/josso/files/"/> . Use the package that embeds Apache Tomcat. + JOSSO can be downloaded from <ulink url="http://sourceforge.net/projects/josso/files/"/>;. Use the package that embeds Apache Tomcat. </para> - + <remark>Docs Note; JOSSO versions up to 1.8.7 are available from this URL. I assume any after 1.8.2 are unsupported. Should we call this out in the docs?</remark> <para> Once downloaded, extract the package into what will be called <replaceable>JOSSO_HOME</replaceable> in this example. </para> </section> <section id="sid-55477376_JOSSO-JOSSOserver"> - <title>JOSSO server</title> + <title>Set Up the JOSSO server</title> <para> This section describes how to set up the JOSSO server to authenticate against the JBoss Portal Platform using the REST authentication plugin. In this example, the JOSSO server will be installed on Tomcat. @@ -770,31 +770,29 @@ <para> <emphasis role="bold">Optional:</emphasis> To use the SSO authentication plugin with JOSSO (not-mandatory but recommended. See <xref linkend="sect-CAS-Authentication_Process"/> for details): </para> - - <para> - Copy the files from <filename>SSO_HOME/josso/josso-<replaceable>&lt;version&gt;</replaceable>/plugin</filename> into the Tomcat directory (<replaceable>JOSSO_HOME</replaceable>). (<replaceable>SSO_HOME</replaceable> points to directory with JBoss Portal Platform as mentioned in <xref linkend="sect-Reference_Guide-SSO_Single_Sign_On"/>) + <substeps> + <step><para> + Copy the files from <filename>SSO_HOME/josso/josso-<replaceable>&lt;version&gt;</replaceable>/plugin/</filename> into <replaceable>JOSSO_HOME</replaceable> directory, as shown below: </para> - - <para> - This action will replace some, and add other, JAR files to the <filename>JOSSO_HOME/webapps/josso/WEB-INF/lib</filename> directory. - </para> - + <para> + Keep in mind that <replaceable>SSO_HOME</replaceable> refers to the JOSSO directory within JBoss Portal Platform as mentioned in <xref linkend="sect-Reference_Guide-SSO_Single_Sign_On"/>. + </para> <itemizedlist> <listitem> <para> - <filename>JOSSO_HOME/lib/josso-gateway-config.xml</filename> + Copy <filename><replaceable>SSO_HOME</replaceable>/josso/josso-<replaceable>&lt;version&gt;</replaceable>/plugin/lib/josso-gateway-config.xml</filename> to <filename><replaceable>JOSSO_HOME</replaceable>/lib/josso-gateway-config.xml</filename>. The original file is being replaced. You should consider creating a backup of it before adding the new file. </para> </listitem> <listitem> <para> - <filename>JOSSO_HOME/lib/josso-gateway-gatein-stores.xml</filename> + Add <filename><replaceable>SSO_HOME</replaceable>/josso/josso-<replaceable>&lt;version&gt;</replaceable>/plugin/lib/josso-gateway-config.xml</filename> to <filename><replaceable>JOSSO_HOME</replaceable>/lib/</filename>. This file is not present in the original <replaceable>JOSSO_HOME</replaceable> download. </para> </listitem> <listitem> <para> - <filename>JOSSO_HOME/webapps/josso/WEB-INF/classes/gatein.properties</filename> + Add <filename>SSO_HOME/josso/josso-<replaceable>&lt;version&gt;</replaceable>/plugin/webapps/josso/WEB-INF/classes/gatein.properties</filename> to <filename>JOSSO_HOME/webapps/josso/WEB-INF/classes/</filename>. This file is not present in the original <replaceable>JOSSO_HOME</replaceable> download. </para> <para> @@ -802,6 +800,8 @@ </para> </listitem> </itemizedlist> + </step> + </substeps> </step> <step>