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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
<?php
/**
* The Auth_application class provides a wrapper around
* application-provided Horde authentication which fits inside the
* Horde Auth:: API.
*
* Required parameters:<pre>
* 'app' The application which is providing authentication.</pre>
*
*
* $Horde: framework/Auth/Auth/application.php,v 1.27.10.12 2006/08/14 02:48:48 chuck Exp $
*
* Copyright 2002-2006 Chuck Hagenbuch <chuck@horde.org>
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.
*
* @author Chuck Hagenbuch <chuck@horde.org>
* @since Horde 3.0
* @package Horde_Auth
*/
class Auth_application extends Auth {
/**
* An array of capabilities, so that the driver can report which
* operations it supports and which it doesn't.
*
* @var array
*/
var $capabilities = array('add' => false,
'update' => false,
'resetpassword' => false,
'remove' => false,
'list' => false,
'transparent' => false);
/**
* Constructs a new Application authentication object.
*
* @param array $params A hash containing connection parameters.
*/
function Auth_application($params = array())
{
$this->_setParams($params);
}
/**
* Queries the current Auth object to find out if it supports the given
* capability.
*
* @param string $capability The capability to test for.
*
* @return boolean Whether or not the capability is supported.
*/
function hasCapability($capability)
{
static $loaded = array();
$methods = array('list' => 'userList',
'add' => 'addUser',
'update' => 'updateUser',
'remove' => 'removeUser');
if (empty($loaded[$capability]) && isset($methods[$capability])) {
$this->capabilities[$capability] = $GLOBALS['registry']->hasMethod($methods[$capability], $this->_params['app']);
$loaded[$capability] = true;
}
return !empty($this->capabilities[$capability]);
}
/**
* Set connection parameters.
*
* @access private
*
* @param array $params A hash containing connection parameters.
*/
function _setParams($params)
{
Horde::assertDriverConfig($params, 'auth',
array('app'),
'authentication application');
if (empty($GLOBALS['registry']->applications[$params['app']])) {
Horde::fatal($params['app'] . ' is not configured in the Horde Registry.', __FILE__, __LINE__);
}
$this->_params = $params;
}
/**
* Find out if a set of login credentials are valid.
*
* @access private
*
* @param string $userId The userId to check.
* @param array $credentials The credentials to use.
*
* @return boolean Whether or not the credentials are valid.
*/
function _authenticate($userId, $credentials)
{
if (!$GLOBALS['registry']->hasMethod('authenticate', $this->_params['app'])) {
Horde::fatal($this->_params['app'] . ' does not provide an authenticate() method.', __FILE__, __LINE__);
}
return $GLOBALS['registry']->callByPackage($this->_params['app'], 'authenticate',
array('userId' => $userId,
'credentials' => $credentials,
'params' => $this->_params));
}
/**
* Return the URI of the login screen for this authentication method.
*
* @access private
*
* @param string $app The application to use.
* @param string $url The URL to redirect to after login.
*
* @return string The login screen URI.
*/
function _getLoginScreen($app = 'horde', $url = '')
{
return parent::_getLoginScreen($this->_params['app'], $url);
}
/**
* List all users in the system.
*
* @return mixed The array of userIds, or a PEAR_Error object on failure.
*/
function listUsers()
{
if ($this->hasCapability('list')) {
return $GLOBALS['registry']->callByPackage($this->_params['app'], 'userList');
} else {
return PEAR::raiseError('unsupported');
}
}
/**
* Add a set of authentication credentials.
*
* @param string $userId The userId to add.
* @param array $credentials The credentials to use.
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function addUser($userId, $credentials)
{
if ($this->hasCapability('add')) {
return $GLOBALS['registry']->callByPackage($this->_params['app'], 'addUser', array($userId, $credentials));
} else {
return PEAR::raiseError('unsupported');
}
}
/**
* Update a set of authentication credentials.
*
* @param string $oldID The old userId.
* @param string $newID The new userId.
* @param array $credentials The new credentials
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function updateUser($oldID, $newID, $credentials)
{
if ($this->hasCapability('update')) {
return $GLOBALS['registry']->callByPackage($this->_params['app'], 'updateUser', array($oldID, $newID, $credentials));
} else {
return PEAR::raiseError('unsupported');
}
}
/**
* Delete a set of authentication credentials.
*
* @param string $userId The userId to delete.
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function removeUser($userId)
{
if ($this->hasCapability('remove')) {
$result = $GLOBALS['registry']->callByPackage($this->_params['app'], 'removeUser', array($userId));
} else {
return PEAR::raiseError('unsupported');
}
if (is_a($result, 'PEAR_Error')) {
return $result;
}
return $this->removeUserData($userId);
}
}
|
