Changeset 1206

Timestamp:

07/18/10 18:57:41 (3 years ago)

Author:

d0nut

Message:

finished openid implementation

Location:

openid

Files:

• de.xml (modified) (1 diff)
• en.xml (modified) (1 diff)
• eventlistener.xml (modified) (1 diff)
• files/icon (added)
• files/icon/openidM.png (added)
• files/icon/openidS.png (added)
• files/lib/data/openid/OpenID.class.php (modified) (17 diffs)
• files/lib/data/openid/OpenIDSession.class.php (added)
• files/lib/page/OpenIDPage.class.php (modified) (4 diffs)
• files/lib/system/event/listener/UserLoginOpenIDListener.class.php (modified) (1 diff)
• install.sql (modified) (1 diff)
• package.xml (modified) (1 diff)
• templates/openidLogin.tpl (modified) (1 diff)

openid/de.xml

@@ -6 +6 @@
                 <item name="wcf.acp.option.module_openid.description"><![CDATA[Erlaubt den Login mit Hilfe eines openid Accounts.]]></item>
         </category>
+        <category name="wcf.openid">
+                <item name="wcf.openid.login.description"><![CDATA[Sie können sich mit ihrem existieren Account bestimmter Anbieter bei uns authentifizieren.<br/>
+                        Das ganze funktioniert ÃŒber die s.g. OpenID Schnittstelle - es werden keine Zugangsdaten ausgetauscht.<br/>]]></item>
+                <item name="wcf.openid.login"><![CDATA[OpenID]]></item>
+        </category>
 </language>

openid/en.xml

@@ -6 +6 @@
                 <item name="wcf.acp.option.module_openid.description"><![CDATA[Allows users to login to the wcf with a openid account.]]></item>
         </category>
+        <category name="wcf.openid">
+                <item name="wcf.openid.login.description"><![CDATA[Click your OpenID account provider to login<br/>]]></item>
+                <item name="wcf.openid.login"><![CDATA[OpenID]]></item>
+        </category>
 </language>

openid/eventlistener.xml

@@ -6 +6 @@
                         <eventclassname>UserLoginForm</eventclassname>
                         <eventname>assignVariables</eventname>
+                        <inherit>1</inherit>
                         <listenerclassfile>lib/system/event/listener/UserLoginOpenIDListener.class.php</listenerclassfile>
                 </eventlistener>

openid/files/lib/data/openid/OpenID.class.php

@@ -1 +1 @@
 <?php
