Zend_OpenId-Consumer.xml 34 KB

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