documentation/manual/ja/module_specs/Zend_Auth_Adapter_Digest.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <!-- EN-Revision: 20763 -->
   4 <sect1 id="zend.auth.adapter.digest">
   5
   6     <title>ダイジェスト認証</title>
   7
   8     <sect2 id="zend.auth.adapter.digest.introduction">
   9
  10         <title>導入</title>
  11
  12         <para>
  13             <ulink url="http://en.wikipedia.org/wiki/Digest_access_authentication">ダイジェスト認証</ulink>
  14             は、
  15             <ulink url="http://ja.wikipedia.org/wiki/Basic%E8%AA%8D%E8%A8%BC">ベーシック認証</ulink>
  16             を改良した <acronym>HTTP</acronym> 認証方式です。
  17             パスワードを平文テキストでネットワークに流すことなく認証を行えます。
  18         </para>
  19
  20         <para>
  21             このアダプタは、テキストファイルをもとにした認証を行います。
  22             このテキストファイルには、ダイジェスト認証の基本要素が書かれています。
  23         </para>
  24
  25         <itemizedlist>
  26             <listitem>
  27                 <para>
  28                     "<emphasis><filename>joe.user</filename></emphasis>" のようなユーザ名。
  29                 </para>
  30             </listitem>
  31
  32             <listitem>
  33                 <para>
  34                     "<emphasis>Administrative Area</emphasis>" のようなレルム。
  35                 </para>
  36             </listitem>
  37
  38             <listitem>
  39                 <para>
  40                     ユーザ名、レルムおよびパスワードをコロンで区切った文字列の <acronym>MD5</acronym> ハッシュ。
  41                 </para>
  42             </listitem>
  43         </itemizedlist>
  44
  45         <para>
  46             それぞれの要素はコロンで区切り、たとえば次のようになります
  47             (この例のパスワードは "<emphasis>somePassword</emphasis>") です。
  48         </para>
  49
  50         <programlisting><![CDATA[
  51 someUser:Some Realm:fde17b91c3a510ecbaf7dbd37f59d4f8
  52 ]]></programlisting>
  53
  54     </sect2>
  55
  56     <sect2 id="zend.auth.adapter.digest.specifics">
  57
  58         <title>使用</title>
  59
  60         <para>
  61             ダイジェスト認証アダプタ <classname>Zend_Auth_Adapter_Digest</classname>
  62             には、以下の入力パラメータが必要です。
  63         </para>
  64
  65         <itemizedlist>
  66             <listitem>
  67                 <para>
  68                     filename - 認証の問い合わせ先となるファイル名。
  69                 </para>
  70             </listitem>
  71
  72             <listitem>
  73                 <para>
  74                     realm - ダイジェスト認証のレルム。
  75                 </para>
  76             </listitem>
  77
  78             <listitem>
  79                 <para>
  80                     username - ダイジェスト認証のユーザ名。
  81                 </para>
  82             </listitem>
  83
  84             <listitem>
  85                 <para>
  86                     password - 指定したレルムにおける、ユーザのパスワード。
  87                 </para>
  88             </listitem>
  89         </itemizedlist>
  90
  91         <para>
  92             これらのパラメータは、<methodname>authenticate()</methodname>
  93             をコールする前に設定しなければなりません。
  94         </para>
  95
  96     </sect2>
  97
  98     <sect2 id="zend.auth.adapter.digest.identity">
  99
 100         <title>ID</title>
 101
 102         <para>
 103             ダイジェスト認証アダプタは <classname>Zend_Auth_Result</classname>
 104             オブジェクトを返します。ここに、認証された ID の情報が
 105             配列として含まれます。配列のキーは
 106             <emphasis>realm</emphasis> および <emphasis>username</emphasis> です。
 107             これらのキーに対応する配列の値は、
 108             <methodname>authenticate()</methodname> をコールする前に設定したものに対応します。
 109         </para>
 110
 111         <programlisting language="php"><![CDATA[
 112 $adapter = new Zend_Auth_Adapter_Digest($filename,
 113                                         $realm,
 114                                         $username,
 115                                         $password);
 116
 117 $result = $adapter->authenticate();
 118
 119 $identity = $result->getIdentity();
 120
 121 print_r($identity);
 122
 123 /*
 124 Array
 125 (
 126     [realm] => Some Realm
 127     [username] => someUser
 128 )
 129 */
 130 ]]></programlisting>
 131
 132     </sect2>
 133
 134 </sect1>
 135 <!--
 136 vim:se ts=4 sw=4 et:
 137 -->