recovery

Documentation

Index

• Constants
• Variables
• func HasReachedState(expected, actual State) bool
• func MethodToNodeGroup(method string) node.Group
• func PostHookRecoveryExecutorNames(e []PostHookExecutor) []string
• type AdminHandler
• type ErrorHandler
  • func NewErrorHandler(d errorHandlerDependencies) *ErrorHandler
  • func (s *ErrorHandler) WriteFlowError(w http.ResponseWriter, r *http.Request, f *Flow, group node.Group, err error)
• type ErrorHandlerProvider
• type Flow
  • func NewFlow(conf *config.Config, exp time.Duration, csrf string, r *http.Request, ...) (*Flow, error)
  • func (f *Flow) AppendTo(src *url.URL) *url.URL
  • func (f Flow) GetID() uuid.UUID
  • func (f Flow) GetNID() uuid.UUID
  • func (f *Flow) GetRequestURL() string
  • func (f *Flow) GetType() flow.Type
  • func (f Flow) TableName(ctx context.Context) string
  • func (f *Flow) Valid() error
• type FlowExpiredError
  • func NewFlowExpiredError(at time.Time) *FlowExpiredError
• type FlowPersistenceProvider
• type FlowPersister
• type Handler
  • func NewHandler(d handlerDependencies) *Handler
  • func (h *Handler) RegisterAdminRoutes(admin *x.RouterAdmin)
  • func (h *Handler) RegisterPublicRoutes(public *x.RouterPublic)
• type HandlerProvider
• type HookExecutor
  • func NewHookExecutor(d executorDependencies) *HookExecutor
  • func (e *HookExecutor) PostRecoveryHook(w http.ResponseWriter, r *http.Request, a *Flow, s *session.Session) error
• type HookExecutorProvider
• type HooksProvider
• type PostHookExecutor
• type PostHookExecutorFunc
  • func (f PostHookExecutorFunc) ExecutePostRecoveryHook(w http.ResponseWriter, r *http.Request, a *Flow, s *session.Session) error
• type PublicHandler
• type State
  • func NextState(current State) State
• type Strategies
  • func (s Strategies) MustStrategy(id string) Strategy
  • func (s Strategies) RegisterAdminRoutes(r *x.RouterAdmin)
  • func (s Strategies) RegisterPublicRoutes(r *x.RouterPublic)
  • func (s Strategies) Strategy(id string) (Strategy, error)
• type Strategy
• type StrategyProvider

Constants

const (
	RouteInitBrowserFlow = "/self-service/recovery/browser"
	RouteInitAPIFlow     = "/self-service/recovery/api"
	RouteGetFlow         = "/self-service/recovery/flows"

	RouteSubmitFlow = "/self-service/recovery"
)

const (
	StrategyRecoveryLinkName = "link"
)

Variables

var (
	ErrHookAbortFlow   = errors.New("aborted recovery hook execution")
	ErrAlreadyLoggedIn = herodot.ErrBadRequest.WithReason("A valid session was detected and thus recovery is not possible.")
)

Functions

func HasReachedState

func HasReachedState(expected, actual State) bool

func MethodToNodeGroup

func MethodToNodeGroup(method string) node.Group

func PostHookRecoveryExecutorNames

func PostHookRecoveryExecutorNames(e []PostHookExecutor) []string

Types

type AdminHandler

type AdminHandler interface {
	RegisterAdminRecoveryRoutes(admin *x.RouterAdmin)
}

type ErrorHandler

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

func NewErrorHandler

func NewErrorHandler(d errorHandlerDependencies) *ErrorHandler

func (*ErrorHandler) WriteFlowError

func (s *ErrorHandler) WriteFlowError(
	w http.ResponseWriter,
	r *http.Request,
	f *Flow,
	group node.Group,
	err error,
)

type ErrorHandlerProvider

type ErrorHandlerProvider interface {
	RecoveryFlowErrorHandler() *ErrorHandler
}

type Flow

type Flow struct {
	// ID represents the request's unique ID. When performing the recovery flow, this
	// represents the id in the recovery ui's query parameter: http://<selfservice.flows.recovery.ui_url>?request=<id>
	//
	// required: true
	// type: string
	// format: uuid
	ID uuid.UUID `json:"id" db:"id" faker:"-"`

	// Type represents the flow's type which can be either "api" or "browser", depending on the flow interaction.
	Type flow.Type `json:"type" db:"type" faker:"flow_type"`

	// ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the setting,
	// a new request has to be initiated.
	//
	// required: true
	ExpiresAt time.Time `json:"expires_at" faker:"time_type" db:"expires_at"`

	// IssuedAt is the time (UTC) when the request occurred.
	//
	// required: true
	IssuedAt time.Time `json:"issued_at" faker:"time_type" db:"issued_at"`

	// RequestURL is the initial URL that was requested from Ory Kratos. It can be used
	// to forward information contained in the URL's path or query for example.
	//
	// required: true
	RequestURL string `json:"request_url" db:"request_url"`

	// Active, if set, contains the registration method that is being used. It is initially
	// not set.
	Active sqlxx.NullString `json:"active,omitempty" faker:"-" db:"active_method"`

	// UI contains data which must be shown in the user interface.
	//
	// required: true
	UI *container.Container `json:"ui" db:"ui"`

	// State represents the state of this request:
	//
	// - choose_method: ask the user to choose a method (e.g. recover account via email)
	// - sent_email: the email has been sent to the user
	// - passed_challenge: the request was successful and the recovery challenge was passed.
	//
	// required: true
	State State `json:"state" faker:"-" db:"state"`

	// CSRFToken contains the anti-csrf token associated with this request.
	CSRFToken string `json:"-" db:"csrf_token"`

	// CreatedAt is a helper struct field for gobuffalo.pop.
	CreatedAt time.Time `json:"-" faker:"-" db:"created_at"`

	// UpdatedAt is a helper struct field for gobuffalo.pop.
	UpdatedAt time.Time `json:"-" faker:"-" db:"updated_at"`

	// RecoveredIdentityID is a helper struct field for gobuffalo.pop.
	RecoveredIdentityID uuid.NullUUID `json:"-" faker:"-" db:"recovered_identity_id"`
	NID                 uuid.UUID     `json:"-"  faker:"-" db:"nid"`
}

