2021-06-09 23:23:16 +05:30
|
|
|
// Copyright 2021 The Gitea Authors. All rights reserved.
|
2022-11-27 23:50:29 +05:30
|
|
|
// SPDX-License-Identifier: MIT
|
2021-06-09 23:23:16 +05:30
|
|
|
|
|
|
|
package auth
|
|
|
|
|
|
|
|
import (
|
|
|
|
"net/http"
|
2022-03-28 10:16:28 +05:30
|
|
|
"strings"
|
2021-06-09 23:23:16 +05:30
|
|
|
|
2021-11-24 15:19:20 +05:30
|
|
|
user_model "code.gitea.io/gitea/models/user"
|
2021-06-09 23:23:16 +05:30
|
|
|
)
|
|
|
|
|
|
|
|
// Ensure the struct implements the interface.
|
|
|
|
var (
|
2023-06-18 13:29:09 +05:30
|
|
|
_ Method = &Group{}
|
2021-06-09 23:23:16 +05:30
|
|
|
)
|
|
|
|
|
|
|
|
// Group implements the Auth interface with serval Auth.
|
|
|
|
type Group struct {
|
2021-07-24 15:46:34 +05:30
|
|
|
methods []Method
|
2021-06-09 23:23:16 +05:30
|
|
|
}
|
|
|
|
|
|
|
|
// NewGroup creates a new auth group
|
2021-07-24 15:46:34 +05:30
|
|
|
func NewGroup(methods ...Method) *Group {
|
2021-06-09 23:23:16 +05:30
|
|
|
return &Group{
|
|
|
|
methods: methods,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-03-28 10:16:28 +05:30
|
|
|
// Add adds a new method to group
|
|
|
|
func (b *Group) Add(method Method) {
|
|
|
|
b.methods = append(b.methods, method)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Name returns group's methods name
|
|
|
|
func (b *Group) Name() string {
|
|
|
|
names := make([]string, 0, len(b.methods))
|
|
|
|
for _, m := range b.methods {
|
2023-09-05 21:28:30 +05:30
|
|
|
names = append(names, m.Name())
|
2022-03-28 10:16:28 +05:30
|
|
|
}
|
|
|
|
return strings.Join(names, ",")
|
|
|
|
}
|
|
|
|
|
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 11:23:28 +05:30
|
|
|
func (b *Group) Verify(req *http.Request, w http.ResponseWriter, store DataStore, sess SessionStore) (*user_model.User, error) {
|
2021-06-09 23:23:16 +05:30
|
|
|
// Try to sign in with each of the enabled plugins
|
2023-07-11 07:34:28 +05:30
|
|
|
var retErr error
|
2023-09-05 21:28:30 +05:30
|
|
|
for _, m := range b.methods {
|
|
|
|
user, err := m.Verify(req, w, store, sess)
|
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 11:23:28 +05:30
|
|
|
if err != nil {
|
2023-07-11 07:34:28 +05:30
|
|
|
if retErr == nil {
|
|
|
|
retErr = err
|
|
|
|
}
|
|
|
|
// Try other methods if this one failed.
|
|
|
|
// Some methods may share the same protocol to detect if they are matched.
|
|
|
|
// For example, OAuth2 and conan.Auth both read token from "Authorization: Bearer <token>" header,
|
|
|
|
// If OAuth2 returns error, we should give conan.Auth a chance to try.
|
|
|
|
continue
|
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 11:23:28 +05:30
|
|
|
}
|
|
|
|
|
2023-07-11 07:34:28 +05:30
|
|
|
// If any method returns a user, we can stop trying.
|
|
|
|
// Return the user and ignore any error returned by previous methods.
|
2021-06-09 23:23:16 +05:30
|
|
|
if user != nil {
|
|
|
|
if store.GetData()["AuthedMethod"] == nil {
|
2023-09-05 21:28:30 +05:30
|
|
|
store.GetData()["AuthedMethod"] = m.Name()
|
2021-06-09 23:23:16 +05:30
|
|
|
}
|
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 11:23:28 +05:30
|
|
|
return user, nil
|
2021-06-09 23:23:16 +05:30
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-07-11 07:34:28 +05:30
|
|
|
// If no method returns a user, return the error returned by the first method.
|
|
|
|
return nil, retErr
|
2021-06-09 23:23:16 +05:30
|
|
|
}
|