Zend_Auth_Adapter_OpenId.xml 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!-- EN-Revision: 15617 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.auth.adapter.openid">
  5. <title>Authentification OpenID</title>
  6. <sect2 id="zend.auth.adapter.openid.introduction">
  7. <title>Introduction</title>
  8. <para>
  9. <classname>Zend_Auth_Adapter_OpenId</classname> permet l'authentification à travers un
  10. serveur distant OpenID. Une telle authentification attend que l'utilisateur fournisse à
  11. l'application Web son identifiant OpenID. L'utilisateur est alors redirigé vers un
  12. fournisseur de services OpenID, afin de s'identifier en rapport avec l'application Web
  13. utilisée. Un mot de passe ou un autre procédé est utilisé, et celui-ci n'est jamais
  14. connu de l'application Web originale.
  15. </para>
  16. <para>
  17. L'identité OpenID est juste une URI qui pointe vers une page avec des
  18. informations décrivant le serveur à utiliser et des informations sur l'utilisateur.
  19. Pour plus d'informations, consultez
  20. <ulink url="http://www.openid.net/">le site officiel OpenID</ulink>ou une version
  21. française <ulink url="http://www.openidfrance.fr">OpenIDFrance</ulink>.
  22. </para>
  23. <para>
  24. La classe <classname>Zend_Auth_Adapter_OpenId</classname> utilise
  25. <classname>Zend_OpenId_Consumer</classname> qui sert à gérer le protocole OpenID.
  26. </para>
  27. <note>
  28. <para>
  29. <classname>Zend_OpenId</classname> utilise
  30. <ulink url="http://www.php.net/manual/fr/ref.gmp.php">l'extension GMP</ulink>, si
  31. disponible. L'utilisation de cette extension est recommandée pour améliorer les
  32. performances de <classname>Zend_Auth_Adapter_OpenId</classname>.
  33. </para>
  34. </note>
  35. </sect2>
  36. <sect2 id="zend.auth.adapter.openid.specifics">
  37. <title>Spécifications</title>
  38. <para>
  39. Comme toute autre classe adaptateur de <classname>Zend_Auth</classname>,
  40. <classname>Zend_Auth_Adapter_OpenId</classname> implémente
  41. <classname>Zend_Auth_Adapter_Interface</classname>, qui définit une seule méthode :
  42. <code>authenticate()</code>. Elle est utilisée pour l'authentification elle-même, une
  43. fois que l'objet est prêt. La préparation d'un objet OpenID nécessite quelques options
  44. à passer à <classname>Zend_OpenId</classname>.
  45. </para>
  46. <para>
  47. A la différence des autres adaptateurs <classname>Zend_Auth</classname>, l'adaptateur
  48. OpenID utilise une authentification sur un serveur externe à l'application, et
  49. nécessitera donc deux requêtes HTTP. Ainsi
  50. <classname>Zend_Auth_Adapter_OpenId::authenticate()</classname> devra être appelée deux
  51. fois : d'abord pour rediriger l'utilisateur vers le serveur OpenID (rien ne sera donc
  52. retourné par la méthode), qui lui-même redirigera l'utilisateur vers l'application, où
  53. un deuxième appel de méthode
  54. <classname>Zend_Auth_Adapter_OpenId::authenticate()</classname> vérifiera la signature
  55. et complétera le processus. Un objet <classname>Zend_Auth_Result</classname> sera alors
  56. cette fois-ci retourné.
  57. </para>
  58. <para>
  59. L'exemple suivant montre l'utilisation de
  60. <classname>Zend_Auth_Adapter_OpenId</classname>.
  61. <classname>Zend_Auth_Adapter_OpenId::authenticate()</classname> est appelée deux fois.
  62. La première fois juste après avoir envoyé le formulaire, lorsque
  63. <code>$_POST['openid_action']</code> vaut <code>"login"</code>, et la deuxième fois
  64. après la redirection du serveur OpenID vers l'application, lorsque
  65. <code>$_GET['openid_mode']</code> ou <code>$_POST['openid_mode']</code> existe.
  66. </para>
  67. <programlisting language="php"><![CDATA[
  68. <?php
  69. $status = "";
  70. $auth = Zend_Auth::getInstance();
  71. if ((isset($_POST['openid_action']) &&
  72. $_POST['openid_action'] == "login" &&
  73. !empty($_POST['openid_identifier'])) ||
  74. isset($_GET['openid_mode']) ||
  75. isset($_POST['openid_mode'])) {
  76. $result = $auth->authenticate(
  77. new Zend_Auth_Adapter_OpenId(@$_POST['openid_identifier']));
  78. if ($result->isValid()) {
  79. $status = "You are logged-in as "
  80. . $auth->getIdentity()
  81. . "<br>\n";
  82. } else {
  83. $auth->clearIdentity();
  84. foreach ($result->getMessages() as $message) {
  85. $status .= "$message<br>\n";
  86. }
  87. }
  88. } else if ($auth->hasIdentity()) {
  89. if (isset($_POST['openid_action']) &&
  90. $_POST['openid_action'] == "logout") {
  91. $auth->clearIdentity();
  92. } else {
  93. $status = "You are logged-in as "
  94. . $auth->getIdentity()
  95. . "<br>\n";
  96. }
  97. }
  98. ?>
  99. <html><body>
  100. <?php echo htmlspecialchars($status);?>
  101. <form method="post"><fieldset>
  102. <legend>OpenID Login</legend>
  103. <input type="text" name="openid_identifier" value="">
  104. <input type="submit" name="openid_action" value="login">
  105. <input type="submit" name="openid_action" value="logout">
  106. </fieldset></form></body></html>
  107. ]]></programlisting>
  108. <para>
  109. Il est possible de personnaliser le processus, pour par exemple demander une
  110. redirection du serveur OpenID vers l'application, sur une page différente de la
  111. première. Ceci peut être fait avec des objets personnalisés
  112. <classname>Zend_OpenId_Consumer_Storage</classname> ou
  113. <classname>Zend_Controller_Response</classname>. Vous pouvez aussi utiliser le procédé
  114. "Simple Registration" pour récupérer les informations au sujet de l'utilisateur, en
  115. provenance du serveur OpenID. Toutes ces possibilités sont écrites et détaillées dans
  116. le chapitre concernant <classname>Zend_OpenId_Consumer</classname>.
  117. </para>
  118. </sect2>
  119. </sect1>