A Recovery Flow

This request is used when an identity wants to recover their account.

We recommend reading the [Account Recovery Documentation](../self-service/flows/password-reset-account-recovery)

swagger:model recoveryFlow

func NewFlow

func NewFlow(conf *config.Config, exp time.Duration, csrf string, r *http.Request, strategies Strategies, ft flow.Type) (*Flow, error)

func (*Flow) AppendTo

func (f *Flow) AppendTo(src *url.URL) *url.URL

func (Flow) GetID

func (f Flow) GetID() uuid.UUID

func (Flow) GetNID

func (f Flow) GetNID() uuid.UUID

func (*Flow) GetRequestURL

func (f *Flow) GetRequestURL() string

func (*Flow) GetType

func (f *Flow) GetType() flow.Type

func (Flow) TableName

func (f Flow) TableName(ctx context.Context) string

func (*Flow) Valid

func (f *Flow) Valid() error

type FlowExpiredError

type FlowExpiredError struct {
	*herodot.DefaultError
	// contains filtered or unexported fields
}

func NewFlowExpiredError

func NewFlowExpiredError(at time.Time) *FlowExpiredError

type FlowPersistenceProvider

type FlowPersistenceProvider interface {
	RecoveryFlowPersister() FlowPersister
}

type FlowPersister

type FlowPersister interface {
	CreateRecoveryFlow(context.Context, *Flow) error
	GetRecoveryFlow(ctx context.Context, id uuid.UUID) (*Flow, error)
	UpdateRecoveryFlow(context.Context, *Flow) error
}

type Handler

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

func NewHandler

func NewHandler(d handlerDependencies) *Handler

func (*Handler) RegisterAdminRoutes

func (h *Handler) RegisterAdminRoutes(admin *x.RouterAdmin)

func (*Handler) RegisterPublicRoutes

func (h *Handler) RegisterPublicRoutes(public *x.RouterPublic)

type HandlerProvider

type HandlerProvider interface {
	RecoveryHandler() *Handler
}

type HookExecutor

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

func NewHookExecutor

func NewHookExecutor(d executorDependencies) *HookExecutor

func (*HookExecutor) PostRecoveryHook

func (e *HookExecutor) PostRecoveryHook(w http.ResponseWriter, r *http.Request, a *Flow, s *session.Session) error

type HookExecutorProvider

type HookExecutorProvider interface {
	RecoveryExecutor() *HookExecutor
}

type HooksProvider

type HooksProvider interface {
	PostRecoveryHooks(ctx context.Context) []PostHookExecutor
}

type PostHookExecutor

type PostHookExecutor interface {
	ExecutePostRecoveryHook(w http.ResponseWriter, r *http.Request, a *Flow, s *session.Session) error
}

type PostHookExecutorFunc

type PostHookExecutorFunc func(w http.ResponseWriter, r *http.Request, a *Flow, s *session.Session) error

func (PostHookExecutorFunc) ExecutePostRecoveryHook

func (f PostHookExecutorFunc) ExecutePostRecoveryHook(w http.ResponseWriter, r *http.Request, a *Flow, s *session.Session) error

type PublicHandler

type PublicHandler interface {
	RegisterPublicRecoveryRoutes(public *x.RouterPublic)
}

type State

type State string

const (
	StateChooseMethod    State = "choose_method"
	StateEmailSent       State = "sent_email"
	StatePassedChallenge State = "passed_challenge"
)

func NextState

func NextState(current State) State

type Strategies

type Strategies []Strategy

func (Strategies) MustStrategy

func (s Strategies) MustStrategy(id string) Strategy

func (Strategies) RegisterAdminRoutes

func (s Strategies) RegisterAdminRoutes(r *x.RouterAdmin)

func (Strategies) RegisterPublicRoutes

func (s Strategies) RegisterPublicRoutes(r *x.RouterPublic)

func (Strategies) Strategy

func (s Strategies) Strategy(id string) (Strategy, error)

type Strategy

type Strategy interface {
	RecoveryStrategyID() string
	RecoveryNodeGroup() node.Group
	PopulateRecoveryMethod(*http.Request, *Flow) error
	Recover(w http.ResponseWriter, r *http.Request, f *Flow) (err error)
}

type StrategyProvider

type StrategyProvider interface {
	AllRecoveryStrategies() Strategies
	RecoveryStrategies(ctx context.Context) Strategies
}