2 /***************************************************************************
3 * Copyright (C) 2003-2008 Polytechnique.org *
4 * http://opensource.polytechnique.org/ *
6 * This program is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the Free Software *
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
20 ***************************************************************************/
23 /* Definitions for the OpenId Specification
24 * http://openid.net/specs/openid-authentication-2_0.html
26 * OP Endpoint URL: https://www.polytechnique.org/openid
27 * OP Identifier: https://www.polytechnique.org/openid
28 * User Identifier: https://www.polytechnique.org/openid/{hruid}
29 * OP-Local Identifier: {hruid}
32 /* This implementation supports two modes:
33 * - entering the OP Identifier, which can simply be 'polytechnique.org'
34 * - entering the User Identifier, or some URL that resolves there
35 * In both cases, Yadis discovery is made possible through the X-XRDS-Location
38 * In the former case, Yadis discovery is performed on /, or where it redirects;
39 * see platal.php. It resolves to the XRDS for this OP, and User Identifier
40 * selection is performed after forcing the user to log in. This only works for
41 * version 2.0 of the OpenId protocol.
43 * In the latter cas, Yadis discovery is performed on /openid/{hruid}. It
44 * resolves ta a user-specific XRDS. This page also features HTML-based
45 * discovery. This works with any version of the protocol.
48 /* Testing suite is here:
49 * http://openidenabled.com/resources/openid-test/
50 * It only supports User Indentifiers.
52 * To test OP Identifiers, download the JanRain PHP library and use the
53 * consumer provided as an example (although it appears that a failure is
54 * mistakenly reported: 'Server denied check_authentication').
55 * Reading the source of the server can also help understanding the code below.
58 /* **checkid_immediate is not supported (yet)**, which means that we will
59 * always ask for confirmation before redirecting to a third-party.
60 * A sensible way to implement it would be to add a "Always trust this site"
61 * checkbox to the form, and to store trusted websites per user. This still
62 * raises the question of removing websites from that list.
63 * Another possibility is to maintain a global whitelist.
66 class OpenidModule
extends PLModule
71 'openid' => $this->make_hook('openid', AUTH_PUBLIC
),
72 'openid/trust' => $this->make_hook('trust', AUTH_COOKIE
),
73 'openid/idp_xrds' => $this->make_hook('idp_xrds', AUTH_PUBLIC
),
74 'openid/user_xrds' => $this->make_hook('user_xrds', AUTH_PUBLIC
),
75 'openid/melix' => $this->make_hook('melix', AUTH_PUBLIC
),
79 function handler_openid(&$page, $x = null
)
81 $this->load('openid.inc.php');
83 // Spec ยง4.1.2: if "openid.mode" is absent, whe SHOULD assume that
84 // the request is not an OpenId message
85 // Thus, we try to render the discovery page
86 if (!array_key_exists('openid_mode', $_REQUEST)) {
87 return $this->render_discovery_page($page, get_user($x));
90 // Now, deal with the OpenId message
91 // Create a server and decode the request
92 $server = init_openid_server();
93 $request = $server->decodeRequest();
95 // In modes 'checkid_immediate' and 'checkid_setup', the request
96 // needs some logic and can not be automatically answered by the server
99 if ($request->mode
== 'checkid_immediate') {
101 // We deny immediate requests, unless:
102 // - the user identifier is known by the RP
103 // - the user is logged in
104 // - the user identifier matches the user logged in
105 // - the user and has whitelisted the site
106 $answer = !$request->idSelect()
108 && $request->identity
== S
::user()->login()
109 && is_trusted_site(S
::user(), $request->trust_root
);
110 $response =& $request->answer($answer);
113 } else if ($request->mode
== 'checkid_setup') {
115 // We redirect to a page where the user will authenticate
116 // and confirm the use of his/her OpenId
117 // Save request in session before jumping to confirmation page
118 S
::set('openid_request', serialize($request));
119 pl_redirect('openid/trust');
122 // Other requests can be automatically handled by the server
124 $response =& $server->handleRequest($request);
128 $webresponse =& $server->encodeResponse($response);
129 $this->render_openid_response($webresponse);
132 function handler_trust(&$page, $x = null
)
134 $this->load('openid.inc.php');
136 // Recover request in session
137 $request = S
::v('openid_request');
138 if (is_null($request)) {
139 // There is no authentication information, something went wrong
144 // Unserialize the request
145 require_once 'Auth/OpenID/Server.php';
146 $request = unserialize($request);
148 $server = init_openid_server();
153 // Set the identity to the user currently logged in
154 // if an OP Identifier was initially used
155 if ($request->identity
== Auth_OpenID_IDENTIFIER_SELECT
) {
156 $identity = $user->hruid
;
157 $claimed_id = get_user_openid_url($user);
158 // Check that the identity matches the user currently logged in
159 // if an User Identifier was initially used
160 } else if ($request->identity
!= $user->hruid
) {
161 $response =& $request->answer(false
);
162 $webresponse =& $server->encodeResponse($response);
163 $this->render_openid_response($webresponse);
167 // Prepare Simple Registration response fields
168 require_once 'Auth/OpenID/SReg.php';
169 $sreg_request = Auth_OpenID_SRegRequest
::fromOpenIDRequest($request);
170 $sreg_response = Auth_OpenID_SRegResponse
::extractResponse($sreg_request, get_sreg_data($user));
172 // Check the whitelist
173 $whitelisted = is_trusted_site($user, $request->trust_root
);
175 // Ask the user for confirmation
176 if (!$whitelisted && $_SERVER['REQUEST_METHOD'] != 'POST') {
177 $page->changeTpl('openid/trust.tpl');
178 $page->assign('relying_party', $request->trust_root
);
179 $page->assign_by_ref('sreg_data', $sreg_response->data
);
183 // At this point $_SERVER['REQUEST_METHOD'] == 'POST'
184 // Answer to the Relying Party
185 if ($whitelisted ||
isset($_POST['trust'])) {
186 S
::kill('openid_request');
187 $response =& $request->answer(true
, null
, $identity, $claimed_id);
189 // Add the simple registration response values to the OpenID
191 $sreg_response->toMessage($response->fields
);
193 } else { // !$whitelisted && !isset($_POST['trust'])
194 S
::kill('openid_request');
195 $response =& $request->answer(false
);
198 // Generate a response to send to the user agent.
199 $webresponse =& $server->encodeResponse($response);
200 $this->render_openid_response($webresponse);
203 function handler_idp_xrds(&$page)
205 $this->load('openid.inc.php');
207 // Set XRDS content-type and template
208 header('Content-type: application/xrds+xml');
209 $page->changeTpl('openid/idp_xrds.tpl', NO_SKIN
);
212 $page->assign('type2', Auth_OpenID_TYPE_2_0_IDP
);
213 $page->assign('sreg', Auth_OpenID_SREG_URI
);
214 $page->assign('provider', get_openid_url());
217 function handler_user_xrds(&$page, $x = null
)
219 $this->load('openid.inc.php');
221 // Make sure the user exists
222 $user = get_user($x);
223 if (is_null($user)) {
227 // Set XRDS content-type and template
228 header('Content-type: application/xrds+xml');
229 $page->changeTpl('openid/user_xrds.tpl', NO_SKIN
);
232 $page->assign('type2', Auth_OpenID_TYPE_2_0
);
233 $page->assign('type1', Auth_OpenID_TYPE_1_1
);
234 $page->assign('sreg', Auth_OpenID_SREG_URI
);
235 $page->assign('provider', get_openid_url());
236 $page->assign('local_id', $user->hruid
);
239 function handler_melix(&$page, $x = null
)
241 $this->load('openid.inc.php');
242 $user = get_user_by_alias($x);
244 // This will redirect to the canonic URL, which was not used
245 // if this hook was triggered
246 return $this->render_discovery_page(&$page, $user);
249 //--------------------------------------------------------------------//
251 function render_discovery_page(&$page, $user)
254 // Show the documentation if this is not the OpenId page of an user
255 if (is_null($user)) {
256 pl_redirect('Xorg/OpenId');
259 // Redirect to the canonic URL if we are using an alias
260 // There might be a risk of redirection loop here
261 // if $_SERVER was not exactly what we expect
262 $current_url = 'http' . (empty($_SERVER['HTTPS']) ?
'' : 's') . '://'
263 . $_SERVER['SERVER_NAME'] . $_SERVER['REQUEST_URI'];
264 $canonic_url = get_user_openid_url($user);
265 if ($current_url != $canonic_url) {
266 http_redirect($canonic_url);
269 // Include X-XRDS-Location response-header for Yadis discovery
270 header('X-XRDS-Location: ' . get_user_xrds_url($user));
273 $page->changeTpl('openid/openid.tpl');
275 // Sets the title of the html page.
276 $page->setTitle($user->fullName());
278 // Sets the <link> tags for HTML-Based Discovery
279 $page->addLink('openid.server openid2.provider', get_openid_url());
280 $page->addLink('openid.delegate openid2.local_id', $user->hruid
);
282 // Adds the global user property array to the display.
283 $page->assign_by_ref('user', $user);
288 function render_no_identifier_page($page, $request)
291 $page->changeTpl('openid/no_identifier.tpl');
294 function render_openid_response($webresponse)
296 // Send HTTP response code
297 if ($webresponse->code
!= AUTH_OPENID_HTTP_OK
) {
298 header(sprintf("HTTP/1.1 %d ", $webresponse->code
),
299 true
, $webresponse->code
);
303 foreach ($webresponse->headers
as $k => $v) {
306 header('Connection: close');
309 print $webresponse->body
;
314 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: