Download the PHP package sroutier/eloquent-ldap without Composer
On this page you can find all versions of the php package sroutier/eloquent-ldap. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sroutier/eloquent-ldap
More information about sroutier/eloquent-ldap
Files in sroutier/eloquent-ldap
Package eloquent-ldap
Short Description 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.
License GPL-3.0
Homepage https://github.com/sroutier/eloquent-ldap
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package eloquent-ldap
eloquent-ldap
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.
Version Compatibility
| Laravel | LERN |
|---|---|
| 5.1.x | 1.x |
| 5.5.x | 2.x |
Install
Via Composer
Declare provider
Add this declaration in the provider array of your ./config/app.php file:
Publish assets
To publish the assets, config file and migration scripts, run this command:
This will publish a config file and a migration file.
Migration
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:
Configure
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).
Microsoft Active Directory server.
Below is a section of a config file that shows how to configure your system to access a Microsoft Active Directory server:
Lightweight Directory Access Protocol server.
Below is a section of a config file that shows how to configure your system to access a Lightweight Directory Access Protocol server:
NOTE: THe configuration options above will allow you to connect and authenticate users using the publicly available OpenLDAP test server hosted by Forum Systems.
MSAD vs LDAP
A couple of difference in how to configure the system depending on which server type is being used are worth pointing out.
- eloquent-ldap.server_type: Can be either LDAP or MSAD. Lets the system know how to interact with the authentication server.
- eloquent-ldap.replicate_group_membership: Currently only supported for MSAD servers.
- eloquent-ldap.resync_on_login: Currently only supported for MSAD servers.
- eloquent-ldap.account_suffix:
- LDAP: Should remain empty for LDAP servers.
- MSAD: Should contain the static part of the users email address.
- eloquent-ldap.user_name:
- LDAP: Should be the complete DN of the user to bind with.
- MSAD: Simply the name of the user to bind with.
- eloquent-ldap.return_real_primary_group:
- LDAP: Not used.
- MSAD: Fix Microsoft AD not following standards may incur extra processing.
Usage
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.
Example
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.
Change log
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The GNU General Public License Version 3 (GPLv3). Please see License File for more information.
