[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

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

Active Directory authentication backend for DokuWiki

Author: James Van Lommel
Author: Andreas Gohr
License: GPL 2 (http://www.gnu.org/licenses/gpl.html)
Link: http://www.nosq.com/blog/2005/08/ldap-activedirectory-and-dokuwiki/
File Size: 390 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 inc/adLDAP.php

Defines 1 class

auth_ad:: (11 methods):
  __construct()
  checkPass()
  getUserData()
  cleanGroup()
  cleanUser()
  isCaseSensitive()
  retrieveUsers()
  modifyUser()
  _init()
  _filter()
  _constructPattern()


Class: auth_ad  - X-Ref

__construct()   X-Ref
Constructor


checkPass($user, $pass)   X-Ref
Check user+password [required auth function]

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

author: James Van Lommel <james@nosq.com>
return: bool

getUserData($user)   X-Ref
Return user info [required auth function]

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

name string  full name of the user
mail string  email address 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

author: James Van Lommel <james@nosq.com>

cleanGroup($name)   X-Ref
Make AD group names usable by DokuWiki.

Removes backslashes ('\'), pound signs ('#'), and converts spaces to underscores.

author: James Van Lommel (jamesvl@gmail.com)

cleanUser($name)   X-Ref
Sanitize user names


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)

modifyUser($user, $changes)   X-Ref
Modify user data

param: $user      nick of the user to be changed
param: $changes   array of field/value pairs to be changed
return: bool

_init()   X-Ref
Initialize the AdLDAP library and connect to the server


_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



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