auth

Documentation

Index

• type ACE
• type ACL
• type Action
• type DefaultAuthorizationPolicy
  • func (p DefaultAuthorizationPolicy) Permits(acl ACL, principals Principals, permission string) bool
• type Policy
• type Principals
  • func (p Principals) Contains(princip string) bool
• type System
  • func New(m *model.Model, db *yago.DB, l hermes.Logger, duration time.Duration, ...) *System
  • func (s System) CreateGroup(groupName string) (model.Group, error)
  • func (s System) CreatePerm(permName string) (model.Permission, error)
  • func (s System) CreateUser(userName, password string, perms []string) (*model.User, error)
  • func (s System) GetToken(name string, roles []string) (string, error)
  • func (s System) GetUserPrincipals(userName string) (Principals, error)
  • func (s System) GiveGroup(userID, groupID int64) error
  • func (s System) GivePerm(groupID, permID int64) error
  • func (s System) VerifyUserPassword(userName, givenPassword string) (valid bool, err error)

Types

type ACE

type ACE struct {
	Action     Action // Allow or Deny
	Principal  string // can be a user, group or any string
	Permission string // a permission string "CanDeleteUsers"
}

ACE (access control entry) is one element of an ACL

type ACL

type ACL []ACE

ACL (access control list) is a list of ACE

type Action

type Action int

Action can be either Deny (0) or Allow (1) see the constants declared below

const (
	// Deny is action that can be used in an ACE to actively
	// deny access to a certain principal
	Deny Action = iota
	// Allow can be used in an ACE to give a permission to a principal
	Allow
)

type DefaultAuthorizationPolicy

type DefaultAuthorizationPolicy struct{}

DefaultAuthorizationPolicy is the policy used by default in Hermes it implements the Policy interface

func (DefaultAuthorizationPolicy) Permits

func (p DefaultAuthorizationPolicy) Permits(acl ACL, principals Principals, permission string) bool

Permits implements the Policy interface by checking if the given principals are permitted the given permission in the context of the given ACL

type Policy

type Policy interface {
	Permits(acl ACL, principals Principals, permission string) bool
}

Policy is the interface an authorization policy must implement An authorization policy is a policy that allows or denies access after a user has been authenticated

type Principals

type Principals []string

Principals is a collection of principals

func (Principals) Contains

func (p Principals) Contains(princip string) bool

Contains tests if a principal is present in the list

type System

type System struct {
	JwtSecret string
	// contains filtered or unexported fields
}

System is responsible to verify if an actor that claims to be is really what is says... (ie: authentication)

func New

func New(m *model.Model, db *yago.DB, l hermes.Logger, duration time.Duration, jwtSecret string) *System

New is a constructor that sets up a auth.System. duration is used to determine how long a token produced by this system will last. jwtSecret is the secret string that will be used as a key to

func (System) CreateGroup

func (s System) CreateGroup(groupName string) (model.Group, error)

CreateGroup is used to create a group.

func (System) CreatePerm

func (s System) CreatePerm(permName string) (model.Permission, error)

CreatePerm is used to create a permission.

func (System) CreateUser

func (s System) CreateUser(userName, password string, perms []string) (*model.User, error)

CreateUser is a method used to create a new user in the system and setting its password in the database

func (System) GetToken

func (s System) GetToken(name string, roles []string) (string, error)

GetToken generates a token with claims corresponding to the name and roles you give. This token is signed with the auth.System secret

func (System) GetUserPrincipals

func (s System) GetUserPrincipals(userName string) (Principals, error)

GetUserPrincipals is a method used to find the principals of a user by name. Principals are strings representing (generally) permissions

func (System) GiveGroup

func (s System) GiveGroup(userID, groupID int64) error

GiveGroup adds a specific group to a given user

func (System) GivePerm

func (s System) GivePerm(groupID, permID int64) error

GivePerm adds a specific permission to a given group

func (System) VerifyUserPassword

func (s System) VerifyUserPassword(userName, givenPassword string) (valid bool, err error)

VerifyUserPassword checks if the given username is matching with the given password. This is using the database backend to check this...