Make Validator and ContextKey required input

README.md

@@ -22,31 +22,24 @@ import (
   "github.com/gofiber/keyauth/v2"
 )
 
-const (
-  apiKey = "my-super-secret-key"
-)
-
 var (
-  errMissing = &fiber.Error{Code: 403, Message: "Missing API key"}
-  errInvalid  = &fiber.Error{Code: 403, Message: "Invalid API key"}
+  APIKey = "correct horse battery staple"
 )
 
-func validateApiKey(ctx *fiber.Ctx, s string) (bool, error) {
-  if s == "" {
-    return false, errMissing
-  }
-  if s == apiKey {
-    return true, nil
-  }
-  return false, errInvalid
+func validateAPIKey(c *fiber.Ctx, key string) (bool, error) {
+	if key == APIKey {
+		return true, nil
+	}
+	return false, keyauth.ErrMissingOrMalformedAPIKey
 }
 
 func main() {
   app := fiber.New()
-
+
+  // note that the keyauth middleware needs to be defined before the routes are defined!
   app.Use(keyauth.New(keyauth.Config{
-    KeyLookup: "cookie:access_token",
-    Validator: validateApiKey,
+    KeyLookup:  "cookie:access_token",
+    Validator:  validateAPIKey,
   }))
 
   app.Get("/", func(c *fiber.Ctx) error {
@@ -64,11 +57,11 @@ func main() {
 curl http://localhost:3000
 #> missing or malformed API Key
 
-curl --cookie "access_token=my-super-secret-key" http://localhost:3000
+curl --cookie "access_token=correct horse battery staple" http://localhost:3000
 #> Successfully authenticated!
 
 curl --cookie "access_token=Clearly A Wrong Key" http://localhost:3000
-#> Invalid or expired API Key
+#>  missing or malformed API Key
 ```
 
 For a more detailed example, see also the [`github.com/gofiber/recipes`](https://github.com/gofiber/recipes) repository and specifically the `fiber-envoy-extauthz` repository and the [`keyauth example`](https://github.com/gofiber/recipes/blob/master/fiber-envoy-extauthz/authz/main.go) code.
@@ -85,24 +78,15 @@ import (
   "github.com/gofiber/fiber/v2"
   "github.com/gofiber/keyauth/v2"
 )
-
-const (
-  apiKey = "my-super-secret-key"
-)
-
 var (
-  errMissing = &fiber.Error{Code: 403, Message: "Missing API key"}
-  errInvalid  = &fiber.Error{Code: 403, Message: "Invalid API key"}
+  APIKey = "correct horse battery staple"
 )
 
-func validateApiKey(ctx *fiber.Ctx, s string) (bool, error) {
-  if s == "" {
-    return false, errMissing
-  }
-  if s == apiKey {
-    return true, nil
-  }
-  return false, errInvalid
+func validateAPIKey(c *fiber.Ctx, key string) (bool, error) {
+	if key == APIKey {
+		return true, nil
+	}
+	return false, keyauth.ErrMissingOrMalformedAPIKey
 }
 
 func authFilter(c *fiber.Ctx) bool {
@@ -116,8 +100,8 @@ func main() {
 
   app.Use(keyauth.New(keyauth.Config{
     Filter: authFilter,
-    KeyLookup: "cookie:access_token",
-    Validator: validateApiKey,
+    KeyLookup:  "cookie:access_token",
+    Validator:  validateAPIKey,
   }))
 
   app.Get("/", func(c *fiber.Ctx) error {
@@ -142,10 +126,10 @@ curl http://localhost:3000
 #> Welcome
 
 # /authenticated needs to be authenticated
-curl --cookie "access_token=my-super-secret-key" http://localhost:3000/authenticated
+curl --cookie "access_token=correct horse battery staple" http://localhost:3000/authenticated
 #> Successfully authenticated!
 
 # /auth2 needs to be authenticated too
-curl --cookie "access_token=my-super-secret-key" http://localhost:3000/auth2
+curl --cookie "access_token=correct horse battery staple" http://localhost:3000/auth2
 #> Successfully authenticated 2!
 ```

main.go

@@ -6,6 +6,7 @@ package keyauth
 
 import (
 	"errors"
+	"net/url"
 	"strings"
 
 	"github.com/gofiber/fiber/v2"
@@ -46,7 +47,6 @@ type Config struct {
 	AuthScheme string
 
 	// Validator is a function to validate key.
-	// Optional. Default: nil
 	Validator func(*fiber.Ctx, string) (bool, error)
 
 	// Context key to store the bearertoken from the token into context.
@@ -70,7 +70,7 @@ func New(config ...Config) fiber.Handler {
 	if cfg.ErrorHandler == nil {
 		cfg.ErrorHandler = func(c *fiber.Ctx, err error) error {
 			if err == ErrMissingOrMalformedAPIKey {
-				return c.Status(fiber.StatusBadRequest).SendString(err.Error())
+				return c.Status(fiber.StatusUnauthorized).SendString(err.Error())
 			}
 			return c.Status(fiber.StatusUnauthorized).SendString("Invalid or expired API Key")
 		}
@@ -83,9 +83,7 @@ func New(config ...Config) fiber.Handler {
 		}
 	}
 	if cfg.Validator == nil {
-		cfg.Validator = func(c *fiber.Ctx, t string) (bool, error) {
-			return true, nil
-		}
+		panic("fiber: keyauth middleware requires a validator function")
 	}
 	if cfg.ContextKey == "" {
 		cfg.ContextKey = "token"
@@ -168,8 +166,8 @@ func keyFromForm(param string) func(c *fiber.Ctx) (string, error) {
 // keyFromParam returns a function that extracts api key from the url param string.
 func keyFromParam(param string) func(c *fiber.Ctx) (string, error) {
 	return func(c *fiber.Ctx) (string, error) {
-		key := c.Params(param)
-		if key == "" {
+		key, err := url.PathUnescape(c.Params(param))
+		if err != nil {
 			return "", ErrMissingOrMalformedAPIKey
 		}
 		return key, nil