Feature/issue 1971 correlation id logging (#1981)

Add correlation ID to SAML flow log tracing
 
Assigns a correlation ID at the start of each SAML authentication flow and propagates it through all four legs (SSO, continue to IdP, assertion consumer, consent) so that log entries across the full flow can be correlated. The ID is also shown on the feedback/error page.

Resolves #1971

Author: kayjoosten

config/packages/ci/monolog.yaml

@@ -0,0 +1,7 @@
+monolog:
+    handlers:
+        test_log_file:
+            type: stream
+            path: '/tmp/eb-fixtures/log-records.ndjson'
+            level: debug
+            formatter: monolog.formatter.json

config/packages/test/monolog.yaml

@@ -12,3 +12,4 @@ monolog:
             type:   stream
             path:   "%kernel.logs_dir%/%kernel.environment%.log"
             level:  DEBUG
+

config/services/ci/services.yml

@@ -154,3 +154,4 @@ services:
         arguments:
             - "@request_stack"
             - "%global.site_notice.allowed.tags%"
+

config/services/compat.yml

@@ -59,3 +59,9 @@ services:
     engineblock.compat.attribute_release_policy_enforcer:
         public: false
         class: EngineBlock_Arp_AttributeReleasePolicyEnforcer
+
+    EngineBlock_Saml2_AuthnRequestSessionRepository:
+        class: EngineBlock_Saml2_AuthnRequestSessionRepository
+        public: true
+        arguments:
+            - '@request_stack'

config/services/controllers/authentication.yml

@@ -33,6 +33,7 @@ services:
             - '@translator'
             - '@twig'
             - '@OpenConext\EngineBlock\Service\FeedbackStateHelper'
+            - '@OpenConext\EngineBlock\Request\CurrentCorrelationId'
 
     OpenConext\EngineBlockBundle\Controller\MetadataController:
         arguments:

config/services/logging.yml

@@ -30,6 +30,12 @@ services:
         tags:
             - { name: monolog.processor }
 
+    OpenConext\EngineBlock\Logger\Processor\CorrelationIdProcessor:
+        arguments:
+            - '@OpenConext\EngineBlock\Request\CurrentCorrelationId'
+        tags:
+            - { name: monolog.processor }
+
     OpenConext\EngineBlock\Logger\Processor\SessionIdProcessor:
         tags:
             - { name: monolog.processor }

config/services/services.yml

@@ -68,6 +68,20 @@ services:
             - '@OpenConext\EngineBlock\Request\UniqidGenerator'
         public: true
 
+    OpenConext\EngineBlock\Request\CurrentCorrelationId:
+        public: true
+
+    OpenConext\EngineBlock\Request\CorrelationIdRepository:
+        public: true
+        arguments:
+            - '@request_stack'
+
+    OpenConext\EngineBlock\Request\CorrelationIdService:
+        public: true
+        arguments:
+            - '@OpenConext\EngineBlock\Request\CorrelationIdRepository'
+            - '@OpenConext\EngineBlock\Request\CurrentCorrelationId'
+
     OpenConext\EngineBlockBundle\Security\Http\EntryPoint\JsonBasicAuthenticationEntryPoint:
         arguments:
             - 'engine-api.%domain%'

config/services_ci.yaml

@@ -68,6 +68,11 @@ services:
     OpenConext\EngineBlockFunctionalTestingBundle\Features\Context\MinkContext:
         tags: ['fob.context']
 
+    OpenConext\EngineBlockFunctionalTestingBundle\Features\Context\LoggingContext:
+        arguments:
+            $logFile: '/tmp/eb-fixtures/log-records.ndjson'
+        tags: ['fob.context']
+
     OpenConext\EngineBlockFunctionalTestingBundle\Fixtures\SbsClientStateManager:
         arguments:
             - "@engineblock.functional_testing.data_store.sbs_client_state_mananger"

languages/messages.en.php

@@ -49,6 +49,7 @@
 
         // Feedback
     'requestId'             => 'UR ID',
+    'correlationId'         => 'CID',
     'identityProvider'      => 'IdP',
     'serviceProvider'       => 'SP',
     'serviceProviderName'   => 'SP Name',

languages/messages.nl.php

@@ -49,6 +49,7 @@
 
      // Feedback
     'requestId'             => 'UR ID',
+    'correlationId'         => 'CID',
     'identityProvider'      => 'IdP',
     'serviceProvider'       => 'SP',
     'serviceProviderName'   => 'SP Name',