ソースを参照

Minor doc updates

Luke Taylor 16 年 前
コミット
217cffbdbc

+ 3 - 2
docs/manual/src/docbook/introduction.xml

@@ -217,7 +217,7 @@
                 xlink:href="http://www.springsource.com/download/community?project=Spring%20Security"
                 xlink:href="http://www.springsource.com/download/community?project=Spring%20Security"
                 >download page</link>, download individual jars (and sample WAR files) from the
                 >download page</link>, download individual jars (and sample WAR files) from the
             Maven Central repository (or a SpringSource Maven repository for snapshot and milestone
             Maven Central repository (or a SpringSource Maven repository for snapshot and milestone
-            releases). Alternatively, you can build the project from source yourself. See the
+            releases) or, alternatively, you can build the project from source yourself. See the
             project web site for more details. </para>
             project web site for more details. </para>
         <section xml:id="modules">
         <section xml:id="modules">
             <title>Project Modules</title>
             <title>Project Modules</title>
@@ -233,7 +233,8 @@
                 <para>Contains core authentication and access-contol classes and interfaces,
                 <para>Contains core authentication and access-contol classes and interfaces,
                     remoting support and basic provisioning APIs. Required by any application which
                     remoting support and basic provisioning APIs. Required by any application which
                     uses Spring Security. Supports standalone applications, remote clients, method
                     uses Spring Security. Supports standalone applications, remote clients, method
-                    (service layer) security and JDBC user provisioning. Contains the top-level packages:<itemizedlist><listitem><para><literal>org.springframework.security.core</literal></para></listitem><listitem><para><literal>org.springframework.security.access</literal></para></listitem><listitem><para><literal>org.springframework.security.authentication</literal></para></listitem><listitem><para><literal>org.springframework.security.provisioning</literal></para></listitem><listitem><para><literal>org.springframework.security.remoting</literal></para></listitem></itemizedlist></para>
+                    (service layer) security and JDBC user provisioning. Contains the top-level
+                                    packages:<itemizedlist><listitem><para><literal>org.springframework.security.core</literal></para></listitem><listitem><para><literal>org.springframework.security.access</literal></para></listitem><listitem><para><literal>org.springframework.security.authentication</literal></para></listitem><listitem><para><literal>org.springframework.security.provisioning</literal></para></listitem><listitem><para><literal>org.springframework.security.remoting</literal></para></listitem></itemizedlist></para>
             </section>
             </section>
             <section xml:id="spring-security-web">
             <section xml:id="spring-security-web">
                 <title>Web - <literal>spring-security-web.jar</literal></title>
                 <title>Web - <literal>spring-security-web.jar</literal></title>

+ 37 - 38
docs/manual/src/docbook/namespace-config.xml

@@ -109,12 +109,12 @@
       </programlisting> This provides a hook into the Spring Security web
       </programlisting> This provides a hook into the Spring Security web
         infrastructure. <classname>DelegatingFilterProxy</classname> is a Spring Framework class
         infrastructure. <classname>DelegatingFilterProxy</classname> is a Spring Framework class
         which delegates to a filter implementation which is defined as a Spring bean in your
         which delegates to a filter implementation which is defined as a Spring bean in your
-        application context. In this case, the bean is named "springSecurityFilterChain", which is
-        an internal infrastructure bean created by the namespace to handle web security. Note that
-        you should not use this bean name yourself. Once you've added this to your
-          <filename>web.xml</filename>, you're ready to start editing your application context file.
-        Web security services are configured using the <literal>&lt;http&gt;</literal> element.
-      </para>
+        application context. In this case, the bean is named
+          <quote>springSecurityFilterChain</quote>, which is an internal infrastructure bean created
+        by the namespace to handle web security. Note that you should not use this bean name
+        yourself. Once you've added this to your <filename>web.xml</filename>, you're ready to start
+        editing your application context file. Web security services are configured using the
+          <literal>&lt;http&gt;</literal> element. </para>
     </section>
     </section>
     <section xml:id="ns-minimal">
     <section xml:id="ns-minimal">
       <title>A Minimal <literal>&lt;http&gt;</literal> Configuration</title>
       <title>A Minimal <literal>&lt;http&gt;</literal> Configuration</title>
