Pass context and request to error handler.

Author: Anders Qvist

internal/oidctesting/tests.go

@@ -1,6 +1,7 @@
 package oidctesting
 
 import (
+	"context"
 	"fmt"
 	"net/http"
 	"net/http/httptest"
@@ -320,14 +321,14 @@ func runTestErrorHandler(t *testing.T, testName string, tester tester) {
 		}{
 			{
 				testDescription:    "no output",
-				errorHandler:       func(desc options.ErrorDescription, err error) *options.Response { return nil },
+				errorHandler:       func(ctx context.Context, request *options.OidcError) *options.Response { return nil },
 				expectStatusCode:   http.StatusBadRequest,
 				expectHeaders:      map[string]string{},
 				expectBodyContains: []byte{},
 			},
 			{
 				testDescription: "basic propagation",
-				errorHandler: func(desc options.ErrorDescription, err error) *options.Response {
+				errorHandler: func(ctx context.Context, request *options.OidcError) *options.Response {
 					return &options.Response{
 						StatusCode: 418,
 						Headers:    map[string]string{},
@@ -342,7 +343,7 @@ func runTestErrorHandler(t *testing.T, testName string, tester tester) {
 			},
 			{
 				testDescription: "additional header",
-				errorHandler: func(desc options.ErrorDescription, err error) *options.Response {
+				errorHandler: func(ctx context.Context, request *options.OidcError) *options.Response {
 					return &options.Response{
 						StatusCode: 418,
 						Headers:    map[string]string{"some": "header"},
@@ -358,7 +359,7 @@ func runTestErrorHandler(t *testing.T, testName string, tester tester) {
 			},
 			{
 				testDescription: "content type",
-				errorHandler: func(desc options.ErrorDescription, err error) *options.Response {
+				errorHandler: func(ctx context.Context, request *options.OidcError) *options.Response {
 					return &options.Response{
 						StatusCode: 418,
 						Headers:    map[string]string{"content-type": "application/json"},

oidcecho/echo.go

@@ -24,7 +24,13 @@ func onError(c echo.Context, errorHandler options.ErrorHandler, statusCode int,
 		c.Logger().Error(err)
 		return c.NoContent(statusCode)
 	}
-	response := errorHandler(description, err)
+	error := options.OidcError{
+		Url:     c.Request().URL,
+		Headers: c.Request().Header,
+		Status:  description,
+		Error:   err,
+	}
+	response := errorHandler(c.Request().Context(), &error)
 	if response == nil {
 		c.Logger().Error(err)
 		return c.NoContent(statusCode)

oidcfiber/fiber.go

@@ -2,6 +2,7 @@ package oidcfiber
 
 import (
 	"fmt"
+	"net/url"
 
 	"github.com/gofiber/fiber/v2"
 	"github.com/xenitab/go-oidc-middleware/internal/oidc"
@@ -23,7 +24,18 @@ func onError(c *fiber.Ctx, errorHandler options.ErrorHandler, statusCode int, de
 	if errorHandler == nil {
 		return c.SendStatus(statusCode)
 	}
-	response := errorHandler(description, err)
+	url, _ := url.Parse(c.OriginalURL())
+	headers := make(map[string][]string, 1)
+	for k, v := range c.GetReqHeaders() {
+		headers[k] = []string{v}
+	}
+	error := options.OidcError{
+		Url:     url,
+		Headers: headers,
+		Status:  description,
+		Error:   err,
+	}
+	response := errorHandler(c.Context(), &error)
 	if response == nil {
 		return c.SendStatus(statusCode)
 	}

oidcgin/gin.go

@@ -24,7 +24,14 @@ func onError(c *gin.Context, errorHandler options.ErrorHandler, statusCode int,
 	if errorHandler == nil {
 		return c.AbortWithError(statusCode, err)
 	}
-	response := errorHandler(description, err)
+
+	error := options.OidcError{
+		Url:     c.Request.URL,
+		Headers: c.Request.Header,
+		Status:  description,
+		Error:   err,
+	}
+	response := errorHandler(c.Request.Context(), &error)
 	if response == nil {
 		return c.AbortWithError(statusCode, err)
 	}

oidchttp/http.go

@@ -20,12 +20,18 @@ func New[T any](h http.Handler, claimsValidationFn options.ClaimsValidationFn[T]
 	return toHttpHandler(h, oidcHandler.ParseToken, setters...)
 }
 
-func onError(w http.ResponseWriter, errorHandler options.ErrorHandler, statusCode int, description options.ErrorDescription, err error) {
+func onError(r *http.Request, w http.ResponseWriter, errorHandler options.ErrorHandler, statusCode int, description options.ErrorDescription, err error) {
 	if errorHandler == nil {
 		w.WriteHeader(statusCode)
 		return
 	}
-	response := errorHandler(description, err)
+	error := options.OidcError{
+		Url:     r.URL,
+		Headers: r.Header,
+		Status:  description,
+		Error:   err,
+	}
+	response := errorHandler(r.Context(), &error)
 	if response == nil {
 		w.WriteHeader(statusCode)
 		return
@@ -46,13 +52,13 @@ func toHttpHandler[T any](h http.Handler, parseToken oidc.ParseTokenFunc[T], set
 
 		tokenString, err := oidc.GetTokenString(r.Header.Get, opts.TokenString)
 		if err != nil {
-			onError(w, opts.ErrorHandler, http.StatusBadRequest, options.GetTokenErrorDescription, err)
+			onError(r, w, opts.ErrorHandler, http.StatusBadRequest, options.GetTokenErrorDescription, err)
 			return
 		}
 
 		claims, err := parseToken(ctx, tokenString)
 		if err != nil {
-			onError(w, opts.ErrorHandler, http.StatusUnauthorized, options.ParseTokenErrorDescription, err)
+			onError(r, w, opts.ErrorHandler, http.StatusUnauthorized, options.ParseTokenErrorDescription, err)
 			return
 		}
 

options/options.go

@@ -1,10 +1,22 @@
 package options
 
 import (
+	"context"
 	"net/http"
+	"net/url"
 	"time"
 )
 
+// Context information for the error handler.
+type OidcError struct {
+	Url     *url.URL
+	Headers http.Header
+	Error   error
+	Status  ErrorDescription
+}
+
+// Error handlers are expected to produce an abstract HTTP response that
+// the framework adapter will render.
 type Response struct {
 	StatusCode int
 	Headers    map[string]string
@@ -36,7 +48,7 @@ type ClaimsContextKeyName string
 const DefaultClaimsContextKeyName ClaimsContextKeyName = "claims"
 
 // ErrorHandler is called by the middleware if not nil
-type ErrorHandler func(description ErrorDescription, err error) *Response
+type ErrorHandler func(ctx context.Context, request *OidcError) *Response
 
 // ErrorDescription is used to pass the description of the error to ErrorHandler
 type ErrorDescription string