plugins/OpenID/openid.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  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 Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
  21
  22 require_once(INSTALLDIR.'/plugins/OpenID/User_openid.php');
  23
  24 require_once('Auth/OpenID.php');
  25 require_once('Auth/OpenID/Consumer.php');
  26 require_once('Auth/OpenID/Server.php');
  27 require_once('Auth/OpenID/SReg.php');
  28 require_once('Auth/OpenID/MySQLStore.php');
  29
  30 # About one year cookie expiry
  31
  32 define('OPENID_COOKIE_EXPIRY', round(365.25 * 24 * 60 * 60));
  33 define('OPENID_COOKIE_KEY', 'lastusedopenid');
  34
  35 function oid_store()
  36 {
  37     static $store = null;
  38     if (!$store) {
  39         # Can't be called statically
  40         $user = new User();
  41         $conn = $user->getDatabaseConnection();
  42         $store = new Auth_OpenID_MySQLStore($conn);
  43     }
  44     return $store;
  45 }
  46
  47 function oid_consumer()
  48 {
  49     $store = oid_store();
  50     $consumer = new Auth_OpenID_Consumer($store);
  51     return $consumer;
  52 }
  53
  54 function oid_server()
  55 {
  56     $store = oid_store();
  57     $server = new Auth_OpenID_Server($store, common_local_url('openidserver'));
  58     return $server;
  59 }
  60
  61 function oid_clear_last()
  62 {
  63     oid_set_last('');
  64 }
  65
  66 function oid_set_last($openid_url)
  67 {
  68     common_set_cookie(OPENID_COOKIE_KEY,
  69                      $openid_url,
  70                      time() + OPENID_COOKIE_EXPIRY);
  71 }
  72
  73 function oid_get_last()
  74 {
  75     if (empty($_COOKIE[OPENID_COOKIE_KEY])) {
  76         return null;
  77     }
  78     $openid_url = $_COOKIE[OPENID_COOKIE_KEY];
  79     if ($openid_url && strlen($openid_url) > 0) {
  80         return $openid_url;
  81     } else {
  82         return null;
  83     }
  84 }
  85
  86 function oid_link_user($id, $canonical, $display)
  87 {
  88
  89     $oid = new User_openid();
  90     $oid->user_id = $id;
  91     $oid->canonical = $canonical;
  92     $oid->display = $display;
  93     $oid->created = DB_DataObject_Cast::dateTime();
  94
  95     if (!$oid->insert()) {
  96         $err = PEAR::getStaticProperty('DB_DataObject','lastError');
  97         return false;
  98     }
  99
 100     return true;
 101 }
 102
 103 function oid_get_user($openid_url)
 104 {
 105     $user = null;
 106     $oid = User_openid::staticGet('canonical', $openid_url);
 107     if ($oid) {
 108         $user = User::staticGet('id', $oid->user_id);
 109     }
 110     return $user;
 111 }
 112
 113 function oid_check_immediate($openid_url, $backto=null)
 114 {
 115     if (!$backto) {
 116         $action = $_REQUEST['action'];
 117         $args = common_copy_args($_GET);
 118         unset($args['action']);
 119         $backto = common_local_url($action, $args);
 120     }
 121
 122     common_ensure_session();
 123
 124     $_SESSION['openid_immediate_backto'] = $backto;
 125
 126     oid_authenticate($openid_url,
 127                      'finishimmediate',
 128                      true);
 129 }
 130
 131 function oid_authenticate($openid_url, $returnto, $immediate=false)
 132 {
 133
 134     $consumer = oid_consumer();
 135
 136     if (!$consumer) {
 137         // TRANS: OpenID plugin server error.
 138         common_server_error(_m('Cannot instantiate OpenID consumer object.'));
 139         return false;
 140     }
 141
 142     common_ensure_session();
 143
 144     $auth_request = $consumer->begin($openid_url);
 145
 146     // Handle failure status return values.
 147     if (!$auth_request) {
 148         common_log(LOG_ERR, __METHOD__ . ": mystery fail contacting $openid_url");
 149         // TRANS: OpenID plugin message. Given when an OpenID is not valid.
 150         return _m('Not a valid OpenID.');
 151     } else if (Auth_OpenID::isFailure($auth_request)) {
 152         common_log(LOG_ERR, __METHOD__ . ": OpenID fail to $openid_url: $auth_request->message");
 153         // TRANS: OpenID plugin server error. Given when the OpenID authentication request fails.
 154         // TRANS: %s is the failure message.
 155         return sprintf(_m('OpenID failure: %s'), $auth_request->message);
 156     }
 157
 158     $sreg_request = Auth_OpenID_SRegRequest::build(// Required
 159                                                    array(),
 160                                                    // Optional
 161                                                    array('nickname',
 162                                                          'email',
 163                                                          'fullname',
 164                                                          'language',
 165                                                          'timezone',
 166                                                          'postcode',
 167                                                          'country'));
 168
 169     if ($sreg_request) {
 170         $auth_request->addExtension($sreg_request);
 171     }
 172
 173     $requiredTeam = common_config('openid', 'required_team');
 174     if ($requiredTeam) {
 175         // LaunchPad OpenID extension
 176         $team_request = new Auth_OpenID_TeamsRequest(array($requiredTeam));
 177         if ($team_request) {
 178             $auth_request->addExtension($team_request);
 179         }
 180     }
 181
 182     $trust_root = common_root_url(true);
 183     $process_url = common_local_url($returnto);
 184
 185     if ($auth_request->shouldSendRedirect()) {
 186         $redirect_url = $auth_request->redirectURL($trust_root,
 187                                                    $process_url,
 188                                                    $immediate);
 189         if (!$redirect_url) {
 190         } else if (Auth_OpenID::isFailure($redirect_url)) {
 191             // TRANS: OpenID plugin server error. Given when the OpenID authentication request cannot be redirected.
 192             // TRANS: %s is the failure message.
 193             return sprintf(_m('Could not redirect to server: %s'), $redirect_url->message);
 194         } else {
 195             common_redirect($redirect_url, 303);
 196         }
 197     } else {
 198         // Generate form markup and render it.
 199         $form_id = 'openid_message';
 200         $form_html = $auth_request->formMarkup($trust_root, $process_url,
 201                                                $immediate, array('id' => $form_id));
 202
 203         # XXX: This is cheap, but things choke if we don't escape ampersands
 204         # in the HTML attributes
 205
 206         $form_html = preg_replace('/&/', '&amp;', $form_html);
 207
 208         // Display an error if the form markup couldn't be generated;
 209         // otherwise, render the HTML.
 210         if (Auth_OpenID::isFailure($form_html)) {
 211             // TRANS: OpenID plugin server error if the form markup could not be generated.
 212             // TRANS: %s is the failure message.
 213             common_server_error(sprintf(_m('Could not create OpenID form: %s'), $form_html->message));
 214         } else {
 215             $action = new AutosubmitAction(); // see below
 216             $action->form_html = $form_html;
 217             $action->form_id = $form_id;
 218             $action->prepare(array('action' => 'autosubmit'));
 219             $action->handle(array('action' => 'autosubmit'));
 220         }
 221     }
 222 }
 223
 224 # Half-assed attempt at a module-private function
 225
 226 function _oid_print_instructions()
 227 {
 228     common_element('div', 'instructions',
 229                    // TRANS: OpenID plugin user instructions.
 230                    _m('This form should automatically submit itself. '.
 231                       'If not, click the submit button to go to your '.
 232                       'OpenID provider.'));
 233 }
 234
 235 /**
 236  * Update a user from sreg parameters
 237  * @param User $user
 238  * @param array $sreg fields from OpenID sreg response
 239  * @access private
 240  */
 241 function oid_update_user($user, $sreg)
 242 {
 243     $profile = $user->getProfile();
 244
 245     $orig_profile = clone($profile);
 246
 247     if (!empty($sreg['fullname']) && strlen($sreg['fullname']) <= 255) {
 248         $profile->fullname = $sreg['fullname'];
 249     }
 250
 251     if (!empty($sreg['country'])) {
 252         if ($sreg['postcode']) {
 253             # XXX: use postcode to get city and region
 254             # XXX: also, store postcode somewhere -- it's valuable!
 255             $profile->location = $sreg['postcode'] . ', ' . $sreg['country'];
 256         } else {
 257             $profile->location = $sreg['country'];
 258         }
 259     }
 260
 261     # XXX save language if it's passed
 262     # XXX save timezone if it's passed
 263
 264     if (!$profile->update($orig_profile)) {
 265         // TRANS: OpenID plugin server error.
 266         common_server_error(_m('Error saving the profile.'));
 267         return false;
 268     }
 269
 270     $orig_user = clone($user);
 271
 272     if (!empty($sreg['email']) && Validate::email($sreg['email'], common_config('email', 'check_domain'))) {
 273         $user->email = $sreg['email'];
 274     }
 275
 276     if (!$user->update($orig_user)) {
 277         // TRANS: OpenID plugin server error.
 278         common_server_error(_m('Error saving the user.'));
 279         return false;
 280     }
 281
 282     return true;
 283 }
 284
 285 function oid_assert_allowed($url)
 286 {
 287     $blacklist = common_config('openid', 'blacklist');
 288     $whitelist = common_config('openid', 'whitelist');
 289
 290     if (empty($blacklist)) {
 291         $blacklist = array();
 292     }
 293
 294     if (empty($whitelist)) {
 295         $whitelist = array();
 296     }
 297
 298     foreach ($blacklist as $pattern) {
 299         if (preg_match("/$pattern/", $url)) {
 300             common_log(LOG_INFO, "Matched OpenID blacklist pattern {$pattern} with {$url}");
 301             foreach ($whitelist as $exception) {
 302                 if (preg_match("/$exception/", $url)) {
 303                     common_log(LOG_INFO, "Matched OpenID whitelist pattern {$exception} with {$url}");
 304                     return;
 305                 }
 306             }
 307             // TRANS: OpenID plugin client exception (403).
 308             throw new ClientException(_m("Unauthorized URL used for OpenID login."), 403);
 309         }
 310     }
 311
 312     return;
 313 }
 314
 315 /**
 316  * Check the teams available in the given OpenID response
 317  * Using Launchpad's OpenID teams extension
 318  *
 319  * @return boolean whether this user is acceptable
 320  */
 321 function oid_check_teams($response)
 322 {
 323     $requiredTeam = common_config('openid', 'required_team');
 324     if ($requiredTeam) {
 325         $team_resp = new Auth_OpenID_TeamsResponse($response);
 326         if ($team_resp) {
 327             $teams = $team_resp->getTeams();
 328         } else {
 329             $teams = array();
 330         }
 331
 332         $match = in_array($requiredTeam, $teams);
 333         $is = $match ? 'is' : 'is not';
 334         common_log(LOG_DEBUG, "Remote user $is in required team $requiredTeam: [" . implode(', ', $teams) . "]");
 335
 336         return $match;
 337     }
 338
 339     return true;
 340 }
 341
 342 class AutosubmitAction extends Action
 343 {
 344     var $form_html = null;
 345     var $form_id = null;
 346
 347     function handle($args)
 348     {
 349         parent::handle($args);
 350         $this->showPage();
 351     }
 352
 353     function title()
 354     {
 355         // TRANS: Title
 356         return _m('OpenID Login Submission');
 357     }
 358
 359     function showContent()
 360     {
 361         $this->raw('<p style="margin: 20px 80px">');
 362         // @fixme this would be better using standard CSS class, but the present theme's a bit scary.
 363         $this->element('img', array('src' => Theme::path('images/icons/icon_processing.gif', 'base'),
 364                                     // for some reason the base CSS sets <img>s as block display?!
 365                                     'style' => 'display: inline'));
 366         // TRANS: OpenID plugin message used while requesting authorization user's OpenID login provider.
 367         $this->text(_m('Requesting authorization from your login provider...'));
 368         $this->raw('</p>');
 369         $this->raw('<p style="margin-top: 60px; font-style: italic">');
 370         // TRANS: OpenID plugin message. User instruction while requesting authorization user's OpenID login provider.
 371         $this->text(_m('If you are not redirected to your login provider in a few seconds, try pushing the button below.'));
 372         $this->raw('</p>');
 373         $this->raw($this->form_html);
 374     }
 375
 376     function showScripts()
 377     {
 378         parent::showScripts();
 379         $this->element('script', null,
 380                        'document.getElementById(\'' . $this->form_id . '\').submit();');
 381     }
 382 }