settings

package
v0.4.4-alpha.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 10, 2020 License: Apache-2.0 Imports: 33 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	PublicPath        = "/self-service/browser/flows/settings"
	PublicRequestPath = "/self-service/browser/flows/requests/settings"

	ContinuityPrefix = "ory_kratos_settings"
)
View Source 
const (
	StrategyProfile = "profile"
)

Variables

View Source 
var (
	ErrRequestExpired = herodot.ErrBadRequest.
						WithError("settings request expired").
						WithReasonf(`The settings request has expired. Please restart the flow.`)
	ErrHookAbortRequest             = errors.New("aborted settings hook execution")
	ErrRequestNeedsReAuthentication = herodot.ErrForbidden.WithReasonf("The login session is too old and thus not allowed to update these fields. Please re-authenticate.")
)
View Source 
var (
	ErrContinuePreviousAction = errors.New("found prior action")
)

Functions

func ContinuityKey 

func ContinuityKey(id string) string

func ContinuityOptions 

func ContinuityOptions(p interface{}, i *identity.Identity) []continuity.ManagerOption

func GetRequestID 

func GetRequestID(r *http.Request) (uuid.UUID, error)

func TestRequestPersister 

func TestRequestPersister(p interface {
	RequestPersister
	identity.PrivilegedPool
}) func(t *testing.T)

func WithCallback 

func WithCallback(cb func(ctxUpdate *UpdateContext) error) func(o *postSettingsHookOptions)

Types

type ErrorHandler 

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

func NewErrorHandler 

func NewErrorHandler(d errorHandlerDependencies, c configuration.Provider) *ErrorHandler

func (*ErrorHandler) HandleSettingsError 

func (s *ErrorHandler) HandleSettingsError(
	w http.ResponseWriter,
	r *http.Request,
	rr *Request,
	err error,
	method string,
)

type ErrorHandlerProvider 

type ErrorHandlerProvider interface{ SettingsRequestErrorHandler() *ErrorHandler }

type Handler 

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

func NewHandler 

func NewHandler(d handlerDependencies, c configuration.Provider) *Handler

func (*Handler) CreateRequest 

func (h *Handler) CreateRequest(w http.ResponseWriter, r *http.Request, sess *session.Session, req *Request) error

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 {
	SettingsHandler() *Handler
}

type HookExecutor 

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

func NewHookExecutor 

func NewHookExecutor(
	d executorDependencies,
	c configuration.Provider,
) *HookExecutor

func (*HookExecutor) PostSettingsHook 

func (e *HookExecutor) PostSettingsHook(w http.ResponseWriter, r *http.Request, settingsType string, ctxUpdate *UpdateContext, i *identity.Identity, opts ...PostSettingsHookOption) error

type HookExecutorProvider 

type HookExecutorProvider interface {
	SettingsHookExecutor() *HookExecutor
}

type HooksProvider 

type HooksProvider interface {
	PostSettingsPrePersistHooks(settingsType string) []PostHookPrePersistExecutor
	PostSettingsPostPersistHooks(settingsType string) []PostHookPostPersistExecutor
}

type PostHookPostPersistExecutor 

type PostHookPostPersistExecutor interface {
	ExecuteSettingsPostPersistHook(w http.ResponseWriter, r *http.Request, a *Request, s *identity.Identity) error
}

type PostHookPostPersistExecutorFunc 

type PostHookPostPersistExecutorFunc func(w http.ResponseWriter, r *http.Request, a *Request, s *identity.Identity) error

func (PostHookPostPersistExecutorFunc) ExecuteSettingsPostPersistHook 

func (f PostHookPostPersistExecutorFunc) ExecuteSettingsPostPersistHook(w http.ResponseWriter, r *http.Request, a *Request, s *identity.Identity) error

type PostHookPrePersistExecutor 

type PostHookPrePersistExecutor interface {
	ExecuteSettingsPrePersistHook(w http.ResponseWriter, r *http.Request, a *Request, s *identity.Identity) error
}

type PostHookPrePersistExecutorFunc 

type PostHookPrePersistExecutorFunc func(w http.ResponseWriter, r *http.Request, a *Request, s *identity.Identity) error

func (PostHookPrePersistExecutorFunc) ExecuteSettingsPrePersistHook 

func (f PostHookPrePersistExecutorFunc) ExecuteSettingsPrePersistHook(w http.ResponseWriter, r *http.Request, a *Request, s *identity.Identity) error

type PostSettingsHookOption 

type PostSettingsHookOption func(o *postSettingsHookOptions)

type Request 

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

	// 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" db:"active_method"`

	// Messages contains a list of messages to be displayed in the Settings UI. Omitting these
	// messages makes it significantly harder for users to figure out what is going on.
	//
	// More documentation on messages can be found in the [User Interface Documentation](https://www.ory.sh/kratos/docs/concepts/ui-user-interface/).
	Messages text.Messages `json:"messages" db:"messages" faker:"-"`

	// Methods contains context for all enabled registration methods. If a registration request has been
	// processed, but for example the password is incorrect, this will contain error messages.
	//
	// required: true
	Methods map[string]*RequestMethod `json:"methods" faker:"settings_request_methods" db:"-"`

	// MethodsRaw is a helper struct field for gobuffalo.pop.
	MethodsRaw RequestMethodsRaw `json:"-" faker:"-" has_many:"selfservice_settings_request_methods" fk_id:"selfservice_settings_request_id"`

	// Identity contains all of the identity's data in raw form.
	//
	// required: true
	Identity *identity.Identity `json:"identity" faker:"identity" db:"-" belongs_to:"identities" fk_id:"IdentityID"`

	// State represents the state of this request. It knows two states:
	//
	// - show_form: No user data has been collected, or it is invalid, and thus the form should be shown.
	// - success: Indicates that the settings request has been updated successfully with the provided data.
	//	   Done will stay true when repeatedly checking. If set to true, done will revert back to false only
	//	   when a request with invalid (e.g. "please use a valid phone number") data was sent.
	//
	// required: true
	State State `json:"state" faker:"-" db:"state"`

	// IdentityID is a helper struct field for gobuffalo.pop.
	IdentityID uuid.UUID `json:"-" faker:"-" db:"identity_id"`
	// 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"`
}

