mirror of
https://github.com/go-gitea/gitea
synced 2024-11-01 01:03:39 +01:00
bbffcc3aec
There are multiple places where Gitea does not properly escape URLs that it is building and there are multiple places where it builds urls when there is already a simpler function available to use this.
This is an extensive PR attempting to fix these issues.
1. The first commit in this PR looks through all href, src and links in the Gitea codebase and has attempted to catch all the places where there is potentially incomplete escaping.
2. Whilst doing this we will prefer to use functions that create URLs over recreating them by hand.
3. All uses of strings should be directly escaped - even if they are not currently expected to contain escaping characters. The main benefit to doing this will be that we can consider relaxing the constraints on user names and reponames in future.
4. The next commit looks at escaping in the wiki and re-considers the urls that are used there. Using the improved escaping here wiki files containing '/'. (This implementation will currently still place all of the wiki files the root directory of the repo but this would not be difficult to change.)
5. The title generation in feeds is now properly escaped.
6. EscapePound is no longer needed - urls should be PathEscaped / QueryEscaped as necessary but then re-escaped with Escape when creating html with locales Signed-off-by: Andrew Thornton <art27@cantab.net>
Signed-off-by: Andrew Thornton <art27@cantab.net>
217 lines
6.2 KiB
Go
217 lines
6.2 KiB
Go
// Copyright 2017 The Gitea Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package repo
|
|
|
|
import (
|
|
"io"
|
|
"net/http"
|
|
"testing"
|
|
|
|
"code.gitea.io/gitea/models"
|
|
"code.gitea.io/gitea/models/unittest"
|
|
"code.gitea.io/gitea/modules/git"
|
|
"code.gitea.io/gitea/modules/test"
|
|
"code.gitea.io/gitea/modules/web"
|
|
"code.gitea.io/gitea/services/forms"
|
|
wiki_service "code.gitea.io/gitea/services/wiki"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
const content = "Wiki contents for unit tests"
|
|
const message = "Wiki commit message for unit tests"
|
|
|
|
func wikiEntry(t *testing.T, repo *models.Repository, wikiName string) *git.TreeEntry {
|
|
wikiRepo, err := git.OpenRepository(repo.WikiPath())
|
|
assert.NoError(t, err)
|
|
defer wikiRepo.Close()
|
|
commit, err := wikiRepo.GetBranchCommit("master")
|
|
assert.NoError(t, err)
|
|
entries, err := commit.ListEntries()
|
|
assert.NoError(t, err)
|
|
for _, entry := range entries {
|
|
if entry.Name() == wiki_service.NameToFilename(wikiName) {
|
|
return entry
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func wikiContent(t *testing.T, repo *models.Repository, wikiName string) string {
|
|
entry := wikiEntry(t, repo, wikiName)
|
|
if !assert.NotNil(t, entry) {
|
|
return ""
|
|
}
|
|
reader, err := entry.Blob().DataAsync()
|
|
assert.NoError(t, err)
|
|
defer reader.Close()
|
|
bytes, err := io.ReadAll(reader)
|
|
assert.NoError(t, err)
|
|
return string(bytes)
|
|
}
|
|
|
|
func assertWikiExists(t *testing.T, repo *models.Repository, wikiName string) {
|
|
assert.NotNil(t, wikiEntry(t, repo, wikiName))
|
|
}
|
|
|
|
func assertWikiNotExists(t *testing.T, repo *models.Repository, wikiName string) {
|
|
assert.Nil(t, wikiEntry(t, repo, wikiName))
|
|
}
|
|
|
|
func assertPagesMetas(t *testing.T, expectedNames []string, metas interface{}) {
|
|
pageMetas, ok := metas.([]PageMeta)
|
|
if !assert.True(t, ok) {
|
|
return
|
|
}
|
|
if !assert.Len(t, pageMetas, len(expectedNames)) {
|
|
return
|
|
}
|
|
for i, pageMeta := range pageMetas {
|
|
assert.EqualValues(t, expectedNames[i], pageMeta.Name)
|
|
}
|
|
}
|
|
|
|
func TestWiki(t *testing.T) {
|
|
unittest.PrepareTestEnv(t)
|
|
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/?action=_pages")
|
|
ctx.SetParams("*", "Home")
|
|
test.LoadRepo(t, ctx, 1)
|
|
Wiki(ctx)
|
|
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status())
|
|
assert.EqualValues(t, "Home", ctx.Data["Title"])
|
|
assertPagesMetas(t, []string{"Home", "Page With Image", "Page With Spaced Name", "Unescaped File"}, ctx.Data["Pages"])
|
|
}
|
|
|
|
func TestWikiPages(t *testing.T) {
|
|
unittest.PrepareTestEnv(t)
|
|
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/?action=_pages")
|
|
test.LoadRepo(t, ctx, 1)
|
|
WikiPages(ctx)
|
|
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status())
|
|
assertPagesMetas(t, []string{"Home", "Page With Image", "Page With Spaced Name", "Unescaped File"}, ctx.Data["Pages"])
|
|
}
|
|
|
|
func TestNewWiki(t *testing.T) {
|
|
unittest.PrepareTestEnv(t)
|
|
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/?action=_new")
|
|
test.LoadUser(t, ctx, 2)
|
|
test.LoadRepo(t, ctx, 1)
|
|
NewWiki(ctx)
|
|
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status())
|
|
assert.EqualValues(t, ctx.Tr("repo.wiki.new_page"), ctx.Data["Title"])
|
|
}
|
|
|
|
func TestNewWikiPost(t *testing.T) {
|
|
for _, title := range []string{
|
|
"New page",
|
|
"&&&&",
|
|
} {
|
|
unittest.PrepareTestEnv(t)
|
|
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/?action=_new")
|
|
test.LoadUser(t, ctx, 2)
|
|
test.LoadRepo(t, ctx, 1)
|
|
web.SetForm(ctx, &forms.NewWikiForm{
|
|
Title: title,
|
|
Content: content,
|
|
Message: message,
|
|
})
|
|
NewWikiPost(ctx)
|
|
assert.EqualValues(t, http.StatusFound, ctx.Resp.Status())
|
|
assertWikiExists(t, ctx.Repo.Repository, title)
|
|
assert.Equal(t, wikiContent(t, ctx.Repo.Repository, title), content)
|
|
}
|
|
}
|
|
|
|
func TestNewWikiPost_ReservedName(t *testing.T) {
|
|
unittest.PrepareTestEnv(t)
|
|
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/?action=_new")
|
|
test.LoadUser(t, ctx, 2)
|
|
test.LoadRepo(t, ctx, 1)
|
|
web.SetForm(ctx, &forms.NewWikiForm{
|
|
Title: "_edit",
|
|
Content: content,
|
|
Message: message,
|
|
})
|
|
NewWikiPost(ctx)
|
|
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status())
|
|
assert.EqualValues(t, ctx.Tr("repo.wiki.reserved_page"), ctx.Flash.ErrorMsg)
|
|
assertWikiNotExists(t, ctx.Repo.Repository, "_edit")
|
|
}
|
|
|
|
func TestEditWiki(t *testing.T) {
|
|
unittest.PrepareTestEnv(t)
|
|
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/Home?action=_edit")
|
|
ctx.SetParams("*", "Home")
|
|
test.LoadUser(t, ctx, 2)
|
|
test.LoadRepo(t, ctx, 1)
|
|
EditWiki(ctx)
|
|
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status())
|
|
assert.EqualValues(t, "Home", ctx.Data["Title"])
|
|
assert.Equal(t, wikiContent(t, ctx.Repo.Repository, "Home"), ctx.Data["content"])
|
|
}
|
|
|
|
func TestEditWikiPost(t *testing.T) {
|
|
for _, title := range []string{
|
|
"Home",
|
|
"New/<page>",
|
|
} {
|
|
unittest.PrepareTestEnv(t)
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/Home?action=_new")
|
|
ctx.SetParams("*", "Home")
|
|
test.LoadUser(t, ctx, 2)
|
|
test.LoadRepo(t, ctx, 1)
|
|
web.SetForm(ctx, &forms.NewWikiForm{
|
|
Title: title,
|
|
Content: content,
|
|
Message: message,
|
|
})
|
|
EditWikiPost(ctx)
|
|
assert.EqualValues(t, http.StatusFound, ctx.Resp.Status())
|
|
assertWikiExists(t, ctx.Repo.Repository, title)
|
|
assert.Equal(t, wikiContent(t, ctx.Repo.Repository, title), content)
|
|
if title != "Home" {
|
|
assertWikiNotExists(t, ctx.Repo.Repository, "Home")
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestDeleteWikiPagePost(t *testing.T) {
|
|
unittest.PrepareTestEnv(t)
|
|
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/Home?action=_delete")
|
|
test.LoadUser(t, ctx, 2)
|
|
test.LoadRepo(t, ctx, 1)
|
|
DeleteWikiPagePost(ctx)
|
|
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status())
|
|
assertWikiNotExists(t, ctx.Repo.Repository, "Home")
|
|
}
|
|
|
|
func TestWikiRaw(t *testing.T) {
|
|
for filepath, filetype := range map[string]string{
|
|
"jpeg.jpg": "image/jpeg",
|
|
"images/jpeg.jpg": "image/jpeg",
|
|
"Page With Spaced Name": "text/plain; charset=utf-8",
|
|
"Page-With-Spaced-Name": "text/plain; charset=utf-8",
|
|
"Page With Spaced Name.md": "text/plain; charset=utf-8",
|
|
"Page-With-Spaced-Name.md": "text/plain; charset=utf-8",
|
|
} {
|
|
unittest.PrepareTestEnv(t)
|
|
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/raw/"+filepath)
|
|
ctx.SetParams("*", filepath)
|
|
test.LoadUser(t, ctx, 2)
|
|
test.LoadRepo(t, ctx, 1)
|
|
WikiRaw(ctx)
|
|
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status())
|
|
assert.EqualValues(t, filetype, ctx.Resp.Header().Get("Content-Type"))
|
|
}
|
|
}
|