comodojo.ldaph

, _(*1)

poor man's php ldap class, _(*2)

Ldaph is a simple library made to handle LDAP/ActiveDirectory authentication and search., _(*3)

It supports:, _(*4)

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

Installation

Install composer, then:, _(*5)

composer require comodojo/ldaph 1.0.*, _(*6)

Basic Usage

Creating an instance, _(*7)

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., _(*8)
```
try {

    $ldap = new \Comodojo\Ldaph('ldap.exampe.com', 389);

}
catch (LdaphException $le){

    // handle exception here

}
```
User authentication, _(*9)
```
$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)., _(*10)

Examples of DN:, _(*11)
- "USERNAME@example.com" (for Active Directory)
- "uid=USERNAME,dc=example,dc=com" (for openLDAP)
Search LDAP tree, _(*12)

Searching into ldap tree requires, at least:, _(*13)
- base DN (base)
- search DN (searchbase)
- bind DN (dn)
- account (user/pass)
search() method will list ldap tree using this parameters., _(*14)
```
$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., _(*15)

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

Examples of searchbase (if you are looking for usernames):, _(*17)
- "(&(!(objectClass=computer))(|(anr=PATTERN)))" (for Active Directory)
- "(uid=PATTERN)" (for openLDAP)