auth

package

v0.0.0-...-94e6d93 Latest Latest Go to latest Published: Apr 4, 2023 License: Apache-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ngld/knossos

Documentation ¶

Index ¶

Variables
func CheckPermission(ctx context.Context, perm Permission, bag Bag) error
func GetRole(ctx context.Context) (*rbac.Role, error)
func GetUser(ctx context.Context) (guardian.Info, error)
func Init(q *queries.DBQuerier)
func IssueToken(ctx context.Context, username string, uid int, roles []string) (string, error)
func MakeAuthMiddleware(next http.Handler) http.Handler
func MarshalBag(src interface{}) (string, error)
func UnmarshalBag(data string, dest interface{}) error
type Bag
type ModBag
type Permission
type UserBag

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrMissingParameters is returned if some required fields on the input message are missing / unset
	ErrMissingParameters = eris.New("some parameters are missing")

	// ErrDbIssue is returned if the request could not be processed due to DB issues
	ErrDbIssue = eris.New("a DB query failed")

	// ErrAuthCtxMissing is returned if the request didn't contain an authContext
	ErrAuthCtxMissing = eris.New("auth context missing")
)

View Source

var ErrInvalidRole = eris.New("invalid user role")

ErrInvalidRole is returned if the current user has an invalid role

View Source

var ErrInvalidTarget = eris.New("invalid target")

ErrInvalidTarget is returned if the target doesn't follow the expected format

Functions ¶

func CheckPermission ¶

func CheckPermission(ctx context.Context, perm Permission, bag Bag) error

CheckPermission verifies that the currently authenticated user has the given permission

func GetRole ¶

func GetRole(ctx context.Context) (*rbac.Role, error)

GetRole checks authentication if necessary and returns the user's role

func GetUser ¶

func GetUser(ctx context.Context) (guardian.Info, error)

GetUser returns the current user info

func Init ¶

func Init(q *queries.DBQuerier)

Init prepares static objects used throughout the lifecycle

func IssueToken ¶

func IssueToken(ctx context.Context, username string, uid int, roles []string) (string, error)

IssueToken generates a new session token with the associated user

func MakeAuthMiddleware ¶

func MakeAuthMiddleware(next http.Handler) http.Handler

MakeAuthMiddleware constructs the necessary middleware required for our Auth* API

func MarshalBag ¶

func MarshalBag(src interface{}) (string, error)

func UnmarshalBag ¶

func UnmarshalBag(data string, dest interface{}) error

Types ¶

type Bag ¶

type Bag struct{}

type ModBag ¶

type ModBag struct {
	Bag
	UserID         int
	ModID          string
	ReleaseVersion string
}

type Permission ¶

type Permission string

const (
	// Mods [takes ModBag]
	PermViewMod   Permission = "ViewMod"
	PermCreateMod Permission = "CreateMod"
	PermEditMod   Permission = "EditMod"
	PermDeleteMod Permission = "DeleteMod"

	// Special perms [takes ModBag]
	PermEditModTeam  Permission = "EditModTeam"
	PermCreateEngine Permission = "CreateEngine"

	// Releases [takes ModBag]
	PermViewRelease   Permission = "ViewRelease"
	PermCreateRelease Permission = "CreateRelease"
	PermEditRelease   Permission = "EditRelease"
	PermDeleteRelease Permission = "DeleteRelease"

	// Users [takes UserBag]
	// Note: CreateUser does *not* apply to the normal registration process
	PermCreateUser Permission = "CreateUser"
	PermEditUser   Permission = "EditUser"
	PermDeleteUser Permission = "DeleteUser"
)

type UserBag ¶

type UserBag struct {
	Bag
	CurrentUser int
	TargetUser  int
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL