audit

Documentation

Overview

Package audit provides channel and role audit functionality. The audit rules are:

• Admin role can only be held by specific roles
• @everyone role must match specific permissions
• Any roles providing extra permissions must be explicitly defined
• Channels should only provide visibility for a single base role
• Exceptions to be explicit
• Read Only channels can provide custom permissions for the role allowed to
• write.

Index

• Variables
• type Channels
  • func (c Channels) Names() []string
  • func (c Channels) Sort()
• type Inspection
  • func (i *Inspection) Check(session *discordgo.Session, id string) error
• type Roles
  • func (r Roles) Names() []string
  • func (r Roles) Sort()

Variables

var RolePermissions = map[string]int64{
	"@everyone":        basePermissions,
	"Amenity Leader":   1071698538049,
	"Mods":             1440260156551,
	"Discord Security": 2196338376671,
	"Announcements":    2198083203015,
	"Admin":            2189895925759,
	"Owner":            1069551046217,
}

RolePermissions we expect.

Types

type Channels

type Channels []*discordgo.Channel

Channels in a Discord server.

func (Channels) Names

func (c Channels) Names() []string

Names of the channels in this set.

func (Channels) Sort

func (c Channels) Sort()

Sort the channels by position.

type Inspection

type Inspection struct {
	Admin Roles
	Base  Roles
	Deny  Channels
	Allow Channels
	Roles map[string]int64
}

Inspection on a server.

func (*Inspection) Check

func (i *Inspection) Check(session *discordgo.Session, id string) error

Check the given server for permission violations.

type Roles

type Roles []*discordgo.Role

Roles in a Discord server.

func (Roles) Names

func (r Roles) Names() []string

Names of the roles in this set.

func (Roles) Sort

func (r Roles) Sort()

Sort the roles by position.