An authentication widget. More...

#include <Wt/Auth/AuthWidget.h>

Inheritance diagram for Wt::Auth::AuthWidget:

Public Member Functions
	AuthWidget (const AuthService &baseAuth, AbstractUserDatabase &users, Login &login)
	Constructor. More...

	AuthWidget (Login &login)
	Constructor. More...

void	setModel (std::unique_ptr< AuthModel > model)
	Sets a model. More...

AuthModel *	model () const
	Returns the model. More...

Login &	login ()
	Returns the login object. More...

void	setInternalBasePath (const std::string &path)
	Sets an internal path for authentication services. More...

std::string	internalBasePath () const
	Returns the internal path. More...

void	setRegistrationEnabled (bool enabled)
	Configures registration capabilities. More...

void	registerNewUser ()
	Starts a new registration process. More...

virtual void	registerNewUser (const Identity &oauth)
	Starts a new registration process. More...

virtual void	processEnvironment ()
	Processes the (initial) environment. More...

virtual void	letUpdatePassword (const User &user, bool promptPassword)
	Lets the user update his password. More...

virtual void	handleLostPassword ()
	Lets the user "recover" a lost password. More...

virtual std::unique_ptr< WWidget >	createLostPasswordView ()
	Creates a lost password view. More...

virtual std::unique_ptr< WWidget >	createRegistrationView (const Identity &id)
	Creates a registration view. More...

virtual void	letResendEmailVerification ()
	Lets the user resend the verification email. More...

virtual std::unique_ptr< WWidget >	createResendEmailVerificationView ()
	Creates a view to resend the email verification email. More...

virtual std::unique_ptr< WWidget >	createUpdatePasswordView (const User &user, bool promptPassword)
	Creates a view to update a user's password. More...

virtual std::unique_ptr< WDialog >	createPasswordPromptDialog (Login &login)
	Creates a password prompt dialog. More...

virtual std::unique_ptr< Mfa::AbstractMfaProcess >	createMfaProcess ()
	Create the MFA process. More...

virtual void	createMfaView ()
	Shows the MFA process in the UI. More...

virtual void	displayError (const WString &error)
	Displays the error message. More...

virtual void	displayInfo (const WString &message)
	Displays the info message. More...

Public Member Functions inherited from Wt::WTemplateFormView
	WTemplateFormView ()
	Constructor. More...

	WTemplateFormView (const WString &text)
	Constructor. More...

void	setFormWidget (WFormModel::Field field, std::unique_ptr< WWidget > widget)
	Sets the form widget for a given field. More...

void	setFormWidget (WFormModel::Field field, std::unique_ptr< WWidget > widget, const std::function< void()> &updateViewValue, const std::function< void()> &updateModelValue)
	Sets the form widget for a given field. More...

virtual void	updateView (WFormModel *model)
	Updates the View. More...

virtual void	updateViewField (WFormModel *model, WFormModel::Field field)
	Creates or updates a field in the View. More...

virtual void	updateViewValue (WFormModel model, WFormModel::Field field, WFormWidget edit)
	Updates the value in the View. More...

virtual bool	updateViewValue (WFormModel model, WFormModel::Field field, WWidget edit)
	Updates the value in the View. More...

virtual void	updateModel (WFormModel *model)
	Updates the Model. More...

virtual void	updateModelField (WFormModel *model, WFormModel::Field field)
	Updates a field in the Model. More...

virtual void	updateModelValue (WFormModel model, WFormModel::Field field, WFormWidget edit)
	Updates a value in the Model. More...

virtual bool	updateModelValue (WFormModel model, WFormModel::Field field, WWidget edit)
	Updates a value in the Model. More...

Public Member Functions inherited from Wt::WTemplate
	WTemplate ()
	Creates a template widget.

	WTemplate (const WString &text)
	Creates a template widget with given template. More...

virtual WString	templateText () const
	Returns the template. More...

void	setTemplateText (const WString &text, TextFormat textFormat=TextFormat::XHTML)
	Sets the template text. More...

void	setWidgetIdMode (TemplateWidgetIdMode mode)
	Sets how the varName should be reflected on bound widgets. More...

TemplateWidgetIdMode	widgetIdMode () const
	Returns how the varName is reflected on a bound widget. More...

virtual void	bindString (const std::string &varName, const WString &value, TextFormat textFormat=TextFormat::XHTML)
	Binds a string value to a variable. More...

void	bindInt (const std::string &varName, int value)
	Binds an integer value to a variable. More...

virtual void	bindWidget (const std::string &varName, std::unique_ptr< WWidget > widget)
	Binds a widget to a variable. More...

template<typename Widget >
Widget *	bindWidget (const std::string &varName, std::unique_ptr< Widget > widget)
	Binds a widget to a variable, returning a raw pointer. More...

template<typename Widget , typename ... Args>
Widget *	bindNew (const std::string &varName, Args &&...args)
	Creates a new widget with the given arguments, and binds it, returning a raw pointer. More...