@@ -359,11 +359,11 @@
     <intercept-url pattern="/**" access="ROLE_USER" requires-channel="any"/>  
     <intercept-url pattern="/**" access="ROLE_USER" requires-channel="any"/>  
     ...
     ...
   </http>]]>
   </http>]]>
-        </programlisting> With this configuration in place, if a user attempts to
-        access anything matching the "/secure/**" pattern using HTTP, they will first be redirected
-        to an HTTPS URL. The available options are "http", "https" or "any". Using the value "any"
-        means that either HTTP or HTTPS can be used. </para>
-      <para> If your application uses non-standard ports for HTTP and/or HTTPS, you can specify a
+        </programlisting>With this configuration in place, if a user attempts to access
+        anything matching the "/secure/**" pattern using HTTP, they will first be redirected to an
+        HTTPS URL. The available options are "http", "https" or "any". Using the value "any" means
+        that either HTTP or HTTPS can be used. </para>
+      <para>If your application uses non-standard ports for HTTP and/or HTTPS, you can specify a
         list of port mappings as follows: <programlisting><![CDATA[     
         list of port mappings as follows: <programlisting><![CDATA[     
   <http>
   <http>
     ...
     ...
@@ -371,10 +371,8 @@
       <port-mapping http="9080" https="9443"/>
       <port-mapping http="9080" https="9443"/>
     </port-mappings>
     </port-mappings>
   </http>]]>
   </http>]]>
-        </programlisting>
-        <!--You can find a more in-depth discussion of channel security
-        in <xref xlink:href="#channel-security"/-->
-      </para>
+        </programlisting><!--You can find a more in-depth discussion of channel security
+        in <xref xlink:href="#channel-security"/--></para>
     </section>
     </section>
     <section xml:id="ns-session-mgmt">
     <section xml:id="ns-session-mgmt">
       <title>Session Management</title>
       <title>Session Management</title>
@@ -416,7 +414,7 @@
         <concurrency-control max-sessions="1" error-if-maximum-exceeded="true" />
         <concurrency-control max-sessions="1" error-if-maximum-exceeded="true" />
     </session-management>
     </session-management>
   </http>]]>
   </http>]]>
-        </programlisting> The second login will then be rejected. By
+        </programlisting>The second login will then be rejected. By
             <quote>rejected</quote>, we mean that the user will be sent to the
             <quote>rejected</quote>, we mean that the user will be sent to the
             <literal>authentication-failure-url</literal> if form-based login is being used. If the
             <literal>authentication-failure-url</literal> if form-based login is being used. If the
           second authentication takes place through another non-interactive mechanism, such as
           second authentication takes place through another non-interactive mechanism, such as
@@ -424,10 +422,30 @@
           the client. If instead you want to use an error page, you can add the attribute
           the client. If instead you want to use an error page, you can add the attribute
             <literal>session-authentication-error-url</literal> to the
             <literal>session-authentication-error-url</literal> to the
             <literal>session-management</literal> element. </para>
             <literal>session-management</literal> element. </para>
-        <para> If you are using a customized authentication filter for form-based login, then you
+        <para>If you are using a customized authentication filter for form-based login, then you
           have to configure concurrent session control support explicitly. More details can be found
           have to configure concurrent session control support explicitly. More details can be found
           in the <link xlink:href="#session-mgmt">Session Management chapter</link>. </para>
           in the <link xlink:href="#session-mgmt">Session Management chapter</link>. </para>
       </section>
       </section>
