auth

Documentation

Index

• Variables
• func BaseTokenPermission(t Token) ([]permission.Permission, error)
• func ConvertOldUser(u *User, err error) (*authTypes.User, error)
• func ParseToken(header string) (string, error)
• func QuotaService() (quotaTypes.QuotaService, error)
• func RegisterScheme(name string, scheme Scheme)
• func RemoveRoleFromAllUsers(roleName string) error
• func TeamService() (authTypes.TeamService, error)
• func TeamTokenService() (authTypes.TeamTokenService, error)
• func UnregisterScheme(name string)
• func UpdateRoleFromAllUsers(roleName, newRoleName, ctx, desc string) error
• type APIToken
  • func APIAuth(token string) (*APIToken, error)
  • func (t *APIToken) GetAppName() string
  • func (t *APIToken) GetUserName() string
  • func (t *APIToken) GetValue() string
  • func (t *APIToken) IsAppToken() bool
  • func (t *APIToken) Permissions() ([]permission.Permission, error)
  • func (t *APIToken) User() (*authTypes.User, error)
• type AuthenticationFailure
  • func (a AuthenticationFailure) Error() string
• type ManagedScheme
• type Scheme
  • func GetScheme(name string) (Scheme, error)
• type SchemeInfo
• type Token
• type User
  • func ConvertNewUser(u *authTypes.User, err error) (*User, error)
  • func GetUserByEmail(email string) (*User, error)
  • func ListUsers() ([]User, error)
  • func ListUsersWithPermissions(wantedPerms ...permission.Permission) ([]User, error)
  • func ListUsersWithRole(role string) ([]User, error)
  • func (u *User) AddKey(key repository.Key, force bool) error
  • func (u *User) AddRole(roleName string, contextValue string) error
  • func (u *User) AddRolesForEvent(roleEvent *permTypes.RoleEvent, contextValue string) error
  • func (u *User) Create() error
  • func (u *User) Delete() error
  • func (u *User) ListKeys() (map[string]string, error)
  • func (u *User) Permissions() ([]permission.Permission, error)
  • func (u *User) RegenerateAPIKey() (string, error)
  • func (u *User) Reload() error
  • func (u *User) RemoveKey(key repository.Key) error
  • func (u *User) RemoveRole(roleName string, contextValue string) error
  • func (u *User) ShowAPIKey() (string, error)
  • func (u *User) Update() error

Variables

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

Functions

func BaseTokenPermission

func BaseTokenPermission(t Token) ([]permission.Permission, error)

func ConvertOldUser

func ConvertOldUser(u *User, err error) (*authTypes.User, error)

func ParseToken

func ParseToken(header string) (string, error)

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

func QuotaService

func QuotaService() (quotaTypes.QuotaService, error)

func RegisterScheme

func RegisterScheme(name string, scheme Scheme)

func RemoveRoleFromAllUsers

func RemoveRoleFromAllUsers(roleName string) error

func TeamService

func TeamService() (authTypes.TeamService, error)

func TeamTokenService

func TeamTokenService() (authTypes.TeamTokenService, error)

func UnregisterScheme

func UnregisterScheme(name string)

func UpdateRoleFromAllUsers

func UpdateRoleFromAllUsers(roleName, newRoleName, ctx, desc string) error

Types

type APIToken

type APIToken struct {
	Token     string `json:"token" bson:"apikey"`
	UserEmail string `json:"email" bson:"email"`
}

func APIAuth

func APIAuth(token string) (*APIToken, error)

func (*APIToken) GetAppName

func (t *APIToken) GetAppName() string

func (*APIToken) GetUserName

func (t *APIToken) GetUserName() string

func (*APIToken) GetValue

func (t *APIToken) GetValue() string

func (*APIToken) IsAppToken

func (t *APIToken) IsAppToken() bool

func (*APIToken) Permissions

func (t *APIToken) Permissions() ([]permission.Permission, error)

func (*APIToken) User

func (t *APIToken) User() (*authTypes.User, error)

type AuthenticationFailure

type AuthenticationFailure struct {
	Message string
}

func (AuthenticationFailure) Error

func (a AuthenticationFailure) Error() 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)
	AppLogout(token string) 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(user *User) error
}

func GetScheme

func GetScheme(name string) (Scheme, error)

type SchemeInfo

type SchemeInfo map[string]interface{}

type Token

type Token authTypes.Token

Token type alias exists to ease refactoring while we move auth types to types/auth package. Both this type alias and the Convert*User funcs should be eliminated once we convert everyone to use authTypes.User.

type User

type User struct {
	Quota    quota.Quota
	Email    string
	Password string
	APIKey   string
	Roles    []authTypes.RoleInstance `bson:",omitempty"`
}

func ConvertNewUser

func ConvertNewUser(u *authTypes.User, err error) (*User, error)

func GetUserByEmail

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

func ListUsers

func ListUsers() ([]User, error)

ListUsers list all users registred in tsuru

func ListUsersWithPermissions

func ListUsersWithPermissions(wantedPerms ...permission.Permission) ([]User, error)

func ListUsersWithRole

func ListUsersWithRole(role string) ([]User, error)

func (*User) AddKey

func (u *User) AddKey(key repository.Key, force bool) error

func (*User) AddRole

func (u *User) AddRole(roleName string, contextValue string) error

func (*User) AddRolesForEvent

func (u *User) AddRolesForEvent(roleEvent *permTypes.RoleEvent, contextValue string) error

func (*User) Create

func (u *User) Create() error

func (*User) Delete

func (u *User) Delete() error

func (*User) ListKeys

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

func (*User) Permissions

func (u *User) Permissions() ([]permission.Permission, error)

func (*User) RegenerateAPIKey

func (u *User) RegenerateAPIKey() (string, error)

func (*User) Reload

func (u *User) Reload() error

func (*User) RemoveKey

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

func (*User) RemoveRole

func (u *User) RemoveRole(roleName string, contextValue string) error

func (*User) ShowAPIKey

func (u *User) ShowAPIKey() (string, error)

func (*User) Update

func (u *User) Update() error