jojo/services/auth/method
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
..
additional_scopes_test.go [v15.0/forgejo] refactor: change authentication to return structured data (#12462) 2026-05-08 04:07:32 +02:00
auth.go [v15.0/forgejo] refactor: change authentication to return structured data (#12462) 2026-05-08 04:07:32 +02:00
auth_result_accesstoken.go [v15.0/forgejo] refactor: change authentication to return structured data (#12462) 2026-05-08 04:07:32 +02:00
auth_result_actionstask.go [v15.0/forgejo] refactor: change authentication to return structured data (#12462) 2026-05-08 04:07:32 +02:00
auth_result_basicpassword.go [v15.0/forgejo] refactor: change authentication to return structured data (#12462) 2026-05-08 04:07:32 +02:00
auth_result_httpsign.go [v15.0/forgejo] refactor: change authentication to return structured data (#12462) 2026-05-08 04:07:32 +02:00
auth_result_oauth.go [v15.0/forgejo] refactor: change authentication to return structured data (#12462) 2026-05-08 04:07:32 +02:00
auth_result_reverseproxy.go [v15.0/forgejo] refactor: change authentication to return structured data (#12462) 2026-05-08 04:07:32 +02:00
auth_result_session.go [v15.0/forgejo] refactor: change authentication to return structured data (#12462) 2026-05-08 04:07:32 +02:00
auth_test.go [v15.0/forgejo] refactor: change authentication to return structured data (#12462) 2026-05-08 04:07:32 +02:00
basic.go [v15.0/forgejo] refactor: clarify four different outputs that authentication methods provide (#12468) 2026-05-08 07:31:33 +02:00
group.go [v15.0/forgejo] refactor: clarify four different outputs that authentication methods provide (#12468) 2026-05-08 07:31:33 +02:00
httpsign.go [v15.0/forgejo] refactor: clarify four different outputs that authentication methods provide (#12468) 2026-05-08 07:31:33 +02:00
main_test.go [v15.0/forgejo] refactor: change authentication to return structured data (#12462) 2026-05-08 04:07:32 +02:00
oauth2.go [v15.0/forgejo] refactor: clarify four different outputs that authentication methods provide (#12468) 2026-05-08 07:31:33 +02:00
oauth2_test.go [v15.0/forgejo] refactor: clarify four different outputs that authentication methods provide (#12468) 2026-05-08 07:31:33 +02:00
reverseproxy.go [v15.0/forgejo] refactor: clarify four different outputs that authentication methods provide (#12468) 2026-05-08 07:31:33 +02:00
reverseproxy_test.go [v15.0/forgejo] refactor: change authentication to return structured data (#12462) 2026-05-08 04:07:32 +02:00
session.go [v15.0/forgejo] refactor: clarify four different outputs that authentication methods provide (#12468) 2026-05-08 07:31:33 +02:00
signin.go [v15.0/forgejo] refactor: change authentication to return structured data (#12462) 2026-05-08 04:07:32 +02:00