std::unique_ptr< WWidget >	removeWidget (const std::string &varName)
	Unbinds a widget by variable name. More...

virtual std::unique_ptr< WWidget >	removeWidget (WWidget *widget) override
	Unbinds a widget by widget pointer. More...

void	bindEmpty (const std::string &varName)
	Binds an empty string to a variable. More...

void	addFunction (const std::string &name, const Function &function)
	Binds a function. More...

void	setCondition (const std::string &name, bool value)
	Sets a condition. More...

virtual bool	conditionValue (const std::string &name) const
	Returns a condition value. More...

std::set< std::string >	conditionsSet ()
	Returns the set of conditions set to true.

virtual void	resolveString (const std::string &varName, const std::vector< WString > &args, std::ostream &result)
	Resolves the string value for a variable name. More...

virtual void	handleUnresolvedVariable (const std::string &varName, const std::vector< WString > &args, std::ostream &result)
	Handles a variable that could not be resolved. More...

virtual WWidget *	resolveWidget (const std::string &varName)
	Resolves a widget for a variable name. More...

virtual const WString &	resolveStringValue (const std::string &varName)
	Resolves a string that was bound to a variable name. More...

virtual bool	resolveFunction (const std::string &name, const std::vector< WString > &args, std::ostream &result)
	Resolves a function call. More...

template<typename T >
T	resolve (const std::string &varName)
	Returns a widget for a variable name. More...

virtual void	clear ()
	Erases all variable bindings. More...

void	setInternalPathEncoding (bool enabled)
	Enables internal path anchors in the XHTML template. More...

bool	hasInternalPathEncoding () const
	Returns whether internal paths are enabled. More...

void	setEncodeTemplateText (bool on)
	Configures when internal path encoding is done. More...

bool	encodeTemplateText () const
	Returns whether internal path encoding is done on the template text. More...

virtual void	refresh () override
	Refresh the widget. More...

virtual void	renderTemplate (std::ostream &result)
	Renders the template into the given result stream. More...

bool	renderTemplateText (std::ostream &result, const WString &templateText)
	Renders a template into the given result stream. More...

std::string	getErrorText ()
	Renders the errors during renderring. More...

virtual std::unique_ptr< WWidget >	removeWidget (WWidget *widget)
	Removes a child widget.

template<typename Widget >
std::unique_ptr< Widget >	removeWidget (Widget *widget)
	Removes a child widget. More...

Public Member Functions inherited from Wt::WInteractWidget
	WInteractWidget ()
	Create an InteractWidget.

EventSignal< WKeyEvent > &	keyWentDown ()
	Event signal emitted when a keyboard key is pushed down. More...

EventSignal< WKeyEvent > &	keyPressed ()
	Event signal emitted when a "character" was entered. More...

EventSignal< WKeyEvent > &	keyWentUp ()
	Event signal emitted when a keyboard key is released. More...

EventSignal &	enterPressed ()
	Event signal emitted when enter was pressed. More...

EventSignal &	escapePressed ()
	Event signal emitted when escape was pressed. More...

EventSignal< WMouseEvent > &	clicked ()
	Event signal emitted when the primary mouse button was clicked on this widget. More...

EventSignal< WMouseEvent > &	doubleClicked ()
	Event signal emitted when the primary mouse button was double clicked on this widget. More...

EventSignal< WMouseEvent > &	mouseWentDown ()
	Event signal emitted when a mouse button was pushed down on this widget. More...

EventSignal< WMouseEvent > &	mouseWentUp ()
	Event signal emitted when a mouse button was released on this widget. More...

EventSignal< WMouseEvent > &	mouseWentOut ()
	Event signal emitted when the mouse went out of this widget. More...

EventSignal< WMouseEvent > &	mouseWentOver ()
	Event signal emitted when the mouse entered this widget. More...

EventSignal< WMouseEvent > &	mouseMoved ()
	Event signal emitted when the mouse moved over this widget. More...

EventSignal< WMouseEvent > &	mouseDragged ()
	Event signal emitted when the mouse is dragged over this widget. More...

EventSignal< WMouseEvent > &	mouseWheel ()
	Event signal emitted when the mouse scroll wheel was used. More...

EventSignal< WTouchEvent > &	touchStarted ()
	Event signal emitted when a finger is placed on the screen. More...

EventSignal< WTouchEvent > &	touchEnded ()
	Event signal emitted when a finger is removed from the screen. More...

EventSignal< WTouchEvent > &	touchMoved ()
	Event signal emitted when a finger, which is already placed on the screen, is moved across the screen. More...

EventSignal< WGestureEvent > &	gestureStarted ()
	Event signal emitted when a gesture is started. More...

EventSignal< WGestureEvent > &	gestureChanged ()
	Event signal emitted when a gesture is changed. More...

EventSignal< WGestureEvent > &	gestureEnded ()
	Event signal emitted when a gesture is ended. More...

