Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

permissions

package module

Go to main page

Versions in this module

v2

v2.6.9

Jun 25, 2023

v2.6.8

Apr 20, 2023

v2.6.7

Apr 20, 2023

v2.6.6

Apr 6, 2023

v2.6.5

Feb 6, 2023

v2.6.4

Feb 6, 2023

Changes in this version

+ const Version

+ var ErrConfirmationNoLongerValid = errors.New("the confirmation code is no longer valid")

+ var ErrConfirmationNotUnique = errors.New("too many generated confirmation codes are not unique")

+ var ErrConfirmationUserMissing = errors.New("the user that is to be confirmed no longer exists")

+ var ErrInvalidUsername = errors.New("only numbers, underscore and some letters are allowed in usernames")

+ var ErrNoCookieEmptyUsername = errors.New("can't set cookie for empty username")

+ var ErrNoCookieMissingUser = errors.New("can't store cookie for non-existing user")

+ var ErrNoCookieUsername = errors.New("could not retrieve the username from browser cookie")

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

+ var ErrRedisConnectionFailure = errors.New("unable to connect to Redis server on port 6379")

+ var ErrRedisLostConnection = errors.New("lost connection to Redis")

+ var ErrSameUsernameAndPassword = errors.New("username and password must be different, try another password")

+ var ErrUsersAlreadyConfirmed = errors.New("all existing users are already confirmed")

+ func PermissionDenied(w http.ResponseWriter, req *http.Request)

+ func ValidUsernamePassword(username, password string) error

+ type Permissions struct

+ func New() *Permissions

+ func New2() (*Permissions, error)

+ func NewPermissions(state *UserState) *Permissions

+ func NewWithRedisConf(dbindex int, hostPort string) *Permissions

+ func NewWithRedisConf2(dbindex int, hostPort string) (*Permissions, error)

+ func (perm *Permissions) AddAdminPath(prefix string)

+ func (perm *Permissions) AddPublicPath(prefix string)

+ func (perm *Permissions) AddUserPath(prefix string)

+ func (perm *Permissions) Clear()

+ func (perm *Permissions) DenyFunction() http.HandlerFunc

+ func (perm *Permissions) Middleware(next http.Handler) http.Handler

+ func (perm *Permissions) Rejected(w http.ResponseWriter, req *http.Request) bool

+ func (perm *Permissions) ServeHTTP(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

+ func (perm *Permissions) SetAdminPath(pathPrefixes []string)

+ func (perm *Permissions) SetDenyFunction(f http.HandlerFunc)

+ func (perm *Permissions) SetPublicPath(pathPrefixes []string)

+ func (perm *Permissions) SetUserPath(pathPrefixes []string)

+ func (perm *Permissions) UserState() pinterface.IUserState

+ type UserState struct

+ func NewUserState(dbindex int, randomseed bool, redisHostPort string) *UserState

+ func NewUserState2(dbindex int, randomseed bool, redisHostPort string) (*UserState, error)

+ func NewUserStateSimple() *UserState

+ func NewUserStateSimple2() (*UserState, error)

+ func NewUserStateWithPassword(hostname, password string) *UserState

+ func NewUserStateWithPassword2(hostname, password string) (*UserState, error)

+ func (state *UserState) AddUnconfirmed(username, confirmationCode string)

+ func (state *UserState) AddUser(username, password, email string)

+ func (state *UserState) AdminRights(req *http.Request) bool

+ func (state *UserState) AllUnconfirmedUsernames() ([]string, error)

+ func (state *UserState) AllUsernames() ([]string, error)

+ func (state *UserState) AlreadyHasConfirmationCode(confirmationCode string) bool

+ func (state *UserState) BooleanField(username, fieldname string) bool

+ func (state *UserState) ClearCookie(w http.ResponseWriter)

+ func (state *UserState) Close()

+ func (state *UserState) Confirm(username string)

+ func (state *UserState) ConfirmUserByConfirmationCode(confirmationCode string) error

+ func (state *UserState) ConfirmationCode(username string) (string, error)

+ func (state *UserState) CookieSecret() string

+ func (state *UserState) CookieTimeout(username string) int64

+ func (state *UserState) CorrectPassword(username, password string) bool

+ func (state *UserState) Creator() pinterface.ICreator

+ func (state *UserState) DatabaseIndex() int

+ func (state *UserState) Email(username string) (string, error)

+ func (state *UserState) FindUserByConfirmationCode(confirmationCode string) (string, error)

+ func (state *UserState) GenerateUniqueConfirmationCode() (string, error)

+ func (state *UserState) GetToken(username string) (string, error)

+ func (state *UserState) HasEmail(email string) (string, error)

+ func (state *UserState) HasUser(username string) bool

+ func (state *UserState) HasUser2(username string) (bool, error)

+ func (state *UserState) HashPassword(username, password string) string

+ func (state *UserState) Host() pinterface.IHost

+ func (state *UserState) IsAdmin(username string) bool

+ func (state *UserState) IsConfirmed(username string) bool

+ func (state *UserState) IsLoggedIn(username string) bool

+ func (state *UserState) Login(w http.ResponseWriter, username string) error

+ func (state *UserState) Logout(username string)

+ func (state *UserState) MarkConfirmed(username string)

+ func (state *UserState) PasswordAlgo() string

+ func (state *UserState) PasswordHash(username string) (string, error)

+ func (state *UserState) Pool() *simpleredis.ConnectionPool

+ func (state *UserState) Properties(username string) []string

+ func (state *UserState) RemoveAdminStatus(username string)

+ func (state *UserState) RemoveToken(username string)

+ func (state *UserState) RemoveUnconfirmed(username string)

+ func (state *UserState) RemoveUser(username string)

+ func (state *UserState) SetAdminStatus(username string)

+ func (state *UserState) SetBooleanField(username, fieldname string, val bool)

+ func (state *UserState) SetCookieSecret(cookieSecret string)

+ func (state *UserState) SetCookieTimeout(cookieTime int64)

+ func (state *UserState) SetLoggedIn(username string)

+ func (state *UserState) SetLoggedOut(username string)

+ func (state *UserState) SetMinimumConfirmationCodeLength(length int)

+ func (state *UserState) SetPassword(username, password string)

+ func (state *UserState) SetPasswordAlgo(algorithm string) error

+ func (state *UserState) SetToken(username, token string, expire time.Duration)

+ func (state *UserState) SetUsernameCookie(w http.ResponseWriter, username string) error

+ func (state *UserState) SetUsernameCookieOnlyHTTPS(w http.ResponseWriter, username string) error

+ func (state *UserState) UserRights(req *http.Request) bool

+ func (state *UserState) Username(req *http.Request) string

+ func (state *UserState) UsernameCookie(req *http.Request) (string, error)

+ func (state *UserState) Users() pinterface.IHashMap

Other modules containing this package

github.com/xyproto/permissions2