hakuryo/ldap-client

A simple LDAP client with a lot a helper function

2.3.0 2025-01-16 08:59 UTC

Requires

• php: >=8.1.0
• ext-ldap: *
• hakuryo/config-parser: ^1.1

Requires (Dev)

• phpunit/phpunit: ^11.5

MIT

• Hakuryo

README

2.2.0 (breaking change)

feature

• Add trackBy param to search and list function. This param will replace the auto index key of the array by the value of the key for the corresponding line.

exemple:

$ldap = ConnectionLDAP::fromFile("my_file",'ldap');
$res = $ldap->search(filter:"objectClass=person",trackBy:"mail");
print_r($res);
// Will ouptut something like this with uid= toto32 sn=toto and mail=[e-mail]
Array
(
  ["[e-mail]"] => stdClass Object
  (
      [uid] => toto32
      [sn] => toto
      [mail] => [e-mail]
  ) 
)

• Add Callback param to search,list and get function to act on lines when they are read.

change

• Param returnedAttrs of search,list and get function now accept a comma separated list of attribute name.
• returnedAttrs keys now respect schema description. They are no longer converted to lowercase.
  • before : objectclass
  • after : objectClass
• Autloading is now PSR-4 instead of classmap.
• Changed the namespace of Exception classes to be PSR-4 compliant
• Removed ConfigParser class using hakuryo/config-parser instead

fix

• list function now use pagination as intended

2.1.0

• Add pagination param to search function

2.0.0 (breaking change)

• cleaned unused code
• refactoring project, classes moved in new directory / namespace
• Naming convention is now camelCase
• getEntry now return null if no result instead of stdclass
• Ldap operation now throw specifique errors
  • search / list / getEntry => LDAPSearchException
  • add => LDAPAddException
  • modify => LDAPModifyException
  • delete => LDAPDeleteException
  • fromFile => LDAPConnectException / LDAPBinDException

new function

• list perform a single level search to get more performance.

modified function

• search now perform a subtree search event if scope is one_level.
• getEntry perform a search taking account of scope

1.1.1 (Breaking changes)

• Rename ConnectionLDAP::fromFile to ConnectionLDAP::from_file fit naming convention.

Install

composer require hakuryo/ldap-client

Dependencies

Mandatory

• PHP >= 8.1

Features

• Parsing client config from INI and JSON file

Usage & exemples

Exemple INI file

[ldap]
HOST="ldap://myldap.mydomain.com"
;LDAPS
;HOST="ldaps://myldap.mydomain.com"
USER="cn=admin,dc=mydomain, dc=com"
DN="dc=mydomain, dc=com"
PWD="my_super_secure_password"
;OPTIONAL
;network_timeout in second
TIMEOUT=5

ConnectionLDAP usage

require_once './vendor/autoload.php';

use hakuryo\ldap\ConnectionLDAP;

// Basic connection 
$ldap = new ConnectionLDAP("myldap.mydomain.com","uid=user,ou=people,dc=mydomain,dc=com")

// From File
$ldap = ConnectionLDAP::fromFile("path_to_my_ldap_ini_file");

// You can specify a section of your ini file
$ldap = ConnectionLDAP::fromFile("path_to_my_ldap_ini_file","ldap_section");

//ldap_search
$ldapFilter = "memberof=cn=admin,ou=groups,dc=mydomain,dc=com";
$attrList = ["uid","displayname","sn","givenname"];
$results = $ldap->search($ldapFilter,$attrList);
foreach($result as $entry){
    echo json_encode($entry,JSON_PRETTY_PRINT);
}

// get an specifique entry
$ldap->getEntry($ldapFilter,$attrList);

// Modify serach_options
$ldap->getSearchOptions()->setBaseDN("ou=my_ou,dc=exemple,dc=com");
$ldap->getSearchOptions()->setResultLimit(1);
$ldap->getSearchOptions()->setScope(LdapSearchOptions::SEARCH_SCOPE_ONE_LEVEL);

// You can chain modification
$ldap->getSearchOptions()->setResultLimit(1)->setScope(LdapSearchOptions::SEARCH_SCOPE_ONE_LEVEL);