Merge pull request #261 from XenitAB/echo-no-jwt-pt-3

Correcting mis-merge on #260

Author: Bittrance

README.md

@@ -206,13 +206,13 @@ func newClaimsHandler() fiber.Handler {
 
 **Import**
 
-`"github.com/xenitab/go-oidc-middleware/oidcechojwt"`
+`"github.com/xenitab/go-oidc-middleware/oidcecho"`
 
 **Middleware**
 
 ```go
 e.Use(middleware.JWTWithConfig(middleware.JWTConfig{
-    ParseTokenFunc: oidcechojwt.New(
+    ParseTokenFunc: oidcecho.New(
 		GetAzureADClaimsValidationFn(cfg.TenantID),
 		options.WithIssuer(cfg.Issuer),
 		options.WithRequiredTokenType("JWT"),

examples/README.md

@@ -14,7 +14,7 @@ There's a CLI utility that makes it easy to use the different OpenID Providers (
 
 ## Providers
 
-When starting the api for one of the providers, change `[server]` to one of: `http`, `echojwt`, `gin` or `fiber`
+When starting the api for one of the providers, change `[server]` to one of: `http`, `echo`, `gin` or `fiber`
 
 ### Azure AD
 

examples/api/main.go

@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/xenitab/go-oidc-middleware/oidcechojwt"
+	"github.com/xenitab/go-oidc-middleware/oidcecho"
 	"github.com/xenitab/go-oidc-middleware/oidcfiber"
 	"github.com/xenitab/go-oidc-middleware/oidcgin"
 	"github.com/xenitab/go-oidc-middleware/oidchttp"
@@ -142,10 +142,10 @@ func getHandler[T any](cfg shared.RuntimeConfig, claimsValidationFn options.Clai
 		oidcHandler := oidcgin.New(claimsValidationFn, opts...)
 
 		return shared.RunGin[T](oidcHandler, cfg.Address, cfg.Port)
-	case shared.EchoJwtServer:
-		parseToken := oidcechojwt.New(claimsValidationFn, opts...)
+	case shared.EchoServer:
+		oidcMiddleware := oidcecho.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/go.mod

@@ -3,11 +3,11 @@ module examples
 go 1.20
 
 require (
-	github.com/xenitab/go-oidc-middleware v0.0.40
-	github.com/xenitab/go-oidc-middleware/oidcechojwt v0.0.40
-	github.com/xenitab/go-oidc-middleware/oidcfiber v0.0.40
-	github.com/xenitab/go-oidc-middleware/oidcgin v0.0.40
-	github.com/xenitab/go-oidc-middleware/oidchttp v0.0.40
+	github.com/xenitab/go-oidc-middleware v0.0.41
+	github.com/xenitab/go-oidc-middleware/oidcecho v0.0.41
+	github.com/xenitab/go-oidc-middleware/oidcfiber v0.0.41
+	github.com/xenitab/go-oidc-middleware/oidcgin v0.0.41
+	github.com/xenitab/go-oidc-middleware/oidchttp v0.0.41
 )
 
 require (

examples/go.sum

@@ -137,16 +137,16 @@ github.com/valyala/fasttemplate v1.2.2/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+
 github.com/valyala/tcplisten v1.0.0 h1:rBHj/Xf+E1tRGZyWIWwJDiRY0zc1Js+CV5DqwacVSA8=
 github.com/valyala/tcplisten v1.0.0/go.mod h1:T0xQ8SeCZGxckz9qRXTfG43PvQ/mcWh7FwZEA7Ioqkc=
 github.com/xenitab/dispans v0.0.10 h1:S+gSUM14rDJWK7MYNrjb8JbjeQPip6mlNJyLX+g7Agc=
-github.com/xenitab/go-oidc-middleware v0.0.40 h1:9VvTv5Gxqlhl3Ltkr5tNEm64rQzZ2qgS/Qsty9BQRos=
-github.com/xenitab/go-oidc-middleware v0.0.40/go.mod h1:ir5fF6tpCQSHauFEfLaHbmND9pHEEaXHQqpjiOK+PY0=
-github.com/xenitab/go-oidc-middleware/oidcechojwt v0.0.40 h1:WuckYOQLhBBE82pyW46VTs/nrjsTF6rnNAGbGQVLWI0=
-github.com/xenitab/go-oidc-middleware/oidcechojwt v0.0.40/go.mod h1:QxbHd00onC7VW/omCr349G3csMT/ZoM3l3aA9H3SX5U=
-github.com/xenitab/go-oidc-middleware/oidcfiber v0.0.40 h1:dadtglqQORdriQ2XoD1tKMzf85qEwRID1hvanbUohy0=
-github.com/xenitab/go-oidc-middleware/oidcfiber v0.0.40/go.mod h1:24S2V8nVaIRIcwysMBhO39zagXQlx3zXF1aqrKk65qQ=
-github.com/xenitab/go-oidc-middleware/oidcgin v0.0.40 h1:31eDSFGXZeG5JIRKLfr2CniJZC6rNHsLjFKos3u9+Lc=
-github.com/xenitab/go-oidc-middleware/oidcgin v0.0.40/go.mod h1:wuTWzXwEgdL3HyIn2R78WcEnbDCO4H/w6yGukj1K1Vg=
-github.com/xenitab/go-oidc-middleware/oidchttp v0.0.40 h1:Abney1IoiRmiip0gyZU/R1vRUGuZ1cz+kUa6VKeMgyA=
-github.com/xenitab/go-oidc-middleware/oidchttp v0.0.40/go.mod h1:CA0TBPlEOWdyGyMZN0NRHAIVpvy+dN20rNVp+Fyx3Jo=
+github.com/xenitab/go-oidc-middleware v0.0.41 h1:k37zfu3fyRKlrD+B+abcgbIUOU2cSjPE7xaFpgA8TJM=
+github.com/xenitab/go-oidc-middleware v0.0.41/go.mod h1:+menF2rCe5yqS4jpVEtR0JgQS3dPZHuwty+4PQ4BbrE=
+github.com/xenitab/go-oidc-middleware/oidcecho v0.0.41 h1:KPLBAYKNtrMoc5wEu9+RAF1Wh165/8UsNSRl6Nf/zDo=
+github.com/xenitab/go-oidc-middleware/oidcecho v0.0.41/go.mod h1:AysP3bzlLWvnTF14MD8/O/ruwAisCr/da+BVhMwXuww=
+github.com/xenitab/go-oidc-middleware/oidcfiber v0.0.41 h1:VPZ4vMX8I4Yp0SyiV5MfhcYW1JcPvvO1X67A/E5DlBQ=
+github.com/xenitab/go-oidc-middleware/oidcfiber v0.0.41/go.mod h1:Vz754/FVFb2WLaMzFbqijZryHOlR+RF0v42Wb5/6amo=
+github.com/xenitab/go-oidc-middleware/oidcgin v0.0.41 h1:GVXQFNqS2YvXhG0XoSFbx4Y1WHd9Gn2hA1LiEAsdcxk=
+github.com/xenitab/go-oidc-middleware/oidcgin v0.0.41/go.mod h1:CAYeVCveJtDtreDBoYy4Rr/t00i5/knF18reUVS7uRE=
+github.com/xenitab/go-oidc-middleware/oidchttp v0.0.41 h1:K/x3LWOAs9NBq8XUpfSHmZzCFXvdyFvws6+DRT6Hx04=
+github.com/xenitab/go-oidc-middleware/oidchttp v0.0.41/go.mod h1:yc5BNJMcUiGNkNieA+o6vn0dypahn1t2XztjUXkC15Y=
 github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
 go.uber.org/atomic v1.7.0 h1:ADUqmZGgLDDfbSL9ZmPxKTybcoEYHgpYfELNoN+7hsw=

examples/shared/runtime.go

@@ -11,18 +11,18 @@ import (
 type Server string
 
 const (
-	HttpServer    Server = "http"
-	GinServer     Server = "gin"
-	EchoJwtServer Server = "echojwt"
-	FiberServer   Server = "fiber"
+	HttpServer  Server = "http"
+	GinServer   Server = "gin"
+	EchoServer  Server = "echo"
+	FiberServer Server = "fiber"
 )
 
 func (s Server) Validate() error {
 	switch s {
-	case HttpServer, GinServer, EchoJwtServer, FiberServer:
+	case HttpServer, GinServer, EchoServer, FiberServer:
 		return nil
 	default:
-		return fmt.Errorf("not a supported server (%s), use one of: http, gin, echojwt, fiber", s)
+		return fmt.Errorf("not a supported server (%s), use one of: http, gin, echo, fiber", s)
 	}
 }
 

examples/shared/server_echo_jwt.go examples/shared/server_echo.goexamples/shared/server_echo_jwt.go renamed to examples/shared/server_echo.go

@@ -9,9 +9,7 @@ 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 {
+func newEchoClaimsHandler[T any](c echo.Context) error {
 	claims, ok := c.Get("user").(T)
 	if !ok {
 		return echo.NewHTTPError(http.StatusUnauthorized, "invalid token")
@@ -20,19 +18,16 @@ 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 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)
 
-	e.Use(middleware.JWTWithConfig(middleware.JWTConfig{
-		ParseTokenFunc: parseToken,
-	}))
-
-	handler := newEchoJWTClaimsHandler[T]
+	handler := newEchoClaimsHandler[T]
 
 	e.GET("/", handler)
 

go.work

@@ -5,7 +5,6 @@ use (
 	./examples
 	./internal/coverage
 	./oidcecho
-	./oidcechojwt
 	./oidcfiber
 	./oidcgin
 	./oidchttp

go.work.sum

@@ -7,6 +7,7 @@ github.com/ugorji/go v1.2.7 h1:qYhyWUUd6WbiM+C6JZAUkIJt/1WrjzNHY9+KCIjVqTo=
 github.com/valyala/fasthttp v1.41.0/go.mod h1:f6VbjjoI3z1NDOZOv17o6RvtRSWxC77seBFc2uWtgiY=
 github.com/xenitab/go-oidc-middleware v0.0.28/go.mod h1:TSn3/nWnymRRFTLJ5GVJ88001QgqTRFr5wcd8kOJ/kY=
 github.com/xenitab/go-oidc-middleware v0.0.33/go.mod h1:0TK8rKoVii+Z7iRdDvL1s2aN2EL7rZ3S7veae1vJzK8=
+github.com/xenitab/go-oidc-middleware v0.0.41/go.mod h1:+menF2rCe5yqS4jpVEtR0JgQS3dPZHuwty+4PQ4BbrE=
 github.com/xenitab/go-oidc-middleware/oidcechojwt v0.0.28/go.mod h1:SzCZBr0zP5VJGt2AgHyYtdgQdN+rce0ImUIUgwCx2gk=
 github.com/xenitab/go-oidc-middleware/oidcfiber v0.0.28/go.mod h1:gAZ4aymsh5I/A+vkapv5G3fnHyy51DKmOPZplFHWSw0=
 github.com/xenitab/go-oidc-middleware/oidcgin v0.0.28/go.mod h1:N9aQNc16SAdLpb20MjzXzgo9TNuuyCuTUKXGkD1kXBI=
@@ -23,4 +24,3 @@ golang.org/x/text v0.6.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
 golang.org/x/time v0.0.0-20201208040808-7e3f01d25324/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/time v0.0.0-20220411224347-583f2d630306 h1:+gHMid33q6pen7kv9xvT+JRinntgeXO2AeZVd0AWD3w=
 golang.org/x/time v0.0.0-20220411224347-583f2d630306/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
-google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c=

internal/coverage/go.mod

@@ -3,11 +3,11 @@ module coverage
 go 1.20
 
 require (
-	github.com/xenitab/go-oidc-middleware v0.0.40
-	github.com/xenitab/go-oidc-middleware/oidcechojwt v0.0.40
-	github.com/xenitab/go-oidc-middleware/oidcfiber v0.0.40
-	github.com/xenitab/go-oidc-middleware/oidcgin v0.0.40
-	github.com/xenitab/go-oidc-middleware/oidchttp v0.0.40
+	github.com/xenitab/go-oidc-middleware v0.0.41
+	github.com/xenitab/go-oidc-middleware/oidcecho v0.0.41
+	github.com/xenitab/go-oidc-middleware/oidcfiber v0.0.41
+	github.com/xenitab/go-oidc-middleware/oidcgin v0.0.41
+	github.com/xenitab/go-oidc-middleware/oidchttp v0.0.41
 )
 
 require (