[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/inc/auth/ -> ldap.class.php (summary)

(no description)

File Size: 486 lines (19 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

auth_ldap:: (11 methods):
  __construct()
  checkPass()
  getUserData()
  isCaseSensitive()
  retrieveUsers()
  _makeFilter()
  _filter()
  _constructPattern()
  _filterEscape()
  _openLDAP()
  _ldapsearch()


Class: auth_ldap  - X-Ref

LDAP authentication backend

__construct()   X-Ref
Constructor


checkPass($user,$pass)   X-Ref
Check user+password

Checks if the given user exists and the given
plaintext password is correct by trying to bind
to the LDAP server

author: Andreas Gohr <andi@splitbrain.org>
return: bool

getUserData($user,$inbind=false)   X-Ref
Return user info

Returns info about the given user needs to contain
at least these fields:

name string  full name of the user
mail string  email addres of the user
grps array   list of groups the user is in

This LDAP specific function returns the following
addional fields:

dn     string  distinguished name (DN)
uid    string  Posix User ID
inbind bool    for internal use - avoid loop in binding

author: Andreas Gohr <andi@splitbrain.org>
author: Trouble
author: Dan Allen <dan.j.allen@gmail.com>
author: <evaldas.auryla@pheur.org>
author: Stephane Chazelas <stephane.chazelas@emerson.com>
return: array containing user data or false

isCaseSensitive()   X-Ref
Most values in LDAP are case-insensitive


retrieveUsers($start=0,$limit=-1,$filter=array()   X-Ref
Bulk retrieval of user data

author: Dominik Eckelmann <dokuwiki@cosmocode.de>
param: start     index of first user to be returned
param: limit     max number of users to be returned
param: filter    array of field/pattern pairs, null for no filter
return: array of userinfo (refer getUserData for internal userinfo details)

_makeFilter($filter, $placeholders)   X-Ref
Make LDAP filter strings.

Used by auth_getUserData to make the filter
strings for grouptree and groupfilter

filter      string  ldap search filter with placeholders
placeholders array   array with the placeholders

author: Troels Liebe Bentsen <tlb@rapanden.dk>
return: string

_filter($user, $info)   X-Ref
return 1 if $user + $info match $filter criteria, 0 otherwise

author: Chris Smith <chris@jalakai.co.uk>

_constructPattern($filter)   X-Ref
No description

_filterEscape($string)   X-Ref
Escape a string to be used in a LDAP filter

Ported from Perl's Net::LDAP::Util escape_filter_value

author: Andreas Gohr

_openLDAP()   X-Ref
Opens a connection to the configured LDAP server and sets the wanted
option on the connection

author: Andreas Gohr <andi@splitbrain.org>

_ldapsearch($link_identifier, $base_dn, $filter, $scope='sub', $attributes=null,$attrsonly=0, $sizelimit=0, $timelimit=0, $deref=LDAP_DEREF_NEVER)   X-Ref
Wraps around ldap_search, ldap_list or ldap_read depending on $scope

author: Andreas Gohr <andi@splitbrain.org>
param: $scope string - can be 'base', 'one' or 'sub'



Generated: Sun Feb 3 03:00:06 2013 Cross-referenced by PHPXref 0.7
WikiForumIRCBugsGitXRefTranslate