user

Documentation

Index

• Variables
• func NewLDAPCache(config *store.LDAPConfig) store.Cache
• func NewLDAPChecker(config *store.LDAPConfig) common.PasswordChecker
• func RegisterAPI(opts Options) *mux.Router
• type Details
• type Options
• type Registry
  • func NewRegistry(cache store.Cache) *Registry
  • func (u *Registry) BcryptChecker() common.PasswordChecker
  • func (u *Registry) Delete(username string) error
  • func (u *Registry) Get(username string) (*Details, error)
  • func (u *Registry) LoadFromJSON(r io.Reader) error
  • func (u *Registry) PlainTextChecker() common.PasswordChecker
  • func (u *Registry) Put(user *Details) error
  • func (u *Registry) SaveToJSON(w io.Writer) error
• type State

Variables

var (
	ErrInvalidUser = errors.New("invalid user")
)

Common Errors

var (
	ErrNotFound = errors.New("not found")
)

Errors

Functions

func NewLDAPCache

func NewLDAPCache(config *store.LDAPConfig) store.Cache

NewLDAPCache returns a cache suitable for interacting with LDAP

func NewLDAPChecker

func NewLDAPChecker(config *store.LDAPConfig) common.PasswordChecker

NewLDAPChecker returns a password checker using LDAP

func RegisterAPI

func RegisterAPI(opts Options) *mux.Router

RegisterAPI returns a router for the api.

Types

type Details

type Details struct {
	ID       uint64 `json:"id"`
	Username string `json:"username"`
	Password string `json:"password"`
	Email    string `json:"email"`
	Name     string `json:"name"`
	State    State  `json:"state"`
}

Details describes the user details

type Options

type Options struct {
	Root    string
	Verbose bool
	Users   *Registry
}

Options are user API handler options

type Registry

type Registry struct {
	// contains filtered or unexported fields
}

Registry maintains the known users

func NewRegistry

func NewRegistry(cache store.Cache) *Registry

NewRegistry returns an initialized UserRegistry

func (*Registry) BcryptChecker

func (u *Registry) BcryptChecker() common.PasswordChecker

BcryptChecker creates in implementation of common.Checker that uses bcrypt to verify password against the password field in the user details

func (*Registry) Delete

func (u *Registry) Delete(username string) error

Delete removes the user registration

func (*Registry) Get

func (u *Registry) Get(username string) (*Details, error)

Get returns a user registration by username, or an error if not found

func (*Registry) LoadFromJSON

func (u *Registry) LoadFromJSON(r io.Reader) error

LoadFromJSON loads users encoded in JSON

func (*Registry) PlainTextChecker

func (u *Registry) PlainTextChecker() common.PasswordChecker

PlainTextChecker creates in implementation of common.Checker that uses simple text comparison to verify password against the plain text password field in the user details

func (*Registry) Put

func (u *Registry) Put(user *Details) error

Put save the user registration

func (*Registry) SaveToJSON

func (u *Registry) SaveToJSON(w io.Writer) error

SaveToJSON stores the registry users to the io.Writer as JSON

type State

type State string

State describes User States

const (
	Active   State = "active"
	Inactive State = "inactive"
)

Valid User States