Switch to new oidcecho package.

Author: Anders Qvist

examples/api/main.go

@@ -143,9 +143,9 @@ func getHandler[T any](cfg shared.RuntimeConfig, claimsValidationFn options.Clai
 
 		return shared.RunGin[T](oidcHandler, cfg.Address, cfg.Port)
 	case shared.EchoJwtServer:
-		parseToken := oidcechojwt.New(claimsValidationFn, opts...)
+		oidcMiddleware := oidcechojwt.New(claimsValidationFn, opts...)
 
-		return shared.RunEchoJWT[T](parseToken, cfg.Address, cfg.Port)
+		return shared.RunEcho[T](oidcMiddleware, cfg.Address, cfg.Port)
 	case shared.FiberServer:
 		oidcHandler := oidcfiber.New(claimsValidationFn, opts...)
 

examples/shared/server_echo.go

@@ -0,0 +1,36 @@
+package shared
+
+import (
+	"fmt"
+	"net"
+	"net/http"
+
+	"github.com/labstack/echo/v4"
+	"github.com/labstack/echo/v4/middleware"
+)
+
+func newEchoClaimsHandler[T any](c echo.Context) error {
+	claims, ok := c.Get("user").(T)
+	if !ok {
+		return echo.NewHTTPError(http.StatusUnauthorized, "invalid token")
+	}
+
+	return c.JSON(http.StatusOK, claims)
+}
+
+func RunEcho[T any](oidcMiddleware echo.MiddlewareFunc, address string, port int) error {
+	e := echo.New()
+	e.HideBanner = true
+
+	e.Use(middleware.Logger())
+	e.Use(middleware.Recover())
+	e.Use(middleware.Secure())
+	e.Use(oidcMiddleware)
+
+	handler := newEchoClaimsHandler[T]
+
+	e.GET("/", handler)
+
+	addr := net.JoinHostPort(address, fmt.Sprintf("%d", port))
+	return e.Start(addr)
+}

examples/shared/server_echo_jwt.go

@@ -9,8 +9,6 @@ import (
 	"github.com/labstack/echo/v4/middleware"
 )
 
-type echoJWTParseTokenFunc func(auth string, c echo.Context) (interface{}, error)
-
 func newEchoJWTClaimsHandler[T any](c echo.Context) error {
 	claims, ok := c.Get("user").(T)
 	if !ok {
@@ -20,17 +18,14 @@ func newEchoJWTClaimsHandler[T any](c echo.Context) error {
 	return c.JSON(http.StatusOK, claims)
 }
 
-func RunEchoJWT[T any](parseToken echoJWTParseTokenFunc, address string, port int) error {
+func RunEchoJWT[T any](echoMiddleware echo.MiddlewareFunc, address string, port int) error {
 	e := echo.New()
 	e.HideBanner = true
 
 	e.Use(middleware.Logger())
 	e.Use(middleware.Recover())
 	e.Use(middleware.Secure())
-
-	e.Use(middleware.JWTWithConfig(middleware.JWTConfig{
-		ParseTokenFunc: parseToken,
-	}))
+	e.Use(echoMiddleware)
 
 	handler := newEchoJWTClaimsHandler[T]
 

oidcechojwt/echo_jwt.go

@@ -10,37 +10,41 @@ import (
 
 // New returns an OpenID Connect (OIDC) discovery `ParseTokenFunc`
 // to be used with the the echo `JWT` middleware.
-func New[T any](claimsValidationFn options.ClaimsValidationFn[T], setters ...options.Option) func(auth string, c echo.Context) (interface{}, error) {
+func New[T any](claimsValidationFn options.ClaimsValidationFn[T], setters ...options.Option) echo.MiddlewareFunc {
 	h, err := oidc.NewHandler(claimsValidationFn, setters...)
 	if err != nil {
 		panic(fmt.Sprintf("oidc discovery: %v", err))
 	}
 
-	return toEchoJWTParseTokenFunc(h.ParseToken, setters...)
+	return toEchoHandler(h.ParseToken, setters...)
 }
 
-type echoJWTParseTokenFunc func(auth string, c echo.Context) (interface{}, error)
-
 func onError(errorHandler options.ErrorHandler, description options.ErrorDescription, err error) {
 	if errorHandler != nil {
 		errorHandler(description, err)
 	}
 }
 
-func toEchoJWTParseTokenFunc[T any](parseToken oidc.ParseTokenFunc[T], setters ...options.Option) echoJWTParseTokenFunc {
+func toEchoHandler[T any](parseToken oidc.ParseTokenFunc[T], setters ...options.Option) echo.MiddlewareFunc {
 	opts := options.New(setters...)
 
-	echoJWTParseTokenFunc := func(auth string, c echo.Context) (interface{}, error) {
-		ctx := c.Request().Context()
-
-		claims, err := parseToken(ctx, auth)
-		if err != nil {
-			onError(opts.ErrorHandler, options.ParseTokenErrorDescription, err)
-			return nil, err
+	return func(next echo.HandlerFunc) echo.HandlerFunc {
+		return func(c echo.Context) error {
+			ctx := c.Request().Context()
+
+			tokenString, err := oidc.GetTokenString(c.Request().Header.Get, opts.TokenString)
+			if err != nil {
+				onError(opts.ErrorHandler, options.GetTokenErrorDescription, err)
+				return echo.ErrBadRequest
+			}
+
+			claims, err := parseToken(ctx, tokenString)
+			if err != nil {
+				onError(opts.ErrorHandler, options.ParseTokenErrorDescription, err)
+				return echo.ErrUnauthorized
+			}
+			c.Set(string(opts.ClaimsContextKeyName), claims)
+			return next(c)
 		}
-
-		return claims, nil
 	}
-
-	return echoJWTParseTokenFunc
 }

oidcechojwt/echo_jwt_test.go

@@ -13,7 +13,6 @@ import (
 	"github.com/xenitab/go-oidc-middleware/options"
 
 	"github.com/labstack/echo/v4"
-	"github.com/labstack/echo/v4/middleware"
 	"github.com/phayes/freeport"
 	"github.com/stretchr/testify/require"
 )
@@ -28,19 +27,17 @@ func BenchmarkSuite(b *testing.B) {
 	oidctesting.RunBenchmarks(b, testName, newTestHandler(b))
 }
 
-func testGetEchoRouter(tb testing.TB, parseToken echoJWTParseTokenFunc) *echo.Echo {
+func testGetEchoRouter(tb testing.TB, echoMiddleware echo.MiddlewareFunc) *echo.Echo {
 	tb.Helper()
 
 	e := echo.New()
 	e.HidePort = true
 	e.HideBanner = true
 
-	e.Use(middleware.JWTWithConfig(middleware.JWTConfig{
-		ParseTokenFunc: parseToken,
-	}))
+	e.Use(echoMiddleware)
 
 	e.GET("/", func(c echo.Context) error {
-		claims, ok := c.Get("user").(oidctesting.TestClaims)
+		claims, ok := c.Get("claims").(oidctesting.TestClaims)
 		if !ok {
 			return echo.NewHTTPError(http.StatusUnauthorized, "invalid token")
 		}
@@ -115,13 +112,13 @@ func (h *testHandler) NewHandlerFn(claimsValidationFn options.ClaimsValidationFn
 func (h *testHandler) ToHandlerFn(parseToken oidc.ParseTokenFunc[oidctesting.TestClaims], opts ...options.Option) http.Handler {
 	h.tb.Helper()
 
-	echoParseToken := toEchoJWTParseTokenFunc(parseToken, opts...)
-	return testGetEchoRouter(h.tb, echoParseToken)
+	echoMiddleware := toEchoHandler(parseToken, opts...)
+	return testGetEchoRouter(h.tb, echoMiddleware)
 }
 
 func (h *testHandler) NewTestServer(opts ...options.Option) oidctesting.ServerTester {
 	h.tb.Helper()
 
-	echoParseToken := New[oidctesting.TestClaims](nil, opts...)
-	return newTestServer(h.tb, testGetEchoRouter(h.tb, echoParseToken))
+	echoMiddleware := New[oidctesting.TestClaims](nil, opts...)
+	return newTestServer(h.tb, testGetEchoRouter(h.tb, echoMiddleware))
 }