X-Git-Url: http://git.polytechnique.org/?a=blobdiff_plain;f=modules%2Fopenid.php;h=843effc59e9e4d1d0950e359df5a1a1be1313679;hb=91f3d206fde4d53cbe3f418cd6fcd6c63c4795ac;hp=c05c0bc498fe07478175b9e365caf9ada7f04e67;hpb=b69727b412cae8449a78dee9ec79ddc70aab985f;p=platal.git diff --git a/modules/openid.php b/modules/openid.php index c05c0bc..843effc 100644 --- a/modules/openid.php +++ b/modules/openid.php @@ -19,93 +19,291 @@ * 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 Identifier: https://www.polytechnique.org/openid/{hruid} + * OP-Local Identifier: {hruid} + */ + +/* This implementation supports two modes: + * - entering the OP Identifier, which can simply be 'polytechnique.org' + * - 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 + * version 2.0 of the OpenId protocol. + * + * In the latter cas, Yadis discovery is performed on /openid/{hruid}. It + * resolves ta a user-specific XRDS. This page also features HTML-based + * discovery. This works with any version of the protocol. + */ + +/* Testing suite is here: + * http://openidenabled.com/resources/openid-test/ + * It only supports User Indentifiers. + * + * To test OP Identifiers, download the JanRain PHP library and use the + * consumer provided as an example (although it appears that a failure is + * mistakenly reported: 'Server denied check_authentication'). + * Reading the source of the server can also help understanding the code below. + */ + + 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/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/trust' => $this->make_hook('trust', AUTH_PUBLIC), + 'openid/melix' => $this->make_hook('melix', AUTH_PUBLIC), ); } - function init_openid() + function handler_openid(&$page, $x = null) { - require_once 'Auth/OpenID.php'; $this->load('openid.inc.php'); + + // Spec §4.1.2: if "openid.mode" is absent, we SHOULD assume that + // the request is not an OpenId message + if (!array_key_exists('openid_mode', $_REQUEST)) { + return $this->render_discovery_page($page, get_user($x)); + } + + // Now, deal with the OpenId message + $server = init_openid_server(); + $request = $server->decodeRequest(); + + // 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); + } + + $webresponse =& $server->encodeResponse($response); + $this->render_openid_response($webresponse); } - function handler_openid(&$page, $x = null) + function handler_trust(&$page, $x = null) { - global $globals; + $this->load('openid.inc.php'); - // Determines the user whose openid we are going to display - if (is_null($x)) { - return PL_NOT_FOUND; + // Recover request in session + $request = S::v('openid_request'); + if (is_null($request)) { + // There is no authentication information, something went wrong + pl_redirect('/'); + return; } - $login = S::logged() ? User::get($x) : User::getSilent($x); - if (!$login) { - return PL_NOT_FOUND; + require_once 'Auth/OpenID/Server.php'; + $request = unserialize($request); + + $server = init_openid_server(); + $user = S::user(); + $identity = null; + $claimed_id = null; + + // Set the identity to the user currently logged in + // if an OP Identifier was initially used + if ($request->identity == Auth_OpenID_IDENTIFIER_SELECT) { + $identity = $user->hruid; + $claimed_id = get_user_openid_url($user); + // Check that the identity matches the user currently logged in + // if an User Identifier was initially used + } else if ($request->identity != $user->hruid) { + $response =& $request->answer(false); + $webresponse =& $server->encodeResponse($response); + $this->render_openid_response($webresponse); + return; } - // Include X-XRDS-Location response-header for Yadis discovery - $user_xrds = $globals->baseurl . 'openid/user_xrds/' . $login->hruid; - header('X-XRDS-Location: ' . $user_xrds); + // Prepare Simple Registration response fields + require_once 'Auth/OpenID/SReg.php'; + $sreg_request = Auth_OpenID_SRegRequest::fromOpenIDRequest($request); + $sreg_response = Auth_OpenID_SRegResponse::extractResponse($sreg_request, get_sreg_data($user)); - // Select template - $page->changeTpl('openid/openid.tpl'); + $whitelisted = is_trusted_site($user, $request->trust_root); - // Sets the title of the html page. - $page->setTitle($login->fullName()); + // Ask the user for confirmation + 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); + return; + } + + // 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); + } - // Sets the tags for HTML-Based Discovery - $page->addLink('openid.server openid2.provider', - $globals->baseurl . '/openid'); - $page->addLink('openid.delegate openid2.local_id', - $login->hruid); + // Answer to the Relying Party + if ($whitelisted || isset($_POST['trust'])) { + S::kill('openid_request'); + $response =& $request->answer(true, null, $identity, $claimed_id); - // Adds the global user property array to the display. - $page->assign_by_ref('user', $login); + // Add the simple registration response values to the OpenID + // response message. + $sreg_response->toMessage($response->fields); + + } else { // !$whitelisted && !isset($_POST['trust']) + S::kill('openid_request'); + $response =& $request->answer(false); + } + + $webresponse =& $server->encodeResponse($response); + $this->render_openid_response($webresponse); } - function handler_idp_xrds(&$page) + function handler_trusted(&$page, $action = 'list', $id = null) { - global $globals; + $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); + } - // Load constants - require_once "Auth/OpenID/Discover.php"; + 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); + } - // Set XRDS content-type and template + function handler_idp_xrds(&$page) + { + $this->load('openid.inc.php'); header('Content-type: application/xrds+xml'); $page->changeTpl('openid/idp_xrds.tpl', NO_SKIN); - - // 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('type2', Auth_OpenID_TYPE_2_0_IDP); + $page->assign('sreg', Auth_OpenID_SREG_URI); + $page->assign('provider', get_openid_url()); } function handler_user_xrds(&$page, $x = null) { - global $globals; + $this->load('openid.inc.php'); - // Load constants - require_once "Auth/OpenID/Discover.php"; + $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); + $page->assign('type2', Auth_OpenID_TYPE_2_0); + $page->assign('type1', Auth_OpenID_TYPE_1_1); + $page->assign('sreg', Auth_OpenID_SREG_URI); + $page->assign('provider', get_openid_url()); + $page->assign('local_id', $user->hruid); + } + + function handler_melix(&$page, $x = null) + { + $this->load('openid.inc.php'); + $user = get_user_by_alias($x); + + // This will redirect to the canonic URL, which was not used + // if this hook was triggered + return $this->render_discovery_page(&$page, $user); + } + + //--------------------------------------------------------------------// + + function render_discovery_page(&$page, $user) + { + + // Show the documentation if this is not the OpenId page of an user + if (is_null($user)) { + pl_redirect('Xorg/OpenId'); + } + + // Redirect to the canonic URL if we are using an alias + // There might be a risk of redirection loop here + // if $_SERVER was not exactly what we expect + $current_url = 'http' . (empty($_SERVER['HTTPS']) ? '' : 's') . '://' + . $_SERVER['SERVER_NAME'] . $_SERVER['REQUEST_URI']; + $canonic_url = get_user_openid_url($user); + if ($current_url != $canonic_url) { + http_redirect($canonic_url); + } - // Set variables - $page->assign('type1', Auth_OpenID_TYPE_2_0); - $page->assign('type2', Auth_OpenID_TYPE_1_1); - $page->assign('uri', $globals->baseurl . '/openid'); + // Include X-XRDS-Location response-header for Yadis discovery + header('X-XRDS-Location: ' . get_user_xrds_url($user)); + + $page->changeTpl('openid/openid.tpl'); + $page->setTitle($user->fullName()); + // Set the tags for HTML-Based Discovery + $page->addLink('openid.server openid2.provider', get_openid_url()); + $page->addLink('openid.delegate openid2.local_id', $user->hruid); + $page->assign_by_ref('user', $user); + + return; } + function render_openid_response($webresponse) + { + 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"); + } + header('Connection: close'); + print $webresponse->body; + exit; + } } // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: -?> +?> \ No newline at end of file