session

Documentation

Overview

Package session provides session authentication and management for the application.

Index

• Constants
• Variables
• func AddVisitedPluginHook(ctx context.Context, pluginID string, hookType hook.TriggerEnum) context.Context
• func CheckAllowPublicWithoutAuth(c ExternalAccessConfig, r *http.Request) error
• func GetCurrentUserID(ctx context.Context) *string
• func LogExternalAccessError(err ExternalAccessError)
• func SetCurrentUserID(ctx context.Context, userID string) context.Context
• type ExternalAccessConfig
• type ExternalAccessError
  • func CheckExternalAccessTripwire(c ExternalAccessConfig) *ExternalAccessError
  • func (e ExternalAccessError) Error() string
• type InvalidCredentialsError
  • func (e InvalidCredentialsError) Error() string
• type SessionConfig
• type Store
  • func NewStore(c SessionConfig) *Store
  • func (s *Store) Authenticate(w http.ResponseWriter, r *http.Request) (userID string, err error)
  • func (s *Store) GetSessionUserID(w http.ResponseWriter, r *http.Request) (string, error)
  • func (s *Store) Login(w http.ResponseWriter, r *http.Request) error
  • func (s *Store) Logout(w http.ResponseWriter, r *http.Request) error
  • func (s *Store) MakePluginCookie(ctx context.Context) *http.Cookie
  • func (s *Store) VisitedPluginHandler() func(http.Handler) http.Handler
• type VisitedPluginHook
  • func GetVisitedPluginHooks(ctx context.Context) []VisitedPluginHook

Constants

const (
	ApiKeyHeader    = "ApiKey"
	ApiKeyParameter = "apikey"
)

Variables

var ErrUnauthorized = errors.New("unauthorized")

Functions

func AddVisitedPluginHook

func AddVisitedPluginHook(ctx context.Context, pluginID string, hookType hook.TriggerEnum) context.Context

func CheckAllowPublicWithoutAuth

func CheckAllowPublicWithoutAuth(c ExternalAccessConfig, r *http.Request) error

func GetCurrentUserID

func GetCurrentUserID(ctx context.Context) *string

GetCurrentUserID gets the current user id from the provided context

func LogExternalAccessError

func LogExternalAccessError(err ExternalAccessError)

func SetCurrentUserID

func SetCurrentUserID(ctx context.Context, userID string) context.Context

Types

type ExternalAccessConfig

type ExternalAccessConfig interface {
	HasCredentials() bool
	GetDangerousAllowPublicWithoutAuth() bool
	GetSecurityTripwireAccessedFromPublicInternet() string
	IsNewSystem() bool
}

type ExternalAccessError

type ExternalAccessError net.IP

func CheckExternalAccessTripwire

func CheckExternalAccessTripwire(c ExternalAccessConfig) *ExternalAccessError

func (ExternalAccessError) Error

func (e ExternalAccessError) Error() string

type InvalidCredentialsError

type InvalidCredentialsError struct {
	Username string
}

func (InvalidCredentialsError) Error

func (e InvalidCredentialsError) Error() string

type SessionConfig

type SessionConfig interface {
	GetUsername() string
	GetAPIKey() string

	GetSessionStoreKey() []byte
	GetMaxSessionAge() int
	ValidateCredentials(username string, password string) bool
}

type Store

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

func NewStore

func NewStore(c SessionConfig) *Store

func (*Store) Authenticate

func (s *Store) Authenticate(w http.ResponseWriter, r *http.Request) (userID string, err error)

func (*Store) GetSessionUserID

func (s *Store) GetSessionUserID(w http.ResponseWriter, r *http.Request) (string, error)

func (*Store) Login

func (s *Store) Login(w http.ResponseWriter, r *http.Request) error

func (*Store) Logout

func (s *Store) Logout(w http.ResponseWriter, r *http.Request) error

func (*Store) MakePluginCookie

func (s *Store) MakePluginCookie(ctx context.Context) *http.Cookie

func (*Store) VisitedPluginHandler

func (s *Store) VisitedPluginHandler() func(http.Handler) http.Handler

type VisitedPluginHook

type VisitedPluginHook struct {
	PluginID string
	HookType hook.TriggerEnum
}

func GetVisitedPluginHooks

func GetVisitedPluginHooks(ctx context.Context) []VisitedPluginHook