void	setDraggable (const std::string &mimeType, WWidget dragWidget=nullptr, bool isDragWidgetOnly=false, WObject sourceWidget=nullptr)
	Configure dragging for drag and drop. More...

void	unsetDraggable ()
	Disable drag & drop for this widget. More...

void	setMouseOverDelay (int delay)
	Sets a delay for the mouse over event. More...

int	mouseOverDelay () const
	Returns the mouse over signal delay. More...

virtual void	setPopup (bool popup) override
	Lets the widget overlay over other sibling widgets. More...

virtual void	load () override
	Loads content just before the widget is used. More...

virtual bool	isEnabled () const override
	Returns whether the widget is enabled. More...

Public Member Functions inherited from Wt::WWebWidget
	WWebWidget ()
	Construct a WebWidget.

virtual std::vector< WWidget * >	children () const override
	Returns child widgets. More...

Signal &	childrenChanged ()
	Signal emitted when children have been added or removed. More...

virtual void	setPositionScheme (PositionScheme scheme) override
	Sets the CSS position scheme. More...

virtual PositionScheme	positionScheme () const override
	Returns the CSS position scheme. More...

virtual void	setOffsets (const WLength &offset, WFlags< Side > sides=AllSides) override
	Sets CSS offsets for a non-statically positioned widget. More...

virtual WLength	offset (Side s) const override
	Returns a CSS offset. More...

virtual void	resize (const WLength &width, const WLength &height) override
	Resizes the widget. More...

virtual WLength	width () const override
	Returns the width. More...

virtual WLength	height () const override
	Returns the height. More...

virtual void	setMinimumSize (const WLength &width, const WLength &height) override
	Sets a minimum size. More...

virtual WLength	minimumWidth () const override
	Returns the minimum width. More...

virtual WLength	minimumHeight () const override
	Returns the minimum height. More...

virtual void	setMaximumSize (const WLength &width, const WLength &height) override
	Sets a maximum size. More...

virtual WLength	maximumWidth () const override
	Returns the maximum width. More...

virtual WLength	maximumHeight () const override
	Returns the maximum height. More...

virtual void	setLineHeight (const WLength &height) override
	Sets the CSS line height for contained text.

virtual WLength	lineHeight () const override
	Returns the CSS line height for contained text. More...

virtual void	setFloatSide (Side s) override
	Specifies a CSS float side. More...

virtual Side	floatSide () const override
	Returns the CSS float side. More...

virtual void	setClearSides (WFlags< Side > sides) override
	Sets the sides that should be cleared of floats. More...

virtual WFlags< Side >	clearSides () const override
	Returns the sides that should remain empty. More...

virtual void	setMargin (const WLength &margin, WFlags< Side > sides=AllSides) override
	Sets CSS margins around the widget. More...

virtual WLength	margin (Side side) const override
	Returns a CSS margin set. More...

virtual void	setHiddenKeepsGeometry (bool enabled) override
	Sets whether the widget keeps its geometry when hidden. More...

virtual bool	hiddenKeepsGeometry () const override
	Returns whether the widget keeps its geometry when hidden. More...

virtual void	setHidden (bool hidden, const WAnimation &animation=WAnimation()) override
	Hides or shows the widget. More...

virtual bool	isHidden () const override
	Returns whether the widget is set hidden. More...

virtual bool	isVisible () const override
	Returns whether the widget is visible. More...

virtual void	setDisabled (bool disabled) override
	Sets whether the widget is disabled. More...

virtual bool	isDisabled () const override
	Returns whether the widget is set disabled. More...

virtual bool	isPopup () const override
	Returns whether the widget is overlayed. More...

virtual void	setInline (bool isInline) override
	Sets whether the widget is displayed inline or as a block. More...

virtual bool	isInline () const override
	Returns whether the widget is displayed inline or as block. More...

virtual void	setDecorationStyle (const WCssDecorationStyle &style) override
	Sets a CSS decoration style. More...

virtual WCssDecorationStyle &	decorationStyle () override
	Returns the decoration style of this widget. More...

virtual void	setStyleClass (const WString &styleClass) override
	Sets (one or more) CSS style classes. More...

virtual WString	styleClass () const override
	Returns the CSS style class. More...

virtual void	addStyleClass (const WString &styleClass, bool force=false) override
	Adds a CSS style class. More...

virtual void	removeStyleClass (const WString &styleClass, bool force=false) override
	Removes a CSS style class. More...

virtual bool	hasStyleClass (const WString &styleClass) const override
	Returns whether the widget has a style class.

virtual void	setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength()) override
	Sets the vertical alignment. More...

virtual AlignmentFlag	verticalAlignment () const override
	Returns the vertical alignment. More...

virtual WLength	verticalAlignmentLength () const override
	Returns the fixed vertical alignment that was set. More...

virtual void	setToolTip (const WString &text, TextFormat textFormat=TextFormat::Plain) override
	Sets a tooltip. More...

virtual void	setDeferredToolTip (bool enable, TextFormat textFormat=TextFormat::Plain) override
	Enable deferred tooltip. More...

