vendor/blackbit_digital_commerce/pimcore-ldap/src/DependencyInjection/Configuration.php line 33

Open in your IDE?
  1. <?php
  3. /**
  4.  * GMDE S.R.L.
  5.  *
  6.  * This source file is subject to the GNU General Public License version 3 (GPLv3)
  7.  * For the full copyright and license information, please view the LICENSE.md and gpl-3.0.txt
  8.  * files that are distributed with this source code.
  9.  *
  10.  * @copyright  Copyright (c) 2018 GMDE S.R.L. (https://www.gmde.it)
  11.  * @license    GNU General Public License version 3 (GPLv3)
  12.  * @author     Alessandro Pozzi (a.pozzi@gmde.it)
  13.  */
  15. namespace Alep\LdapBundle\DependencyInjection;
  17. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  18. use Symfony\Component\Config\Definition\ConfigurationInterface;
  20. /**
  21.  * This is the class that validates and merges configuration from your app/config files.
  22.  *
  23.  * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
  24.  */
  25. class Configuration implements ConfigurationInterface
  26. {
  27.     /**
  28.      * {@inheritdoc}
  29.      */
  30.     public function getConfigTreeBuilder()
  31.     {
  32.         $treeBuilder = new TreeBuilder();
  33.         $rootNode = $treeBuilder->root('alep_ldap');
  35.         $rootNode
  36.             ->children()
  37.                 ->booleanNode('enabled')
  38.                     ->defaultValue(false)
  39.                 ->end()
  40.                 ->scalarNode('service')
  41.                     ->info('This is the name of your configured LDAP client. You can freely chose the name, but it must be unique in your application and it cannot start with a number or contain white spaces.')
  42.                     ->isRequired()
  43.                     ->cannotBeEmpty()
  44.                     ->defaultValue('Symfony\Component\Ldap\Ldap')
  45.                 ->end()
  46.                 ->scalarNode('base_dn')
  47.                     ->info('This is the base DN for the directory')
  48.                     ->defaultNull()
  49.                 ->end()
  50.                 ->scalarNode('search_dn')
  51.                     ->info('This is your read-only user\'s DN, which will be used to authenticate against the LDAP server in order to fetch the user\'s information.')
  52.                     ->defaultNull()
  53.                 ->end()
  54.                 ->scalarNode('search_password')
  55.                     ->info('This is your read-only user\'s password, which will be used to authenticate against the LDAP server in order to fetch the user\'s information.')
  56.                     ->defaultNull()
  57.                 ->end()
  58.                 ->arrayNode('default_roles')
  59.                     ->info('This is the default roles you wish to give to a user fetched from the LDAP server. If you do not configure this key, your users won\'t have any roles, and will not be considered as authenticated fully.')
  60.                     ->scalarPrototype()->end()
  61.                 ->end()
  62.                 ->scalarNode('uid_key')
  63.                     ->info('This is the entry\'s key to use as its UID. Depends on your LDAP server implementation.')
  64.                     ->isRequired()
  65.                     ->cannotBeEmpty()
  66.                     ->defaultValue('sAMAccountName')
  67.                 ->end()
  68.                 ->scalarNode('filter')
  69.                     ->info('This key lets you configure which LDAP query will be used. The {uid_key} string will be replaced by the value of the uid_key configuration value (by default, sAMAccountName), and the {username} string will be replaced by the username you are trying to load.')
  70.                     ->isRequired()
  71.                     ->cannotBeEmpty()
  72.                     ->defaultValue('({uid_key}={username})')
  73.                 ->end()
  74.                 ->arrayNode('exclude')
  75.                     ->info('This is a list of usernames to exclude from LDAP authentication.')
  76.                     ->setDeprecated('The "%node%" option is deprecated. Use "exclude_rules" instead.')
  77.                     ->scalarPrototype()->end()
  78.                 ->end()
  79.                 ->arrayNode('exclude_rules')
  80.                     ->info('This is a list of usernames/roles to exclude from LDAP authentication (supports regular expressions).')
  81.                     ->children()
  82.                         ->arrayNode('users')->scalarPrototype()->end()->end()
  83.                         ->arrayNode('roles')->scalarPrototype()->end()->end()
  84.                     ->end()
  85.                 ->end()
  86.                 ->scalarNode('mapper')
  87.                     ->info('This is the data mapper service used to map ldap user data to Pimcore user.')
  88.                     ->cannotBeEmpty()
  89.                     ->defaultValue('Alep\LdapBundle\DataMapper\DefaultLdapUserMapper')
  90.                 ->end()
  91.                 ->scalarNode('logger')
  92.                     ->info('This is the logger service used by the bundle.')
  93.                 ->end()
  94.             ->end()
  95.         ;
  97.         return $treeBuilder;
  98.     }
  99. }