gogate

Jun 9, 2026

Changes in this version

+ var ErrPermissionAlreadyExists = errors.New("wpd-gogate: permission already exists")

+ var ErrRoleAlreadyExists = errors.New("wpd-gogate: role already exists")

type Gate

+ func (g *Gate) GetAllPermissionsMap(ctx context.Context) (map[string][]string, error)

+ func (g *Gate) GetAllRolesMap(ctx context.Context) (map[string][]string, error)

Jun 9, 2026

Changes in this version

+ func IsNilOrEmpty(val any) bool

type MiddlewareOptions

+ GuardName string

type ModelRef

+ func (m *ModelRef) GetRolesMap(ctx context.Context) (map[string][]string, error)

+ func (m *ModelRef) HasAllPermissions(ctx context.Context, permissionNames ...string) (bool, error)

+ func (m *ModelRef) HasAllRoles(ctx context.Context, guardName string, roleNames ...string) (bool, error)

+ func (m *ModelRef) HasAnyPermission(ctx context.Context, permissionNames ...string) (bool, error)

+ func (m *ModelRef) HasAnyRole(ctx context.Context, guardName string, roleNames ...string) (bool, error)

+ func (m *ModelRef) HasRole(ctx context.Context, roleName string, guardName string) (bool, error)

Jun 5, 2026

Changes in this version

+ func RequirePermission(gate *Gate, permissionName string, opts *MiddlewareOptions) echo.MiddlewareFunc

+ type Config struct

+ DefaultGuardName string

+ ModelHasPermissionsTable string

+ ModelHasRolesTable string

+ PermissionsTable string

+ RoleHasPermissionsTable string

+ RolesTable string

+ func DefaultConfig() Config

+ type DBTX interface

+ ExecContext func(ctx context.Context, query string, args ...any) (sql.Result, error)

+ QueryContext func(ctx context.Context, query string, args ...any) (*sql.Rows, error)

+ QueryRowContext func(ctx context.Context, query string, args ...any) *sql.Row

+ type Gate struct

+ func NewGate(db DBTX, cfg *Config) *Gate

+ func (g *Gate) Check(ctx context.Context, modelType string, modelID any, permissionName string, ...) (bool, error)

+ func (g *Gate) CreatePermission(ctx context.Context, name string, guardName string) error

+ func (g *Gate) CreateRole(ctx context.Context, name string, guardName string) error

+ func (g *Gate) DeletePermission(ctx context.Context, name string) error

+ func (g *Gate) DeleteRole(ctx context.Context, name string) error

+ func (g *Gate) HasRolePermission(roleName, permissionName string) bool

+ func (g *Gate) LoadPolicy(ctx context.Context) error

+ func (g *Gate) Model(modelType string, modelID any, teamID any) *ModelRef

+ func (g *Gate) Role(name string) *RoleRef

+ type MiddlewareOptions struct

+ ExtractModelID func(c echo.Context) (any, error)

+ ExtractTeamID func(c echo.Context) (any, error)

+ ModelType string

+ OnDenied func(c echo.Context, permissionName string) error

+ OnError func(c echo.Context, err error) error

+ func DefaultMiddlewareOptions() MiddlewareOptions

+ type ModelRef struct

+ func (m *ModelRef) AssignRole(ctx context.Context, roleName string) error

+ func (m *ModelRef) Can(ctx context.Context, permissionName string) (bool, error)

+ func (m *ModelRef) GetAllPermissions(ctx context.Context) ([]string, error)

+ func (m *ModelRef) GetDirectPermissions(ctx context.Context) ([]string, error)

+ func (m *ModelRef) GetPermissionsViaRoles(ctx context.Context) ([]string, error)

+ func (m *ModelRef) GetRoleNames(ctx context.Context) ([]string, error)

+ func (m *ModelRef) GivePermissionTo(ctx context.Context, permissionName string) error

+ func (m *ModelRef) RemoveRole(ctx context.Context, roleName string) error

+ func (m *ModelRef) RevokePermissionTo(ctx context.Context, permissionName string) error

+ type RoleRef struct

+ func (r *RoleRef) GetPermissionNames(ctx context.Context) ([]string, error)

+ func (r *RoleRef) GivePermissionTo(ctx context.Context, permissionName string) error

+ func (r *RoleRef) RevokePermissionTo(ctx context.Context, permissionName string) error