QOAuthHttpServerReplyHandler Class

Handles loopback redirects by setting up a local HTTP server. 更多...

头：	#include <QOAuthHttpServerReplyHandler>
CMake:	find_package(Qt6 REQUIRED COMPONENTS NetworkAuth) target_link_libraries(mytarget PRIVATE Qt6::NetworkAuth)
qmake:	QT += networkauth
继承：	QOAuthOobReplyHandler

• 所有成员列表，包括继承成员

公共函数

	QOAuthHttpServerReplyHandler (QObject * parent = nullptr)
	QOAuthHttpServerReplyHandler (quint16 port , QObject * parent = nullptr)
	QOAuthHttpServerReplyHandler (const QHostAddress & address , quint16 port , QObject * parent = nullptr)
virtual	~QOAuthHttpServerReplyHandler ()
QString	callbackPath () const
QString	callbackText () const
void	close ()
bool	isListening () const
bool	listen (const QHostAddress & address = QHostAddress::Any, quint16 port = 0)
quint16	port () const
void	setCallbackPath (const QString & path )
void	setCallbackText (const QString & text )

详细描述

This class serves as a reply handler for OAuth 2.0 authorization processes that use loopback redirection .

The redirect URI is where the authorization server redirects the user-agent (typically, and preferably, the system browser) once the authorization part of the flow is complete. Loopback redirect URIs use http as the scheme and either localhost or an IP address literal as the host (see IPv4 and IPv6 ).

QOAuthHttpServerReplyHandler sets up a localhost server. Once the authorization server redirects the browser to this localhost address, the reply handler parses the redirection URI query parameters, and then signals authorization completion with a signal .

To handle other redirect URI schemes, see QOAuthUriSchemeReplyHandler.

The following code illustrates the usage. First, the needed variables:

QOAuth2AuthorizationCodeFlow m_oauth;
QOAuthHttpServerReplyHandler *m_handler = nullptr;
					

Followed up by the OAuth setup (error handling omitted for brevity):

m_oauth.setAuthorizationUrl(QUrl("https://some.authorization.service/v3/authorize"_L1));
m_oauth.setAccessTokenUrl(QUrl("https://some.authorization.service/v3/access_token"_L1));
m_oauth.setClientIdentifier("a_client_id"_L1);
m_oauth.setScope("read"_L1);
m_handler = new QOAuthHttpServerReplyHandler(1234, this);
connect(&m_oauth, &QAbstractOAuth::authorizeWithBrowser, this, &QDesktopServices::openUrl);
connect(&m_oauth, &QAbstractOAuth::granted, this, [this]() {
    // Here we use QNetworkRequestFactory to store the access token
    m_api.setBearerToken(m_oauth.token().toLatin1());
    m_handler->close();
});
					

Finally, we then set up the URI scheme reply-handler:

m_oauth.setReplyHandler(m_handler);
// Initiate the authorization
if (m_handler->isListening()) {
    m_oauth.grant();
}
					

IPv4 and IPv6

Currently if the handler is a loopback address, IPv4 any address, or IPv6 any address, the used callback is in the form of http://localhost:{port}/{path} . Otherwise, for specific IP addresses, the actual IP literal is used. For instance http://192.168.0.2:{port}/{path} in the case of IPv4.

成员函数文档编制

[explicit] QOAuthHttpServerReplyHandler:: QOAuthHttpServerReplyHandler ( QObject * parent = nullptr)

Constructs a QOAuthHttpServerReplyHandler object using parent as a parent object. Calls listen () with port 0 and address Null .

另请参阅 listen ().

[explicit] QOAuthHttpServerReplyHandler:: QOAuthHttpServerReplyHandler ( quint16 port , QObject * parent = nullptr)

Constructs a QOAuthHttpServerReplyHandler object using parent as a parent object. Calls listen () 采用 port and address Null .

另请参阅 listen ().

[explicit] QOAuthHttpServerReplyHandler:: QOAuthHttpServerReplyHandler (const QHostAddress & address , quint16 port , QObject * parent = nullptr)

Constructs a QOAuthHttpServerReplyHandler object using parent as a parent object. Calls listen () 采用 address and port .

另请参阅 listen ().

[virtual noexcept] QOAuthHttpServerReplyHandler:: ~QOAuthHttpServerReplyHandler ()

销毁 QOAuthHttpServerReplyHandler object. Stops listening for connections / redirections.

另请参阅 close ().

QString QOAuthHttpServerReplyHandler:: callbackPath () const

Returns the path that is used as the path component of the callback () / OAuth2 redirect_uri parameter .

另请参阅 setCallbackPath ().

QString QOAuthHttpServerReplyHandler:: callbackText () const

Returns the text that is used in response to the redirection at the end of the authorization stage.

The text is wrapped in a simple HTML page, and displayed to the user by the browser / user-agent which did the redirection.

The default text is

Callback received. Feel free to close this page.
					

另请参阅 setCallbackText ().

void QOAuthHttpServerReplyHandler:: close ()

Tells this handler to stop listening for connections / redirections.

另请参阅 listen ().

bool QOAuthHttpServerReplyHandler:: isListening () const

返回 true if this handler is currently listening, and false 否则。

另请参阅 listen () 和 close ().

bool QOAuthHttpServerReplyHandler:: listen (const QHostAddress & address = QHostAddress::Any, quint16 port = 0)

Tells this handler to listen for incoming connections / redirections on address and port 。返回 true if listening is successful, and false 否则。

Active listening is only required when performing the initial authorization phase, typically initiated by a QOAuth2AuthorizationCodeFlow::grant () 调用。

It is recommended to close the listener after successful authorization. Listening is not needed for requesting access tokens or refreshing them.

If this function is called with Null 作为 address , the handler will attempt to listen to LocalHost , and if that fails, LocalHostIPv6 .

另请参阅 IPv4 and IPv6 .

另请参阅 close (), isListening ()，和 QTcpServer::listen ().

quint16 QOAuthHttpServerReplyHandler:: port () const

Returns the port on which this handler is listening, otherwise returns 0.

另请参阅 listen () 和 isListening ().

void QOAuthHttpServerReplyHandler:: setCallbackPath (const QString & path )

设置 path to be used as the path component of the callback ().

另请参阅 callbackPath ().

void QOAuthHttpServerReplyHandler:: setCallbackText (const QString & text )

设置 text to be used in response to the redirection at the end of the authorization stage.

另请参阅 callbackText ().

内容

• 公共函数

• 详细描述

• IPv4 and IPv6