jojo/routers/api/packages/nuget/auth.go
forgejo-backport-action a1222ebb5b [v15.0/forgejo] refactor: clarify four different outputs that authentication methods provide (#12468)
**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>
2026-05-08 07:31:33 +02:00

56 lines
1.6 KiB
Go

// Copyright 2022 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package nuget
import (
"fmt"
"net/http"
auth_model "forgejo.org/models/auth"
user_model "forgejo.org/models/user"
"forgejo.org/modules/log"
"forgejo.org/services/auth"
)
var (
_ auth.Method = &Auth{}
_ auth.AuthenticationResult = &nugetAuthenticationResult{}
)
type nugetAuthenticationResult struct {
*auth.BaseAuthenticationResult
user *user_model.User
}
func (r *nugetAuthenticationResult) User() *user_model.User {
return r.user
}
type Auth struct{}
// https://docs.microsoft.com/en-us/nuget/api/package-publish-resource#request-parameters
func (a *Auth) Verify(req *http.Request, w http.ResponseWriter, sess auth.SessionStore) auth.MethodOutput {
apiKey := req.Header.Get("X-NuGet-ApiKey")
if apiKey == "" {
return &auth.AuthenticationNotAttempted{}
}
token, err := auth_model.GetAccessTokenBySHA(req.Context(), apiKey)
if err != nil {
if !auth_model.IsErrAccessTokenNotExist(err) && !auth_model.IsErrAccessTokenEmpty(err) {
return &auth.AuthenticationError{Error: fmt.Errorf("nuget auth GetAccessTokenBySHA: %w", err)}
}
return &auth.AuthenticationAttemptedIncorrectCredential{Error: err}
}
u, err := user_model.GetUserByID(req.Context(), token.UID)
if err != nil {
return &auth.AuthenticationError{Error: fmt.Errorf("nuget auth GetUserByID: %w", err)}
}
if err := token.UpdateLastUsed(req.Context()); err != nil {
log.Error("UpdateLastUsed: %v", err)
}
return &auth.AuthenticationSuccess{Result: &nugetAuthenticationResult{user: u}}
}