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

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;
  19. use Symfony\Component\HttpKernel\Kernel;
  21. /**
  22.  * This is the class that validates and merges configuration from your app/config files.
  23.  *
  24.  * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
  25.  */
  26. class Configuration implements ConfigurationInterface
  27. {
  28.     /**
  29.      * {@inheritdoc}
  30.      */
  31.     public function getConfigTreeBuilder()
  32.     {
  33.         $kernelVersion = Kernel::MAJOR_VERSION;
  35.         if ($kernelVersion >= 5) {
  36.             $treeBuilder = new TreeBuilder('alep_ldap');
  37.             $rootNode = $treeBuilder->getRootNode();
  38.         } else {
  39.             $treeBuilder = new TreeBuilder();
  40.             $rootNode = $treeBuilder->root('alep_ldap');
  41.         }
  43.         $rootNode
  44.             ->children()
  45.                 ->booleanNode('enabled')
  46.                     ->defaultValue(false)
  47.                 ->end()
  48.                 ->scalarNode('service')
  49.                     ->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.')
  50.                     ->isRequired()
  51.                     ->cannotBeEmpty()
  52.                     ->defaultValue('Symfony\Component\Ldap\Ldap')
  53.                 ->end()
  54.                 ->scalarNode('base_dn')
  55.                     ->info('This is the base DN for the directory')
  56.                     ->defaultNull()
  57.                 ->end()
  58.                 ->scalarNode('search_dn')
  59.                     ->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.')
  60.                     ->defaultNull()
  61.                 ->end()
  62.                 ->scalarNode('search_password')
  63.                     ->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.')
  64.                     ->defaultNull()
  65.                 ->end()
  66.                 ->arrayNode('default_roles')
  67.                     ->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.')
  68.                     ->scalarPrototype()->end()
  69.                 ->end()
  70.                 ->scalarNode('uid_key')
  71.                     ->info('This is the entry\'s key to use as its UID. Depends on your LDAP server implementation.')
  72.                     ->isRequired()
  73.                     ->cannotBeEmpty()
  74.                     ->defaultValue('sAMAccountName')
  75.                 ->end()
  76.                 ->scalarNode('filter')
  77.                     ->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.')
  78.                     ->isRequired()
  79.                     ->cannotBeEmpty()
  80.                     ->defaultValue('({uid_key}={username})')
  81.                 ->end()
  82.                 ->arrayNode('exclude')
  83.                     ->info('This is a list of usernames to exclude from LDAP authentication.')
  84.                     ->setDeprecated('The "%node%" option is deprecated. Use "exclude_rules" instead.')
  85.                     ->scalarPrototype()->end()
  86.                 ->end()
  87.                 ->arrayNode('exclude_rules')
  88.                     ->info('This is a list of usernames/roles to exclude from LDAP authentication (supports regular expressions).')
  89.                     ->children()
  90.                         ->arrayNode('users')->scalarPrototype()->end()->end()
  91.                         ->arrayNode('roles')->scalarPrototype()->end()->end()
  92.                     ->end()
  93.                 ->end()
  94.                 ->scalarNode('mapper')
  95.                     ->info('This is the data mapper service used to map ldap user data to Pimcore user.')
  96.                     ->cannotBeEmpty()
  97.                     ->defaultValue('Alep\LdapBundle\DataMapper\DefaultLdapUserMapper')
  98.                 ->end()
  99.                 ->scalarNode('logger')
  100.                     ->info('This is the logger service used by the bundle.')
  101.                 ->end()
  102.             ->end()
  103.         ;
  105.         return $treeBuilder;
  106.     }
  107. }