1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Superclass for plugins that do authorization
*
* PHP version 5
*
* LICENCE: This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category Plugin
* @package StatusNet
* @author Craig Andrews <candrews@integralblue.com>
* @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
if (!defined('STATUSNET') && !defined('LACONICA')) {
exit(1);
}
/**
* Superclass for plugins that do authorization
*
* @category Plugin
* @package StatusNet
* @author Craig Andrews <candrews@integralblue.com>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
abstract class AuthorizationPlugin extends Plugin
{
//is this plugin authoritative for authorization?
public $authoritative = false;
//------------Auth plugin should implement some (or all) of these methods------------\\
/**
* Is a user allowed to log in?
* @param user
* @return boolean true if the user is allowed to login, false if explicitly not allowed to login, null if we don't explicitly allow or deny login
*/
function loginAllowed($user) {
return null;
}
/**
* Does a profile grant the user a named role?
* @param profile
* @return boolean true if the profile has the role, false if not
*/
function hasRole($profile, $name) {
return false;
}
//------------Below are the methods that connect StatusNet to the implementing Auth plugin------------\\
function onStartSetUser($user) {
$loginAllowed = $this->loginAllowed($user);
if($loginAllowed === true){
return;
}else if($loginAllowed === false){
$user = null;
return false;
}else{
if($this->authoritative) {
$user = null;
return false;
}else{
return;
}
}
}
function onStartSetApiUser($user) {
return $this->onStartSetUser($user);
}
function onStartHasRole($profile, $name, &$has_role) {
if($this->hasRole($profile, $name)){
$has_role = true;
return false;
}else{
if($this->authoritative) {
$has_role = false;
return false;
}else{
return;
}
}
}
}
|
