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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
|
<?php
/*
* $Horde: horde/lib/Auth/sql.php,v 1.21.2.7 2003/02/18 00:33:02 jan Exp $
*
* Copyright 1999-2003 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.
*/
/**
* The Auth_sql class provides a sql implementation of the Horde
* authentication system.
*
* Required values for $params:
* 'phptype' The database type (ie. 'pgsql', 'mysql, etc.).
* 'hostspec' The hostname of the database server.
* 'protocol' The communication protocol ('tcp', 'unix', etc.).
* 'username' The username with which to connect to the database.
* 'password' The password associated with 'username'.
* 'database' The name of the database.
*
* Optional values:
* 'table' The name of the auth table in 'database'. Defaults to 'horde_users'.
*
* Required by some database implementations:
* 'options' Additional options to pass to the database.
* 'tty' The TTY on which to connect to the database.
* 'port' The port on which to connect to the database.
*
* The table structure for the auth system is as follows:
*
* create table horde_users (
* user_uid varchar(255) not null,
* user_pass varchar(255) not null,
* primary key (user_uid)
* );
*
* @author Chuck Hagenbuch <chuck@horde.org>
* @version $Revision: 1.21.2.7 $
* @since Horde 1.3
* @package horde.auth
*/
class Auth_sql extends Auth {
/** An array of capabilities, so that the driver can report which
operations it supports and which it doesn't.
@var array $capabilities */
var $capabilities = array('add' => true,
'update' => true,
'remove' => true,
'list' => true,
'transparent' => false,
'loginscreen' => false);
/**
* Hash containing connection parameters.
* @var array $_params
*/
var $_params = array();
/**
* Handle for the current database connection.
* @var object DB $_db
*/
var $_db;
/**
* Boolean indicating whether or not we're connected to the SQL server.
* @var boolean $connected
*/
var $_connected = false;
/**
* Constructs a new SQL authentication object.
*
* @param array $params A hash containing connection parameters.
*/
function Auth_sql($params = array())
{
$this->_params = $params;
}
/**
* Attempts to open a persistent connection to the SQL server.
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function _connect()
{
if (!$this->_connected) {
if (!is_array($this->_params)) {
Horde::fatal(new PEAR_Error(_("No configuration information specified for SQL authentication.")), __FILE__, __LINE__);
}
if (!isset($this->_params['phptype'])) {
Horde::fatal(new PEAR_Error(_("Required 'phptype' not specified in authentication configuration.")), __FILE__, __LINE__);
}
if (!isset($this->_params['hostspec'])) {
Horde::fatal(new PEAR_Error(_("Required 'hostspec' not specified in authentication configuration.")), __FILE__, __LINE__);
}
if (!isset($this->_params['username'])) {
Horde::fatal(new PEAR_Error(_("Required 'username' not specified in authentication configuration.")), __FILE__, __LINE__);
}
if (!isset($this->_params['password'])) {
Horde::fatal(new PEAR_Error(_("Required 'password' not specified in authentication configuration.")), __FILE__, __LINE__);
}
if (!isset($this->_params['database'])) {
Horde::fatal(new PEAR_Error(_("Required 'database' not specified in authentication configuration.")), __FILE__, __LINE__);
}
if (!isset($this->_params['table'])) {
$this->_params['table'] = 'horde_users';
}
/* Connect to the SQL server using the supplied parameters. */
include_once 'DB.php';
$this->_db = &DB::connect($this->_params, true);
if (DB::isError($this->_db)) {
Horde::fatal(new PEAR_Error(_("Unable to connect to SQL server.")), __FILE__, __LINE__);
}
/* Enable the "portability" option. */
$this->_db->setOption('optimize', 'portability');
$this->_connected = true;
}
return true;
}
/**
* Disconnect from the SQL server and clean up the connection.
*
* @return boolean true on success, false on failure.
*/
function _disconnect()
{
if ($this->_connected) {
$this->_connected = false;
return $this->_db->disconnect();
}
return true;
}
/**
* Find out if a set of login credentials are valid.
*
* @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 (Auth::checkAuth($userID)) {
return true;
}
/* _connect() will die with Horde::fatal() upon failure. */
$this->_connect();
/* Build the SQL query. */
$query = 'SELECT user_uid FROM ' . $this->_params['table'];
$query .= ' WHERE user_uid = ' . $this->_db->quote($userID);
$query .= ' AND user_pass = ' . $this->_db->quote(md5($credentials['password']));
/* Execute the query. */
$result = $this->_db->query($query);
if (!DB::isError($result)) {
$row = $result->fetchRow(DB_GETMODE_ASSOC);
if (is_array($row)) {
$result->free();
Auth::setAuth($userID, $credentials);
return true;
} else {
$result->free();
return false;
}
} else {
return false;
}
}
/**
* Add a set of authentication credentials.
*
* @param string $userID The userID to add.
* @param array $credentials The credentials to add.
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function addUser($userID, $credentials)
{
/* _connect() will die with Horde::fatal() upon failure. */
$this->_connect();
/* Build the SQL query. */
$query = 'INSERT INTO ' . $this->_params['table'] . ' (user_uid, user_pass) ';
$query .= 'VALUES (' . $this->_db->quote($userID) . ', ' . $this->_db->quote(md5($credentials['password'])) . ')';
/* Execute the query. */
$result = $this->_db->query($query);
if ($result !== DB_OK) {
return (new PEAR_Error(_("Database query failed.")));
}
return true;
}
/**
* 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)
{
/* _connect() will die with Horde::fatal() upon failure. */
$this->_connect();
/* Build the SQL query. */
$query = 'UPDATE ' . $this->_params['table'] . ' SET user_uid = ' . $this->_db->quote($newID) . ', user_pass = ' . $this->_db->quote(md5($credentials['password']));
$query .= 'WHERE user_uid = ' . $this->_db->quote($oldID);
/* Execute the query. */
$result = $this->_db->query($query);
if ($result !== DB_OK) {
return (new PEAR_Error(_("Database query failed.")));
}
return true;
}
/**
* Delete a set of authentication credentials.
*
* @param string $userID The userID to delete.
* @return boolean Success or failure.
*/
function removeUser($userID)
{
/* _connect() will die with Horde::fatal() upon failure. */
$this->_connect();
/* Build the SQL query. */
$query = 'DELETE FROM ' . $this->_params['table'];
$query .= ' WHERE user_uid = ' . $this->_db->quote($userID);
/* Execute the query. */
$result = $this->_db->query($query);
if ($result !== DB_OK) {
return (new PEAR_Error(_("Database query failed.")));
}
return true;
}
/**
* List all users in the system.
*
* @return mixed The array of userIDs, or false on failure/unsupported.
*/
function listUsers()
{
/* _connect() will die with Horde::fatal() upon failure. */
$this->_connect();
/* Build the SQL query. */
$query = 'SELECT user_uid from ' . $this->_params['table'];
/* Execute the query. */
$result = $this->_db->getAll($query, null, DB_FETCHMODE_ORDERED);
/* Loop through and build return value. */
$users = array();
foreach ($result as $ar) {
$users[] = $ar[0];
}
return $users;
}
}
?>
|
