Wt::Auth::OidcProcess Class Reference

An OpenId Connect authentication process. More...

#include <Auth/OidcService>

Inheritance diagram for Wt::Auth::OidcProcess:

Public Member Functions
virtual void	startAuthenticate ()
	Starts an authorization and authentication process. More...
virtual void	getIdentity (const OAuthAccessToken &token)
	Obtains an authenticated identity. More...
Public Member Functions inherited from Wt::Auth::OAuthProcess
const std::string &	scope () const
	Returns the scope for which this process was created. More...
const OAuthService &	service () const
	Returns the OAuth service which spawned this process. More...
virtual void	startAuthorize ()
	Starts an authorization process. More...
WString	error () const
	Error information, in case authentication or identification failed. More...
const OAuthAccessToken &	token () const
	Returns the access token. More...
Signal< OAuthAccessToken > &	authorized ()
	Authorization signal. More...
Signal< Identity > &	authenticated ()
	Authentication signal. More...
Public Member Functions inherited from Wt::WObject
	WObject (WObject *parent=0)
	Create a WObject with a given parent object. More...
virtual	~WObject ()
	Destructor. More...
virtual const std::string	id () const
	Returns the (unique) identifier for this object. More...
virtual void	setObjectName (const std::string &name)
	Sets an object name. 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...
void	addChild (WObject *child)
	Adds a child object. More...
virtual void	removeChild (WObject *child)
	Removes a child object. More...
const std::vector< WObject * > &	children () const
	Returns the children.
WObject *	parent () const
	Returns the parent object.

Additional Inherited Members
Public Types inherited from Wt::WObject
typedef void(WObject::*	Method) ()
	Typedef for a WObject method without arguments.
Protected Member Functions inherited from Wt::Auth::OAuthProcess
	OAuthProcess (const OAuthService &service, const std::string &scope)
	Constructor. More...
virtual OAuthAccessToken	parseTokenResponse (const Http::Message &response)
	Parses the response for a token request. More...
virtual void	setError (const WString &e)
	Sets the error. More...
Protected Member Functions inherited from Wt::WObject
virtual WStatelessSlot *	getStateless (Method method)
	On-demand stateless slot implementation. More...
Static Protected Member Functions inherited from Wt::WObject
static WObject *	sender ()
	Returns the sender of the current slot call. More...

Detailed Description

An OpenId Connect authentication process.

The process implements the state machine that is needed to complete an OpenID Connect authentication cycle.

A process is created for a particular scope, which represents what kind of information one wants to access, and which is used to inform the user of the kind of operations he needs to authorize for your application to make with his protected data.

See also

OidcService::createProcess()

OAuthProcess

Member Function Documentation

void Wt::Auth::OidcProcess::getIdentity ( const OAuthAccessToken &  token )

virtual

Obtains an authenticated identity.

The authentication process will either use the ID token included with the access token or, when this is not available, request the identity at the user info endpoint using claims.

The authentication process ends with the authenticated() signal which signals the obtained identity.

Reimplemented from Wt::Auth::OAuthProcess.

virtual void Wt::Auth::OidcProcess::startAuthenticate ( )

virtual

Starts an authorization and authentication process.

This is startAuthorize() followed by getIdentity().

The authentication process ends with the authenticated() signal which signals the obtained identity.

Note

To be able to use a popup (instead of a page redirect), you should connect this method directly to an, since popup windows are blocked in most web browsers unless they are the direct consequence of an event.

Reimplemented from Wt::Auth::OAuthProcess.