2021-06-10 01:53:16 +08:00
// Copyright 2019 The Gitea Authors. All rights reserved.
2022-11-28 02:20:29 +08:00
// SPDX-License-Identifier: MIT
2021-06-10 01:53:16 +08:00
package auth
import (
"net/http"
2021-11-24 17:49:20 +08:00
user_model "code.gitea.io/gitea/models/user"
2021-06-10 01:53:16 +08:00
"code.gitea.io/gitea/modules/log"
)
// Ensure the struct implements the interface.
var (
2021-07-24 18:16:34 +08:00
_ Method = & Session { }
2021-06-10 01:53:16 +08:00
)
// Session checks if there is a user uid stored in the session and returns the user
// object for that uid.
2022-01-21 01:46:10 +08:00
type Session struct { }
2021-06-10 01:53:16 +08:00
// Name represents the name of auth method
func ( s * Session ) Name ( ) string {
return "session"
}
// Verify checks if there is a user uid stored in the session and returns the user
// object for that uid.
// Returns nil if there is no user uid stored in the session.
refactor auth interface to return error when verify failure (#22119)
This PR changed the Auth interface signature from
`Verify(http *http.Request, w http.ResponseWriter, store DataStore, sess
SessionStore) *user_model.User`
to
`Verify(http *http.Request, w http.ResponseWriter, store DataStore, sess
SessionStore) (*user_model.User, error)`.
There is a new return argument `error` which means the verification
condition matched but verify process failed, we should stop the auth
process.
Before this PR, when return a `nil` user, we don't know the reason why
it returned `nil`. If the match condition is not satisfied or it
verified failure? For these two different results, we should have
different handler. If the match condition is not satisfied, we should
try next auth method and if there is no more auth method, it's an
anonymous user. If the condition matched but verify failed, the auth
process should be stop and return immediately.
This will fix #20563
Co-authored-by: KN4CK3R <admin@oldschoolhack.me>
Co-authored-by: Jason Song <i@wolfogre.com>
2022-12-28 13:53:28 +08:00
func ( s * Session ) Verify ( req * http . Request , w http . ResponseWriter , store DataStore , sess SessionStore ) ( * user_model . User , error ) {
2022-10-07 04:50:38 +08:00
if sess == nil {
2024-03-21 16:48:08 +08:00
return nil , nil
2022-10-07 04:50:38 +08:00
}
2021-06-10 01:53:16 +08:00
// Get user ID
uid := sess . Get ( "uid" )
if uid == nil {
2024-03-21 16:48:08 +08:00
return nil , nil
2021-06-10 01:53:16 +08:00
}
log . Trace ( "Session Authorization: Found user[%d]" , uid )
id , ok := uid . ( int64 )
if ! ok {
2024-03-21 16:48:08 +08:00
return nil , nil
2021-06-10 01:53:16 +08:00
}
// Get user object
2024-03-21 16:48:08 +08:00
user , err := user_model . GetUserByID ( req . Context ( ) , id )
2021-06-10 01:53:16 +08:00
if err != nil {
2021-11-24 17:49:20 +08:00
if ! user_model . IsErrUserNotExist ( err ) {
2024-03-21 16:48:08 +08:00
log . Error ( "GetUserByID: %v" , err )
// Return the err as-is to keep current signed-in session, in case the err is something like context.Canceled. Otherwise non-existing user (nil, nil) will make the caller clear the signed-in session.
return nil , err
2021-06-10 01:53:16 +08:00
}
2024-03-21 16:48:08 +08:00
return nil , nil
2021-06-10 01:53:16 +08:00
}
log . Trace ( "Session Authorization: Logged in user %-v" , user )
2024-03-21 16:48:08 +08:00
return user , nil
2021-06-10 01:53:16 +08:00
}