Zend_OpenId-Provider.xml 17 KB

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