-require_once(WCF_DIR.'lib/data/user/avatar/AvatarEditor.class.php');
 require_once(WCF_DIR.'lib/data/user/UserEditor.class.php');
 
 /**
- *
+ * embeds the openid system into the wcf
+ * registers include pathes and cares for all dependencies
+ * 
+ * @author      Torben Brodt
+ * @copyright   2010 easy-coding.de
+ * @license     GNU General Public License <http://opensource.org/licenses/gpl-3.0.html>
+ * @package     de.easy-coding.wcf.openid
  */
 class OpenID {
 
         /**
-         *
-         */
-        public function __construct() {
-                $path_extra = dirname(dirname(dirname(__FILE__)));
+         * form instance needed for finish action
+         *
+         * @var UserLoginForm|OpenIDPage
+         */
+        protected $eventObj;
+
+        /**
+         * sets include pathes
+         * 
+         * @param       UserLoginForm|OpenIDPage        $eventObj
+         */
+        public function __construct($eventObj = null) {
+                $this->eventObj = $eventObj;
+
+                $path_extra = dirname(__FILE__);
                 $path = ini_get('include_path');
                 $path = $path_extra . PATH_SEPARATOR . $path;
@@ -18 +34 @@
 
                 /**
+                 * session wrapper
+                 */
+                require_once "Auth/Yadis/Manager.php";
+
+                /**
+                 * session wrapper
+                 */
+                require_once "OpenIDSession.class.php";
+
+                /**
                  * Require the OpenID consumer code.
                  */
@@ -26 +52 @@
                  * OpenID information.
                  */
-                require_once "Auth/OpenID/DumbStore.php";
+                require_once "Auth/OpenID/FileStore.php";
 
                 /**
@@ -39 +65 @@
         }
 
-        protected function &getStore() {
-                return new Auth_OpenID_DumbStore();
-        }
-
-        protected function &getConsumer() {
+        /**
+         * returns file store
+         */
+        protected function getStore() {
+                $store_path = FileUtil::getTemporaryFilename('openid_');
+                $store_path = TMP_DIR."/_openid".WCF_N;
+                return new Auth_OpenID_FileStore($store_path);
+        }
+
+        /**
+         * get authenticated user
+         */
+        protected function getConsumer() {
+
+                $session = new OpenIDSession();
+        
                 /**
                  * Create a consumer object using the store object created
@@ -49 +86 @@
                  */
                 $store = $this->getStore();
-                $consumer =& new Auth_OpenID_Consumer($store);
+                $consumer =& new Auth_OpenID_Consumer($store, $session);
                 return $consumer;
         }
 
+        /**
+         * gets openid handler url
+         *
+         * @return      string
+         */
         public static function getReturnTo() {
-                return PAGE_URL.'index.php?page=OpenID';
-        }
-
+                return PAGE_URL.'/index.php?page=OpenID';
+        }
+
+        /**
+         * gets root url
+         *
+         * @return      string
+         */
         public static function getTrustRoot() {
-                return PAGE_URL.'index.php';
-        }
-
-        /**
-         * $_GET['openid_identifier']
-         * $_GET['policies']
+                return PAGE_URL;
+        }
+
+        /**
+         * call api and try authentication
          */
         public function tryAuthentication($openid, $policy_uris = array()) {
@@ -73 +119 @@
                 // No auth request means we can't begin OpenID.
                 if (!$auth_request) {
-                        $this->error = ("Authentication error; not a valid OpenID.");
-                        return;
+                        throw new Exception("Authentication error; not a valid OpenID.");
                 }
 
@@ -105 +150 @@
                         // message.
                         if (Auth_OpenID::isFailure($redirect_url)) {
-                                $this->error = ("Could not redirect to server: " . $redirect_url->message);
-                                return;
+                                throw new Exception("Could not redirect to server: " . $redirect_url->message);
                         } else {
                                 // Send redirect.
                                 header("Location: ".$redirect_url);
+                                exit;
                         }
                 } else {
@@ -119 +164 @@
                         // otherwise, render the HTML.
                         if (Auth_OpenID::isFailure($form_html)) {
-                                $this->error = ("Could not redirect to server: " . $form_html->message);
-                                return;
+                                throw new Exception("Could not redirect to server: " . $form_html->message);
                         } else {
-                                print $form_html;
+                        
+                                // used by openid 2, formular and redirect are printed out
+                                echo $form_html;
+                                exit;
                         }
                 }
@@ -128 +175 @@
 
         /**
-         *
+         * got answer, save user
          */
         public function finishAuthentication() {
@@ -157 +204 @@
 
                         if ($response->endpoint->canonicalID) {
-                                $StringUtil::encodeHTMLd_canonicalID = StringUtil::encodeHTML($response->endpoint->canonicalID);
-                                $success .= '  (XRI CanonicalID: '.$StringUtil::encodeHTMLd_canonicalID.') ';
+                                $encoded_canonicalID = StringUtil::encodeHTML($response->endpoint->canonicalID);
+                                $success .= '  (XRI CanonicalID: '.$encoded_canonicalID.') ';
                         }
 
@@ -168 +215 @@
 
                                         foreach ($pape_resp->auth_policies as $uri) {
-                                                $StringUtil::encodeHTMLd_uri = StringUtil::encodeHTML($uri);
-                                                $success .= "<li><tt>$StringUtil::encodeHTMLd_uri</tt></li>";
+                                                $encoded_uri = StringUtil::encodeHTML($uri);
+                                                $success .= "<li><tt>$encoded_uri</tt></li>";
                                         }
 
@@ -204 +251 @@
                 }
         }
-        
 
         /**
@@ -213 +259 @@
          */
         protected function getOpenIDEnabledUser($me) {
-                $sql = "SELECT          utb.userID
-                        FROM            wcf".WCF_N."_user_to_openid utb
-                        WHERE           utb.openidID = ".intval($me['id'])."
-                        AND             utb.identifier = '".escapeString($me['identifier'])."'";
+                $sql = "SELECT          userID
+                        FROM            wcf".WCF_N."_user_to_openid
+                        WHERE           openID = '".sha1($me['identifier'])."'";
                 $row = WCF::getDB()->getFirstRow($sql);
 
                 $user = $row ? new User($row['userID']) : null;
-                return $user->userID ? $user : null;
+                return $user && $user->userID ? $user : null;
         }
 
@@ -232 +277 @@
         protected function addOpenIDUser($me, $user) {
                 $sql = "REPLACE INTO    wcf".WCF_N."_user_to_openid
-                                        (openidID, identifier, userID)
-                        VALUES          (".intval($me['id']).", '".escapeString($me['identifier'])."', ".intval($user->userID).")";
+                                        (openID, userID)
+                        VALUES          ('".sha1($me['identifier'])."', ".intval($user->userID).")";
 
                 return WCF::getDB()->sendQuery($sql);
@@ -243 +288 @@
         public function finishUser($me) {
 
+                // take default username from hostname
+                if($me['name'] === null) {
+                        $host = parse_url($me['identifier'], PHP_URL_HOST)." ID #1";
+                        $host = preg_replace("/^www\./", "", $host);
+                        $me['name'] = $host;
+                }
+                
                 // openid permissions granted, does an login exist?
                 $user = $this->getOpenIDEnabledUser($me);
@@ -258 +310 @@
                 if($user) {
 
-                        die('login temporary disabled');
                         // UserLoginForm should not write cookie, since interfaces only support unhashed password
                         $this->eventObj->useCookies = 0;
@@ -307 +358 @@
                 // get a valid username
                 $username = $this->findUsername($me['name']);
+                
+                // take default email
+                if($me['email'] === null) {
+                        $me['email'] = sha1($me['identifier']).'@openid';
+                }
 
                 // create new user

openid/files/lib/page/OpenIDPage.class.php

@@ -1 +1 @@
 <?php
 // wcf imports
-require_once(WCF_DIR.'lib/page/AbstractPage.class.php');
+require_once(WCF_DIR.'lib/form/UserLoginForm.class.php');
 require_once(WCF_DIR.'lib/data/openid/OpenID.class.php');
 
@@ -12 +12 @@
  * @package     de.easy-coding.wcf.openid
  */
-class OpenIDPage extends AbstractPage {
+class OpenIDPage extends UserLoginForm {
 
+        /**
+         * 
+         * @var string
+         */
         protected $identifier;
         
@@ -23 +27 @@
                 
                 $this->identifier = isset($_GET['identifier']) ? $_GET['identifier'] : null;
-        }
-        
-        /**
-         * @see Page::readData()
-         */
-        public function readData() {
-                parent::readData();
                 
-                $openid = new OpenID();
+                $openid = new OpenID($this);
                 
                 if($this->identifier) {
@@ -39 +36 @@
                 }
         }
-        
-        /**
-         * @see Page::assignVariables()
-         */
-        public function assignVariables() {
-                parent::assignVariables();
-                
-                
-                WCF::getTPL()->assign(array(
-                        'entry' => $this->entry,
-                ));
-        }
 }
 ?>

openid/files/lib/system/event/listener/UserLoginOpenIDListener.class.php

@@ -32 +32 @@
                         return;
                 }
-                
-                // TODO: remove DEBUG
-                if(!isset($_GET['openid'])) {
-                        return;
-                }
 
                 $this->eventObj = $eventObj;

openid/install.sql

@@ -2 +2 @@
 CREATE TABLE wcf1_user_to_openid (
         userID INT(10) NOT NULL DEFAULT 0,
-        identifier VARCHAR(255) NOT NULL DEFAULT '',
-        openID INT(10) NOT NULL DEFAULT 0,
+        openID char(64) NOT NULL DEFAULT '',
         UNIQUE(userID),
-        UNIQUE(identifier, openID)
+        UNIQUE(openID)
 ) ENGINE=MyISAM DEFAULT CHARSET=utf8;

openid/package.xml

@@ -6 +6 @@
                 <packagedescription language="de"><![CDATA[Dieses Plugin verbindet openid mit dem WCF. So ist z.B. ein Direktlogin via openid möglich.]]></packagedescription>
                 <packagedescription><![CDATA[This enables all users to login with their openid account.]]></packagedescription>
-                <version>1.0.0 Beta 1</version>
+                <version>1.0.0 RC 1</version>
                 <date>DATE</date>
                 <plugin>com.woltlab.wcf</plugin>

openid/templates/openidLogin.tpl

@@ +1 @@
+<script type="text/javascript">
+function openid(elem, msg) {
+        var x = prompt(msg);
+        if(x) {
+                elem.href = elem.href.replace(/\\1/, x);
+                return true;
+        }
+
+        return false;
+}
+</script>
 <div class="formElement">
         <div class="formField">
-                <form method="get" action="{$openid_url}">
-                        <script type="text/javascript">
-                        function openid(elem, msg) {
-                                var x = prompt(msg);
-                                if(x) {
-                                        elem.href = elem.href.replace(/\\1/, x);
-                                        return true;
-                                }
-        
-                                return false;
-                        }
-                        </script>
-        
-                        Sie können sich mit ihrem existieren Account bestimmter Anbieter bei uns authentifizieren.<br/>
-                        Das ganze funktioniert ÃŒber die s.g. OpenID Schnittstelle - es werden keine Zugangsdaten ausgetauscht.<br/>
+                <fieldset>
+                        <legend><img src="{icon}openidS.png{/icon}" alt="" />{lang}wcf.openid.login{/lang}</legend>
+{*
+                        <form method="get" action="{$openid_url}">
+*}
+                        {lang}wcf.openid.login.description{/lang}
 
                         <a href="{$openid_url}&identifier=https://www.google.com/accounts/o8/id">Google</a>
                         <a href="{$openid_url}&identifier=http://yahoo.com/">Yahoo</a>
                         <a href="{$openid_url}&identifier=http://openid.aol.com/\1" onclick="return openid(this)">AOL</a>
+                        <a href="{$openid_url}&identifier=http://www.flickr.com/">Flickr</a>
                         <a href="{$openid_url}&identifier=http://\1.myopenid.com/" onclick="return openid(this)">myOpenID</a>
-
-                        <p>... oder geben Sie ihre OpenID manuell ein:<br/>
-                        <input type="text" name="identifier" class="openid" value="https://www.google.com/accounts/o8/id" /></p>
-                        <p>
-                                <input type="submit" value="Weiter &raquo;" />
-                        </p>
-                </form>
+                        <a href="{$openid_url}&identifier=http://technorati.com/people/technorati/\1" onclick="return openid(this)">Technorati</a>
+                        <a href="{$openid_url}&identifier=http://\1.wordpress.com/" onclick="return openid(this)">Wordpress</a>
+                        <a href="{$openid_url}&identifier=http://\1.blogspot.com/" onclick="return openid(this)">Blogspot</a>
+{*
+                                <p>... oder geben Sie ihre OpenID manuell ein:<br/>
+                                <input type="text" name="identifier" class="openid" value="https://www.google.com/accounts/o8/id" /></p>
+                                <p>
+                                        <input type="submit" value="Weiter &raquo;" />
+                                </p>
+                        </form>
+*}
+                </fieldset>
         </div>
 </div>