QOAuthUriSchemeReplyHandler Class

Detaillierte Beschreibung

Diese Klasse dient als Antwort-Handler für OAuth 2.0-Autorisierungsprozesse, die private/angepasste oder HTTPS-URI-Schemata für die Umleitung verwenden. Sie verwaltet den Empfang der Autorisierungsumleitung (auch als Callback bekannt) und den anschließenden Erwerb von Zugriffstokens.

Der Umleitungs-URI ist der Ort, an den der Autorisierungsserver den Benutzer-Agenten (normalerweise und vorzugsweise den Systembrowser) umleitet, sobald der Autorisierungsteil des Datenflusses abgeschlossen ist.

Die Verwendung spezifischer URI-Schemata erfordert eine Konfiguration auf der Ebene des Betriebssystems, um den URI der richtigen Anwendung zuzuordnen. Die Art und Weise, wie diese Zuordnung vorgenommen wird, variiert von Betriebssystem zu Betriebssystem. Siehe Platform Support and Dependencies.

Diese Klasse ergänzt QOAuthHttpServerReplyHandler, die http Schemata durch Einrichtung eines localhost-Servers behandelt.

Der folgende Code veranschaulicht die Verwendung. Zuerst die benötigten Variablen:

QOAuth2AuthorizationCodeFlow m_oauth;
QOAuthUriSchemeReplyHandler m_handler;

Gefolgt von der OAuth-Einrichtung (Fehlerbehandlung der Kürze halber weggelassen):

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

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

Schließlich richten wir den URI-Schema-Antwort-Handler ein:

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

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

Private/Benutzerdefinierte URI-Schemata

Benutzerdefinierte URI-Schemata verwenden in der Regel die Reverse-Domain-Notation, gefolgt von einem Pfad, oder gelegentlich Host/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 Umleitungs-URLs reguläre https-Links:

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

Diese Links werden auf iOS als Universal Links und auf Android als App Links bezeichnet.

Die Verwendung von https-Schemata wird empfohlen, da sie zusätzliche Sicherheit bieten, indem sie die Anwendungsentwickler zwingen, den Besitz der verwendeten URLs nachzuweisen. Dieser Nachweis erfolgt durch das Bereitstellen einer Assoziationsdatei, die das Betriebssystem als Teil seiner internen URL-Verteilung konsultiert.

Der Inhalt dieser Datei assoziiert die Anwendung und die verwendeten URLs. Die Assoziationsdateien müssen öffentlich und ohne HTTP-Weiterleitungen zugänglich sein. Außerdem muss die Hosting-Site über gültige Zertifikate verfügen und die Datei muss, zumindest bei Android, als application/json content-type bereitgestellt werden (siehe Konfigurationshandbuch Ihres Servers).

Darüber hinaus können https-Links einige Vorteile für die Benutzerfreundlichkeit bieten:

• Die https-URL ist gleichzeitig ein normaler https-Link. Wenn der Benutzer die Anwendung nicht installiert hat (da die URL nicht von einer Anwendung verarbeitet wurde), kann der https-Link zum Beispiel Anweisungen zum Installieren der Anwendung enthalten.
• Der Anwendungsauswahldialog zum Öffnen der URL kann vermieden werden, und stattdessen kann Ihre Anwendung automatisch geöffnet werden.

Der Nachteil ist, dass dies zusätzliche Einstellungen erfordert, da Sie diese öffentlich gehostete Assoziationsdatei einrichten müssen.

Plattformunterstützung und Abhängigkeiten

Die derzeit unterstützten Plattformen sind Android, iOS und macOS.

Das Abhören des URI-Schemas basiert auf QDesktopServices::setUrlHandler() und QDesktopServices::unsetUrlHandler(). Diese werden derzeit vom Qt::Gui-Modul bereitgestellt und daher hängt das QtNetworkAuth -Modul von Qt::Gui ab. Wenn QtNetworkAuth ohne Qt::Gui gebaut wird, wird QOAuthUriSchemeReplyHandler nicht enthalten sein.

Android

Unter Android sind die URI-Schemata erforderlich:

• Einrichten von intent-filters im Anwendungsmanifest
• Optional, für die automatische Verifizierung mit https-Schemata, das Hosten einer Site-Association-Datei assetlinks.json

Siehe auch die Qt Android Manifestdatei Konfiguration.

iOS und macOS

Unter iOS und macOS erfordern die URI-Schemata:

• Einrichten der Site-Association entitlement
• Bei https-Schemata, Hosting einer site association file (apple-app-site-association)

Windows, Linux

Derzeit nicht unterstützt.