3 * StatusNet, the distributed open-source microblogging tool
7 * LICENCE: This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 * @author Evan Prodromou <evan@status.net>
23 * @author Craig Andrews <candrews@integralblue.com>
24 * @copyright 2009-2010 StatusNet, Inc.
25 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET')) {
35 * Plugin for OpenID authentication and identity
37 * This class enables consumer support for OpenID, the distributed authentication
38 * and identity system.
40 * Depends on: WebFinger plugin for HostMeta-lookup (user@host format)
44 * @author Evan Prodromou <evan@status.net>
45 * @author Craig Andrews <candrews@integralblue.com>
46 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
47 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
48 * @link http://status.net/
49 * @link http://openid.net/
51 class OpenIDPlugin extends Plugin
53 // Plugin parameter: set true to disallow non-OpenID logins
54 // If set, overrides the setting in database or $config['site']['openidonly']
55 public $openidOnly = null;
60 if ($this->openidOnly !== null) {
62 $config['site']['openidonly'] = (bool)$this->openidOnly;
67 * Add OpenID-related paths to the router table
69 * Hook for RouterInitialized event.
71 * @param URLMapper $m URL mapper
73 * @return boolean hook return
75 public function onStartInitializeRouter(URLMapper $m)
77 $m->connect('main/openid', array('action' => 'openidlogin'));
78 $m->connect('main/openidtrust', array('action' => 'openidtrust'));
79 $m->connect('settings/openid', array('action' => 'openidsettings'));
80 $m->connect('index.php?action=finishopenidlogin',
81 array('action' => 'finishopenidlogin'));
82 $m->connect('index.php?action=finishaddopenid',
83 array('action' => 'finishaddopenid'));
84 $m->connect('main/openidserver', array('action' => 'openidserver'));
85 $m->connect('panel/openid', array('action' => 'openidadminpanel'));
91 * In OpenID-only mode, disable paths for password stuff
93 * @param string $path path to connect
94 * @param array $defaults path defaults
95 * @param array $rules path rules
96 * @param array $result unused
98 * @return boolean hook return
100 function onStartConnectPath(&$path, &$defaults, &$rules, &$result)
102 if (common_config('site', 'openidonly')) {
103 // Note that we should not remove the login and register
104 // actions. Lots of auth-related things link to them,
105 // such as when visiting a private site without a session
106 // or revalidating a remembered login for admin work.
108 // We take those two over with redirects to ourselves
109 // over in onArgsInitialize().
110 static $block = array('main/recoverpassword',
111 'settings/password');
113 if (in_array($path, $block)) {
122 * If we've been hit with password-login args, redirect
124 * @param array $args args (URL, Get, post)
126 * @return boolean hook return
128 function onArgsInitialize($args)
130 if (common_config('site', 'openidonly')) {
131 if (array_key_exists('action', $args)) {
132 $action = trim($args['action']);
133 if (in_array($action, array('login', 'register'))) {
134 common_redirect(common_local_url('openidlogin'));
135 } else if ($action == 'passwordsettings') {
136 common_redirect(common_local_url('openidsettings'));
137 } else if ($action == 'recoverpassword') {
138 // TRANS: Client exception thrown when an action is not available.
139 throw new ClientException(_m('Unavailable action.'));
147 * Public XRDS output hook
149 * Puts the bits of code needed by some OpenID providers to show
150 * we're good citizens.
152 * @param Action $action Action being executed
153 * @param XMLOutputter &$xrdsOutputter Output channel
155 * @return boolean hook return
157 function onEndPublicXRDS(Action $action, &$xrdsOutputter)
159 $xrdsOutputter->elementStart('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
160 'xmlns:simple' => 'http://xrds-simple.net/core/1.0',
161 'version' => '2.0'));
162 $xrdsOutputter->element('Type', null, 'xri://$xrds*simple');
164 foreach (array('finishopenidlogin', 'finishaddopenid') as $finish) {
165 $xrdsOutputter->showXrdsService(Auth_OpenID_RP_RETURN_TO_URL_TYPE,
166 common_local_url($finish));
169 $xrdsOutputter->showXrdsService('http://specs.openid.net/auth/2.0/server',
170 common_local_url('openidserver'),
173 'http://specs.openid.net/auth/2.0/identifier_select');
174 $xrdsOutputter->elementEnd('XRD');
178 * User XRDS output hook
180 * Puts the bits of code needed to discover OpenID endpoints.
182 * @param Action $action Action being executed
183 * @param XMLOutputter &$xrdsOutputter Output channel
185 * @return boolean hook return
187 function onEndUserXRDS(Action $action, &$xrdsOutputter)
189 $xrdsOutputter->elementStart('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
190 'xml:id' => 'openid',
191 'xmlns:simple' => 'http://xrds-simple.net/core/1.0',
192 'version' => '2.0'));
193 $xrdsOutputter->element('Type', null, 'xri://$xrds*simple');
196 $xrdsOutputter->showXrdsService('http://specs.openid.net/auth/2.0/return_to',
197 common_local_url('finishopenidlogin'));
200 $xrdsOutputter->showXrdsService('http://specs.openid.net/auth/2.0/signon',
201 common_local_url('openidserver'),
204 common_profile_url($action->user->nickname));
205 $xrdsOutputter->elementEnd('XRD');
209 * If we're in OpenID-only mode, hide all the main menu except OpenID login.
211 * @param Action $action Action being run
213 * @return boolean hook return
215 function onStartPrimaryNav($action)
217 if (common_config('site', 'openidonly') && !common_logged_in()) {
218 // TRANS: Tooltip for main menu option "Login"
219 $tooltip = _m('TOOLTIP', 'Login to the site.');
220 $action->menuItem(common_local_url('openidlogin'),
221 // TRANS: Main menu option when not logged in to log in
226 // TRANS: Tooltip for main menu option "Help"
227 $tooltip = _m('TOOLTIP', 'Help me!');
228 $action->menuItem(common_local_url('doc', array('title' => 'help')),
229 // TRANS: Main menu option for help on the StatusNet site
234 if (!common_config('site', 'private')) {
235 // TRANS: Tooltip for main menu option "Search"
236 $tooltip = _m('TOOLTIP', 'Search for people or text.');
237 $action->menuItem(common_local_url('peoplesearch'),
238 // TRANS: Main menu option when logged in or when the StatusNet instance is not private
239 _m('MENU', 'Search'), $tooltip, false, 'nav_search');
241 Event::handle('EndPrimaryNav', array($action));
250 * If we're in openidOnly mode, we disable the menu for all other login.
252 * @param Action $action Action being executed
254 * @return boolean hook return
256 function onStartLoginGroupNav($action)
258 if (common_config('site', 'openidonly')) {
259 $this->showOpenIDLoginTab($action);
260 // Even though we replace this code, we
261 // DON'T run the End* hook, to keep others from
262 // adding tabs. Not nice, but.
270 * Menu item for login
272 * @param Action $action Action being executed
274 * @return boolean hook return
276 function onEndLoginGroupNav($action)
278 $this->showOpenIDLoginTab($action);
284 * Show menu item for login
286 * @param Action $action Action being executed
290 function showOpenIDLoginTab($action)
292 $action_name = $action->trimmed('action');
294 $action->menuItem(common_local_url('openidlogin'),
295 // TRANS: OpenID plugin menu item on site logon page.
296 _m('MENU', 'OpenID'),
297 // TRANS: OpenID plugin tooltip for logon menu item.
298 _m('Login or register with OpenID.'),
299 $action_name === 'openidlogin');
303 * Show menu item for password
305 * We hide it in openID-only mode
307 * @param Action $menu Widget for menu
308 * @param void &$unused Unused value
312 function onStartAccountSettingsPasswordMenuItem($menu, &$unused) {
313 if (common_config('site', 'openidonly')) {
320 * Menu item for OpenID settings
322 * @param Action $action Action being executed
324 * @return boolean hook return
326 function onEndAccountSettingsNav($action)
328 $action_name = $action->trimmed('action');
330 $action->menuItem(common_local_url('openidsettings'),
331 // TRANS: OpenID plugin menu item on user settings page.
332 _m('MENU', 'OpenID'),
333 // TRANS: OpenID plugin tooltip for user settings menu item.
334 _m('Add or remove OpenIDs.'),
335 $action_name === 'openidsettings');
343 * Loads our classes if they're requested.
345 * @param string $cls Class requested
347 * @return boolean hook return
349 function onAutoload($cls)
353 case 'Auth_OpenID_TeamsExtension':
354 case 'Auth_OpenID_TeamsRequest':
355 case 'Auth_OpenID_TeamsResponse':
356 require_once dirname(__FILE__) . '/extlib/teams-extension.php';
360 return parent::onAutoload($cls);
366 * These actions should use https when SSL support is 'sometimes'
368 * @param Action $action Action to form an URL for
369 * @param boolean &$ssl Whether to mark it for SSL
371 * @return boolean hook return
373 function onSensitiveAction($action, &$ssl)
377 case 'finishopenidlogin':
378 case 'finishaddopenid':
389 * These actions should be visible even when the site is marked private
391 * @param Action $action Action to show
392 * @param boolean &$login Whether it's a login action
394 * @return boolean hook return
396 function onLoginAction($action, &$login)
401 case 'finishopenidlogin':
411 * We include a <meta> element linking to the webfinger resource page,
412 * for OpenID client-side authentication.
414 * @param Action $action Action being shown
418 function onEndShowHeadElements(Action $action)
420 if ($action instanceof ShowstreamAction) {
421 $action->element('link', array('rel' => 'openid2.provider',
422 'href' => common_local_url('openidserver')));
423 $action->element('link', array('rel' => 'openid2.local_id',
424 'href' => $action->profile->profileurl));
425 $action->element('link', array('rel' => 'openid.server',
426 'href' => common_local_url('openidserver')));
427 $action->element('link', array('rel' => 'openid.delegate',
428 'href' => $action->profile->profileurl));
431 if ($action instanceof SitestreamAction) {
432 $action->element('meta', array('http-equiv' => 'X-XRDS-Location',
433 'content' => common_local_url('publicxrds')));
439 * Redirect to OpenID login if they have an OpenID
441 * @param Action $action Action being executed
442 * @param User $user User doing the action
444 * @return boolean whether to continue
446 function onRedirectToLogin($action, $user)
448 if (common_config('site', 'openid_only') || (!empty($user) && User_openid::hasOpenID($user->id))) {
449 common_redirect(common_local_url('openidlogin'), 303);
455 * Show some extra instructions for using OpenID
457 * @param Action $action Action being executed
459 * @return boolean hook value
461 function onEndShowPageNotice($action)
463 $name = $action->trimmed('action');
468 if (common_logged_in()) {
469 // TRANS: Page notice for logged in users to try and get them to add an OpenID account to their StatusNet account.
470 // TRANS: This message contains Markdown links in the form (description)[link].
471 $instr = _m('(Have an [OpenID](http://openid.net/)? ' .
472 '[Add an OpenID to your account](%%action.openidsettings%%)!');
474 // TRANS: Page notice for anonymous users to try and get them to register with an OpenID account.
475 // TRANS: This message contains Markdown links in the form (description)[link].
476 $instr = _m('(Have an [OpenID](http://openid.net/)? ' .
477 'Try our [OpenID registration]'.
478 '(%%action.openidlogin%%)!)');
482 // TRANS: Page notice on the login page to try and get them to log on with an OpenID account.
483 // TRANS: This message contains Markdown links in the form (description)[link].
484 $instr = _m('(Have an [OpenID](http://openid.net/)? ' .
485 'Try our [OpenID login]'.
486 '(%%action.openidlogin%%)!)');
492 $output = common_markup_to_html($instr);
493 $action->raw($output);
498 * Load our document if requested
500 * @param string &$title Title to fetch
501 * @param string &$output HTML to output
503 * @return boolean hook value
505 function onStartLoadDoc(&$title, &$output)
507 if ($title == 'openid') {
508 $filename = INSTALLDIR.'/plugins/OpenID/doc-src/openid';
510 $c = file_get_contents($filename);
511 $output = common_markup_to_html($c);
512 return false; // success!
519 * Add our document to the global menu
521 * @param string $title Title being fetched
522 * @param string &$output HTML being output
524 * @return boolean hook value
526 function onEndDocsMenu(&$items) {
527 $items[] = array('doc',
528 array('title' => 'openid'),
529 _m('MENU', 'OpenID'),
530 _('Logging in with OpenID'),
538 * Assure that our data objects are available in the DB
540 * @return boolean hook value
542 function onCheckSchema()
544 $schema = Schema::get();
545 $schema->ensureTable('user_openid', User_openid::schemaDef());
546 $schema->ensureTable('user_openid_trustroot', User_openid_trustroot::schemaDef());
547 $schema->ensureTable('user_openid_prefs', User_openid_prefs::schemaDef());
549 /* These are used by JanRain OpenID library */
551 $schema->ensureTable('oid_associations',
554 'server_url' => array('type' => 'blob', 'not null' => true),
555 'handle' => array('type' => 'varchar', 'length' => 191, 'not null' => true, 'default' => ''), // character set latin1,
556 'secret' => array('type' => 'blob'),
557 'issued' => array('type' => 'int'),
558 'lifetime' => array('type' => 'int'),
559 'assoc_type' => array('type' => 'varchar', 'length' => 64),
561 'primary key' => array(array('server_url', 191), 'handle'),
563 $schema->ensureTable('oid_nonces',
566 'server_url' => array('type' => 'varchar', 'length' => 2047),
567 'timestamp' => array('type' => 'int'),
568 'salt' => array('type' => 'char', 'length' => 40),
570 'unique keys' => array(
571 'oid_nonces_server_url_timestamp_salt_key' => array(array('server_url', 191), 'timestamp', 'salt'),
579 * Add our tables to be deleted when a user is deleted
581 * @param User $user User being deleted
582 * @param array &$tables Array of table names
584 * @return boolean hook value
586 function onUserDeleteRelated($user, &$tables)
588 $tables[] = 'User_openid';
589 $tables[] = 'User_openid_trustroot';
594 * Add an OpenID tab to the admin panel
596 * @param Widget $nav Admin panel nav
598 * @return boolean hook value
600 function onEndAdminPanelNav($nav)
602 if (AdminPanelAction::canAdmin('openid')) {
604 $action_name = $nav->action->trimmed('action');
607 common_local_url('openidadminpanel'),
608 // TRANS: OpenID configuration menu item.
610 // TRANS: Tooltip for OpenID configuration menu item.
611 _m('OpenID configuration.'),
612 $action_name == 'openidadminpanel',
613 'nav_openid_admin_panel'
621 * Add OpenID information to the Account Management Control Document
622 * Event supplied by the Account Manager plugin
624 * @param array &$amcd Array that expresses the AMCD
626 * @return boolean hook value
629 function onEndAccountManagementControlDocument(&$amcd)
631 $amcd['auth-methods']['openid'] = array(
634 'path' => common_local_url('openidlogin'),
636 'identity' => 'openid_url'
643 * Add our version information to output
645 * @param array &$versions Array of version-data arrays
647 * @return boolean hook value
649 function onPluginVersion(&$versions)
651 $versions[] = array('name' => 'OpenID',
652 'version' => GNUSOCIAL_VERSION,
653 'author' => 'Evan Prodromou, Craig Andrews',
654 'homepage' => 'http://status.net/wiki/Plugin:OpenID',
656 // TRANS: Plugin description.
657 _m('Use <a href="http://openid.net/">OpenID</a> to login to the site.'));
661 function onStartOAuthLoginForm($action, &$button)
663 if (common_config('site', 'openidonly')) {
664 // Cancel the regular password login form, we won't need it.
665 $this->showOAuthLoginForm($action);
666 // TRANS: button label for OAuth authorization page when needing OpenID authentication first.
667 $button = _m('BUTTON', 'Continue');
670 // Leave the regular password login form in place.
671 // We'll add an OpenID link at bottom...?
677 * @fixme merge with common code for main OpenID login form
678 * @param HTMLOutputter $action
680 protected function showOAuthLoginForm($action)
682 $action->elementStart('fieldset');
683 // TRANS: OpenID plugin logon form legend.
684 $action->element('legend', null, _m('LEGEND','OpenID login'));
686 $action->elementStart('ul', 'form_data');
687 $action->elementStart('li');
688 $provider = common_config('openid', 'trusted_provider');
689 $appendUsername = common_config('openid', 'append_username');
691 // TRANS: Field label.
692 $action->element('label', array(), _m('OpenID provider'));
693 $action->element('span', array(), $provider);
694 if ($appendUsername) {
695 $action->element('input', array('id' => 'openid_username',
696 'name' => 'openid_username',
697 'style' => 'float: none'));
699 $action->element('p', 'form_guide',
700 // TRANS: Form guide.
701 ($appendUsername ? _m('Enter your username.') . ' ' : '') .
702 // TRANS: Form guide.
703 _m('You will be sent to the provider\'s site for authentication.'));
704 $action->hidden('openid_url', $provider);
706 // TRANS: OpenID plugin logon form field label.
707 $action->input('openid_url', _m('OpenID URL'),
709 // TRANS: OpenID plugin logon form field instructions.
710 _m('Your OpenID URL.'));
712 $action->elementEnd('li');
713 $action->elementEnd('ul');
715 $action->elementEnd('fieldset');
719 * Handle a POST user credential check in apioauthauthorization.
720 * If given an OpenID URL, we'll pass us over to the regular things
721 * and then redirect back here on completion.
723 * @fixme merge with common code for main OpenID login form
724 * @param HTMLOutputter $action
726 function onStartOAuthLoginCheck($action, &$user)
728 $provider = common_config('openid', 'trusted_provider');
730 $openid_url = $provider;
731 if (common_config('openid', 'append_username')) {
732 $openid_url .= $action->trimmed('openid_username');
735 $openid_url = $action->trimmed('openid_url');
739 require_once dirname(__FILE__) . '/openid.php';
740 oid_assert_allowed($openid_url);
742 $returnto = common_local_url(
746 'oauth_token' => $action->arg('oauth_token'),
747 'mode' => $action->arg('mode')
750 common_set_returnto($returnto);
752 // This will redirect if functional...
753 $result = oid_authenticate($openid_url,
754 'finishopenidlogin');
755 if (is_string($result)) { # error message
756 throw new ServerException($result);
766 * Add link in user's XRD file to allow OpenID login.
768 * This link in the XRD should let users log in with their
769 * Webfinger identity to services that support it. See
770 * http://webfinger.org/login for an example.
772 * @param XML_XRD $xrd Currently-displaying resource descriptor
773 * @param Profile $target The profile that it's for
775 * @return boolean hook value (always true)
778 function onEndWebFingerProfileLinks(XML_XRD $xrd, Profile $target)
780 $xrd->links[] = new XML_XRD_Element_Link(
781 'http://specs.openid.net/auth/2.0/provider',
782 $target->profileurl);
788 * Add links in the user's profile block to their OpenID URLs.
790 * @param Profile $profile The profile being shown
791 * @param Array &$links Writeable array of arrays (href, text, image).
793 * @return boolean hook value (true)
796 function onOtherAccountProfiles($profile, &$links)
798 $prefs = User_openid_prefs::getKV('user_id', $profile->id);
800 if (empty($prefs) || !$prefs->hide_profile_link) {
802 $oid = new User_openid();
804 $oid->user_id = $profile->id;
807 while ($oid->fetch()) {
808 $links[] = array('href' => $oid->display,
809 'text' => _('OpenID'),
810 'image' => $this->path("icons/openid-16x16.gif"));