comodojo/ldaph

poor man's php ldap class

1.0.3 2018-12-06 11:06 UTC

Requires

• php: >=5.3.0
• ext-ldap: *
• comodojo/exceptions: ^1.0

Requires (Dev)

• phpunit/phpunit: ^4.0|^5.0
• scrutinizer/ocular: ^1.0

MIT

• Marco Giovinazzi

• php
• Authentication
• ldap
• SSO
• active directory
• ldaps
• directory search

README

poor man's php ldap class

Ldaph is a simple library made to handle LDAP/ActiveDirectory authentication and search.

It supports:

• ssl (ldaps)
• tls
• single sign on (Active Directory)

Installation

Install composer, then:

composer require comodojo/ldaph 1.0.*

Basic Usage

• Creating an instance

  Class constructor expects ldap server and port as parameters. Wrap it in a try/catch block, since it may generate a LdaphException in case of wrong parameters or missed php ext.

  try {
  	
  	$ldap = new \Comodojo\Ldaph('ldap.exampe.com', 389);
  
  }
  catch (LdaphException $le){
  
  	// handle exception here
  
  }

• User authentication

  $dn = "uid=john,dc=example,dc=com";
  
  try {
  
  	$ldap = new \Comodojo\Ldaph('ldap.exampe.com', 389);
  	$lauth = $ldap->dn($dn)->auth('john', 'doe');
  
  }
  catch (LdaphException $le){
  
  	// handle exception here
  
  }

  Defining DN, there is a special word USERNAME that will be replaced with first auth() parameter ($username).

  Examples of DN:

  • "[e-mail]" (for Active Directory)
  • "uid=USERNAME,dc=example,dc=com" (for openLDAP)

• Search LDAP tree

  Searching into ldap tree requires, at least:

  • base DN (base)
  • search DN (searchbase)
  • bind DN (dn)
  • account (user/pass)

  search() method will list ldap tree using this parameters.

  $dn = "uid=USERNAME,dc=example,dc=com";
  $base = "dc=example,dc=com";
  $searchbase = "(uid=PATTERN)";
  
  try {
  
  	$ldap = new \Comodojo\Ldaph('ldap.exampe.com', 389);
  
  	$lsearch = $ldap->base($base)
  					->searchbase($searchbase)
  					->dn($dn)
  					->account('john', 'doe')
  					->search("*",true);
  
  }
  catch (LdaphException $le){
  
  	// handle exception here
  
  }

  Special word 'PATTERN' in searchbase will be replaced with first search() parameter.

  Second parameter (if true) will return results in a more convenient, array-based form.

  Examples of searchbase (if you are looking for usernames):

  • "(&(!(objectClass=computer))(|(anr=PATTERN)))" (for Active Directory)
  • "(uid=PATTERN)" (for openLDAP)

Documentation

• API

Contributing

Contributions are welcome and will be fully credited. Please see CONTRIBUTING for details.

License

comodojo/ldaph is released under the MIT License (MIT). Please see License File for more information.