feat: Global 2FA enforcement (#8753)

resolves #8549

This PR add a config to enforce 2FA for the whole Forgejo instance. It can be configured to `none`, `admin` or `all`.
A user who is required to enable 2FA is like a disabled user. He can only see the `/user/settings/security`-Page to enable 2FA, this should be similar to a user which needs to change his password. Also api and git-commands are not allowed.

## Checklist

The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org).

### Tests

- I added test coverage for Go changes...
  - [x] in their respective `*_test.go` for unit tests.
  - [x] in the `tests/integration` directory if it involves interactions with a live Forgejo server.
- I added test coverage for JavaScript changes...
  - [ ] in `web_src/js/*.test.js` if it can be unit tested.
  - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)).

### Documentation

- [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change.
- [ ] I did not document these changes and I do not expect someone else to do it.

I will do it, if the general idea of this PR is a good feature.

### Release notes

- [ ] I do not want this change to show in the release notes.
- [x] I want the title to show in the release notes with a link to this pull request.
- [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title.

<!--start release-notes-assistant-->

## Release notes
<!--URL:https://codeberg.org/forgejo/forgejo-->
- Security features
  - [PR](https://codeberg.org/forgejo/forgejo/pulls/8753): <!--number 8753 --><!--line 0 --><!--description R2xvYmFsIDJGQSBlbmZvcmNlbWVudA==-->Global 2FA enforcement<!--description-->
<!--end release-notes-assistant-->

Co-authored-by: 0ko <0ko@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8753
Reviewed-by: 0ko <0ko@noreply.codeberg.org>
Reviewed-by: Ellen Εμιλία Άννα Zscheile <fogti@noreply.codeberg.org>
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: zokki <zokki.softwareschmiede@gmail.com>
Co-committed-by: zokki <zokki.softwareschmiede@gmail.com>
This commit is contained in:
zokki 2025-08-15 10:56:45 +02:00 committed by Earl Warren
commit d6838462b8
29 changed files with 1179 additions and 62 deletions

View file

@ -21,11 +21,13 @@ import (
user_model "forgejo.org/models/user"
"forgejo.org/modules/setting"
api "forgejo.org/modules/structs"
"forgejo.org/modules/test"
"forgejo.org/modules/util"
packages_service "forgejo.org/services/packages"
packages_cleanup_service "forgejo.org/services/packages/cleanup"
"forgejo.org/tests"
"github.com/pquerna/otp/totp"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
@ -673,3 +675,97 @@ func TestPackageCleanup(t *testing.T) {
}
})
}
func TestPackageWithTwoFactor(t *testing.T) {
defer tests.PrepareTestEnv(t)()
adminUser := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 1})
normalUser := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 4})
runTest := func(t *testing.T, doer *user_model.User, useTOTP bool, expectedStatus int) {
t.Helper()
if doer != nil {
defer unittest.AssertSuccessfulDelete(t, &auth_model.TwoFactor{UID: doer.ID})
}
passcode := func() string {
if !useTOTP {
return ""
}
otpKey, err := totp.Generate(totp.GenerateOpts{
SecretSize: 40,
Issuer: "forgejo-test",
AccountName: doer.Name,
})
require.NoError(t, err)
require.NoError(t, auth_model.NewTwoFactor(t.Context(), &auth_model.TwoFactor{UID: doer.ID}, otpKey.Secret()))
passcode, err := totp.GenerateCode(otpKey.Secret(), time.Now())
require.NoError(t, err)
return passcode
}()
url := fmt.Sprintf("/api/v1/packages/%s", normalUser.Name) // a public packge to test
req := NewRequest(t, "GET", url)
if doer != nil {
req.AddBasicAuth(doer.Name)
}
if useTOTP {
MakeRequest(t, req, http.StatusUnauthorized)
req = NewRequest(t, "GET", url).
AddBasicAuth(doer.Name)
req.Header.Set("X-Forgejo-OTP", passcode)
}
MakeRequest(t, req, expectedStatus)
}
t.Run("NoneTwoFactorRequirement", func(t *testing.T) {
// this should be the default, so don't have to set the variable
t.Run("no 2fa", func(t *testing.T) {
runTest(t, adminUser, false, http.StatusOK)
runTest(t, normalUser, false, http.StatusOK)
runTest(t, nil, false, http.StatusOK) // anonymous
})
t.Run("enabled 2fa", func(t *testing.T) {
runTest(t, adminUser, true, http.StatusOK)
runTest(t, normalUser, true, http.StatusOK)
})
})
t.Run("AllTwoFactorRequirement", func(t *testing.T) {
defer test.MockVariableValue(&setting.GlobalTwoFactorRequirement, setting.AllTwoFactorRequirement)()
t.Run("no 2fa", func(t *testing.T) {
runTest(t, adminUser, false, http.StatusForbidden)
runTest(t, normalUser, false, http.StatusForbidden)
runTest(t, nil, false, http.StatusOK) // anonymous
})
t.Run("enabled 2fa", func(t *testing.T) {
runTest(t, adminUser, true, http.StatusOK)
runTest(t, normalUser, true, http.StatusOK)
})
})
t.Run("AdminTwoFactorRequirement", func(t *testing.T) {
defer test.MockVariableValue(&setting.GlobalTwoFactorRequirement, setting.AdminTwoFactorRequirement)()
t.Run("no 2fa", func(t *testing.T) {
runTest(t, adminUser, false, http.StatusForbidden)
runTest(t, normalUser, false, http.StatusOK)
runTest(t, nil, false, http.StatusOK) // anonymous
})
t.Run("enabled 2fa", func(t *testing.T) {
runTest(t, adminUser, true, http.StatusOK)
runTest(t, normalUser, true, http.StatusOK)
})
})
}