/usr/share/php/Horde/Auth/Cyrsql.php is in php-horde-auth 2.2.2-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 | <?php
/**
* Copyright 2002-2017 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did
* not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @author Ilya Krel <mail@krel.org>
* @author Jan Schneider <jan@horde.org>
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL-2.1
* @package Auth
*/
/**
* The Horde_Auth_Cyrsql class provides a SQL implementation of the Horde
* authentication system for the Cyrus IMAP server. Most of the functionality
* is the same as for the SQL class; only what is different overrides the
* parent class implementations.
*
* The table structure for the auth system is as follows:
* <pre>
* CREATE TABLE accountuser (
* username VARCHAR(255) BINARY NOT NULL DEFAULT '',
* password VARCHAR(32) BINARY NOT NULL DEFAULT '',
* prefix VARCHAR(50) NOT NULL DEFAULT '',
* domain_name VARCHAR(255) NOT NULL DEFAULT '',
* UNIQUE KEY username (username)
* );
*
* CREATE TABLE adminuser (
* username VARCHAR(50) BINARY NOT NULL DEFAULT '',
* password VARCHAR(50) BINARY NOT NULL DEFAULT '',
* type INT(11) NOT NULL DEFAULT '0',
* SID VARCHAR(255) NOT NULL DEFAULT '',
* home VARCHAR(255) NOT NULL DEFAULT '',
* PRIMARY KEY (username)
* );
*
* CREATE TABLE alias (
* alias VARCHAR(255) NOT NULL DEFAULT '',
* dest LONGTEXT,
* username VARCHAR(50) NOT NULL DEFAULT '',
* status INT(11) NOT NULL DEFAULT '1',
* PRIMARY KEY (alias)
* );
*
* CREATE TABLE domain (
* domain_name VARCHAR(255) NOT NULL DEFAULT '',
* prefix VARCHAR(50) NOT NULL DEFAULT '',
* maxaccounts INT(11) NOT NULL DEFAULT '20',
* quota INT(10) NOT NULL DEFAULT '20000',
* transport VARCHAR(255) NOT NULL DEFAULT 'cyrus',
* freenames ENUM('YES','NO') NOT NULL DEFAULT 'NO',
* freeaddress ENUM('YES','NO') NOT NULL DEFAULT 'NO',
* PRIMARY KEY (domain_name),
* UNIQUE KEY prefix (prefix)
* );
*
* CREATE TABLE domainadmin (
* domain_name VARCHAR(255) NOT NULL DEFAULT '',
* adminuser VARCHAR(255) NOT NULL DEFAULT ''
* );
*
* CREATE TABLE search (
* search_id VARCHAR(255) NOT NULL DEFAULT '',
* search_sql TEXT NOT NULL,
* perpage INT(11) NOT NULL DEFAULT '0',
* timestamp TIMESTAMP(14) NOT NULL,
* PRIMARY KEY (search_id),
* KEY search_id (search_id)
* );
*
* CREATE TABLE virtual (
* alias VARCHAR(255) NOT NULL DEFAULT '',
* dest LONGTEXT,
* username VARCHAR(50) NOT NULL DEFAULT '',
* status INT(11) NOT NULL DEFAULT '1',
* KEY alias (alias)
* );
*
* CREATE TABLE log (
* id INT(11) NOT NULL AUTO_INCREMENT,
* msg TEXT NOT NULL,
* user VARCHAR(255) NOT NULL DEFAULT '',
* host VARCHAR(255) NOT NULL DEFAULT '',
* time DATETIME NOT NULL DEFAULT '2000-00-00 00:00:00',
* pid VARCHAR(255) NOT NULL DEFAULT '',
* PRIMARY KEY (id)
* );
* </pre>
*
* @author Ilya Krel <mail@krel.org>
* @author Jan Schneider <jan@horde.org>
* @category Horde
* @copyright 2002-2017 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL-2.1
* @package Auth
*/
class Horde_Auth_Cyrsql extends Horde_Auth_Sql
{
/**
* An array of capabilities, so that the driver can report which
* operations it supports and which it doesn't.
*
* @var array
*/
protected $_capabilities = array(
'add' => true,
'list' => true,
'remove' => true,
'resetpassword' => false,
'update' => true,
'authenticate' => true,
);
/**
* Horde_Imap_Client object.
*
* @var Horde_Imap_Client_Base
*/
protected $_imap;
/**
* Constructor.
*
* @param array $params Parameters:
* - domain_field: (string) If set to anything other than 'none' this is
* used as field name where domain is stored.
* DEFAULT: 'domain_name'
* - folders: (array) An array of folders to create under username.
* DEFAULT: NONE
* - hidden_accounts: (array) An array of system accounts to hide from
* the user interface.
* DEFAULT: None.
* - imap: (Horde_Imap_Client_Base) [REQUIRED] An IMAP client object.
* - quota: (integer) The quota (in kilobytes) to grant on the mailbox.
* DEFAULT: NONE
* - userhierarchy: (string) The user hierarchy prefix (UTF-8).
* DEFAULT: 'user.'
*
* @throws InvalidArgumentException
*/
public function __construct(array $params = array())
{
if (!isset($params['imap']) ||
!($params['imap'] instanceof Horde_Imap_Client_Base)) {
throw new InvalidArgumentException('Missing imap parameter.');
}
$this->_imap = $params['imap'];
unset($params['imap']);
$params = array_merge(array(
'domain_field' => 'domain_name',
'folders' => array(),
'hidden_accounts' => array('cyrus'),
'quota' => null,
'userhierarchy' => 'user.'
), $params);
parent::__construct($params);
}
/**
* Find out if a set of login credentials are valid.
*
* @param string $userId The userId to check.
* @param array $credentials The credentials to use.
*
* @throws Horde_Auth_Exception
*/
protected function _authenticate($userId, $credentials)
{
if (!empty($this->_params['domain_field']) &&
($this->_params['domain_field'] != 'none')) {
/* Build the SQL query with domain. */
$query = sprintf('SELECT * FROM %s WHERE %s = ? AND %s = ?',
$this->_params['table'],
$this->_params['username_field'],
$this->_params['domain_field']);
$values = explode('@', $userId);
} else {
/* Build the SQL query without domain. */
$query = sprintf('SELECT * FROM %s WHERE %s = ?',
$this->_params['table'],
$this->_params['username_field']);
$values = array($userId);
}
try {
$row = $this->_db->selectOne($query, $values);
} catch (Horde_Db_Exception $e) {
throw new Horde_Auth_Exception('', Horde_Auth::REASON_FAILED);
}
if (!$row ||
!$this->_comparePasswords($row[$this->_params['password_field']], $credentials['password'])) {
throw new Horde_Auth_Exception('', Horde_Auth::REASON_BADLOGIN);
}
$now = time();
if (!empty($this->_params['hard_expiration_field']) &&
!empty($row[$this->_params['hard_expiration_field']]) &&
($now > $row[$this->_params['hard_expiration_field']])) {
throw new Horde_Auth_Exception('', Horde_Auth::REASON_EXPIRED);
}
if (!empty($this->_params['soft_expiration_field']) &&
!empty($row[$this->_params['soft_expiration_field']]) &&
($now > $row[$this->_params['soft_expiration_field']])) {
$this->setCredential('change', true);
}
}
/**
* Add a set of authentication credentials.
*
* @param string $userId The userId to add.
* @param array $credentials The credentials to add.
*
* @throw Horde_Auth_Exception
*/
public function addUser($userId, $credentials)
{
if (!empty($this->_params['domain_field']) &&
($this->_params['domain_field'] != 'none')) {
list($name, $domain) = explode('@', $userId);
$query = sprintf('INSERT INTO %s (%s, %s, %s) VALUES (?, ?, ?)',
$this->_params['table'],
$this->_params['username_field'],
$this->_params['domain_field'],
$this->_params['password_field']);
$values = array(
$name,
$domain,
Horde_Auth::getCryptedPassword($credentials['password'],
'',
$this->_params['encryption'],
$this->_params['show_encryption'])
);
$query2 = 'INSERT INTO virtual (alias, dest, username, status) VALUES (?, ?, ?, 1)';
$values2 = array($userId, $userId, $name);
try {
$this->_db->insert($query, $values);
$this->_db->insert($query2, $values2);
} catch (Horde_Db_Exception $e) {
throw new Horde_Auth_Exception($e);
}
} else {
parent::addUser($userId, $credentials);
}
$mailbox = $this->_params['userhierarchy'] . $userId;
try {
$this->_imap->createMailbox($mailbox);
$this->_imap->setACL($mailbox, $this->_params['cyradmin'], array('rights' => 'lrswipcda'));
if (isset($this->_params['quota']) &&
($this->_params['quota'] >= 0)) {
$this->_imap->setQuota($mailbox, array('storage' => $this->_params['quota']));
}
} catch (Horde_Imap_Client_Exception $e) {
throw new Horde_Auth_Exception($e);
}
foreach ($this->_params['folders'] as $val) {
try {
$this->_imap->createMailbox($val);
$this->_imap->setACL($val, $this->_params['cyradmin'], array('rights' => 'lrswipcda'));
} catch (Horde_Imap_Client_Exception $e) {}
}
}
/**
* Delete a set of authentication credentials.
*
* @param string $userId The userId to delete.
*
* @throws Horde_Auth_Exception
*/
public function removeUser($userId)
{
if (!empty($this->_params['domain_field']) &&
($this->_params['domain_field'] != 'none')) {
list($name, $domain) = explode('@', $userId);
/* Build the SQL query. */
$query = sprintf('DELETE FROM %s WHERE %s = ? and %s = ?',
$this->_params['table'],
$this->_params['username_field'],
$this->_params['domain_field']);
$values = array($name, $domain);
$query2 = 'DELETE FROM virtual WHERE dest = ?';
$values2 = array($userId);
try {
$this->_db->delete($query, $values);
$this->_db->delete($query2, $values2);
} catch (Horde_Db_Exception $e) {
throw new Horde_Auth_Exception($e);
}
} else {
parent::removeUser($userId);
}
/* Set ACL for mailbox deletion. */
list($admin) = explode('@', $this->_params['cyradmin']);
$mailbox = $this->_params['userhierarchy'] . $userId;
try {
$this->_imap->setACL($mailbox, $admin, array('rights' => 'lrswipcda'));
$this->_imap->deleteMailbox($mailbox);
} catch (Horde_Imap_Client_Exception $e) {
throw new Horde_Auth_Exception($e);
}
}
/**
* List all users in the system.
*
* @param boolean $sort Sort the users?
*
* @return mixed The array of userIds.
* @throws Horde_Auth_Exception
*/
public function listUsers($sort = false)
{
if (!empty($this->_params['domain_field']) &&
($this->_params['domain_field'] != 'none')) {
/* Build the SQL query with domain. */
$query = sprintf('SELECT %s, %s FROM %s',
$this->_params['username_field'],
$this->_params['domain_field'],
$this->_params['table']);
} else {
/* Build the SQL query without domain. */
$query = sprintf('SELECT %s FROM %s',
$this->_params['username_field'],
$this->_params['table']);
}
if ($sort) {
$query .= sprintf(" ORDER BY %s", $this->_params['username_field']);
}
try {
$result = $this->_db->select($query);
} catch (Horde_Db_Exception $e) {
throw new Horde_Auth_Exception($e);
}
/* Loop through and build return array. */
$users = array();
if (!empty($this->_params['domain_field']) &&
($this->_params['domain_field'] != 'none')) {
foreach ($result as $ar) {
if (!in_array($ar[$this->_params['username_field']], $this->_params['hidden_accounts'])) {
$users[] = $ar[$this->_params['username_field']] . '@' . $ar[$this->_params['domain_field']];
}
}
} else {
foreach ($result as $ar) {
if (!in_array($ar[$this->_params['username_field']], $this->_params['hidden_accounts'])) {
$users[] = $ar[$this->_params['username_field']];
}
}
}
return $users;
}
/**
* Update a set of authentication credentials.
*
* @param string $oldID The old userId.
* @param string $newID The new userId. [NOT SUPPORTED]
* @param array $credentials The new credentials
*
* @throws Horde_Auth_Exception
*/
public function updateUser($oldID, $newID, $credentials)
{
if (!empty($this->_params['domain_field']) &&
($this->_params['domain_field'] != 'none')) {
list($name, $domain) = explode('@', $oldID);
/* Build the SQL query with domain. */
$query = sprintf(
'UPDATE %s SET %s = ? WHERE %s = ? and %s = ?',
$this->_params['table'],
$this->_params['password_field'],
$this->_params['username_field'],
$this->_params['domain_field']
);
$values = array(
Horde_Auth::getCryptedPassword($credentials['password'], '', $this->_params['encryption'], $this->_params['show_encryption']),
$name,
$domain
);
} else {
/* Build the SQL query. */
$query = sprintf(
'UPDATE %s SET %s = ? WHERE %s = ?',
$this->_params['table'],
$this->_params['password_field'],
$this->_params['username_field']
);
$values = array(
Horde_Auth::getCryptedPassword($credentials['password'], '', $this->_params['encryption'], $this->_params['show_encryption']),
$oldID
);
}
try {
$this->_db->update($query, $values);
} catch (Horde_Db_Exception $e) {
throw new Horde_Auth_Exception($e);
}
}
}
|