rbac

package

v1.9.2 Latest Latest Go to latest Published: Nov 20, 2020 License: GPL-3.0 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/isi-nc/autentigo

Links

Open Source Insights

Documentation ¶

Index ¶

func GroupsFromToken(token *jwt.Token) (groups []string)
func Match(role string, user *User) bool
func MatchRequest(role string, req *http.Request) (authn, authz bool)
func SetDefaults(iface Interface, validationCrt []byte)
type Config
- func FromBytes(ba []byte) (config *Config, err error)
- func FromFile(path string) (config *Config, err error)
type Interface
type Rule
- func (r Rule) Match(user *User) bool
type User
- func UserFromRequest(req *http.Request, validationCrt []byte) (u *User)
- func UserFromToken(token *jwt.Token) (u *User)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GroupsFromToken ¶

func GroupsFromToken(token *jwt.Token) (groups []string)

GroupsFromToken returns the groups claimed by the token

func Match ¶

func Match(role string, user *User) bool

func MatchRequest ¶

func MatchRequest(role string, req *http.Request) (authn, authz bool)

func SetDefaults ¶

func SetDefaults(iface Interface, validationCrt []byte)

SetDefaults sets everything up for default matchers.

Types ¶

type Config ¶

type Config struct {
	// Roles every user has.
	Base []string

	// Rules to determine a user's roles.
	Rules []Rule
}

Config is a simple RBAC configuration.

func FromBytes ¶

func FromBytes(ba []byte) (config *Config, err error)

func FromFile ¶

func FromFile(path string) (config *Config, err error)

func (*Config) Match ¶

func (c *Config) Match(role string, user *User) bool

func (*Config) MatchRequest ¶

func (c *Config) MatchRequest(role string, req *http.Request, validationCrt []byte) (authn, authz bool)

func (*Config) RolesOf ¶

func (c *Config) RolesOf(user *User) (roles []string)

type Interface ¶

type Interface interface {
	Match(role string, user *User) bool
	MatchRequest(role string, req *http.Request, validationCrt []byte) (authn, authz bool)
}

Interface of an RBAC backend

var (
	// Default interface used for default matchers.
	Default Interface

	// DefaultValidationCertificate used for default matchers.
	DefaultValidationCertificate []byte
)

type Rule ¶

type Rule struct {
	Role   string
	Users  []string
	Groups []string
}

Rule is a simple RBAC rule to match a role

func (Rule) Match ¶

func (r Rule) Match(user *User) bool

type User ¶

type User struct {
	Name   string
	Groups []string
}

User describes a user for the simple RBAC backend

func UserFromRequest ¶

func UserFromRequest(req *http.Request, validationCrt []byte) (u *User)

UserFromRequest returns a User object from the given request or `nil` if the token is not found or invalid.

func UserFromToken ¶

func UserFromToken(token *jwt.Token) (u *User)

UserFromToken returns a User object from the given token.

Source Files ¶

View all Source files

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