virtual WString	toolTip () const override
	Returns the tooltip.

virtual void	setAttributeValue (const std::string &name, const WString &value) override
	Sets an attribute value. More...

virtual WString	attributeValue (const std::string &name) const override
	Returns an attribute value. More...

virtual void	setJavaScriptMember (const std::string &name, const std::string &value) override
	Sets a JavaScript member. More...

virtual std::string	javaScriptMember (const std::string &name) const override
	Returns the value of a JavaScript member. More...

virtual void	callJavaScriptMember (const std::string &name, const std::string &args) override
	Calls a JavaScript member. More...

virtual bool	loaded () const override
	Returns whether this widget has been loaded. More...

virtual void	setId (const std::string &id) override
	Sets the CSS Id. More...

virtual WWidget *	find (const std::string &name) override
	Finds a descendent widget by name. More...

virtual WWidget *	findById (const std::string &id) override
	Finds a descendent widget by id.

virtual void	setSelectable (bool selectable) override
	Sets as selectable. More...

virtual void	doJavaScript (const std::string &javascript) override
	Executes the given JavaScript statements when the widget is rendered or updated. More...

virtual const std::string	id () const override
	Returns the (unique) identifier for this object. More...

void	setLoadLaterWhenInvisible (bool)
	Change the way the widget is loaded when invisible. More...

std::string	htmlTagName () const
	returns the current html tag name More...

void	setHtmlTagName (const std::string &tag)
	set the custom HTML tag name More...

virtual void	setCanReceiveFocus (bool enabled) override
	Sets whether the widget can receive focus. More...

virtual bool	canReceiveFocus () const override
	Returns whether the widget can receive focus. More...

virtual bool	setFirstFocus () override
	Set focus on the widget's first descendant. More...

virtual void	setFocus (bool focus) override
	Sets focus. More...

virtual bool	hasFocus () const override
	Returns whether the widget currently has the focus.

virtual void	setTabIndex (int index) override
	Sets the tab index. More...

virtual int	tabIndex () const override
	Returns the tab index. More...

EventSignal &	blurred ()
	Signal emitted when the widget lost focus. More...

EventSignal &	focussed ()
	Signal emitted when the widget recieved focus. More...

virtual bool	scrollVisibilityEnabled () const final override
	Returns whether scroll visibility detection is enabled for this widget. More...

virtual void	setScrollVisibilityEnabled (bool enabled) final override
	Sets whether scroll visibility detection is enabled for this widget. More...

virtual int	scrollVisibilityMargin () const final override
	Returns the margin around the viewport within which the widget is considered visible. More...

virtual void	setScrollVisibilityMargin (int margin) final override
	Sets the margin around the viewport within which the widget is considered visible. More...

virtual Signal< bool > &	scrollVisibilityChanged () final override
	Signal triggered when the scroll visibility of this widget changes. More...

virtual bool	isScrollVisible () const final override
	Returns whether this widget is currently considered scroll visible. More...

virtual void	setThemeStyleEnabled (bool enabled) final override
	Sets whether theme styling for a widget is enabled or disabled. More...

virtual bool	isThemeStyleEnabled () const final override
	Returns whether this widget is currently styled by the chosen theme. More...

virtual void	setObjectName (const std::string &name) override
	Sets an object name. More...

void	setFocus ()
	Sets focus. More...

virtual void	setFocus (bool focus)=0
	Sets focus. More...

Public Member Functions inherited from Wt::WWidget
virtual	~WWidget ()
	Destructor. More...

WWidget *	parent () const
	Returns the parent widget.

template<typename Widget >
std::unique_ptr< Widget >	removeWidget (Widget *widget)
	Removes a child widget. More...

std::unique_ptr< WWidget >	removeFromParent ()
	Removes the widget from its parent. More...

void	setWidth (const WLength &width)
	Sets the width. More...

void	setHeight (const WLength &height)
	Sets the height. More...

virtual void	positionAt (const WWidget *widget, Orientation orientation=Orientation::Vertical)
	Positions a widget next to another widget. More...

virtual void	toggleStyleClass (const WString &styleClass, bool add, bool force=false)
	Toggles a CSS style class.

std::string	jsRef () const
	Returns a JavaScript expression to the corresponding DOM node. More...

void	setFocus ()
	Sets focus. More...

virtual void	acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())
	Sets a mime type to be accepted for dropping. More...

virtual void	stopAcceptDrops (const std::string &mimeType)
	Indicates that a mime type is no longer accepted for dropping. More...

virtual void	htmlText (std::ostream &out)
	Streams the (X)HTML representation. More...

bool	isRendered () const
	Returns whether the widget is rendered. More...

void	hide ()
	Hides the widget. More...

void	animateHide (const WAnimation &animation)
	Hides the widget using an animation. More...

void	show ()
	Shows the widget. More...

void	animateShow (const WAnimation &animation)
	Shows the widget using an animation. More...

void	enable ()
	Enables the widget. More...

void	disable ()
	Disable thes widget. More...

