go-packages/iris
1
0
Fork 0
mirror of https://github.com/kataras/iris.git synced 2025-02-02 15:30:36 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

basicauth: add session for current login tries (if MaxTries > 0) and log debug error handler

Browse Source
This commit is contained in:
Gerasimos (Makis) Maropoulos 2020-11-25 04:20:56 +02:00
parent 11e21150d0
commit 763300b566
No known key found for this signature in database
GPG Key ID: 5DBE766BD26A54E7
1 changed files with 51 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
middleware/basicauth/basicauth.go
View File

@ -2,7 +2,6 @@ package basicauth
import (
stdContext "context"
"log"
"net/http"
"net/url"
"strconv"
@ -11,6 +10,7 @@ import (
"time"
"github.com/kataras/iris/v12/context"
"github.com/kataras/iris/v12/sessions"
)
func init() {
@ -108,6 +108,11 @@ type Options struct {
// Defaults to "basicmaxtries".
// The MaxTries should be set to greater than zero.
MaxTriesCookie string
// If not empty then this session key will be used to store
// the current tries of login failures. If not a session manager
// was registered then the application will log an error.
// Note that this field has a priority over the MaxTriesCookie.
MaxTriesSession string
// ErrorHandler handles the given request credentials failure.
// E.g when the client tried to access a protected resource
// with empty or invalid or expired credentials or
@ -115,13 +120,6 @@ type Options struct {
//
// Defaults to the DefaultErrorHandler, do not modify if you don't need to.
ErrorHandler ErrorHandler
// ErrorLogger if not nil then it logs any credentials failure errors
// that are going to be sent to the client. Set it on debug development state.
// Usage:
// ErrorLogger = log.New(os.Stderr, "", log.LstdFlags)
//
// Defaults to nil.
ErrorLogger *log.Logger
// GC automatically clears old entries every x duration.
// Note that, by old entries we mean expired credentials therefore
// the `MaxAge` option should be already set,
@ -276,15 +274,32 @@ func Load(jsonOrYamlFilename string, userOpts ...UserAuthOption) context.Handler
}
func (b *BasicAuth) getCurrentTries(ctx *context.Context) (tries int) {
if key := b.opts.MaxTriesSession; key != "" {
if sess := sessions.Get(ctx); sess != nil {
tries = sess.GetIntDefault(key, 0)
} else {
ctx.Application().Logger().Error("basicauth: getCurrentTries: session key: %s but no session manager is registered", key)
return
}
} else {
cookie := ctx.GetCookie(b.opts.MaxTriesCookie)
if cookie != "" {
tries, _ = strconv.Atoi(cookie)
}
}
return
}
func (b *BasicAuth) setCurrentTries(ctx *context.Context, tries int) {
if key := b.opts.MaxTriesSession; key != "" {
if sess := sessions.Get(ctx); sess != nil {
sess.Set(key, tries)
} else {
ctx.Application().Logger().Error("basicauth: setCurrentTries: session key: %s but no session manager is registered", key)
return
}
} else {
maxAge := b.opts.MaxAge
if maxAge == 0 {
maxAge = DefaultCookieMaxAge // 1 hour.
@ -301,19 +316,27 @@ func (b *BasicAuth) setCurrentTries(ctx *context.Context, tries int) {
ctx.SetCookie(c)
}
}
func (b *BasicAuth) resetCurrentTries(ctx *context.Context) {
if key := b.opts.MaxTriesSession; key != "" {
if sess := sessions.Get(ctx); sess != nil {
sess.Delete(key)
} else {
ctx.Application().Logger().Error("basicauth: resetCurrentTries: session key: %s but no session manager is registered", key)
return
}
} else {
ctx.RemoveCookie(b.opts.MaxTriesCookie)
}
}
func isHTTPS(r *http.Request) bool {
return (strings.EqualFold(r.URL.Scheme, "https") || r.TLS != nil) && r.ProtoMajor == 2
}
func (b *BasicAuth) handleError(ctx *context.Context, err error) {
if b.opts.ErrorLogger != nil {
b.opts.ErrorLogger.Println(err)
}
ctx.Application().Logger().Debug(err)
// should not be nil as it's defaulted on New.
b.opts.ErrorHandler(ctx, err)