mirror of https://github.com/gin-gonic/gin.git
docs: Add document to constant `AuthProxyUserKey` and `BasicAuthForProxy`. (#3887)
This commit is contained in:
parent
990c44aebf
commit
ee70b30a97
3
auth.go
3
auth.go
|
@ -15,6 +15,8 @@ import (
|
|||
|
||||
// AuthUserKey is the cookie name for user credential in basic auth.
|
||||
const AuthUserKey = "user"
|
||||
|
||||
// AuthProxyUserKey is the cookie name for proxy_user credential in basic auth for proxy.
|
||||
const AuthProxyUserKey = "proxy_user"
|
||||
|
||||
// Accounts defines a key/value for user/pass list of authorized logins.
|
||||
|
@ -92,6 +94,7 @@ func authorizationHeader(user, password string) string {
|
|||
}
|
||||
|
||||
// BasicAuthForProxy returns a Basic HTTP Proxy-Authorization middleware.
|
||||
// If the realm is empty, "Proxy Authorization Required" will be used by default.
|
||||
func BasicAuthForProxy(accounts Accounts, realm string) HandlerFunc {
|
||||
if realm == "" {
|
||||
realm = "Proxy Authorization Required"
|
||||
|
|
Loading…
Reference in New Issue