Zend_Auth_Adapter_DbTable.xml 15 KB

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