mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-05-17 00:06:35 +00:00
a1222ebb5b
**Backport:** https://codeberg.org/forgejo/forgejo/pulls/12231 #12202 began a refactor of Forgejo's authentication implementations by providing structured data on an authentication success. However, error cases were maintained as-is in that refactor, leaving a complex situation: what does returning an error from an authentication method mean?; does it mean that the authentication failed, or that a server error occurred? Can another authentication still be tried? This PR changes authentication methods so that they can return one of four things: - `AuthenticationSuccess` with an authentication result. - `AuthenticationNotAttempted` which indicates that no credentials relevant for this authentication method were presented. If every method returned `AuthenticationNotAttempted`, then you would have an unauthenticated access. - `AuthenticationAttemptedIncorrectCredential` which indicates that credentials were present and failed validation -- a situation indicating a `401 Unauthorized`. - `AuthenticationError` which indicates that an internal server error occurred and failed authentication -- indicating a `500 Internal Server Error`. This paves the way for one more refactor coming next: `basic.go` and `oauth2.go` perform 3-4 different authentications each (access tokens, oauth JWTs, actions tokens, actions JWTs, and username/password). With the capability to return these more precise responses, these authentication methods can be split up into separate logic that isn't intertwined together. Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/12468 Reviewed-by: Gusted <gusted@noreply.codeberg.org>
56 lines
1.7 KiB
Go
56 lines
1.7 KiB
Go
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package method
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
|
|
user_model "forgejo.org/models/user"
|
|
"forgejo.org/modules/log"
|
|
"forgejo.org/services/auth"
|
|
)
|
|
|
|
// Ensure the struct implements the interface.
|
|
var (
|
|
_ auth.Method = &Session{}
|
|
)
|
|
|
|
// Session checks if there is a user uid stored in the session and returns the user
|
|
// object for that uid.
|
|
type Session struct{}
|
|
|
|
// 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.
|
|
func (s *Session) Verify(req *http.Request, w http.ResponseWriter, sess auth.SessionStore) auth.MethodOutput {
|
|
if sess == nil {
|
|
return &auth.AuthenticationNotAttempted{}
|
|
}
|
|
|
|
// Get user ID
|
|
uid := sess.Get("uid")
|
|
if uid == nil {
|
|
return &auth.AuthenticationNotAttempted{}
|
|
}
|
|
log.Trace("Session Authorization: Found user[%d]", uid)
|
|
|
|
id, ok := uid.(int64)
|
|
if !ok {
|
|
return &auth.AuthenticationNotAttempted{}
|
|
}
|
|
|
|
// Get user object
|
|
user, err := user_model.GetUserByID(req.Context(), id)
|
|
if err != nil {
|
|
if !user_model.IsErrUserNotExist(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 &auth.AuthenticationError{Error: fmt.Errorf("session auth GetUserByID: %w", err)}
|
|
}
|
|
return &auth.AuthenticationAttemptedIncorrectCredential{Error: err}
|
|
}
|
|
|
|
log.Trace("Session Authorization: Logged in user %-v", user)
|
|
return &auth.AuthenticationSuccess{Result: &sessionAuthenticationResult{user: user}}
|
|
}
|