ptdot/ldapauth

Laravel LDAP authentication wrapper

dev-master 2018-07-22 09:50 UTC

Requires

• php: >=5.5.9
• illuminate/support: 5.3.x|5.4.x|5.5.x|5.6.x

MIT

• Didik Tri Susanto

• Authentication
• ldap
• laravel

README

Laravel LDAP Authentication is a package for authenticating user to Active Directory using Lightweight Directory Access Protocol and integrated with Laravel authenticatable model out of the box.

Requirements

• Laravel 5.1 - 5.6
• Enable PHP LDAP Extension

Installation

Install package through composer.

composer require ptdot/ldapauth

Next, if using Laravel under 5.5, include the service provider and Facade within your config/app.php file.

'providers' => [
    Ptdot\LdapAuth\LdapAuthServiceProvider::class,
],

'aliases' => [
    'LdapAuth' => Ptdot\LdapAuth\LdapAuthFacade::class,
]

Since Laravel 5.5+ is using Package Discovery, there is no need manually insert service provider and facade inside your app.php.

Configuration

Publish config using command:

php artisan vendor:publish --tag=config

Set keys and values for your LDAP configuration in .env file.

LDAP_HOST=ldap.example.com
LDAP_PORT=389

Setup your User model or custom authentication model In config/ldap.php file and don't forget to adjust your usernameField value from your authentication model.

Make sure you are already has user data in database and create user model for authentication.

/*
    |--------------------------------------------------------------------------
    | Authentication user model
    |--------------------------------------------------------------------------
    |
    | Authentication is used User model for default.
    | Define this option if authentication model using different model / namespace.
    |
    */
    'user' => App\User::class,
    'usernameField' => 'username'

Usage

For attempting authentication using LDAP:

$result = LdapAuth::attempt($username, $password);

Attempt method will return an array that indicate that authentication is success or not.

Example

/**
* Logging in using LDAP
*/
public funtion login(Request $request)
{
    $username = $request->get('username');
    $password = $request->get('password');
    
    $login = LdapAuth::attempt($username, $password);
    if($login['status']) {
        return "Login success";
    }
    return "Login failed. Error: ".$login['message'];
}

Contributing

Feel free to report an issue or merge request if you want to help this package become better and useful.