bool	layoutSizeAware () const
	Returns whether the widget is layout size aware. More...

Public Member Functions inherited from Wt::WObject
void	addChild (std::unique_ptr< WObject > child)
	Add a child WObject whose lifetime is determined by this WObject.

template<typename Child >
Child *	addChild (std::unique_ptr< Child > child)
	Add a child WObject, returning a raw pointer. More...

std::unique_ptr< WObject >	removeChild (WObject *child)
	Remove a child WObject, so its lifetime is no longer determined by this WObject.

template<typename Child >
std::unique_ptr< Child >	removeChild (Child *child)
	Remove a child WObject, so its lifetime is no longer determined by this WObject. More...

virtual std::string	objectName () const
	Returns the object name. More...

void	resetLearnedSlots ()
	Resets learned stateless slot implementations. More...

template<class T >
void	resetLearnedSlot (void(T::*method)())
	Resets a learned stateless slot implementation. More...

template<class T >
WStatelessSlot *	implementStateless (void(T::*method)())
	Declares a slot to be stateless and learn client-side behaviour on first invocation. More...

template<class T >
WStatelessSlot *	implementStateless (void(T::method)(), void(T::undoMethod)())
	Declares a slot to be stateless and learn client-side behaviour in advance. More...

void	isNotStateless ()
	Marks the current function as not stateless. More...

template<class T >
WStatelessSlot *	implementJavaScript (void(T::*method)(), const std::string &jsCode)
	Provides a JavaScript implementation for a method. More...

Public Member Functions inherited from Wt::Core::observable
	observable () noexcept
	Default constructor.

virtual	~observable ()
	Destructor. More...

template<typename... Args, typename C >
auto	bindSafe (void(C::*method)(Args...)) noexcept
	Protects a method call against object destruction. More...

template<typename... Args, typename C >
auto	bindSafe (void(C::*method)(Args...) const) const noexcept
	Protects a const method call against object destruction. More...

template<typename Function >
auto	bindSafe (const Function &function) noexcept
	Protects a function against object destruction. More...

Protected Member Functions
virtual void	create ()
	Creates the user-interface. More...

virtual void	createLoginView ()
	Creates the login view. More...

virtual void	createLoggedInView ()
	Creates the view shown when the user is logged in. More...

virtual void	createPasswordLoginView ()
	Creates a password login view. More...

virtual void	createOAuthLoginView ()
	Creates a widget to login using OAuth. More...

virtual void	createSamlLoginView ()
	Creates a widget to login using SAML. More...

virtual WDialog *	showDialog (const WString &title, std::unique_ptr< WWidget > contents)
	Shows a dialog. More...

virtual std::unique_ptr< RegistrationModel >	createRegistrationModel ()
	Creates a registration model. More...

virtual std::unique_ptr< WWidget >	createFormWidget (AuthModel::Field field) override
	Creates a form widget. More...

virtual void	render (WFlags< RenderFlag > flags) override
	Renders the widget. More...

Protected Member Functions inherited from Wt::WTemplateFormView
virtual void	indicateValidation (WFormModel::Field field, bool validated, WText info, WWidget edit, const WValidator::Result &validation)
	Indicates the validation result. More...

Protected Member Functions inherited from Wt::WTemplate
virtual void	applyArguments (WWidget *w, const std::vector< WString > &args)
	Applies arguments to a resolved widget. More...

void	format (std::ostream &result, const std::string &s, TextFormat textFormat=TextFormat::Plain)
	Utility method to safely format an XHTML string. More...

void	format (std::ostream &result, const WString &s, TextFormat textFormat=TextFormat::Plain)
	Utility method to safely format an XHTML string. More...

virtual void	enableAjax () override
	Progresses to an Ajax-enabled widget. More...

void	reset ()
	Notifies the template that it has changed and must be rerendered. More...

Protected Member Functions inherited from Wt::WInteractWidget
virtual void	propagateSetEnabled (bool enabled) override
	Propagates that a widget was enabled or disabled through children. More...

Protected Member Functions inherited from Wt::WWebWidget
virtual WStatelessSlot *	getStateless (Method method) override
	On-demand stateless slot implementation. More...

Protected Member Functions inherited from Wt::WWidget
void	setLayoutSizeAware (bool sizeAware)
	Sets the widget to be aware of its size set by a layout manager. More...

virtual void	layoutSizeChanged (int width, int height)
	Virtual method that indicates a size change. More...

	WWidget ()
	Creates a widget.

virtual void	dropEvent (WDropEvent dropEvent)
	Handles a drop event. More...

virtual int	boxPadding (Orientation orientation) const
	Returns the widget's built-in padding. More...

virtual int	boxBorder (Orientation orientation) const
	Returns the widget's built-in border width. More...

void	scheduleRender (WFlags< RepaintFlag > flags=None)
	Schedules rerendering of the widget. More...

Additional Inherited Members
Public Types inherited from Wt::WTemplate
typedef TemplateWidgetIdMode	WidgetIdMode
	Typedef for enum Wt::TemplateWidgetIdMode.

