verification

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

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

type ErrorHandlerProvider interface {
	VerificationFlowErrorHandler() *ErrorHandler
}

type FakeStrategy struct{}

type Flow struct {
	// ID represents the request's unique ID. When performing the verification flow, this
	// represents the id in the verify ui's query parameter: http://<selfservice.flows.verification.ui_url>?request=<id>
	//
	// type: string
	// format: uuid
	// required: true
	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.
	//
	// required: true
	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 verify the address,
	// a new request has to be initiated.
	ExpiresAt time.Time `json:"expires_at" faker:"time_type" db:"expires_at"`

	// IssuedAt is the time (UTC) when the request occurred.
	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.
	RequestURL string `json:"request_url" db:"request_url"`

	// ReturnTo contains the requested return_to URL.
	ReturnTo string `json:"return_to,omitempty" db:"-"`

	// 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. verify your email)
	// - sent_email: the email has been sent to the user
	// - passed_challenge: the request was successful and the verification challenge was passed.
	//
	// required: true
	State State `json:"state" faker:"-" db:"state"`

	// OAuth2LoginChallenge holds the login challenge originally set during the registration flow.
	OAuth2LoginChallenge sqlxx.NullString `json:"-" db:"oauth2_login_challenge"`
	OAuth2LoginChallengeParams

	// 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"`
	NID       uuid.UUID `json:"-"  faker:"-" db:"nid"`

	// TransientPayload is used to pass data from the verification flow to hooks and email templates
	//
	// required: false
	TransientPayload json.RawMessage `json:"transient_payload,omitempty" faker:"-" db:"-"`
}

type FlowOption func(f *Flow)

type FlowPersistenceProvider interface {
	VerificationFlowPersister() FlowPersister
}

type FlowPersister interface {
	CreateVerificationFlow(context.Context, *Flow) error
	GetVerificationFlow(ctx context.Context, id uuid.UUID) (*Flow, error)
	UpdateVerificationFlow(context.Context, *Flow) error
	DeleteExpiredVerificationFlows(context.Context, time.Time, int) error
}

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

type HandlerProvider interface {
	VerificationHandler() *Handler
}

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

type HookExecutorProvider interface {
	VerificationExecutor() *HookExecutor
}

type HooksProvider interface {
	PostVerificationHooks(ctx context.Context) []PostHookExecutor
	PreVerificationHooks(ctx context.Context) []PreHookExecutor
}

type OAuth2LoginChallengeParams struct {
	// SessionID holds the session id if set from a registraton hook.
	SessionID uuid.NullUUID `json:"-" faker:"-" db:"session_id"`

	// IdentityID holds the identity id if set from a registraton hook.
	IdentityID uuid.NullUUID `json:"-" faker:"-" db:"identity_id"`

	// AMR contains a list of authentication methods that were used to verify the
	// session if set from a registration hook.
	AMR session.AuthenticationMethods `db:"authentication_methods" json:"-"`
}

type PostHookExecutor interface {
	ExecutePostVerificationHook(w http.ResponseWriter, r *http.Request, a *Flow, i *identity.Identity) error
}

type PostHookExecutorFunc func(w http.ResponseWriter, r *http.Request, a *Flow, i *identity.Identity) error

type PreHookExecutor interface {
	ExecuteVerificationPreHook(w http.ResponseWriter, r *http.Request, a *Flow) error
}

type PreHookExecutorFunc func(w http.ResponseWriter, r *http.Request, a *Flow) error

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

type State = flow.State

type Strategies []Strategy

type Strategy interface {
	VerificationStrategyID() string
	NodeGroup() node.UiNodeGroup
	PopulateVerificationMethod(*http.Request, *Flow) error
	Verify(w http.ResponseWriter, r *http.Request, f *Flow) (err error)
	SendVerificationEmail(context.Context, *Flow, *identity.Identity, *identity.VerifiableAddress) error
}

type StrategyProvider interface {
	VerificationStrategies(ctx context.Context) Strategies
	AllVerificationStrategies() Strategies
	GetActiveVerificationStrategy(context.Context) (Strategy, error)
}

type VerificationStrategy string