Zend_OpenId-Provider.xml 17 KB

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