Merge pull request #438 from pocivaneuh/authentication-header

feat: header authentication service configuration

Author: dbu

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.
 
+- Added configuration for the `header` authentication plugin (#437).
+
 # 1.30.1 - 2023-09-07
 
 - Added alias to allow autowiring the `AsyncHttpClient` interface (#436).

composer.json

@@ -31,7 +31,7 @@
         "php-http/discovery": "^1.14",
         "php-http/httplug": "^2.0",
         "php-http/logger-plugin": "^1.1",
-        "php-http/message": "^1.4",
+        "php-http/message": "^1.9",
         "php-http/message-factory": "^1.0.2",
         "php-http/stopwatch-plugin": "^1.2",
         "psr/http-message": "^1.0 || ^2.0",

src/DependencyInjection/Configuration.php

@@ -662,6 +662,10 @@ private function createAuthenticationPluginNode(): NodeDefinition
                             case 'query_param':
                                 $this->validateAuthenticationType(['params'], $config, 'query_param');
 
+                                break;
+                            case 'header':
+                                $this->validateAuthenticationType(['header_name', 'header_value'], $config, 'header');
+
                                 break;
                         }
 
@@ -670,14 +674,16 @@ private function createAuthenticationPluginNode(): NodeDefinition
                 ->end()
                 ->children()
                     ->enumNode('type')
-                        ->values(['basic', 'bearer', 'wsse', 'service', 'query_param'])
+                        ->values(['basic', 'bearer', 'wsse', 'service', 'query_param', 'header'])
                         ->isRequired()
                         ->cannotBeEmpty()
                     ->end()
                     ->scalarNode('username')->end()
                     ->scalarNode('password')->end()
                     ->scalarNode('token')->end()
                     ->scalarNode('service')->end()
+                    ->scalarNode('header_name')->end()
+                    ->scalarNode('header_value')->end()
                     ->arrayNode('params')->prototype('scalar')->end()
                     ->end()
                 ->end()

src/DependencyInjection/HttplugExtension.php

@@ -18,6 +18,7 @@
 use Http\Client\Plugin\Vcr\ReplayPlugin;
 use Http\Message\Authentication\BasicAuth;
 use Http\Message\Authentication\Bearer;
+use Http\Message\Authentication\Header;
 use Http\Message\Authentication\QueryParam;
 use Http\Message\Authentication\Wsse;
 use Http\Mock\Client as MockClient;
@@ -380,6 +381,12 @@ private function configureAuthentication(ContainerBuilder $container, array $con
                     $container->register($authServiceKey, QueryParam::class)
                         ->addArgument($values['params']);
 
+                    break;
+                case 'header':
+                    $container->register($authServiceKey, Header::class)
+                        ->addArgument($values['header_name'])
+                        ->addArgument($values['header_value']);
+
                     break;
                 case 'service':
                     $authServiceKey = $values['service'];

tests/Resources/Fixtures/config/full.php

@@ -96,6 +96,11 @@
                 'type' => 'bearer',
                 'token' => 'foo',
             ],
+            'my_header' => [
+                'type' => 'header',
+                'header_name' => 'foo',
+                'header_value' => 'bar',
+            ],
             'my_service' => [
                 'type' => 'service',
                 'service' => 'my_auth_service',

tests/Resources/Fixtures/config/full.xml

@@ -58,6 +58,7 @@
                 <my_basic type="basic" username="foo" password="bar"/>
                 <my_wsse type="wsse" username="foo" password="bar"/>
                 <my_bearer type="bearer" token="foo"/>
+                <my_header type="header" header_name="foo" header_value="bar" />
                 <my_service type="service" service="my_auth_service"/>
             </authentication>
             <cache cache-pool="my_cache_pool" stream-factory="my_other_stream_factory">

tests/Resources/Fixtures/config/full.yml

@@ -65,6 +65,10 @@ httplug:
             my_bearer:
                 type: bearer
                 token: foo
+            my_header:
+                type: header
+                header_name: foo
+                header_value: bar
             my_service:
                 type: service
                 service: my_auth_service

tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -244,6 +244,12 @@ public function testSupportsAllConfigFormats(): void
                         'token' => 'foo',
                         'params' => [],
                     ],
+                    'my_header' => [
+                        'type' => 'header',
+                        'header_name' => 'foo',
+                        'header_value' => 'bar',
+                        'params' => [],
+                    ],
                     'my_service' => [
                         'type' => 'service',
                         'service' => 'my_auth_service',