mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-05-12 22:10:25 +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>
119 lines
2.9 KiB
Go
119 lines
2.9 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package eventsource
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
activities_model "forgejo.org/models/activities"
|
|
issues_model "forgejo.org/models/issues"
|
|
"forgejo.org/modules/graceful"
|
|
"forgejo.org/modules/json"
|
|
"forgejo.org/modules/log"
|
|
"forgejo.org/modules/process"
|
|
"forgejo.org/modules/setting"
|
|
"forgejo.org/modules/timeutil"
|
|
"forgejo.org/services/convert"
|
|
)
|
|
|
|
// Init starts this eventsource
|
|
func (m *Manager) Init() {
|
|
if setting.UI.Notification.EventSourceUpdateTime <= 0 {
|
|
return
|
|
}
|
|
go graceful.GetManager().RunWithShutdownContext(m.Run)
|
|
}
|
|
|
|
// Run runs the manager within a provided context
|
|
func (m *Manager) Run(ctx context.Context) {
|
|
ctx, _, finished := process.GetManager().AddTypedContext(ctx, "Service: EventSource", process.SystemProcessType, true)
|
|
defer finished()
|
|
|
|
then := timeutil.TimeStampNow().Add(-2)
|
|
timer := time.NewTicker(setting.UI.Notification.EventSourceUpdateTime)
|
|
loop:
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
timer.Stop()
|
|
break loop
|
|
case <-timer.C:
|
|
m.mutex.Lock()
|
|
connectionCount := len(m.messengers)
|
|
if connectionCount == 0 {
|
|
log.Trace("Event source has no listeners")
|
|
// empty the connection channel
|
|
select {
|
|
case <-m.connection:
|
|
break
|
|
default:
|
|
break
|
|
}
|
|
}
|
|
m.mutex.Unlock()
|
|
if connectionCount == 0 {
|
|
// No listeners so the source can be paused
|
|
log.Trace("Pausing the eventsource")
|
|
select {
|
|
case <-ctx.Done():
|
|
break loop
|
|
case <-m.connection:
|
|
log.Trace("Connection detected - restarting the eventsource")
|
|
// OK we're back so lets reset the timer and start again
|
|
// We won't change the "then" time because there could be concurrency issues
|
|
select {
|
|
case <-timer.C:
|
|
break
|
|
default:
|
|
break
|
|
}
|
|
continue
|
|
}
|
|
}
|
|
|
|
now := timeutil.TimeStampNow().Add(-2)
|
|
|
|
uidCounts, err := activities_model.GetUIDsAndNotificationCounts(ctx, then, now)
|
|
if err != nil {
|
|
log.Error("Unable to get UIDcounts: %v", err)
|
|
}
|
|
for _, uidCount := range uidCounts {
|
|
m.SendMessage(uidCount.UserID, &Event{
|
|
Name: "notification-count",
|
|
Data: uidCount,
|
|
})
|
|
}
|
|
then = now
|
|
|
|
if setting.Service.EnableTimetracking {
|
|
usersStopwatches, err := issues_model.GetUIDsAndStopwatch(ctx)
|
|
if err != nil {
|
|
log.Error("Unable to get GetUIDsAndStopwatch: %v", err)
|
|
return
|
|
}
|
|
|
|
for uid, stopwatches := range usersStopwatches {
|
|
apiSWs, err := convert.ToStopWatches(ctx, stopwatches)
|
|
if err != nil {
|
|
if !issues_model.IsErrIssueNotExist(err) {
|
|
log.Error("Unable to APIFormat stopwatches: %v", err)
|
|
}
|
|
continue
|
|
}
|
|
dataBs, err := json.Marshal(apiSWs)
|
|
if err != nil {
|
|
log.Error("Unable to marshal stopwatches: %v", err)
|
|
continue
|
|
}
|
|
m.SendMessage(uid, &Event{
|
|
Name: "stopwatches",
|
|
Data: string(dataBs),
|
|
})
|
|
}
|
|
}
|
|
}
|
|
}
|
|
m.UnregisterAll()
|
|
}
|