51 lines
2.0 KiB
PHP
Executable File
51 lines
2.0 KiB
PHP
Executable File
<?php
|
|
|
|
/**
|
|
* Class to interact with LDAP
|
|
*
|
|
* @author Denis CLAVIER <clavierd at gmail dot com>
|
|
*/
|
|
interface LDAPInterface
|
|
{
|
|
/**
|
|
* @param string @user
|
|
* A ldap username or email or sAMAccountName
|
|
* @param string @password
|
|
* An optional password linked to the user, if not provided an anonymous bind is attempted
|
|
* @param string @ldap_search_attribute
|
|
* The attribute used on your LDAP to identify user (uid, email, cn, sAMAccountName)
|
|
* @param string @ldap_filter
|
|
* An optional filter to search in LDAP (ex : objectClass = person).
|
|
* @param string @ldap_base_dn
|
|
* The LDAP base DN.
|
|
* @param string @ldap_bind_dn
|
|
* The directory name of a service user to bind before search. Must be a user with read permission on LDAP.
|
|
* @param string @ldap_bind_pass
|
|
* The password associated to the service user to bind before search.
|
|
*
|
|
* @return
|
|
* TRUE if the user is identified and can access to the LDAP server
|
|
* and FALSE if it isn't
|
|
*/
|
|
public function checkLogin($user,$password = null,$ldap_search_attribute,$ldap_filter = null,$ldap_base_dn,$ldap_bind_dn,$ldap_bind_pass);
|
|
|
|
/**
|
|
* @param string @ldap_base_dn
|
|
* The LDAP base DN.
|
|
* @param string @ldap_filter
|
|
* A filter to get relevant data. Often the user id in ldap (uid or sAMAccountName).
|
|
* @param string @ldap_bind_dn
|
|
* The directory name of a service user to bind before search. Must be a user with read permission on LDAP.
|
|
* @param string @ldap_bind_pass
|
|
* The password associated to the service user to bind before search.
|
|
* @param string @ldap_search_attribute
|
|
* The attribute used on your LDAP to identify user (uid, email, cn, sAMAccountName)
|
|
* @param string @user
|
|
* A ldap username or email or sAMAccountName
|
|
*
|
|
* @return
|
|
* An array with the user's mail, complete name and directory name.
|
|
*/
|
|
public function getDataForMattermost($ldap_base_dn, $ldap_filter, $ldap_bind_dn, $ldap_bind_pass, $ldap_search_attribute, $user);
|
|
}
|