Zend_OpenId-Provider.xml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 14978 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.openid.provider">
  5. <title>Zend_OpenId_Provider</title>
  6. <para>
  7. <classname>Zend_OpenId_Provider</classname> kann verwendet werden um OpenID Server zu implementieren. Dieses
  8. Kapitel bietet Beispiele die Demonstrieren wie ein sehr einfacher Server erstellt werden kann. Für
  9. die Implementierung eines produktiven OpenId Servers (wie zum Beispiel
  10. <ulink url="http://www.myopenid.com">www.myopenid.com</ulink>) kann es aber notwendig sein mit
  11. komplexeren Problemen umzugehen.
  12. </para>
  13. <sect2 id="zend.openid.provider.start">
  14. <title>Schellstart</title>
  15. <para>
  16. Das folgende Beispiel beinhaltet Code für das Erstellen eines Benutzerzugang indem
  17. <classname>Zend_OpenId_Provider::register</classname> verwendet wird. Das Link-Element mit
  18. <code>rel="openid.server"</code> zeigt auf das eigene Serverscript. Wenn diese Identität zu einer
  19. OpenID-aktivierten Seite übertragen wird, wird eine Authentifizierung zu diesem Server durchgeführt.
  20. </para>
  21. <para>
  22. Der Code vor dem &lt;html&gt; Tag ist nur ein Trick der automatisch den Benutzerzugang erstellt.
  23. Man benötigt solch einen Code nicht wenn echte Identitäten verwendet werden.
  24. </para>
  25. <example id="zend.openid.provider.example-1">
  26. <title>Die Identität</title>
  27. <programlisting role="php"><![CDATA[
  28. <?php
  29. // eine Testidentität erstellen
  30. define("TEST_SERVER", Zend_OpenId::absoluteURL("example-8.php"));
  31. define("TEST_ID", Zend_OpenId::selfURL());
  32. define("TEST_PASSWORD", "123");
  33. $server = new Zend_OpenId_Provider();
  34. if (!$server->hasUser(TEST_ID)) {
  35. $server->register(TEST_ID, TEST_PASSWORD);
  36. }
  37. ?>
  38. <html><head>
  39. <link rel="openid.server" href="<?php echo TEST_SERVER;?>" />
  40. </head><body>
  41. <?php echo TEST_ID;?>
  42. </body></html>
  43. ]]>
  44. </programlisting>
  45. </example>
  46. <para>
  47. Das folgende Identitäts-Serverscript behandelt zwei Arten von Anfragen von OpenID-aktivierten Sites
  48. (for Assoziation und Authentifizierung). Beide von Ihnen werden von der gleichen Methode behandelt:
  49. <classname>Zend_OpenId_Provider::handle</classname>. Die zwei Argumente für
  50. <classname>Zend_OpenId_Provider</classname> Konstruktor sind die URLs des Logins und der Vertrauten Seite,
  51. welche die Eingabe des End-Benutzers abfragen.
  52. </para>
  53. <para>
  54. Bei Erfolg gibt die Methode <classname>Zend_OpenId_Provider::handle</classname> einen String zurück der zur
  55. OpenID-aktivierten Seite zurück übergeben werden sollte. Bei einem fehler wird <code>false</code>
  56. zurückgegeben. Dieses Beispiel gibt eine HTTP 403 Antwort zurück wenn
  57. <classname>Zend_OpenId_Provider::handle</classname> fehlschlägt. Man erhält diese Antwort
  58. wenn man dieses Skript mit einem Web-Browser öffnet, weil es eine nicht-OpenID
  59. konforme Anfrage sendet.
  60. </para>
  61. <example id="zend.openid.provider.example-2">
  62. <title>Einfacher Identitäts Provider</title>
  63. <programlisting role="php"><![CDATA[
  64. $server = new Zend_OpenId_Provider("example-8-login.php",
  65. "example-8-trust.php");
  66. $ret = $server->handle();
  67. if (is_string($ret)) {
  68. echo $ret;
  69. } else if ($ret !== true) {
  70. header('HTTP/1.0 403 Forbidden');
  71. echo 'Verboten';
  72. }
  73. ]]>
  74. </programlisting>
  75. </example>
  76. <note>
  77. <para>
  78. Es ist eine gute Idee eine sichere Verbindung (HTTPS) für diese Skripte zu verwenden - und
  79. speziell für die folgenden interaktiven Scripte - um den Diebstahl von Passwörtern zu verhindern.
  80. </para>
  81. </note>
  82. <para>
  83. Das folgende Skript implementiert einen Login Schirm für einen Identitäts Server indem
  84. <classname>Zend_OpenId_Provider</classname> verwendet wird und leitet zu dieser Seite weiter wenn ein
  85. benötigter Benutzer sich noch nicht eingeloggt hat. Auf dieser Seite gibt der Benutzer sein
  86. Passwort an um sich anzumelden.
  87. </para>
  88. <para>
  89. Es sollte das Passwort "123" verwendet werden das im obigen Identitäts Skript verwendet wurde.
  90. </para>
  91. <para>
  92. Bei Abschicken, ruft das Skript <classname>Zend_OpenId_Provider::login</classname> mit der akzeptierten
  93. Benutzer Identität und dem Passwort auf, und leitet anschließend zum Hauptskript des Identitäts
  94. Providers zurück. Bei Erfolg baut <classname>Zend_OpenId_Provider::login</classname> eine Session zwischen dem
  95. Benutzer und dem Identitäts-Provider auf und speichert die Informationen über den Benutzer der nun
  96. angemeldet ist. Alle folgenden Anfragen vom gleichen Benutzer benötigen keine Login-Prozedur mehr -
  97. selbst wenn diese von einer anderen OpenID aktivierten Web-Seite kommen.
  98. </para>
  99. <note>
  100. <para>
  101. Es ist zu beachten das die Session nur zwischen den End-Benutzer und dem Identitäts-Provider
  102. existiert. OpenID aktivierte Seiten wissen nichts darüber.
  103. </para>
  104. </note>
  105. <example id="zend.openid.provider.example-3">
  106. <title>Einfacher Login Schirm</title>
  107. <programlisting role="php"><![CDATA[
  108. <?php
  109. $server = new Zend_OpenId_Provider();
  110. if ($_SERVER['REQUEST_METHOD'] == 'POST' &&
  111. isset($_POST['openid_action']) &&
  112. $_POST['openid_action'] === 'login' &&
  113. isset($_POST['openid_identifier']) &&
  114. isset($_POST['openid_password'])) {
  115. $server->login($_POST['openid_identifier'],
  116. $_POST['openid_password']);
  117. Zend_OpenId::redirect("example-8.php", $_GET);
  118. }
  119. ?>
  120. <html>
  121. <body>
  122. <form method="post">
  123. <fieldset>
  124. <legend>OpenID Login</legend>
  125. <table border=0>
  126. <tr>
  127. <td>Name:</td>
  128. <td>
  129. <input type="text"
  130. name="openid_identifier"
  131. value="<?php echo htmlspecialchars($_GET['openid_identity']);?>">
  132. </td>
  133. </tr>
  134. <tr>
  135. <td>Passwort:</td>
  136. <td>
  137. <input type="text"
  138. name="openid_password"
  139. value="">
  140. </td>
  141. </tr>
  142. <tr>
  143. <td>&nbsp;</td>
  144. <td>
  145. <input type="submit"
  146. name="openid_action"
  147. value="login">
  148. </td>
  149. </tr>
  150. </table>
  151. </fieldset>
  152. </form>
  153. </body>
  154. </html>
  155. ]]>
  156. </programlisting>
  157. </example>
  158. <para>
  159. Der Fakt das der Benutzer jetzt angemeldet ist bedeutet nicht das die Authentifizierung
  160. notwendigerweise erfolgreich sein muß. Der Benutzer kann entscheiden das er der betreffenden
  161. OpenID aktivierten Seite nicht vertraut. Der folgende Vertrauens-Schirm erlaubt dem Endbenutzer
  162. diese Wahl zu treffen. Diese Wahl kann entweder nur für die aktuelle Anfrage oder für "immer"
  163. gemacht werden. Im zweiten Fall werden Informationen über vertrauenswürdige/nicht
  164. vertrauenswürdige Seiten in einer internen Datenbank gespeichert, und alle folgenden
  165. Authentifizierungs Anfragen von dieser Seite werden automatisch gehandhabt ohne einer
  166. Interaktion des Benutzers.
  167. </para>
  168. <example id="zend.openid.provider.example-4">
  169. <title>Einfacher Vertrauens Schirm</title>
  170. <programlisting role="php"><![CDATA[
  171. <?php
  172. $server = new Zend_OpenId_Provider();
  173. if ($_SERVER['REQUEST_METHOD'] == 'POST' &&
  174. isset($_POST['openid_action']) &&
  175. $_POST['openid_action'] === 'trust') {
  176. if (isset($_POST['allow'])) {
  177. if (isset($_POST['forever'])) {
  178. $server->allowSite($server->getSiteRoot($_GET));
  179. }
  180. $server->respondToConsumer($_GET);
  181. } else if (isset($_POST['deny'])) {
  182. if (isset($_POST['forever'])) {
  183. $server->denySite($server->getSiteRoot($_GET));
  184. }
  185. Zend_OpenId::redirect($_GET['openid_return_to'],
  186. array('openid.mode'=>'cancel'));
  187. }
  188. }
  189. ?>
  190. <html>
  191. <body>
  192. <p>Eine Seite die sich als
  193. <a href="<?php echo htmlspecialchars($server->getSiteRoot($_GET));?>
  194. <?php echo htmlspecialchars($server->getSiteRoot($_GET));?>
  195. </a>
  196. identifiziert hat uns nach Bestätigung gefragt ob
  197. <a href="<?php echo htmlspecialchars($server->getLoggedInUser());?>">
  198. <?php echo htmlspecialchars($server->getLoggedInUser());?>
  199. </a>
  200. ihre Identitäts URL ist.
  201. </p>
  202. <form method="post">
  203. <input type="checkbox" name="forever">
  204. <label for="forever">für immer</label><br>
  205. <input type="hidden" name="openid_action" value="trust">
  206. <input type="submit" name="allow" value="Allow">
  207. <input type="submit" name="deny" value="Deny">
  208. </form>
  209. </body>
  210. </html>
  211. ]]>
  212. </programlisting>
  213. </example>
  214. <para>
  215. Produktive OpenID Server unterstützen normalerweise die einfache Registrierungs Erweiterung die
  216. es Benutzern erlaubt einige Informationen über ein Benutzerformular beim Provider nachzufragen.
  217. In diesem Fall kann die Vertraute Seite erweitert werden um die Eingabe von angefragten Feldern
  218. zu erlauben oder ein spezielles Benutzerprofil auszuwählen.
  219. </para>
  220. </sect2>
  221. <sect2 id="zend.openid.provider.all">
  222. <title>Kombinierte Skripte</title>
  223. <para>
  224. Es ist möglich alle Provider Funktionalitäten in einem Skript zusammen zu kombinieren. In diesem Fall
  225. werden Login und Vertraute URLs unterdrückt, und <classname>Zend_OpenId_Provider</classname> nimmt an das diese
  226. auf die gleiche Seite zeigen mit einem zusätzlichen "openid.action" GET Argument.
  227. </para>
  228. <note>
  229. <para>
  230. Das folgende Beispiel ist nicht komplett. Es bietet kein GUI für End-Benutzer wie es sein
  231. sollte, aber es führt automatisches Login und Vertrauen durch. Das wird getan um das Beispiel
  232. zu vereinfachen, und echte Server müssen Code von den vorherigen Beispielen inkludieren.
  233. </para>
  234. </note>
  235. <example id="zend.openid.provider.example-5">
  236. <title>Alles zusammen</title>
  237. <programlisting role="php"><![CDATA[
  238. $server = new Zend_OpenId_Provider();
  239. define("TEST_ID", Zend_OpenId::absoluteURL("example-9-id.php"));
  240. define("TEST_PASSWORD", "123");
  241. if ($_SERVER['REQUEST_METHOD'] == 'GET' &&
  242. isset($_GET['openid_action']) &&
  243. $_GET['openid_action'] === 'login') {
  244. $server->login(TEST_ID, TEST_PASSWORD);
  245. unset($_GET['openid_action']);
  246. Zend_OpenId::redirect(Zend_OpenId::selfUrl(), $_GET);
  247. } else if ($_SERVER['REQUEST_METHOD'] == 'GET' &&
  248. isset($_GET['openid_action']) &&
  249. $_GET['openid_action'] === 'trust') {
  250. unset($_GET['openid_action']);
  251. $server->respondToConsumer($_GET);
  252. } else {
  253. $ret = $server->handle();
  254. if (is_string($ret)) {
  255. echo $ret;
  256. } else if ($ret !== true) {
  257. header('HTTP/1.0 403 Forbidden');
  258. echo 'Verboten';
  259. }
  260. }
  261. ]]>
  262. </programlisting>
  263. </example>
  264. <para>
  265. Wenn man dieses Beispiel mit den vorherigen Beispielen vergleicht, die in einzelne Seiten aufgeteilt
  266. sind, sieht man zusätzlich zum Dispatch Code, nur einen Unterschied:
  267. <code>unset($_GET['openid_action'])</code>. Dieser Aufruf von <code>unset</code> ist notwendig um
  268. die nächste Anfrage zum Haupthandler zu routen.
  269. </para>
  270. </sect2>
  271. <sect2 id="zend.openid.provider.sreg">
  272. <title>Einfache Registrierungs Erweiterung (SREG)</title>
  273. <para>
  274. Wieder ist der Code vor dem &lt;html&gt; Tag nur ein Trick um die Funktionalität zu demonstrieren.
  275. Er erstellt einen neuen Benutzerzugang und assoziiert Ihn mit einem Profil (Spitzname und
  276. Passwort). Solche Tricks werden bei ausgelieferten Providern nicht benötigt wo sich End Benutzer
  277. auf OpenID Servern registrieren und Ihre Profile eintragen. Die Implementierung dieses GUI würde
  278. den Rahmen dieses Handbuches sprengen.
  279. </para>
  280. <example id="zend.openid.provider.example-6">
  281. <title>Identität mit Profil</title>
  282. <programlisting role="php"><![CDATA[
  283. <?php
  284. define("TEST_SERVER", Zend_OpenId::absoluteURL("example-10.php"));
  285. define("TEST_ID", Zend_OpenId::selfURL());
  286. define("TEST_PASSWORD", "123");
  287. $server = new Zend_OpenId_Provider();
  288. if (!$server->hasUser(TEST_ID)) {
  289. $server->register(TEST_ID, TEST_PASSWORD);
  290. $server->login(TEST_ID, TEST_PASSWORD);
  291. $sreg = new Zend_OpenId_Extension_Sreg(array(
  292. 'nickname' =>'test',
  293. 'email' => 'test@test.com'
  294. ));
  295. $root = Zend_OpenId::absoluteURL(".");
  296. Zend_OpenId::normalizeUrl($root);
  297. $server->allowSite($root, $sreg);
  298. $server->logout();
  299. }
  300. ?>
  301. <html>
  302. <head>
  303. <link rel="openid.server" href="<?php echo TEST_SERVER;?>" />
  304. </head>
  305. <body>
  306. <?php echo TEST_ID;?>
  307. </body>
  308. </html>
  309. ]]>
  310. </programlisting>
  311. </example>
  312. <para>
  313. Die Identität sollte jetzt der OpenID-aktivierten Webseite übergeben werden (verwende das einfache
  314. Registrierungs Erweiterung Beispiel aus dem vorherigen Kapitel) und sie sollte das folgende OpenID
  315. Server Skript verwenden.
  316. </para>
  317. <para>
  318. Dieses Skript ist eine Variation des Skripts im "Alles zusammen" Beispiel. Es verwendet den gleichen
  319. automatischen Login Mechanismus, aber es enthält keinen Code für die Vertrauens-Seite. Der Benutzer
  320. hat dem Beispielskript bereits für immer vertraut. Dieses Vertrauen wurde durch den Aufruf der
  321. <classname>Zend_OpenId_Provider::allowSite()</classname> Methode im Identitäts Skript hergestellt. Die gleiche
  322. Methode assoziiert das Profil mit der vertrauten Seite. Dieses Profil wird automatisch für eine
  323. Anfrage von der vertrauten URL zurückgegeben.
  324. </para>
  325. <para>
  326. Um die einfache Registrierungs Erweiterung funktionsfähig zu machen ist einfach die Übergabe einer
  327. Instanz von <classname>Zend_OpenId_Extension_Sreg</classname> als zweites Argument der
  328. <classname>Zend_OpenId_Provider::handle()</classname> Methode.
  329. </para>
  330. <example id="zend.openid.provider.example-7">
  331. <title>Provider mit SREG</title>
  332. <programlisting role="php"><![CDATA[
  333. $server = new Zend_OpenId_Provider();
  334. $sreg = new Zend_OpenId_Extension_Sreg();
  335. define("TEST_ID", Zend_OpenId::absoluteURL("example-10-id.php"));
  336. define("TEST_PASSWORD", "123");
  337. if ($_SERVER['REQUEST_METHOD'] == 'GET' &&
  338. isset($_GET['openid_action']) &&
  339. $_GET['openid_action'] === 'login') {
  340. $server->login(TEST_ID, TEST_PASSWORD);
  341. unset($_GET['openid_action']);
  342. Zend_OpenId::redirect(Zend_OpenId::selfUrl(), $_GET);
  343. } else if ($_SERVER['REQUEST_METHOD'] == 'GET' &&
  344. isset($_GET['openid_action']) &&
  345. $_GET['openid_action'] === 'trust') {
  346. echo "UNTRUSTED DATA" ;
  347. } else {
  348. $ret = $server->handle(null, $sreg);
  349. if (is_string($ret)) {
  350. echo $ret;
  351. } else if ($ret !== true) {
  352. header('HTTP/1.0 403 Forbidden');
  353. echo 'Verboten';
  354. }
  355. }
  356. ]]>
  357. </programlisting>
  358. </example>
  359. </sect2>
  360. <sect2 id="zend.openid.provider.else">
  361. <title>Sonst noch was?</title>
  362. <para>
  363. Das Erstellen von OpenID Providern ist eine viel seltenere Aufgabe als die Erstellung von
  364. OpenID-aktivierten Sites, weswegen dieses Handbuch nicht alle <classname>Zend_OpenId_Provider</classname>
  365. Features so ausführlich abdeckt wie es für <classname>Zend_OpenId_Consumer</classname> getan wurde.
  366. </para>
  367. <para>
  368. Zusammenfassend enthält <classname>Zend_OpenId_Provider</classname>:
  369. </para>
  370. <itemizedlist>
  371. <listitem>
  372. <para>
  373. Ein Set von Methoden um ein End-Benutzer GUI zu Erstellen das es Benutzern erlauben sich
  374. zu registrieren und Ihre vertrauten Seiten und Profile zu managen.
  375. </para>
  376. </listitem>
  377. <listitem>
  378. <para>
  379. Einen abstrakten Speicherlayer um Informationen über Benutzer, Ihre Seiten und Ihre Profile
  380. zu speichern. Es speichert auch Assoziationen zwischen Providern und OpenID-aktivierten
  381. Seiten. Dieser Layer ist ähnlich dem der <classname>Zend_OpenId_Consumer</classname> Klasse. Er
  382. verwendet standardmäßg auch den Dateispeicher, kann aber mit anderen Backends abgeleitet
  383. werden.
  384. </para>
  385. </listitem>
  386. <listitem>
  387. <para>
  388. Einen Abtraktions Benutzer-Assoziierungs Layer der Web-Browser von Benutzern mit
  389. eingeloggten Identitäten verknüpfen kann.
  390. </para>
  391. </listitem>
  392. </itemizedlist>
  393. <para>
  394. Die <classname>Zend_OpenId_Provider</classname> Klasse versucht nicht alle möglichen Features abzudecken die
  395. von OpenID Servern implementiert werden können, z.B. wie digitale Zertifikate, kann aber einfach
  396. erweitert werden durch <classname>Zend_OpenId_Extension</classname>s oder durch standardmäßige
  397. Objektorientierte Erweiterungen.
  398. </para>
  399. </sect2>
  400. </sect1>
  401. <!--
  402. vim:se ts=4 sw=4 et:
  403. -->