Zend_OpenId-Consumer.xml 34 KB

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