mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-06-22 10:02:15 +00:00
One of the security patches released 2026-03-09 [fixed a vulnerability](!11513 (commit d1c7b04d09)) 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>
91 lines
2.2 KiB
Go
91 lines
2.2 KiB
Go
// Copyright 2023 The Gitea Authors. All rights reserved.
|
|
// Copyright 2025 The Forgejo Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
// extracted from `/build/lint-locale.go`, `/build/lint-locale-usage.go`
|
|
|
|
package localeiter
|
|
|
|
import (
|
|
"encoding/json" //nolint:depguard
|
|
"fmt"
|
|
|
|
"forgejo.org/modules/setting"
|
|
)
|
|
|
|
func IterateMessagesContent(localeContent []byte, onMsgid func(string, string) error) error {
|
|
cfg, err := setting.NewConfigProviderForLocale(localeContent)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
for _, section := range cfg.Sections() {
|
|
for _, key := range section.Keys() {
|
|
var trKey string
|
|
// see https://codeberg.org/forgejo/discussions/issues/104
|
|
// https://github.com/WeblateOrg/weblate/issues/10831
|
|
// for an explanation of why "common" is an alternative
|
|
if section.Name() == "" || section.Name() == "DEFAULT" || section.Name() == "common" {
|
|
trKey = key.Name()
|
|
} else {
|
|
trKey = section.Name() + "." + key.Name()
|
|
}
|
|
if err := onMsgid(trKey, key.Value()); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func iterateMessagesNextInner(onMsgid func(string, string, string) error, data map[string]any, trKey string) error {
|
|
for key, value := range data {
|
|
fullKey := key
|
|
if trKey != "" {
|
|
fullKey = trKey + "." + key
|
|
}
|
|
switch value := value.(type) {
|
|
case string:
|
|
// Check whether we are adding a plural form to the parent object, or a new nested JSON object.
|
|
realKey := trKey
|
|
pluralSuffix := ""
|
|
|
|
switch key {
|
|
case "zero", "one", "two", "few", "many":
|
|
pluralSuffix = key
|
|
case "other":
|
|
// do nothing
|
|
break
|
|
default:
|
|
realKey = fullKey
|
|
}
|
|
|
|
if err := onMsgid(realKey, pluralSuffix, value); err != nil {
|
|
return err
|
|
}
|
|
|
|
case map[string]any:
|
|
if err := iterateMessagesNextInner(onMsgid, value, fullKey); err != nil {
|
|
return err
|
|
}
|
|
|
|
case nil:
|
|
// do nothing
|
|
break
|
|
|
|
default:
|
|
return fmt.Errorf("Unexpected JSON type: %s - %T", fullKey, value)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func IterateMessagesNextContent(localeContent []byte, onMsgid func(string, string, string) error) error {
|
|
var localeData map[string]any
|
|
if err := json.Unmarshal(localeContent, &localeData); err != nil {
|
|
return err
|
|
}
|
|
return iterateMessagesNextInner(onMsgid, localeData, "")
|
|
}
|