Let say... start porting module/profile.php
[platal.git] / modules / openid.php
index d535d79..843effc 100644 (file)
@@ -22,7 +22,7 @@
 
 /* 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 Identifier:             https://www.polytechnique.org/openid/{hruid}
@@ -34,7 +34,7 @@
  *     - entering the User Identifier, or some URL that resolves there
  * In both cases, Yadis discovery is made possible through the X-XRDS-Location
  * header.
- * 
+ *
  * In the former case, Yadis discovery is performed on /, or where it redirects;
  * see platal.php. It resolves to the XRDS for this OP, and User Identifier
  * selection is performed after forcing the user to log in. This only works for
  * Reading the source of the server can also help understanding the code below.
  */
 
-/* **checkid_immediate is not supported (yet)**, which means that we will
- * always ask for confirmation before redirecting to a third-party.
- * A sensible way to implement it would be to add a "Always trust this site"
- * checkbox to the form, and to store trusted websites per user. This still
- * raises the question of removing websites from that list.
- * Another possibility is to maintain a global whitelist.
- */
 
 class OpenidModule extends PLModule
 {
@@ -70,6 +63,8 @@ class OpenidModule extends PLModule
         return array(
             'openid'            => $this->make_hook('openid', AUTH_PUBLIC),
             'openid/trust'      => $this->make_hook('trust', AUTH_COOKIE),
+            'openid/trusted'    => $this->make_hook('trusted', AUTH_MDP),
+            'admin/openid/trusted'  => $this->make_hook('admin_trusted', AUTH_MDP),
             'openid/idp_xrds'   => $this->make_hook('idp_xrds', AUTH_PUBLIC),
             'openid/user_xrds'  => $this->make_hook('user_xrds', AUTH_PUBLIC),
             'openid/melix'      => $this->make_hook('melix', AUTH_PUBLIC),
@@ -80,61 +75,48 @@ class OpenidModule extends PLModule
     {
         $this->load('openid.inc.php');
 
-        // Spec §4.1.2: if "openid.mode" is absent, whe SHOULD assume that
+        // Spec §4.1.2: if "openid.mode" is absent, we SHOULD assume that
         // the request is not an OpenId message
-        // Thus, we try to render the discovery page
         if (!array_key_exists('openid_mode', $_REQUEST)) {
             return $this->render_discovery_page($page, get_user($x));
         }
 
-        // Create a server and decode the request
+        // Now, deal with the OpenId message
         $server = init_openid_server();
         $request = $server->decodeRequest();
 
-        // This request needs some logic and can not be automatically
-        // answered by the server
-        if (in_array($request->mode,
-                     array('checkid_immediate', 'checkid_setup'))) {
-
-            // If the user identifier is not known by the RP yet
-            if ($request->idSelect()) {
-                if ($request->mode == 'checkid_immediate') {
-                    // Deny authentication if we can't interact with the user
-                    $response =& $request->answer(false);
-                } else {
-                    // Otherwise save request in session and redirect
-                    // to a page that requires authentication
-                    S::set('openid_request', serialize($request));
-                    pl_redirect('openid/trust');
-                    return;
-                }
-
-            // If we still don't have an identifier (used or desired), give up
-            } else if (!$request->identity) {
-                $this->render_no_identifier_page($page, $request);
-                return;
-
-            // From now on we have an identifier
-            // We always require confirmation before sending information
-            // to third-party websites
-            // So for now we deny immediate requests
-            } else if ($request->immediate) {
-                $response =& $request->answer(false);
-
-            // The user may confirm the use of his OpenId
-            } else {
-                // Save request in session and jump to confirmation page
-                S::set('openid_request', serialize($request));
-                pl_redirect('openid/trust');
-                return;
-            }
+        // In modes 'checkid_immediate' and 'checkid_setup', the request
+        // needs some logic and can not be automatically answered by the server
+
+        // Immediate mode
+        if ($request->mode == 'checkid_immediate') {
+
+            // We deny immediate requests, unless:
+            //   - the user identifier is known by the RP
+            //   - the user is logged in
+            //   - the user identifier matches the user logged in
+            //   - the user has whitelisted the site
+            $answer = !$request->idSelect()
+                      && S::logged()
+                      && $request->identity == S::user()->login()
+                      && is_trusted_site(S::user(), $request->trust_root);
+            $response =& $request->answer($answer);
+
+        // Setup mode
+        } else if ($request->mode == 'checkid_setup') {
+
+            // We redirect to a page where the user will authenticate
+            // and confirm the use of his/her OpenId
+            // The request is saved in session before redirecting
+            S::set('openid_request', serialize($request));
+            pl_redirect('openid/trust');
+            return;
 
         // Other requests can be automatically handled by the server
         } else {
             $response =& $server->handleRequest($request);
         }
 
-        // Render response
         $webresponse =& $server->encodeResponse($response);
         $this->render_openid_response($webresponse);
     }
@@ -151,7 +133,6 @@ class OpenidModule extends PLModule
             return;
         }
 
-        // Unserialize the request
         require_once 'Auth/OpenID/Server.php';
         $request = unserialize($request);
 
@@ -179,9 +160,10 @@ class OpenidModule extends PLModule
         $sreg_request = Auth_OpenID_SRegRequest::fromOpenIDRequest($request);
         $sreg_response = Auth_OpenID_SRegResponse::extractResponse($sreg_request, get_sreg_data($user));
 
+        $whitelisted = is_trusted_site($user, $request->trust_root);
 
         // Ask the user for confirmation
-        if ($_SERVER['REQUEST_METHOD'] != 'POST') {
+        if (!$whitelisted && $_SERVER['REQUEST_METHOD'] != 'POST') {
             $page->changeTpl('openid/trust.tpl');
             $page->assign('relying_party', $request->trust_root);
             $page->assign_by_ref('sreg_data', $sreg_response->data);
@@ -189,8 +171,14 @@ class OpenidModule extends PLModule
         }
 
         // At this point $_SERVER['REQUEST_METHOD'] == 'POST'
+
+        // Add 'always trusted' sites to whitelist
+        if (isset($_POST['trust']) && @$_POST['always']) {
+            add_trusted_site($user, $request->trust_root);
+        }
+
         // Answer to the Relying Party
-        if (isset($_POST['trust'])) {
+        if ($whitelisted || isset($_POST['trust'])) {
             S::kill('openid_request');
             $response =& $request->answer(true, null, $identity, $claimed_id);
 
@@ -198,25 +186,44 @@ class OpenidModule extends PLModule
             // response message.
             $sreg_response->toMessage($response->fields);
 
-        } else { // !isset($_POST['trust'])
+        } else { // !$whitelisted && !isset($_POST['trust'])
             S::kill('openid_request');
             $response =& $request->answer(false);
         }
 
-        // Generate a response to send to the user agent.
         $webresponse =& $server->encodeResponse($response);
         $this->render_openid_response($webresponse);
     }
 
+    function handler_trusted(&$page, $action = 'list', $id = null)
+    {
+        $page->setTitle('Sites tiers de confiance');
+        $page->assign('title', 'Mes sites tiers de confiance pour OpenId');
+        $table_editor = new PLTableEditor('openid/trusted', 'openid_trusted', 'id');
+        $table_editor->set_where_clause('user_id = ' . XDB::escape(S::user()->id()));
+        $table_editor->vars['user_id']['display'] = false;
+        $table_editor->describe('url', 'site tiers', true);
+        $page->assign('deleteonly', true);
+        $table_editor->apply($page, $action, $id);
+    }
+
+    function handler_admin_trusted(&$page, $action = 'list', $id = null)
+    {
+        $page->setTitle('Sites tiers de confiance');
+        $page->assign('title', 'Sites tiers de confiance globaux pour OpenId');
+        $table_editor = new PLTableEditor('admin/openid/trusted', 'openid_trusted', 'id');
+        $table_editor->set_where_clause('user_id IS NULL');
+        $table_editor->vars['user_id']['display'] = false;
+        $table_editor->describe('url', 'site tiers', true);
+        $page->assign('readonly', true);
+        $table_editor->apply($page, $action, $id);
+    }
+
     function handler_idp_xrds(&$page)
     {
         $this->load('openid.inc.php');
-
-        // Set XRDS content-type and template
         header('Content-type: application/xrds+xml');
         $page->changeTpl('openid/idp_xrds.tpl', NO_SKIN);
-
-        // Set variables
         $page->assign('type2', Auth_OpenID_TYPE_2_0_IDP);
         $page->assign('sreg', Auth_OpenID_SREG_URI);
         $page->assign('provider', get_openid_url());
@@ -226,17 +233,13 @@ class OpenidModule extends PLModule
     {
         $this->load('openid.inc.php');
 
-        // Make sure the user exists
         $user = get_user($x);
         if (is_null($user)) {
             return PL_NOT_FOUND;
         }
 
-        // Set XRDS content-type and template
         header('Content-type: application/xrds+xml');
         $page->changeTpl('openid/user_xrds.tpl', NO_SKIN);
-
-        // Set variables
         $page->assign('type2', Auth_OpenID_TYPE_2_0);
         $page->assign('type1', Auth_OpenID_TYPE_1_1);
         $page->assign('sreg', Auth_OpenID_SREG_URI);
@@ -277,43 +280,26 @@ class OpenidModule extends PLModule
         // 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
+        // Set 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)
-    {
-        // Select template
-        $page->changeTpl('openid/no_identifier.tpl');
-    }
-
     function render_openid_response($webresponse)
     {
-        // Send HTTP response code
         if ($webresponse->code != AUTH_OPENID_HTTP_OK) {
             header(sprintf("HTTP/1.1 %d ", $webresponse->code),
                    true, $webresponse->code);
         }
-
-        // Send headers
         foreach ($webresponse->headers as $k => $v) {
             header("$k: $v");
         }
         header('Connection: close');
-
-        // Send body
         print $webresponse->body;
         exit;
     }