Files
vikunja/pkg/models/link_sharing_test.go
T
kolaente ce0d1355cf fix(security): reject link shares in Webhook.ReadAll
The guard on Webhook.CanRead is unreachable: no route exposes a read-one
webhook, and DoReadAll never calls CanRead. Two paths were left open:

- the v2 user-webhook list passes a.GetID() into Webhook.UserID, which is
  negative for a link share, so the w.UserID > 0 branch and its link share
  check were skipped and the request fell through to the project branch with
  project id 0, returning 404 instead of 403.
- the project branch never rejected link shares at all, so any holder of a
  public share link could list the project's webhooks. target_url is a bearer
  secret for Slack, Discord, Teams and Zapier.

Guard both by rejecting link shares at the top of ReadAll.
2026-08-04 13:40:11 +02:00

447 lines
12 KiB
Go

// Vikunja is a to-do list application to facilitate your life.
// Copyright 2018-present Vikunja and contributors. All rights reserved.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
package models
import (
"testing"
"time"
"code.vikunja.io/api/pkg/db"
"code.vikunja.io/api/pkg/user"
"github.com/golang-jwt/jwt/v5"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestLinkSharing_Create(t *testing.T) {
doer := &user.User{ID: 1}
t.Run("normal", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
share := &LinkSharing{
ProjectID: 1,
Permission: PermissionRead,
}
err := share.Create(s, doer)
require.NoError(t, err)
assert.NotEmpty(t, share.Hash)
assert.NotEmpty(t, share.ID)
assert.Equal(t, SharingTypeWithoutPassword, share.SharingType)
require.NoError(t, s.Commit())
db.AssertExists(t, "link_shares", map[string]interface{}{
"id": share.ID,
}, false)
})
t.Run("invalid permission", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
share := &LinkSharing{
ProjectID: 1,
Permission: Permission(123),
}
err := share.Create(s, doer)
require.Error(t, err)
assert.True(t, IsErrInvalidPermission(err))
})
t.Run("password should be hashed", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
share := &LinkSharing{
ProjectID: 1,
Permission: PermissionRead,
Password: "somePassword",
}
err := share.Create(s, doer)
require.NoError(t, err)
assert.NotEmpty(t, share.Hash)
assert.NotEmpty(t, share.ID)
assert.Empty(t, share.Password)
require.NoError(t, s.Commit())
db.AssertExists(t, "link_shares", map[string]interface{}{
"id": share.ID,
"sharing_type": SharingTypeWithPassword,
}, false)
})
}
func TestLinkSharing_ReadAll(t *testing.T) {
doer := &user.User{ID: 1}
t.Run("all no password", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
share := &LinkSharing{
ProjectID: 1,
}
all, _, _, err := share.ReadAll(s, doer, "", 1, -1)
shares := all.([]*LinkSharing)
require.NoError(t, err)
assert.Len(t, shares, 2)
for _, sharing := range shares {
assert.Empty(t, sharing.Password)
}
})
t.Run("search", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
share := &LinkSharing{
ProjectID: 1,
}
all, _, _, err := share.ReadAll(s, doer, "wITHPASS", 1, -1)
shares := all.([]*LinkSharing)
require.NoError(t, err)
assert.Len(t, shares, 1)
assert.Equal(t, int64(4), shares[0].ID)
})
t.Run("should forbid read-only users from listing link shares", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
// User 1 has only read access to project 3
share := &LinkSharing{
ProjectID: 3,
}
_, _, _, err := share.ReadAll(s, doer, "", 1, -1)
require.Error(t, err)
assert.True(t, IsErrGenericForbidden(err))
})
t.Run("should forbid write users from listing link shares", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
// User 1 has write access to project 10
share := &LinkSharing{
ProjectID: 10,
}
_, _, _, err := share.ReadAll(s, doer, "", 1, -1)
require.Error(t, err)
assert.True(t, IsErrGenericForbidden(err))
})
}
func TestLinkSharing_ReadOne(t *testing.T) {
doer := &user.User{ID: 1}
t.Run("normal", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
share := &LinkSharing{
ID: 1,
}
err := share.ReadOne(s, doer)
require.NoError(t, err)
assert.NotEmpty(t, share.Hash)
assert.Equal(t, SharingTypeWithoutPassword, share.SharingType)
})
t.Run("with password", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
share := &LinkSharing{
ID: 4,
}
err := share.ReadOne(s, doer)
require.NoError(t, err)
assert.NotEmpty(t, share.Hash)
assert.Equal(t, SharingTypeWithPassword, share.SharingType)
assert.Empty(t, share.Password)
})
}
// A link share id must never be mistaken for a users.id at a permission check.
// See GHSA-32r8-5843-4qw2.
func TestLinkSharing_GetID(t *testing.T) {
share := &LinkSharing{ID: 1}
assert.Equal(t, int64(-1), share.GetID())
assert.Negative(t, share.GetID())
}
func TestLinkSharing_toUser(t *testing.T) {
t.Run("empty name", func(t *testing.T) {
share := &LinkSharing{
ID: 1,
Name: "",
Created: time.Now(),
Updated: time.Now(),
}
user := share.toUser()
assert.Equal(t, "link-share-1", user.Username)
assert.Equal(t, "Link Share", user.Name)
assert.Equal(t, int64(-1), user.ID)
})
t.Run("name provided", func(t *testing.T) {
share := &LinkSharing{
ID: 2,
Name: "My Test Share",
Created: time.Now(),
Updated: time.Now(),
}
user := share.toUser()
assert.Equal(t, "link-share-2", user.Username)
assert.Equal(t, "My Test Share (Link Share)", user.Name)
assert.Equal(t, int64(-2), user.ID)
})
}
func TestGetLinkShareFromClaims(t *testing.T) {
// Mirrors NewLinkShareJWTAuthtoken, including the legacy `permission`
// and `sharedByID` claims so the tests below can prove they're ignored.
buildClaims := func(id int64, hash string, projectID int64, permission Permission, sharedByID int64) jwt.MapClaims {
return jwt.MapClaims{
"type": float64(2), // AuthTypeLinkShare
"id": float64(id),
"hash": hash,
"project_id": float64(projectID),
"permission": float64(permission),
"sharedByID": float64(sharedByID),
}
}
t.Run("valid share returns DB values", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
dbShare, err := GetLinkShareByID(s, 1)
require.NoError(t, err)
claims := buildClaims(dbShare.ID, dbShare.Hash, dbShare.ProjectID, dbShare.Permission, dbShare.SharedByID)
got, err := GetLinkShareFromClaims(s, claims)
require.NoError(t, err)
assert.Equal(t, dbShare.ID, got.ID)
assert.Equal(t, dbShare.Hash, got.Hash)
assert.Equal(t, dbShare.ProjectID, got.ProjectID)
assert.Equal(t, dbShare.Permission, got.Permission)
assert.Equal(t, dbShare.SharedByID, got.SharedByID)
})
t.Run("deleted share is rejected", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
dbShare, err := GetLinkShareByID(s, 1)
require.NoError(t, err)
claims := buildClaims(dbShare.ID, dbShare.Hash, dbShare.ProjectID, dbShare.Permission, dbShare.SharedByID)
_, err = s.Where("id = ?", dbShare.ID).Delete(&LinkSharing{})
require.NoError(t, err)
_, err = GetLinkShareFromClaims(s, claims)
require.Error(t, err)
assert.True(t, IsErrLinkShareTokenInvalid(err),
"expected ErrLinkShareTokenInvalid for deleted share, got %T: %v", err, err)
})
t.Run("permission downgrade takes effect immediately", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
dbShare, err := GetLinkShareByID(s, 3)
require.NoError(t, err)
require.Equal(t, PermissionAdmin, dbShare.Permission,
"fixture precondition: share id=3 must start as admin")
// Capture claims while the share is still admin, then downgrade.
claims := buildClaims(dbShare.ID, dbShare.Hash, dbShare.ProjectID, PermissionAdmin, dbShare.SharedByID)
_, err = s.Where("id = ?", dbShare.ID).Cols("permission").Update(&LinkSharing{Permission: PermissionRead})
require.NoError(t, err)
got, err := GetLinkShareFromClaims(s, claims)
require.NoError(t, err)
assert.Equal(t, PermissionRead, got.Permission,
"permission must come from DB, not from the (stale) JWT claim")
})
t.Run("hash mismatch is rejected", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
dbShare, err := GetLinkShareByID(s, 1)
require.NoError(t, err)
claims := buildClaims(dbShare.ID, "not-the-real-hash", dbShare.ProjectID, dbShare.Permission, dbShare.SharedByID)
_, err = GetLinkShareFromClaims(s, claims)
require.Error(t, err)
assert.True(t, IsErrLinkShareTokenInvalid(err))
})
t.Run("sharedByID comes from DB not from claim", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
dbShare, err := GetLinkShareByID(s, 1)
require.NoError(t, err)
// Bogus sharedByID in the claim must be ignored in favor of the DB value.
claims := buildClaims(dbShare.ID, dbShare.Hash, dbShare.ProjectID, dbShare.Permission, 9999999)
got, err := GetLinkShareFromClaims(s, claims)
require.NoError(t, err)
assert.Equal(t, dbShare.SharedByID, got.SharedByID)
})
t.Run("missing id claim is rejected", func(t *testing.T) {
s := db.NewSession()
defer s.Close()
claims := jwt.MapClaims{
"hash": "whatever",
}
_, err := GetLinkShareFromClaims(s, claims)
require.Error(t, err)
assert.True(t, IsErrLinkShareTokenInvalid(err))
})
t.Run("missing hash claim is rejected", func(t *testing.T) {
s := db.NewSession()
defer s.Close()
claims := jwt.MapClaims{
"id": float64(1),
}
_, err := GetLinkShareFromClaims(s, claims)
require.Error(t, err)
assert.True(t, IsErrLinkShareTokenInvalid(err))
})
}
func TestLinkSharing_CannotActAsCollidingUser(t *testing.T) {
t.Run("read a team the colliding user belongs to", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
// user 1 is a member of team 1
can, _, err := (&Team{ID: 1}).CanRead(s, &LinkSharing{ID: 1})
require.NoError(t, err)
assert.False(t, can)
})
t.Run("remove the colliding user from their team", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
tm := &TeamMember{TeamID: 1, Username: "user1"}
can, err := tm.CanDelete(s, &LinkSharing{ID: 1})
require.NoError(t, err)
assert.False(t, can)
})
t.Run("act on a bot owned by the colliding user", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
// user 23 is a bot owned by user 21
bot := &BotUser{User: user.User{ID: 23}}
share := &LinkSharing{ID: 21}
canRead, _, err := bot.CanRead(s, share)
require.NoError(t, err)
assert.False(t, canRead)
canUpdate, err := bot.CanUpdate(s, share)
require.NoError(t, err)
assert.False(t, canUpdate)
canDelete, err := bot.CanDelete(s, share)
require.NoError(t, err)
assert.False(t, canDelete)
})
t.Run("enumerate bots owned by the colliding user", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
_, _, _, err := (&BotUser{}).ReadAll(s, &LinkSharing{ID: 21}, "", 1, 50)
require.Error(t, err)
assert.True(t, IsErrGenericForbidden(err))
})
t.Run("read a user-level webhook owned by the colliding user", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
can, _, err := (&Webhook{UserID: 1}).CanRead(s, &LinkSharing{ID: 1})
require.NoError(t, err)
assert.False(t, can)
})
t.Run("list the webhooks of the colliding user", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
share := &LinkSharing{ID: 1}
// the route fills UserID from the auth object
_, _, _, err := (&Webhook{UserID: share.GetID()}).ReadAll(s, share, "", 1, 50)
require.Error(t, err)
assert.True(t, IsErrGenericForbidden(err))
})
t.Run("list the webhooks of the project the share points at", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
// link share 1 has read permission on project 1
share := &LinkSharing{ID: 1, ProjectID: 1, Permission: PermissionRead}
_, _, _, err := (&Webhook{ProjectID: 1}).ReadAll(s, share, "", 1, 50)
require.Error(t, err)
assert.True(t, IsErrGenericForbidden(err))
})
}