webapp

type AllowFrameAncestorsFromCustomUI bool

type AllowFrameAncestorsFromEnv bool

type AnonymousIdentityProvider interface {
	ParseRequestUnverified(requestJWT string) (r *anonymous.Request, err error)
}

type AnonymousTokenInput struct {
	JWT           string
	PromotionCode string
}

type AnonymousUserPromotionService struct {
	Anonymous AnonymousIdentityProvider
	Clock     clock.Clock
}

type Authflow struct {
	// AllScreens is x_step => screen.
	AllScreens map[string]*AuthflowScreen `json:"all_screens,omitempty"`
}

type AuthflowDelayedUIScreenData struct {
	TargetResult *Result `json:"target_result,omitempty"`
}

type AuthflowFinishedUIScreenData struct {
	FlowType          authflow.FlowType `json:"flow_type,omitempty"`
	FinishRedirectURI string            `json:"finish_redirect_uri,omitempty"`
}

type AuthflowScreen struct {
	// Store FinishedUIScreenData when the flow is finish
	FinishedUIScreenData *AuthflowFinishedUIScreenData `json:"finished_ui_screen_data,omitempty"`
	// Store DelayedUIScreenData when injecting screen between two steps
	DelayedUIScreenData *AuthflowDelayedUIScreenData `json:"delayed_ui_screen_data,omitempty"`
	// PreviousXStep is the x_step of the screen that leads to this screen.
	PreviousXStep string `json:"previous_x_step,omitempty"`
	// PreviousInput is the input that leads to this screen.
	// It can be nil.
	PreviousInput map[string]interface{} `json:"previous_input,omitempty"`
	// StateToken is always present.
	StateToken *AuthflowStateToken `json:"state_token,omitempty"`
	// BranchStateToken is only present when the underlying authflow step has branches.
	BranchStateToken *AuthflowStateToken `json:"branch_state_token,omitempty"`
	// TakenBranchIndex tracks the taken branch.
	TakenBranchIndex *int `json:"taken_branch_index,omitempty"`
	// TakenChannel tracks the taken channel.
	TakenChannel model.AuthenticatorOOBChannel `json:"taken_channel,omitempty"`
	// WechatCallbackData is only relevant for wechat login.
	WechatCallbackData *AuthflowWechatCallbackData `json:"wechat_callback_data,omitempty"`
	// IsBotProtectionRequired will be used to determine whether to navigate to bot protection verification screen.
	IsBotProtectionRequired bool `json:"is_bot_protection_required,omitempty"`

	// In some cases, we intentionally add screens between steps, so the path may not match
	SkipPathCheck bool `json:"skip_path_check,omitempty"`

	// viewmodels used in specific screens
	OAuthProviderDemoCredentialViewModel *authflowv2viewmodels.OAuthProviderDemoCredentialViewModel `json:"oauth_provider_demo_credential,omitempty"`
}

type AuthflowScreenWithFlowResponse struct {
	Screen                       *AuthflowScreen
	StateTokenFlowResponse       *authflow.FlowResponse
	BranchStateTokenFlowResponse *authflow.FlowResponse
}

type AuthflowService interface {
	Get(ctx context.Context, stateToken string) (*authflow.ServiceOutput, error)
}

type AuthflowStateToken struct {
	XStep      string `json:"x_step"`
	StateToken string `json:"state_token"`
}

type AuthflowWechatCallbackData struct {
	State            string                        `json:"state"`
	WebappOAuthState *webappoauth.WebappOAuthState `json:"webapp_oauth_state"`
	Query            string                        `json:"query"`
}

type ColorSchemeMiddleware struct {
	Cookies CookieManager
}

type ContextHolderMiddleware struct{}

type CookieManager interface {
	GetCookie(r *http.Request, def *httputil.CookieDef) (*http.Cookie, error)
	ValueCookie(def *httputil.CookieDef, value string) *http.Cookie
	ClearCookie(def *httputil.CookieDef) *http.Cookie
}

type CookiesGetter interface {
	GetCookies() []*http.Cookie
}