Request presents a settings request

This request is used when an identity wants to update settings (e.g. profile data, passwords, ...) in a selfservice manner.

We recommend reading the [User Settings Documentation](../self-service/flows/user-settings)

swagger:model settingsRequest

func NewRequest 

func NewRequest(exp time.Duration, r *http.Request, s *session.Session) *Request

func (*Request) AfterFind 

func (r *Request) AfterFind(_ *pop.Connection) error

func (*Request) AfterSave 

func (r *Request) AfterSave(c *pop.Connection) error

func (*Request) BeforeSave 

func (r *Request) BeforeSave(_ *pop.Connection) error

func (*Request) GetID 

func (r *Request) GetID() uuid.UUID

func (Request) TableName 

func (r Request) TableName() string

func (*Request) URL 

func (r *Request) URL(settingsURL *url.URL) *url.URL

func (*Request) Valid 

func (r *Request) Valid(s *session.Session) error

type RequestMethod 

type RequestMethod struct {
	// Method contains the request credentials type.
	Method string `json:"method" db:"method"`

	// Config is the credential type's config.
	Config *RequestMethodConfig `json:"config" db:"config"`

	// ID is a helper struct field for gobuffalo.pop.
	ID uuid.UUID `json:"-" db:"id"`

	// RequestID is a helper struct field for gobuffalo.pop.
	RequestID uuid.UUID `json:"-" db:"selfservice_settings_request_id"`

	// Request is a helper struct field for gobuffalo.pop.
	Request *Request `json:"-" belongs_to:"selfservice_settings_request" fk_id:"RequestID"`

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

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

swagger:model settingsRequestMethod

func (RequestMethod) TableName 

func (u RequestMethod) TableName() string

type RequestMethodConfig 

type RequestMethodConfig struct {
	// swagger:ignore
	RequestMethodConfigurator
	// contains filtered or unexported fields
}

swagger:type settingsRequestConfigPayload

func (*RequestMethodConfig) MarshalJSON 

func (c *RequestMethodConfig) MarshalJSON() ([]byte, error)

func (*RequestMethodConfig) Scan 

func (c *RequestMethodConfig) Scan(value interface{}) error

func (*RequestMethodConfig) UnmarshalJSON 

func (c *RequestMethodConfig) UnmarshalJSON(data []byte) error

func (*RequestMethodConfig) Value 

func (c *RequestMethodConfig) Value() (driver.Value, error)

type RequestMethodConfigurator 

type RequestMethodConfigurator interface {
	form.ErrorParser
	form.FieldSetter
	form.FieldUnsetter
	form.ValueSetter
	form.Resetter
	form.MessageResetter
	form.CSRFSetter
	form.FieldSorter
	form.MessageAdder
}

swagger:ignore

type RequestMethods 

type RequestMethods map[string]*RequestMethod

func (RequestMethods) TableName 

func (u RequestMethods) TableName() string

type RequestMethodsRaw 

type RequestMethodsRaw []RequestMethod // workaround for https://github.com/gobuffalo/pop/pull/478

func (RequestMethodsRaw) TableName 

func (u RequestMethodsRaw) TableName() string

type RequestPersistenceProvider 

type RequestPersistenceProvider interface {
	SettingsRequestPersister() RequestPersister
}

type RequestPersister 

type RequestPersister interface {
	CreateSettingsRequest(context.Context, *Request) error
	GetSettingsRequest(ctx context.Context, id uuid.UUID) (*Request, error)
	UpdateSettingsRequest(context.Context, *Request) error
}

type State 

type State string
const (
	StateShowForm State = "show_form"
	StateSuccess  State = "success"
)

type Strategies 

type Strategies []Strategy

func (Strategies) MustStrategy 

func (s Strategies) MustStrategy(id string) Strategy

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 {
	SettingsStrategyID() string
	RegisterSettingsRoutes(*x.RouterPublic)
	PopulateSettingsMethod(*http.Request, *session.Session, *Request) error
}

type StrategyProvider 

type StrategyProvider interface {
	SettingsStrategies() Strategies
}

type UpdateContext 

type UpdateContext struct {
	Valid   bool
	Session *session.Session
	Request *Request
}

func PrepareUpdate 

func PrepareUpdate(d interface {
	x.LoggingProvider
	continuity.ManagementProvider
	session.ManagementProvider
	RequestPersistenceProvider
}, w http.ResponseWriter, r *http.Request, name string, payload UpdatePayload) (*UpdateContext, error)

type UpdatePayload 

type UpdatePayload interface {
	GetRequestID() uuid.UUID
	SetRequestID(id uuid.UUID)
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.