Zend_OpenId-Consumer.xml 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15157 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.openid.consumer">
  5. <title>Zend_OpenId_Consumer Grundlagen</title>
  6. <para>
  7. <classname>Zend_OpenId_Consumer</classname> kann verwendet werdeb um OpenID Authentifizierung auf Webseiten
  8. zu implementieren.
  9. </para>
  10. <sect2 id="zend.openid.consumer.authentication">
  11. <title>OpenID Authentifikation</title>
  12. <para>
  13. Aus der Sicht eines Website Entwicklers, geschieht die Authentifikation von OpenID in drei Schritten:
  14. </para>
  15. <orderedlist>
  16. <listitem>
  17. <para>
  18. Zeige das OpenID Authentifikations Formular
  19. </para>
  20. </listitem>
  21. <listitem>
  22. <para>
  23. Akzeptiere die OpenID Identität und übergib Sie an den OpenID Provider
  24. </para>
  25. </listitem>
  26. <listitem>
  27. <para>
  28. Überprüfe die Antwort des OpenID Providers
  29. </para>
  30. </listitem>
  31. </orderedlist>
  32. <para>
  33. Das OpenID Authentifikations Protokoll benötigt aktuell mehrere, aber viele von Ihnen sind
  34. innerhalb von <classname>Zend_OpenId_Consumer</classname> gekapselt, und deshalb für den Entwickler transparent.
  35. </para>
  36. <para>
  37. Der End-Benutzer initiiert den OpenID Authentifikations Prozess indem er Seine oder Ihre
  38. Identifikations Daten in der entsprechenden Form übermittelt. Das folgende Beispiel zeigt ein
  39. einfaches Formular das einen OpenID Identifikator akzeptiert. Es gilt zu beachten das das Beispiel
  40. nur einen Login demonstriert.
  41. </para>
  42. <example id="zend.openid.consumer.example-1">
  43. <title>Das einfache OpenID Login Formular</title>
  44. <programlisting role="php"><![CDATA[
  45. <html><body>
  46. <form method="post" action="example-1_2.php"><fieldset>
  47. <legend>OpenID Login</legend>
  48. <input type="text" name="openid_identifier">
  49. <input type="submit" name="openid_action" value="login">
  50. </fieldset></form></body></html>
  51. ]]></programlisting>
  52. </example>
  53. <para>
  54. Dieses Formular übergibt bei der Übertragung eine OpenID Identität an das folgende PHP Skript welches
  55. den zweiten Schritt der Authentifizierung durchführt. Das PHP Skript muss in diesem Schritt nur die
  56. <classname>Zend_OpenId_Consumer::login()</classname> Methode aufrufen. Das erste Argument dieser Methode
  57. akzeptiert eine OpenID Identität, und das zweite ist die URL des Skripts das den dritten und letzten
  58. Schritt der Authentifizierung behandelt.
  59. </para>
  60. <example id="zend.openid.consumer.example-1_2">
  61. <title>Der Authentifizierungs Anfrage Handler</title>
  62. <programlisting role="php"><![CDATA[
  63. $consumer = new Zend_OpenId_Consumer();
  64. if (!$consumer->login($_POST['openid_identifier'], 'example-1_3.php')) {
  65. die("OpenID Login fehlgeschlagen.");
  66. }
  67. ]]></programlisting>
  68. </example>
  69. <para>
  70. Die <classname>Zend_OpenId_Consumer::login()</classname> Methode führt eine Suche nach einem gegebenen Identifikator
  71. durch und findet, bei Erfolg, die Adresse des Identitäts Providers und dessen Lokalen Idenzifizierer
  72. durch. Dann erstellt es eine Assoziation zum gegebenen Provider sodas beide, die Site und der
  73. Provider, um das gleiche Geheimnis teilen das verwendet wird um nachfolgende Nachrichten zu
  74. verschlüsseln. Letztendlich wird eine Authentifikations Anfrage an den Provider übergeben. Diese
  75. Anfrage leitet den Web-Browser des End-Benutzers zu einer OpenID Server Site um, wo der
  76. Benutzer die Möglichkeit habt den Authentifizierungs Prozess fortzuführen.
  77. </para>
  78. <para>
  79. Ein OpenID Provider fragt nochmalerweise Benutzer nach Ihrem Passwort (wenn Sie vorher noch nicht
  80. angemeldet waren), wenn der Benutzer dieser Site vertraut und welche Informationen zu der Site
  81. zurückgegeben werden können. Diese Interaktionen sind für den OpenID Konsument nicht sichtbar
  82. sodas es für Ihn keine Möglichkeit gibt das Benutzerpasswort oder andere Informationen zu
  83. bekommen bei denen der Benutzer nicht gesagt hat das der OpenId Provider Sie teilen darf.
  84. </para>
  85. <para>
  86. Bei Erfolg wird <classname>Zend_OpenId_Consumer::login()</classname> nicht zurückkommen, sondern eine HTTP
  87. Umleitung durchführt. Trotzdem wird im Falle eine Fehler ein false zurückgeben wird. Fehler können
  88. durch eine ungültige Identität, einen Provider der nicht antwortet, Kommunikations Fehler, usw.
  89. auftreten.
  90. </para>
  91. <para>
  92. Der dritte Schritt der Authentifikation wird durch die Antwort vom OpenID Provider initiiert,
  93. nachdem dieser das Benutzerpasswort authentifiziert hat. Diese Antwort wird indirekt, als HTTP
  94. Umleitung übergeben, indem der Webbrowsers des End-Benutzers verwendet wird. Der Konsument muß nun
  95. einfach prüfen ob die Antwort gültig ist.
  96. </para>
  97. <example id="zend.openid.consumer.example-1_3">
  98. <title>Der Authentifizierungs Antwort Prüfer</title>
  99. <programlisting role="php"><![CDATA[
  100. $consumer = new Zend_OpenId_Consumer();
  101. if ($consumer->verify($_GET, $id)) {
  102. echo "GÜLTIG ". htmlspecialchars($id);
  103. } else {
  104. echo "UNGÜLTIG" . htmlspecialchars($id);
  105. }
  106. ]]></programlisting>
  107. </example>
  108. <para>
  109. Diese Prüfung wird durchgeführt indem die <classname>Zend_OpenId_Consumer::verify</classname> Methode
  110. verwendet wird, welche ein ganzes Array von HTTP Anfrage Argumenten entgegennimmt und prüft ob
  111. diese Antwort durch den OpenID Provider richtig signiert wurde. Sie kann die erhaltete OpenID
  112. Identität, die vom Endbenutzer im ersten Schritt angegeben wurde, zuordnen, indem ein zweites,
  113. optionales, Argument eingegeben wird.
  114. </para>
  115. </sect2>
  116. <sect2 id="zend.openid.consumer.combine">
  117. <title>Alle Schritte in einer Seite kombinieren</title>
  118. <para>
  119. Das folgende Beispiel kombiniert alle drei Schritte in einem Skript. Es bietet keine neuen
  120. Funktionalitäten. Der Vorteil der Verwendung eines einzelnen Skripts ist, das Entwickler keine
  121. URLs für das Skript definieren muss, das den nächsten Schritt durchführt. Standardmäßig verwenden
  122. alle Schritte die gleiche URL. Trotzdem enthält das Skript nun etwas Dispatchcode um den korrekten
  123. Code für jeden Schritt der Authentifikation aufzurufen.
  124. </para>
  125. <example id="zend.openid.consumer.example-2">
  126. <title>Das komplette Skript für ein OpenID Login</title>
  127. <programlisting role="php"><![CDATA[
  128. $status = "";
  129. if (isset($_POST['openid_action']) &&
  130. $_POST['openid_action'] == "login" &&
  131. !empty($_POST['openid_identifier'])) {
  132. $consumer = new Zend_OpenId_Consumer();
  133. if (!$consumer->login($_POST['openid_identifier'])) {
  134. $status = "OpenID Login fehlgeschlagen.";
  135. }
  136. } else if (isset($_GET['openid_mode'])) {
  137. if ($_GET['openid_mode'] == "id_res") {
  138. $consumer = new Zend_OpenId_Consumer();
  139. if ($consumer->verify($_GET, $id)) {
  140. $status = "GÜLTIG " . htmlspecialchars($id);
  141. } else {
  142. $status = "UNGÜLTIG " . htmlspecialchars($id);
  143. }
  144. } else if ($_GET['openid_mode'] == "cancel") {
  145. $status = "ABGEBROCHEN";
  146. }
  147. }
  148. ?>
  149. <html><body>
  150. <?php echo "$status<br>" ?>
  151. <form method="post">
  152. <fieldset>
  153. <legend>OpenID Login</legend>
  154. <input type="text" name="openid_identifier" value=""/>
  155. <input type="submit" name="openid_action" value="login"/>
  156. </fieldset>
  157. </form>
  158. </body></html>
  159. ]]></programlisting>
  160. </example>
  161. <para>
  162. Zusätzlich unterscheidet dieser Code zwischen abgebrochen und ungültigen Authentifizierungs Antworten.
  163. Der Provider gibt eine abgebrochene Antwort zurück, wenn der Identitäts Provider die gegebene
  164. Identität nicht unterstützt, der Benutzer nicht angemeldet ist, oder der Benutzer der Seite
  165. nicht vertraut. Eine ungültige Antwort zeigt an das die Antwort dem OpenId Protokoll nicht
  166. entspricht oder nicht korrekt signiert wurde.
  167. </para>
  168. </sect2>
  169. <sect2 id="zend.openid.consumer.realm">
  170. <title>Konsumenten Bereiche</title>
  171. <para>
  172. Wenn eine OpenID-aktivierte Site eine Authentifikations Anfrage an einen Provider übergibt,
  173. identifiziert diese sich selbst mit einer Bereichs URL. Diese URL kann als Root der vertrauten
  174. Site betrachtet werden. Wenn der Benutzer der Bereichs URL vertraut, dann sollte er oder Sie das
  175. auch bei der passenden und den untergeordneten URLs tun.
  176. </para>
  177. <para>
  178. Standardmäßig wird der Bereich automatisch auf die URL des Verzeichnisses gesetzt indem das Login
  179. Skript ist. Dieser Standardwert ist für die meisten, aber nicht alle, Fälle ausreichend. Manchmal
  180. sollte einer komplette Domain, und nicht einem Verzeichnis vertraut werden. Oder sogar einer
  181. Kombination von verschiedenen Servern in einer Domain.
  182. </para>
  183. <para>
  184. Um den Standardwert zu überschreiben müssen Entwickler die Bereichs URL als drittes Argument an die
  185. <classname>Zend_OpenId_Consumer::login</classname> Methode übergeben. Im folgenden Beispiel fragt eine einzelne
  186. Interaktion nach vertrauten Zugriff auf alle php.net Sites.
  187. </para>
  188. <example id="zend.openid.consumer.example-3_2">
  189. <title>Authentifizierungs Anfrage für spezielle Bereiche</title>
  190. <programlisting role="php"><![CDATA[
  191. $consumer = new Zend_OpenId_Consumer();
  192. if (!$consumer->login($_POST['openid_identifier'],
  193. 'example-3_3.php',
  194. 'http://*.php.net/')) {
  195. die("OpenID Login fehlgeschlagen.");
  196. }
  197. ]]></programlisting>
  198. </example>
  199. <para>
  200. Dieses Beispiel implementiert nur den zweiten Schritt der Authentifikation; der erste und dritte
  201. Schritt sind die identisch mit dem ersten Beispiel.
  202. </para>
  203. </sect2>
  204. <sect2 id="zend.openid.consumer.check">
  205. <title>Sofortige Prüfung</title>
  206. <para>
  207. In einigen Fällen muß eine Anwendung nur prüfen ob ein Benutzer bereits auf einem vertrauten
  208. OpenID Server eingeloggt ist ohne einer Interaktion mit dem Benutzer. Die
  209. <classname>Zend_OpenId_Consumer::check</classname> Methode führt genau das durch. Sie wird mit den
  210. gleichen Argumenten wie <classname>Zend_OpenId_Consumer::login</classname> ausgeführt, aber Sie zeigt dem
  211. Benutzer keine OpenID Serverseiten. Aus Sicht des Benutzers ist dieser Prozess transparent, und es
  212. scheint als ob er die Site nie verlässt. Der dritte Schritt ist erfolgreich wenn der
  213. Benutzer bereits angemeldet ist und der Site vertraut, andernfalls ist er erfolglos.
  214. </para>
  215. <example id="zend.openid.consumer.example-4">
  216. <title>Sofortige Prüfung ohne Interaktion</title>
  217. <programlisting role="php"><![CDATA[
  218. $consumer = new Zend_OpenId_Consumer();
  219. if (!$consumer->check($_POST['openid_identifier'], 'example-4_3.php')) {
  220. die("OpenID Login fehlgeschlaten.");
  221. }
  222. ]]></programlisting>
  223. </example>
  224. <para>
  225. Das Beispiel implementiert nur den zweiten Schritt der Authentifikation; der erste und dritte
  226. Schritt sind dem obigen Beispiel ähnlich.
  227. </para>
  228. </sect2>
  229. <sect2 id="zend.openid.consumer.storage">
  230. <title>Zend_OpenId_Consumer_Storage</title>
  231. <para>
  232. Es gibt drei Schritte beim Authentifizierungs Prozess von OpenID, und jeder wird durch eine
  233. separate HTTP Anfrage durchgeführt. Um die Informationen zwischen den Anfragen zu speichern
  234. verwendet <classname>Zend_OpenId_Consumer</classname> einen internen Speicher.
  235. </para>
  236. <para>
  237. Entwickler müssen sich nicht notwendigerweise um die Speicherung kümmern weil
  238. <classname>Zend_OpenId_Consumer</classname> standardmäßig einen dateibasierten Speicher im temporären
  239. Verzeichnis verwendet, ähnlich wie PHP Sessions. Trotzdem ist dieser Speicher nicht in allen
  240. Situationen richtig. Einige Entwickler wollen Informationen in einer Datenbank speichern, wärend
  241. andere einen üblichen Speicher für große Server-Farmen verwenden wollen. Glücklicherweise können
  242. Entwickler den Standardspeicher sehr einfach mit Ihrem eigenen tauschen. Um einen eigenen
  243. Speichermechanismus zu spezifizieren muß nur die <classname>Zend_OpenId_Consumer_Storage</classname>
  244. Klasse erweitert werden und diese Unterklasse dem <classname>Zend_OpenId_Consumer</classname> Konstruktor
  245. im ersten Argument übergeben werden.
  246. </para>
  247. <para>
  248. Das folgende Beispiel demonstriert einen einfachen Speicher Mechanismus der <classname>Zend_Db</classname>
  249. als sein Backend verwendet und drei Gruppen von Funktionen bereitstellt. Der erste Gruppe enthält
  250. Funktionen für die Arbeit mit Assoziationen, wärend die zweite Gruppe erkannte Informationen cacht,
  251. und die dritte Gruppe kann verwendet werden um zu prüfen ob die Antwort eindeutig ist. Die Klasse
  252. kann einfach mit bestehenden oder neuen Datenbanken verwendet werden; wenn die benötigten Tabellen
  253. nicht existieren, wird er Sie erstellen.
  254. </para>
  255. <example id="zend.openid.consumer.example-5">
  256. <title>Datenbank Speicher</title>
  257. <programlisting role="php"><![CDATA[
  258. class DbStorage extends Zend_OpenId_Consumer_Storage
  259. {
  260. private $_db;
  261. private $_association_table;
  262. private $_discovery_table;
  263. private $_nonce_table;
  264. // Übergib das Zend_Db_Adapter Objekt und die Namen der
  265. // benötigten Tabellen
  266. public function __construct($db,
  267. $association_table = "association",
  268. $discovery_table = "discovery",
  269. $nonce_table = "nonce")
  270. {
  271. $this->_db = $db;
  272. $this->_association_table = $association_table;
  273. $this->_discovery_table = $discovery_table;
  274. $this->_nonce_table = $nonce_table;
  275. $tables = $this->_db->listTables();
  276. // Erstelle die Assoziationstabellen wenn Sie nicht existieren
  277. if (!in_array($association_table, $tables)) {
  278. $this->_db->getConnection()->exec(
  279. "create table $association_table (" .
  280. " url varchar(256) not null primary key," .
  281. " handle varchar(256) not null," .
  282. " macFunc char(16) not null," .
  283. " secret varchar(256) not null," .
  284. " expires timestamp" .
  285. ")");
  286. }
  287. // Erstelle die Discoverytabellen wenn Sie nicht existieren
  288. if (!in_array($discovery_table, $tables)) {
  289. $this->_db->getConnection()->exec(
  290. "create table $discovery_table (" .
  291. " id varchar(256) not null primary key," .
  292. " realId varchar(256) not null," .
  293. " server varchar(256) not null," .
  294. " version float," .
  295. " expires timestamp" .
  296. ")");
  297. }
  298. // Erstelle die Nouncetabellen wenn Sie nicht existieren
  299. if (!in_array($nonce_table, $tables)) {
  300. $this->_db->getConnection()->exec(
  301. "create table $nonce_table (" .
  302. " nonce varchar(256) not null primary key," .
  303. " created timestamp default current_timestamp" .
  304. ")");
  305. }
  306. }
  307. public function addAssociation($url,
  308. $handle,
  309. $macFunc,
  310. $secret,
  311. $expires)
  312. {
  313. $table = $this->_association_table;
  314. $secret = base64_encode($secret);
  315. $this->_db
  316. ->query('insert into ' .
  317. $table . " (url, handle, macFunc, secret, expires) " .
  318. "values ('$url', '$handle', '$macFunc', " .
  319. "'$secret', $expires)");
  320. return true;
  321. }
  322. public function getAssociation($url,
  323. &$handle,
  324. &$macFunc,
  325. &$secret,
  326. &$expires)
  327. {
  328. $table = $this->_association_table;
  329. $this->_db->query("delete from $table where expires < " . time());
  330. $res = $this->_db->fetchRow('select handle, macFunc, secret, expires ' .
  331. "from $table where url = '$url'");
  332. if (is_array($res)) {
  333. $handle = $res['handle'];
  334. $macFunc = $res['macFunc'];
  335. $secret = base64_decode($res['secret']);
  336. $expires = $res['expires'];
  337. return true;
  338. }
  339. return false;
  340. }
  341. public function getAssociationByHandle($handle,
  342. &$url,
  343. &$macFunc,
  344. &$secret,
  345. &$expires)
  346. {
  347. $table = $this->_association_table;
  348. $this->_db->query("delete from $table where expires < " . time());
  349. $res = $this->_db
  350. ->fetchRow('select url, macFunc, secret, expires ' .
  351. "from $table where handle = '$handle'");
  352. if (is_array($res)) {
  353. $url = $res['url'];
  354. $macFunc = $res['macFunc'];
  355. $secret = base64_decode($res['secret']);
  356. $expires = $res['expires'];
  357. return true;
  358. }
  359. return false;
  360. }
  361. public function delAssociation($url)
  362. {
  363. $table = $this->_association_table;
  364. $this->_db->query("delete from $table where url = '$url'");
  365. return true;
  366. }
  367. public function addDiscoveryInfo($id,
  368. $realId,
  369. $server,
  370. $version,
  371. $expires)
  372. {
  373. $table = $this->_discovery_table;
  374. $this->_db
  375. ->query("insert into $table " .
  376. "(id, realId, server, version, expires) " .
  377. "values (" .
  378. "'$id', '$realId', '$server', $version, $expires)");
  379. return true;
  380. }
  381. public function getDiscoveryInfo($id,
  382. &$realId,
  383. &$server,
  384. &$version,
  385. &$expires)
  386. {
  387. $table = $this->_discovery_table;
  388. $this->_db->query("delete from $table where expires < " . time());
  389. $res = $this->_db
  390. ->fetchRow('select realId, server, version, expires ' .
  391. "from $table where id = '$id'");
  392. if (is_array($res)) {
  393. $realId = $res['realId'];
  394. $server = $res['server'];
  395. $version = $res['version'];
  396. $expires = $res['expires'];
  397. return true;
  398. }
  399. return false;
  400. }
  401. public function delDiscoveryInfo($id)
  402. {
  403. $table = $this->_discovery_table;
  404. $this->_db->query("delete from $table where id = '$id'");
  405. return true;
  406. }
  407. public function isUniqueNonce($nonce)
  408. {
  409. $table = $this->_nonce_table;
  410. try {
  411. $ret = $this->_db
  412. ->query("insert into $table (nonce) values ('$nonce')");
  413. } catch (Zend_Db_Statement_Exception $e) {
  414. return false;
  415. }
  416. return true;
  417. }
  418. public function purgeNonces($date=null)
  419. {
  420. }
  421. }
  422. $db = Zend_Db::factory('Pdo_Sqlite',
  423. array('dbname'=>'/tmp/openid_consumer.db'));
  424. $storage = new DbStorage($db);
  425. $consumer = new Zend_OpenId_Consumer($storage);
  426. ]]></programlisting>
  427. </example>
  428. <para>
  429. Dieses Beispiel zeigt keinen OpenID Authentifikations Code, aber dieser Code würde der gleiche sein
  430. wie der für die anderen Beispiel in diesem Kapitel.
  431. </para>
  432. </sect2>
  433. <sect2 id="zend.openid.consumer.sreg">
  434. <title>Einfache Registrations Erweiterung</title>
  435. <para>
  436. Zusätzlich zur Authentifikation kann OpenID Standard für einen leichtgewichtigen Profiltausch
  437. verwendet werden, um Informationen über einen Benutzer über mehrere Sites hinweg portabel zu machen.
  438. Dieses Feature wird nicht durch die OpenID Authentifikations Spezifikation abgedeckt, aber vom
  439. OpenID Einfachen Registrierungs Erweiterungs Protokoll unterstützt. Dieses Protokoll erlaubt es
  440. OpenID-aktivierten Sites nach Informationen über End-Benutzern von OpenID Providers zu fragen.
  441. Diese Informationen können folgendes beinhalten:
  442. </para>
  443. <itemizedlist>
  444. <listitem>
  445. <para>
  446. <emphasis>nickname</emphasis>
  447. - ein UTF-8 String den der End-Benutzer als Spitzname verwendet.
  448. </para>
  449. </listitem>
  450. <listitem>
  451. <para>
  452. <emphasis>email</emphasis>
  453. - die Email Adresse des Benutzers wie in Sektion 3.4.1 von RFC2822 spezifiziert.
  454. </para>
  455. </listitem>
  456. <listitem>
  457. <para>
  458. <emphasis>fullname</emphasis>
  459. - eine UTF-8 String Repräsentation des kompletten Namens des Benutzers.
  460. </para>
  461. </listitem>
  462. <listitem>
  463. <para>
  464. <emphasis>dob</emphasis>
  465. - das Geburtsdatum des Benutzers im Format 'YYYY-MM-DD'. Jeder Wert dessen Repräsentation
  466. weniger als die speifizierte Anzahl an Ziffern in diesem Format verwendet sollte mit Nullen
  467. aufgefüllt werden. In anderen Worten, die Länge dieses Wertes muß immer 10 sein. Wenn der
  468. Benutzer irgendeinen Teil dieses Wertes (z.B. Jahr, Monat oder Tag) nicht angeben will,
  469. dann muß dieser auf Null gesetzt werden. Wenn ein Benutzer zum Beispiel angeben will das
  470. sein Geburtsdatum in das Jahr 1980 fällt, aber nicht den Monat oder Tag angeben will, dann
  471. sollte der zurückgegebene Wert '1980-00-00' sein.
  472. </para>
  473. </listitem>
  474. <listitem>
  475. <para>
  476. <emphasis>gender</emphasis>
  477. - das Geschlecht des Benutzers: "M" für männlich, "F" für weiblich
  478. </para>
  479. </listitem>
  480. <listitem>
  481. <para>
  482. <emphasis>postcode</emphasis>
  483. - ein UTF-8 String der dem Postleitzahl System des Landes des End-Benutzers entspricht
  484. </para>
  485. </listitem>
  486. <listitem>
  487. <para>
  488. <emphasis>country</emphasis>
  489. - das Land des Wohnsitzes des Benutzers wie spezifiziert in ISO3166
  490. </para>
  491. </listitem>
  492. <listitem>
  493. <para>
  494. <emphasis>language</emphasis>
  495. - die bevorzugte Sprache des Benutzers wie spezifiziert in ISO639
  496. </para>
  497. </listitem>
  498. <listitem>
  499. <para>
  500. <emphasis>timezone</emphasis>
  501. - ein ASCII String von der Zeitzonen Datenbank. Zum Beispiel, "Europe/Paris" oder
  502. "America/Los_Angeles".
  503. </para>
  504. </listitem>
  505. </itemizedlist>
  506. <para>
  507. Eine OpenID-aktivierte Web-Seite kann nach jeder beliebigen Kombination dieser Felder fragen.
  508. Sie kann auch einige Informationen strikt fordern und es Benutzern erlauben zusätzliche Informationen
  509. anzubieten oder zu verstecken. Das folgende Beispiel Instanziiert die
  510. <classname>Zend_OpenId_Extension_Sreg</classname> Klasse die einen <emphasis>nickname</emphasis>
  511. (Spitzname) benötigt und optional eine <emphasis>email</emphasis> (E-Mail) und einen
  512. <emphasis>fullname</emphasis> (vollständigen Namen) benötigt.
  513. </para>
  514. <example id="zend.openid.consumer.example-6_2">
  515. <title>Anfragen mit einer einfachen Registrations Erweiterung senden</title>
  516. <programlisting role="php"><![CDATA[
  517. $sreg = new Zend_OpenId_Extension_Sreg(array(
  518. 'nickname'=>true,
  519. 'email'=>false,
  520. 'fullname'=>false), null, 1.1);
  521. $consumer = new Zend_OpenId_Consumer();
  522. if (!$consumer->login($_POST['openid_identifier'],
  523. 'example-6_3.php',
  524. null,
  525. $sreg)) {
  526. die("OpenID Login fehlgeschlagen.");
  527. }
  528. ]]></programlisting>
  529. </example>
  530. <para>
  531. Wie man sieht akzeptiert der <classname>Zend_OpenId_Extension_Sreg</classname> Konstruktor ein Array von
  532. OpenId Feldern. Das Array hat den Namen der Felder als Indezes zu einem Flag das anzeigt ob das
  533. Feld benötigt wird oder nicht. <emphasis>true</emphasis> bedeutet der Wert wird benötigt und
  534. <emphasis>false</emphasis> bedeutet das Feld ist optional. Die Methode
  535. <classname>Zend_OpenId_Consumer::login</classname> akzeptiert eine Erweiterung oder ein Array von
  536. Erweiterungen als sein viertes Argument.
  537. </para>
  538. <para>
  539. Im dritten Schritt der Authentifikation sollte das <classname>Zend_OpenId_Extension_Sreg</classname> Objekt
  540. an <classname>Zend_OpenId_Consumer::verify</classname> übergeben werden. Anschließend wird die Methode
  541. <classname>Zend_OpenId_Extension_Sreg::getProperties</classname>, bei erfolgreicher Authentifizierung,
  542. ein assoziatives Array von benötigten Feldern zurückgeben.
  543. </para>
  544. <example id="zend.openid.consumer.example-6_3">
  545. <title>Antworten mit einer einfachen Registierungs Erweiterung prüfen</title>
  546. <programlisting role="php"><![CDATA[
  547. $sreg = new Zend_OpenId_Extension_Sreg(array(
  548. 'nickname'=>true,
  549. 'email'=>false,
  550. 'fullname'=>false), null, 1.1);
  551. $consumer = new Zend_OpenId_Consumer();
  552. if ($consumer->verify($_GET, $id, $sreg)) {
  553. echo "GÜLTIG " . htmlspecialchars($id) . "<br>\n";
  554. $data = $sreg->getProperties();
  555. if (isset($data['nickname'])) {
  556. echo "Spitzname: " . htmlspecialchars($data['nickname']) . "<br>\n";
  557. }
  558. if (isset($data['email'])) {
  559. echo "Email: " . htmlspecialchars($data['email']) . "<br>\n";
  560. }
  561. if (isset($data['fullname'])) {
  562. echo "Vollständiger Name: " . htmlspecialchars($data['fullname'])
  563. . "<br>\n";
  564. }
  565. } else {
  566. echo "UNGÜLTIG " . htmlspecialchars($id);
  567. }
  568. ]]></programlisting>
  569. </example>
  570. <para>
  571. Wenn das <classname>Zend_OpenId_Extension_Sreg</classname> Objekt ohne Argumente erstellt wurde, sollte der
  572. Benutzercode selbst das Vorhandensein der benötigten Daten prüfen. Trotzdem, wenn das Objekt mit
  573. der gleichen Liste an benötigten Feldern wie im zweiten Schritt erstellt wird, wird es automatisch
  574. die Existenz der benötigten Daten prüfen. In diesem Fall wird <classname>Zend_OpenId_Consumer::verify</classname>
  575. <emphasis>false</emphasis> zurückgeben wenn irgendeines der benötigten Felder fehlt.
  576. </para>
  577. <para>
  578. <classname>Zend_OpenId_Extension_Sreg</classname> verwendet standardmäßig die Version 1.0 weil die
  579. Spezifikation der Version 1.1 noch nicht fertiggestellt wurde. Trotzdem unterstützen einige
  580. Bibliotheken die Version 1.0 nicht vollständig. Zum Beispiel benötigt www.myopenid.com einen
  581. SREG Namensraum in den Anfragen der nur in 1.1 vorhanden ist. Um mit so einem Server zu Arbeiten
  582. muß man die Version 1.1 explizit im <classname>Zend_OpenId_Extension_Sreg</classname> Konstruktor setzen.
  583. </para>
  584. <para>
  585. Das zweite Argument des <classname>Zend_OpenId_Extension_Sreg</classname> Konstruktors ist eine Policy URL,
  586. die dem Benutzer durch den Identitäts Provider zur Verfügung gestellt werden sollte.
  587. </para>
  588. </sect2>
  589. <sect2 id="zend.openid.consumer.auth">
  590. <title>Integration mit Zend_Auth</title>
  591. <para>
  592. Zend Framework bietet eine spezielle Klasse für die Unterstützung von Benutzer Authentifikation:
  593. <classname>Zend_Auth</classname>. Diese Klasse kann zusammen mit <classname>Zend_OpenId_Consumer</classname> verwendet
  594. werden. Das folgende Beispiel zeigt wie <code>OpenIdAdapter</code> das
  595. <classname>Zend_Auth_Adapter_Interface</classname> mit der <code>authenticate</code> Methode implementiert.
  596. Diese führt eine Authentifikations Anfrage und Verifikation durch.
  597. </para>
  598. <para>
  599. Der große Unterschied zwischen diesem Adapter und dem bestehenden ist, das er mit zwei HTTP
  600. Anfragen arbeitet und einen Dispatch code enthält um den zweiten oder dritten Schritt der
  601. OpenID Authentifikation durchzuführen.
  602. </para>
  603. <example id="zend.openid.consumer.example-7">
  604. <title>Zend_Auth Adapter für OpenID</title>
  605. <programlisting role="php"><![CDATA[
  606. class OpenIdAdapter implements Zend_Auth_Adapter_Interface {
  607. private $_id = null;
  608. public function __construct($id = null) {
  609. $this->_id = $id;
  610. }
  611. public function authenticate() {
  612. $id = $this->_id;
  613. if (!empty($id)) {
  614. $consumer = new Zend_OpenId_Consumer();
  615. if (!$consumer->login($id)) {
  616. $ret = false;
  617. $msg = "Authentifizierung fehlgeschlagen.";
  618. }
  619. } else {
  620. $consumer = new Zend_OpenId_Consumer();
  621. if ($consumer->verify($_GET, $id)) {
  622. $ret = true;
  623. $msg = "Authentifizierung erfolgreich";
  624. } else {
  625. $ret = false;
  626. $msg = "Authentifizierung fehlgeschlagen";
  627. }
  628. }
  629. return new Zend_Auth_Result($ret, $id, array($msg));
  630. }
  631. }
  632. $status = "";
  633. $auth = Zend_Auth::getInstance();
  634. if ((isset($_POST['openid_action']) &&
  635. $_POST['openid_action'] == "login" &&
  636. !empty($_POST['openid_identifier'])) ||
  637. isset($_GET['openid_mode'])) {
  638. $adapter = new OpenIdAdapter(@$_POST['openid_identifier']);
  639. $result = $auth->authenticate($adapter);
  640. if ($result->isValid()) {
  641. Zend_OpenId::redirect(Zend_OpenId::selfURL());
  642. } else {
  643. $auth->clearIdentity();
  644. foreach ($result->getMessages() as $message) {
  645. $status .= "$message<br>\n";
  646. }
  647. }
  648. } else if ($auth->hasIdentity()) {
  649. if (isset($_POST['openid_action']) &&
  650. $_POST['openid_action'] == "logout") {
  651. $auth->clearIdentity();
  652. } else {
  653. $status = "Du bist angemeldet als " . $auth->getIdentity() . "<br>\n";
  654. }
  655. }
  656. ?>
  657. <html><body>
  658. <?php echo htmlspecialchars($status);?>
  659. <form method="post"><fieldset>
  660. <legend>OpenID Login</legend>
  661. <input type="text" name="openid_identifier" value="">
  662. <input type="submit" name="openid_action" value="login">
  663. <input type="submit" name="openid_action" value="logout">
  664. </fieldset></form></body></html>
  665. ]]></programlisting>
  666. </example>
  667. <para>
  668. Mit <classname>Zend_Auth</classname> wird die Identität des End-Benutzes in den Session Daten gespeichert.
  669. Sie kann mit <classname>Zend_Auth::hasIdentity</classname> und <classname>Zend_Auth::getIdentity</classname>
  670. geprüft werden.
  671. </para>
  672. </sect2>
  673. <sect2 id="zend.openid.consumer.mvc">
  674. <title>Integration mit Zend_Controller</title>
  675. <para>
  676. Zuletzt ein paar Worte über die Integration in Model-View-Controller Anwendungen: Solche
  677. Zend Framework Anwendungen werden implementiert durch Verwenden der <classname>Zend_Controller</classname>
  678. Klasse und Sie verwenden die <classname>Zend_Controller_Response_Http</classname> Klasse um HTTP Antworten
  679. vorzubereiten und an den Web Browser des Benutzers zurückzusenden.
  680. </para>
  681. <para>
  682. <classname>Zend_OpenId_Consumer</classname> bietet keine GUI Möglichkeiten aber es führt HTTP Umleitungen
  683. bei erflgreichen <classname>Zend_OpenId_Consumer::login</classname> und
  684. <classname>Zend_OpenId_Consumer::check</classname> durch. Diese Umleitungen könnten nicht richtig funktionieren,
  685. oder sogar überhaupt nicht, wenn einige Daten bereits an den Web Browser gesendet wurden. Um
  686. HTTP Umleitungen im MVC Code richtig durchzuführen sollte die echte
  687. <classname>Zend_Controller_Response_Http</classname> als letztes Argument an
  688. <classname>Zend_OpenId_Consumer::login</classname> oder <classname>Zend_OpenId_Consumer::check</classname> gesendet
  689. werden.
  690. </para>
  691. </sect2>
  692. </sect1>
  693. <!--
  694. vim:se ts=4 sw=4 et:
  695. -->