type DynamicCSPMiddleware struct {
	Cookies                         CookieManager
	OAuthConfig                     *config.OAuthConfig
	AllowedFrameAncestorsFromEnv    config.AllowedFrameAncestors
	AllowFrameAncestorsFromEnv      AllowFrameAncestorsFromEnv
	AllowFrameAncestorsFromCustomUI AllowFrameAncestorsFromCustomUI
}

type ErrorService struct {
	AppID       config.AppID
	Cookie      ErrorTokenCookieDef
	RedisHandle *appredis.Handle
	Cookies     CookieManager
}

type ErrorState struct {
	Form       url.Values          `json:"form,omitempty"`
	Error      *apierrors.APIError `json:"error,omitempty"`
	TrackingID string              `json:"tracking_id,omitempty"`
}

type ErrorTokenCookieDef struct {
	Def *httputil.CookieDef
}

type FlashMessageType string

type GraphService interface {
	NewGraph(ctx context.Context, interactionCtx *interaction.Context, intent interaction.Intent) (*interaction.Graph, error)
	Get(ctx context.Context, instanceID string) (*interaction.Graph, error)
	DryRun(ctx context.Context, contextValues interaction.ContextValues, fn func(ctx context.Context, interactionCtx *interaction.Context) (*interaction.Graph, error)) error
	Run(ctx context.Context, contextValues interaction.ContextValues, graph *interaction.Graph) error
	Accept(ctx context.Context, interactionCtx *interaction.Context, graph *interaction.Graph, input interface{}) (*interaction.Graph, []interaction.Edge, error)
}

type NavigationAction string

type Navigator interface {
	Navigate(ctx context.Context, screen *AuthflowScreenWithFlowResponse, r *http.Request, webSessionID string, result *Result)
}

type NoProjectCSPMiddleware struct {
	AllowedFrameAncestorsFromEnv config.AllowedFrameAncestors
}

type OAuthClientResolver interface {
	ResolveClient(clientID string) *config.OAuthClientConfig
}

type PublicOriginMiddleware struct {
	Config     *config.HTTPConfig
	TrustProxy config.TrustProxy
}

type RequireAuthenticatedMiddleware struct{}

type RequireAuthenticationEnabledMiddleware struct {
	AuthUI *config.UIConfig
}

type RequireSettingsEnabledMiddleware struct {
	AuthUI *config.UIConfig
}

type Result struct {
	UILocales                string              `json:"ui_locales,omitempty"`
	ColorScheme              string              `json:"color_scheme,omitempty"`
	RedirectURI              string              `json:"redirect_uri,omitempty"`
	NavigationAction         NavigationAction    `json:"navigation_action,omitempty"`
	Cookies                  []*http.Cookie      `json:"cookies,omitempty"`
	IsInteractionErr         bool                `json:"is_interaction_err,omitempty"`
	RemoveQueries            setutil.Set[string] `json:"remove_queries,omitempty"`
	StopOTelTracePropagation bool                `json:"stop_otel_trace_propagation,omitempty"`
}

type Service2 struct {
	Request              *http.Request
	Sessions             SessionStore
	SessionCookie        SessionCookieDef
	SignedUpCookie       SignedUpCookieDef
	MFADeviceTokenCookie mfa.CookieDef
	ErrorService         *ErrorService
	Cookies              CookieManager
	OAuthConfig          *config.OAuthConfig
	UIConfig             *config.UIConfig
	TrustProxy           config.TrustProxy
	UIInfoResolver       UIInfoResolver
	OAuthClientResolver  OAuthClientResolver

	Graph GraphService
}

