mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-05-13 06:20:24 +00:00
One of the security patches released 2026-03-09 [fixed a vulnerability](https://codeberg.org/forgejo/forgejo/pulls/11513/commits/d1c7b04d09f6a13896eaa1322ac690b2021539da) caused by a misapplication of Go `case` statements, where the implementation would have been correct if Go `case` statements automatically fall through to the next case block, but they do not. This PR adds a semgrep rule which detects any empty `case` statement and raises an error, in order to prevent this coding mistake in the future. For example, code like this will now trigger a build error: ```go switch setting.Protocol { case setting.HTTPUnix: case setting.FCGI: case setting.FCGIUnix: default: defaultLocalURL := string(setting.Protocol) + "://" } ``` Example error: ``` cmd/web.go ❯❯❱ semgrep.config.forgejo-switch-empty-case switch has a case block with no content. This is treated as "break" by Go, but developers may confuse it for "fallthrough". To fix this error, disambiguate by using "break" or "fallthrough". 279┆ switch setting.Protocol { 280┆ case setting.HTTPUnix: 281┆ case setting.FCGI: 282┆ case setting.FCGIUnix: 283┆ default: 284┆ defaultLocalURL := string(setting.Protocol) + "://" 285┆ if setting.HTTPAddr == "0.0.0.0" { 286┆ defaultLocalURL += "localhost" 287┆ } else { 288┆ defaultLocalURL += setting.HTTPAddr ``` As described in the error output, this error can be fixed by explicitly listing `break` (the real Go behaviour, to do nothing in the block), or by listing `fallthrough` (if the intent was to fall through). All existing code triggering this detection has been changed to `break` (or, rarely, irrelevant cases have been removed), which should maintain the same code functionality. While performing this fixup, a light analysis was performed on each case and they *appeared* correct, but with ~65 cases I haven't gone into extreme depth. Tests are present for the semgrep rule in `.semgrep/tests/go.go`. ## 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). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [ ] This change will be noticed by a Forgejo user or admin (feature, bug fix, performance, etc.). I suggest to include a release note for this change. - [x] This change is not visible to a Forgejo user or admin (refactor, dependency upgrade, etc.). I think there is no need to add a release note for this change. Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/11593 Reviewed-by: Gusted <gusted@noreply.codeberg.org> Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net> Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
80 lines
1.9 KiB
Go
80 lines
1.9 KiB
Go
// Copyright 2023 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package admin
|
|
|
|
import (
|
|
"runtime/pprof"
|
|
"sync"
|
|
"time"
|
|
|
|
"forgejo.org/modules/graceful"
|
|
"forgejo.org/modules/log"
|
|
"forgejo.org/modules/process"
|
|
"forgejo.org/modules/queue"
|
|
"forgejo.org/modules/setting"
|
|
)
|
|
|
|
var testQueueOnce sync.Once
|
|
|
|
// initTestQueueOnce initializes the test queue for dev mode
|
|
// the test queue will also be shown in the queue list
|
|
// developers could see the queue length / worker number / items number on the admin page and try to remove the items
|
|
func initTestQueueOnce() {
|
|
testQueueOnce.Do(func() {
|
|
ctx, _, finished := process.GetManager().AddTypedContext(graceful.GetManager().ShutdownContext(), "TestQueue", process.SystemProcessType, false)
|
|
qs := setting.QueueSettings{
|
|
Name: "test-queue",
|
|
Type: "channel",
|
|
Length: 20,
|
|
BatchLength: 2,
|
|
MaxWorkers: 3,
|
|
}
|
|
testQueue, err := queue.NewWorkerPoolQueueWithContext(ctx, "test-queue", qs, func(t ...int64) (unhandled []int64) {
|
|
for range t {
|
|
select {
|
|
case <-graceful.GetManager().ShutdownContext().Done():
|
|
break
|
|
case <-time.After(5 * time.Second):
|
|
break
|
|
}
|
|
}
|
|
return nil
|
|
}, true)
|
|
if err != nil {
|
|
log.Error("unable to create test queue: %v", err)
|
|
return
|
|
}
|
|
|
|
queue.GetManager().AddManagedQueue(testQueue)
|
|
testQueue.SetWorkerMaxNumber(5)
|
|
go graceful.GetManager().RunWithCancel(testQueue)
|
|
go func() {
|
|
pprof.SetGoroutineLabels(ctx)
|
|
defer finished()
|
|
|
|
cnt := int64(0)
|
|
adding := true
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
break
|
|
case <-time.After(500 * time.Millisecond):
|
|
if adding {
|
|
if testQueue.GetQueueItemNumber() == qs.Length {
|
|
adding = false
|
|
}
|
|
} else {
|
|
if testQueue.GetQueueItemNumber() == 0 {
|
|
adding = true
|
|
}
|
|
}
|
|
if adding {
|
|
_ = testQueue.Push(cnt)
|
|
cnt++
|
|
}
|
|
}
|
|
}
|
|
}()
|
|
})
|
|
}
|