+      <section xml:id="ns-session-fixation">
+        <title>Session Fixation Attack Protection</title>
+        <para>
+          <link xlink:href="http://en.wikipedia.org/wiki/Session_fixation">Session fixation</link>
+          attacks are a potential risk where it is possible for a malicious attacker to create a
+          session by accessing a site, then persuade another user to log in with the same session
+          (by sending them a link containing the session identifier as a parameter, for example).
+          Spring Security protects against this automatically by creating a new session when a user
+          logs in. If you don't require this protection, or it conflicts with some other
+          requirement, you can control the behaviour using the
+            <literal>session-fixation-protection</literal> attribute on
+            <literal>&lt;session-management&gt;</literal>, which has three options
+                  <itemizedlist><listitem><para><literal>migrateSession</literal> - creates a new
+                session and copies the existing session attributes to the new session. This is the
+                default.</para></listitem><listitem><para><literal>none</literal> - Don't do
+                anything. The original session will be
+                  retained.</para></listitem><listitem><para><literal>newSession</literal> - Create
+                a new "clean" session, without copying the existing session
+            data.</para></listitem></itemizedlist></para>
+      </section>
     </section>
     </section>
     <section xml:id="ns-openid">
     <section xml:id="ns-openid">
       <title>OpenID Login</title>
       <title>OpenID Login</title>
@@ -541,25 +559,6 @@
             overview</link> chapter. </para>
             overview</link> chapter. </para>
       </section>
       </section>
     </section>
     </section>
-    <section xml:id="ns-session-fixation">
-      <title>Session Fixation Attack Protection</title>
-      <para>
-        <link xlink:href="http://en.wikipedia.org/wiki/Session_fixation">Session fixation</link>
-        attacks are a potential risk where it is possible for a malicious attacker to create a
-        session by accessing a site, then persuade another user to log in with the same session (by
-        sending them a link containing the session identifier as a parameter, for example). Spring
-        Security protects against this automatically by creating a new session when a user logs in.
-        If you don't require this protection, or it conflicts with some other requirement, you can
-        control the behaviour using the <literal>session-fixation-protection</literal> attribute on
-          <literal>&lt;http&gt;</literal>, which has three options
-                <itemizedlist><listitem><para><literal>migrateSession</literal> - creates a new
-              session and copies the existing session attributes to the new session. This is the
-              default.</para></listitem><listitem><para><literal>none</literal> - Don't do anything.
-              The original session will be
-                retained.</para></listitem><listitem><para><literal>newSession</literal> - Create a
-              new "clean" session, without copying the existing session
-          data.</para></listitem></itemizedlist></para>
-    </section>
   </section>
   </section>
   <section xml:id="ns-method-security">
   <section xml:id="ns-method-security">
     <title>Method Security</title>
     <title>Method Security</title>
@@ -637,13 +636,13 @@
         alternative for both method and web security. </para>
         alternative for both method and web security. </para>
       <para> For method security, you do this by setting the
       <para> For method security, you do this by setting the
           <literal>access-decision-manager-ref</literal> attribute on
           <literal>access-decision-manager-ref</literal> attribute on
-          <literal>global-method-security</literal>to the Id of the appropriate
+          <literal>global-method-security</literal> to the Id of the appropriate
           <interfacename>AccessDecisionManager</interfacename> bean in the application context: <programlisting language="xml"><![CDATA[
           <interfacename>AccessDecisionManager</interfacename> bean in the application context: <programlisting language="xml"><![CDATA[
   <global-method-security access-decision-manager-ref="myAccessDecisionManagerBean">
   <global-method-security access-decision-manager-ref="myAccessDecisionManagerBean">
     ... 
     ... 
   </global-method-security>
   </global-method-security>
   ]]></programlisting></para>
   ]]></programlisting></para>
-      <para> The syntax for web security is the same, but on the <literal>http</literal> element: <programlisting><![CDATA[
+      <para> The syntax for web security is the same, but on the <literal>http</literal> element: <programlisting  language="xml"><![CDATA[
   <http access-decision-manager-ref="myAccessDecisionManagerBean">
   <http access-decision-manager-ref="myAccessDecisionManagerBean">
     ... 
     ... 
   </http>
   </http>