[pal-cvs 3429] [1163] added filter doc.

svnno****@sourc***** svnno****@sourc*****
2008年 9月 12日 (金) 18:20:31 JST


Revision: 1163
          http://svn.sourceforge.jp/cgi-bin/viewcvs.cgi?root=pal&view=rev&rev=1163
Author:   shinsuke
Date:     2008-09-12 18:20:31 +0900 (Fri, 12 Sep 2008)

Log Message:
-----------
added filter doc.

Modified Paths:
--------------
    pal-portal/docs/ja/configuration-guide/trunk/xdocs/navigation.xml

Added Paths:
-----------
    pal-portal/docs/ja/configuration-guide/trunk/xdocs/security/authfilter.xml


-------------- next part --------------
Modified: pal-portal/docs/ja/configuration-guide/trunk/xdocs/navigation.xml
===================================================================
--- pal-portal/docs/ja/configuration-guide/trunk/xdocs/navigation.xml	2008-09-12 09:02:27 UTC (rev 1162)
+++ pal-portal/docs/ja/configuration-guide/trunk/xdocs/navigation.xml	2008-09-12 09:20:31 UTC (rev 1163)
@@ -39,7 +39,7 @@
       <item name="ログイン" href="security/login.html"/>
       <item name="資格管理" href="security/credential.html"/>
       <item name="ポートレットからの利用" href="security/portlet.html"/>
-<!-- Authentication Filter -->
+      <item name="認証フィルター" href="security/authfilter.html"/>
     </menu>
     <menu name="デザイン">
       <item name="概要" href="design/guide.html"/>

Added: pal-portal/docs/ja/configuration-guide/trunk/xdocs/security/authfilter.xml
===================================================================
--- pal-portal/docs/ja/configuration-guide/trunk/xdocs/security/authfilter.xml	                        (rev 0)
+++ pal-portal/docs/ja/configuration-guide/trunk/xdocs/security/authfilter.xml	2008-09-12 09:20:31 UTC (rev 1163)
@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+  <properties>
+    <title>設定</title>
+    <subtitle>認証フィルター</subtitle>
+    <authors>
+      <person name="菅谷信介" email="shins****@yahoo*****"/>
+    </authors>
+  </properties>
+  <body>
+    <section name="認証フィルターについて">
+      <p>
+PALポータルは J2EE のフォーム認証をサポートしていますが、様々な認証環境にサポートするため、認証フィルター群を提供しています。
+認証フィルターを利用することで、リクエストパラメータやクッキーなどからユーザー名とパスワードを取得して、認証処理を実行できます。
+たとえば、他のシステムで認証後、そのシステムでクッキーに認証するための情報を入れて、PALポータルにアクセスすることで、ログイン画面を表示することなしにログインすることができます。
+      </p>
+    </section>
+    <section name="認証フィルターの種類">
+      <p>
+PALポータルでは、次の認証フィルターを提供しています。
+<ul>
+<li>jp.sf.pal.portal.filter.CookieAuthFilter: クッキーからユーザー名とパスワードを取得する。</li>
+<li>jp.sf.pal.portal.filter.RequestHeaderAuthFilter: リクエストヘッダーからユーザー名とパスワードを取得する。</li>
+<li>jp.sf.pal.portal.filter.RequestParameterAuthFilter: リクエストパラメータからからユーザー名とパスワードを取得する。</li>
+</ul>
+      </p>
+    </section>
+    <section name="初期値">
+      <p>
+web.xml で filter 要素内の init-param 要素で値を指定できます。
+      </p>
+<subsection name="username.key">
+<p>
+<ul>
+<li>ユーザー名を取得するためのキー</li>
+<li>デフォルト値: org.apache.jetspeed.login.username</li>
+</ul>
+</p>
+</subsection>
+<subsection name="password.key">
+<p>
+<ul>
+<li>パスワードを取得するためのキー</li>
+<li>デフォルト値: org.apache.jetspeed.login.password</li>
+</ul>
+</p>
+</subsection>
+<subsection name="skip.password.check">
+<p>
+<ul>
+<li># パスワード確認をスキップするかどうか。</li>
+<li>デフォルト値: false</li>
+</ul>
+</p>
+</subsection>
+    </section>
+    <section name="設定方法">
+<p>
+web.xml に以下のように記述します。
+</p>
+<source><![CDATA[
+...
+  <filter>
+    <filter-name>AuthFilter</filter-name>
+    <filter-class>jp.sf.pal.portal.filter.RequestHeaderAuthFilter</filter-class>
+    <init-param>
+      <param-name>username.key</param-name>
+      <param-value>USERNAME</param-value>
+    </init-param>
+    <init-param>
+      <param-name>password.key</param-name>
+      <param-value>PASSWORD</param-value>
+    </init-param>
+    <init-param>
+      <param-name>skip.password.check</param-name>
+      <param-value>true</param-value>
+    </init-param>
+  </filter>
+...
+  <filter-mapping>
+    <filter-name>AuthFilter</filter-name>
+    <url-pattern>/*</url-pattern>
+  </filter-mapping>
+...
+]]></source>
+      <p>
+設定を保存し、ポータルを再起動後に有効になります。
+      </p>
+    </section>
+  </body>
+</document>


Property changes on: pal-portal/docs/ja/configuration-guide/trunk/xdocs/security/authfilter.xml
___________________________________________________________________
Name: svn:eol-style
   + native


pal-cvs メーリングリストの案内