| Package Data | |
|---|---|
| Maintainer Username: | sroutier |
| Maintainer Contact: | sroutier@gmail.com (Sebastien Routier) |
| Package Create Date: | 2015-08-07 |
| Package Last Update: | 2018-01-20 |
| Language: | PHP |
| License: | GPL-3.0 |
| Last Refreshed: | 2024-04-11 03:17:36 |
| Package Statistics | |
|---|---|
| Total Downloads: | 8,614 |
| Monthly Downloads: | 8 |
| Daily Downloads: | 0 |
| Total Stars: | 19 |
| Total Watchers: | 3 |
| Total Forks: | 5 |
| Total Open Issues: | 1 |
A Laravel package that first tries to log the user against the internal database, if that fails, it tries against the configured LDAP/AD server. Optionally it will create a local user record on first login of an LDAP user, as well as grant that user permissions to local groups that have matching names of the LDAP groups that the user is a member of.
Laravel | LERN :---------|:---------- 5.1.x | 1.x 5.5.x | 2.x
Via Composer
$ composer require sroutier/eloquent-ldap
Add this declaration in the provider array of your ./config/app.php file:
Sroutier\EloquentLDAP\Providers\EloquentLDAPServiceProvider::class,
To publish the assets, config file and migration scripts, run this command:
$ php artisan vendor:publish --provider="Sroutier\EloquentLDAP\Providers\EloquentLDAPServiceProvider"
This will publish a config file and a migration file.
The migration script will add a new column auth_type to the schema of the
users table, and one column resync_on_login to the groups table. You
should already have both tables, but if you do not or if you want to use
different tables for those purposes, the migration to create those
tables is provided as an example, but commented out. You will
want to review the migration script and adjust according to
your scenario.
Once ready, run the migration script with this command:
$ php artisan migrate
The recommended way to configure this package is by defining the following
variables in you .env file and adjusting the values there. For a
detailed explanation of each setting, refer to the config file
that you published above.
The configuration that you will need will vary based on the type or server that you wish to authenticate against. Below are example config section for both options, Lightweight Directory Access Protocol (LDAP) and Microsoft Active Directory (MSAD).
Below is a section of a .env config file that shows how to configure your system to access a Microsoft Active
Directory server:
eloquent-ldap.enabled=true
eloquent-ldap.debug=false
eloquent-ldap.server_type=MSAD
eloquent-ldap.create_accounts=true
eloquent-ldap.replicate_group_membership=true
eloquent-ldap.resync_on_login=true
eloquent-ldap.group_model=App\Models\Role
eloquent-ldap.label_internal=internal
eloquent-ldap.label_ldap=ldap
eloquent-ldap.account_suffix=@company.com
eloquent-ldap.base_dn=DC=department,DC=company,DC=com
eloquent-ldap.server=ldapsrv01.company.com
eloquent-ldap.port=389
eloquent-ldap.user_name=ldap_reader
eloquent-ldap.password=PaSsWoRd
eloquent-ldap.return_real_primary_group=true
eloquent-ldap.secured=false
eloquent-ldap.secured_port=636
eloquent-ldap.recursive_groups=true
eloquent-ldap.sso=false
eloquent-ldap.username_field=samaccountname
eloquent-ldap.email_field=userprincipalname
eloquent-ldap.first_name_field=givenname
eloquent-ldap.last_name_field=sn
eloquent-ldap.user_filter=(&(objectcategory=person)(samaccountname=%username))
Below is a section of a .env config file that shows how to configure your system to access a Lightweight
Directory Access Protocol server:
eloquent-ldap.enabled=true
eloquent-ldap.debug=false
eloquent-ldap.server_type=LDAP
eloquent-ldap.create_accounts=true
eloquent-ldap.replicate_group_membership=false
eloquent-ldap.resync_on_login=false
eloquent-ldap.group_model=App\Models\Role
eloquent-ldap.label_internal=internal
eloquent-ldap.label_ldap=ldap
eloquent-ldap.account_suffix=
eloquent-ldap.base_dn=dc=example,dc=com
eloquent-ldap.server=ldap.forumsys.com
eloquent-ldap.port=389
eloquent-ldap.user_name=cn=read-only-admin,dc=example,dc=com
eloquent-ldap.password=password
eloquent-ldap.return_real_primary_group=true
eloquent-ldap.secured=false
eloquent-ldap.secured_port=636
eloquent-ldap.recursive_groups=true
eloquent-ldap.sso=false
eloquent-ldap.username_field=uid
eloquent-ldap.email_field=mail
eloquent-ldap.first_name_field=
eloquent-ldap.last_name_field=sn
eloquent-ldap.user_filter=(&(objectclass=person)(uid=%username))
NOTE: THe configuration options above will allow you to connect and authenticate users using the publicly available OpenLDAP test server hosted by Forum Systems.
A couple of difference in how to configure the system depending on which server type is being used are worth pointing out.
The users table/model must have the following columns/attributes named
username, first_name, last_name and email. The migration
script provided with this package has an example of how to
create such a table but it is commented out.
The user model must have the auth-type attribute added to its fillable array
to allow setting the column in the database.
Also your login view and AuthController must accept a user name and password.
They can accept other fields if you want, such as email, security token,
etc... But the first time a new user tries to log in, since he will not
be found in the local database, the package will need the user name to
authenticate against the LDAP server.
For a concrete example of this package used in an active project, see sroutier/laravel-5.1-enterprise-starter-kit. Note that in that project this package is used in combination with Zizaco/entrust to provide role based authorization, therefore there is no group model, but instead a role model.
Please see CHANGELOG for more information what has changed recently.
Please see CONTRIBUTING for details.
If you discover any security related issues, please email sroutier@gmail.com instead of using the issue tracker.
The GNU General Public License Version 3 (GPLv3). Please see License File for more information.