typedef std::function< bool(WTemplate *t, const std::vector< WString > &args, std::ostream &result)>	Function
	A function type. More...

Public Types inherited from Wt::WObject
typedef void(WObject::*	Method) ()
	Typedef for a WObject method without arguments.

Static Public Member Functions inherited from Wt::WWebWidget
static std::string	jsStringLiteral (const std::string &v, char delimiter='\'')
	Turn a CharEncoding::UTF8 encoded string into a JavaScript string literal. More...

Static Public Member Functions inherited from Wt::WWidget
static WString	tr (const char *key)
	Short hand for WString::tr() More...

Detailed Description

An authentication widget.

The authentication widget is a widget that provides a login or logout function (depending on whether the user is currently logged in). You can use it for either or both purposes.

Login or logout events are signalled to a Login object on which this widget acts.

The widget also processes environmental information related to authentication:

email tokens, which are indicated in an internal path. The widget uses dialogs (by default) to interact with the user to act on the token.
authentication tokens, which are stored in browser cookies, to implement remember-me functionality.

The processEnvironment() method initiates this process, and should typically be called only at application startup time.

The authentication widget is implemented as a View for an AuthModel, which can be set using setModel(). The login logic (at this moment only for password-based authentication) is handled by this model.

It is very likely that the off-the shelf authentication widget does not satisfy entirely to your taste or functional requirements. The widget uses three methods to allow customization:

as a WTemplateFormView, you may change the layout and styling of to your liking.
the authentication logic is delegated to an AuthModel and can can be specialized or can be used with a custom view altogether.
the views are created using virtual methods, which may be specialized to create a customized view or to apply changes to the default view.

Constructor & Destructor Documentation

◆ AuthWidget() [1/2]

Wt::Auth::AuthWidget::AuthWidget	(	const AuthService &	baseAuth,
		AbstractUserDatabase &	users,
		Login &	login
	)

Constructor.

Creates a new authentication widget. This creates an AuthModel using the given authentication service baseAuth and user database users.

The result of authentication changes is propagated to the rest of the application using a login object.

Authentication services need to be configured in the model().

◆ AuthWidget() [2/2]

Wt::Auth::AuthWidget::AuthWidget ( Login & login )

Constructor.

Creates a new authentication widget.

The result of authentication changes is propagated to the rest of the application using a login object.

You need to call setModel() to configure a model for this view.

Member Function Documentation

◆ create()

void Wt::Auth::AuthWidget::create ( )

protectedvirtual

Creates the user-interface.

This method is called just before an initial rendering, and creates the initial view.

The default implementation calls createLoginView() or createLoggedInView() depending on whether a user is currently logged in.

If MFA is enabled (AuthService::mfaEnabled()), this may call createMfaView(). This will be called if the user that is logging in has this step enabled (AuthModel::hasMfaStep()).

◆ createFormWidget()

std::unique_ptr< WWidget > Wt::Auth::AuthWidget::createFormWidget ( AuthModel::Field field )

overrideprotectedvirtual

Creates a form widget.

This method is called by updateViewField() when it needs to create a form widget for a field, and none was specified using setFormWidget().

Reimplemented from Wt::WTemplateFormView.

◆ createLoggedInView()

void Wt::Auth::AuthWidget::createLoggedInView ( )

protectedvirtual

Creates the view shown when the user is logged in.

The default implementation renders the "Wt.Auth.template.logged-in" template.

◆ createLoginView()

void Wt::Auth::AuthWidget::createLoginView ( )

protectedvirtual

Creates the login view.

This creates a view that allows the user to login, and is shown when no user is current logged in.

The default implementation renders the "Wt.Auth.template.login" template, and binds fields using createPasswordLoginView() and createOAuthLoginView().

◆ createLostPasswordView()

std::unique_ptr< WWidget > Wt::Auth::AuthWidget::createLostPasswordView ( )

virtual

Creates a lost password view.

When email verification has been enabled, the user may indicate that he has lost his password – then proof of controlling the same email address that had associated with his account is sufficient to allow him to enter a new password.

This creates the widget used to let the user enter his email address. The default implementation creates a new LostPasswordWidget.

See also: handleLostPassword()

◆ createMfaProcess()

std::unique_ptr< Mfa::AbstractMfaProcess > Wt::Auth::AuthWidget::createMfaProcess ( )

virtual

Create the MFA process.

When MFA is enabled (AuthService::setMfaProvider() is set), this will be called to create a specific MFA process. This can be used by developers to provide their own implementation, and ensure that the right widgets are shown to the user.

By default this will generate a Mfa::TotpProcess.

◆ createMfaView()

void Wt::Auth::AuthWidget::createMfaView ( )

virtual

Shows the MFA process in the UI.

This functionality manages how the MFA step is shown to the user. Developers can override this to show the step in any way they see fit. This can be shown as part of the main view, as a pop-up, ...

