]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/OpenID/OpenIDPlugin.php
New domain regexp for WebFinger matching.
[quix0rs-gnu-social.git] / plugins / OpenID / OpenIDPlugin.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * PHP version 5
6  *
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.
11  *
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.
16  *
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/>.
19  *
20  * @category  Plugin
21  * @package   StatusNet
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/
28  */
29
30 if (!defined('STATUSNET')) {
31     exit(1);
32 }
33
34 /**
35  * Plugin for OpenID authentication and identity
36  *
37  * This class enables consumer support for OpenID, the distributed authentication
38  * and identity system.
39  *
40  * Depends on: WebFinger plugin for HostMeta-lookup (user@host format)
41  *
42  * @category Plugin
43  * @package  StatusNet
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/
50  */
51 class OpenIDPlugin extends Plugin
52 {
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;
56
57     function initialize()
58     {
59         parent::initialize();
60         if ($this->openidOnly !== null) {
61             global $config;
62             $config['site']['openidonly'] = (bool)$this->openidOnly;
63         }
64     }
65
66     /**
67      * Add OpenID-related paths to the router table
68      *
69      * Hook for RouterInitialized event.
70      *
71      * @param URLMapper $m URL mapper
72      *
73      * @return boolean hook return
74      */
75     public function onStartInitializeRouter(URLMapper $m)
76     {
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'));
86
87         return true;
88     }
89
90     /**
91      * In OpenID-only mode, disable paths for password stuff
92      *
93      * @param string $path     path to connect
94      * @param array  $defaults path defaults
95      * @param array  $rules    path rules
96      * @param array  $result   unused
97      *
98      * @return boolean hook return
99      */
100     function onStartConnectPath(&$path, &$defaults, &$rules, &$result)
101     {
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.
107             //
108             // We take those two over with redirects to ourselves
109             // over in onArgsInitialize().
110             static $block = array('main/recoverpassword',
111                                   'settings/password');
112
113             if (in_array($path, $block)) {
114                 return false;
115             }
116         }
117
118         return true;
119     }
120
121     /**
122      * If we've been hit with password-login args, redirect
123      *
124      * @param array $args args (URL, Get, post)
125      *
126      * @return boolean hook return
127      */
128     function onArgsInitialize($args)
129     {
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.'));
140                 }
141             }
142         }
143         return true;
144     }
145
146     /**
147      * Public XRDS output hook
148      *
149      * Puts the bits of code needed by some OpenID providers to show
150      * we're good citizens.
151      *
152      * @param Action       $action         Action being executed
153      * @param XMLOutputter &$xrdsOutputter Output channel
154      *
155      * @return boolean hook return
156      */
157     function onEndPublicXRDS(Action $action, &$xrdsOutputter)
158     {
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');
163         //consumer
164         foreach (array('finishopenidlogin', 'finishaddopenid') as $finish) {
165             $xrdsOutputter->showXrdsService(Auth_OpenID_RP_RETURN_TO_URL_TYPE,
166                                             common_local_url($finish));
167         }
168         //provider
169         $xrdsOutputter->showXrdsService('http://specs.openid.net/auth/2.0/server',
170                                         common_local_url('openidserver'),
171                                         null,
172                                         null,
173                                         'http://specs.openid.net/auth/2.0/identifier_select');
174         $xrdsOutputter->elementEnd('XRD');
175     }
176
177     /**
178      * If we're in OpenID-only mode, hide all the main menu except OpenID login.
179      *
180      * @param Action $action Action being run
181      *
182      * @return boolean hook return
183      */
184     function onStartPrimaryNav($action)
185     {
186         if (common_config('site', 'openidonly') && !common_logged_in()) {
187             // TRANS: Tooltip for main menu option "Login"
188             $tooltip = _m('TOOLTIP', 'Login to the site.');
189             $action->menuItem(common_local_url('openidlogin'),
190                               // TRANS: Main menu option when not logged in to log in
191                               _m('MENU', 'Login'),
192                               $tooltip,
193                               false,
194                               'nav_login');
195             // TRANS: Tooltip for main menu option "Help"
196             $tooltip = _m('TOOLTIP', 'Help me!');
197             $action->menuItem(common_local_url('doc', array('title' => 'help')),
198                               // TRANS: Main menu option for help on the StatusNet site
199                               _m('MENU', 'Help'),
200                               $tooltip,
201                               false,
202                               'nav_help');
203             if (!common_config('site', 'private')) {
204                 // TRANS: Tooltip for main menu option "Search"
205                 $tooltip = _m('TOOLTIP', 'Search for people or text.');
206                 $action->menuItem(common_local_url('peoplesearch'),
207                                   // TRANS: Main menu option when logged in or when the StatusNet instance is not private
208                                   _m('MENU', 'Search'), $tooltip, false, 'nav_search');
209             }
210             Event::handle('EndPrimaryNav', array($action));
211             return false;
212         }
213         return true;
214     }
215
216     /**
217      * Menu for login
218      *
219      * If we're in openidOnly mode, we disable the menu for all other login.
220      *
221      * @param Action $action Action being executed
222      *
223      * @return boolean hook return
224      */
225     function onStartLoginGroupNav($action)
226     {
227         if (common_config('site', 'openidonly')) {
228             $this->showOpenIDLoginTab($action);
229             // Even though we replace this code, we
230             // DON'T run the End* hook, to keep others from
231             // adding tabs. Not nice, but.
232             return false;
233         }
234
235         return true;
236     }
237
238     /**
239      * Menu item for login
240      *
241      * @param Action $action Action being executed
242      *
243      * @return boolean hook return
244      */
245     function onEndLoginGroupNav($action)
246     {
247         $this->showOpenIDLoginTab($action);
248
249         return true;
250     }
251
252     /**
253      * Show menu item for login
254      *
255      * @param Action $action Action being executed
256      *
257      * @return void
258      */
259     function showOpenIDLoginTab($action)
260     {
261         $action_name = $action->trimmed('action');
262
263         $action->menuItem(common_local_url('openidlogin'),
264                           // TRANS: OpenID plugin menu item on site logon page.
265                           _m('MENU', 'OpenID'),
266                           // TRANS: OpenID plugin tooltip for logon menu item.
267                           _m('Login or register with OpenID.'),
268                           $action_name === 'openidlogin');
269     }
270
271     /**
272      * Show menu item for password
273      *
274      * We hide it in openID-only mode
275      *
276      * @param Action $menu    Widget for menu
277      * @param void   &$unused Unused value
278      *
279      * @return void
280      */
281     function onStartAccountSettingsPasswordMenuItem($menu, &$unused) {
282         if (common_config('site', 'openidonly')) {
283             return false;
284         }
285         return true;
286     }
287
288     /**
289      * Menu item for OpenID settings
290      *
291      * @param Action $action Action being executed
292      *
293      * @return boolean hook return
294      */
295     function onEndAccountSettingsNav($action)
296     {
297         $action_name = $action->trimmed('action');
298
299         $action->menuItem(common_local_url('openidsettings'),
300                           // TRANS: OpenID plugin menu item on user settings page.
301                           _m('MENU', 'OpenID'),
302                           // TRANS: OpenID plugin tooltip for user settings menu item.
303                           _m('Add or remove OpenIDs.'),
304                           $action_name === 'openidsettings');
305
306         return true;
307     }
308
309     /**
310      * Autoloader
311      *
312      * Loads our classes if they're requested.
313      *
314      * @param string $cls Class requested
315      *
316      * @return boolean hook return
317      */
318     function onAutoload($cls)
319     {
320         switch ($cls)
321         {
322         case 'Auth_OpenID_TeamsExtension':
323         case 'Auth_OpenID_TeamsRequest':
324         case 'Auth_OpenID_TeamsResponse':
325             require_once dirname(__FILE__) . '/extlib/teams-extension.php';
326             return false;
327         }
328
329         return parent::onAutoload($cls);
330     }
331
332     /**
333      * Login actions
334      *
335      * These actions should be visible even when the site is marked private
336      *
337      * @param Action  $action Action to show
338      * @param boolean &$login Whether it's a login action
339      *
340      * @return boolean hook return
341      */
342     function onLoginAction($action, &$login)
343     {
344         switch ($action)
345         {
346         case 'openidlogin':
347         case 'finishopenidlogin':
348         case 'openidserver':
349             $login = true;
350             return false;
351         default:
352             return true;
353         }
354     }
355
356     /**
357      * We include a <meta> element linking to the webfinger resource page,
358      * for OpenID client-side authentication.
359      *
360      * @param Action $action Action being shown
361      *
362      * @return void
363      */
364     function onEndShowHeadElements(Action $action)
365     {
366         if ($action instanceof ShowstreamAction) {
367             $action->element('link', array('rel' => 'openid2.provider',
368                                            'href' => common_local_url('openidserver')));
369             $action->element('link', array('rel' => 'openid2.local_id',
370                                            'href' => $action->getTarget()->getUrl()));
371             $action->element('link', array('rel' => 'openid.server',
372                                            'href' => common_local_url('openidserver')));
373             $action->element('link', array('rel' => 'openid.delegate',
374                                            'href' => $action->getTarget()->getUrl()));
375         }
376
377         if ($action instanceof SitestreamAction) {
378             $action->element('meta', array('http-equiv' => 'X-XRDS-Location',
379                                          'content' => common_local_url('publicxrds')));
380         }
381         return true;
382     }
383
384     /**
385      * Redirect to OpenID login if they have an OpenID
386      *
387      * @param Action $action Action being executed
388      * @param User   $user   User doing the action
389      *
390      * @return boolean whether to continue
391      */
392     function onRedirectToLogin($action, $user)
393     {
394         if (common_config('site', 'openidonly') || (!empty($user) && User_openid::hasOpenID($user->id))) {
395             common_redirect(common_local_url('openidlogin'), 303);
396         }
397         return true;
398     }
399
400     /**
401      * Show some extra instructions for using OpenID
402      *
403      * @param Action $action Action being executed
404      *
405      * @return boolean hook value
406      */
407     function onEndShowPageNotice($action)
408     {
409         $name = $action->trimmed('action');
410
411         switch ($name)
412         {
413         case 'register':
414             if (common_logged_in()) {
415                 // TRANS: Page notice for logged in users to try and get them to add an OpenID account to their StatusNet account.
416                 // TRANS: This message contains Markdown links in the form (description)[link].
417                 $instr = _m('(Have an [OpenID](http://openid.net/)? ' .
418                   '[Add an OpenID to your account](%%action.openidsettings%%)!');
419             } else {
420                 // TRANS: Page notice for anonymous users to try and get them to register with an OpenID account.
421                 // TRANS: This message contains Markdown links in the form (description)[link].
422                 $instr = _m('(Have an [OpenID](http://openid.net/)? ' .
423                   'Try our [OpenID registration]'.
424                   '(%%action.openidlogin%%)!)');
425             }
426             break;
427         case 'login':
428             // TRANS: Page notice on the login page to try and get them to log on with an OpenID account.
429             // TRANS: This message contains Markdown links in the form (description)[link].
430             $instr = _m('(Have an [OpenID](http://openid.net/)? ' .
431               'Try our [OpenID login]'.
432               '(%%action.openidlogin%%)!)');
433             break;
434         default:
435             return true;
436         }
437
438         $output = common_markup_to_html($instr);
439         $action->raw($output);
440         return true;
441     }
442
443     /**
444      * Load our document if requested
445      *
446      * @param string &$title  Title to fetch
447      * @param string &$output HTML to output
448      *
449      * @return boolean hook value
450      */
451     function onStartLoadDoc(&$title, &$output)
452     {
453         if ($title == 'openid') {
454             $filename = INSTALLDIR.'/plugins/OpenID/doc-src/openid';
455
456             $c      = file_get_contents($filename);
457             $output = common_markup_to_html($c);
458             return false; // success!
459         }
460
461         return true;
462     }
463
464     /**
465      * Add our document to the global menu
466      *
467      * @param string $title   Title being fetched
468      * @param string &$output HTML being output
469      *
470      * @return boolean hook value
471      */
472     function onEndDocsMenu(&$items) {
473         $items[] = array('doc', 
474                          array('title' => 'openid'),
475                          _m('MENU', 'OpenID'),
476                          _('Logging in with OpenID'),
477                          'nav_doc_openid');
478         return true;
479     }
480
481     /**
482      * Data definitions
483      *
484      * Assure that our data objects are available in the DB
485      *
486      * @return boolean hook value
487      */
488     function onCheckSchema()
489     {
490         $schema = Schema::get();
491         $schema->ensureTable('user_openid', User_openid::schemaDef());
492         $schema->ensureTable('user_openid_trustroot', User_openid_trustroot::schemaDef());
493         $schema->ensureTable('user_openid_prefs', User_openid_prefs::schemaDef());
494
495         /* These are used by JanRain OpenID library */
496
497         $schema->ensureTable('oid_associations',
498                              array(
499                                  'fields' => array(
500                                      'server_url' => array('type' => 'blob', 'not null' => true),
501                                      'handle' => array('type' => 'varchar', 'length' => 191, 'not null' => true, 'default' => ''), // character set latin1,
502                                      'secret' => array('type' => 'blob'),
503                                      'issued' => array('type' => 'int'),
504                                      'lifetime' => array('type' => 'int'),
505                                      'assoc_type' => array('type' => 'varchar', 'length' => 64),
506                                  ),
507                                  'primary key' => array(array('server_url', 191), 'handle'),
508                              ));
509         $schema->ensureTable('oid_nonces',
510                              array(
511                                  'fields' => array(
512                                      'server_url' => array('type' => 'varchar', 'length' => 2047),
513                                      'timestamp' => array('type' => 'int'),
514                                      'salt' => array('type' => 'char', 'length' => 40),
515                                  ),
516                                  'unique keys' => array(
517                                      'oid_nonces_server_url_timestamp_salt_key' => array(array('server_url', 191), 'timestamp', 'salt'),
518                                  ),
519                              ));
520
521         return true;
522     }
523
524     /**
525      * Add our tables to be deleted when a user is deleted
526      *
527      * @param User  $user    User being deleted
528      * @param array &$tables Array of table names
529      *
530      * @return boolean hook value
531      */
532     function onUserDeleteRelated($user, &$tables)
533     {
534         $tables[] = 'User_openid';
535         $tables[] = 'User_openid_trustroot';
536         return true;
537     }
538
539     /**
540      * Add an OpenID tab to the admin panel
541      *
542      * @param Widget $nav Admin panel nav
543      *
544      * @return boolean hook value
545      */
546     function onEndAdminPanelNav($nav)
547     {
548         if (AdminPanelAction::canAdmin('openid')) {
549
550             $action_name = $nav->action->trimmed('action');
551
552             $nav->out->menuItem(
553                 common_local_url('openidadminpanel'),
554                 // TRANS: OpenID configuration menu item.
555                 _m('MENU','OpenID'),
556                 // TRANS: Tooltip for OpenID configuration menu item.
557                 _m('OpenID configuration.'),
558                 $action_name == 'openidadminpanel',
559                 'nav_openid_admin_panel'
560             );
561         }
562
563         return true;
564     }
565
566     /**
567      * Add OpenID information to the Account Management Control Document
568      * Event supplied by the Account Manager plugin
569      *
570      * @param array &$amcd Array that expresses the AMCD
571      *
572      * @return boolean hook value
573      */
574
575     function onEndAccountManagementControlDocument(&$amcd)
576     {
577         $amcd['auth-methods']['openid'] = array(
578             'connect' => array(
579                 'method' => 'POST',
580                 'path' => common_local_url('openidlogin'),
581                 'params' => array(
582                     'identity' => 'openid_url'
583                 )
584             )
585         );
586     }
587
588     /**
589      * Add our version information to output
590      *
591      * @param array &$versions Array of version-data arrays
592      *
593      * @return boolean hook value
594      */
595     function onPluginVersion(array &$versions)
596     {
597         $versions[] = array('name' => 'OpenID',
598                             'version' => GNUSOCIAL_VERSION,
599                             'author' => 'Evan Prodromou, Craig Andrews',
600                             'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/OpenID',
601                             'rawdescription' =>
602                             // TRANS: Plugin description.
603                             _m('Use <a href="http://openid.net/">OpenID</a> to login to the site.'));
604         return true;
605     }
606
607     function onStartOAuthLoginForm($action, &$button)
608     {
609         if (common_config('site', 'openidonly')) {
610             // Cancel the regular password login form, we won't need it.
611             $this->showOAuthLoginForm($action);
612             // TRANS: button label for OAuth authorization page when needing OpenID authentication first.
613             $button = _m('BUTTON', 'Continue');
614             return false;
615         } else {
616             // Leave the regular password login form in place.
617             // We'll add an OpenID link at bottom...?
618             return true;
619         }
620     }
621
622     /**
623      * @fixme merge with common code for main OpenID login form
624      * @param HTMLOutputter $action
625      */
626     protected function showOAuthLoginForm($action)
627     {
628         $action->elementStart('fieldset');
629         // TRANS: OpenID plugin logon form legend.
630         $action->element('legend', null, _m('LEGEND','OpenID login'));
631
632         $action->elementStart('ul', 'form_data');
633         $action->elementStart('li');
634         $provider = common_config('openid', 'trusted_provider');
635         $appendUsername = common_config('openid', 'append_username');
636         if ($provider) {
637             // TRANS: Field label.
638             $action->element('label', array(), _m('OpenID provider'));
639             $action->element('span', array(), $provider);
640             if ($appendUsername) {
641                 $action->element('input', array('id' => 'openid_username',
642                                               'name' => 'openid_username',
643                                               'style' => 'float: none'));
644             }
645             $action->element('p', 'form_guide',
646                            // TRANS: Form guide.
647                            ($appendUsername ? _m('Enter your username.') . ' ' : '') .
648                            // TRANS: Form guide.
649                            _m('You will be sent to the provider\'s site for authentication.'));
650             $action->hidden('openid_url', $provider);
651         } else {
652             // TRANS: OpenID plugin logon form field label.
653             $action->input('openid_url', _m('OpenID URL'),
654                          '',
655                         // TRANS: OpenID plugin logon form field instructions.
656                          _m('Your OpenID URL.'));
657         }
658         $action->elementEnd('li');
659         $action->elementEnd('ul');
660
661         $action->elementEnd('fieldset');
662     }
663
664     /**
665      * Handle a POST user credential check in apioauthauthorization.
666      * If given an OpenID URL, we'll pass us over to the regular things
667      * and then redirect back here on completion.
668      *
669      * @fixme merge with common code for main OpenID login form
670      * @param HTMLOutputter $action
671      */
672     function onStartOAuthLoginCheck($action, &$user)
673     {
674         $provider = common_config('openid', 'trusted_provider');
675         if ($provider) {
676             $openid_url = $provider;
677             if (common_config('openid', 'append_username')) {
678                 $openid_url .= $action->trimmed('openid_username');
679             }
680         } else {
681             $openid_url = $action->trimmed('openid_url');
682         }
683
684         if ($openid_url) {
685             require_once dirname(__FILE__) . '/openid.php';
686             oid_assert_allowed($openid_url);
687
688             $returnto = common_local_url(
689                 'ApiOAuthAuthorize',
690                 array(),
691                 array(
692                     'oauth_token' => $action->arg('oauth_token'),
693                     'mode'        => $action->arg('mode')
694                 )
695             );
696             common_set_returnto($returnto);
697
698             // This will redirect if functional...
699             $result = oid_authenticate($openid_url,
700                                        'finishopenidlogin');
701             if (is_string($result)) { # error message
702                 throw new ServerException($result);
703             } else {
704                 exit(0);
705             }
706         }
707
708         return true;
709     }
710
711     /**
712      * Add link in user's XRD file to allow OpenID login.
713      *
714      * This link in the XRD should let users log in with their
715      * Webfinger identity to services that support it. See
716      * http://webfinger.org/login for an example.
717      *
718      * @param XML_XRD   $xrd    Currently-displaying resource descriptor
719      * @param Profile   $target The profile that it's for
720      *
721      * @return boolean hook value (always true)
722      */
723
724     function onEndWebFingerProfileLinks(XML_XRD $xrd, Profile $target)
725     {
726         $xrd->links[] = new XML_XRD_Element_Link(
727                             'http://specs.openid.net/auth/2.0/provider',
728                             $target->profileurl);
729
730         return true;
731     }
732
733     /**
734      * Add links in the user's profile block to their OpenID URLs.
735      *
736      * @param Profile $profile The profile being shown
737      * @param Array   &$links  Writeable array of arrays (href, text, image).
738      *
739      * @return boolean hook value (true)
740      */
741     
742     function onOtherAccountProfiles($profile, &$links)
743     {
744         $prefs = User_openid_prefs::getKV('user_id', $profile->id);
745
746         if (empty($prefs) || !$prefs->hide_profile_link) {
747
748             $oid = new User_openid();
749
750             $oid->user_id = $profile->id;
751
752             if ($oid->find()) {
753                 while ($oid->fetch()) {
754                     $links[] = array('href' => $oid->display,
755                                      'text' => _('OpenID'),
756                                      'image' => $this->path("icons/openid-16x16.gif"));
757                 }
758             }
759         }
760
761         return true;
762     }
763 }