type Session struct {
	ID string `json:"id"`

	// Steps is a history stack of steps taken within this session.
	Steps []SessionStep `json:"steps,omitempty"`

	// Authflow keeps track of an authflow.
	Authflow *Authflow `json:"authflow,omitempty"`

	SAMLSessionID  string `json:"saml_session_id,omitempty"`
	OAuthSessionID string `json:"oauth_session_id,omitempty"`

	// ClientID is the client ID from SAMLSessionID or OAuthSessionID.
	ClientID string `json:"client_id,omitempty"`

	// RedirectURI is the URI to redirect to after the completion of session.
	RedirectURI string `json:"redirect_uri,omitempty"`

	// KeepAfterFinish indicates the session would not be deleted after the
	// completion of interaction graph.
	KeepAfterFinish bool `json:"keep_after_finish,omitempty"`

	// Extra is used to store extra information for use of webapp.
	Extra map[string]interface{} `json:"extra"`

	// Prompt is used to indicate requested authentication behavior
	// which includes both supported and unsupported prompt
	Prompt []string `json:"prompt_list,omitempty"`

	// Page is used to indicate the preferred page to show.
	Page string `json:"page,omitempty"`

	// UpdatedAt indicate the session last updated time
	UpdatedAt time.Time `json:"updated_at,omitempty"`

	// UserIDHint is the intended user ID.
	// It is expected that the authenticated user is indicated by this user ID,
	// otherwise it is an error.
	UserIDHint string `json:"user_id_hint,omitempty"`

	// CanUseIntentReauthenticate indicates whether IntentReauthenticate can be used.
	CanUseIntentReauthenticate bool `json:"can_use_intent_reauthenticate,omitempty"`

	// SuppressIDPSessionCookie indicates whether IDP session cookie should neither be read or written.
	SuppressIDPSessionCookie bool `json:"suppress_idp_session_cookie,omitempty"`

	// OAuthProviderAlias is used to auto redirect user to the given oauth provider in the login page
	OAuthProviderAlias string `json:"oauth_provider_alias,omitempty"`

	// LoginHint is the OIDC login_hint parameter.
	LoginHint string `json:"login_hint,omitempty"`

	// The settings action associated with this session
	// Empty if it is not a settings action
	SettingsActionID string `json:"settings_action_id,omitempty"`

	// The current flow is completed or not
	IsCompleted bool `json:"is_completed,omitempty"`
}

type SessionCookieDef struct {
	Def *httputil.CookieDef
}

type SessionMiddleware struct {
	Sessions            SessionMiddlewareSessionService
	OAuthSessions       SessionMiddlewareOAuthSessionService
	SAMLSessions        SessionMiddlewareSAMLSessionService
	States              SessionMiddlewareStore
	OAuthUIInfoResolver SessionMiddlewareOAuthUIInfoResolver
	SAMLUIInfoResolver  SessionMiddlewareSAMLUIInfoResolver
	CookieDef           SessionCookieDef
	Cookies             CookieManager
}

type SessionMiddlewareOAuthSessionService interface {
	Get(ctx context.Context, entryID string) (*oauthsession.Entry, error)
}

type SessionMiddlewareOAuthUIInfoResolver interface {
	GetOAuthSessionID(req *http.Request, urlQuery string) (string, bool)
	RemoveOAuthSessionID(w http.ResponseWriter, r *http.Request)
	ResolveForUI(ctx context.Context, r protocol.AuthorizationRequest) (*oidc.UIInfo, error)
}

type SessionMiddlewareSAMLSessionService interface {
	Get(ctx context.Context, sessionID string) (*samlsession.SAMLSession, error)
}

type SessionMiddlewareSAMLUIInfoResolver interface {
	GetSAMLSessionID(req *http.Request, urlQuery string) (string, bool)
	RemoveSAMLSessionID(w http.ResponseWriter, r *http.Request)
}

type SessionMiddlewareSessionService interface {
	CreateSession(ctx context.Context, session *Session, redirectURI string) (*Result, error)
}

type SessionMiddlewareStore interface {
	Get(ctx context.Context, id string) (*Session, error)
}

