10Duke Enterprise C++ SDK: OIDCLoginRequestWithLoopbackRedirection Class Reference

Searching...

No Matches

#include <OIDCLoginRequestWithLoopbackRedirection.h>

Detailed Description

An implementation of tenduke::sso::OIDCLogin using an external browser (the OS default browser) and with "Loopback Interface Redirection" (see https://www.rfc-editor.org/rfc/rfc8252#section-7.3).

In terms of user-experience, this flow is quite obtrusive, but is relatively easy to implement in a platform-independent manner. It also has the benefit of not including an embedded browser, which might increase the footprint of an application noticeably (and embedded browsers are not recommended nowadays, for several reasons).

This flow first starts a lightweight local HTTP server. Then the default OS browser is opened with the URL to start the login. Once the execution succeeds (or fails), the backend sends "redirect"-response to the browser. In this case, the redirect points to an HTTP URL with localhost, e.g. "http://localhost:9999/callback". The browser receives the redirect response and navigates to the URL. The local HTTP server is listening to this URL and then notifies the application of the success (or failure). Finally, the HTTP server is shutdown.

Inheritance diagram for OIDCLoginRequestWithLoopbackRedirection:

Public Member Functions
	OIDCLoginRequestWithLoopbackRedirection (const std::shared_ptr< const ::tenduke::oidc::osbrowser::LoopbackRedirectionLoginParameters > &parameters, uint32_t acceptTimeoutMs=250, uint32_t receiveTimeoutMs=250)
	Constructs a new instance.
std::unique_ptr<::tenduke::oidc::OIDCState >	execute () override
	Performs the login.
void	abort () override
	Aborts the login.

Protected Member Functions
std::unique_ptr<::tenduke::oauth::OAuthConfiguration >	tweakOAuthConfiguration (std::uint16_t port) const
	Creates a new OAuthConfiguration by replacing port to the redirectURI.

Constructor & Destructor Documentation

◆ OIDCLoginRequestWithLoopbackRedirection()

tenduke::oidc::osbrowser::OIDCLoginRequestWithLoopbackRedirection::OIDCLoginRequestWithLoopbackRedirection	(	const std::shared_ptr< const ::tenduke::oidc::osbrowser::LoopbackRedirectionLoginParameters > &	parameters,
		uint32_t	acceptTimeoutMs = 250,
		uint32_t	receiveTimeoutMs = 250 )

Constructs a new instance.

Parameters

parameters	login parameters
acceptTimeoutMs	timeout for socket accept calls in milliseconds
receiveTimeoutMs	timeout for socket receive calls in milliseconds

Member Function Documentation

◆ abort()

void tenduke::oidc::osbrowser::OIDCLoginRequestWithLoopbackRedirection::abort ( )

overridevirtual

Aborts the login.

This allows another thread to abort a dangling login process.

Implements tenduke::oidc::OIDCLoginRequest.

◆ execute()

std::unique_ptr<::OIDCState > tenduke::oidc::osbrowser::OIDCLoginRequestWithLoopbackRedirection::execute ( )

overridevirtual

Performs the login.

Returns: new OIDCState describing the user session

Implements tenduke::oidc::OIDCLoginRequest.

◆ tweakOAuthConfiguration()

std::unique_ptr<::OAuthConfiguration > tenduke::oidc::osbrowser::OIDCLoginRequestWithLoopbackRedirection::tweakOAuthConfiguration ( std::uint16_t port ) const

protected

Creates a new OAuthConfiguration by replacing port to the redirectURI.

This is used in OOB-cases, where the redirect URI is being listened to by a locally started HTTP server.