QOAuthUriSchemeReplyHandler Class

Ausführliche Beschreibung

Diese Klasse dient als Antwort-Handler für OAuth-2.0 -Autorisierungsvorgänge, die private/benutzerdefinierte oder HTTPS-URI-Schemata für die Weiterleitung verwenden. Sie verwaltet den Empfang der Autorisierungsweiterleitung (auch als Callback bezeichnet) und die anschließende Beschaffung von Zugriffstoken.

Die Umleitungs-URI ist die Adresse, an die der Autorisierungsserver den User-Agent (in der Regel und vorzugsweise den Systembrowser) umleitet, sobald der Autorisierungsteil des Ablaufs abgeschlossen ist.

Die Verwendung bestimmter URI-Schemata erfordert eine Konfiguration auf Betriebssystemebene, um die URI der richtigen Anwendung zuzuordnen. Die Vorgehensweise zur Einrichtung dieser Zuordnung variiert je nach Betriebssystem. Siehe Platform Support and Dependencies.

Diese Klasse ergänzt QOAuthHttpServerReplyHandler, das „ http “-Schemas durch die Einrichtung eines Localhost-Servers verarbeitet.

Der folgende Code veranschaulicht die Verwendung. Zunächst die benötigten Variablen:

QOAuth2AuthorizationCodeFlow m_oauth;
QOAuthUriSchemeReplyHandler m_handler;

Anschließend folgt die OAuth-Konfiguration (die Fehlerbehandlung wurde der Kürze halber weggelassen):

m_oauth.setAuthorizationUrl(QUrl(authorizationUrl));
m_oauth.setTokenUrl(QUrl(accessTokenUrl));
m_oauth.setClientIdentifier(clientIdentifier);
m_oauth.setRequestedScopeTokens({scope});

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();
});

Abschließend richten wir dann den URI-Schema-Reply-Handler ein:

m_handler.setRedirectUrl(QUrl{"com.example.myqtapp://oauth2redirect"_L1});
m_oauth.setReplyHandler(&m_handler);

// Initiate the authorization
if (m_handler.listen()) {
    m_oauth.grant();
}

Private/benutzerdefinierte URI-Schemas

Benutzerdefinierte URI-Schemata verwenden in der Regel die Reverse-Domain-Notation, gefolgt von einem Pfad, oder gelegentlich einen Host bzw. Host+Pfad:

// Example with path:
com.example.myapp:/oauth2/callback
// Example with host:
com.example.myapp://oauth2.callback

HTTPS-URI-Schema

Bei HTTPS-URI-Schemata sind die Weiterleitungs-URLs reguläre HTTPS-Links:

https://myapp.example.com/oauth2/callback

Diese Links werden unter iOS als „Universal Links“ und unter Android als „App Links“ bezeichnet.

Die Verwendung von HTTPS-Schemata wird empfohlen, da sie zusätzliche Sicherheit bietet, indem sie Anwendungsentwickler dazu zwingt, die Eigentümerschaft an den verwendeten URLs nachzuweisen. Dieser Nachweis erfolgt durch das Hosten einer Zuordnungsdatei, die das Betriebssystem im Rahmen seiner internen URL-Weiterleitung abfragt.

Der Inhalt dieser Datei ordnet die Anwendung den verwendeten URLs zu. Die Zuordnungsdateien müssen ohne HTTP-Weiterleitungen öffentlich zugänglich sein. Darüber hinaus muss die Hosting-Website über gültige Zertifikate verfügen, und zumindest bei Android muss die Datei mit dem Content-Type „ application/json “ bereitgestellt werden (siehe Konfigurationsanleitung Ihres Servers).

Darüber hinaus können HTTPS-Links einige Vorteile hinsichtlich der Benutzerfreundlichkeit bieten:

• Die HTTPS-URL fungiert gleichzeitig als regulärer HTTPS-Link. Wenn der Nutzer die App noch nicht installiert hat (da die URL von keiner App verarbeitet wurde), kann der HTTPS-Link beispielsweise Anweisungen dazu bereitstellen.
• Der Dialog zur Auswahl einer Anwendung zum Öffnen der URL kann vermieden werden, und stattdessen wird Ihre Anwendung möglicherweise automatisch geöffnet

Der Nachteil ist, dass hierfür zusätzliche Konfigurationsschritte erforderlich sind, da Sie diese öffentlich gehostete Zuordnungsdatei einrichten müssen.

Plattformunterstützung und Abhängigkeiten

Derzeit werden die Plattformen Android, iOS und macOS unterstützt.

Das Abhören von URI-Schemata basiert auf QDesktopServices::setUrlHandler() und QDesktopServices::unsetUrlHandler(). Diese werden derzeit vom Modul „Qt GUI“ bereitgestellt, weshalb das Modul „ QtNetworkAuth “ von „Qt GUI“ abhängig ist. Wenn „ QtNetworkAuth “ ohne „Qt GUI“ kompiliert wird, wird „QOAuthUriSchemeReplyHandler“ nicht einbezogen.

Android

Unter Android erfordern die URI-Schemas Folgendes:

• Einrichtung von „ intent-filters “ im Anwendungsmanifest
• Optional: Für die automatische Überprüfung bei https-Schemas muss eine Site-Association-Datei bereitgestellt werden assetlinks.json

Siehe auch die Konfiguration der Qt-Android-Manifestdatei.

iOS und macOS

Unter iOS und macOS erfordern die URI-Schemas Folgendes:

• Einrichten der Website-Zuordnung entitlement
• Bei https-Schemas muss eine „ site association file “ (apple-app-site-association) bereitgestellt werden

Windows, Linux

Derzeit nicht unterstützt. Plattformen und Anwendungsfälle, die Qt WebEngine , können diesen Antwort-Handler dennoch nutzen – siehe „Qt OAuth2 Browser Support“ für weitere Details.