add hint to error logs

Author: pradtke

lib/Controller/OAuth2AccessTokenController.php

@@ -53,6 +53,7 @@ public function __invoke(ServerRequest $request): \Psr\Http\Message\ResponseInte
                         'errorDescription' => $e->getPayload()["error_description"],
                         'oidc' => [
                                 'endpoint' => 'token',
+                                'hint' => $e->getHint(),
                             ]
                     ]
                 );
@@ -64,13 +65,18 @@ public function __invoke(ServerRequest $request): \Psr\Http\Message\ResponseInte
         try {
             return $this->authorizationServer->respondToAccessTokenRequest($request, new Response());
         } catch (Exception $e) {
+            $hint = null;
+            if ($e instanceof OidcServerException) {
+                $hint = $e->getHint();
+            }
             MetricLogger::getInstance()->logMetric(
                 'oidc',
                 'error',
                 [
                     'message' => $e->getMessage(),
                     'oidc' => [
                             'endpoint' => 'token',
+                            'hint' => $hint,
                             'clientId' => $this->getClientIdFromTokenRequest($request),
                             'grantType' => $this->getRequestParameter("grant_type", $request)
                         ]

lib/Controller/OAuth2AuthorizationController.php

@@ -87,16 +87,21 @@ public function __invoke(ServerRequest $request): ResponseInterface
         } catch (Exception $e) {
             if (!($e instanceof BadRequest)) {
                 $queryParams = $request->getQueryParams();
-                $scope = $queryParams['scope'];
+                $scope = $queryParams['scope'] ?? "";
+                $hint = null;
+                if ($e instanceof OidcServerException) {
+                    $hint = $e->getHint();
+                }
                 MetricLogger::getInstance()->logMetric(
                     'oidc',
                     'error',
                     [
                         'message' => $e->getMessage(),
-                        'clientId' => $queryParams['client_id'],
+                        'clientId' => $queryParams['client_id'] ?? null,
                         'scopes' => ($scope === null || $scope === "") ? [] : explode(" ", $scope),
                         'oidc' => [
                                 'endpoint' => 'authorize',
+                                'hint' => $hint,
                             ]
                             // authorize endpoint doesn't contain secrets so okay to log all params
                             + $queryParams

lib/Controller/OpenIdConnectUserInfoController.php

@@ -87,6 +87,7 @@ public function __invoke(ServerRequest $request): Response
                         'errorDescription' => $e->getPayload()["error_description"],
                         'oidc' => [
                                 'endpoint' => 'userinfo',
+                                'hint' => $e->getHint(),
                             ]
                     ]
                 );
@@ -128,14 +129,19 @@ public function __invoke(ServerRequest $request): Response
 
             return new JsonResponse($claims);
         } catch (Exception $e) {
+            $hint = null;
+            if ($e instanceof OidcServerException) {
+                $hint = $e->getHint();
+            }
             MetricLogger::getInstance()->logMetric(
                 'oidc',
                 'error',
                 [
                     'message' => $e->getMessage(),
                     'oidc' => [
                             'endpoint' => 'userinfo',
-                            'tokenId' => $tokenId
+                            'tokenId' => $tokenId,
+                            'hint' => $hint,
                         ]
 
                 ]