mirror of
https://git.vectorsigma.ru/public/AdGuardHome.git
synced 2026-08-03 19:39:39 +00:00
Pull request 2414: AGDNS-2743-auth-middleware
Merge in DNS/adguard-home from AGDNS-2743-auth-middleware to master
Squashed commit of the following:
commit 3d0621f1992fd42ecdf3f5b1039d938db065e478
Merge: 320581ba7 57dc791f5
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date: Fri May 30 16:38:22 2025 +0300
Merge branch 'master' into AGDNS-2743-auth-middleware
commit 320581ba7693183a39c53dc9f71180ab2a4f4d88
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date: Thu May 29 21:39:13 2025 +0300
all: imp code
commit 4de3e7e9baa4459ce0c18d229c809dedeb59a590
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date: Thu May 29 17:46:51 2025 +0300
home: imp tests
commit 6556aa48e77bd11254f097a888c51b6c5cd931b9
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date: Wed May 28 22:53:01 2025 +0300
all: add tests
commit 338eea6699bd2f3ae654c2f1f65fe44f43f4b1dd
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date: Tue May 27 15:53:31 2025 +0300
home: ctx key web user
commit 0453e5a9717954308331ea1aff2e43257c0f5569
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date: Thu May 22 14:28:09 2025 +0300
home: auth mw
This commit is contained in:
@@ -1,9 +1,11 @@
|
||||
package home
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/hex"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"net/http"
|
||||
"net/netip"
|
||||
"path"
|
||||
@@ -12,11 +14,14 @@ import (
|
||||
"time"
|
||||
|
||||
"github.com/AdguardTeam/AdGuardHome/internal/aghhttp"
|
||||
"github.com/AdguardTeam/AdGuardHome/internal/aghuser"
|
||||
"github.com/AdguardTeam/golibs/errors"
|
||||
"github.com/AdguardTeam/golibs/httphdr"
|
||||
"github.com/AdguardTeam/golibs/log"
|
||||
"github.com/AdguardTeam/golibs/logutil/slogutil"
|
||||
"github.com/AdguardTeam/golibs/netutil"
|
||||
"github.com/AdguardTeam/golibs/timeutil"
|
||||
"github.com/AdguardTeam/golibs/validate"
|
||||
)
|
||||
|
||||
// cookieTTL is the time-to-live of the session cookie.
|
||||
@@ -348,3 +353,154 @@ func (a *authHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||
func optionalAuthHandler(handler http.Handler) http.Handler {
|
||||
return &authHandler{handler}
|
||||
}
|
||||
|
||||
const (
|
||||
// errInvalidLogin is returned when there is an invalid login attempt.
|
||||
errInvalidLogin errors.Error = "invalid username or password"
|
||||
)
|
||||
|
||||
// authMiddlewareDefaultConfig is the configuration structure for the default
|
||||
// authentication middleware.
|
||||
type authMiddlewareDefaultConfig struct {
|
||||
// logger is used for logging the operation of the middleware. It must not
|
||||
// be nil.
|
||||
logger *slog.Logger
|
||||
|
||||
// sessions contains web user sessions. It must not be nil.
|
||||
sessions aghuser.SessionStorage
|
||||
|
||||
// users contains web user information. It must not be nil.
|
||||
users aghuser.DB
|
||||
}
|
||||
|
||||
// authMiddlewareDefault is the default authentication middleware. It searches
|
||||
// for a web client using an authentication cookie or basic auth credentials and
|
||||
// passes it with the context.
|
||||
type authMiddlewareDefault struct {
|
||||
logger *slog.Logger
|
||||
sessions aghuser.SessionStorage
|
||||
users aghuser.DB
|
||||
}
|
||||
|
||||
// newAuthMiddlewareDefault returns the new properly initialized
|
||||
// *authMiddlewareDefault.
|
||||
func newAuthMiddlewareDefault(c *authMiddlewareDefaultConfig) (mw *authMiddlewareDefault) {
|
||||
return &authMiddlewareDefault{
|
||||
logger: c.logger,
|
||||
sessions: c.sessions,
|
||||
users: c.users,
|
||||
}
|
||||
}
|
||||
|
||||
// wrap adds authentication logic to the provided HTTP handler.
|
||||
func (mw *authMiddlewareDefault) wrap(h http.Handler) (wrapped http.Handler) {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
ctx := r.Context()
|
||||
if !mw.needsAuthentication(ctx, r) {
|
||||
h.ServeHTTP(w, r)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
u, err := mw.userFromRequest(ctx, r)
|
||||
if u != nil {
|
||||
h.ServeHTTP(w, r.WithContext(withWebUser(ctx, u)))
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
mw.logger.ErrorContext(ctx, "retrieving user from request", slogutil.KeyError, err)
|
||||
}
|
||||
|
||||
w.WriteHeader(http.StatusUnauthorized)
|
||||
})
|
||||
}
|
||||
|
||||
// needsAuthentication returns true if the current request requires
|
||||
// authentication.
|
||||
//
|
||||
// TODO(s.chzhen): Use the request's path.
|
||||
func (mw *authMiddlewareDefault) needsAuthentication(
|
||||
ctx context.Context,
|
||||
_ *http.Request,
|
||||
) (ok bool) {
|
||||
users, err := mw.users.All(ctx)
|
||||
if err != nil {
|
||||
// Should not happen.
|
||||
panic(err)
|
||||
}
|
||||
|
||||
if len(users) == 0 {
|
||||
return false
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
// userFromRequest tries to retrieve a user based on the request.
|
||||
func (mw *authMiddlewareDefault) userFromRequest(
|
||||
ctx context.Context,
|
||||
r *http.Request,
|
||||
) (u *aghuser.User, err error) {
|
||||
defer func() { err = errors.Annotate(err, "getting user from request: %w") }()
|
||||
|
||||
cookie, err := r.Cookie(sessionCookieName)
|
||||
if err == http.ErrNoCookie {
|
||||
return mw.userFromRequestBasicAuth(ctx, r)
|
||||
}
|
||||
|
||||
sess, err := hex.DecodeString(cookie.Value)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("decoding cookie: %w", err)
|
||||
}
|
||||
|
||||
l := aghuser.SessionTokenLength
|
||||
|
||||
// TODO(a.garipov): Add validate.Len.
|
||||
err = validate.InRange("token length", len(sess), l, l)
|
||||
if err != nil {
|
||||
// Don't wrap the error because it's informative enough as is.
|
||||
return nil, err
|
||||
}
|
||||
|
||||
t := aghuser.SessionToken(sess)
|
||||
s, err := mw.sessions.FindByToken(ctx, t)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("searching session by token: %w", err)
|
||||
}
|
||||
|
||||
if s == nil {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
u, err = mw.users.ByLogin(ctx, s.UserLogin)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("searching user by login %q: %w", s.UserLogin, err)
|
||||
}
|
||||
|
||||
return u, nil
|
||||
}
|
||||
|
||||
// userFromRequestBasicAuth searches for a user using Basic Auth credentials.
|
||||
func (mw *authMiddlewareDefault) userFromRequestBasicAuth(
|
||||
ctx context.Context,
|
||||
r *http.Request,
|
||||
) (user *aghuser.User, err error) {
|
||||
login, pass, ok := r.BasicAuth()
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("credentials: %w", errors.ErrNoValue)
|
||||
}
|
||||
|
||||
user, _ = mw.users.ByLogin(ctx, aghuser.Login(login))
|
||||
if user == nil {
|
||||
return nil, errInvalidLogin
|
||||
}
|
||||
|
||||
ok = user.Password.Authenticate(ctx, pass)
|
||||
if !ok {
|
||||
return nil, errInvalidLogin
|
||||
}
|
||||
|
||||
return user, nil
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user