It will also need to decide whether the setup view (Mfa::AbstractMfaProcess::createSetupView()) or input view (Mfa::AbstractMfaProcess::createInputView()) is shown to the user.

By default this will show the process in the main view, replacing the normal login widget with the right view on the MFA process.

◆ createOAuthLoginView()

void Wt::Auth::AuthWidget::createOAuthLoginView ( )

protectedvirtual

Creates a widget to login using OAuth.

The default implementation adds an icon for each OAuth service provider available. The icon that will be used for each service is a PNG file with a path based on the name of the service. If the name is is "myService", then the icon path will be "css/oauth-myService.png". Wt does not bundle any icons by default, so you should make sure that the icon is in place.

There's a lot to say about making a usable login mechanism for OAuth (and federated login services in general), see https://sites.google.com/site/oauthgoog/UXFedLogin.

See also: createLoginView()

◆ createPasswordLoginView()

void Wt::Auth::AuthWidget::createPasswordLoginView ( )

protectedvirtual

Creates a password login view.

This is used by the default implementation of createLoginView() to prompt for the information needed for logging in using a username and password. The default implementation implements a view guided by the model().

See also: createLoginView()

◆ createPasswordPromptDialog()

std::unique_ptr< WDialog > Wt::Auth::AuthWidget::createPasswordPromptDialog ( Login & login )

virtual

Creates a password prompt dialog.

This creates a dialog password. The user is taken from the login object, which also signals an eventual success using its Login::changed() signal.

The default implementation instantiates a PasswordPromptDialog.

◆ createRegistrationModel()

std::unique_ptr< RegistrationModel > Wt::Auth::AuthWidget::createRegistrationModel ( )

protectedvirtual

Creates a registration model.

This method creates a registration model. The default implementation creates a RegistrationModel() but you may want to reimplement this function to return a specialized registration model (complementing a specialized registration view).

See also: registerNewUser()

◆ createRegistrationView()

std::unique_ptr< WWidget > Wt::Auth::AuthWidget::createRegistrationView ( const Identity & id )

virtual

Creates a registration view.

This creates a registration view, optionally using information already obtained from a third party identification service (such as an OAuth provider).

The default implementation creates a new RegistrationWidget with a model created using createRegistrationModel().

See also: registerNewUser()

◆ createResendEmailVerificationView()

std::unique_ptr< WWidget > Wt::Auth::AuthWidget::createResendEmailVerificationView ( )

virtual

Creates a view to resend the email verification email.

If AuthService::emailVerificationRequired() is true, a button will be shown next to the user name field to resend the verification email (if the email was not yet verified). This button will show a dialog containing the widget returned by this method. The default implementation instantiates a ResendEmailVerificationWidget.

This creates the widget used to let the user chose a new password. The default implementation instantiates an UpdatePasswordWidget.

Note that if email verification is optional, the application should provide its own mechanism to resend the verification email (e.g. in a user settings widget).

◆ createSamlLoginView()

void Wt::Auth::AuthWidget::createSamlLoginView ( )

protectedvirtual

Creates a widget to login using SAML.

The default implementation adds an icon for each SAML service provider available. The icon that will be used for each service is a PNG file with a path based on the name of the service. If the name is "myService", then the icon path will be "css/saml-myService.png". Wt does not bundle any icons by default, so you should make sure that the icon is in place.

See also: createLoginView()

◆ createUpdatePasswordView()

std::unique_ptr< WWidget > Wt::Auth::AuthWidget::createUpdatePasswordView	(	const User &	user,
		bool	promptPassword
	)

virtual

Creates a view to update a user's password.

If promptPassword is true, the user has to enter his current password in addition to a new password.

This creates the widget used to let the user chose a new password. The default implementation instantiates an UpdatePasswordWidget.

See also: letUpdatePassword()

◆ displayError()

void Wt::Auth::AuthWidget::displayError ( const WString & error )

virtual

Displays the error message.

This method display an dialog showing the error

◆ displayInfo()

void Wt::Auth::AuthWidget::displayInfo ( const WString & message )

virtual

Displays the info message.

This method display an dialog showing the info

◆ handleLostPassword()

void Wt::Auth::AuthWidget::handleLostPassword ( )

virtual

Lets the user "recover" a lost password.

This creates a view to let the user enter his email address, used to send an email containing instructions to enter a new password.

The default implementation creates a new view using createLostPasswordView() and shows it in a dialog using showDialog().

◆ internalBasePath()

std::string Wt::Auth::AuthWidget::internalBasePath ( ) const

Returns the internal path.

See also: setInternalBasePath()

◆ letResendEmailVerification()

void Wt::Auth::AuthWidget::letResendEmailVerification ( )

virtual

Lets the user resend the verification email.

This creates a view to let the user resend the email to verify their email address.

The default implementation creates a new view using createResendEmailVerificationView() and shows it in a dialog using showDialog().

◆ letUpdatePassword()

void Wt::Auth::AuthWidget::letUpdatePassword	(	const User &	user,
		bool	promptPassword
	)

