user

package

v0.4.3 Latest Latest Go to latest Published: Apr 7, 2024 License: MIT Imports: 6 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/kyleu/admini

Links

Open Source Insights

Documentation ¶

Overview ¶

Package user - Content managed by Project Forge, see [projectforge.md] for details.

Index ¶

Variables
func Check(path string, accounts Accounts) (bool, string)
func IsAdmin(accounts Accounts) bool
func SetPermissions(allowDefault bool, ps ...*Permission)
type Account
type Accounts
- func AccountsFromString(s string) Accounts
type Permission
- func Perm(p string, m string, a bool) *Permission
- func (p Permission) Matches(path string) bool
- func (p Permission) String() string
type Permissions
- func GetPermissions() Permissions
- func (p Permissions) Check(path string, accounts Accounts) (bool, string)
- func (p Permissions) Sort()
type Profile

Constants ¶

This section is empty.

Variables ¶

View Source

var DefaultProfile = &Profile{Name: "Guest"}

View Source

var (
	PermissionsLogger util.Logger
)

Functions ¶

func Check ¶

func Check(path string, accounts Accounts) (bool, string)

func IsAdmin ¶ added in v0.2.12

func IsAdmin(accounts Accounts) bool

func SetPermissions ¶

func SetPermissions(allowDefault bool, ps ...*Permission)

Types ¶

type Account ¶

type Account struct {
	Provider string `json:"provider"`
	Email    string `json:"email"`
	Picture  string `json:"picture"`
	Token    string `json:"-"`
}

func (*Account) Domain ¶ added in v0.2.12

func (a *Account) Domain() string

func (*Account) String ¶

func (a *Account) String() string

func (*Account) TitleString ¶ added in v0.2.12

func (a *Account) TitleString() string

type Accounts ¶

type Accounts []*Account

func AccountsFromString ¶

func AccountsFromString(s string) Accounts

func (Accounts) GetByProvider ¶

func (a Accounts) GetByProvider(p string) Accounts

func (Accounts) GetByProviderDomain ¶ added in v0.2.12

func (a Accounts) GetByProviderDomain(p string, d string) *Account

func (Accounts) Image ¶ added in v0.2.12

func (a Accounts) Image() string

func (Accounts) Images ¶ added in v0.2.12

func (a Accounts) Images() []string

func (Accounts) Matches ¶

func (a Accounts) Matches(match string) bool

func (Accounts) Purge ¶

func (a Accounts) Purge(keys ...string) Accounts

func (Accounts) Sort ¶

func (a Accounts) Sort()

func (Accounts) String ¶

func (a Accounts) String() string

func (Accounts) TitleString ¶ added in v0.2.12

func (a Accounts) TitleString() string

type Permission ¶

type Permission struct {
	Path  string `json:"path"`
	Match string `json:"match"`
	Allow bool   `json:"allow"`
}

func Perm ¶

func Perm(p string, m string, a bool) *Permission

func (Permission) Matches ¶

func (p Permission) Matches(path string) bool

func (Permission) String ¶

func (p Permission) String() string

type Permissions ¶

type Permissions []*Permission

func GetPermissions ¶

func GetPermissions() Permissions

func (Permissions) Check ¶

func (p Permissions) Check(path string, accounts Accounts) (bool, string)

func (Permissions) Sort ¶

func (p Permissions) Sort()

type Profile ¶

type Profile struct {
	Name  string `json:"name,omitempty"`
	Mode  string `json:"mode,omitempty"`
	Theme string `json:"theme,omitempty"`
}

func (*Profile) Clone ¶

func (p *Profile) Clone() *Profile

func (*Profile) Equals ¶

func (p *Profile) Equals(x *Profile) bool

func (*Profile) ModeClass ¶

func (p *Profile) ModeClass() string

func (*Profile) String ¶

func (p *Profile) String() string

Source Files ¶

View all Source files

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