type SessionOptions struct {
	SAMLSessionID    string
	OAuthSessionID   string
	SettingsActionID string
	ClientID         string
	RedirectURI      string
	KeepAfterFinish  bool
	Prompt           []string
	Extra            map[string]interface{}
	Page             string
	// TODO(authflow): UserIDHint is now handled natively by authflow.
	UserIDHint                 string
	UpdatedAt                  time.Time
	CanUseIntentReauthenticate bool
	// TODO(authflow): SuppressIDPSessionCookie is now handled natively by authflow.
	SuppressIDPSessionCookie bool
	OAuthProviderAlias       string
	LoginHint                string
}

type SessionStep struct {
	// Kind is the kind of the step.
	Kind SessionStepKind `json:"kind"`
	// GraphID is the graph ID of the step.
	GraphID string `json:"graph_id"`
	// FormData is the place to store shared form data across different user agents.
	// The only use case currently is verification email being opened in another user agent.
	// In that case, the form submitted by the other user agent will update FormData.
	// The original user agent will then read from it to fill in its form.
	FormData map[string]interface{} `json:"form_data"`
}

type SessionStepKind string

type SessionStore interface {
	Get(ctx context.Context, id string) (*Session, error)
	Create(ctx context.Context, session *Session) (err error)
	Update(ctx context.Context, session *Session) (err error)
	Delete(ctx context.Context, id string) (err error)
}

type SessionStoreRedis struct {
	AppID config.AppID
	Redis *appredis.Handle
}

type SettingsCompletedResult struct {
	*Result
}

type SettingsSubRoutesMiddleware struct {
	Database   *appdb.Handle
	Identities SettingsSubRoutesMiddlewareIdentityService
}

type SettingsSubRoutesMiddlewareIdentityService interface {
	ListByUser(ctx context.Context, userID string) ([]*identity.Info, error)
}

type SignedUpCookieDef struct {
	Def *httputil.CookieDef
}

type SuccessPageMiddleware struct {
	Endpoints    SuccessPageMiddlewareEndpointsProvider
	UIConfig     *config.UIConfig
	Cookies      CookieManager
	ErrorService *ErrorService
}

type SuccessPageMiddlewareEndpointsProvider interface {
	ErrorEndpointURL() *url.URL
}

type TakeBranchInput struct {
	Index   int
	Channel model.AuthenticatorOOBChannel

	// bot protection specific inputs
	BotProtectionProviderType     string
	BotProtectionProviderResponse string
}

type TakeBranchOptions struct {
	DisableFallbackToSMS bool
}

type TakeBranchOutputTransformer func(ctx context.Context, output *authflow.ServiceOutput, err error, deps TransformerDependencies) (*authflow.ServiceOutput, error)

type TakeBranchResult interface {
	// contains filtered or unexported methods
}

type TakeBranchResultInput struct {
	Input                 map[string]interface{}
	NewAuthflowScreenFull func(flowResponse *authflow.FlowResponse, retriedForError error) *AuthflowScreenWithFlowResponse
	TransformOutput       *TakeBranchOutputTransformer
	OnRetry               *TakeBranchResultInputRetryHandler
}

type TakeBranchResultInputRetryHandler func(err error) (nextInput interface{})

type TakeBranchResultSimple struct {
	Screen *AuthflowScreenWithFlowResponse
}

type TransformerDependencies struct {
	Clock     clock.Clock
	Authflows AuthflowService
}

type TutorialMiddleware struct {
	TutorialCookie TutorialMiddlewareTutorialCookie
}

type TutorialMiddlewareTutorialCookie interface {
	SetAll(rw http.ResponseWriter)
}

type UIInfoResolver interface {
	SetAuthenticationInfoInQuery(redirectURI string, e *authenticationinfo.Entry) string
}

type UIParamMiddleware struct {
	OAuthUIInfoResolver SessionMiddlewareOAuthUIInfoResolver
	OAuthSessions       SessionMiddlewareOAuthSessionService
	SAMLSessions        SessionMiddlewareSAMLSessionService
	Cookies             CookieManager
}

type VisitorIDMiddleware struct {
	Cookies CookieManager
}

type WeChatRedirectURIMiddleware struct {
	Cookies        CookieManager
	IdentityConfig *config.IdentityConfig
}