session

Documentation

Index

• Constants
• Variables
• type Action
• type AuthHeaderStyle
• type Information
• type MetaData
• type Oauth2
• type Options
• type Provider
• type ProviderWrapper
  • func (p *ProviderWrapper) GetCertURL() string
  • func (p *ProviderWrapper) IsNoop() bool
• type Registry
  • func (r *Registry) Get(name string) *Session
  • func (r *Registry) Set(name string, store *Session)
• type Session
  • func (s *Session) DelToken(c echo.Context) error
  • func (m *Session) Do(next echo.HandlerFunc, c echo.Context) error
  • func (s *Session) GetStore() StoreInf
  • func (m *Session) Info(c echo.Context) error
  • func (m *Session) Init(ctx context.Context, name string) error
  • func (m *Session) IsLogged(c echo.Context) (bool, error)
  • func (m *Session) Middleware(ctx context.Context, name string) (echo.MiddlewareFunc, error)
  • func (m *Session) RedirectToLogin(c echo.Context, store StoreInf, addRedirectPath bool, removeSession bool) error
  • func (m *Session) RedirectToMain(c echo.Context) error
  • func (m *Session) SetAction() error
  • func (s *Session) SetStore(ctx context.Context) error
  • func (s *Session) SetToken(c echo.Context, token []byte, providerName string) error
• type Store
• type StoreInf
• type Token
• type TokenData
  • func ParseToken(v []byte) (*TokenData, error)
  • func ParseToken64(v string) (*TokenData, error)

Constants

const (
	CtxTokenHeaderKey     = "token_header"
	CtxDisableRedirectKey = "disable_redirect"
)

Variables

var (
	TokenKey    = "token"
	ProviderKey = "provider"
)

var GlobalRegistry = &Registry{
	Store: make(map[string]*Session),
}

Types

type Action

type Action struct {
	Active string `cfg:"active"`
	Token  *Token `cfg:"token"`
}

type AuthHeaderStyle

type AuthHeaderStyle int

AuthHeaderStyle is a type to set Authorization header style.

const (
	AuthHeaderStyleBasic AuthHeaderStyle = iota
	AuthHeaderStyleBearerSecret
	AuthHeaderStyleParams
)

type Information

type Information struct {
	// Values list to store in the cookie like "preferred_username", "given_name", "family_name", "sid", "azp", "aud"
	Values []string `cfg:"values"`
	// Custom map to store in the cookie.
	Custom map[string]interface{} `cfg:"custom"`
	// Roles to store in the cookie as []string.
	Roles bool `cfg:"roles"`
	// Scopes to store in the cookie as []string.
	Scopes bool `cfg:"scopes"`
}

type MetaData

type MetaData struct {
	Error string `json:"error"`
}

type Oauth2

type Oauth2 struct {
	// ClientID is the application's ID.
	ClientID string `cfg:"client_id"`
	// ClientSecret is the application's secret.
	ClientSecret string `cfg:"client_secret" log:"false"`
	// Scope specifies optional requested permissions.
	Scopes []string `cfg:"scopes"`
	// CertURL is the resource server's public key URL.
	CertURL string `cfg:"cert_url"`
	// IntrospectURL is the check the active or not with request.
	IntrospectURL string `cfg:"introspect_url"`
	// AuthURL is the resource server's authorization endpoint
	// use for redirection to login page.
	AuthURL string `cfg:"auth_url"`
	// TokenURL is the resource server's token endpoint URL.
	TokenURL  string `cfg:"token_url"`
	LogoutURL string `cfg:"logout_url"`
	// AuthHeaderStyle is optional. If not set, AuthHeaderStyleBasic will be used.
	AuthHeaderStyle AuthHeaderStyle
}

type Options

type Options struct {
	Path     string `cfg:"path"`
	MaxAge   int    `cfg:"max_age"`
	Domain   string `cfg:"domain"`
	Secure   bool   `cfg:"secure"`
	HttpOnly bool   `cfg:"http_only"`
	// SameSite for Lax 2, Strict 3, None 4.
	SameSite http.SameSite `cfg:"same_site"`
}

type Provider

type Provider struct {
	Oauth2 *Oauth2 `cfg:"oauth2"`
	// PasswordFlow is use password flow to get token.
	PasswordFlow bool `cfg:"password_flow"`
	// Priority is use to sort provider.
	Priority int `cfg:"priority"`
}

type ProviderWrapper

type ProviderWrapper struct {
	Generic *providers.Generic
}

func (*ProviderWrapper) GetCertURL

func (p *ProviderWrapper) GetCertURL() string

func (*ProviderWrapper) IsNoop

func (p *ProviderWrapper) IsNoop() bool

type Registry

type Registry struct {
	Store map[string]*Session
	// contains filtered or unexported fields
}

func (*Registry) Get

func (r *Registry) Get(name string) *Session

func (*Registry) Set

func (r *Registry) Set(name string, store *Session)

type Session

type Session struct {
	SessionKey string  `cfg:"session_key"`
	Store      Store   `cfg:"store"`
	Options    Options `cfg:"options"`

	CookieName string `cfg:"cookie_name"`

	Action      Action              `cfg:"action"`
	Information Information         `cfg:"information"`
	Provider    map[string]Provider `cfg:"provider"`
	// contains filtered or unexported fields
}

func (*Session) DelToken

func (s *Session) DelToken(c echo.Context) error

func (*Session) Do

func (m *Session) Do(next echo.HandlerFunc, c echo.Context) error

func (*Session) GetStore

func (s *Session) GetStore() StoreInf

func (*Session) Info

func (m *Session) Info(c echo.Context) error

func (*Session) Init

func (m *Session) Init(ctx context.Context, name string) error

func (*Session) IsLogged

func (m *Session) IsLogged(c echo.Context) (bool, error)

IsLogged check token is exist and valid.

func (*Session) Middleware

func (m *Session) Middleware(ctx context.Context, name string) (echo.MiddlewareFunc, error)

func (*Session) RedirectToLogin

func (m *Session) RedirectToLogin(c echo.Context, store StoreInf, addRedirectPath bool, removeSession bool) error

func (*Session) RedirectToMain

func (m *Session) RedirectToMain(c echo.Context) error

func (*Session) SetAction

func (m *Session) SetAction() error

func (*Session) SetStore

func (s *Session) SetStore(ctx context.Context) error

func (*Session) SetToken

func (s *Session) SetToken(c echo.Context, token []byte, providerName string) error

type Store

type Store struct {
	Active string       `cfg:"active"`
	Redis  *store.Redis `cfg:"redis"`
	File   *store.File  `cfg:"file"`
}

type StoreInf

type StoreInf interface {
	Get(r *http.Request, name string) (*sessions.Session, error)
}

type Token

type Token struct {
	LoginPath          string `cfg:"login_path"`
	DisableRefresh     bool   `cfg:"disable_refresh"`
	InsecureSkipVerify bool   `cfg:"insecure_skip_verify"`
	// contains filtered or unexported fields
}

type TokenData

type TokenData struct {
	AccessToken      string `json:"access_token"`
	ExpiresIn        int    `json:"expires_in"`
	RefreshExpiresIn int    `json:"refresh_expires_in"`
	RefreshToken     string `json:"refresh_token"`
	TokenType        string `json:"token_type"`
	NotBeforePolicy  int    `json:"not-before-policy"`
	SessionState     string `json:"session_state"`
	Scope            string `json:"scope"`
	IDToken          string `json:"id_token"`
}

func ParseToken

func ParseToken(v []byte) (*TokenData, error)

func ParseToken64

func ParseToken64(v string) (*TokenData, error)

Parse64 parse the cookie