auth

Documentation

Index

• Variables
• func ChangeQuota(user *User, limit int) error
• func CheckUserAccess(teamNames []string, u *User) bool
• func CreateTeam(name string, user ...*User) error
• func GetTeamsNames(teams []Team) []string
• func ParseToken(header string) (string, error)
• func RegisterScheme(name string, scheme Scheme)
• func ReleaseApp(user *User) error
• func ReserveApp(user *User) error
• func UnregisterScheme(name string)
• type AuthenticationFailure
  • func (a AuthenticationFailure) Error() string
• type Key
• type ManagedScheme
• type Scheme
  • func GetScheme(name string) (Scheme, error)
• type SchemeInfo
• type Team
  • func GetTeam(name string) (*Team, error)
  • func (t *Team) AddUser(u *User) error
  • func (t *Team) AllowedApps() ([]string, error)
  • func (t *Team) ContainsUser(u *User) bool
  • func (t *Team) RemoveUser(u *User) error
• type Token
• type User
  • func GetUserByEmail(email string) (*User, error)
  • func (u *User) AddKey(key Key) error
  • func (u *User) AllowedApps() ([]string, error)
  • func (u *User) Create() error
  • func (u *User) CreateOnGandalf() error
  • func (u *User) Delete() error
  • func (u *User) FindKey(key Key) (Key, int)
  • func (u *User) HasKey(key Key) bool
  • func (u *User) IsAdmin() bool
  • func (u *User) ListKeys() (map[string]string, error)
  • func (u *User) RemoveKey(key Key) error
  • func (u *User) Teams() ([]Team, error)
  • func (u *User) Update() error

Variables

var (
	ErrInvalidTeamName   = errors.New("invalid team name")
	ErrTeamAlreadyExists = errors.New("team already exists")
	ErrTeamNotFound      = errors.New("team not found")
)

var (
	ErrUserNotFound      = stderrors.New("user not found")
	ErrUserAlreadyHasKey = stderrors.New("user already has this key")
	ErrKeyNotFound       = stderrors.New("key not found")
)

var ErrInvalidToken = errors.New("Invalid token")

Functions

func ChangeQuota

func ChangeQuota(user *User, limit int) error

ChangeQuota redefines the limit of the user. The new limit must be bigger than or equal to the current number of apps of the user. The new limit maybe smaller than 0, which mean that the user should have an unlimited number of apps.

func CheckUserAccess

func CheckUserAccess(teamNames []string, u *User) bool

func CreateTeam

func CreateTeam(name string, user ...*User) error

func GetTeamsNames

func GetTeamsNames(teams []Team) []string

func ParseToken

func ParseToken(header string) (string, error)

ParseToken extracts token from a header: 'type token' or 'token'

func RegisterScheme

func RegisterScheme(name string, scheme Scheme)

func ReleaseApp

func ReleaseApp(user *User) error

ReleaseApp releases an app from the user list, releasing the quota spot for another app.

func ReserveApp

func ReserveApp(user *User) error

ReserveApp reserves an app for the user, reserving it in the database. It's used to reserve the app in the user quota, returning an error when there isn't any space available.

func UnregisterScheme

func UnregisterScheme(name string)

Types

type AuthenticationFailure

type AuthenticationFailure struct {
	Message string
}

func (AuthenticationFailure) Error

func (a AuthenticationFailure) Error() string

type Key

type Key struct {
	Name    string
	Content string
}

type ManagedScheme

type ManagedScheme interface {
	Scheme
	StartPasswordReset(user *User) error
	ResetPassword(user *User, resetToken string) error
	ChangePassword(token Token, oldPassword string, newPassword string) error
}

type Scheme

type Scheme interface {
	AppLogin(appName string) (Token, error)
	Login(params map[string]string) (Token, error)
	Logout(token string) error
	Auth(token string) (Token, error)
	Info() (SchemeInfo, error)
	Name() string
	Create(user *User) (*User, error)
	Remove(token Token) error
}

func GetScheme

func GetScheme(name string) (Scheme, error)

type SchemeInfo

type SchemeInfo map[string]interface{}

type Team

type Team struct {
	Name  string   `bson:"_id" json:"name"`
	Users []string `json:"users"`
}

func GetTeam

func GetTeam(name string) (*Team, error)

func (*Team) AddUser

func (t *Team) AddUser(u *User) error

func (*Team) AllowedApps

func (t *Team) AllowedApps() ([]string, error)

func (*Team) ContainsUser

func (t *Team) ContainsUser(u *User) bool

func (*Team) RemoveUser

func (t *Team) RemoveUser(u *User) error

type Token

type Token interface {
	GetValue() string
	GetAppName() string
	GetUserName() string
	IsAppToken() bool
	User() (*User, error)
}

type User

type User struct {
	Email    string
	Password string
	Keys     []Key
	quota.Quota
}

func GetUserByEmail

func GetUserByEmail(email string) (*User, error)

func (*User) AddKey

func (u *User) AddKey(key Key) error

func (*User) AllowedApps

func (u *User) AllowedApps() ([]string, error)

func (*User) Create

func (u *User) Create() error

func (*User) CreateOnGandalf

func (u *User) CreateOnGandalf() error

func (*User) Delete

func (u *User) Delete() error

func (*User) FindKey

func (u *User) FindKey(key Key) (Key, int)

func (*User) HasKey

func (u *User) HasKey(key Key) bool

func (*User) IsAdmin

func (u *User) IsAdmin() bool

func (*User) ListKeys

func (u *User) ListKeys() (map[string]string, error)

func (*User) RemoveKey

func (u *User) RemoveKey(key Key) error

func (*User) Teams

func (u *User) Teams() ([]Team, error)

Teams returns a slice containing all teams that the user is member of.

func (*User) Update

func (u *User) Update() error