Wt::Auth::OidcUserInfoEndpoint Class Reference

Endpoint at which user info can be requested. More...

#include <Wt/Auth/OidcUserInfoEndpoint>

Inheritance diagram for Wt::Auth::OidcUserInfoEndpoint:

Public Member Functions
	OidcUserInfoEndpoint (AbstractUserDatabase &db)
	Constructor.
virtual void	handleRequest (const Http::Request &request, Http::Response &response)
	Handles a request. More...
void	setScopeToken (const std::string &scopeToken, const std::set< std::string > &claims)
	Maps the given scope token to the given set of claims. More...
const std::map< std::string, std::set< std::string > > &	scopeTokens () const
	Retrieves the set of claims that has been mapped to the given scope token.
Public Member Functions inherited from Wt::WResource
	WResource (WObject *parent=0)
	Creates a new resource.
	~WResource ()
	Destroys the resource. More...
void	suggestFileName (const Wt::WString &name, DispositionType dispositionType=Attachment)
	Suggests a filename to the user for the data streamed by this resource. More...
const Wt::WString &	suggestedFileName () const
	Returns the suggested file name. More...
void	setDispositionType (DispositionType cd)
	Configures the Content-Disposition header. More...
DispositionType	dispositionType () const
	Returns the currently configured content disposition. More...
void	setChanged ()
	Generates a new URL for this resource and emits the changed signal. More...
void	setInternalPath (const std::string &path)
	Sets an internal path for this resource. More...
std::string	internalPath () const
	Returns the internal path. More...
const std::string &	generateUrl ()
	Generates an URL for this resource. More...
const std::string &	url () const
	Returns the current URL for this resource. More...
Signal &	dataChanged ()
	Signal emitted when the data presented in this resource has changed. More...
void	setUploadProgress (bool enabled)
	Indicate interest in upload progress. More...
Signal< ::uint64_t, ::uint64_t > &	dataReceived ()
	Signal emitted when data has been received for this resource. More...
void	write (std::ostream &out, const Http::ParameterMap &parameters=Http::ParameterMap(), const Http::UploadedFileMap &files=Http::UploadedFileMap())
	Stream the resource to a stream. More...
virtual void	handleAbort (const Http::Request &request)
	Handles a continued request being aborted. More...
void	haveMoreData ()
	Indicate that more data is available. More...
void	setTakesUpdateLock (bool enabled)
	Set whether this resource takes the WApplication's update lock. More...
bool	takesUpdateLock () const
	Returns whether this resources takes the WApplication's update lock. 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.

Protected Member Functions
virtual Json::Object	generateUserInfo (const User &user, const std::set< std::string > &scope)
	Generates the JSON containing the claims for the given scope. More...
Protected Member Functions inherited from Wt::WResource
void	beingDeleted ()
	Prepares the resource for deletion. More...
Protected Member Functions inherited from Wt::WObject
virtual WStatelessSlot *	getStateless (Method method)
	On-demand stateless slot implementation. More...

Additional Inherited Members
Public Types inherited from Wt::WResource
enum	DispositionType { NoDisposition, Attachment, Inline }
	Values for the disposition type in the Content-Disposition header. More...
Public Types inherited from Wt::WObject
typedef void(WObject::*	Method) ()
	Typedef for a WObject method without arguments.
Static Protected Member Functions inherited from Wt::WObject
static WObject *	sender ()
	Returns the sender of the current slot call. More...

Detailed Description

Endpoint at which user info can be requested.

The UserInfo Endpoint is an OAuth 2.0 Protected Resource that returns Claims about the authenticated End-User. To obtain the requested Claims about the End-User, the Client makes a request to the UserInfo Endpoint using an Access Token obtained through OpenID Connect Authentication. These Claims are normally represented by a JSON object that contains a collection of name and value pairs for the Claims.

One can use setScopeToken to map claims to a scopeToken. The value of these claims will be retrieved using the AbstractUserDatabase::idpJsonClaim function.

You can look at http://openid.net/specs/openid-connect-core-1_0.html#UserInfo for more information.

This endpoint is implemented as a WResource, so it's usually deployed using WServer::addResource.

This class relies on the implementation of several functions in the AbstractUserDatabase. Namely AbstractUserDatabase::idpJsonClaim, AbstractUserDatabase::idpTokenFindWithValue, AbstractUserDatabase::idpTokenUser, and AbstractUserDatabase::idpTokenScope.

Must be deployed using TLS.

See also

setScopeToken

AbstractUserDatabase

Member Function Documentation

generateUserInfo()

Json::Object Wt::Auth::OidcUserInfoEndpoint::generateUserInfo ( const User &  user, const std::set< std::string > &  scope  )

protectedvirtual

Generates the JSON containing the claims for the given scope.

Can be overridden, but by default it uses the configured mapping set by setScopeToken, and AbstractUserDatabase::idpJsonClaim.

See also

AbstractUserDatabase::idpJsonClaim

handleRequest()

void Wt::Auth::OidcUserInfoEndpoint::handleRequest ( const Http::Request &  request, Http::Response &  response  )

virtual

Handles a request.

Reimplement this method so that a proper response is generated for the given request. From the request object you can access request parameters and whether the request is a continuation request. In the response object, you should set the mime type and stream the output data.

A request may also concern a continuation, indicated in Http::Request::continuation(), in which case the next part for a previously created continuation should be served.

While handling a request, which may happen at any time together with event handling, the library makes sure that the resource is not being concurrently deleted, but multiple requests may happend simultaneously for a single resource.

Implements Wt::WResource.

setScopeToken()

void Wt::Auth::OidcUserInfoEndpoint::setScopeToken	(	const std::string &	scopeToken,
		const std::set< std::string > &	claims
	)

Maps the given scope token to the given set of claims.

The value of these claims will be retrieved from the AbstractUserDatabase using the AbstractUserDatabase::idpJsonClaim function.

At construction, the following default scopes are automatically populated: profile -> {name} and email -> {email, email_verified}

A scope can be erased by setting it to an empty set of claims.

See also

AbstractUserDatabase::idpJsonClaim