README

ShieldLDAP is an CodeIgniter Shield Addon to authenticate against an LDAP Server.

See the An Official Auth Library for more Info.

Authentication Methods

ShieldLDAP provides the LDAP-based method.

LDAP

This is your typical username/password system you see everywhere. It includes a secure "remember me" functionality. This can be used for standard web applications, as well as for single page applications. Includes full controllers and basic views for all standard functionality, like registration, login, forgot password, etc.

Getting Started

Prerequisites

Usage of Shield requires the following:

A CodeIgniter 4.3.5+ based project
Composer for package management
PHP 7.4.3+

Installation

Installation is done through Composer.

composer config minimum-stability dev
composer config prefer-stable true

composer require rakoitde/shieldldap dev-develop

Setup

php spark shield:setup
php spark shieldldap:setup

Config AuthLdap in .env

It is recommended that the AuthLdap settings are made in the .env to prevent internal company information from becoming public

#--------------------------------------------------------------------
# Shield AuthLdap
#--------------------------------------------------------------------

authldap.ldap_host              = 
authldap.ldap_domain            = 
authldap.search_base            = 
authldap.storePasswordInSession = false
authldap.use_ldaps              = true
authldap.username               = 
authldap.password               =

See the (docs)[docs] for more specific instructions on installation and usage recommendations.

Contributing

ShieldLDAP does accept and encourage contributions from the community in any shape. It doesn't matter whether you can code, write documentation, or help find bugs, all contributions are welcome.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

rakoitde / shieldldap

Maintainers

Details