virtual

Lets the user update his password.

This creates a view to let the user enter his new password.

The default implementation creates a new view using createUpdatePasswordView() and shows it in a dialog using showDialog().

◆ login()

Login& Wt::Auth::AuthWidget::login ( )

Returns the login object.

This login object is used to keep track of the user currently authenticated.

◆ model()

AuthModel* Wt::Auth::AuthWidget::model ( ) const

Returns the model.

The model is used only for the login function.

See also: setModel()

◆ processEnvironment()

void Wt::Auth::AuthWidget::processEnvironment ( )

virtual

Processes the (initial) environment.

This method process environmental information that may be relevant to authentication:

email tokens, which are indicated through an internal path. The widget uses dialogs (by default) to interact with the user to act on the token.
authentication tokens, which are stored in browser cookies, to implement remember-me functionality. When logging in using an authentication token, the login is considered "weak" (since a user may have inadvertently forgotten to logout from a public computer). You should let the user authenticate using another, primary method before doing sensitive operations. The createPasswordPromptDialog() method may be useful for this. This token denotes a regular username/password login. If the "remember-me" functionality is enabled for it, and selected, a token will be produced, named according to AuthService::authTokenCookieName(), and valid for AuthService::authTokenValidity() (in minutes). Both can be set by enabling authentication tokens with AuthService::setAuthTokenaEnabled(). By default the cookie will be called "wtauth" and will be valid for two weeks.

See also: letUpdatePassword()

◆ registerNewUser() [1/2]

void Wt::Auth::AuthWidget::registerNewUser ( )

Starts a new registration process.

This calls registerNewUser(0).

◆ registerNewUser() [2/2]

void Wt::Auth::AuthWidget::registerNewUser ( const Identity & oauth )

virtual

Starts a new registration process.

This starts a new registration process, and may be called in response to a user action, an internal path change, or an OAuthService login procedure which identified a new user. In the latter case, the OAuth-provided information is passed as parameter oauth.

The default implementation creates a view using createRegistrationView(), and shows it in a dialog using showDialog().

◆ render()

void Wt::Auth::AuthWidget::render ( WFlags< RenderFlag > flags )

overrideprotectedvirtual

Renders the widget.

This function renders the widget (or an update for the widget), after this has been scheduled using scheduleRender().

The default implementation will render the widget by serializing changes to JavaScript and HTML. You may want to reimplement this widget if you have been postponing some of the layout / rendering implementation until the latest moment possible. In that case you should make sure you call the base implementation however.

Reimplemented from Wt::WWebWidget.

◆ setInternalBasePath()

void Wt::Auth::AuthWidget::setInternalBasePath ( const std::string & path )

Sets an internal path for authentication services.

Only the registration function is made available through an internal path (so that one can redirect a user to the registration page). Other internal paths involved in authentication are configured in the service classes:

AuthService::setEmailRedirectInternalPath(): email tokens
OAuthService::redirectInternalPath(): an internal path used during the oauth process.

◆ setModel()

void Wt::Auth::AuthWidget::setModel ( std::unique_ptr< AuthModel > model )

Sets a model.

This sets a model to be used for authentication.

◆ setRegistrationEnabled()

void Wt::Auth::AuthWidget::setRegistrationEnabled ( bool enabled )

Configures registration capabilities.

Although the AuthWidget itself does not implement a registration view, it may offer a button/link to do so, and calls registerNewUser() when a user wishes to register.

Even if registration is not enabled, the result of an OAuthService login process may be that a new user is identified. Then the createRegistrationView() is also used to present this new user with a registration view, passing the information obtained through OAuth.

◆ showDialog()

WDialog * Wt::Auth::AuthWidget::showDialog	(	const WString &	title,
		std::unique_ptr< WWidget >	contents
	)

protectedvirtual

Shows a dialog.

This shows a dialog. The default method creates a standard WDialog, with the given title and contents as central widget.

When the central widget is deleted, it deletes the dialog.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AuthWidget() [1/2]

◆ AuthWidget() [2/2]

Member Function Documentation

◆ create()

◆ createFormWidget()

◆ createLoggedInView()

◆ createLoginView()

◆ createLostPasswordView()

◆ createMfaProcess()

◆ createMfaView()

◆ createOAuthLoginView()

◆ createPasswordLoginView()

◆ createPasswordPromptDialog()

◆ createRegistrationModel()

◆ createRegistrationView()

◆ createResendEmailVerificationView()

◆ createSamlLoginView()

◆ createUpdatePasswordView()

◆ displayError()

◆ displayInfo()

◆ handleLostPassword()

◆ internalBasePath()

◆ letResendEmailVerification()

◆ letUpdatePassword()

◆ login()

◆ model()

◆ processEnvironment()

◆ registerNewUser() [1/2]

◆ registerNewUser() [2/2]

◆ render()

◆ setInternalBasePath()

◆ setModel()

◆ setRegistrationEnabled()

◆ showDialog()