Use custom validation for authentication plugin

Author: Nyholm

DependencyInjection/Configuration.php

@@ -120,21 +120,7 @@ protected function configurePlugins(ArrayNodeDefinition $root)
             ->arrayNode('plugins')
                 ->addDefaultsIfNotSet()
                 ->children()
-                    ->arrayNode('authentication')
-                        ->useAttributeAsKey('name')
-                        ->prototype('array')
-                            ->children()
-                                ->enumNode('type')
-                                    ->values(['basic', 'bearer', 'wsse'])
-                                    ->isRequired()
-                                    ->cannotBeEmpty()
-                                ->end()
-                                ->scalarNode('username')->end()
-                                ->scalarNode('password')->end()
-                                ->scalarNode('token')->end()
-                            ->end()
-                        ->end()
-                    ->end() // End authentication plugin
+                    ->append($this->addAuthenticationPluiginNode())
 
                     ->arrayNode('cache')
                     ->canBeEnabled()
@@ -239,4 +225,62 @@ protected function configurePlugins(ArrayNodeDefinition $root)
             ->end()
         ->end();
     }
+
+    /**
+     * Add configuration for authentication plugin.
+     *
+     * @return ArrayNodeDefinition|\Symfony\Component\Config\Definition\Builder\NodeDefinition
+     */
+    private function addAuthenticationPluiginNode()
+    {
+        $builder = new TreeBuilder();
+        $node = $builder->root('authentication');
+        $node
+            ->useAttributeAsKey('name')
+            ->prototype('array')
+                ->validate()
+                    ->always()
+                    ->then(function ($config) {
+                        switch ($config['type']) {
+                            case 'basic':
+                                if (empty($config['username']) || empty($config['password'])) {
+                                    throw new InvalidConfigurationException('Authentication "basic" requires both "username" and "password".');
+                                }
+                                break;
+                            case 'bearer':
+                                if (empty($config['bearer'])) {
+                                    throw new InvalidConfigurationException('Authentication "bearer" requires a "token".');
+                                }
+                                break;
+                            case 'service':
+                                if (empty($config['service'])) {
+                                    throw new InvalidConfigurationException('Authentication "service" requires a "service".');
+                                }
+                                break;
+                            case 'wsse':
+                                if (empty($config['username']) || empty($config['password'])) {
+                                    throw new InvalidConfigurationException('Authentication "wsse" requires both "username" and "password".');
+                                }
+                                break;
+                        }
+
+                        return $config;
+                    })
+                ->end()
+                ->children()
+                    ->enumNode('type')
+                        ->values(['basic', 'bearer', 'wsse', 'service'])
+                        ->isRequired()
+                        ->cannotBeEmpty()
+                    ->end()
+                    ->scalarNode('username')->end()
+                    ->scalarNode('password')->end()
+                    ->scalarNode('token')->end()
+                    ->scalarNode('service')->end()
+                    ->end()
+                ->end()
+            ->end(); // End authentication plugin
+
+        return $node;
+    }
 }

DependencyInjection/HttplugExtension.php

@@ -178,43 +178,30 @@ private function configureAuthentication(ContainerBuilder $container, array $con
     {
         foreach ($config as $name => $values) {
             $authServiceKey = sprintf('httplug.plugin.authentication.%s.auth', $name);
-            if ($values['type'] === 'bearer') {
-                $this->validateAuthenticationConfiguration($values, 'bearer', $name, ['token']);
-                $container->register($authServiceKey, Bearer::class)
-                    ->addArgument($values['token']);
-            } elseif ($values['type'] === 'basic') {
-                $this->validateAuthenticationConfiguration($values, 'bearer', $name, ['username', 'password']);
-                $container->register($authServiceKey, BasicAuth::class)
-                    ->addArgument($values['username'])
-                    ->addArgument($values['password']);
-            } elseif ($values['type'] === 'wsse') {
-                $this->validateAuthenticationConfiguration($values, 'bearer', $name, ['username', 'password']);
-                $container->register($authServiceKey, Wsse::class)
-                    ->addArgument($values['username'])
-                    ->addArgument($values['password']);
-            } else {
-                throw new \LogicException(sprintf('Unknown authentication type: "%s"', $values['type']));
+            switch ($values['type']) {
+                case 'bearer':
+                    $container->register($authServiceKey, Bearer::class)
+                        ->addArgument($values['token']);
+                    break;
+                case 'basic':
+                    $container->register($authServiceKey, BasicAuth::class)
+                        ->addArgument($values['username'])
+                        ->addArgument($values['password']);
+                    break;
+                case 'wsse':
+                    $container->register($authServiceKey, Wsse::class)
+                        ->addArgument($values['username'])
+                        ->addArgument($values['password']);
+                    break;
+                case 'service':
+                    $authServiceKey = $values['service'];
+                    break;
+                default:
+                    throw new \LogicException(sprintf('Unknown authentication type: "%s"', $values['type']));
             }
 
             $container->register('httplug.plugin.authentication.'.$name, AuthenticationPlugin::class)
                 ->addArgument(new Reference($authServiceKey));
         }
     }
-
-    /**
-     * Throw a Logic error with a descriptive error if some configuration is missing.
-     *
-     * @param array  $config
-     * @param string $authType
-     * @param string $type
-     * @param array  $names
-     */
-    private function validateAuthenticationConfiguration(array $config, $type, $authType, array $names)
-    {
-        foreach ($names as $name) {
-            if (empty($config[$name])) {
-                throw new \LogicException(sprintf('When using %s ahtnetication you must configure a value for "httplug.plugins.authentication.%s.%s".', $type, $authType, $name));
-            }
-        }
-    }
 }

README.md

@@ -143,15 +143,18 @@ httpug:
         authentication:
             my_basic:
                 type: 'basic'
-                username: 'foo'
-                password: 'bar'
+                username: 'my_username'
+                password: 'p4ssw0rd'
             my_wsse:
                 type: 'wsse'
-                username: 'foo'
-                password: 'bar'
+                username: 'my_username'
+                password: 'p4ssw0rd'
             my_brearer:
                 type: 'bearer'
-                token: 'foo'
+                token: 'authentication_token_hash'
+            my_service:
+                type: 'service'
+                service: 'my_authentication_service'
 
     clients:
         acme: