auth_token

Documentation

Index

• Constants
• Variables
• func AddManualSession(ctx op_context.Context, cipher auth.AuthParameterEncryption, tenancyID string, ...) (auth_session.Session, string, error)
• func GenManualToken(ctx op_context.Context, cipher auth.AuthParameterEncryption, tenancyID string, ...) (string, error)
• func RefreshRequired(code string) bool
• func ReloginRequired(code string) bool
• type AuthNewTokenHandler
  • func NewNewToken(users auth_session.WithUserSessionManager) *AuthNewTokenHandler
  • func (a *AuthNewTokenHandler) Handle(ctx auth.AuthContext) (bool, error)
  • func (a *AuthNewTokenHandler) Init(cfg config.Config, log logger.Logger, vld validator.Validator, ...) error
  • func (a *AuthNewTokenHandler) Process(ctx auth.AuthContext) (bool, *Token, error)
• type AuthTokenHandler
  • func New(users auth_session.WithUserSessionManager) *AuthTokenHandler
  • func (a *AuthTokenHandler) Config() interface{}
  • func (a *AuthTokenHandler) ErrorDescriptions() map[string]string
  • func (a *AuthTokenHandler) ErrorProtocolCodes() map[string]int
  • func (a *AuthTokenHandler) GenAccessToken(ctx auth.AuthContext) (*Token, error)
  • func (a *AuthTokenHandler) GenRefreshToken(ctx auth.AuthContext, session auth_session.Session) (*Token, error)
  • func (a *AuthTokenHandler) GenToken(ctx auth.AuthContext, paramName string, expirationSeconds int) (*Token, error)
  • func (a *AuthTokenHandler) Handle(ctx auth.AuthContext) (bool, error)
  • func (a *AuthTokenHandler) Init(cfg config.Config, log logger.Logger, vld validator.Validator, ...) error
  • func (a *AuthTokenHandler) SessionExpiration() time.Time
  • func (a *AuthTokenHandler) SetAuthManager(manager auth.AuthManager)
• type AuthTokenHandlerConfig
• type Token
• type TokenSchema
  • func NewSchema(users auth_session.WithUserSessionManager) *TokenSchema
  • func (t *TokenSchema) Handlers() []auth.AuthHandler
  • func (t *TokenSchema) Init(cfg config.Config, log logger.Logger, vld validator.Validator, ...) error
  • func (t *TokenSchema) SetAuthManager(manager auth.AuthManager)

Constants

const AccessTokenName = "access-token"

const CheckTokenProtocol = "check_token"

const ErrorCodeInvalidToken = "auth_token_invalid"

const ErrorCodeRefreshDisabled = "refresh_disabled"

const ErrorCodeSessionExpired = "session_expired"

const ErrorCodeTokenExpired = "auth_token_expired"

const ErrorCodeUnknownUser = "unknown_user"

const NewTokenProtocol = "new_token"

const RefreshTokenName = "refresh-token"

const TokenProtocol = "token"

Variables

var ErrorDescriptions = map[string]string{
	ErrorCodeTokenExpired:    "Provided authentication token expired",
	ErrorCodeInvalidToken:    "Invalid authentication token",
	ErrorCodeSessionExpired:  "Session expired",
	ErrorCodeUnknownUser:     "Unknown user",
	ErrorCodeRefreshDisabled: "Refresh disabled",
}

var ErrorProtocolCodes = map[string]int{
	ErrorCodeTokenExpired:    http.StatusUnauthorized,
	ErrorCodeInvalidToken:    http.StatusUnauthorized,
	ErrorCodeSessionExpired:  http.StatusUnauthorized,
	ErrorCodeUnknownUser:     http.StatusUnauthorized,
	ErrorCodeRefreshDisabled: http.StatusUnauthorized,
}

Functions

func AddManualSession

func AddManualSession(ctx op_context.Context, cipher auth.AuthParameterEncryption, tenancyID string, users auth_session.WithUserSessionManager, login string, ttlSeconds int, tokenName ...string) (auth_session.Session, string, error)

func GenManualToken

func GenManualToken(ctx op_context.Context, cipher auth.AuthParameterEncryption, tenancyID string, user auth.User, sesisonID string, expirationSeconds int, tokenType string) (string, error)

func RefreshRequired

func RefreshRequired(code string) bool

func ReloginRequired

func ReloginRequired(code string) bool

Types

type AuthNewTokenHandler

type AuthNewTokenHandler struct {
	AuthTokenHandler
}

func NewNewToken

func NewNewToken(users auth_session.WithUserSessionManager) *AuthNewTokenHandler

func (*AuthNewTokenHandler) Handle

func (a *AuthNewTokenHandler) Handle(ctx auth.AuthContext) (bool, error)

func (*AuthNewTokenHandler) Init

func (a *AuthNewTokenHandler) Init(cfg config.Config, log logger.Logger, vld validator.Validator, configPath ...string) error

func (*AuthNewTokenHandler) Process

func (a *AuthNewTokenHandler) Process(ctx auth.AuthContext) (bool, *Token, error)

type AuthTokenHandler

type AuthTokenHandler struct {
	auth.AuthHandlerBase
	AuthTokenHandlerConfig
	// contains filtered or unexported fields
}

func New

func New(users auth_session.WithUserSessionManager) *AuthTokenHandler

func (*AuthTokenHandler) Config

func (a *AuthTokenHandler) Config() interface{}

func (*AuthTokenHandler) ErrorDescriptions

func (a *AuthTokenHandler) ErrorDescriptions() map[string]string

func (*AuthTokenHandler) ErrorProtocolCodes

func (a *AuthTokenHandler) ErrorProtocolCodes() map[string]int

func (*AuthTokenHandler) GenAccessToken

func (a *AuthTokenHandler) GenAccessToken(ctx auth.AuthContext) (*Token, error)

func (*AuthTokenHandler) GenRefreshToken

func (a *AuthTokenHandler) GenRefreshToken(ctx auth.AuthContext, session auth_session.Session) (*Token, error)

func (*AuthTokenHandler) GenToken

func (a *AuthTokenHandler) GenToken(ctx auth.AuthContext, paramName string, expirationSeconds int) (*Token, error)

func (*AuthTokenHandler) Handle

func (a *AuthTokenHandler) Handle(ctx auth.AuthContext) (bool, error)

func (*AuthTokenHandler) Init

func (a *AuthTokenHandler) Init(cfg config.Config, log logger.Logger, vld validator.Validator, configPath ...string) error

func (*AuthTokenHandler) SessionExpiration

func (a *AuthTokenHandler) SessionExpiration() time.Time

func (*AuthTokenHandler) SetAuthManager

func (a *AuthTokenHandler) SetAuthManager(manager auth.AuthManager)

type AuthTokenHandlerConfig

type AuthTokenHandlerConfig struct {
	ACCESS_TOKEN_TTL_SECONDS        int    `default:"900" validate:"gt=0"`
	REFRESH_TOKEN_TTL_SECONDS       int    `default:"43200" validate:"gt=0"`
	ACCESS_TOKEN_GEN_BEFORE_SECONDS int    `default:"60" validate:"gt=0"`
	AUTO_PROLONGATE_ACCESS          bool   `default:"true"`
	AUTO_PROLONGATE_REFRESH         bool   `default:"true"`
	REFRESH_PATH                    string `default:"/auth/refresh"`
	LOGOUT_PATH                     string `default:"/auth/logout"`

	ACCESS_TOKEN_NAME string `default:"access-token"`
	DIRECT_TOKEN_NAME bool

	DISABLE_REFRESH bool
}

type Token

type Token struct {
	auth.ExpireToken
	Id          string `json:"id"`
	UserId      string `json:"user_id"`
	UserDisplay string `json:"user_display"`
	SessionId   string `json:"session_id"`
	Tenancy     string `json:"tenancy"`
	Type        string `json:"type"`
}

type TokenSchema

type TokenSchema struct {
	auth.AuthSchema

	Token *AuthTokenHandler
}

func NewSchema

func NewSchema(users auth_session.WithUserSessionManager) *TokenSchema

func (*TokenSchema) Handlers

func (t *TokenSchema) Handlers() []auth.AuthHandler

func (*TokenSchema) Init

func (t *TokenSchema) Init(cfg config.Config, log logger.Logger, vld validator.Validator, configPath ...string) error

func (*TokenSchema) SetAuthManager

func (t *TokenSchema) SetAuthManager(manager auth.AuthManager)