/usr/share/cacti/site/lib/ldap.php is in cacti 0.8.7i-2ubuntu1.
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 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 | <?php
/*
+-------------------------------------------------------------------------+
| Copyright (C) 2004-2011 The Cacti Group |
| |
| This program is free software; you can redistribute it and/or |
| modify it under the terms of the GNU General Public License |
| as published by the Free Software Foundation; either version 2 |
| 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 General Public License for more details. |
+-------------------------------------------------------------------------+
| Cacti: The Complete RRDTool-based Graphing Solution |
+-------------------------------------------------------------------------+
| This code is designed, written, and maintained by the Cacti Group. See |
| about.php and/or the AUTHORS file for specific developer information. |
+-------------------------------------------------------------------------+
| http://www.cacti.net/ |
+-------------------------------------------------------------------------+
*/
/*
LDAP functions
*/
/* cacti_ldap_auth
@arg $username - username of the user
@arg $password - password of the user
@arg $dn - LDAP DN for binding
@arg $host - Hostname or IP of LDAP server, Default = Configured settings value
@arg $port - Port of the LDAP server uses, Default = Configured settings value
@arg $port_ssl - Port of the LDAP server uses for SSL, Default = Configured settings value
@arg $version - '2' or '3', LDAP protocol version, Default = Configured settings value
@arg $encryption - '0' None, '1' SSL, '2' TLS, Default = Configured settings value
@arg $referrals - '0' Referrals from server are ignored, '1' Referrals from server are processed, Default = Configured setting value
@arg $group_require - '0' Group membership is not required, '1' Group membership is required
@arg $group_dn - LDAP Group DN
@arg $group_attrib - Name of the LDAP Attrib that contains members
@arg $group_require - '1' DN or '2' Username, user group member ship type
@return - array of values
"error_num" = error number returned
"error_text" = error text
Error codes:
# Text
==============================================================
0 Authentication Success
1 Authentication Failure
2 No username defined
3 Protocol error, unable to set version
4 Unable to set referrals option
5 Protocol error, unable to start TLS communications
6 Unable to create LDAP object
7 Protocol error
8 Insufficient access
9 Unable to connect to server
10 Timeout
11 General bind error
12 Group DN not found
99 PHP LDAP not enabled
*/
function cacti_ldap_auth($username, $password = "", $dn = "", $host = "", $port = "", $port_ssl = "", $version = "",
$encryption = "", $referrals = "", $group_require = "", $group_dn = "", $group_attrib = "", $group_member_type = "") {
$ldap = new Ldap;
if (!empty($username)) $ldap->username = $username;
if (!empty($password)) $ldap->password = $password;
if (!empty($dn)) $ldap->dn = $dn;
if (!empty($host)) $ldap->host = $host;
if (!empty($port)) $ldap->port = $port;
if (!empty($port_ssl)) $ldap->port_ssl = $port_ssl;
if (!empty($version)) $ldap->version = $version;
if (!empty($encryption)) $ldap->encryption = $encryption;
if (!empty($referrals)) $ldap->referrals = $referrals;
if (!empty($group_require)) $ldap->group_require = $group_require;
if (!empty($group_dn)) $ldap->group_dn = $group_dn;
if (!empty($group_attrib)) $ldap->group_attrib = $group_attrib;
if (!empty($group_member_type)) $ldap->group_member_type = $group_member_type;
return $ldap->Authenticate();
}
/* cacti_ldap_search_dn
@arg $username - username to search for in the LDAP directory
@arg $dn - configured LDAP DN for binding, "<username>" will be replaced with $username
@arg $host - Hostname or IP of LDAP server, Default = Configured settings value
@arg $port - Port of the LDAP server uses, Default = Configured settings value
@arg $port_ssl - Port of the LDAP server uses for SSL, Default = Configured settings value
@arg $version - '2' or '3', LDAP protocol version, Default = Configured settings value
@arg $encryption - '0' None, '1' SSL, '2' TLS, Default = Configured settings value
@arg $referrals - '0' Referrals from server are ignored, '1' Referrals from server are processed, Default = Configured setting value
@arg $mode - '0' No Searching, '1' Anonymous Searching, '2' Specfic Searching, Default = Configured settings value
@arg $search_base - Search base DN, Default = Configured settings value
@arg $search_filter - Filter to find the user, Default = Configured settings value
@arg $specific_dn - DN for binding to perform user search, Default = Configured settings value
@arg $specific_password - Password for binding to perform user search, Default - Configured settings value
@return - array of values
"error_num" = error number returned
"error_text" = error text
"dn" = found dn of user
Error codes:
# Text
==============================================================
0 User found
1 No username defined
2 Unable to create LDAP connection object
3 Unable to find users DN
4 Protocol error, unable to set version
5 Protocol error, unable to start TLS communications
6 Protocol error
7 Invalid credential
8 Insufficient access
9 Unable to connect to server
10 Timeout
11 General bind error
12 Unable to set referrals option
13 More than one matching user found
14 Specific DN and Password required
99 PHP LDAP not enabled
*/
function cacti_ldap_search_dn($username, $dn = "", $host = "", $port = "", $port_ssl = "", $version = "", $encryption = "",
$referrals = "", $mode = "", $search_base = "", $search_filter = "", $specific_dn = "", $specific_password = "") {
$ldap = new Ldap;
if (!empty($username)) $ldap->username = $username;
if (!empty($dn)) $ldap->dn = $dn;
if (!empty($host)) $ldap->host = $host;
if (!empty($port)) $ldap->port = $port;
if (!empty($port_ssl)) $ldap->port_ssl = $port_ssl;
if (!empty($version)) $ldap->version = $version;
if (!empty($encryption)) $ldap->encryption = $encryption;
if (!empty($referrals)) $ldap->referrals = $referrals;
if (!empty($mode)) $ldap->mode = $mode;
if (!empty($search_base)) $ldap->search_base = $search_base;
if (!empty($search_filter)) $ldap->search_filter = $search_filter;
if (!empty($specific_dn)) $ldap->specific_dn = $specific_dn;
if (!empty($specific_password)) $ldap->specific_password = $specific_password;
return $ldap->Search();
}
class Ldap {
function Ldap() {
/* Initialize LDAP parameters for Authenticate */
$this->dn = read_config_option("ldap_dn");
$this->host = read_config_option("ldap_server");
$this->port = read_config_option("ldap_port");
$this->port_ssl = read_config_option("ldap_port_ssl");
$this->version = read_config_option("ldap_version");
$this->encryption = read_config_option("ldap_encryption");
$this->referrals = read_config_option("ldap_referrals");
if (read_config_option("ldap_group_require") == "on") {
$this->group_require = true;
}else{
$this->group_require = false;
}
$this->group_dn = read_config_option("ldap_group_dn");
$this->group_attrib = read_config_option("ldap_group_attrib");
$this->group_member_type = read_config_option("ldap_group_member_type");
/* Initialize LDAP parameters for Search */
$this->mode = read_config_option("ldap_mode");
$this->specific_dn = read_config_option("ldap_specific_dn");
$this->specific_password = read_config_option("ldap_specific_password");
$this->search_base = read_config_option("ldap_search_base");
$this->search_filter = read_config_option("ldap_search_filter");
return true;
}
function Authenticate() {
$output = array();
/* function check */
if (!function_exists("ldap_connect")) {
$output["error_num"] = 99;
$output["error_text"] = "PHP LDAP not enabled";
return $output;
}
/* validation */
if (empty($this->username)) {
$output["error_num"] = "2";
$output["error_text"] = "No username defined";
return $output;
}
$this->dn = str_replace("<username>", $this->username, $this->dn);
/* Fix encoding of username and password */
$this->username = utf8_encode($this->username);
$this->password = utf8_encode($this->password);
/* Determine connection method and create LDAP Object */
if ($this->encryption == "1") {
/* This only works with OpenLDAP, I'm pretty sure this will not work with Solaris, Tony */
$ldap_conn = @ldap_connect("ldaps://" . $this->host . ":" . $this->port_ssl);
}else{
$ldap_conn = @ldap_connect($this->host, $this->port);
}
if ($ldap_conn) {
/* Set protocol version */
cacti_log("LDAP: Setting protocol version to " . $this->version, false, "AUTH");
if (!@ldap_set_option($ldap_conn, LDAP_OPT_PROTOCOL_VERSION, $this->version)) {
$output["error_num"] = "3";
$output["error_text"] = "Protocol Error, Unable to set version";
cacti_log("LDAP: " . $output["error_text"], false, "AUTH");
@ldap_close($ldap_conn);
return $output;
}
/* set referrals */
if ($this->referrals == "0") {
if (!@ldap_set_option($ldap_conn, LDAP_OPT_REFERRALS, 0)) {
$output["error_num"] = "4";
$output["error_text"] = "Unable to set referrals option";
cacti_log("LDAP: " . $output["error_text"], false, "AUTH");
@ldap_close($ldap_conn);
return $output;
}
}
/* start TLS if requested */
if ($this->encryption == "2") {
if (!@ldap_start_tls($ldap_conn)) {
$output["error_num"] = "5";
$output["error_text"] = "Protocol error, unable to start TLS communications";
cacti_log("LDAP: " . $output["error_text"], false, "AUTH");
@ldap_close($ldap_conn);
return $output;
}
}
/* Bind to the LDAP directory */
$ldap_response = @ldap_bind($ldap_conn, $this->dn, $this->password);
if ($ldap_response) {
if ($this->group_require == 1) {
/* Process group membership if required */
if ($this->group_member_type == 1) {
$ldap_group_response = @ldap_compare($ldap_conn, $this->group_dn, $this->group_attrib, $this->dn);
} else {
$ldap_group_response = @ldap_compare($ldap_conn, $this->group_dn, $this->group_attrib, $this->username);
}
if ($ldap_group_response === true) {
/* Auth ok */
$output["error_num"] = "0";
$output["error_text"] = "Authentication Success";
} else if ($ldap_group_response === false) {
$output["error_num"] = "8";
$output["error_text"] = "Insufficient access";
cacti_log("LDAP: " . $output["error_text"], false, "AUTH");
@ldap_close($ldap_conn);
return $output;
} else {
$output["error_num"] = "12";
$output["error_text"] = "Group DN could not be found to compare";
cacti_log("LDAP: " . $output["error_text"], false, "AUTH");
@ldap_close($ldap_conn);
return $output;
}
}else{
/* Auth ok - No group membership required */
$output["error_num"] = "0";
$output["error_text"] = "Authentication Success";
}
}else{
/* unable to bind */
$ldap_error = ldap_errno($ldap_conn);
if ($ldap_error == 0x03) {
/* protocol error */
$output["error_num"] = "7";
$output["error_text"] = "Protocol error";
}elseif ($ldap_error == 0x31) {
/* invalid credentials */
$output["error_num"] = "1";
$output["error_text"] = "Authentication Failure";
}elseif ($ldap_error == 0x32) {
/* insuffient access */
$output["error_num"] = "8";
$output["error_text"] = "Insufficient access";
}elseif ($ldap_error == 0x51) {
/* unable to connect to server */
$output["error_num"] = "9";
$output["error_text"] = "Unable to connect to server";
}elseif ($ldap_error == 0x55) {
/* timeout */
$output["error_num"] = "10";
$output["error_text"] = "Connection Timeout";
}else{
/* general bind error */
$output["error_num"] = "11";
$output["error_text"] = "General bind error, LDAP result: " . ldap_error($ldap_conn);
}
}
}else{
/* Error intializing LDAP */
$output["error_num"] = "6";
$output["error_text"] = "Unable to create LDAP object";
}
/* Close LDAP connection */
@ldap_close($ldap_conn);
if ($output["error_num"] > 0) {
cacti_log("LDAP: " . $output["error_text"], false, "AUTH");
}
return $output;
}
function Search() {
$output = array();
/* function check */
if (!function_exists("ldap_connect")) {
$output["error_num"] = 99;
$output["error_text"] = "PHP LDAP not enabled";
return $output;
}
/* validation */
if (empty($this->username)) {
$output["dn"] = "";
$output["error_num"] = "1";
$output["error_text"] = "No username defined";
cacti_log("LDAP_SEARCH: No username defined", false, "AUTH");
return $output;
}
/* Encode username */
$this->username = utf8_encode($this->username);
/* strip bad chars from username - prevent altering filter from username */
$this->username = str_replace("&", "", $this->username);
$this->username = str_replace("|", "", $this->username);
$this->username = str_replace("(", "", $this->username);
$this->username = str_replace(")", "", $this->username);
$this->username = str_replace("*", "", $this->username);
$this->username = str_replace(">", "", $this->username);
$this->username = str_replace("<", "", $this->username);
$this->username = str_replace("!", "", $this->username);
$this->username = str_replace("=", "", $this->username);
$this->dn = str_replace("<username>", $this->username, $this->dn);
if ($this->mode == "0") {
/* Just bind mode, make dn and return */
$output["dn"] = $this->dn;
$output["error_num"] = "0";
$output["error_text"] = "User found";
return $output;
}elseif ($this->mode == "2") {
/* Specific */
if (empty($this->specific_dn) || empty($this->specific_password)) {
$output["dn"] = $this->dn;
$output["error_num"] = "14";
$output["error_text"] = "Specific DN and Password required";
return $output;
}
}elseif ($this->mode == "1"){
/* assume anonymous */
$specific_dn = "";
$specific_password = "";
}
$this->search_filter = str_replace("<username>", $this->username, $this->search_filter);
/* Fix encoding on ldap specific search DN and password */
$this->specific_password = utf8_encode($this->specific_password);
$this->specific_dn = utf8_encode($this->specific_dn);
/* Searching mode */
if ($this->encryption == "1") {
/* This only works with OpenLDAP, I'm pretty sure this will not work with Solaris, Tony */
$ldap_conn = @ldap_connect("ldaps://" . $this->host . ":" . $this->port_ssl);
}else{
$ldap_conn = @ldap_connect($this->host, $this->port);
}
if ($ldap_conn) {
/* Set protocol version */
if (!@ldap_set_option($ldap_conn, LDAP_OPT_PROTOCOL_VERSION, $this->version)) {
/* protocol error */
$output["dn"] = "";
$output["error_num"] = "4";
$output["error_text"] = "Protocol error, unable to set version";
cacti_log("LDAP_SEARCH: " . $output["error_text"], false, "AUTH");
@ldap_close($ldap_conn);
return $output;
}
/* set referrals */
if ($this->referrals == "0") {
if (!@ldap_set_option($ldap_conn, LDAP_OPT_REFERRALS, 0)) {
/* referrals set error */
$output["dn"] = "";
$output["error_num"] = "13";
$output["error_text"] = "Unable to set referrals option";
cacti_log("LDAP_SEARCH: " . $output["error_text"], false, "AUTH");
@ldap_close($ldap_conn);
return $output;
}
}
/* start TLS if requested */
if ($this->encryption == "2") {
if (!@ldap_start_tls($ldap_conn)) {
/* TLS startup error */
$output["dn"] = "";
$output["error_num"] = "5";
$output["error_text"] = "Protocol error, unable to start TLS communications";
cacti_log("LDAP_SEARCH: " . $output["error_text"], false, "AUTH");
@ldap_close($ldap_conn);
return $output;
}
}
/* bind to the directory */
if (ldap_bind($ldap_conn, $this->specific_dn, $this->specific_password)) {
/* Search */
$ldap_results = ldap_search($ldap_conn, $this->search_base, $this->search_filter, array("dn"));
if ($ldap_results) {
$ldap_entries = ldap_get_entries($ldap_conn, $ldap_results);
if ($ldap_entries["count"] == "1") {
/* single response return user dn */
$output["dn"] = $ldap_entries["0"]["dn"];
$output["error_num"] = "0";
$output["error_text"] = "User found";
cacti_log("LDAP_SEARCH: User found, DN '%s'" . $output["dn"], false, "AUTH");
}elseif ($ldap_entries["count"] > 1) {
/* more than 1 result */
$output["dn"] = "";
$output["error_num"] = "13";
$output["error_text"] = "More than one matching user found";
}else{
/* no search results */
$output["dn"] = "";
$output["error_num"] = "3";
$output["error_text"] = "Unable to find users DN";
}
}else{
/* no search results, user not found*/
$output["dn"] = "";
$output["error_num"] = "3";
$output["error_text"] = "Unable to find users DN";
}
}else{
/* unable to bind */
$ldap_error = ldap_errno($ldap_conn);
if ($ldap_error == 0x03) {
/* protocol error */
$output["dn"] = "";
$output["error_num"] = "6";
$output["error_text"] = "Protocol error";
}elseif ($ldap_error == 0x31) {
/* invalid credentials */
$output["dn"] = "";
$output["error_num"] = "7";
$output["error_text"] = "Invalid credentials";
}elseif ($ldap_error == 0x32) {
/* insuffient access */
$output["dn"] = "";
$output["error_num"] = "8";
$output["error_text"] = "Insufficient access";
}elseif ($ldap_error == 0x51) {
/* unable to connect to server */
$output["dn"] = "";
$output["error_num"] = "9";
$output["error_text"] = "Unable to connect to server";
}elseif ($ldap_error == 0x55) {
/* timeout */
$output["dn"] = "";
$output["error_num"] = "10";
$output["error_text"] = "Connection Timeout";
}else{
/* general bind error */
$output["dn"] = "";
$output["error_num"] = "11";
$output["error_text"] = "General bind error, LDAP result: " . ldap_error($ldap_conn);
}
}
}else{
/* unable to setup connection */
$output["dn"] = "";
$output["error_num"] = "2";
$output["error_text"] = "Unable to create LDAP connection object";
}
@ldap_close($ldap_conn);
if ($output["error_num"] > 0) {
cacti_log("LDAP_SEARCH: " . $output["error_text"], false, "AUTH");
}
return $output;
}
}
?>
|