auth

Documentation

Overview

Package auth contains types for working with non blank user names. User always has a non blank name. OptionalUser will either have a non blank name or no value.

Index

• Constants
• func CreateContextWithAuthInfo(ctx context.Context, info AggregatorUserInfo) context.Context
• func ErrAuthInfoMissing(authInfo AggregatorUserInfo) error
• func ErrAuthInfoUsernameIsMissing(authInfo AggregatorUserInfo) error
• func IsErrAuthInfoMissing(e error) bool
• func IsErrAuthInfoUsernameIsMissing(e error) bool
• type AggregatorUserInfo
  • func RetrieveAuthInfoFromContext(ctx context.Context) (AggregatorUserInfo, bool)
• type AuthenticationMode
• type InfoError
  • func (e *InfoError) AuthInfo() AggregatorUserInfo
  • func (e *InfoError) Error() string
• type OptionalUser
  • func MaybeNamed(name string) OptionalUser
  • func MaybeRequestUser(r *http.Request) OptionalUser
  • func NoUser() OptionalUser
  • func ToOptionalUser(user User) OptionalUser
  • func (user OptionalUser) NameOrElse(defaultValue string) string
• type User
  • func Named(name string) (User, error)
  • func RequestUser(r *http.Request) (User, error)

Constants

const (
	AuthInfoContextKey contextKey = "AuthInfo"
)

Functions

func CreateContextWithAuthInfo

func CreateContextWithAuthInfo(ctx context.Context, info AggregatorUserInfo) context.Context

func ErrAuthInfoMissing

func ErrAuthInfoMissing(authInfo AggregatorUserInfo) error

func ErrAuthInfoUsernameIsMissing

func ErrAuthInfoUsernameIsMissing(authInfo AggregatorUserInfo) error

func IsErrAuthInfoMissing

func IsErrAuthInfoMissing(e error) bool

func IsErrAuthInfoUsernameIsMissing

func IsErrAuthInfoUsernameIsMissing(e error) bool

Types

type AggregatorUserInfo

type AggregatorUserInfo struct {
	User   string
	Groups []string
	Extra  map[string][]string
}

func RetrieveAuthInfoFromContext

func RetrieveAuthInfoFromContext(ctx context.Context) (AggregatorUserInfo, bool)

type AuthenticationMode

type AuthenticationMode string

type InfoError

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

func (*InfoError) AuthInfo

func (e *InfoError) AuthInfo() AggregatorUserInfo

func (*InfoError) Error

func (e *InfoError) Error() string

type OptionalUser

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

the possibility of a user

func MaybeNamed

func MaybeNamed(name string) OptionalUser

store an non blank user name inside the optional user

func MaybeRequestUser

func MaybeRequestUser(r *http.Request) OptionalUser

func NoUser

func NoUser() OptionalUser

convenience function for building no user

func ToOptionalUser

func ToOptionalUser(user User) OptionalUser

weaken the User type into an OptionalUser type.

func (OptionalUser) NameOrElse

func (user OptionalUser) NameOrElse(defaultValue string) string

access the user name of an optional user. If no name is present return the default value

type User

type User interface {
	Name() string
}

use an interface to expose the user type hiding in privateUser

func Named

func Named(name string) (User, error)

func RequestUser

func RequestUser(r *http.Request) (User, error)