Zend_Auth_Adapter_DbTable.xml 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15156 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.auth.adapter.dbtable">
  5. <title>Datenbanktabellen Authentifizierung</title>
  6. <sect2 id="zend.auth.adapter.dbtable.introduction">
  7. <title>Einführung</title>
  8. <para>
  9. <classname>Zend_Auth_Adapter_DbTable</classname> bietet die Möglichkeit sich gegenüber Zeugnissen zu
  10. authentifizieren die in einer Datenbank Tabelle gespeichert sind. Weil
  11. <classname>Zend_Auth_Adapter_DbTable</classname> eine Instanz von <classname>Zend_Db_Adapter_Abstract</classname>
  12. benötigt, die an den Konstruktor übergeben wird, ist jede Instanz an eine spezielle Datenbank
  13. Verbindung verknüpft. Andere Konfigurationsoptionen können durch den Konstruktor gesetzt werden und
  14. durch die Methoden der Instanz. Eine für jede Option.
  15. </para>
  16. <para>
  17. Die vorhandenen Konfigurationsoptionen beinhalten:
  18. <itemizedlist>
  19. <listitem>
  20. <para>
  21. <code>tableName</code>: Das ist der Name der Datenbanktabelle welche die Authentifikations
  22. Zeugnisse enthält, und gegen die die Datenbank Authentifikations Abfrage durchgeführt
  23. wird.
  24. </para>
  25. </listitem>
  26. <listitem>
  27. <para>
  28. <code>identityColumn</code>: Ist der Name der Spalte der Datenbanktabelle die die
  29. Identität repräsentiert. Die Spalte der Identität muß eindeutige und einmalige Werte
  30. enthalten, wie einen Benutzernamen oder eine Email Adresse.
  31. </para>
  32. </listitem>
  33. <listitem>
  34. <para>
  35. <code>credentialColumn</code>: Das ist der Name der Spalte der Datenbanktabelle die
  36. verwendet wird um die Zeugnisse zu repräsentieren. Bei einem einfachen Identitäts und
  37. Passwort-Authentifizierungs Schema korrespondieren die Zeugnisse mit dem Passwort. Siehe
  38. auch die <code>credentialTreatment</code> Option.
  39. </para>
  40. </listitem>
  41. <listitem>
  42. <para>
  43. <code>credentialTreatment</code>: In vielen Fällen sind Passwörter und andere sensitive
  44. Daten verschlüsselt, gehasht, kodiert, gesalted, verschleiert oder auf andere Weise durch
  45. irgendeine Funktion oder einen Algorithmus behandelt. Durch die Spezifikation eines
  46. parametrisierbaren Behandlungsstrings mit dieser Methode, wie <code>'MD5(?)'</code>
  47. oder <code>'PASSWORD(?)'</code>, könnte ein Entwickler beliebiges SQL an den Eingabe-
  48. Zeugnis-Daten anwenden. Da diese Funktionen der darunter liegenden RDBMS speziell
  49. gehören, sollte das Handbuch der Datenbank auf das Vorhandensein solcher Funktionen
  50. im eigenen Datenbank System geprüft werden.
  51. </para>
  52. </listitem>
  53. </itemizedlist>
  54. </para>
  55. <example id="zend.auth.adapter.dbtable.introduction.example.basic_usage">
  56. <title>Grundsätzliche Verwendung</title>
  57. <para>
  58. Wie bereits in der Einführung beschrieben benötigt der <classname>Zend_Auth_Adapter_DbTable</classname>
  59. Konstruktor eine Instanz von <classname>Zend_Db_Adapter_Abstract</classname> die als Datenbank Verbindung
  60. fungiert zu welcher die Instanz des Authentifizierungs-Adapters gebunden ist. Zuerst sollte die
  61. Datenbankverbindung erstellt werden.
  62. </para>
  63. <para>
  64. Der folgende Code erstellt eien Adapter für eine In-Memory Datenbank, erstellt ein einfaches
  65. Datenbankschema, und fügt eine Zeile ein gegen die später eine Authentifizierungs-Abfrage
  66. durchgeführt werden kann. Dieses Beispiel benötigt die SQLite Erweiterung:
  67. </para>
  68. <programlisting role="php"><![CDATA[
  69. // Erstellt eine In-Memory SQLite Datenbankverbindung
  70. $dbAdapter = new Zend_Db_Adapter_Pdo_Sqlite(array('dbname' =>
  71. ':memory:'));
  72. // Erstellt eine einfache Datenbank-Erstellungs-Abfrage
  73. $sqlCreate = 'CREATE TABLE [users] ('
  74. . '[id] INTEGER NOT NULL PRIMARY KEY, '
  75. . '[username] VARCHAR(50) UNIQUE NOT NULL, '
  76. . '[password] VARCHAR(32) NULL, '
  77. . '[real_name] VARCHAR(150) NULL)';
  78. // Erstellt die Tabelle für die Authentifizierungs Zeugnisse
  79. $dbAdapter->query($sqlCreate);
  80. // Erstellt eine Abfrage um eine Zeile einzufügen für die eine
  81. // Authentifizierung erfolgreich sein kann
  82. $sqlInsert = "INSERT INTO users (username, password, real_name) "
  83. . "VALUES ('my_username', 'my_password', 'My Real Name')";
  84. // Daten einfügen
  85. $dbAdapter->query($sqlInsert);
  86. ]]></programlisting>
  87. <para>
  88. Mit der Datenbankverbindung und den vorhandenen Tabellendaten, kann eine Instanz von
  89. <classname>Zend_Auth_Adapter_DbTable</classname> erstellt werden. Die Werte der Konfigurationsoptionen
  90. können dem Konstruktor übergeben werden, oder als Parameter der setzenden Methoden nach der
  91. Instanziierung:
  92. </para>
  93. <programlisting role="php"><![CDATA[
  94. // Die Instanz mit Konstruktor Parametern konfiurieren...
  95. $authAdapter = new Zend_Auth_Adapter_DbTable(
  96. $dbAdapter,
  97. 'users',
  98. 'username',
  99. 'password'
  100. );
  101. // ...oder die Instanz mit den setzenden Methoden konfigurieren
  102. $authAdapter = new Zend_Auth_Adapter_DbTable($dbAdapter);
  103. $authAdapter
  104. ->setTableName('users')
  105. ->setIdentityColumn('username')
  106. ->setCredentialColumn('password')
  107. ;
  108. ]]></programlisting>
  109. <para>
  110. An diesem Punkt ist die Instanz des Authentifizierungsadapters bereit um Authentifierungsabfragen
  111. zu akzeptieren. Um eine Authentifierungsabfrage zu formulieren, werden die Eingabezeugnis Werte
  112. dem Adapter vor dem Aufruf der <code>authenticate()</code> Methode, übergeben:
  113. </para>
  114. <programlisting role="php"><![CDATA[
  115. // Die Eingabezeugnis Werte setzen (z.B. von einem Login Formular)
  116. $authAdapter
  117. ->setIdentity('my_username')
  118. ->setCredential('my_password');
  119. // Die Authentifizierungsabfrage durchführen, das Ergebnis speichern
  120. $result = $authAdapter->authenticate();
  121. ]]></programlisting>
  122. <para>
  123. Zusätzlich zum Vorhandensein der <code>getIdentity()</code> Methode über das Authentifizierungs
  124. Ergebnisobjekt, unterstützt <classname>Zend_Auth_Adapter_DbTable</classname> auch das empfangen der
  125. Tabellenzeile wenn die Authentifizierung erfolgeich war:
  126. </para>
  127. <programlisting role="php"><![CDATA[
  128. // Die Identität ausgeben
  129. echo $result->getIdentity() . "\n\n";
  130. // Die Ergebniszeile ausgeben
  131. print_r($identity);
  132. /* Ausgabe:
  133. my_username
  134. Array
  135. (
  136. [id] => 1
  137. [username] => my_username
  138. [password] => my_password
  139. [real_name] => My Real Name
  140. )
  141. */
  142. ]]></programlisting>
  143. <para>
  144. Da die Zeile der Tabelle die Zeugnis Daten enthält ist es wichtig diese Werte gegenüber
  145. unberechtigten Versuchen abzusichern.
  146. </para>
  147. </example>
  148. </sect2>
  149. <sect2 id="zend.auth.adapter.dbtable.advanced.storing_result_row">
  150. <title>Fortgeschrittene Verwendung: Ein DbTable Ergebnis Objekt dauerhaft machen</title>
  151. <para>
  152. Standardmäßig gibt <classname>Zend_Auth_Adapter_DbTable</classname> die unterstützte Identität an das
  153. Auth Objekt bei erfolgreicher Authentifizierung zurück. Ein anderes Verwendungs-Szenario, bei dem
  154. Entwickler ein Identitäts Objekt, welches andere nützliche Informationen enthält, in den dauerhaften
  155. Speichermechanismus von <classname>Zend_Auth</classname> abspeichern wollen, wird durch die Verwendung der
  156. <code>getResultRowObject()</code> Methode gelöst die ein <code>stdClass</code> Objekt zurück gibt.
  157. Der folgende Code Abschnitt zeigt diese Verwendung:
  158. </para>
  159. <programlisting role="php"><![CDATA[
  160. // Mit Zend_Auth_Adapter_DbTable authentifizieren
  161. $result = $this->_auth->authenticate($adapter);
  162. if ($result->isValid()) {
  163. // Die Identität als Objekt speichern wobei nur der Benutzername und
  164. // der echte Name zurückgegeben werden
  165. $storage = $this->_auth->getStorage();
  166. $storage->write($adapter->getResultRowObject(array(
  167. 'username',
  168. 'real_name'
  169. )));
  170. // Die Identität als Objekt speichern, wobei die
  171. // Passwort Spalte unterdrückt wird
  172. $storage->write($adapter->getResultRowObject(
  173. null,
  174. 'password'
  175. ));
  176. /* ... */
  177. } else {
  178. /* ... */
  179. }
  180. ]]></programlisting>
  181. </sect2>
  182. <sect2 id="zend.auth.adapter.dbtable.advanced.advanced_usage">
  183. <title>Forgeschrittene Verwendung durch Beispiele</title>
  184. <para>
  185. Wärend der primäre Zweck von <classname>Zend_Auth</classname> (und konsequenter Weise
  186. <classname>Zend_Auth_Adapter_DbTable</classname>) die <emphasis role="strong">Authentifizierung</emphasis>
  187. und nicht die <emphasis role="strong">Authorisierung</emphasis> ist, gibt es ein paar
  188. Instanzen und Probleme auf dem Weg welche Art besser passt. Abhängig davon wie man sich
  189. entscheidet ein Problem zu beschreiben, macht es manchmal Sinn, das was wie ein
  190. Authorisierungsproblem aussieht im Authentifizierungs-Adapter zu lösen.
  191. </para>
  192. <para>
  193. Mit dieser Definition, hat <classname>Zend_Auth_Adapter_DbTable</classname> einige eingebaute
  194. Mechanismen die für zusätzliche Checks wärend der Authentifizierungszeit angepasst
  195. werden können, um einige übliche Benutzerprobleme zu lösen.
  196. </para>
  197. <programlisting role="php"><![CDATA[
  198. // Der Feldwert des Status eines Accounts ist nicht gleich "compromised"
  199. $adapter = new Zend_Auth_Adapter_DbTable(
  200. $db,
  201. 'users',
  202. 'username',
  203. 'password',
  204. 'MD5(?) AND status != "compromised"'
  205. );
  206. // Der aktive Feldwert des Accounts ist gleich "TRUE"
  207. $adapter = new Zend_Auth_Adapter_DbTable(
  208. $db,
  209. 'users',
  210. 'username',
  211. 'password',
  212. 'MD5(?) AND active = "TRUE"'
  213. );
  214. ]]></programlisting>
  215. <para>
  216. Ein anderes Szenario kann die Implementierung eines Saltingmachanismus sein. Salting ist ein
  217. Ausdruck der auf eine Technik verweist die die Sicherheit der Anwendung sehr stark erhöht.
  218. Sie basiert auf der Idee das das Anfügen von zufälligen Strings bei jedem Passwort es
  219. unmöglich macht eine erfolgreiche Brute-Force Attacke auf die Datenbank durchzuführen bei der
  220. vorberechnete Hashwerte aus einem Verzeichnis genommen werden.
  221. </para>
  222. <para>
  223. Hierfür muß die Tabelle so modifiziert werden das Sie unseren Salt-String enthält:
  224. </para>
  225. <programlisting role="php"><![CDATA[
  226. $sqlAlter = "ALTER TABLE [users] "
  227. . "ADD COLUMN [password_salt] "
  228. . "AFTER [password]";
  229. $dbAdapter->query($sqlAlter);
  230. ]]></programlisting>
  231. <para>
  232. Hier ist ein einfacher Weg um einen Salt String für jeden Benutzer bei der Registrierung zu
  233. erstellen:
  234. </para>
  235. <programlisting role="php"><![CDATA[
  236. for ($i = 0; $i < 50; $i++) {
  237. $dynamicSalt .= chr(rand(33, 126));
  238. }
  239. ]]></programlisting>
  240. <para>
  241. Und nun erstellen wir den Adapter:
  242. </para>
  243. <programlisting role="php"><![CDATA[
  244. $adapter = new Zend_Auth_Adapter_DbTable(
  245. $db,
  246. 'users',
  247. 'username',
  248. 'password',
  249. "MD5(CONCAT('"
  250. . Zend_Registry::get('staticSalt')
  251. . "', ?, password_salt))"
  252. );
  253. ]]></programlisting>
  254. <note>
  255. <para>
  256. Die Sicherheit kann sogar noch mehr erhöht werden indem ein statischer Salt Wert hardcoded
  257. in der Anwendung verwendet wird. Im Falle das die Datenbank korrumpiert wird (z.B. durch eine
  258. SQL Injection Attacke) aber der Webserver intakt bleibt sind die Daten für den Angreifer noch
  259. immer nicht verwendbar.
  260. </para>
  261. </note>
  262. <para>
  263. Eine andere Alternative besteht darin die <code>getDbSelect()</code> Methode von
  264. Zend_Auth_Adapter_DbTable zu verwenden nachdem der Adapter erstellt wurde. Diese
  265. Methode gibt die Instanz des Zend_Db_Select Objekts zurück welches verwendet wird
  266. um die authenticate() Methode zu komplettieren. Es ist wichtig anzumerken das diese
  267. Methode immer das gleiche Objekt zurückgibt unabhängig davon ob authenticate()
  268. aufgerufen wurde oder nicht. Diese Objekt <emphasis>enthält keine</emphasis> Identity
  269. oder Anmeldeinformationen in sich da diese Werte im Select Objekt wärend des Ausführens
  270. von authenticate() platziert werden.
  271. </para>
  272. <para>
  273. Als Beispiel einer Situation könnte man die getDbSelect() Methode verwenden um
  274. den Status eines Benutzers zu prüfen, in anderen Worten sehen ob der Account des
  275. Benutzers aktiviert ist.
  276. </para>
  277. <programlisting role="php"><![CDATA[
  278. // Das Beispiel von oben weiterführen
  279. $adapter = new Zend_Auth_Adapter_DbTable(
  280. $db,
  281. 'users',
  282. 'username',
  283. 'password',
  284. 'MD5(?)'
  285. );
  286. // Das Select Objekt (durch Referenz) bekommen
  287. $select = $adapter->getDbSelect();
  288. $select->where('active = "TRUE"');
  289. // Authentifizieren, das stellt sicher das users.active = TRUE
  290. $adapter->authenticate();
  291. ]]></programlisting>
  292. </sect2>
  293. </sect1>
  294. <!--
  295. vim:se ts=4 sw=4 et:
  296. -->