Files
OwnCord/Server/permissions/checker.go
T
J3vbandClaude Fable 5 249e35af91 feat(server): unify channel-visibility through permissions.Checker
Route the four "must mirror" READ_MESSAGES filters — REST
ListVisibleChannels, ws buildReady, reconnect replay
computeAllowedChannels, and hub RefreshChannelVisibility — through a
single permissions.Checker predicate so a drift can never leak a
private channel (audit A-2026-07-07 / backlog item 3).

- add permissions.Checker.VisibleChannelIDs + ChannelRef (skips dm,
  fails closed, admin bypass via HasChannelPermBatch)
- delegate the three batch sites; RefreshChannelVisibility uses
  HasChannelPerm instead of its inline EffectivePerms copy
- REST/WS agreement test asserting all three sites yield the identical
  non-DM set across admin / member-with-deny / denied-everywhere

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-20 11:28:03 +02:00

125 lines
4.8 KiB
Go

package permissions
import (
"errors"
"fmt"
)
// ─── Errors ─────────────────────────────────────────────────────────────────
// ErrNotDMParticipant is returned when a user is not a participant in a DM channel.
var ErrNotDMParticipant = errors.New("not a participant in this DM")
// ErrPermissionDenied is returned when a user lacks the required permission.
var ErrPermissionDenied = errors.New("permission denied")
// ─── DB interface ───────────────────────────────────────────────────────────
// ChannelOverride holds the allow/deny permission bits for a single channel.
type ChannelOverride struct {
Allow int64
Deny int64
}
// ChannelRef is the minimal channel description VisibleChannelIDs needs.
// Declared here (not imported from db) so the permissions package stays free
// of a db dependency; callers map their []db.Channel down to []ChannelRef.
type ChannelRef struct {
ID int64
Type string
}
// DB is the minimal database interface the Checker needs.
// Defined at the consumer (per Go convention: accept interfaces, return structs).
type DB interface {
GetChannelPermissions(channelID, roleID int64) (allow, deny int64, err error)
IsDMParticipant(userID, channelID int64) (bool, error)
}
// ─── Checker ────────────────────────────────────────────────────────────────
// Checker consolidates all channel permission checks into one reusable type.
// It is safe to share across goroutines because it holds no mutable state.
type Checker struct {
db DB
}
// NewChecker creates a Checker backed by the given database interface.
func NewChecker(db DB) *Checker {
return &Checker{db: db}
}
// HasChannelPerm reports whether the role (identified by rolePerms and roleID)
// has all the given permission bits on the specified channel. Administrator
// roles bypass all checks. Channel overrides (allow/deny) are fetched from the
// database per call.
func (ck *Checker) HasChannelPerm(rolePerms int64, roleID, channelID, perm int64) bool {
if HasAdmin(rolePerms) {
return true
}
allow, deny, err := ck.db.GetChannelPermissions(channelID, roleID)
if err != nil {
return false
}
effective := EffectivePerms(rolePerms, allow, deny)
return effective&perm == perm
}
// HasChannelPermBatch reports whether the role has the given permission on the
// channel using a pre-fetched overrides map. This avoids N+1 queries when
// filtering many channels in bulk. The zero-value ChannelOverride (no entry in
// map) is correct -- it means no override exists.
func (ck *Checker) HasChannelPermBatch(rolePerms int64, overrides map[int64]ChannelOverride, channelID, perm int64) bool {
if HasAdmin(rolePerms) {
return true
}
o := overrides[channelID] // zero-value (0, 0) when no override exists
effective := EffectivePerms(rolePerms, o.Allow, o.Deny)
return effective&perm == perm
}
// VisibleChannelIDs returns the set of non-DM channel IDs the role (identified
// by rolePerms) may READ, using a pre-fetched overrides map. It is the single
// predicate behind every "which channels does this role see" site (REST
// ListVisibleChannels, the ws ready payload, and reconnect replay filtering) so
// they can never drift apart. DM channels are skipped — their visibility is
// membership-based, layered on top by the caller. A nil/zero role yields an
// empty set naturally (no admin bypass, no base READ, and no override map
// entries to grant it).
func (ck *Checker) VisibleChannelIDs(rolePerms int64, channels []ChannelRef, overrides map[int64]ChannelOverride) map[int64]bool {
visible := make(map[int64]bool)
for _, ch := range channels {
if ch.Type == "dm" {
continue
}
if ck.HasChannelPermBatch(rolePerms, overrides, ch.ID, ReadMessages) {
visible[ch.ID] = true
}
}
return visible
}
// RequireChannelAccess checks whether the user can access the channel with the
// given permission. For DM channels (channelType == "dm"), it verifies
// participant membership via IsDMParticipant. For regular channels, it checks
// role-based permissions via HasChannelPerm.
//
// Returns nil on success, or a descriptive error on failure.
func (ck *Checker) RequireChannelAccess(userID, rolePerms, roleID int64, channelType string, channelID, perm int64) error {
if channelType == "dm" {
ok, err := ck.db.IsDMParticipant(userID, channelID)
if err != nil {
return fmt.Errorf("checking DM participation: %w", err)
}
if !ok {
return ErrNotDMParticipant
}
return nil
}
if !ck.HasChannelPerm(rolePerms, roleID, channelID, perm) {
return ErrPermissionDenied
}
return nil
}