Zend_Auth_Adapter_DbTable.xml 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!-- EN-Revision: 16652 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.auth.adapter.dbtable">
  5. <title>Authentification avec une table de base de données</title>
  6. <sect2 id="zend.auth.adapter.dbtable.introduction">
  7. <title>Introduction</title>
  8. <para>
  9. <classname>Zend_Auth_Adapter_DbTable</classname> fournit la possibilité d'authentifier
  10. sur la base de crédits stockés dans une table de base de données. Comme
  11. <classname>Zend_Auth_Adapter_DbTable</classname> requiert qu'une instance de
  12. <classname>Zend_Db_Adapter_Abstract</classname> soit fournie à son constructeur, chaque
  13. instance est liée à une connexion de base de données particulière. Les autres options
  14. de configuration peuvent être réglées grâce au constructeur ou au travers de
  15. différentes méthodes, une pour chaque option.
  16. </para>
  17. <para>
  18. Les options de configuration disponibles incluent&#160;:
  19. </para>
  20. <itemizedlist>
  21. <listitem>
  22. <para>
  23. <property>tableName</property>&#160;: il s'agit du nom de la table dans la
  24. base de données qui contient les crédits d'authentification, et envers laquelle la
  25. requête d'authentification sera réalisée.
  26. </para>
  27. </listitem>
  28. <listitem>
  29. <para>
  30. <property>identityColumn</property>&#160;: il s'agit du nom de la colonne dans
  31. la table utilisée pour représenter l'identité. La colonne d'identité doit
  32. contenir une valeur unique, comme un "username" ou une adresse
  33. émail.
  34. </para>
  35. </listitem>
  36. <listitem>
  37. <para>
  38. <property>credentialColumn</property>&#160;: il s'agit du nom de la colonne
  39. dans la table utilisée pour représenter le crédit. Dans le cas d'une simple
  40. authentification par identité / mot de passe, la valeur de crédit
  41. correspond au mot de passe. Voir aussi l'option
  42. <property>credentialTreatment</property>.
  43. </para>
  44. </listitem>
  45. <listitem>
  46. <para>
  47. <property>credentialTreatment</property>&#160;: dans la plupart des cas, les
  48. mots de passe et autres données sensibles sont cryptés, hachés, encodés,
  49. masqués, ou sinon traités à travers une fonction ou un algorithme. En
  50. spécifiant un traitement paramétrable de chaîne avec cette méthode, comme
  51. <methodname>MD5(?)</methodname> ou <methodname>PASSWORD(?)</methodname>, un
  52. développeur peut appliquer un code <acronym>SQL</acronym> arbitraire sur les
  53. données de crédit fournies. Comme ces fonctions sont spécifiques à chaque
  54. gestionnaire de base de données (<acronym>SGBD</acronym>), vérifiez le manuel
  55. de la base de données pour vérifier la disponibilité de ces fonctions dans
  56. votre système.
  57. </para>
  58. </listitem>
  59. </itemizedlist>
  60. <example id="zend.auth.adapter.dbtable.introduction.example.basic_usage">
  61. <title>Utilisation basique</title>
  62. <para>
  63. Comme expliqué dans l'introduction, le constructeur de
  64. <classname>Zend_Auth_Adapter_DbTable</classname> requiert une instance de
  65. <classname>Zend_Db_Adapter_Abstract</classname> qui est utilisée comme connexion à
  66. la base de données à laquelle l'instance d'adaptateur d'authentification est liée.
  67. Avant tout, la connexion à la base de donnée devrait être crée.
  68. </para>
  69. <para>
  70. Le code suivant crée un adaptateur pour une base de données en mémoire, crée
  71. un schéma avec une table unique, et insère une ligne sur laquelle nous pouvons
  72. réaliser une requête d'authentification plus tard. Cet exemple requiert que
  73. l'extension PDO SQLite soit disponible&#160;:
  74. </para>
  75. <programlisting language="php"><![CDATA[
  76. // Crée une connexion de base de données SQLite en mémoire
  77. $dbAdapter = new Zend_Db_Adapter_Pdo_Sqlite(array('dbname' =>
  78. ':memory:'));
  79. // Construit une requête de création de table
  80. $sqlCreate = 'CREATE TABLE [users] ( '
  81. . '[id] INTEGER NOT NULL PRIMARY KEY, '
  82. . '[username] VARCHAR(50) UNIQUE NOT NULL, '
  83. . '[password] VARCHAR(32) NULL, '
  84. . '[real_name] VARCHAR(150) NULL)';
  85. // Crée la table de crédits d'authentification
  86. $dbAdapter->query($sqlCreate);
  87. // Construit la requête pour insérer une ligne pour laquelle
  88. // l'authentification pourra réussir
  89. $sqlInsert = "INSERT INTO users (username, password, real_name) "
  90. . "VALUES ('my_username', 'my_password', 'My Real Name')";
  91. // Insertion des données
  92. $dbAdapter->query($sqlInsert);
  93. ]]></programlisting>
  94. <para>
  95. Avec une connexion de base de données et des données disponibles dans la
  96. table, une instance de <classname>Zend_Auth_Adapter_DbTable</classname> peut être
  97. créée. Les valeurs d'options de configuration peuvent être fournies au
  98. constructeur ou en tant que paramètres aux méthodes de réglage après
  99. l'instanciation&#160;:
  100. </para>
  101. <programlisting language="php"><![CDATA[
  102. // Configure une instance avec des paramètres de constructeur ...
  103. $authAdapter = new Zend_Auth_Adapter_DbTable($dbAdapter,
  104. 'users',
  105. 'username',
  106. 'password');
  107. // ... ou configure l'instance avec des méthodes de réglage
  108. $authAdapter = new Zend_Auth_Adapter_DbTable($dbAdapter);
  109. $authAdapter->setTableName('users')
  110. ->setIdentityColumn('username')
  111. ->setCredentialColumn('password');
  112. ]]></programlisting>
  113. <para>
  114. A cet instant, l'instance de l'adaptateur d'authentification est prête à
  115. recevoir des requêtes d'authentification. Dans le but de réaliser une requête
  116. d'authentification, les valeurs des crédits requêtés sont fournies à l'adaptateur
  117. avant d'appeler la méthode <methodname>authenticate()</methodname>&#160;:
  118. </para>
  119. <programlisting language="php"><![CDATA[
  120. // Règle les valeurs d'entrées des crédits
  121. // (en général, à partir d'un formulaire d'enregistrement)
  122. $authAdapter->setIdentity('my_username')
  123. ->setCredential('my_password');
  124. // Réalise la requête d'authentification, et sauvegarde le résultat
  125. $result = $authAdapter->authenticate();
  126. ]]></programlisting>
  127. <para>
  128. En plus de la disponibilité de la méthode <methodname>getIdentity()</methodname>
  129. pour récupérer l'objet du résultat d'authentification,
  130. <classname>Zend_Auth_Adapter_DbTable</classname> supporte aussi la récupération de
  131. la ligne de la table qui a réussi l'authentification&#160;:
  132. </para>
  133. <programlisting language="php"><![CDATA[
  134. // Affiche l'identité
  135. echo $result->getIdentity() . "\n\n";
  136. // Affiche la ligne de résultat
  137. print_r($authAdapter->getResultRowObject());
  138. /* Affiche:
  139. my_username
  140. Array
  141. (
  142. [id] => 1
  143. [username] => my_username
  144. [password] => my_password
  145. [real_name] => My Real Name
  146. )
  147. */
  148. ]]></programlisting>
  149. <para>
  150. Puisque la ligne de la table contient la valeur de crédit, il est important de
  151. garantir ces valeurs contre l'accès fortuit.
  152. </para>
  153. </example>
  154. </sect2>
  155. <sect2 id="zend.auth.adapter.dbtable.advanced.storing_result_row">
  156. <title>Utilisation avancée : maintenir persistant l'objet de résultat DbTable</title>
  157. <para>
  158. Par défaut, <classname>Zend_Auth_Adapter_DbTable</classname> retourne l'identité
  159. fournie à l'objet Auth en cas d'authentification couronnée de succès. Un autre scénario
  160. d'utilisation, où les développeurs veulent stocker dans le mécanisme de stockage
  161. persistant du <classname>Zend_Auth</classname> un objet d'identité contenant d'autres
  162. informations utiles, est résolu en utilisant la méthode
  163. <methodname>getResultRowObject()</methodname> retournant un objet
  164. <emphasis>stdClass</emphasis>. Le petit bout de code suivant illustre cette
  165. utilisation&#160;:
  166. </para>
  167. <programlisting language="php"><![CDATA[
  168. // authentifie avec Zend_Auth_Adapter_DbTable
  169. $result = $this->_auth->authenticate($adapter);
  170. if ($result->isValid()) {
  171. // stocke l'identité comme objet dans lequel seulement username et
  172. // real_name sont retournés
  173. $storage = $this->_auth->getStorage();
  174. $storage->write($adapter->getResultRowObject(array('username',
  175. 'real_name')));
  176. // stocke l'identité comme objet dans lequel la colonne password
  177. // a été omis
  178. $storage->write($adapter->getResultRowObject(null, 'password'));
  179. /* ... */
  180. } else {
  181. /* ... */
  182. }
  183. ]]></programlisting>
  184. </sect2>
  185. <sect2 id="zend.auth.adapter.dbtable.advanced.advanced_usage">
  186. <title>Utilisation avancée par l'exemple</title>
  187. <para>
  188. Bien que le but initial de <classname>Zend_Auth</classname> (et par extension celui de
  189. <classname>Zend_Auth_Adapter_DbTable</classname>) est principalement
  190. l'<emphasis>authentification</emphasis> et non
  191. l'<emphasis>autorisation</emphasis> (ou contrôle d'accès), il existe quelques
  192. exemples et problèmes qui franchissent la limite des domaines auxquels ils
  193. appartiennent. Selon la façon dont vous avez décidé d'expliquer votre problème, il
  194. semble parfois raisonnable de résoudre ce qui pourrait ressembler à un problème
  195. d'autorisation dans l'adaptateur d'authentification.
  196. </para>
  197. <para>
  198. Ceci étant dit, <classname>Zend_Auth_Adapter_DbTable</classname> possède des mécanismes
  199. qui sont construits de telle sorte qu'ils peuvent être démultipliés pour ajouter des
  200. contrôles supplémentaires au moment de l'authentification pour résoudre quelques
  201. problèmes communs d'utilisateur.
  202. </para>
  203. <programlisting language="php"><![CDATA[
  204. // La valeur du champs "etat" d'un compte
  205. // ne doit pas être égal à "compromis"
  206. $adapter = new Zend_Auth_Adapter_DbTable($db,
  207. 'utilisateurs',
  208. 'login',
  209. 'password',
  210. 'MD5(?) AND etat != "compromis"');
  211. // La valeur du champs "actif" d'un compte
  212. // doit être égal à "TRUE"
  213. $adapter = new Zend_Auth_Adapter_DbTable($db,
  214. 'utilisateurs',
  215. 'login',
  216. 'password',
  217. 'MD5(?) AND actif = "TRUE"');
  218. ]]></programlisting>
  219. <para>
  220. Un autre scénario possible est l'implantation d'un mécanisme de "salting".
  221. "Salting" est un terme se référant une technique qui peut fortement améliorer la
  222. sécurité de votre application. C'est basé sur l'idée que concaténer une chaîne
  223. aléatoire à tout mot de passe rend impossible la réussite d'une attaque de type "brute
  224. force" sur la base de données en utilisant des valeurs préalablement hashées issues
  225. d'un dictionnaire.
  226. </para>
  227. <para>
  228. Par conséquent nous devons modifier notre table pour stocker notre chaîne de
  229. "salt" aléatoire&#160;:
  230. </para>
  231. <programlisting language="php"><![CDATA[
  232. $sqlAlter = "ALTER TABLE [users] "
  233. . "ADD COLUMN [password_salt] "
  234. . "AFTER [password]";
  235. $dbAdapter->query($sqlAlter);
  236. ]]></programlisting>
  237. <para>
  238. Voici une méthode simple pour générer une chaîne aléatoire pour chaque
  239. utilisateur à leur enregistrement&#160;:
  240. </para>
  241. <programlisting language="php"><![CDATA[
  242. for ($i = 0; $i < 50; $i++)
  243. {
  244. $dynamicSalt .= chr(rand(33, 126));
  245. }
  246. ]]></programlisting>
  247. <para>Et maintenant, construisons l'adaptateur&#160;:</para>
  248. <programlisting language="php"><![CDATA[
  249. $adapter = new Zend_Auth_Adapter_DbTable(
  250. $db,
  251. 'users',
  252. 'username',
  253. 'password',
  254. "MD5(CONCAT('"
  255. . Zend_Registry::get('staticSalt')
  256. . "', ?, password_salt))"
  257. );
  258. ]]></programlisting>
  259. <note>
  260. <para>
  261. Vous pouvez encore améliorer la sécurité en utilisant une chaîne de "salt"
  262. statique codée en dur dans votre application. Dans le cas ou la base de données est
  263. compromise (par exemple par une attaque de type injection <acronym>SQL</acronym>)
  264. mais que votre serveur Web est intact, les données sont inutilisables par
  265. l'attaquant.
  266. </para>
  267. </note>
  268. <para>
  269. Une autre alternative est d'utiliser la méthode <methodname>getDbSelect()</methodname>
  270. de la classe <classname>Zend_Auth_Adapter_DbTable</classname> après la construction de
  271. l'adaptateur. Cette méthode retournera une instance d'objet
  272. <classname>Zend_Db_Select</classname> utilisée pour réaliser la routine
  273. <methodname>authenticate()</methodname>. Il est important de noter que cette méthode
  274. retournera toujours le même objet, que la méthode
  275. <methodname>authenticate()</methodname> a été appelée ou non. Cet objet
  276. <emphasis>ne comportera aucune</emphasis> information d'identité ou de crédit puisque
  277. celles-ci sont placées dans l'objet select au moment de
  278. <methodname>authenticate()</methodname>.
  279. </para>
  280. <para>
  281. Un exemple de situation nécessitant l'utilisation de la méthode
  282. <methodname>getDbSelect()</methodname> serait de vérifier le statut d'un utilisateur,
  283. en d'autres termes pour voir si le compte d'un utilisateur est activé.
  284. </para>
  285. <programlisting language="php"><![CDATA[
  286. // En continuant avec l'exemple ci-dessus
  287. $adapter = new Zend_Auth_Adapter_DbTable(
  288. $db,
  289. 'users',
  290. 'username',
  291. 'password',
  292. 'MD5(?)'
  293. );
  294. // Récupérer l'objet select (par référence)
  295. $select = $adapter->getDbSelect();
  296. $select->where('active = "TRUE"');
  297. // Authentification, ceci s'assure que users.active = TRUE
  298. $adapter->authenticate();
  299. ]]></programlisting>
  300. </sect2>
  301. </sect1>