Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Monogramm/MauticLdapAuthBundle

:elephant: :rocket: Enables LDAP authentication for mautic 2 and newer
https://github.com/Monogramm/MauticLdapAuthBundle

authentication ldap mautic mixins php plugin

Last synced: 30 days ago
JSON representation

:elephant: :rocket: Enables LDAP authentication for mautic 2 and newer

Host: GitHub
URL: https://github.com/Monogramm/MauticLdapAuthBundle
Owner: Monogramm
License: agpl-3.0
Created: 2019-04-02T15:51:14.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2022-09-04T17:42:00.000Z (over 2 years ago)
Last Synced: 2024-08-03T17:15:18.771Z (4 months ago)
Topics: authentication, ldap, mautic, mixins, php, plugin
Language: PHP
Homepage: https://github.com/mautic/mautic
Size: 364 KB
Stars: 11
Watchers: 6
Forks: 11
Open Issues: 4
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-mautic - Monogramm/MauticLdapAuthBundle - Enables LDAP authentication for mautic 2 and newer (Plugins)

README

        [![Packagist](https://img.shields.io/packagist/l/monogramm/mautic-ldap-auth-bundle.svg)](LICENSE)

[![Packagist Version](https://img.shields.io/packagist/v/monogramm/mautic-ldap-auth-bundle.svg)](https://packagist.org/packages/monogramm/mautic-ldap-auth-bundle)

[![Build Status](https://travis-ci.org/Monogramm/MauticLdapAuthBundle.svg)](https://travis-ci.org/Monogramm/MauticLdapAuthBundle)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Monogramm/MauticLdapAuthBundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Monogramm/MauticLdapAuthBundle/?branch=master)

[![mautic](https://img.shields.io/badge/mautic-%3E%3D%202.11-blue.svg)](https://www.mautic.org/mixin/ldapauth/)

# Mautic LDAP Authentication Plugin

This Plugin enables LDAP authentication for mautic 2 and newer. Even though Mautic offers SAML authentication, the main objective is to offer an alternative to those who do not want to setup SSO in their company just for mautic :smiley:

## Installation via composer (preferred)

Execute `composer require monogramm/mautic-ldap-auth-bundle` in the main directory of the mautic installation.

## Installation via .zip

1. Download the [master.zip](https://github.com/Monogramm/MauticLdapAuthBundle/archive/master.zip), extract it into the `plugins/` directory and rename the new directory to `MauticLdapAuthBundle`.

2. Install `symfony/ldap` requirements with composer: `composer require symfony/ldap:~2.8`

3. Clear the cache via console command `php app/console cache:clear --env=prod` (might take a while) *OR* manually delete the `app/cache/prod` directory.

## Configuration

Navigate to the Plugins page and click "Install/Upgrade Plugins". You should now see a "LDAP Auth" plugin.

-   ![LDAP Auth Plugin](docs/mautic_ldap_plugins_01.png)

-   ![LDAP Auth Plugin - Published](docs/mautic_ldap_plugins_02.png)

-   ![LDAP Auth Plugin - Features](docs/mautic_ldap_plugins_03.png)

After activating the plugin, you can now go to "Configuration > LDAP Settings" to edit the parameters:

![LDAP Settings](docs/mautic_ldap_settings_02.png)

You can also edit manually your parameters in `local.php` (adapt to your LDAP configuration):

```php

    //'parameters' => array(

    // ...

        'ldap_auth_host' => 'ldap.mysupercompany.com',

        'ldap_auth_port' => 389,

        'ldap_auth_version' => 3,

        'ldap_auth_ssl' => false,

        'ldap_auth_starttls' => true,

        'ldap_auth_base_dn' => 'ou=People,dc=ldap,dc=mysupercompany,dc=com',

        'ldap_auth_user_query' => '(objectclass=inetOrgPerson)',

        'ldap_auth_username_attribute' => 'uid',

        'ldap_auth_email_attribute' => 'mail',

        'ldap_auth_firstname_attribute' => 'givenname',

        'ldap_auth_lastname_attribute' => 'sn',

        'ldap_auth_fullname_attribute' => 'displayname',

        'ldap_auth_isactivedirectory' => false,

    // ...

```

A sample configuration for Active Directory is 

```php

    //'parameters' => array(

    // ...

        'ldap_auth_host' => 'ad.mysupercompany.com',

        'ldap_auth_port' => 389,

        'ldap_auth_version' => 3,

        'ldap_auth_ssl' => false,

        'ldap_auth_starttls' => false,

        'ldap_auth_base_dn' => 'cn=Users,dc=ad,dc=mysupercompany,dc=com',

        'ldap_auth_user_query' => '(objectclass=user)(memberof=marketing)',     // careful this can be case sensitive!

        'ldap_auth_username_attribute' => 'samaccountname',                     // this is case sensitive!

        'ldap_auth_email_attribute' => 'mail',

        'ldap_auth_firstname_attribute' => 'givenname',

        'ldap_auth_lastname_attribute' => 'sn',

        'ldap_auth_fullname_attribute' => 'displayname',

        'ldap_auth_isactivedirectory' => true,

        'ldap_auth_activedirectory_domain' => 'ad.mysupercompany.com',

    // ...

```

Once the parameters are set, open a new browser and check connection through LDAP. **Do not log out until LDAP configuration is valid!**

## Developments in progress

* Test LDAP Authentication settings

* LDAP bind account and Group management

## Contributing

Ideas and suggestions are welcome. Feel free to create an issue or PR on Github using our [CONTRIBUTING](CONTRIBUTING.md) guidelines.

## License

See [LICENSE](LICENSE) file.

## Author(s)

* [Monogramm](https://github.com/Monogramm)

## Awesome contributor(s)

* [terdinatore](https://github.com/terdinatore)