mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-05-15 23:40:26 +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>
195 lines
3.8 KiB
Go
195 lines
3.8 KiB
Go
// Copyright 2021 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package migration
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
)
|
|
|
|
var _ Downloader = &RetryDownloader{}
|
|
|
|
// RetryDownloader retry the downloads
|
|
type RetryDownloader struct {
|
|
Downloader
|
|
ctx context.Context
|
|
RetryTimes int // the total execute times
|
|
RetryDelay int // time to delay seconds
|
|
}
|
|
|
|
// NewRetryDownloader creates a retry downloader
|
|
func NewRetryDownloader(ctx context.Context, downloader Downloader, retryTimes, retryDelay int) *RetryDownloader {
|
|
return &RetryDownloader{
|
|
Downloader: downloader,
|
|
ctx: ctx,
|
|
RetryTimes: retryTimes,
|
|
RetryDelay: retryDelay,
|
|
}
|
|
}
|
|
|
|
func (d *RetryDownloader) retry(work func() error) error {
|
|
var (
|
|
times = d.RetryTimes
|
|
err error
|
|
)
|
|
for ; times > 0; times-- {
|
|
if err = work(); err == nil {
|
|
return nil
|
|
}
|
|
if IsErrNotSupported(err) {
|
|
return err
|
|
}
|
|
select {
|
|
case <-d.ctx.Done():
|
|
return d.ctx.Err()
|
|
case <-time.After(time.Second * time.Duration(d.RetryDelay)):
|
|
break
|
|
}
|
|
}
|
|
return err
|
|
}
|
|
|
|
// SetContext set context
|
|
func (d *RetryDownloader) SetContext(ctx context.Context) {
|
|
d.ctx = ctx
|
|
d.Downloader.SetContext(ctx)
|
|
}
|
|
|
|
// GetRepoInfo returns a repository information with retry
|
|
func (d *RetryDownloader) GetRepoInfo() (*Repository, error) {
|
|
var (
|
|
repo *Repository
|
|
err error
|
|
)
|
|
|
|
err = d.retry(func() error {
|
|
repo, err = d.Downloader.GetRepoInfo()
|
|
return err
|
|
})
|
|
|
|
return repo, err
|
|
}
|
|
|
|
// GetTopics returns a repository's topics with retry
|
|
func (d *RetryDownloader) GetTopics() ([]string, error) {
|
|
var (
|
|
topics []string
|
|
err error
|
|
)
|
|
|
|
err = d.retry(func() error {
|
|
topics, err = d.Downloader.GetTopics()
|
|
return err
|
|
})
|
|
|
|
return topics, err
|
|
}
|
|
|
|
// GetMilestones returns a repository's milestones with retry
|
|
func (d *RetryDownloader) GetMilestones() ([]*Milestone, error) {
|
|
var (
|
|
milestones []*Milestone
|
|
err error
|
|
)
|
|
|
|
err = d.retry(func() error {
|
|
milestones, err = d.Downloader.GetMilestones()
|
|
return err
|
|
})
|
|
|
|
return milestones, err
|
|
}
|
|
|
|
// GetReleases returns a repository's releases with retry
|
|
func (d *RetryDownloader) GetReleases() ([]*Release, error) {
|
|
var (
|
|
releases []*Release
|
|
err error
|
|
)
|
|
|
|
err = d.retry(func() error {
|
|
releases, err = d.Downloader.GetReleases()
|
|
return err
|
|
})
|
|
|
|
return releases, err
|
|
}
|
|
|
|
// GetLabels returns a repository's labels with retry
|
|
func (d *RetryDownloader) GetLabels() ([]*Label, error) {
|
|
var (
|
|
labels []*Label
|
|
err error
|
|
)
|
|
|
|
err = d.retry(func() error {
|
|
labels, err = d.Downloader.GetLabels()
|
|
return err
|
|
})
|
|
|
|
return labels, err
|
|
}
|
|
|
|
// GetIssues returns a repository's issues with retry
|
|
func (d *RetryDownloader) GetIssues(page, perPage int) ([]*Issue, bool, error) {
|
|
var (
|
|
issues []*Issue
|
|
isEnd bool
|
|
err error
|
|
)
|
|
|
|
err = d.retry(func() error {
|
|
issues, isEnd, err = d.Downloader.GetIssues(page, perPage)
|
|
return err
|
|
})
|
|
|
|
return issues, isEnd, err
|
|
}
|
|
|
|
// GetComments returns a repository's comments with retry
|
|
func (d *RetryDownloader) GetComments(commentable Commentable) ([]*Comment, bool, error) {
|
|
var (
|
|
comments []*Comment
|
|
isEnd bool
|
|
err error
|
|
)
|
|
|
|
err = d.retry(func() error {
|
|
comments, isEnd, err = d.Downloader.GetComments(commentable)
|
|
return err
|
|
})
|
|
|
|
return comments, isEnd, err
|
|
}
|
|
|
|
// GetPullRequests returns a repository's pull requests with retry
|
|
func (d *RetryDownloader) GetPullRequests(page, perPage int) ([]*PullRequest, bool, error) {
|
|
var (
|
|
prs []*PullRequest
|
|
err error
|
|
isEnd bool
|
|
)
|
|
|
|
err = d.retry(func() error {
|
|
prs, isEnd, err = d.Downloader.GetPullRequests(page, perPage)
|
|
return err
|
|
})
|
|
|
|
return prs, isEnd, err
|
|
}
|
|
|
|
// GetReviews returns pull requests reviews
|
|
func (d *RetryDownloader) GetReviews(reviewable Reviewable) ([]*Review, error) {
|
|
var (
|
|
reviews []*Review
|
|
err error
|
|
)
|
|
|
|
err = d.retry(func() error {
|
|
reviews, err = d.Downloader.GetReviews(reviewable)
|
|
return err
|
|
})
|
|
|
|
return reviews, err
|
|
}
|