Merge branch 'nshmura-master'

middleware/basic_auth.go

@@ -2,6 +2,7 @@ package middleware
 
 import (
 	"encoding/base64"
+	"strconv"
 
 	"github.com/labstack/echo"
 )
@@ -15,6 +16,10 @@ type (
 		// Validator is a function to validate BasicAuth credentials.
 		// Required.
 		Validator BasicAuthValidator
+
+		// Realm is a string to define realm attribute of BasicAuth.
+		// Default value "Restricted".
+		Realm string
 	}
 
 	// BasicAuthValidator defines a function to validate BasicAuth credentials.
@@ -22,13 +27,15 @@ type (
 )
 
 const (
-	basic = "Basic"
+	basic        = "Basic"
+	defaultRealm = "Restricted"
 )
 
 var (
 	// DefaultBasicAuthConfig is the default BasicAuth middleware config.
 	DefaultBasicAuthConfig = BasicAuthConfig{
 		Skipper: DefaultSkipper,
+		Realm:   defaultRealm,
 	}
 )
 
@@ -52,6 +59,9 @@ func BasicAuthWithConfig(config BasicAuthConfig) echo.MiddlewareFunc {
 	if config.Skipper == nil {
 		config.Skipper = DefaultBasicAuthConfig.Skipper
 	}
+	if config.Realm == "" {
+		config.Realm = defaultRealm
+	}
 
 	return func(next echo.HandlerFunc) echo.HandlerFunc {
 		return func(c echo.Context) error {
@@ -78,8 +88,15 @@ func BasicAuthWithConfig(config BasicAuthConfig) echo.MiddlewareFunc {
 				}
 			}
 
+			realm := ""
+			if config.Realm == defaultRealm {
+				realm = defaultRealm
+			} else {
+				realm = strconv.Quote(config.Realm)
+			}
+
 			// Need to return `401` for browsers to pop-up login box.
-			c.Response().Header().Set(echo.HeaderWWWAuthenticate, basic+" realm=Restricted")
+			c.Response().Header().Set(echo.HeaderWWWAuthenticate, basic+" realm="+realm)
 			return echo.ErrUnauthorized
 		}
 	}

website/content/middleware/basic-auth.md

@@ -41,6 +41,10 @@ BasicAuthConfig struct {
   // Validator is a function to validate BasicAuth credentials.
   // Required.
   Validator BasicAuthValidator
+
+  // Realm is a string to define realm attribute of BasicAuth.
+  // Default value "Restricted".
+  Realm string
 }
 ```