Working OpenId implementation, including basic security features
authorAymeric Augustin <aymeric.augustin@m4x.org>
Sat, 25 Oct 2008 21:23:29 +0000 (23:23 +0200)
committerAymeric Augustin <aymeric.augustin@m4x.org>
Sat, 25 Oct 2008 21:37:14 +0000 (23:37 +0200)
Still needs code improvements, error handling, and testing

Change path for OpenId library and update Makefile
Create a spool for the OpenId library with the Makefile

Makefile
modules/openid.php
modules/openid/openid.inc.php
templates/openid/no_identifier.tpl [new file with mode: 0644]
templates/openid/trust.tpl [new file with mode: 0644]

index e297744..fc1550e 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -112,7 +112,7 @@ get-wiki:
 ## openid
 ##
 
-openid: get-openid
+openid: get-openid spool/openid/store
 
 # There is no obvious way to automatically use the latest version
 get-openid:
@@ -124,6 +124,11 @@ get-openid:
            rm -r php-openid-2.1.2;                                       \
        fi
 
+spool/openid/store:
+       mkdir -p $@
+       chmod o+w $@
+
+
 ##
 ## banana
 ##
index c05c0bc..1114a39 100644 (file)
  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  ***************************************************************************/
 
+
+/* Definitions for the OpenId Specification
+ * http://openid.net/specs/openid-authentication-2_0.html
+ * 
+ * OP Endpoint URL:             https://www.polytechnique.org/openid
+ * OP Identifier:               https://www.polytechnique.org/openid
+ * User-Supplied Identifier:    https://www.polytechnique.org/openid/{$hruid}
+ *    Identity selection is not supported by this implementation
+ * OP-Local Identifier:         {$hruid}
+ */
+
 class OpenidModule extends PLModule
 {
     function handlers()
     {
         return array(
-            'openid'    => $this->make_hook('openid', AUTH_PUBLIC),
+            'openid'            => $this->make_hook('openid', AUTH_PUBLIC),
+            'openid/trust'      => $this->make_hook('trust', AUTH_COOKIE),
             'openid/idp_xrds'   => $this->make_hook('idp_xrds', AUTH_PUBLIC),
             'openid/user_xrds'  => $this->make_hook('user_xrds', AUTH_PUBLIC),
-            'openid/trust'  => $this->make_hook('trust', AUTH_PUBLIC),
         );
     }
 
-    function init_openid()
-    {
-        require_once 'Auth/OpenID.php';
-        $this->load('openid.inc.php');
-    }
-
     function handler_openid(&$page, $x = null)
     {
-        global $globals;
+        $this->load('openid.inc.php');
+        $user = get_user($x);
 
-        // Determines the user whose openid we are going to display
-        if (is_null($x)) {
-            return PL_NOT_FOUND;
+        // Display the discovery page
+        if ($_SERVER['REQUEST_METHOD'] != 'POST' && !array_key_exists('openid_mode', $_GET)) {
+            return $this->render_discovery_page($page, $user);
         }
 
-        $login = S::logged() ? User::get($x) : User::getSilent($x);
-        if (!$login) {
-            return PL_NOT_FOUND;
+        // Create a server and decode the request
+        $server = init_openid_server();
+        $request = $server->decodeRequest();
+
+        if (in_array($request->mode,
+                     array('checkid_immediate', 'checkid_setup'))) {
+
+            // Each user has only one identity to choose from
+            // So we can make automatically the identity selection
+            if ($request->idSelect()) {
+                $request->identity = get_user_openid_url($user);
+            }
+
+            // If we still don't have an identifier (used or desired), give up
+            if (!$request->identity) {
+                $this->render_no_identifier_page($page, $request);
+                return;
+            }
+
+            // We always require confirmation before sending information
+            // to third-party websites
+            if ($request->immediate) {
+                $response =& $request->answer(false, get_openid_url());
+            } else {
+                // Save request in session and jump to confirmation page
+                S::set('request', serialize($request));
+                pl_redirect('openid/trust');
+                return;
+            }
+
+        } else { // Other $request->mode
+            $response =& $server->handleRequest($request);
         }
 
-        // Include X-XRDS-Location response-header for Yadis discovery
-        $user_xrds = $globals->baseurl . 'openid/user_xrds/' . $login->hruid;
-        header('X-XRDS-Location: ' . $user_xrds);
+        // Render response
+        $webresponse =& $server->encodeResponse($response);
+        $this->render_openid_response($webresponse, true);
+    }
 
-        // Select template
-        $page->changeTpl('openid/openid.tpl');
+    function handler_trust(&$page, $x = null)
+    {
+        $this->load('openid.inc.php');
 
-        // Sets the title of the html page.
-        $page->setTitle($login->fullName());
+        // Recover request in session
+        $request = S::v('request');
+        if (is_null($request)) {
+            // There is no authentication information, something went wrong
+            pl_redirect('/');
+            return;
+        } else {
+            // Unserialize the request
+            require_once "Auth/OpenID/Server.php";
+            $request = unserialize($request);
+        }
 
-        // Sets the <link> tags for HTML-Based Discovery
-        $page->addLink('openid.server openid2.provider',
-                       $globals->baseurl . '/openid');
-        $page->addLink('openid.delegate openid2.local_id',
-                       $login->hruid);
+        $server = init_openid_server();
+        $user = S::user();
 
-        // Adds the global user property array to the display.
-        $page->assign_by_ref('user', $login);
+        // Check that the identity matches the user currently logged in
+        if ($request->identity != get_user_openid_url($user)) {
+            $response =& $request->answer(false);
+            $webresponse =& $server->encodeResponse($response);
+            $this->render_openid_response($webresponse);
+            return;
+        }
+
+        if ($_SERVER['REQUEST_METHOD'] != 'POST') {
+            $page->changeTpl('openid/trust.tpl');
+            $page->assign('relying_party', $request->trust_root);
+            return;
+        }
+
+        if (isset($_POST['trust'])) { // $_SERVER['REQUEST_METHOD'] == 'POST'
+            unset($_SESSION['request']);
+            $response =& $request->answer(true, null, $request->identity);
+
+            // Answer with some sample Simple Registration data.
+            // TODO USE REAL USER DATA
+            // $user = S::user();
+            $sreg_data = array(
+                               'fullname' => 'Example User',
+                               'nickname' => 'example',
+                               'dob' => '1970-01-01',
+                               'email' => 'invalid@example.com',
+                               'gender' => 'F',
+                               'postcode' => '12345',
+                               'country' => 'ES',
+                               'language' => 'eu',
+                               'timezone' => 'America/New_York');
+
+            // Add the simple registration response values to the OpenID
+            // response message.
+            require_once 'Auth/OpenID/SReg.php';
+            $sreg_request = Auth_OpenID_SRegRequest::fromOpenIDRequest($request);
+            $sreg_response = Auth_OpenID_SRegResponse::extractResponse($sreg_request, $sreg_data);
+            $sreg_response->toMessage($response->fields);
+
+            // Generate a response to send to the user agent.
+            $webresponse =& $server->encodeResponse($response);
+            $this->render_openid_response($webresponse);
+        } else {
+            pl_redirect('');
+            return;
+        }
     }
 
     function handler_idp_xrds(&$page)
     {
-        global $globals;
-
         // Load constants
-        require_once "Auth/OpenID/Discover.php";
+        $this->load('openid.inc.php');
 
         // Set XRDS content-type and template
         header('Content-type: application/xrds+xml');
@@ -85,15 +170,13 @@ class OpenidModule extends PLModule
         // Set variables
         $page->changeTpl('openid/idp_xrds.tpl', NO_SKIN);
         $page->assign('type', Auth_OpenID_TYPE_2_0_IDP);
-        $page->assign('uri', $globals->baseurl . '/openid');
+        $page->assign('uri', get_openid_url());
     }
 
     function handler_user_xrds(&$page, $x = null)
     {
-        global $globals;
-
         // Load constants
-        require_once "Auth/OpenID/Discover.php";
+        $this->load('openid.inc.php');
 
         // Set XRDS content-type and template
         header('Content-type: application/xrds+xml');
@@ -102,9 +185,61 @@ class OpenidModule extends PLModule
         // Set variables
         $page->assign('type1', Auth_OpenID_TYPE_2_0);
         $page->assign('type2', Auth_OpenID_TYPE_1_1);
-        $page->assign('uri', $globals->baseurl . '/openid');
+        $page->assign('uri', get_openid_url());
     }
 
+    //--------------------------------------------------------------------//
+
+    function render_discovery_page(&$page, $user)
+    {
+
+        if (is_null($user)) {
+            return PL_NOT_FOUND;
+        }
+
+        // Include X-XRDS-Location response-header for Yadis discovery
+        header('X-XRDS-Location: ' . get_user_xrds_url($user));
+
+        // Select template
+        $page->changeTpl('openid/openid.tpl');
+
+        // Sets the title of the html page.
+        $page->setTitle($user->fullName());
+
+        // Sets the <link> tags for HTML-Based Discovery
+        $page->addLink('openid.server openid2.provider', get_openid_url());
+        $page->addLink('openid.delegate openid2.local_id', $user->hruid);
+
+        // Adds the global user property array to the display.
+        $page->assign_by_ref('user', $user);
+
+        return;
+    }
+
+    function render_no_identifier_page($page, $request)
+    {
+        $page->changeTpl('openid/no_identifier.tpl');
+    }
+
+    // TODO determine when to close the connection or not
+    // TODO i don't why it was done that way in the example
+    function render_openid_response($webresponse, $close = false)
+    {
+        if ($webresponse->code != AUTH_OPENID_HTTP_OK) {
+            header(sprintf("HTTP/1.1 %d ", $webresponse->code),
+                   true, $webresponse->code);
+        }
+
+        foreach ($webresponse->headers as $k => $v) {
+            header("$k: $v");
+        }
+
+        if ($close) {
+            header('Connection: close');
+        }
+        print $webresponse->body;
+        exit;
+    }
 }
 
 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
index e69de29..669eccf 100644 (file)
@@ -0,0 +1,73 @@
+<?php
+/***************************************************************************
+ *  Copyright (C) 2003-2008 Polytechnique.org                              *
+ *  http://opensource.polytechnique.org/                                   *
+ *                                                                         *
+ *  This program is free software; you can redistribute it and/or modify   *
+ *  it under the terms of the GNU General Public License as published by   *
+ *  the Free Software Foundation; either version 2 of the License, or      *
+ *  (at your option) any later version.                                    *
+ *                                                                         *
+ *  This program is distributed in the hope that it will be useful,        *
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *  GNU General Public License for more details.                           *
+ *                                                                         *
+ *  You should have received a copy of the GNU General Public License      *
+ *  along with this program; if not, write to the Free Software            *
+ *  Foundation, Inc.,                                                      *
+ *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
+ ***************************************************************************/
+
+require_once "Auth/OpenID/Discover.php";
+
+function init_openid_server()
+{
+    // Initialize a filesystem-based store
+    $store_location = dirname(__FILE__) . '/../../spool/openid/store';
+    require_once "Auth/OpenID/FileStore.php";
+    $store = new Auth_OpenID_FileStore($store_location);
+
+    // Create an OpenId server
+    require_once 'Auth/OpenID/Server.php';
+    return new Auth_OpenID_Server($store, get_openid_url());
+}
+
+function get_openid_url()
+{
+    global $globals;
+    return $globals->baseurl . '/openid';
+}
+
+function get_user($x) {
+    if (is_null($x)) {
+        return null;
+    }
+    $user = User::getSilent($x);
+    return $user ? $user : null;
+
+}
+
+function get_user_openid_url($user)
+{
+    if (is_null($user)) {
+        return null;
+    }
+    global $globals;
+    return $globals->baseurl . '/openid/' . $user->hruid;
+}
+
+function get_user_xrds_url($user)
+{
+    if (is_null($user)) {
+        return null;
+    }
+    global $globals;
+    return $globals->baseurl . '/openid/user_xrds/' . $user->hruid;
+}
+
+
+
+
+// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
+?>
\ No newline at end of file
diff --git a/templates/openid/no_identifier.tpl b/templates/openid/no_identifier.tpl
new file mode 100644 (file)
index 0000000..b82ce2d
--- /dev/null
@@ -0,0 +1,27 @@
+{**************************************************************************}
+{*                                                                        *}
+{*  Copyright (C) 2003-2008 Polytechnique.org                             *}
+{*  http://opensource.polytechnique.org/                                  *}
+{*                                                                        *}
+{*  This program is free software; you can redistribute it and/or modify  *}
+{*  it under the terms of the GNU General Public License as published by  *}
+{*  the Free Software Foundation; either version 2 of the License, or     *}
+{*  (at your option) any later version.                                   *}
+{*                                                                        *}
+{*  This program is distributed in the hope that it will be useful,       *}
+{*  but WITHOUT ANY WARRANTY; without even the implied warranty of        *}
+{*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *}
+{*  GNU General Public License for more details.                          *}
+{*                                                                        *}
+{*  You should have received a copy of the GNU General Public License     *}
+{*  along with this program; if not, write to the Free Software           *}
+{*  Foundation, Inc.,                                                     *}
+{*  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA               *}
+{*                                                                        *}
+{**************************************************************************}
+
+<h1>Erreur lors du traitement de l'identification.</h1>
+
+<p>Cette requête n'a pas pu aboutir car elle ne contient pas d'identifiant.</p>
+
+<p>Veuillez revenir au site d'origine et re-tenter l'identification.</p>
\ No newline at end of file
diff --git a/templates/openid/trust.tpl b/templates/openid/trust.tpl
new file mode 100644 (file)
index 0000000..edd221b
--- /dev/null
@@ -0,0 +1,33 @@
+{**************************************************************************}
+{*                                                                        *}
+{*  Copyright (C) 2003-2008 Polytechnique.org                             *}
+{*  http://opensource.polytechnique.org/                                  *}
+{*                                                                        *}
+{*  This program is free software; you can redistribute it and/or modify  *}
+{*  it under the terms of the GNU General Public License as published by  *}
+{*  the Free Software Foundation; either version 2 of the License, or     *}
+{*  (at your option) any later version.                                   *}
+{*                                                                        *}
+{*  This program is distributed in the hope that it will be useful,       *}
+{*  but WITHOUT ANY WARRANTY; without even the implied warranty of        *}
+{*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *}
+{*  GNU General Public License for more details.                          *}
+{*                                                                        *}
+{*  You should have received a copy of the GNU General Public License     *}
+{*  along with this program; if not, write to the Free Software           *}
+{*  Foundation, Inc.,                                                     *}
+{*  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA               *}
+{*                                                                        *}
+{**************************************************************************}
+
+
+<p>Le site <strong>{$relying_party}</strong> demande à confirmer votre identité.</p>
+
+<p>Souhaitez-vous confirmer votre identité ?</p>
+
+<div class="form">
+  <form method="post" action="openid/trust">
+    <input type="submit" name="trust" value="Confirmer" />
+    <input type="submit" value="Ne pas confirmer" />
+  </form>
+</div>