symfony-bundle ldap-user-bundle

l3/ldap-user-bundle

User Provider from LDAP (branch ou=people)

Symfony 2/3/4/5/6/7 User provider from LDAP, _(*1)

(author : Universite Lille), _(*2)

Allow use LDAP like user provider and security in application written in Symfony2/3/4/5/6, _(*3)

Installation of the Bundle.

Install the Bundle with this command :, _(*4)

composer require l3/ldap-user-bundle:~1.0

Launch the command composer update to install the package, _(*5)

For Symfony 2 and 3 : add the Bundle in AppKernel.php, _(*6)

 ['all' => true],
OpenLdapObject\Bundle\LdapObjectBundle\OpenLdapObjectLdapObjectBundle::class => ['all' => true],
...
```

Configuration of the bundle
---
For Symfony 2 and Symfony 3 :
in the configuration file app/config/parameters.yml.dist and app/config/parameters.yml, add this under parameters:
```
# app/config/parameters.yml.dist
# app/config/parameters.yml
...
parameters:
    ldap_hostname: ldap.univ.fr             # the ldap host of your server ldap
    ldap_base_dn: 'dc=univ,dc=fr'           # the base dn of your server ldap which contains the users
    ldap_dn: 'uid=login,ou=ldapusers,dc=univ,dc=fr' # the login of your server ldap
    ldap_password: password             # the password of your server ldap
...
```
and configure the values in parameters.yml file.

next in the configuration file app/config/config.yml, add this lines at the end of the file :
```
# app/config/config.yml
...
# Ldap
open_ldap_object_ldap_object:
    host:     "%ldap_hostname%"
    dn:       "%ldap_dn%"
    password: "%ldap_password%"
    base_dn:  "%ldap_base_dn%"
```

(optional) you can affect automatically a specific role to a user if the user got the ldap group in his memberOf ldap field.
add this at the end of the file app/config/config.yml :
```
# app/config/config.yml
...
# LdapUser
l3_ldap_user:
    roles:
        user: SPEALLPERS        # if the user got the group SPEALLPERS in this memberOf ldap field, he obtains automatically the role "ROLE_USER"
        admin: DSIAPP           # if the user got the group DSIAPP in this memberOf ldap field, he obtains automatically the role "ROLE_ADMIN"
```

And configure the firewall in order to use the user provider of this Bundle :
```
# app/config/security.yml
...
security:
    providers:
            ldap:
                id: ldap_user_provider
```

For Symfony 4 and 5 and 6 and 7 :
in the configuration file .env.local and .env, add this :
```
# .env.local 
# .env
...
###> l3/ldap-user-bundle ###
LDAP_HOSTNAME=ldap.univ.fr
LDAP_BASE_DN=dc=univ,dc=fr
LDAP_DN=cn=login,dc=univ,dc=fr
LDAP_PASSWORD=password
###You are not authorized to access to this application.
    {% elseif status_code == 404 %}
        
Page not found.
    {% else %}
        
The application returns an error "{{ status_code }} {{ status_text }}".
    {% endif %}
{% endblock %}
```

ORM LDAP functions
---
You can make custom ORM LDAP Entity through Doctrine ORM.
Just create your Entity like this Entity People in your application Bundle :
```
# src/YourApplicationBundle/Entity/People.php
cn[0];
    }

    public function getUid() {
        return $this->uid;
    }

    public function setUid($value) {
        $this->uid = $value;
        return $this;
    }

    public function getCn() {
        return $this->cn;
    }

    public function addCn($value) {
        $this->cn->add($value);
        return $this;
    }

    public function removeCn($value) {
        $this->cn->removeElement($value);
        return $this;
    }

    public function getSn() {
        return $this->sn;
    }

    public function addSn($value) {
        $this->sn->add($value);
        return $this;
    }

    public function removeSn($value) {
        $this->sn->removeElement($value);
        return $this;
    }

    public function getGivenName() {
        return $this->givenName;
    }

    public function setGivenName($value) {
        $this->givenName = $value;
        return $this;
    }

    public function getMail() {
        return $this->mail;
    }

    public function setMail($value) {
        $this->mail = $value;
        return $this;
    }

    public function addMemberOf($value) {
        $this->memberOf->add($value);
        return $this;
    }

    public function removeMemberOf($value) {
        $this->memberOf->removeElement($value);
        return $this;
    }

    public function getMemberOf() {
        return $this->memberOf;
    }

    public function getEduPersonPrimaryAffiliation() {
        return $this->eduPersonPrimaryAffiliation;
    }

    public function setEduPersonPrimaryAffiliation($value) {
        $this->eduPersonPrimaryAffiliation = $value;
        return $this;
    }

}
?>

• Dn : Use this annotation to build the dn with twig syntax
• Entity : Use this annotation to attribute to a php entity class an ldapObjectClass
• Column : Use this annotation to type the variable php
• Index : Use this annotation to set the index of the Entity

and in your Controller, you can read the LDAP with call your Entity like this :, _(*7)

# src/YourApplicationBundle/Controller/DefaultController.php
<?php
namespace YourApplicationBundle\Controller;
...
use YourApplication\Entity\People;
...
class DefaultController extends Controller {

    /**
     * @Route("/", name="homepage")
     */
    public function indexAction(Request $request)
    {
        ...
        // type of the people (student ? employee ? ..etc)
    $profil = $this->get('ldap_object.manager')->getRepository('YourApplicationBundle\Entity\People')->find($this->getUser()->getUid());     

        if ($profil != null){
            $profil = $profil->getEduPersonPrimaryAffiliation();
        }
    ...
    }
}

For Symfony 7 :, _(*8)

# src/YourApplicationBundle/Controller/DefaultController.php
<?php
namespace YourApplicationBundle\Controller;
...
use YourApplication\Entity\People;
...
class DefaultController extends Controller {
    /**
     * @Route("/", name="homepage")
     */
    #[Route('/', name='homepage')]
    public function indexAction(Request $request)
    {
        ...
        // type of the people (student ? employee ? ..etc)
        $profil = $this->get('ldap_object.manager')->getRepository('YourApplicationBundle\Entity\People')->find($this->getUser()->getUid());
        if ($profil != null){
            $profil = $profil->getEduPersonPrimaryAffiliation();
        }
        ...
    }
}

for write the LDAP, call your Entity like this :, _(*9)

# src/YourApplicationBundle/Controller/DefaultController.php
<?php
namespace YourApplicationBundle\Controller;
...
use YourApplication\Entity\People;
...
class DefaultController extends Controller {

    /**
     * @Route("/", name="homepage")
     */
    public function indexAction(Request $request)
    {
        ...
        $p = new People();
        $p->setUid('P7279');
        $p->setGivenName('Mathieu');
        $p->addSn('Hetru');
        $em = $this->get('ldap_object.manager');
        $em->persist($p);
        $em->flush();
        ...
    }
}

For symfony 7 :, _(*10)

# src/YourApplicationBundle/Controller/DefaultController.php
<?php
namespace YourApplicationBundle\Controller;
...
use YourApplication\Entity\People;
...
class DefaultController extends Controller {
    #[Route('/', name='homepage')]
    public function indexAction(Request $request)
    {
        ...
        $a = new People();
        $a->setUid('1940');
        $a->setGivenName('Mathieu');
        $a->addSn('Hetru');
        $em = $this->get('ldap_object.manager');
        $em->persist($a);
        $em->flush();
        ...
    }
}

Annotations

The Route annotations run if you install this package :, _(*11)

composer require doctrine/annotations