[jboss-cvs] JBossAS SVN: r76305 - in projects/security/security-negotiation/trunk/docs/userguide/en: modules and 1 other directory.

[jboss-cvs-commits at lists.jboss.org]

Author: darran.lofthouse at jboss.com
Date: 2008-07-28 11:24:43 -0400 (Mon, 28 Jul 2008)
New Revision: 76305

Added:
   projects/security/security-negotiation/trunk/docs/userguide/en/modules/troubleshooting.xml
Modified:
   projects/security/security-negotiation/trunk/docs/userguide/en/master.xml
Log:
[SECURITY-265] Added troubleshooting to user guide.

Modified: projects/security/security-negotiation/trunk/docs/userguide/en/master.xml
===================================================================
--- projects/security/security-negotiation/trunk/docs/userguide/en/master.xml	2008-07-28 14:54:43 UTC (rev 76304)
+++ projects/security/security-negotiation/trunk/docs/userguide/en/master.xml	2008-07-28 15:24:43 UTC (rev 76305)
@@ -108,6 +108,9 @@
   <xi:include href="modules/references.xml"
     xmlns:xi="http://www.w3.org/2001/XInclude" xpointer="element(/1)" />
     
+  <xi:include href="modules/troubleshooting.xml"
+    xmlns:xi="http://www.w3.org/2001/XInclude" xpointer="element(/1)" />    
+    
   <xi:include href="modules/ldap_login_module.xml"
     xmlns:xi="http://www.w3.org/2001/XInclude" xpointer="element(/1)" />    
 </book>
\ No newline at end of file

Added: projects/security/security-negotiation/trunk/docs/userguide/en/modules/troubleshooting.xml
===================================================================
--- projects/security/security-negotiation/trunk/docs/userguide/en/modules/troubleshooting.xml	                        (rev 0)
+++ projects/security/security-negotiation/trunk/docs/userguide/en/modules/troubleshooting.xml	2008-07-28 15:24:43 UTC (rev 76305)
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+<chapter id="troubleshooting">
+  <title>Troubleshooting</title>
+
+  <section>
+    <title>Introduction</title>
+
+    <para>
+      When working with the JBoss Negotiation authenticator there are a
+      number of different approaches to identify the cause of failures,
+      this chapter contains information on some of the approaches you
+      can take.
+    </para>
+
+    <para>
+      The first tool that you should make use of is the Negotiation
+      Toolikit which is documented in '
+      <xref linkend="negotiation_toolkit" />
+      ', the authenticator and this documentation were both developed
+      using the toolkit so using this to test your deployment will
+      eliminate any differences introduced by your own application.
+    </para>
+  </section>
+
+
+  <section id="logging">
+    <title>Logging</title>
+
+    <para>
+      Within JBoss AS the most important category to enable full TRACE
+      logging is 'org'jboss.security': -
+    </para>
+
+    <programlisting>
+      <![CDATA[
+<category name="org.jboss.security">
+  <priority value="TRACE"/>
+</category>]]>
+    </programlisting>
+
+    <para>
+      Enabling TRACE logging for the 'org'jboss.security' will log
+      additional information for the authentcator, the login module and
+      for the rest of JBoss Security.
+    </para>
+
+    <para>
+      The 'com.sun.security.auth.module.Krb5LoginModule' login module
+      also allows you to enable additional logging by setting the
+      'debug' option to 'true': -
+    </para>
+
+    <programlisting>
+      <![CDATA[<module-option name="debug">true</module-option>]]>
+    </programlisting>
+
+    <para>
+      Finally setting the system property
+      <code>-Dsun.security.krb5.debug=true</code>
+      will result in much more verbose output of the complete GSSAPI
+      negotiation process.
+    </para>
+
+  </section>
+
+
+</chapter>
\ No newline at end of file


Property changes on: projects/security/security-negotiation/trunk/docs/userguide/en/modules/troubleshooting.xml
___________________________________________________________________
Name: svn:keywords
   + Id Revision
Name: svn:eol-style
   + LF